renc 1.3.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d3125b37f8be1fbbb5c13ed9b8cfc46a9b194842
-  data.tar.gz: e4728c765ba5fa9e0ee91bcf529eea90291582e3
+SHA256:
+  metadata.gz: 12a07a3819b5e0c3ac476b111f346a56a3a7936ca2843c00006367ff96ffa98a
+  data.tar.gz: 49c6afd4b3e1f84020be224fdd66a65e89688b8154fbf58596afecc0049e79bc
 SHA512:
-  metadata.gz: 0fa3a777853a2e7e32df811616bcf2379150dc8537696c0575d24d3ed1208724a858c2891558e8232617073b781387f4046b5a829cb825172ed42bbba70e3f56
-  data.tar.gz: 28f87fdcf7561059f7b48580ef1cfa3d38af1ca586a2cfc230a05c6bb8feb85c3d5134893e3728cd2c84e6ceda03277b38925784e63a8afa9da032e71329df63
+  metadata.gz: 0b37003f38acf041ca5b8e7710f0dfc2a4b6b4d7acf1e464a6135e4f41c799c16b12c1ac631f98e6823f88754516d2a408faa9c57eafe0db34f8f88a2874d1a6
+  data.tar.gz: 253d69c822c8865bacf37402fa1c52c593f4231dbf999e8821e12f29e5b76d59b33abac206eb09194b0ad0e3b08571a2574a5d18991d27eb84783db8d2c65c4f

data/.gitignore

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

data/.rubocop.yml

@@ -9,6 +9,15 @@ AllCops:
   Exclude:
     - renc.gemspec
     - vendor/**/*
+    - bin/**/*
 
 Style/AsciiComments:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/LineLength:
+  Exclude:
+    - spec/**/*

data/.travis.yml

@@ -1,6 +1,19 @@
 language: ruby
+
 cache: bundler
+
 rvm:
-  - 2.3.0
-  - 2.2.4
-before_install: gem install bundler -v 1.11.2
+  - 3.0
+  - 2.7
+  - 2.6
+  - 2.5
+
+before_install:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+
+before_script:
+  - ./cc-test-reporter before-build
+
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CHANGELOG.md

