encoding_estimator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f22f57e18e9e57c37d777061d7b644f1b44acf71
+  data.tar.gz: e27edfa36627f76644d9238c1177853f70a2d238
+SHA512:
+  metadata.gz: f4621f23022e68f1fa8298f56e3aba0ffac23bc086a71187b45e89ff0d19a0dbbb59c1f16c72f83b021a217c5120d1056c4a3c527005b1132df51d877187e3ec
+  data.tar.gz: f2ef8383cb065d1b2402fd5418ee17305ba29aedc44aa8172d2fa1306e3144aa95e790aebb7d34f0ab2ba021789cb767cdb0fd03da92a6adc8c05e695ba21a1b

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+.idea

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kirmis@st.ovgu.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Oskar Kirmis
+
+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,121 @@
+# EncodingEstimator: Detect encoding of strings
+
+This gem allows you to detect the encoding of a string based on their content. It uses character distribution statistics to check which encoding is the one that gives you the best results.
+
+## Usage in Ruby Code
+
+The gem has two major high level methods. The first one can be used when you want to know, how a string is encoded:
+
+```ruby
+detection = EncodingEstimator.detect( File.read( 'foo.txt' ), languages: [ :en, :de ] )
+puts "Encoding: #{detection.result.encoding}"
+```
+
+The second one is a shortcut you can use in case you just want to be sure to get a string of an unknown encoding as a UTF-8 encoded string (should be the ruby default):
+
+```ruby
+utf8_txt = EncodingEstimator.ensure_utf8( File.read( 'foo.txt' ), languages: [ :en, :de ] )
+```
+
+If you need more control over the operations to perform, just have a look at `EncodingEstimator::Detector` and `EncodingEstimator::Conversion`.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'encoding_estimator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install encoding_estimator
+
+Note: if you want to use the multithreaded versions of the algorithms, please install `parallel` and `ruby-progressbar` gem.
+
+## Command line utilities
+
+This gem provides two command line utilities: `encest-detect` and `encest-gen`.
+
+### encest-detect
+
+This tool can detect the encoding of files. Therefore, it has some command line options you should use whenever you know more about a file (e.g. which languages it could be written in or which encodings it could have).
+
+```
+usage: encest-detect [options]
+    --encodings, -e   Encodings to test (default: iso-8859-1,utf-16le,windows-1251)
+    --operations, -o  Operations (enc/dec) to test (default: dec)
+    --languages, -l   Language profiles to apply (default: en,de)
+    --threads, -t     Number of threads to use (0 to disable multithreading, default)
+    --help, -h        Display help
+    other arguments: files to parse
+```
+
+Please note that the `-l` argument accepts the short two-letter-codes for the included language profiles as well as paths to language model files. These can be generated by using `encest-gen`.
+
+The output might look like this:
+
+```
+$ encest-detect -l en,de,fr */*.txt
+de/iso-8859-1.txt: dec_iso-8859-1
+    keep_utf-8: 0.9983638601518013
+    dec_iso-8859-1: 1.0
+    dec_utf-16le: 0.0
+    dec_windows-1251: 0.9984215377764598
+en/utf-16le.txt: dec_utf-16le
+    keep_utf-8: 0.0
+    dec_iso-8859-1: 0.3981167811176304
+    dec_utf-16le: 1.0
+    dec_windows-1251: 0.005410547626031029
+fr/utf-8.txt: keep_utf-8
+    keep_utf-8: 1.0
+    dec_iso-8859-1: 0.9957726010451553
+    dec_utf-16le: 0.0
+    dec_windows-1251: 0.9957810888135232
+```
+
+### encest-gen
+
+This tool is can generate the language models the `encest-detect` tool uses (or the other classes in this gem). The language models are *very simple* JSON files, looking somewhat like that:
+
+`{"W":0.222539,"ä":0.288427,"-":0.513657,"Z":0.118473 ... }`
+
+The `encest-gen` command generates these scores based on a lot of input text. To generate the language models this gem provides by default, I used dumps of the Wikipedia, but you can use any (UTF-8-encoded) text files you like. Just put them in one directory, let's call it *pt* (for Portuguese) and extract the files you want to learn the language model from to that directory (e.g. the Wikipedia dump). Please split large files into smaller chunks of text (max ~20MiB) because ruby otherwise will crash with NoMemoryError and you don't see a progressbar.
+
+Usage of `encest-gen` is quite simple:
+```
+usage: encest-gen [options]
+    --threshold, -t  Minimum character count threshold to include a char in the model (default: 0.00001)
+    --threads, -n    Number of threads used to process the files (default: 4)
+    --silent, -s     Disable progressbars and other outputs
+    --help, -h       Display help
+    other arguments: lang1=directory1 ... langN=directoryN
+```
+
+So for our Portuguese language model on a 8 core machine we call:
+
+`encest-gen -n 8 pt=/path/to/the/directory/with/text`
+
+The command will produce a file called `pt.json` which is you new language model.
+
+## How it works
+
+This gem uses a statistical approach to determine the encoding of an input string. Therefore, it interprets the input as different encodings (all encodings to test) and compares the character distribution against one or multiple language models. The detector then returns the likelihood of every encoding.
+
+## Supported languages
+
+Currently, the gem has support for 5 languages: English, German, French, Spanish and Russian. The language profiles were generated from Wikipedia dumps. You can generate your own language profiles using the `encest-gen` tool. For more information on this tool, see above.
+
+## Supported encodings
+
+The gem supports all encodings your ruby implementation supports. But note that including more encodings in the list of encodings you want to test slows down the detection process.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task :default => :spec

