transproc 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d88691992987b997ac6deeec1affc3a04a1657fc4ed3521f84c6b26adcce5a1
-  data.tar.gz: dc1f06315b9c3a039c6694a14e4cd379b6836b1710fafe0123a05e985441eca8
+  metadata.gz: bd2c6ee5f665083297c1fcfd89a5e37d2284e498d6bc3953b88314e9513cbf43
+  data.tar.gz: 6b9a5f270234b26b479095c66187f91fcca9428afb605f75aa9f51b890976eef
 SHA512:
-  metadata.gz: a2288e68392270823d3dcc4543534553c0d1ac504d95f84f4f9ccc54f52f682dfb64118aecfa913226247c24cc1d77d367193df29ef89a14255f9870c6ae3425
-  data.tar.gz: 65b3916bc564ad16fab85fd84bb66a75544ee7924b4df50673727f212cbc551dc2106a594a052b47093dff1653c7e92e1e464e74facc9cd1aa51ae7c8084e3d0
+  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,21 +1,21 @@
-dist: trusty
 language: ruby
-sudo: required
 cache: bundler
 bundler_args: --without tools
-before_script: gem update --system
+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:
-  - '[ -d coverage ] && bundle exec codeclimate-test-reporter'
 rvm:
   - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - 2.6
-  - jruby-9.2.4.1
+  - 2.6.3
+  - 2.5.5
+  - 2.4.6
+  - jruby-9.2.7.0
 env:
   global:
-    - JRUBY_OPTS='--dev -J-Xmx1024M'
     - COVERAGE='true'
 notifications:
   webhooks:

data/CHANGELOG.md

@@ -1,11 +1,23 @@
-# v1.0.3 to-be-released
+# 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...master](https://github.com/solnic/transproc/compare/v1.0.2...master)
+[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
 

data/Gemfile

@@ -2,27 +2,15 @@ source 'https://rubygems.org'
 
 gemspec
 
-group :test do
-  gem 'equalizer'
+gem 'rake'
+gem 'rspec', '~> 3.8'
+gem 'dry-equalizer', '~> 0.2'
 
-  gem 'anima'
-
-  platform :mri do
-    if RUBY_VERSION >= '2.5'
-      gem 'mutant', github: 'mbj/mutant', branch: 'master'
-      gem 'mutant-rspec'
-    end
-
-    gem 'codeclimate-test-reporter', require: false
-    gem 'simplecov', require: false
-  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/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'

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
@@ -100,6 +102,35 @@ module Transproc
       map_keys(hash, Coercions[:to_string].fn)
     end
 
+    # Stringify keys in a hash recursively
+    #
+    # @example
+    #   input = { :foo => "bar", :baz => [{ :one => 1 }] }
+    #
+    #   t(:deep_stringify_keys)[input]
+    #   # => { "foo" => "bar", "baz" => [{ "one" => 1 }] }
+    #
+    # @param [Hash]
+    #
+    # @return [Hash]
+    #
+    # @api public
+    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
       #

data/lib/transproc/proc.rb

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

data/lib/transproc/recursion.rb

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

data/lib/transproc/registry.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module Transproc
   # Container to define transproc functions in, and access them via `[]` method

data/lib/transproc/store.rb

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 module Transproc
   # Immutable collection of named procedures from external modules

data/lib/transproc/support/deprecations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Transproc
   module Deprecations
     def self.announce(name, msg)

data/lib/transproc/transformer.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'transproc/transformer/class_interface'
+require 'transproc/transformer/deprecated/class_interface'
 
 module Transproc
   # Transfomer class for defining transprocs with a class DSL.
@@ -45,6 +48,9 @@ module Transproc
   # @api public
   class Transformer
     extend ClassInterface
+    extend Deprecated::ClassInterface
+
+    attr_reader :transproc
 
     # Execute the transformation pipeline with the given input.
     #
@@ -63,7 +69,7 @@ module Transproc
     #
     # @api public
     def call(input)
-      self.class.transproc.call(input)
+      transproc.call(input)
     end
   end
 end

data/lib/transproc/transformer/class_interface.rb

@@ -1,7 +1,14 @@
+# frozen_string_literal: true
+
+require 'transproc/transformer/dsl'
+
 module Transproc
   class Transformer
-    # @api private
+    # @api public
     module ClassInterface
+      # @api private
+      attr_reader :dsl
+
       # Return a base Transproc::Transformer class with the
       # container configured to the passed argument.
       #
@@ -17,14 +24,18 @@ module Transproc
       #
       # @api public
       def [](container)
-        klass = Class.new(Transformer)
+        klass = Class.new(self)
         klass.container(container)
         klass
       end
 
       # @api private
       def inherited(subclass)
+        super
+
         subclass.container(@container) if defined?(@container)
+
+        subclass.instance_variable_set('@dsl', dsl.dup) if dsl
       end
 
       # Get or set the container to resolve transprocs from.
@@ -45,41 +56,32 @@ module Transproc
       # @return [Transproc::Registry]
       #
       # @api private
-      def container(container = ::Transproc::Undefined)
-        if container == ::Transproc::Undefined
-          ensure_container_presence!
-          @container
+      def container(container = Undefined)
+        if container.equal?(Undefined)
+          @container ||= Module.new.extend(Transproc::Registry)
         else
           @container = container
         end
       end
 
-      # Define an anonymous transproc derived from given Transformer
-      # Evaluates block with transformations and returns initialized transproc.
-      # Does not mutate original Transformer
-      #
-      # @example
-      #
-      #   class MyTransformer < Transproc::Transformer[MyContainer]
-      #   end
-      #
-      #   transproc = MyTransformer.define do
-      #     map_values t(:to_string)
-      #   end
-      #   transproc.call(a: 1, b: 2)
-      #   # => {a: '1', b: '2'}
-      #
-      # @yield Block allowing to define transformations. The same as class level DSL
-      #
-      # @return [Function] Composed transproc
-      #
       # @api public
-      def define(&block)
-        return transproc unless block_given?
+      def import(*args)
+        container.import(*args)
+      end
+
+      # @api public
+      def define!(&block)
+        @dsl ||= DSL.new(container)
+        @dsl.instance_eval(&block)
+        self
+      end
 
-        Class.new(self).tap { |klass| klass.instance_eval(&block) }.transproc
+      # @api public
+      def new(*args)
+        super(*args).tap do |transformer|
+          transformer.instance_variable_set('@transproc', dsl.(transformer)) if dsl
+        end
       end
-      alias build define
 
       # Get a transformation from the container,
       # without adding it to the transformation pipeline
@@ -105,42 +107,6 @@ module Transproc
       def t(fn, *args)
         container[fn, *args]
       end
-
-      # @api private
-      def method_missing(method, *args, &block)
-        if container.contain?(method)
-          args.push(define(&block)) if block_given?
-          transformations << t(method, *args)
-        else
-          super
-        end
-      end
-
-      # @api private
-      def respond_to_missing?(method, _include_private = false)
-        container.contain?(method) || super
-      end
-
-      # @api private
-      def transproc
-        transformations.reduce(:>>)
-      end
-
-      private
-
-      # An array containing the transformation pipeline
-      #
-      # @api private
-      def transformations
-        @transformations ||= []
-      end
-
-      # @api private
-      def ensure_container_presence!
-        return if defined?(@container)
-        raise ArgumentError, 'Transformer function registry is empty. '\
-                             'Provide your registry via Transproc::Transformer[YourRegistry]'
-      end
     end
   end
 end