transproc 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18747dd5f157b683c7f3fc9200c7a7eb084cb270
-  data.tar.gz: 6961af7f27c18df6f9da0e3b0cbf839a003c839f
+  metadata.gz: e3020e57756005b16449b171dc8532bd2c39887e
+  data.tar.gz: 06f27a81c36eec5993c51e64b58d440355ea1a12
 SHA512:
-  metadata.gz: 51f5533988a1658e74988a7176936aac2d97925624720ac74dc5ca3ffc51651f61732947e645a3b65ed430992d442ae5aff4d8d35a81acc2bcaae45a7bdb9d77
-  data.tar.gz: 0b665c3972a08d45fed440025c3c986dfb00726615c16ed4e52c29ac9a86ca7e6e91d9cd8275f32829b638b21edea9a4ba8813b8e673f0839e9576d54d4cefa0
+  metadata.gz: 76b51f3ed36099dfa1410ac9aed768edab31275cc2057b50ee3e91b0795c36a8db2e030163c38f3be33fce5480b6523b3766f911951ed7026364310384b85412
+  data.tar.gz: 17d92360f7aaddc1f0a00fcf240f7402d9cf3419ed1c3b1a3e93e73b7a5781cfc8c8f84757b8b52529f9dadc7323e6d3302c840f017b60f80514b30ded93e05a

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## v0.3.0 2015-07-12
+
+This release deprecates a couple of APIs and changes the way functions can be
+accessed. The global `Transproc()` function registry is now deprecated and you
+should define your own function registry via `extend Transproc::Registry` and its
+`import` interface. See API docs for the details.
+
+Proper deprecation warnings will appear as this is still a backward-compatible
+release, however, please update to the new API as the global registry will be gone
+in 1.0.0.
+
+### Added
+
+* `HashTransformations.eval_values` which evaluates callable values in a hash
+  recursively (solnic)
+* `HashTransformations.deep_symbolize_keys` which, surprise surprise, symbolizes
+  keys in a hash, recursively (solnic)
+* Shared examples `:transforming_immutable_data` and `:mutating_input_data`
+  to specify transformations in RSpec (nepalez)
+
+### Changed
+
+* `Transproc::Registry` now uses singleton methods that can be imported from
+  arbitrary modules via `import` interface (nepalez)
+* Updated all built-in modules to the new registry API (nepalez + solnic)
+* `Transproc()` has been deprecated (solnic)
+* `Transproc::Helper` has been deprecated (solnic)
+
+[Compare v0.2.4...HEAD](https://github.com/solnic/transproc/compare/v0.2.4...HEAD)
+
 ## v0.2.4 2015-06-20
 
 ### Added

data/README.md

@@ -38,14 +38,32 @@ Or install it yourself as:
 ``` ruby
 require 'json'
 require 'transproc/all'
+require 'inflecto'
 
-# compose transformation functions
-include Transproc::Helper
+# create your own local registry for transformation functions
+module Functions
+  extend Transproc::Registry
+end
+
+# import necessary functions from external modules
+module Functions
+  # ...
+
+  # all transformations available in the imported module
+  import Transproc::HashTransforations
+  import Transproc::ArrayTransformations
 
-transformation = t(:map_array, t(:symbolize_keys) >> t(:rename_keys, user_name: :user))
-transformation >>= t(:wrap, :address, [:city, :street, :zipcode])
+  # only specific transformation (renamed into the desired local name)
+  import :camelize, from: Inflecto, as: :camel_case
+end
+
+# use imported transformation
+transformation = Functions[:camel_case]
+transformation.call 'i_am_a_camel'
+# => "IAmACamel"
 
-# call the function
+transformation = Functions[:map_array, Functions[:symbolize_keys] >> Functions[:rename_keys, user_name: :user]]
+transformation >>= Functions[:wrap, :address, [:city, :street, :zipcode]]
 transformation.call(
   [
     { 'user_name' => 'Jane',
@@ -56,22 +74,22 @@ transformation.call(
 )
 # => [{:user=>"Jane", :address=>{:city=>"NYC", :street=>"Street 1", :zipcode=>"123"}}]
 
-# Define your own transformations easily
-Transproc.register(:to_json, -> v { JSON.dump(v) })
-
-Transproc(:to_json).call([{ name: 'Jane' }])
-# => "[{\"name\":\"Jane\"}]"
+# define your own composable transformation easily
+transformation = Functions[-> v { JSON.dump(v) }]
+transformation.call(name: 'Jane')
+# => "{\"name\":\"Jane\"}"
 
-# ...or create a module with custom transformations
-module MyTransformations
-  extend Transproc::Functions
+# ...or add it to registered functions via singleton method of the registry
+module Functions
+  # ...
 
-  def load_json(v)
+  def self.load_json(v)
     JSON.load(v)
   end
 end
 
-(Transproc(:load_json) >> Transproc(:map_array, Transproc(:symbolize_keys))).call('[{"name":"Jane"}]')
+transformation = Functions[:load_json] >> Functions[:map_array, Functions[:symbolize_keys]]
+transformation.call('[{"name":"Jane"}]')
 # => [{ :name => "Jane" }]
 ```
 

data/lib/transproc.rb

@@ -3,10 +3,17 @@ require 'transproc/function'
 require 'transproc/functions'
 require 'transproc/composer'
 require 'transproc/error'
+require 'transproc/store'
 require 'transproc/registry'
+require 'transproc/support/deprecations'
 
 module Transproc
-  module_function
+  # Function registry
+  #
+  # @api private
+  def self.functions
+    @_functions ||= {}
+  end
 
   # Register a new function
   #
@@ -19,9 +26,9 @@ module Transproc
   # @return [Function]
   #
   # @api public
-  def register(*args, &block)
+  def self.register(*args, &block)
     name, fn = *args
-    if functions.include?(name)
+    if functions.include? name
       raise FunctionAlreadyRegisteredError, "Function #{name} is already defined"
     end
     functions[name] = fn || block
@@ -32,17 +39,14 @@ module Transproc
   # @param [Symbol] name The name of the registered function
   #
   # @api private
-  def [](name)
-    functions.fetch(name) {
-      raise FunctionNotFoundError, "No registered function for #{name}"
-    }
-  end
+  def self.[](name, *args)
+    fn = functions.fetch(name) { raise FunctionNotFoundError.new(name) }
 
-  # Function registry
-  #
-  # @api private
-  def functions
-    @_functions ||= {}
+    if args.any?
+      fn.with(*args)
+    else
+      fn
+    end
   end
 end
 
@@ -63,10 +67,15 @@ require 'transproc/hash'
 #
 # @api public
 def Transproc(fn, *args)
+  Transproc::Deprecations.announce(
+    'Transproc()',
+    'Define your own function registry using Transproc::Registry extension'
+  )
+
   case fn
   when Proc then Transproc::Function.new(fn, args: args)
   when Symbol
-    fun = Transproc[fn]
+    fun = Transproc[fn, *args]
     case fun
     when Transproc::Function, Transproc::Composite then fun
     else Transproc::Function.new(fun, args: args)

data/lib/transproc/array.rb

@@ -1,4 +1,5 @@
 require 'transproc/coercions'
+require 'transproc/hash'
 
 module Transproc
   # Transformation functions for Array objects
@@ -20,7 +21,7 @@ module Transproc
   #
   # @api public
   module ArrayTransformations
-    extend Functions
+    extend Registry
 
     # Map array values using transformation function
     #
@@ -36,7 +37,7 @@ module Transproc
     # @return [Array]
     #
     # @api public
-    def map_array(array, fn)
+    def self.map_array(array, fn)
       map_array!(Array[*array], fn)
     end
 
@@ -45,7 +46,7 @@ module Transproc
     # @see ArrayTransformations.map_array
     #
     # @api public
-    def map_array!(array, fn)
+    def self.map_array!(array, fn)
       array.map! { |value| fn[value] }
     end
 
@@ -64,8 +65,9 @@ module Transproc
     # @return [Array]
     #
     # @api public
-    def wrap(array, key, keys)
-      map_array(array, Transproc(:nest, key, keys))
+    def self.wrap(array, key, keys)
+      nest = HashTransformations[:nest, key, keys]
+      map_array(array, nest)
     end
 
     # Group array values using provided root key and value keys
@@ -86,12 +88,12 @@ module Transproc
     # @return [Array]
     #
     # @api public
-    def group(array, key, keys)
+    def self.group(array, key, keys)
       grouped = Hash.new { |h, k| h[k] = [] }
       array.each do |hash|
         hash = Hash[hash]
 
-        old_group = Transproc::Coercions.to_tuples(hash.delete(key))
+        old_group = Coercions.to_tuples(hash.delete(key))
         new_group = keys.inject({}) { |a, e| a.merge(e => hash.delete(e)) }
 
         grouped[hash] << old_group.map { |item| item.merge(new_group) }
@@ -121,7 +123,7 @@ module Transproc
     # @return [Array]
     #
     # @api public
-    def ungroup(array, key, keys)
+    def self.ungroup(array, key, keys)
       array.flat_map { |item| HashTransformations.split(item, key, keys) }
     end
 
@@ -139,7 +141,7 @@ module Transproc
     # @return [Array<Hash>]
     #
     # @api public
-    def combine(array, mappings)
+    def self.combine(array, mappings)
       root, groups = array
 
       cache = Hash.new { |h, k| h[k] = {} }
@@ -189,7 +191,7 @@ module Transproc
     # @return [Array]
     #
     # @api public
-    def extract_key(array, key)
+    def self.extract_key(array, key)
       extract_key!(Array[*array], key)
     end
 
@@ -198,7 +200,7 @@ module Transproc
     # @see ArrayTransformations.extract_key
     #
     # @api public
-    def extract_key!(array, key)
+    def self.extract_key!(array, key)
       map_array!(array, -> v { v[key] })
     end
 
@@ -217,7 +219,7 @@ module Transproc
     # @return [Array]
     #
     # @api public
-    def insert_key(array, key)
+    def self.insert_key(array, key)
       insert_key!(Array[*array], key)
     end
 
@@ -226,7 +228,7 @@ module Transproc
     # @see ArrayTransformations.insert_key
     #
     # @api public
-    def insert_key!(array, key)
+    def self.insert_key!(array, key)
       map_array!(array, -> v { { key => v } })
     end
 
@@ -238,7 +240,7 @@ module Transproc
     #
     # @api public
     #
-    def add_keys(array, keys)
+    def self.add_keys(array, keys)
       add_keys!(Array[*array], keys)
     end
 
@@ -247,9 +249,13 @@ module Transproc
     # @see ArrayTransformations.add_keys
     #
     # @api public
-    def add_keys!(array, keys)
+    def self.add_keys!(array, keys)
       base = keys.inject({}) { |a, e| a.merge(e => nil) }
       map_array!(array, -> v { base.merge(v) })
     end
+
+    # @deprecated Register methods globally
+    (methods - Registry.methods - Registry.instance_methods)
+      .each { |name| Transproc.register name, t(name) }
   end
 end

data/lib/transproc/class.rb

@@ -13,7 +13,7 @@ module Transproc
   #
   # @api public
   module ClassTransformations
-    extend Functions
+    extend Registry
 
     # Inject given arguments into the constructor of the class
     #
@@ -26,7 +26,7 @@ module Transproc
     # @return [Object] An instance of the given klass
     #
     # @api public
-    def constructor_inject(*args, klass)
+    def self.constructor_inject(*args, klass)
       klass.new(*args)
     end
 
@@ -41,12 +41,16 @@ module Transproc
     # @return [Object]
     #
     # @api public
-    def set_ivars(ivar_hash, klass)
+    def self.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
+
+    # @deprecated Register methods globally
+    (methods - Registry.methods - Registry.instance_methods)
+      .each { |name| Transproc.register name, t(name) }
   end
 end

data/lib/transproc/coercions.rb

@@ -8,7 +8,7 @@ module Transproc
   #
   # @api public
   module Coercions
-    extend Functions
+    extend Registry
 
     TRUE_VALUES = [true, 1, '1', 'on', 't', 'true', 'y', 'yes'].freeze
     FALSE_VALUES = [false, 0, '0', 'off', 'f', 'false', 'n', 'no'].freeze
@@ -28,7 +28,7 @@ module Transproc
     # @return [String]
     #
     # @api public
-    def to_string(value)
+    def self.to_string(value)
       value.to_s
     end
 
@@ -43,7 +43,7 @@ module Transproc
     # @return [Symbol]
     #
     # @api public
-    def to_symbol(value)
+    def self.to_symbol(value)
       value.to_sym
     end
 
@@ -58,7 +58,7 @@ module Transproc
     # @return [Integer]
     #
     # @api public
-    def to_integer(value)
+    def self.to_integer(value)
       value.to_i
     end
 
@@ -73,7 +73,7 @@ module Transproc
     # @return [Float]
     #
     # @api public
-    def to_float(value)
+    def self.to_float(value)
       value.to_f
     end
 
@@ -88,7 +88,7 @@ module Transproc
     # @return [Decimal]
     #
     # @api public
-    def to_decimal(value)
+    def self.to_decimal(value)
       value.to_d
     end
 
@@ -105,7 +105,7 @@ module Transproc
     # @return [TrueClass,FalseClass]
     #
     # @api public
-    def to_boolean(value)
+    def self.to_boolean(value)
       BOOLEAN_MAP.fetch(value)
     end
 
@@ -120,7 +120,7 @@ module Transproc
     # @return [Date]
     #
     # @api public
-    def to_date(value)
+    def self.to_date(value)
       Date.parse(value)
     end
 
@@ -135,7 +135,7 @@ module Transproc
     # @return [Time]
     #
     # @api public
-    def to_time(value)
+    def self.to_time(value)
       Time.parse(value)
     end
 
@@ -150,7 +150,7 @@ module Transproc
     # @return [DateTime]
     #
     # @api public
-    def to_datetime(value)
+    def self.to_datetime(value)
       DateTime.parse(value)
     end
 
@@ -168,10 +168,14 @@ module Transproc
     #
     # @return [Array<Hash>]
     #
-    def to_tuples(value)
+    def self.to_tuples(value)
       array = value.is_a?(Array) ? Array[*value] : [{}]
       array.select! { |item| item.is_a?(Hash) }
       array.any? ? array : [{}]
     end
+
+    # @deprecated Register methods globally
+    (methods - Registry.methods - Registry.instance_methods)
+      .each { |name| Transproc.register name, t(name) }
   end
 end