data/bin/encest-detect

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require 'json'
+require 'slop'
+
+# Get environment: development or production? -> Installed gem or current source dir
+if ENV.key?( 'ENCEST_ENV' ) and ENV[ 'ENCEST_ENV' ] == 'development'
+  require_relative '../lib/encoding_estimator'
+else
+  require 'encoding_estimator'
+end
+
+
+opts = Slop.parse do |o|
+  o.array(
+      '--encodings', '-e', 'Encodings to test (default: iso-8859-1,utf-16le,windows-1251)', default: %w(iso-8859-1 utf-16le windows-1251)
+  )
+  o.array(
+      '--operations', '-o', 'Operations (enc/dec) to test (default: dec)',
+      default: [EncodingEstimator::Conversion::Operation::DECODE]
+  )
+  o.array(
+      '--languages', '-l', 'Language models to apply (default: en,de)', default: ['de', 'en']
+  )
+  o.integer(
+       '--threads', '-t', 'Number of threads to use (0 to disable multithreading, default)', default: 0
+  )
+  o.bool(
+      '--help', '-h', 'Display help'
+  )
+end
+
+if opts[:help]
+  puts opts
+  puts (' ' * 4) + 'other arguments: files to parse'
+  exit! 0
+end
+
+opts.arguments.each do |file|
+  unless File.file? file
+    puts "No such file: #{file}"
+    exit! 1
+  end
+end
+
+# Internal vs. external profiles
+opts[:languages] = opts[:languages].map { |l| l.size == 2 ? l.to_sym : l }
+
+# Multithreading: nil for 0
+opts[:threads] = opts[:threads] == 0 ? nil : opts[:threads]
+
+# Process every file
+opts.arguments.each do |file|
+  detection = EncodingEstimator.detect File.read(file ), {
+                    languages:  opts[:languages],  encodings: opts[:encodings],
+                    operations: opts[:operations], include_default: true,
+                    num_cores:  opts[:threads]
+  }
+
+  puts "#{file}: #{detection.result.key}"
+  detection.results.each { |r| puts "    #{r[:conversion].key}: #{r[:score]}" }
+end

data/bin/encest-gen

