sterilizer 0.0.2

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sterilizer.gemspec
+gemspec
+
+gem "pry"

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ben Thompson
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,53 @@
+# Sterilizer
+
+A simple module that extends a String, giving it a `sterilize!` method which to ensure the string is always valid UTF-8
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sterilizer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sterilizer
+
+## Usage
+Handy when you want to ensure incoming strings will contain invalid characters
+```ruby
+
+dodgy_params = {
+  :ok => "Hello",
+  :dodgy => "hi \255",
+  :accented => "\xE9",
+}
+guarantee_strings!(dodgy_params)
+# =>
+    {
+        :ok=>"Hello",
+        :dodgy=>"hi ­"
+        :accented=>"é"
+    }
+
+private
+
+def guarantee_strings!(unclean_params)
+  unclean_params.each do |_,v|
+    v.sterilize!
+  end
+end
+```
+
+It uses the https://github.com/oleander/rchardet gem to guess the character encoding if the string isn't valid when forced to UTF-8
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/sterilizer.rb

@@ -0,0 +1,79 @@
+require "sterilizer/version"
+require "rchardet19"
+
+module Sterilizer
+  def sterilize!
+
+    return self unless !!defined?(Encoding)
+    # return if encoding is valid and equal to default_internal
+    return self if valid_when_default?
+
+    # force to default encoding if valid when forced
+    return self.force_encoding(Encoding.default_internal) if valid_when_forced?
+
+    # At this point, we know the string is not valid encoding, it the encoding is UTF-8,
+    # we must try a different encoding that is valid before forcefully encoding to UTF-8
+    # Otherwise, the encoding type is non-default. If it is valid, encode it to UTF-8, otherwise
+    # find an alternative before forcefully encoding to UTF-8
+    if encoding_is_default?
+      # Might have a situation where encoding is the same as default, but it's not valid
+      # Force it to something else so we can String#encode
+      non_default_encoding = find_a_valid_encoding
+      force_encoding_with(non_default_encoding)
+    else
+      if valid_when_forced?(self.encoding)
+        self.encode!(Encoding.default_internal, self.encoding, { :undef => :replace, :invalid => :replace})
+      else
+        alternative_encoding = find_a_valid_encoding(self.encoding)
+        force_encoding_with(alternative_encoding)
+      end
+    end
+  rescue
+    self.force_encoding_with("ASCII")
+  end
+
+  def encoding_is_default?
+    self.encoding == Encoding.default_internal
+  end
+
+  def valid_when_default?
+    self.valid_encoding? && encoding_is_default?
+  end
+
+  def valid_when_forced?(encoding = Encoding.default_internal)
+    self.dup.force_encoding(encoding).valid_encoding?
+  end
+
+  def find_a_valid_encoding(ignoring = [Encoding.default_internal], guessed_already = false)
+    # If we've already tried to guess the encoding, resort to picking one at random until valid
+    if guessed_already
+      provisional_encoding = Encoding.list.detect{ |encoding| !ignoring.include?(encoding) }
+    else # On first run, we'll try and guess the character encoding
+      provisional_encoding = guess_encoding
+    end
+
+    # If the provisional encoding is valid when string is forced to it, select it otherwise continue to find one
+    if valid_when_forced?(provisional_encoding)
+      provisional_encoding
+    else
+      find_a_valid_encoding(ignoring << provisional_encoding, :guess_failed)
+    end
+  end
+
+  # Use an external library to attempt to (silently) guess the encoding
+  def guess_encoding(guesser = CharDet)
+    Encoding.find(guesser.detect(self, :silent => true)["encoding"])
+  end
+
+  def force_encoding_with(encoding)
+    self.force_encoding(encoding).encode(Encoding.default_internal, :invalid => :replace, :undef => :replace)
+  end
+
+end
+
+# Add sterilize methods to a string if it is sterilized, saves clobbering every string!
+class String
+  def sterilize!
+    self.extend(Sterilizer).sterilize!
+  end
+end

data/lib/sterilizer/version.rb

@@ -0,0 +1,3 @@
+module Sterilizer
+  VERSION = "0.0.2"
+end

data/sterilizer.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sterilizer/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "sterilizer"
+  gem.version       = Sterilizer::VERSION
+  gem.authors       = ["Ben Thompson"]
+  gem.email         = ["ben@atechmedia.com"]
+  gem.description   = %q{Guarantee a string}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "rchardet19"
+  gem.add_development_dependency 'pry'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: sterilizer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Ben Thompson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rchardet19
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Guarantee a string
+email:
+- ben@atechmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sterilizer.rb
+- lib/sterilizer/version.rb
+- sterilizer.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []
+has_rdoc: