transproc 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 64dbe08d203b9ac87e38de4e8f46dde2899d5cfc
-  data.tar.gz: 6c4e2cd21783a8fea8e3f4ebfe05656ca8e1cd73
+SHA256:
+  metadata.gz: bd2c6ee5f665083297c1fcfd89a5e37d2284e498d6bc3953b88314e9513cbf43
+  data.tar.gz: 6b9a5f270234b26b479095c66187f91fcca9428afb605f75aa9f51b890976eef
 SHA512:
-  metadata.gz: e46205bc38e87eb30fa40d1466bfb0f1cff727a945d985f22bb17ae9ac2c3be4910363403c08f2092514f15c2de6d06b8d5863ec9db530fa600465ea9782c601
-  data.tar.gz: 964e3d01aa66e74542a79ea9844977c299cab95984959d066336b3203b67364e4728938e5412a9cde5acbc7661d5f5d744e3d42d17dc89574856f4d56e8d1aff
+  metadata.gz: 1c79034b27d317e52be52e98eb0cce057400efc99c05203e16fd39112a911d0bb568511d58dd138bbc32568cf8951fab586dcdf90e3c9bff434b6fd93347044b
+  data.tar.gz: a2086dc6a92e03837412d7665869c1ad516a3a5ce097db1b31224936d767af048eadb32c86e8e0bcf815ef38445f9aed9a878b5f5ca97b5559b3194efa567aec

data/.codeclimate.yml

@@ -0,0 +1,15 @@
+version: "2"
+
+prepare:
+  fetch:
+  - url: "https://raw.githubusercontent.com/dry-rb/devtools/master/.rubocop.yml"
+    path: ".rubocop.yml"
+
+exclude_patterns:
+  - "benchmarks/"
+  - "examples/"
+  - "spec/"
+
+plugins:
+  rubocop:
+    enabled: true

data/.gitignore

@@ -13,3 +13,6 @@
 *.o
 *.a
 mkmf.log
+.rubocop.yml
+.rubocop_todo.yml
+

data/.travis.yml

@@ -1,18 +1,22 @@
-dist: trusty
 language: ruby
-sudo: required
 cache: bundler
 bundler_args: --without tools
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+after_script:
+  - "[ -d coverage ] && ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
 script: 'bundle exec rake spec'
-after_success:
-  - '[ "$TRAVIS_RUBY_VERSION" = "2.3.1" ] && [ "$TRAVIS_BRANCH" = "master" ] && bundle exec codeclimate-test-reporter'
 rvm:
