renc 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b87be5d18214f6f0241ba83689760173435cd375
-  data.tar.gz: 7473827a7e4e0d4a383ed28fa148b820978dc96f
+  metadata.gz: 7f70f4e782058204a07038072f5f044f6c70a6ac
+  data.tar.gz: c8b8331054b0c93b40fca1fa9d7db3d27c0e4810
 SHA512:
-  metadata.gz: ca57295a0c03eb1e6cc5b08cb96908c9d3a5e73654c38ee90ff2315aa958f497d86ff8c56519abd1690b12c809248648f35d227a6dce009d5661f19df69e6f83
-  data.tar.gz: 6c47aac8531825d80c21c4c64ec2798a57b44ccb85b7e1093bfc20155bd09a8209d7fff2787cc384c2838c8de8528e7abf27f07ca54dd89b348f74976df08538
+  metadata.gz: 0c5f4a131d471a306f3f1cf58cef2eee70e5df70bbda6c3c46b2de09ab67e5299d8cc1348fdb9ec0ecab155364ada431d64ad5e0e369bc0917fadcb13f55aa67
+  data.tar.gz: d632b298ec50c4c6ca6e693b0d50cb07df1acf9603102e55c0a6e0c6835a10616be4cb696ab5d8754652597d2d11125ca4b7f4a222e5937784efcbe89102d51e

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 
 /vendor
+/bin

data/.rubocop.yml

@@ -9,6 +9,7 @@ AllCops:
   Exclude:
     - renc.gemspec
     - vendor/**/*
+    - bin/**/*
 
 Style/AsciiComments:
   Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# v2.2.0
+2017-08-11 JST
+- [issue #25](https://github.com/k-ta-yamada/renc/issues/25)
+  [add] Add target Class Struct #25
+- [issue #26](https://github.com/k-ta-yamada/renc/issues/26)
+  [mod] Add error message details #26
+- [issue #23](https://github.com/k-ta-yamada/renc/issues/23)
+  [clean] Renc::Configuration.default_xxx='s comment is wrong #23
+
 # v2.1.0
 - [issue #21](https://github.com/k-ta-yamada/renc/issues/21)
   change class structure; Separate Configuration #21

data/README.md

@@ -52,7 +52,7 @@ hash_val.renc[:a].encoding # => #<Encoding::UTF-8>
 hash_val.renc == hash_val  # => true
 ```
 
-### Nested Hash, Array, and others
+### Nested Hash and Array.
 > @ref [./spec/spec_helper.rb](https://github.com/k-ta-yamada/renc/blob/master/spec/spec_helper.rb#L18)
 
 ```ruby
@@ -107,7 +107,7 @@ Renc.default_encoding = Encoding::ASCII
 Renc.default_options # => { undef: :replace }
 '🐘'.renc  # => '?'
 
-# if you want to change to ascii
+# if you want to change to { undef: nil }
 Renc.default_options = { undef: nil }
 '🐘'.renc  # => Encoding::UndefinedConversionError: U+1F418 from UTF-8 to US-ASCII
 

data/lib/renc.rb

@@ -12,7 +12,7 @@ module Renc
   extend Configuration
 
   # for include #renc method
-  TARGET_CLASS = [String, Array, Hash].freeze
+  TARGET_CLASS = [String, Array, Hash, Struct].freeze
   TARGET_CLASS.each { |klass| klass.send(:include, self) }
 
   # recursive encode for Hash and Array.
@@ -41,32 +41,39 @@ module Renc
   # @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)
+    raise TypeError, ERR_MESSAGE_ENCODING unless encoding.is_a?(Encoding)
+    raise TypeError, ERR_MESSAGE_OPTIONS unless options.is_a?(Hash)
 
-    renc_internal(self, encoding, options)
+    @encoding = encoding
+    @options  = options
+
+    _renc(self)
   end
 
   private
 
-  def renc_internal(obj, encoding, options)
+  def _renc(obj)
     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)
+    when String then obj.encode(@encoding, @options)
+    when Hash   then _hash(obj)
+    when Array  then _array(obj)
+    when Struct then _struct(obj)
     else obj
     end
   end
 
   # recursive encode for Hash values of String.
-  def renc_hash(obj, encoding, options)
-    obj.each_with_object({}) do |(key, val), h|
-      h[key] = renc_internal(val, encoding, options)
-    end
+  def _hash(obj)
+    obj.each_with_object({}) { |(k, v), h| h[k] = _renc(v) }
   end
 
   # recursive encode for Array values of String.
-  def renc_array(obj, encoding, options)
-    obj.map { |val| renc_internal(val, encoding, options) }
+  def _array(obj)
+    obj.map { |v| _renc(v) }
+  end
+
+  # recursive encode for Hash values of Struct.
+  def _struct(obj)
+    obj.class.new(*_renc(obj.to_h).values)
   end
 end

data/lib/renc/configuration.rb

@@ -1,4 +1,7 @@
 module Renc
+  ERR_MESSAGE_ENCODING = 'argument `encoding` is not a Encoding Class'.freeze
+  ERR_MESSAGE_OPTIONS  = 'argument `options` is not a Hash Class'.freeze
+
   # namespace
   module Configuration
     # this gem's default configured encoding
@@ -18,11 +21,11 @@ module Renc
 
     # configure default encoding
     # @example
-    #   Renc.default_encoding = 1 # => Renc::ConfigureError
+    #   Renc.default_encoding = 1 # => TypeError
     #   Renc.default_encoding = Encoding::ASCII
     # @param encoding [Encoding]
     def default_encoding=(encoding)
-      raise TypeError unless encoding.is_a?(Encoding)
+      raise TypeError, ERR_MESSAGE_ENCODING unless encoding.is_a?(Encoding)
       @default_encoding = encoding
     end
 
@@ -35,11 +38,11 @@ module Renc
 
     # configure default options
     # @example
-    #   Renc.default_options = 1 # => Renc::ConfigureError
+    #   Renc.default_options = 1 # => TypeError
     #   Renc.default_options = { undef: nil }
     # @param options [Hash]
     def default_options=(options)
-      raise TypeError unless options.is_a?(Hash)
+      raise TypeError, ERR_MESSAGE_OPTIONS unless options.is_a?(Hash)
       @default_options = options
     end
   end

data/lib/renc/version.rb

@@ -1,3 +1,3 @@
 module Renc
-  VERSION = '2.1.0'.freeze
+  VERSION = '2.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: renc
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - k-ta-yamada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-19 00:00:00.000000000 Z
+date: 2017-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -154,8 +154,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/renc.rb
 - lib/renc/configuration.rb
 - lib/renc/version.rb
@@ -180,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: recursive encode for Hash and Array.

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bundler/setup'
-require 'renc'
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-require 'pry'
-Pry.start
-
-# require 'irb'
-# IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here