renc 1.3.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2961272d2bc8daa940bc880bbfb4016333c56a8d
-  data.tar.gz: fa2ca88bf5c656d5ed89930a41a9d6a184ad8b46
+  metadata.gz: 6d9665ebabc71fd95740388777621dce95bb7b7c
+  data.tar.gz: ca951228ca44d73c03df61a4054cc90a3147e55f
 SHA512:
-  metadata.gz: '0877c18c27f378076e68127a825f371e8cdad3b001d48ce6897d9eaf880cc085f544cc4b54747c807d35784f3e6da195f36403f69a4f6c7db4a8317d5dcb7a8e'
-  data.tar.gz: 949a2b453def851195f5e4509a0d45045f6f704243b46227ff0b39c1b1f2e28aeee27a88f0ca7e69575de935c32d94b8b397cbe09e713b099cbe0ddbe99acf57
+  metadata.gz: 95ec060b743f14a0585dacc96222fe8a77a68bce26d7931868ece0c8140192972f820ad3ff326d87a41136d4949eb093ffaa126c9a021dad2d995b6f2b042eaa
+  data.tar.gz: 58cfba8cbf227d6230bc32e0dd5b62a65103ea2ce97a9ef377a3782006ad7256affe5733bc13ed2f32c86e6e232e5e3b23ac0449f7c72f5596e6a2e7c2c6a427

data/.rubocop.yml

@@ -12,3 +12,11 @@ AllCops:
 
 Style/AsciiComments:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -9,3 +9,5 @@ rvm:
 before_install:
   - gem update --system --no-doc
   - gem install bundler