@@ -0,0 +1,105 @@
+#!/usr/bin/env ruby
+
+# This tool can be used to generate language profiles from directories containing
+# a lot plaintext. It can process multiple languages and directories at once.
+# The models created will be written to the working directory as "two-letter-lang-code.json".
+
+require 'json'
+require 'slop'
+
+# Get environment: development or production? -> Installed gem or current source dir
+if ENV.key?( 'ENCEST_ENV' ) and ENV[ 'ENCEST_ENV' ] == 'development'
+  require_relative '../lib/encoding_estimator'
+else
+  require 'encoding_estimator'
+end
+
+# Represents a task as specified as command line argument to build a language model for a given
+# language using the files from a given directory.
+class ModelBuildTask
+  attr_reader :directory, :language
+
+  # New model build task representing a directory and a language code
+  def initialize( directory, language )
+    @directory = directory
+    @language  = language
+  end
+
+  # Validate the object for correct directory name and language code. Exits the program on error.
+  def validate!
+    errors = [ validate_directory, validate_language ].reject { |e| e.nil? }
+    print_errors errors if errors.any?
+  end
+
+  # Create a ModelBuildTask from a given command line argument of the form
+  # "two-letter-code=directory". Quits the program on parsing errors.
+  #
+  # @param [String] string Command line argument to parse
+  # @return [ModelBuildTask] ModelBuildTask representing the command line argument (language and directory)
+  def self.parse( string )
+    tokens = string.split '='
+    if tokens.size == 2
+      ModelBuildTask.new(tokens[1], tokens[0])
+    else
+      print_errors [ "Invalid argument: '#{string}'" ]
+    end
+  end
+
+  private
+
+  # Print a list of errors to standard error
+  def self.print_errors( errors )
+    STDERR.write "#{errors.join "\n"}"
+    exit! 1
+  end
+
+  # Create directory validation error message. nil if everything is fine.
+  def validate_directory
+    "Not a directory: '#{@directory}'." unless File.directory? @directory
+  end
+
+  # Create two-letter-language-code error message. nil if no error
+  def validate_language
+    "Invalid language name (no two-letter-code): '#{@directory}'." unless @language.size == 2
+  end
+end
+
+# Specify/parse the command line arguments.
+opts = Slop.parse do |o|
+  o.float(
+      '--threshold', '-t', 'Minimum character count threshold to include a char in the model (default: 0.00001)', default: 0.00001
+  )
+  o.integer(
+       '--threads', '-n', 'Number of threads used to process the files (default: 4)', default: 4
+  )
+  o.bool(
+      '--silent', '-s', 'Disable progressbars and other outputs'
+  )
+  o.bool(
+      '--help', '-h', 'Display help'
+  )
+end
+
+# Help requested?
+if ARGV.include?( '-h' ) || ARGV.include?( '--help' )
+  puts opts
+  puts ( ' ' * 4 ) + 'other arguments: lang1=directory1 ... langN=directoryN'
+  exit! 0
+end
+
+silent = opts[:silent]
+
+# Parse all arguments of the form two-letter-language-code=directory-to-process-files-from
+configurations = opts.arguments.map { |arg| ModelBuildTask.parse(arg) }
+
+# Process every language with its associated directory
+configurations.each do |config|
+  puts "Creating language file for #{config.language} from #{config.directory}..." unless silent
+
+  # Create the model from the directory
+  runner = EncodingEstimator::ParallelModelBuilder.new( config.directory, opts[:threshold] )
+  runner.execute!( opts[:threads], !silent )
+
+  # Save the model as json
+  File.open("#{config.language}.json", 'w') { |f| f.write JSON.unparse(runner.results) }
+end

data/encoding_estimator.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'encoding_estimator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'encoding_estimator'
+  spec.version       = EncodingEstimator::VERSION
+  spec.authors       = ['Oskar Kirmis']
+  spec.email         = ['kirmis@st.ovgu.de']
+
+  spec.summary       = %q{Detect encoding of an input string using character count statistics.}
+  spec.description   = %q{This gem allows you to detect the encoding of a string based on their content. It uses character distribution statistics to check which encoding is the one that gives you the best results.}
+  spec.homepage      = 'https://git.iftrue.de/okirmis/encoding_estimator'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_dependency 'htmlentities', '~> 4.3'
+  spec.add_dependency 'json', '~> 2.0'
+  spec.add_dependency 'slop', '~> 4.4'
+end

data/lib/encoding_estimator/builder/model_builder.rb

