transproc 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cc7103ff3c33f4d49ebf8bd85f049500f5b0a27
-  data.tar.gz: 08c4676baf065be02235c2a9885d62fadb514311
+  metadata.gz: c88956f58489c894cec8a4dd8a8714e47b3b1af0
+  data.tar.gz: 570b8a17eb185d2129fda432dce71160d13fdcc0
 SHA512:
-  metadata.gz: a532a67708497aa9ddc6e53c10bddbcc1b0c9c71ac648b05f59b9d4c24ec61e08d2f713b535134824a67aec9f099be647e5593bbe3033a32dca96c164b1b0b85
-  data.tar.gz: b21cc5f7674752c33e4d55c3067f9f71ba372444d4ee497cc054a14293f89087232b55489e670aa7fafe891ce147a15924c1418009268c4875771d7a657c3431
+  metadata.gz: c81a55daec46a1cf7f46b0ce4aa99897f2efa598899f335891036fd9531b1e991fb969d4f17a31ef89743eea7cff21c8b72573bac9eb98e02fc45b4212a1a620
+  data.tar.gz: b6f9740cab83acad2875220322f1a93814ce6e1a861893cceb08903730f2f2208b11f98b229b6a54cf6da63f3b8d1925d52b00e009fc0567c6a953796ffd8032

data/.rubocop.yml

@@ -0,0 +1,66 @@
+inherit_from: .rubocop_todo.yml
+
+# Exclude temporary files
+AllCops:
+  Exclude:
+    - tmp/**/*
+
+# Allow global Transproc method definition
+Style/MethodName:
+  Exclude:
+    - lib/transproc.rb
+
+# No need to handle LoadError in Rakefile
+Lint/HandleExceptions:
+  Exclude:
+    - rakelib/*.rake
+    - spec/spec_helper.rb
+
+# It’s quite readable when we know what we are doing
+Lint/AssignmentInCondition:
+  Enabled: false
+
+# The enforced style doesn’t match Vim’s defaults
+Style/AlignParameters:
+  Enabled: false
+
+# UTF-8 is perfectly fine in comments
+Style/AsciiComments:
+  Enabled: false
+
+# Allow using braces for value-returning blocks
+Style/BlockDelimiters:
+  Enabled: false
+
+# Documentation checked by Inch CI
+Style/Documentation:
+  Enabled: false
+
+# Early returns have their vices
+Style/GuardClause:
+  Enabled: false
+
+# Need to be skipped for >-> usage
+Style/Lambda:
+  Enabled: false
+
+# Multiline block chains are ok
+Style/MultilineBlockChain:
+  Enabled: false
+
+# Even a single escaped slash can be confusing
+Style/RegexpLiteral:
+  MaxSlashes: 0
+
+# Don’t introduce semantic fail/raise distinction
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Allow compact style for specs
+Style/ClassAndModuleChildren:
+  Exclude:
+    - spec/**/*_spec.rb
+
+# Allow logical `or`/`and` in conditionals
+Style/AndOr:
+  EnforcedStyle: conditionals

data/.rubocop_todo.yml

@@ -0,0 +1,11 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-04-16 18:31:27 +0100 using RuboCop version 0.26.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 11
+# Configuration parameters: AllowURI.
+Metrics/LineLength:
+  Max: 110

data/.travis.yml

@@ -3,7 +3,8 @@ sudo: false
 cache: bundler
 env:
   - CODECLIMATE_REPO_TOKEN=aead71de2239048f830499462c54b57dfc646f1d56ad5dcbbc3469a6ebaf97ca
-script: "bundle exec rake spec"
+bundler_args: --without tools
+script: 'bundle exec rake spec'
 rvm:
   - 2.0
   - 2.1

data/CHANGELOG.md