+after_success:
+  - bundle exec codeclimate-test-reporter

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v2.0.0
+- [issue #10](https://github.com/k-ta-yamada/renc/issues/10)
+  Changing default_encoding by os #10
+  - change default encoding is `Encoding.default_external`
+- [issue #18](https://github.com/k-ta-yamada/renc/issues/18)
+  Encoding::UndefinedConversionError #18
+  - change `#renc`'s arguments is change.
+    #renc(encoding, `obj`) => #renc(encoding, `options`)
+
 # v1.3.1
 - [issue #14](https://github.com/k-ta-yamada/renc/issues/14)
   String.include is NoMethodError on Ruby 2.0.0

data/README.md

@@ -8,6 +8,7 @@
 
 recurse encoding for Hash and Array.
 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,6 +25,7 @@ Or install it yourself as:
 
     $ gem install renc
 
+
 ## Usage
 
 ### Basic
@@ -48,13 +50,25 @@ hash_val = { a: str_ascii }
 hash_val[:a].encoding      # => #<Encoding::US-ASCII>
 hash_val.renc[:a].encoding # => #<Encoding::UTF-8>
 hash_val.renc == hash_val  # => true
-
 ```
 
 ### Nested Hash, Array, and others
 > @ref [./spec/spec_helper.rb](https://github.com/k-ta-yamada/renc/blob/master/spec/spec_helper.rb#L18)
 
 ```ruby
+nested = {
+  a: 'a', # encoding target1
+  b: {
+    ba: 1,
+    bb: [
+      'bb0', # encoding target2
+      :bb2,
+      3
+    ]
+  }
+}
+nested.renc == nested # => true
+
 # @ref ./spec/spec_helper.rb#L18
 class Hash
   def values_in_nested_hash
@@ -62,38 +76,46 @@ class Hash
   end
 end
 
-nested = { a: 'a',           # encoding target1
-           b: { ba: 1,
-                bb: [
-                      'bb0', # encoding target2
-                      :bb2,
-                      3
-                    ]
-              }
-         }
-nested.renc == nested # => true
-
-encoded_string_values = nested.values_in_nested_hash
-encoded_string_values.flatten!
+encoded_string_values = nested.values_in_nested_hash # => ["a", [1, ["bb0", :bb2, 3]]]
+encoded_string_values.flatten! # => ["a", 1, "bb0", :bb2, 3]
 encoded_string_values.select! { |v| v.is_a?(String) } # => ["a", "bb0"]
 encoded_string_values.all? { |v| v.encoding == Encoding::UTF_8 } # => true
 ```
 
 ### Configuration
 
+#### Renc.default_encoding
+
 ```ruby
-# default configure encoding is utf-8
+# default configure encoding is Encoding.default_external
+Encoding.default_external # => #<Encoding::UTF-8>
 Renc.default_encoding # => #<Encoding::UTF-8>
 'test'.renc.encoding  # => #<Encoding::UTF-8>
 
-# if you want to change to sjis
-Renc.default_encoding = Encoding::Windows_31J
-'test'.renc.encoding  # => #<Encoding::Windows-31J>
+# if you want to change to ascii
+Renc.default_encoding = Encoding::ASCII
+'test'.renc.encoding  # => #<Encoding::ASCII>
 
 # change temporaly
 'test'.renc(Encoding::ASCII).encoding # => #<Encoding:US-ASCII>
 ```
 
+#### Renc.default_options
+
+```ruby
+# default configure options is { undef: :replace }
+Renc.default_options # => { undef: :replace }
+'🐘'.renc  # => '?'
+
+# if you want to change to ascii
+Renc.default_options = { undef: nil }
+'🐘'.renc  # => Encoding::UndefinedConversionError: U+1F418 from UTF-8 to US-ASCII
+
+# change temporaly
+'🐘'.renc(Encoding::ASCII, undef: nil).encoding # => Encoding::UndefinedConversionError: U+1F418 from UTF-8 to US-ASCII
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
@@ -108,6 +130,7 @@ which will create a git tag for the version,
 push git commits and tags,
 and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+
 ## Contributing
 
 Bug reports and pull requests are welcome on

data/lib/renc.rb

@@ -1,17 +1,25 @@
 require 'renc/version'
 
 # recurse encoding for Hash and Array.
+# @example
+#   require 'renc'
+#
+#   # or context `main`
+#   extend Renc
+# @see #renc
 module Renc
-  # raise unless encoding.is_a?(Encoding)
-  class ConfigureError < StandardError; end
-
-  # this gem's default configured encoding
-  DEFAULT_ENCODING = Encoding::UTF_8
-
   # for include #renc method
   TARGET_CLASS = [String, Array, Hash].freeze
   TARGET_CLASS.each { |klass| klass.send(:include, self) }
 
+  # this gem's default configured encoding
+  # @see Encoding.default_external
+  DEFAULT_ENCODING = Encoding.default_external
+
+  # this gem's default options for String#encode
+  # @see String#encode
+  DEFAULT_OPTIONS = { undef: :replace }.freeze
+
   class << self
     # return @default_encoding
     # @return [Encoding] @default_encoding
@@ -21,60 +29,85 @@ module Renc
     end
 
     # configure default encoding
-    # @param encoding [Encoding]
     # @example
     #   Renc.default_encoding = 1 # => Renc::ConfigureError
     #   Renc.default_encoding = Encoding::ASCII
+    # @param encoding [Encoding]
     def default_encoding=(encoding)
-      raise ConfigureError,
-            'Encoding class only allow' unless encoding.is_a?(Encoding)
+      raise TypeError unless encoding.is_a?(Encoding)
       @default_encoding = encoding
     end
+
+    # return @default_options
+    # @return [Encoding] @default_options
+    # @see DEFAULT_OPTIONS
+    def default_options
+      @default_options ||= DEFAULT_OPTIONS
+    end
+
+    # configure default options
+    # @example
+    #   Renc.default_options = 1 # => Renc::ConfigureError
+    #   Renc.default_options = { undef: nil }
+    # @param options [Hash]
+    def default_options=(options)
+      raise TypeError unless options.is_a?(Hash)
+      @default_options = options
+    end
   end
 
   # recurse encoding for Hash and Array.
-  # @param encoding [Encoding]
-  # @param obj [Object]
-  # @return [Object]
   # @example
+  #   # for example
   #   default_src_encoding # => #<Encoding:UTF-8>
   #
   #   # Hash values
-  #   result = { a: 'a', b: 'b', c: 'c' }.renc(Encoding::Windows_31J)
+  #   result = { a: 'a', b: 'b', c: 'c' }.renc(Encoding::ASCII)
   #   result # => { a: 'a', b: 'b', c: 'c' }
-  #   result.values.map(&:encoding).all? { Encoding::Windows_31J } # => true
+  #   result.values.map(&:encoding).all? { Encoding::ASCII } # => true
   #
   #   # Array values
-  #   result = %w(a b c).renc(Encoding::Windows_31J)
+  #   result = %w(a b c).renc(Encoding::ASCII)
   #   result # => ['a', 'b', 'c']
-  #   result.map(&:encoding).all? { Encoding::Windows_31J } # => true
+  #   result.map(&:encoding).all? { Encoding::ASCII } # => true
   #
-  #   # if u define Kernel.renc method.
-  #   Kernel.include Renc
-  #   Object.include Kernel
-  #   # or context `main`
-  #   extend Renc
-  def renc(encoding = Renc.default_encoding, obj = self)
-    case obj
-    when String then obj.encode(encoding)
-    when Array  then renc_array(obj, encoding)
-    when Hash   then renc_hash(obj, encoding)
-    else             obj
-    end
+  #   # with configure default_encoding
+  #   Renc.default_encoding = Encoding::ASCII
+  #   result = 'hello'.renc
+  #   result # => 'hello'
+  #   result.encoding # => Encoding::ASCII
+  # @param encoding [Encoding]
+  # @param options [Hash]
+  # @return [Object]
+  # @see .default_encoding
+  # @see .default_options
+  def renc(encoding = Renc.default_encoding, options = Renc.default_options)
+    raise TypeError unless encoding.is_a?(Encoding)
+    raise TypeError unless options.is_a?(Hash)
+
+    renc_internal(self, encoding, options)
   end
 
   private
 
+  def renc_internal(obj, encoding, options)
+    case obj
+    when Hash   then renc_hash(obj, encoding, options)
+    when Array  then renc_array(obj, encoding, options)
+    when String then obj.encode(encoding, options)
+    else obj
+    end
+  end
+
   # recurse encoding for Hash values of String.
-  def renc_hash(obj, encoding)
-    obj.each_with_object({}) do |args, h|
-      key, val = args
-      h[key] = renc(encoding, val)
+  def renc_hash(obj, encoding, options)
+    obj.each_with_object({}) do |(key, val), h|
+      h[key] = renc_internal(val, encoding, options)
     end
   end
 
   # recurse encoding for Array values of String.
-  def renc_array(obj, encoding)
-    obj.map { |val| renc(encoding, val) }
+  def renc_array(obj, encoding, options)
+    obj.map { |val| renc_internal(val, encoding, options) }
   end
 end

data/lib/renc/version.rb

@@ -1,3 +1,3 @@
 module Renc
-  VERSION = '1.3.1'.freeze
+  VERSION = '2.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renc
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 2.0.0
 platform: ruby
 authors:
 - k-ta-yamada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-06 00:00:00.000000000 Z
+date: 2017-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler