force_utf8 1.0.0

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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in force_utf8.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Gitorious AS
+
+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,41 @@
+# ForceUtf8
+
+ForceUtf8 is a library that allows you to convert any Ruby string into a string encoded in UTF-8. It replaces any unknown characters with question marks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'force_utf8'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install force_utf8
+
+## Usage
+
+### Monkey-patched version
+
+    require 'force_utf8'
+
+    "foo\xCFbar".force_utf8 # returns "foo?bar"
+    "foo\xCFbar".force_utf8! # mutates string into "foo?bar"
+
+### Global function
+
+    require 'force_utf8/encode'
+
+    ForceUtf8::Encode.encode("foo\xCFbar") # returns "foo?bar"
+    ForceUtf8::Encode.encode!("foo\xCFbar") # mutates string into "foo?bar"
+
+## 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/force_utf8.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'force_utf8/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "force_utf8"
+  spec.version       = ForceUtf8::VERSION
+  spec.authors       = ["Adam Pohorecki"]
+  spec.email         = ["adam@pohorecki.pl"]
+  spec.description   = %q{Convert any Ruby string to UTF8.}
+  spec.summary       = %q{Convert any Ruby string to UTF8.}
+  spec.homepage      = "https://gitorious.org/gitorious/force_utf8"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/force_utf8.rb

@@ -0,0 +1,3 @@
+require "force_utf8/version"
+require "force_utf8/encode"
+require "force_utf8/core_ext"

data/lib/force_utf8/core_ext.rb

@@ -0,0 +1,9 @@
+class String
+  def force_utf8
+    ForceUtf8::Encode.encode(self)
+  end
+
+  def force_utf8!
+    ForceUtf8::Encode.encode!(self)
+  end
+end

data/lib/force_utf8/encode.rb

@@ -0,0 +1,23 @@
+module ForceUtf8
+  module Encode
+    def encode(string)
+      return unless string
+      string = string.dup
+      encode!(string)
+      string
+    end
+
+    def encode!(string)
+      return unless string
+
+      string.force_encoding("UTF-8")
+
+      unless string.valid_encoding?
+        new_chars = string.chars.map { |c| c.valid_encoding? ? c : '?' }.join
+        string.replace(new_chars)
+      end
+    end
+
+    extend self
+  end
+end

data/lib/force_utf8/version.rb

@@ -0,0 +1,3 @@
+module ForceUtf8
+  VERSION = "1.0.0"
+end

data/spec/force_utf8/encode_spec.rb

@@ -0,0 +1,79 @@
+# encoding: utf-8
+
+require "force_utf8"
+
+describe ForceUtf8::Encode do
+  context "monkey patches" do
+    it "includes the mutating extension" do
+      str = "żółć\xCF"
+      str.force_utf8!
+
+      str.should == "żółć?"
+    end
+
+    it "includes the immutable extension" do
+      str = "żółć\xCF"
+
+      str.force_utf8.should == "żółć?"
+      str.should == "żółć\xCF"
+    end
+  end
+
+  context "encode!" do
+    it "does not replace valid UTF-8 chars" do
+      str = "żółć"
+
+      ForceUtf8::Encode.encode!(str)
+
+      str.should == "żółć"
+      str.valid_encoding?.should be_true
+    end
+
+    it "replaces invalid UTF-8 chars with question marks" do
+      str = "żółć\xCF"
+
+      ForceUtf8::Encode.encode!(str)
+
+      str.should == "żółć?"
+      str.valid_encoding?.should be_true
+    end
+
+    it "does not attempt to mutate a nil value" do
+      expect {
+        ForceUtf8::Encode.encode!(nil)
+      }.not_to raise_error
+    end
+  end
+
+  context "encode" do
+    it "does not replace valid UTF-8 chars" do
+      str = "żółć"
+
+      encoded = ForceUtf8::Encode.encode(str)
+
+      encoded.should == "żółć"
+      encoded.valid_encoding?.should be_true
+    end
+
+    it "replaces invalid UTF-8 chars with question marks" do
+      str = "żółć\xCF"
+
+      encoded = ForceUtf8::Encode.encode(str)
+
+      encoded.should == "żółć?"
+      encoded.valid_encoding?.should be_true
+    end
+
+    it "does not mutate the given string" do
+      str = "żółć\xCF"
+
+      ForceUtf8::Encode.encode(str)
+
+      str.should == "żółć\xCF"
+    end
+
+    it "returns nil for nil value" do
+      ForceUtf8::Encode.encode(nil).should be_nil
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: force_utf8
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Adam Pohorecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Convert any Ruby string to UTF8.
+email:
+- adam@pohorecki.pl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- force_utf8.gemspec
+- lib/force_utf8.rb
+- lib/force_utf8/core_ext.rb
+- lib/force_utf8/encode.rb
+- lib/force_utf8/version.rb
+- spec/force_utf8/encode_spec.rb
+homepage: https://gitorious.org/gitorious/force_utf8
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2425636791820530650
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2425636791820530650
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Convert any Ruby string to UTF8.
+test_files:
+- spec/force_utf8/encode_spec.rb