@@ -0,0 +1,70 @@
+require 'htmlentities'
+
+module EncodingEstimator
+
+  # Class which allows building language models (character count statistics) from a single file
+  class ModelBuilder
+    attr_reader   :filename
+
+    # Create a new object for a given file
+    #
+    # @param [String] filename Path to the file to learn statistics from
+    def initialize( filename )
+      @filename = filename
+    end
+
+    # Count all characters in the file
+    #
+    # @return [Hash] Hash mapping each character found in the file to the number of occurrences
+    def execute
+      content = load_content
+
+      stats = {}
+      content.each_char { |c| stats[c] = stats.fetch(c, 0) + 1 }
+
+      stats
+    end
+
+    # Combine multiple character count statistics to one single table. Also, characters
+    # occurring less often then a threshold are ignored. The final table is scaled
+    # linear (and mapped to a score of 1 to 10)
+    #
+    # @param [Array<Hash>] stats_collection   Array of character count statistics as returned by ModelBuilder.encode
+    # @param [Float]       min_char_threshold Threshold used to decide, which characters to include
+    #                                         (include a char if count/max_count >= threshold)
+    # @return [Hash] Character count statistics, in linear scale, score from 1 to 10
+    def self.join_and_postprocess( stats_collection, min_char_threshold = 0.0001 )
+      stats     = {}
+      log_stats = {}
+
+      # Join all stats
+      stats_collection.each do |stat|
+        stat.each { |char, count| stats[char] = stats.fetch(char, 0) + count }
+      end
+
+      max_count = stats.values.max
+      stats.each do |char, count|
+        next if count < max_count * min_char_threshold
+
+        log_stats[ char ] = ( 10.0 * count / max_count ).round( 6 )
+      end
+
+      log_stats
+    end
+
+    private
+
+    # Load the content from the file specified in the constructor. HTML entities are decoded because of large
+    # collections of natural language from the internet are used (e.g. Wikipedia).
+    #
+    # @return [String] Content of the file without whitespaces
+    def load_content
+      raw       = File.read( @filename ).encode('UTF-16be', invalid: :replace, replace: '').encode('UTF-8')
+      decoder   = HTMLEntities.new
+      plaintext = decoder.decode raw
+
+      plaintext.gsub! /\s/, ''
+      plaintext
+    end
+  end
+end

data/lib/encoding_estimator/builder/parallel_model_builder.rb

@@ -0,0 +1,45 @@
+require_relative '../parallel_support'
+require_relative 'model_builder'
+
+module EncodingEstimator
+
+  # Class used to build language models from multiple files
+  class ParallelModelBuilder
+
+    attr_reader :files
+    attr_reader :results
+
+    # Create a new builder object from all files of a given directory.
+    #
+    # @param [String] directory          Path to the directory to load files from
+    # @param [Float]  min_char_threshold Minimum threshold specifying which characters to include in the final model
+    #                                    (see ModelBuilder.join_and_postprocess for more information)
+    def initialize( directory, min_char_threshold = 0.00001 )
+      @files     = Dir.new( directory ).entries.map { |p| "#{directory}/#{p}" }.select { |p| File.file?( p ) }
+      @results   = nil
+      @threshold = min_char_threshold
+    end
+
+    # Load and process all files from the directory. If the parallel gem is installed, this is done in
+    # multiple processes and therefore truly concurrent. If the ruby-progressbar gem is installed and
+    # the show_progress parameter is set to true, a progressbar will be shown.
+    #
+    # @param [Integer] max_processes Maximum number of processes to spawn for processing the files
+    # @param [Boolean] show_progress if set to true and the ruby-progressbar gem is installed, show a progressbar
+    # @return [Hash] Character count statistics combined from all files of the directory, scaled linear
+    def execute!( max_processes = 4, show_progress = true )
+      if EncodingEstimator::ParallelSupport.supported?
+        opts = {
+            in_processes: max_processes,
+            progress: ( show_progress && EncodingEstimator::ParallelSupport.progress? ) ? 'Analyzing' : nil
+        }
+
+        result_list = Parallel.map( files, opts ) { |f| EncodingEstimator::ModelBuilder.new( f ).execute }
+      else
+        result_list = files.map { |f| EncodingEstimator::ModelBuilder.new( f ).execute }
+      end
+
+      @results  = EncodingEstimator::ModelBuilder.join_and_postprocess(result_list, @threshold )
+    end
+  end
+end

