Update gemspec

bf4 · bf4 · commit fecd7440b1f5 · 2015-10-26T04:08:31.000-05:00
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)
diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,23 @@
+The MIT License (MIT)
+====================
+
+* Copyright © 2013 David Chelimsky, Myron Marston, Jon Rowe, Sam Phippen, Xavier Shay, Bradley Schaefer
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # EncodedString
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/encoded_string`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+EncodedString is a wrapper for a string and a given encoding that handles operations on
+strings with different encodings, invalid encodings, have no known conversion method,
+or are otherwise incompatible, all without raising excpetions
 
 ## Installation
 
@@ -22,7 +22,63 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+EncodedString.pick_encoding(str1, str2)
+
+string = "123".force_encoding(EncodedString::UTF_8)
+str = "abc".encode('ASCII-8BIT')
+str = EncodedString.new(str, target_encoding = string.encoding)
+str.source_encoding.to_s
+str.split("\n")
+str << "123"
+str.to_s
+```
+
+## About
+
+Encoding Exceptions:
+
+```plain
+Raised by Encoding and String methods:
+  Encoding::UndefinedConversionError:
+    when a transcoding operation fails
+    if the String contains characters invalid for the target encoding
+    e.g. "\x80".encode('UTF-8','ASCII-8BIT')
+    vs "\x80".encode('UTF-8','ASCII-8BIT', undef: :replace, replace: '<undef>')
+    # => '<undef>'
+  Encoding::CompatibilityError
+    when Encoding.compatibile?(str1, str2) is nil
+    e.g. utf_16le_emoji_string.split("\n")
+    e.g. valid_unicode_string.encode(utf8_encoding) << ascii_string
+  Encoding::InvalidByteSequenceError:
+    when the string being transcoded contains a byte invalid for
+    either the source or target encoding
+    e.g. "\x80".encode('UTF-8','US-ASCII')
+    vs "\x80".encode('UTF-8','US-ASCII', invalid: :replace, replace: '<byte>')
+    # => '<byte>'
+  ArgumentError
+    when operating on a string with invalid bytes
+    e.g."\x80".split("\n")
+  TypeError
+    when a symbol is passed as an encoding
+    Encoding.find(:"UTF-8")
+    when calling force_encoding on an object
+    that doesn't respond to #to_str
+
+Raised by transcoding methods:
+  Encoding::ConverterNotFoundError:
+    when a named encoding does not correspond with a known converter
+    e.g. 'abc'.force_encoding('UTF-8').encode('foo')
+    or a converter path cannot be found
+    e.g. "\x80".force_encoding('ASCII-8BIT').encode('Emacs-Mule')
+
+Raised by byte <-> char conversions
+  RangeError: out of char range
+    e.g. the UTF-16LE emoji: 128169.chr
+```
+
+See [lib/encoded_string.rb](lib/encoded_string.rb) and
+[spec/encoded_string_spec.rb](spec/encoded_string_spec.rb) for more information.
 
 ## Development
 
@@ -32,5 +88,10 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/encoded_string.
+Bug reports and pull requests are welcome on GitHub at https://github.com/bf4/encoded_string. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
diff --git a/encoded_string.gemspec b/encoded_string.gemspec
@@ -7,22 +7,13 @@ Gem::Specification.new do |spec|
   spec.name          = "encoded_string"
   spec.version       = EncodedString::VERSION
   spec.authors       = ["Benjamin Fleischer"]
-  spec.email         = ["TODO: Write your email address"]
+  spec.email         = ["github@benjaminfleischer.com"]
 
-  spec.summary       = %q{TODO: Write a short summary, because Rubygems requires one.}
-  spec.description   = %q{TODO: Write a longer description or delete this line.}
-  spec.homepage      = "TODO: Put your gem's website or public repo URL here."
-
-  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
-  # delete this section to allow pushing this gem to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
-  else
-    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
-  end
+  spec.summary       = %q{Handle string operations without worrying about raising encoding exceptions.}
+  spec.description   = %q{Extracted from rspec-support. See https://github.com/rspec/rspec-support/issues/249.}
+  spec.homepage      = "https://github.com/bf4/encoded_string"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