@@ -1,20 +1,64 @@
-# v1.3.0
-- [issue #7](https://github.com/k-ta-yamada/tee_logger/issues/7)
+# CHANGELOG.md
+
+## v2.2.1
+
+2020-12-31 JST
+
+- Add support for Ruby 3.0
+
+## 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
+
+## 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
+
+## v1.3.0
+
+- [issue #7](https://github.com/k-ta-yamada/renc/issues/7)
   configuration default encoding
 
-# v1.2.0
+## v1.2.0
+
 - remove `Renc#enc` method
 
-# v1.1.0
-- [issue #4](https://github.com/k-ta-yamada/tee_logger/issues/4)
+## v1.1.0
+
+- [issue #4](https://github.com/k-ta-yamada/renc/issues/4)
   #renc for Hash and Array
 
-# v1.0.1
+## v1.0.1
+
 - required Ruby version is change to over 2.0.0.
   - gemspec: `spec.required_ruby_version = '>= 2.0.0'`
     - maybe, be able to run on `version >= 2.0.0`.
 
-# v1.0.0
+## v1.0.0
+
 - change to instance_method from singleton_method.
 - renc method is implemented.
 - enc method is deprecated.
@@ -23,8 +67,10 @@
     - maybe, be able to run on `version >= 2.0.0`.
   - Travis CI: 2.2.4, 2.3.0
 
-# v0.2.0
+## v0.2.0
+
 - implement base features.
 
-# v0.1.0
+## v0.1.0
+
 - sorry, this version is dummy.

data/Gemfile

@@ -2,5 +2,3 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in renc.gemspec
 gemspec
-gem 'codeclimate-test-reporter', group: :test, require: nil
-gem 'simplecov-console', group: :test, require: nil

data/README.md

@@ -1,12 +1,14 @@
 [![Gem Version][gem_version-svg]][gem_version]
 [![Build Status][travis-svg]][travis]
+[![Downloads][downloads-svg]][gem_version]
+[![Inline docs][inch-ci-svg]][inch-ci]
 [![Code Climate][codeclimate-svg]][codeclimate]
 [![Test Coverage][codeclimate_cov-svg]][codeclimate_cov]
-[![Inline docs][inch-ci-svg]][inch-ci]
 
 # Renc
 
-recurse encoding for Hash and Array.
+recursive encode for Hash and Array.
+
 
 ## Installation
 
@@ -24,6 +26,7 @@ Or install it yourself as:
 
     $ gem install renc
 
+
 ## Usage
 
 ### Basic
@@ -48,13 +51,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/feature/issue7/spec/spec_helper.rb#L18)
+### Nested Hash and Array.
+> @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 +77,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 { undef: nil }
+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 +131,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
@@ -115,17 +139,17 @@ GitHub at https://github.com/k-ta-yamada/renc.
 This project is intended to be a safe,
 welcoming space for collaboration,
 and contributors are expected to adhere to the
-[Contributor Covenant](http://contributor-covenant.org) code of conduct.
+[Contributor Covenant](https://contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source
-under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
 
 
-[gem_version]: http://badge.fury.io/rb/renc
+[gem_version]: https://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
@@ -133,5 +157,6 @@ under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 [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
+[inch-ci]: https://inch-ci.org/github/k-ta-yamada/renc
+[inch-ci-svg]: https://inch-ci.org/github/k-ta-yamada/renc.svg?branch=master
+[downloads-svg]: https://ruby-gem-downloads-badge.herokuapp.com/renc?type=total&total_label=&color=brightgreen

data/lib/renc.rb

@@ -1,80 +1,79 @@
 require 'renc/version'
+require 'renc/configuration'
 
-# recurse encoding for Hash and Array.
+# recursive encode 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
+  extend Configuration
 
   # for include #renc method
-  TARGET_CLASS = [String, Array, Hash].freeze
-  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
+  TARGET_CLASS = [String, Array, Hash, Struct].freeze
+  TARGET_CLASS.each { |klass| klass.send(:include, self) }
 
-  # recurse encoding for Hash and Array.
-  # @param encoding [Encoding]
-  # @param obj [Object]
-  # @return [Object]
+  # recursive encode for Hash and Array.
   # @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, ERR_MESSAGE_ENCODING unless encoding.is_a?(Encoding)
+    raise TypeError, ERR_MESSAGE_OPTIONS unless options.is_a?(Hash)
+
+    @encoding = encoding
+    @options  = options
+
+    _renc(self)
   end
 
   private
 
-  # 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(obj)
+    case obj
+    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
 
-  # recurse encoding for Array values of String.
-  def renc_array(obj, encoding)
-    obj.map { |val| renc(encoding, val) }
+  # recursive encode for Hash values of String.
+  def _hash(obj)
+    obj.transform_values { |v| _renc(v) }
+  end
+
+  # recursive encode for Array values of String.
+  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

@@ -0,0 +1,51 @@
+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
+    # @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
+
+    # return @default_encoding
+    # @return [Encoding] @default_encoding
+    # @see DEFAULT_ENCODING
+    def default_encoding
+      @default_encoding ||= DEFAULT_ENCODING
+    end
+
+    # configure default encoding
+    # @example
+    #   Renc.default_encoding = 1 # => TypeError
+    #   Renc.default_encoding = Encoding::ASCII
+    # @param encoding [Encoding]
+    def default_encoding=(encoding)
+      raise TypeError, ERR_MESSAGE_ENCODING 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 # => TypeError
+    #   Renc.default_options = { undef: nil }
+    # @param options [Hash]
+    def default_options=(options)
+      raise TypeError, ERR_MESSAGE_OPTIONS unless options.is_a?(Hash)
+
+      @default_options = options
+    end
+  end
+end

data/lib/renc/version.rb

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

data/renc.gemspec

@@ -9,10 +9,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ['k-ta-yamada']
   spec.email         = ['key.luvless@gmail.com']
 
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.5.0'
 
-  spec.summary       = 'recurse encoding for Hash and Array.'
-  spec.description   = 'recurse encoding for Hash and Array.'
+  spec.summary       = 'recursive encode for Hash and Array.'
+  spec.description   = 'recursive encode for Hash and Array.'
   spec.homepage      = 'https://github.com/k-ta-yamada/renc'
   spec.license       = 'MIT'
 
@@ -21,9 +21,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.11'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-console'
 
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-doc'

metadata

@@ -1,57 +1,85 @@
 --- !ruby/object:Gem::Specification
 name: renc
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.2.1
 platform: ruby
 authors:
 - k-ta-yamada
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2016-03-04 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +164,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: recurse encoding for Hash and Array.
+description: recursive encode for Hash and Array.
 email:
 - key.luvless@gmail.com
 executables: []
@@ -154,16 +182,15 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - lib/renc.rb
+- lib/renc/configuration.rb
 - lib/renc/version.rb
 - renc.gemspec
 homepage: https://github.com/k-ta-yamada/renc
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -171,17 +198,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.5.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: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
-summary: recurse encoding for Hash and Array.
+summary: recursive encode for Hash and Array.
 test_files: []
-has_rdoc: 

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