data/lib/encoding_estimator/conversion.rb

@@ -0,0 +1,108 @@
+module EncodingEstimator
+
+  # Class that represents the conversion of a string to or from an other encoding
+  class Conversion
+    DEFAULT_TARGET_ENCODING = :'utf-8'
+
+    # Ways of conversion: convert from an encoding to the target, to an encoding or don't change anything
+    module Operation
+      ENCODE = :enc
+      DECODE = :dec
+      KEEP   = :keep
+    end
+
+    attr_reader :operation
+    attr_reader :encoding
+
+    # Initialize a new conversion object from an encoding and tell it whether to convert from it or to it
+    #
+    # @param [String] encoding  Encoding to convert to/from
+    # @param [Symbol] operation Whether to convert from that encoding or to it
+    def initialize( encoding = DEFAULT_TARGET_ENCODING, operation = Operation::KEEP )
+      @encoding  = encoding
+      @operation = operation
+    end
+
+    # Check if two conversions are representing the same operation.
+    #
+    # @param [EncodingEstimator::Conversion] other Conversion to compare this instance to
+    # @return [Boolean] True if equal, false if not
+    def equals?( other )
+
+      # Not the same encoding? Cannot be equal
+      return false if other.encoding.to_s != self.encoding.to_s
+
+      # If the default and the target encoding is the same, the operation doesn't matter
+      # as the conversion does nothing at all
+      return true if self.encoding.to_s == DEFAULT_TARGET_ENCODING.to_s
+
+      # Not the default encoding, so check if the operation is the same
+      self.operation == other.operation
+    end
+
+    # Perform the conversion with the current settings on a given string
+    #
+    # @param [String] data String to encode/decode
+    # @return [String] The encoded/decoded string
+    def perform( data )
+      return encode( data, encoding ) if operation == Operation::ENCODE
+      return decode( data, encoding ) if operation == Operation::DECODE
+      data
+    end
+
+    # Get the internal name (unique key) for this conversion. Useful when storing/referencing conversions
+    # in hashes.
+    #
+    # @return [String] Unique key of this conversion
+    def key
+      @key ||= "#{operation}_#{encoding}"
+    end
+
+    # Generate all conversions of for given encodings and operations. Note: this will produce
+    # #encodings * #operations conversions if default is not included and #encoding * #operations + 1
+    # if the default is included.
+    #
+    # @param [Array<String>] encodings   Names of the encodings to generate conversions for
+    # @param [Array<Symbol>] operations  Operations describing which conversions (encode/decode/keep) to include
+    # @param [Boolean] include_no_change Include the default conversion (keep UTF-8) in the list
+    # @return [Array<Conversion>]        List of conversions generated from the encodings and operations
+    def self.generate(
+        encodings  = %w(utf-8 iso-8859-1 Windows-1251),
+        operations = [Operation::ENCODE, Operation::DECODE ],
+        include_no_change = true
+    )
+
+      conversions = include_no_change ? [ Conversion.new ] : []
+
+      encodings.each do |encoding|
+        conversions = conversions + operations.map { |operation| Conversion.new( encoding, operation )  }
+      end
+
+      conversions
+    end
+
+    private
+
+    # Encode a given string from the default (UTF-8) to a given encoding.
+    #
+    # @param [String] str      String to encode
+    # @param [String] encoding Name of the encoding used to encode the string
+    # @return [String] The encoded string
+    def encode( str, encoding )
+      str.clone.force_encoding( DEFAULT_TARGET_ENCODING.to_s ).encode(
+          encoding, invalid: :replace, undef: :replace, replace: ''
+      ).force_encoding( DEFAULT_TARGET_ENCODING.to_s )
+    end
+
+    # Decode a given string from a given encoding to the default (UTF-8).
+    #
+    # @param [String] str      String to decode
+    # @param [String] encoding Name of the encoding used to decode the string
+    # @return [String] The decoded string
+    def decode( str, encoding )
+      str.clone.force_encoding( encoding ).encode(
+          DEFAULT_TARGET_ENCODING.to_s, invalid: :replace, undef: :replace, replace: ''
+      )
+    end
+  end
+end