-  - 2.0
-  - 2.2
-  - 2.1
-  - 2.3.1
-  - rbx-3
-  - jruby-9.1.5.0
+  - 2.3.8
+  - 2.6.3
+  - 2.5.5
+  - 2.4.6
+  - jruby-9.2.7.0
+env:
+  global:
+    - COVERAGE='true'
 notifications:
   webhooks:
     urls:

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+# v1.1.0 2019-07-18
+
+This is the last transproc release before the project will be forked to `dry-transformer`.
+
+## Added
+
+* New DSL for defining transformers using `define!` method, which now supports instance methods as transformation functions (@solnic)
+* Simplified transformer class definition - registry is auto-configured and you can use `import` at the transformer class level (@solnic)
+* New `HashTransformation.deep_stringify_keys` function
+
+[Compare v1.0.3...v1.1.0](https://github.com/solnic/transproc/compare/v1.0.3...v1.1.0)
+
+# v1.0.3 2018-12-01
+
+## Changed
+
+* [BREAKING] Added minimal Ruby version to the gemspec file. Transproc now works with Ruby 2.3 and above (flash-gordon)
+* Performance improvements introduced by using new built-in methods in `Hash` (v-kolesnikov + flash-gordon)
+
+[Compare v1.0.2...v1.0.3](https://github.com/solnic/transproc/compare/v1.0.2...v1.0.3)
+
 # v1.0.2 2017-02-25
 
 ## Fixed
@@ -8,7 +29,7 @@
 
 # v1.0.1 2017-02-25
 
-* `combine` is now multiple times faster, depending on the level of nesting (Kukunin + splattael) 
+* `combine` is now multiple times faster, depending on the level of nesting (Kukunin + splattael)
 * `nest` (thus `wrap` too) is ~2x faster now (solnic)
 
 [Compare v1.0.0...v1.0.1](https://github.com/solnic/transproc/compare/v1.0.0...v1.0.1)

data/Gemfile

@@ -2,28 +2,15 @@ source 'https://rubygems.org'
 
 gemspec
 
-group :test do
-  gem 'equalizer'
+gem 'rake'
+gem 'rspec', '~> 3.8'
+gem 'dry-equalizer', '~> 0.2'
 
-  if RUBY_VERSION >= '2.1'
-    gem 'anima'
-    platform :mri do
-      gem 'mutant', github: 'mbj/mutant', branch: 'master'
-      gem 'mutant-rspec'
-
-      gem 'codeclimate-test-reporter', require: false
-      gem 'simplecov', require: false
-    end
-  else
-    gem 'anima', '~> 0.2.0'
-  end
+platform :mri do
+  gem 'simplecov', require: false
 end
 
 group :tools do
-  gem 'rubocop', '~> 0.30.0'
   gem 'byebug', platform: :mri
   gem 'benchmark-ips'
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'guard-rubocop'
 end

data/README.md

@@ -1,6 +1,5 @@
 [gem]: https://rubygems.org/gems/transproc
 [travis]: https://travis-ci.org/solnic/transproc
-[gemnasium]: https://gemnasium.com/solnic/transproc
 [codeclimate]: https://codeclimate.com/github/solnic/transproc
 [coveralls]: https://coveralls.io/r/solnic/transproc
 [inchpages]: http://inch-ci.org/github/solnic/transproc
@@ -9,7 +8,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/transproc.svg)][gem]
 [![Build Status](https://travis-ci.org/solnic/transproc.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/solnic/transproc.svg)][gemnasium]
 [![Code Climate](https://codeclimate.com/github/solnic/transproc/badges/gpa.svg)][codeclimate]
 [![Test Coverage](https://codeclimate.com/github/solnic/transproc/badges/coverage.svg)][codeclimate]
 [![Inline docs](http://inch-ci.org/github/solnic/transproc.svg?branch=master)][inchpages]
@@ -197,9 +195,9 @@ transformation = t(:camel_case)
 transformation.call 'i_am_a_camel'
 # => "IAmACamel"
 
-transformation = t(:map_array, t(:symbolize_keys)
- .>> t(:rename_keys, user_name: :user))
- .>> t(:wrap, :address, [:city, :street, :zipcode])
+transformation = t(:map_array, (
+  t(:symbolize_keys).>> t(:rename_keys, user_name: :user)
+  )).>> t(:wrap, :address, [:city, :street, :zipcode])
 
 transformation.call(
   [

data/Rakefile

@@ -1,3 +1,4 @@
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 task default: :spec

data/lib/transproc.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'transproc/version'
+require 'transproc/constants'
 require 'transproc/function'
 require 'transproc/functions'
 require 'transproc/composer'
@@ -8,9 +11,5 @@ require 'transproc/registry'
 require 'transproc/transformer'
 require 'transproc/support/deprecations'
 
-module Transproc
-  Undefined = Object.new.freeze
-end
-
 require 'transproc/array'
 require 'transproc/hash'

data/lib/transproc/all.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'transproc'
 
 require 'transproc/class'

data/lib/transproc/array.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'transproc/coercions'
 require 'transproc/hash'
 require 'transproc/array/combine'
@@ -65,7 +67,7 @@ module Transproc
     # Group array values using provided root key and value keys
     #
     # @example
-    #   fn = Transproc(:group, :tags, [:tag_name])
+    #   fn = Transproc(:group, :tags, [:tag])
     #
     #   fn.call [
     #     { task: 'Group it', tag: 'task' },
@@ -98,10 +100,10 @@ module Transproc
     # Ungroup array values using provided root key and value keys
     #
     # @example
-    #   fn = Transproc(:group, :tags, [:tag_name])
+    #   fn = Transproc(:ungroup, :tags, [:tag])
     #
     #   fn.call [
-    #     { task: 'Group it', tags: [{ tag: 'task' }, { tag: 'important' }]
+    #     { task: 'Group it', tags: [{ tag: 'task' }, { tag: 'important' }] }
     #   ]
     #   # => [
     #     { task: 'Group it', tag: 'task' },

data/lib/transproc/array/combine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Transproc
   module ArrayTransformations
     class Combine

data/lib/transproc/class.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Transproc
   # Transformation functions for Classes
   #

data/lib/transproc/coercions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'time'
 require 'bigdecimal'

data/lib/transproc/compiler.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Transproc
+  # @api private
+  class Compiler
+    InvalidFunctionNameError = Class.new(StandardError)
+
+    attr_reader :registry, :transformer
+
+    def initialize(registry, transformer = nil)
+      @registry = registry
+      @transformer = transformer
+    end
+
+    def call(ast)
+      ast.map(&method(:visit)).reduce(:>>)
+    end
+
+    def visit(node)
+      id, *rest = node
+      public_send(:"visit_#{id}", *rest)
+    end
+
+    def visit_fn(node)
+      name, rest = node
+      args = rest.map { |arg| visit(arg) }
+
+      if registry.contain?(name)
+        registry[name, *args]
+      elsif transformer.respond_to?(name)
+        Function.new(transformer.method(name), name: name, args: args)
+      else
+        raise InvalidFunctionNameError, "function name +#{name}+ is not valid"
+      end
+    end
+
+    def visit_arg(arg)
+      arg
+    end
+
+    def visit_t(node)
+      call(node)
+    end
+  end
+end

data/lib/transproc/composer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'transproc/support/deprecations'
 
 module Transproc

data/lib/transproc/composite.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Transproc
   # Composition of two functions
   #

data/lib/transproc/conditional.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Transproc
   # Conditional transformation functions
   #

data/lib/transproc/constants.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Transproc
+  Undefined = Object.new.freeze
+end

data/lib/transproc/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Transproc
   Error = Class.new(StandardError)
   FunctionAlreadyRegisteredError = Class.new(Error)

data/lib/transproc/function.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'transproc/composite'
 
 module Transproc

data/lib/transproc/functions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Transproc
   # Function container extension
   #

data/lib/transproc/hash.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'transproc/coercions'
 
 module Transproc
@@ -17,20 +19,26 @@ module Transproc
   module HashTransformations
     extend Registry
 
-    # Map all keys in a hash with the provided transformation function
-    #
-    # @example
-    #   Transproc(:map_keys, -> s { s.upcase })['name' => 'Jane']
-    #   # => {"NAME" => "Jane"}
-    #
-    # @param [Hash]
-    #
-    # @return [Hash]
-    #
-    # @api public
-    def self.map_keys(source_hash, fn)
-      Hash[source_hash].tap do |hash|
-        hash.keys.each { |key| hash[fn[key]] = hash.delete(key) }
+    if RUBY_VERSION >= '2.5'
+      # Map all keys in a hash with the provided transformation function
+      #
+      # @example
+      #   Transproc(:map_keys, -> s { s.upcase })['name' => 'Jane']
+      #   # => {"NAME" => "Jane"}
+      #
+      # @param [Hash]
+      #
+      # @return [Hash]
+      #
+      # @api public
+      def self.map_keys(source_hash, fn)
+        Hash[source_hash].transform_keys!(&fn)
+      end
+    else
+      def self.map_keys(source_hash, fn)
+        Hash[source_hash].tap do |hash|
+          hash.keys.each { |key| hash[fn[key]] = hash.delete(key) }
+        end
       end
     end
 
@@ -94,20 +102,55 @@ module Transproc
       map_keys(hash, Coercions[:to_string].fn)
     end
 
-    # Map all values in a hash using transformation function
+    # Stringify keys in a hash recursively
     #
     # @example
-    #   Transproc(:map_values, -> v { v.upcase })[:name => 'Jane']
-    #   # => {"name" => "JANE"}
+    #   input = { :foo => "bar", :baz => [{ :one => 1 }] }
+    #
+    #   t(:deep_stringify_keys)[input]
+    #   # => { "foo" => "bar", "baz" => [{ "one" => 1 }] }
     #
     # @param [Hash]
     #
     # @return [Hash]
     #
     # @api public
-    def self.map_values(source_hash, fn)
-      Hash[source_hash].tap do |hash|
-        hash.each { |key, value| hash[key] = fn[value] }
+    def self.deep_stringify_keys(hash)
+      hash.each_with_object({}) do |(key, value), output|
+        output[key.to_s] =
+          case value
+          when Hash
+            deep_stringify_keys(value)
+          when Array
+            value.map { |item|
+              item.is_a?(Hash) ? deep_stringify_keys(item) : item
+            }
+          else
+            value
+          end
+      end
+    end
+
+    if RUBY_VERSION >= '2.4'
+      # Map all values in a hash using transformation function
+      #
+      # @example
+      #   Transproc(:map_values, -> v { v.upcase })[:name => 'Jane']
+      #   # => {"name" => "JANE"}
+      #
+      # @param [Hash]
+      #
+      # @return [Hash]
+      #
+      # @api public
+      def self.map_values(source_hash, fn)
+        Hash[source_hash].transform_values!(&fn)
+      end
+    else
+      def self.map_values(source_hash, fn)
+        Hash[source_hash].tap do |hash|
+          hash.each { |key, value| hash[key] = fn[value] }
+        end
       end
     end
 
@@ -167,20 +210,26 @@ module Transproc
       Hash[hash].reject { |k, _| keys.include?(k) }
     end
 
-    # Accepts specified keys from a hash
-    #
-    # @example
-    #   Transproc(:accept_keys, [:name])[name: 'Jane', email: 'jane@doe.org']
-    #   # => {:name=>"Jane"}
-    #
-    # @param [Hash] hash The input hash
-    # @param [Array] keys The keys to be accepted
-    #
-    # @return [Hash]
-    #
-    # @api public
-    def self.accept_keys(hash, keys)
-      reject_keys(hash, hash.keys - keys)
+    if RUBY_VERSION >= '2.5'
+      # Accepts specified keys from a hash
+      #
+      # @example
+      #   Transproc(:accept_keys, [:name])[name: 'Jane', email: 'jane@doe.org']
+      #   # => {:name=>"Jane"}
+      #
+      # @param [Hash] hash The input hash
+      # @param [Array] keys The keys to be accepted
+      #
+      # @return [Hash]
+      #
+      # @api public
+      def self.accept_keys(hash, keys)
+        Hash[hash].slice(*keys)
+      end
+    else
+      def self.accept_keys(hash, keys)
+        reject_keys(hash, hash.keys - keys)
+      end
     end
 
     # Map a key in a hash with the provided transformation function