renc 2.0.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6d9665ebabc71fd95740388777621dce95bb7b7c
-  data.tar.gz: ca951228ca44d73c03df61a4054cc90a3147e55f
+SHA256:
+  metadata.gz: 750acdb58a73c029d510df8600bf2a86180e0a92d0740270d6c99dfe96348188
+  data.tar.gz: ae4999e736bfadce482148ac54e43115452e39f1ea17f93971fe14d81517fae5
 SHA512:
-  metadata.gz: 95ec060b743f14a0585dacc96222fe8a77a68bce26d7931868ece0c8140192972f820ad3ff326d87a41136d4949eb093ffaa126c9a021dad2d995b6f2b042eaa
-  data.tar.gz: 58cfba8cbf227d6230bc32e0dd5b62a65103ea2ce97a9ef377a3782006ad7256affe5733bc13ed2f32c86e6e232e5e3b23ac0449f7c72f5596e6a2e7c2c6a427
+  metadata.gz: 3c30d4bb81f8f243a2082eb3c32d21da3eb967a24c37dc4d175757a6b02f3308a300cc7c2d415f1b67cf980c5fcc54fbef28fbb15cdf449ce8893e587b0624e1
+  data.tar.gz: 4eb48aa439836190cc3e73631348fcb590898fe29a32d339fc94fb3548275368621c21353856bf8151f524198d603c3e6fabc8fcc87c19774172b7a9c28aacce

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/.travis.yml

@@ -1,13 +1,18 @@
 language: ruby
+
 cache: bundler
+
 rvm:
-  - 2.4.0
-  - 2.3.3
-  - 2.2.6
-  - 2.1.10
-  - 2.0.0-p648
+  - 3.0
+  - 2.7
+  - 2.6
+
 before_install:
-  - gem update --system --no-doc
-  - gem install bundler
-after_success:
-  - bundle exec codeclimate-test-reporter
+  - 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,4 +1,35 @@
-# v2.0.0
+# CHANGELOG.md
+
+## v2.2.2
+
+2021-09-04 JST
+
+- required_ruby_version change to `>= 2.6.0` because Ruby 2.5 reaches EOL.
+
+## 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`
@@ -7,27 +38,33 @@
   - change `#renc`'s arguments is change.
     #renc(encoding, `obj`) => #renc(encoding, `options`)
 
-# v1.3.1
+## 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
+## 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
+## 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.
@@ -36,8 +73,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,15 +1,32 @@
+# Renc
+
 [![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
+recursive encode for Hash and Array.
+
+<!-- TOC -->
 
-recurse encoding for Hash and Array.
+- [1. Installation](#1-installation)
+- [2. Usage](#2-usage)
+  - [2.1. Basic](#21-basic)
+  - [2.2. Nested Hash and Array](#22-nested-hash-and-array)
+  - [2.3. Configuration](#23-configuration)
+    - [2.3.1. Renc.default_encoding](#231-rencdefault_encoding)
+    - [2.3.2. Renc.default_options](#232-rencdefault_options)
+- [3. Development](#3-development)
+- [4. Contributing](#4-contributing)
+- [5. License](#5-license)
 
+<!-- /TOC -->
 
-## Installation
+---
+
+## 1. Installation
 
 Add this line to your application's Gemfile:
 
@@ -19,16 +36,21 @@ gem 'renc'
 
 And then execute:
 
-    $ bundle
+```sh
+bundle
+```
 
 Or install it yourself as:
 
-    $ gem install renc
+```sh
+gem install renc
+```
 
+---
 
-## Usage
+## 2. Usage
 
-### Basic
+### 2.1. Basic
 
 ```ruby
 require 'renc'
@@ -52,7 +74,8 @@ hash_val.renc[:a].encoding # => #<Encoding::UTF-8>
 hash_val.renc == hash_val  # => true
 ```
 
-### Nested Hash, Array, and others
+### 2.2. Nested Hash and Array
+
 > @ref [./spec/spec_helper.rb](https://github.com/k-ta-yamada/renc/blob/master/spec/spec_helper.rb#L18)
 
 ```ruby
@@ -82,9 +105,9 @@ encoded_string_values.select! { |v| v.is_a?(String) } # => ["a", "bb0"]
 encoded_string_values.all? { |v| v.encoding == Encoding::UTF_8 } # => true
 ```
 
-### Configuration
+### 2.3. Configuration
 
-#### Renc.default_encoding
+#### 2.3.1. Renc.default_encoding
 
 ```ruby
 # default configure encoding is Encoding.default_external
@@ -100,14 +123,14 @@ Renc.default_encoding = Encoding::ASCII
 'test'.renc(Encoding::ASCII).encoding # => #<Encoding:US-ASCII>
 ```
 
-#### Renc.default_options
+#### 2.3.2. Renc.default_options
 
 ```ruby
 # default configure options is { undef: :replace }
 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
 
@@ -115,8 +138,9 @@ Renc.default_options = { undef: nil }
 '🐘'.renc(Encoding::ASCII, undef: nil).encoding # => Encoding::UndefinedConversionError: U+1F418 from UTF-8 to US-ASCII
 ```
 
+---
 
-## Development
+## 3. Development
 
 After checking out the repo, run `bin/setup` to install dependencies.
 Then, run `rake spec` to run the tests.
@@ -130,31 +154,36 @@ 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
+## 4. Contributing
 
 Bug reports and pull requests are welcome on
 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
+## 5. 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).
 
+---
 
+eof
 
-[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
+[travis]: https://app.travis-ci.com/k-ta-yamada/renc
+[travis-svg]: https://app.travis-ci.com/k-ta-yamada/renc.svg?branch=master
 [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
+[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/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 = '2.0.0'.freeze
+  VERSION = '2.2.2'.freeze
 end

data/lib/renc.rb

@@ -1,6 +1,7 @@
 require 'renc/version'
+require 'renc/configuration'
 
-# recurse encoding for Hash and Array.
+# recursive encode for Hash and Array.
 # @example
 #   require 'renc'
 #
@@ -8,55 +9,13 @@ require 'renc/version'
 #   extend Renc
 # @see #renc
 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) }
 
-  # 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
-    # @see DEFAULT_ENCODING
-    def default_encoding
-      @default_encoding ||= DEFAULT_ENCODING
-    end
-
-    # configure default encoding
-    # @example
-    #   Renc.default_encoding = 1 # => Renc::ConfigureError
-    #   Renc.default_encoding = Encoding::ASCII
-    # @param encoding [Encoding]
-    def default_encoding=(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.
+  # recursive encode for Hash and Array.
   # @example
   #   # for example
   #   default_src_encoding # => #<Encoding:UTF-8>
@@ -82,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
 
-  # recurse encoding 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
+  # 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
 
-  # recurse encoding for Array values of String.
-  def renc_array(obj, encoding, options)
-    obj.map { |val| renc_internal(val, encoding, options) }
+  # recursive encode for Hash values of Struct.
+  def _struct(obj)
+    obj.class.new(*_renc(obj.to_h).values)
   end
 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.6.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,15 @@ 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'
+  # Workaround for cc-test-reporter with SimpleCov 0.18.
+  # Stop upgrading SimpleCov until the following issue will be resolved.
+  # https://github.com/codeclimate/test-reporter/issues/418
+  # https://github.com/codeclimate/test-reporter/issues/413
+  spec.add_development_dependency 'simplecov', '= 0.17'
+  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: 2.0.0
+  version: 2.2.2
 platform: ruby
 authors:
 - k-ta-yamada
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-02-15 00:00:00.000000000 Z
+date: 2021-09-04 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.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  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: '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,16 +198,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-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: []

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