@@ -1,10 +1,39 @@
+## v0.2.1 2015-05-17
+
+### Added
+
+* `:constructor_inject` injects arguments into the constructor of a class (AMHOL)
+* `:set_ivars` which allocates an object and sets instance variables from a hash (key/value pairs) on an object (AMHOL)
+* `:combine` which merges multiple arrays into one using "join keys" (solnic)
+* `:reject_keys` which rejects specified keys in a hash (solnic)
+* `:accept_keys` which accepts specified keys in a hash (solnic)
+* `:extract_key` converts the array of hashes to array of values (nepalez)
+
+### Changed
+
+* `:unwrap` can be called without keys (solnic)
+* `Transproc.register` raises a meaningful error when a given function is already registered (kwando)
+* `Transproc[]` raises a meaningful error when a given function doesn't exist (kwando)
+* `Transproc[]` raises a meaningful error when a transformation crashes (kwando)
+
+### Fixed
+
+* `Transproc()` no longer creates a function if it's already a function (splattael)
+* A couple of mistakes in the API docs (AMHOL)
+
+### Internal
+
+* Rubocop integration \o/ (AMHOL)
+
+[Compare v0.2.0...v0.2.1](https://github.com/solnic/transproc/compare/v0.2.0...v0.2.1)
+
 ## v0.2.0 2015-04-14
 
 ### Added
 
+* `:map_keys` hash transformation (AMHOL)
+* `:stringify_keys` hash transformation (AMHOL)
 * `:map_values` hash transformation (AMHOL)
-* `:map_value` hash transformation (AMHOL)
-* `:map_value` hash transformation (AMHOL)
 * `:guard` function (AMHOL)
 * `:is` type-check function (solnic)
 * `Function#to_ast` for easy inspection (solnic)

data/Gemfile

@@ -3,13 +3,18 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
+  gem 'equalizer'
+  gem 'anima'
   gem 'mutant'
   gem 'mutant-rspec'
   gem 'codeclimate-test-reporter', require: nil
 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/Guardfile

@@ -1,4 +1,4 @@
-guard :rspec, cmd: "rspec" do
+guard :rspec, cmd: 'rspec' do
   # run all specs if configuration is modified
   watch('Guardfile')           { 'spec' }
   watch('Gemfile.lock')        { 'spec' }
@@ -12,5 +12,5 @@ guard :rspec, cmd: "rspec" do
   # run a spec if it is modified
   watch(%r{\Aspec/(?:unit|integration)/.+_spec\.rb\z})
 
-  notification :tmux, display_message: true
+  notification :tmux, display_message: true if ENV.key?('TMUX')
 end

data/README.md

@@ -5,11 +5,11 @@
 [coveralls]: https://coveralls.io/r/solnic/transproc
 [inchpages]: http://inch-ci.org/github/solnic/transproc
 
-# Transproc [![Join the chat at https://gitter.im/solnic/transproc](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/solnic/transproc?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+# Transproc [![Join the chat at https://gitter.im/solnic/transproc](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/solnic/transproc)
 
 [![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.png)][gemnasium]
+[![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]
@@ -36,6 +36,7 @@ Or install it yourself as:
 ## Usage
 
 ``` ruby
+require 'json'
 require 'transproc/all'
 
 # compose transformation functions
@@ -56,7 +57,7 @@ transformation.call(
 # => [{:user=>"Jane", :address=>{:city=>"NYC", :street=>"Street 1", :zipcode=>"123"}}]
 
 # Define your own transformations easily
-Transproc(:to_json, -> v { JSON.dump(v) })
+Transproc.register(:to_json, -> v { JSON.dump(v) })
 
 Transproc(:to_json).call([{ name: 'Jane' }])
 # => "[{\"name\":\"Jane\"}]"
@@ -70,7 +71,7 @@ module MyTransformations
   end
 end
 
-(Transproc(:load_json) >> Transproc(:symbolize_keys)).call('[{"name":"Jane"}]')
+(Transproc(:load_json) >> Transproc(:map_array, Transproc(:symbolize_keys))).call('[{"name":"Jane"}]')
 # => [{ :name => "Jane" }]
 ```
 

data/Rakefile

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

data/lib/transproc.rb

@@ -1,6 +1,7 @@
 require 'transproc/version'
 require 'transproc/function'
 require 'transproc/composer'
+require 'transproc/error'
 
 module Transproc
   module_function
@@ -18,6 +19,9 @@ module Transproc
   # @api public
   def register(*args, &block)
     name, fn = *args
+    if functions.include?(name)
+      raise FunctionAlreadyRegisteredError, "function #{name} is already defined"
+    end
     functions[name] = fn || block
   end
 
@@ -27,7 +31,9 @@ module Transproc
   #
   # @api private
   def [](name)
-    functions.fetch(name)
+    functions.fetch(name) {
+      raise FunctionNotFoundError, "no registered function for #{name}"
+    }
   end
 
   # Function registry
@@ -75,6 +81,11 @@ end
 def Transproc(fn, *args)
   case fn
   when Proc then Transproc::Function.new(fn, args: args)
-  when Symbol then Transproc::Function.new(Transproc[fn], args: args)
+  when Symbol
+    fun = Transproc[fn]
+    case fun
+    when Transproc::Function, Transproc::Composite then fun
+    else Transproc::Function.new(fun, args: args)
+    end
   end
 end

data/lib/transproc/all.rb

@@ -1,7 +1,9 @@
 require 'transproc'
 
+require 'transproc/class'
 require 'transproc/coercions'
 require 'transproc/conditional'
 require 'transproc/array'
 require 'transproc/hash'
+require 'transproc/object'
 require 'transproc/recursion'

data/lib/transproc/array.rb

@@ -16,7 +16,7 @@ module Transproc
   #       { 'city' => 'NYC', 'zipcode' => '312' }
   #     ]
   #   )
-  #   # => [{ city: 'Boston', zipcode: '123' }, { city: 'NYC', zipcode: '312' }]
+  #   # => [{:address=>{:city=>"Boston", :zipcode=>"123"}}, {:address=>{:city=>"NYC", :zipcode=>"312"}}]
   #
   # @api public
   module ArrayTransformations
@@ -98,5 +98,82 @@ module Transproc
         root.merge(key => children)
       end
     end
+
+    # Combines two arrays by merging child items from right array using join keys
+    #
+    # @example
+    #   fn = t(:combine, [[:tasks, name: :user]])
+    #
+    #   fn.call([[{ name: 'Jane' }], [{ user: 'Jane', title: 'One' }]])
+    #   # => [{:name=>"Jane", :tasks=>[{:user=>"Jane", :title=>"One"}]}]
+    #
+    # @param [Array<Array>] array The input array
+    # @param [Array<Hash>] mappings The mapping definitions array
+    #
+    # @return [Array<Hash>]
+    #
+    # @api public
+    def combine(array, mappings)
+      root, groups = array
+
+      cache = Hash.new { |h, k| h[k] = Hash.new }
+
+      root.map { |parent|
+        child_hash = {}
+
+        groups.each_with_index do |candidates, index|
+          key, keys, group_mappings = mappings[index]
+
+          children =
+            if group_mappings
+              combine(candidates, group_mappings)
+            else
+              candidates
+            end
+
+          child_keys = keys.values
+          pkey_value = parent.values_at(*keys.keys) # ugh
+
+          cache[key][child_keys] ||= children.group_by { |child|
+            child.values_at(*child_keys)
+          }
+          child_arr = cache[key][child_keys][pkey_value] || []
+
+          child_hash.update(key => child_arr)
+        end
+
+        parent.merge(child_hash)
+      }
+    end
+
+    # Converts the array of hashes to array of values, extracted by given key
+    #
+    # @example
+    #   fn = t(:extract_key, :name)
+    #   fn.call [
+    #     { name: 'Alice', role: 'sender' },
+    #     { name: 'Bob', role: 'receiver' },
+    #     { role: 'listener' }
+    #   ]
+    #   # => ['Alice', 'Bob', nil]
+    #
+    # @param [Array<Hash>] array The input array of hashes
+    # @param [Object] key The key to extract values by
+    #
+    # @return [Array]
+    #
+    # @api public
+    def extract_key(array, key)
+      extract_key!(Array[*array], key)
+    end
+
+    # Same as `extract_key` but mutates the array
+    #
+    # @see ArrayTransformations.extract_key
+    #
+    # @api public
+    def extract_key!(array, key)
+      map_array!(array, -> v { v[key] })
+    end
   end
 end

data/lib/transproc/class.rb

@@ -0,0 +1,52 @@
+module Transproc
+  # Transformation functions for Classes
+  #
+  # @example
+  #   require 'transproc/class'
+  #
+  #   include Transproc::Helper
+  #
+  #   fn = t(:constructor_inject, 'User', :name, :age)
+  #
+  #   fn[Struct]
+  #   # => Struct::User
+  #
+  # @api public
+  module ClassTransformations
+    extend Functions
+
+    # Inject given arguments into the constructor of the class
+    #
+    # @example
+    #   Transproct(:constructor_inject, 'User', :name, :age)[Struct]
+    #   # => Struct::User
+    #
+    # @param [Class]
+    #
+    # @return [Mixed]
+    #
+    # @api public
+    def constructor_inject(*args, klass)
+      klass.new(*args)
+    end
+
+    # Set instance variables from the hash argument (key/value pairs) on the object
+    #
+    # @example
+    #   Transproc(:set_ivars, Object)[name: 'Jane', age: 25]
+    #   # => #<Object:0x007f411d06a210 @name="Jane", @age=25>
+    #
+    # @param [Object]
+    #
+    # @return [Object]
+    #
+    # @api public
+    def set_ivars(ivar_hash, klass)
+      object = klass.allocate
+      ivar_hash.each do |ivar_name, ivar_value|
+        object.instance_variable_set("@#{ivar_name}", ivar_value)
+      end
+      object
+    end
+  end
+end

data/lib/transproc/composite.rb

@@ -0,0 +1,50 @@
+module Transproc
+  # Composition of two functions
+  #
+  # @api private
+  class Composite
+    # @return [Proc]
+    #
+    # @api private
+    attr_reader :left
+
+    # @return [Proc]
+    #
+    # @api private
+    attr_reader :right
+
+    # @api private
+    def initialize(left, right)
+      @left = left
+      @right = right
+    end
+
+    # Call right side with the result from the left side
+    #
+    # @param [Object] value The input value
+    #
+    # @return [Object]
+    #
+    # @api public
+    def call(value)
+      right[left[value]]
+    end
+    alias_method :[], :call
+
+    # @see Function#compose
+    #
+    # @api public
+    def compose(other)
+      self.class.new(self, other)
+    end
+    alias_method :+, :compose
+    alias_method :>>, :compose
+
+    # @see Function#to_ast
+    #
+    # @api public
+    def to_ast
+      left.to_ast << right.to_ast
+    end
+  end
+end