renc 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d23dd022e00e54050a4613a1aae4999e49046876
-  data.tar.gz: 5e0c6ca26059dcfaa1c52ff9f522a5e3bb35362d
+  metadata.gz: d3125b37f8be1fbbb5c13ed9b8cfc46a9b194842
+  data.tar.gz: e4728c765ba5fa9e0ee91bcf529eea90291582e3
 SHA512:
-  metadata.gz: 6bd1436484490cf7f116aad27f3b7eb044292148857f11b6956e7369822f4ec3aa708d2dd9ad100252964ca05c01108723b971eb5c33ac7862ad0f1301e7f703
-  data.tar.gz: 7424d0ddbcd033c1416a01d34bb39db2dc4a98b222fead380395cc1d9d44f3c89b4897ee9f7610f4db2d919be9fae0de65c9c58597c5a7300ef3cc889076e70e
+  metadata.gz: 0fa3a777853a2e7e32df811616bcf2379150dc8537696c0575d24d3ed1208724a858c2891558e8232617073b781387f4046b5a829cb825172ed42bbba70e3f56
+  data.tar.gz: 28f87fdcf7561059f7b48580ef1cfa3d38af1ca586a2cfc230a05c6bb8feb85c3d5134893e3728cd2c84e6ceda03277b38925784e63a8afa9da032e71329df63

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# v1.3.0
+- [issue #7](https://github.com/k-ta-yamada/tee_logger/issues/7)
+  configuration default encoding
+
 # v1.2.0
 - remove `Renc#enc` method
 

data/README.md

@@ -26,20 +26,72 @@ Or install it yourself as:
 
 ## Usage
 
+### Basic
+
 ```ruby
 require 'renc'
 
+# String
 str_ascii = 'hello renc!'.encode(Encoding::ASCII)
-str_ascii.encoding # => #<Encoding::US-ASCII>
-Renc.enc(str_ascii, Encoding::UTF_8).encoding # => #<Encoding::UTF-8>
+str_ascii.encoding          # => #<Encoding::US-ASCII>
+str_ascii.renc.encoding     # => #<Encoding::UTF-8>
+str_ascii == str_ascii.renc # => true
+
+# Array
+array_val = [str_ascii]
+array_val.first.encoding      # => #<Encoding::US-ASCII>
+array_val.renc.first.encoding # => #<Encoding::UTF-8>
+array_val.renc == array_val   # => ture
 
+# Hash
 hash_val = { a: str_ascii }
-hash_val[:a].encoding # => Encoding::ASCII
-Renc.enc(hash_val, Encoding::UTF_8)[:a].encoding # => #<Encoding::UTF-8>
+hash_val[:a].encoding      # => #<Encoding::US-ASCII>
+hash_val.renc[:a].encoding # => #<Encoding::UTF-8>
+hash_val.renc == hash_val  # => true
 
-array_val = [str_ascii]
-array_val.first.encoding # => Encoding::ASCII
-Renc.enc(array_val, Encoding::UTF_8).first.encoding # => #<Encoding::UTF-8>
+```
+
+### Nested Hash, Array, and others
+> @ref [./spec/spec_helper.rb](https://github.com/k-ta-yamada/renc/blob/feature/issue7/spec/spec_helper.rb#L18)
+
+```ruby
+# @ref ./spec/spec_helper.rb#L18
+class Hash
+  def values_in_nested_hash
+    map { |_k, v| v.is_a?(Hash) ? v.values_in_nested_hash : v }
+  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.select! { |v| v.is_a?(String) } # => ["a", "bb0"]
+encoded_string_values.all? { |v| v.encoding == Encoding::UTF_8 } # => true
+```
+
+### Configuration
+
+```ruby
+# default configure encoding is 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>
+
+# change temporaly
+'test'.renc(Encoding::ASCII).encoding # => #<Encoding:US-ASCII>
 ```
 
 ## Development
@@ -75,15 +127,11 @@ under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
 [gem_version]: http://badge.fury.io/rb/renc
 [gem_version-svg]: https://badge.fury.io/rb/renc.svg
-
 [travis]: https://travis-ci.org/k-ta-yamada/renc
 [travis-svg]: https://travis-ci.org/k-ta-yamada/renc.svg
-
 [codeclimate]: https://codeclimate.com/github/k-ta-yamada/renc
 [codeclimate-svg]: https://codeclimate.com/github/k-ta-yamada/renc/badges/gpa.svg
-
 [codeclimate_cov]: https://codeclimate.com/github/k-ta-yamada/renc/coverage
 [codeclimate_cov-svg]: https://codeclimate.com/github/k-ta-yamada/renc/badges/coverage.svg
-
 [inch-ci]: http://inch-ci.org/github/k-ta-yamada/renc
 [inch-ci-svg]: http://inch-ci.org/github/k-ta-yamada/renc.svg?branch=master

data/lib/renc.rb

@@ -1,34 +1,60 @@
 require 'renc/version'
 
 # recurse encoding for Hash and Array.
-# @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' }
-#   result.values.map(&:encoding).all? { Encoding::Windows_31J } # => true
-#
-#   # Array values
-#   result = %w(a b c).renc(Encoding::Windows_31J)
-#   result # => ['a', 'b', 'c']
-#   result.map(&:encoding).all? { Encoding::Windows_31J } # => true
-#
-#   # if u define Kernel.renc method.
-#   Kernel.include Renc
-#   Object.include Kernel
-#   # or context `main`
-#   extend 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
-  # include #renc method
   TARGET_CLASS.each { |klass| klass.include self }
 
+  class << self
+    # return @default_encoding
+    # @return [Encoding] @default_encoding
+    # @see DEFAULT_ENCODING
+    def default_encoding
+      @default_encoding ||= DEFAULT_ENCODING
+    end
+
+    # configure default encoding
+    # @param encoding [Encoding]
+    # @example
+    #   Renc.default_encoding = 1 # => Renc::ConfigureError
+    #   Renc.default_encoding = Encoding::ASCII
+    def default_encoding=(encoding)
+      raise ConfigureError,
+            'Encoding class only allow' unless encoding.is_a?(Encoding)
+      @default_encoding = encoding
+    end
+  end
+
   # recurse encoding for Hash and Array.
   # @param encoding [Encoding]
   # @param obj [Object]
   # @return [Object]
-  def renc(encoding = Encoding::UTF_8, obj = self)
+  # @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' }
+  #   result.values.map(&:encoding).all? { Encoding::Windows_31J } # => true
+  #
+  #   # Array values
+  #   result = %w(a b c).renc(Encoding::Windows_31J)
+  #   result # => ['a', 'b', 'c']
+  #   result.map(&:encoding).all? { Encoding::Windows_31J } # => 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)

data/lib/renc/version.rb

@@ -1,3 +1,3 @@
 module Renc
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renc
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - k-ta-yamada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-02 00:00:00.000000000 Z
+date: 2016-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler