utf8_converter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 731755377192fe051e2d39ac746b0fa5d072727f
+  data.tar.gz: a0e77a244a4f1ee80c7358b8f62fdf0be14a1822
+SHA512:
+  metadata.gz: a18279072b7d850addfe33ed2ac6389c98261bfe6fbf7548ece399e23023f55bcbcae0f4401d51499efad80963e891a568677aa22c9a8314a2299c457b51d8db
+  data.tar.gz: f364e576ebb24eb8dfa187b17de34bba37cfc4314258201131b07885b3e97fe19ebd16183af6d0923bee132bd2869e782ec04961927e711c6e4a69acf4f1747e

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in utf8_converter.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 newint33h
+
+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,69 @@
+# UTF8 Converter
+
+A Ruby gem that attempts to convert texts from unknown encodings to UTF8.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'utf8_converter'
+```
+
+And execute:
+
+    $ bundle update
+
+Or install it yourself as:
+
+    $ gem install utf8_converter
+
+## Usage
+
+The normal usage for converting texts to UTF8 is the following:
+
+```
+require 'utf8_converter'
+
+unknown_text = "R\u00E9sum\u00E9"
+
+# Make a copy in UTF8 encoding
+puts unknown_text.to_utf8
+# Résumé
+
+# Convert the actual variable to UTF8
+unknown_text.to_utf8!
+puts unknown_text
+# Résumé
+
+```
+
+However the previous code will only convert the encodings listed in the default encodings listed
+in the following variable:
+
+```
+p UTF8Converter.common_encodings
+# => [#<Encoding:ISO-8859-1 (autoload)>, #<Encoding:Windows-1252 (autoload)>]
+```
+
+You can define the common encodings your application is expecting to receive:
+
+```
+UTF8Converter.common_encodings = UTF8Converter::DEFAULT_COMMON_ENCODINGS
+# or
+UTF8Converter.common_encodings = [Encoding::ISO_8859_1]
+```
+
+Any other text with a different encoding will result in a replacement of unknown characters to
+a default replace character:
+
+```
+UTF8Converter.common_encodings = []
+
+puts "A\xF1o".to_utf8
+# A?o
+
+UTF8Converter.default_replace_character = ''
+puts "A\xF1o".to_utf8
+# Ao
+```

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/lib/utf8_converter.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+require 'utf8_converter/version'
+
+# Class used to keep the default common encoding and the helper methods for the string conversion
+class UTF8Converter
+  DEFAULT_COMMON_ENCODINGS = [
+    Encoding::ISO_8859_1, 
+    Encoding::Windows_1252
+  ]
+  DEFAULT_REPLACE_CHARACTER = '?'
+
+  class << self
+    attr_accessor :common_encodings
+    attr_accessor :default_replace_character
+  end
+
+  @common_encodings = DEFAULT_COMMON_ENCODINGS
+  @default_replace_character = DEFAULT_REPLACE_CHARACTER
+
+  def self.try_convert_from_encoding_to_utf8!(string, encoding)
+    original_encoding = string.encoding
+    begin
+      string.force_encoding(encoding).encode!(Encoding::UTF_8)
+      true
+    rescue
+      string.force_encoding(original_encoding)
+      false
+    end
+  end 
+
+  def self.convert_to_utf8!(string)
+    if string.force_encoding(Encoding::UTF_8).valid_encoding?
+      return string.encode!(Encoding::UTF_8)
+    end
+    @common_encodings.each do |encoding|
+      return string if try_convert_from_encoding_to_utf8!(string, encoding)
+    end
+    string.encode!(Encoding::UTF_8, invalid: :replace, replace: @default_replace_character)
+  end 
+end
+
+# This partial class adds some useful methods to convert text to utf-8
+class String
+
+  def to_utf8!
+    UTF8Converter.convert_to_utf8!(self)
+  end
+
+  def to_utf8
+    dup.to_utf8!
+  end
+end

data/lib/utf8_converter/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+# This partial class defines the version of the gem
+class UTF8Converter
+  VERSION = '0.1.0'
+end

data/utf8_converter.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'utf8_converter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'utf8_converter'
+  spec.version       = UTF8Converter::VERSION
+  spec.authors       = ['Jorge Del Rio']
+  spec.email         = ['jdelrios@gmail.com']
+
+  spec.summary       = 'A gem to force all kind of text into UTF8 encoding'
+  spec.description   = 'This gem attempts to convert texts from unknown encodings to UTF8'
+  spec.homepage      = 'https://github.com/newint33h/utf8_converter.git'
+  spec.license       = 'MIT'
+
+  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']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: utf8_converter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jorge Del Rio
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: This gem attempts to convert texts from unknown encodings to UTF8
+email:
+- jdelrios@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/utf8_converter.rb
+- lib/utf8_converter/version.rb
+- utf8_converter.gemspec
+homepage: https://github.com/newint33h/utf8_converter.git
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A gem to force all kind of text into UTF8 encoding
+test_files: []