transproc 0.2.4 → 0.3.0

data/lib/transproc/composer.rb

@@ -1,3 +1,5 @@
+require 'transproc/support/deprecations'
+
 module Transproc
   # Transproc helper that adds `t` method as a shortcut for `Transproc` method
   #
@@ -8,6 +10,24 @@ module Transproc
   #
   # @api public
   module Helper
+    # @api private
+    def self.included(*)
+      Transproc::Deprecations.announce(
+        'Transproc::Helper',
+        'Define your own function registry using Transproc::Registry extension'
+      )
+      super
+    end
+
+    # @api private
+    def self.included(*)
+      Transproc::Deprecations.announce(
+        'Transproc::Helper',
+        'Define your own function registry using Transproc::Registry extension'
+      )
+      super
+    end
+
     # @see Transproc
     #
     # @api public
@@ -31,8 +51,6 @@ module Transproc
   #
   # @api public
   module Composer
-    include Helper
-
     # @api private
     class Factory
       attr_reader :fns, :default
@@ -53,6 +71,12 @@ module Transproc
       def to_fn
         fns.reduce(:+) || default
       end
+
+      # @deprecated
+      # @api public
+      def t(*args, &block)
+        Transproc(*args, &block)
+      end
     end
 
     # Gather and compose functions and fall-back to a default one if provided

data/lib/transproc/conditional.rb

@@ -13,7 +13,7 @@ module Transproc
   #
   # @api public
   module Conditional
-    extend Functions
+    extend Registry
 
     # Apply the transformation function to subject if the predicate returns true, or return un-modified
     #
@@ -28,7 +28,7 @@ module Transproc
     # @return [Mixed]
     #
     # @api public
-    def guard(value, predicate, fn)
+    def self.guard(value, predicate, fn)
       predicate[value] ? fn[value] : value
     end
 
@@ -48,8 +48,12 @@ module Transproc
     # @return [Object]
     #
     # @api public
-    def is(value, type, fn)
+    def self.is(value, type, fn)
       guard(value, -> v { v.is_a?(type) }, fn)
     end
+
+    # @deprecated Register methods globally
+    (methods - Registry.methods - Registry.instance_methods)
+      .each { |name| Transproc.register name, t(name) }
   end
 end

data/lib/transproc/error.rb

@@ -1,8 +1,14 @@
 module Transproc
   Error = Class.new(StandardError)
-  FunctionNotFoundError = Class.new(Error)
   FunctionAlreadyRegisteredError = Class.new(Error)
 
+  class FunctionNotFoundError < Error
+    def initialize(function, source = nil)
+      return super "No registered function #{source}[:#{function}]" if source
+      super "No globally registered function for #{function}"
+    end
+  end
+
   class MalformedInputError < Error
     attr_reader :function, :value, :original_error
 

data/lib/transproc/function.rb

@@ -22,10 +22,18 @@ module Transproc
     # @api private
     attr_reader :args
 
+    # @!attribute [r] name
+    #
+    # @return [<type] The name of the function
+    #
+    # @api public
+    attr_reader :name
+
     # @api private
-    def initialize(fn, options)
+    def initialize(fn, options = {})
       @fn = fn
-      @args = options[:args]
+      @args = options.fetch(:args, [])
+      @name = options.fetch(:name, fn)
     end
 
     # Call the wrapped proc
@@ -38,7 +46,7 @@ module Transproc
     def call(*value)
       fn[*value, *args]
     rescue => e
-      raise MalformedInputError.new(@fn, value, e)
+      raise MalformedInputError.new(@name, value, e)
     end
     alias_method :[], :call
 
@@ -57,14 +65,29 @@ module Transproc
     alias_method :+, :compose
     alias_method :>>, :compose
 
+    # Return a new fn with curried args
+    #
+    # @return [Function]
+    #
+    # @api private
+    def with(*args)
+      self.class.new(fn, name: name, args: args)
+    end
+
+    # @api public
+    def ==(other)
+      return false unless other.instance_of?(self.class)
+      [fn, name, args] == [other.fn, other.name, other.args]
+    end
+    alias_method :eql?, :==
+
     # Return a simple AST representation of this function
     #
     # @return [Array]
     #
     # @api public
     def to_ast
-      identifier = fn.instance_of?(Proc) ? fn : fn.name
-      [identifier, args]
+      [name, args]
     end
   end
 end

data/lib/transproc/functions.rb

@@ -14,6 +14,11 @@ module Transproc
   #
   # @api public
   module Functions
+    def self.extended(mod)
+      warn 'Transproc::Functions is deprecated please switch to Transproc::Registry'
+      super
+    end
+
     def method_added(meth)
       module_function meth
       Transproc.register(meth, method(meth))

data/lib/transproc/hash.rb

@@ -15,7 +15,7 @@ module Transproc
   #
   # @api public
   module HashTransformations
-    extend Functions
+    extend Registry
 
     # Map all keys in a hash with the provided transformation function
     #
@@ -28,7 +28,7 @@ module Transproc
     # @return [Hash]
     #
     # @api public
-    def map_keys(hash, fn)
+    def self.map_keys(hash, fn)
       map_keys!(Hash[hash], fn)
     end
 
@@ -37,7 +37,7 @@ module Transproc
     # @see HashTransformations.map_keys
     #
     # @api public
-    def map_keys!(hash, fn)
+    def self.map_keys!(hash, fn)
       hash.keys.each { |key| hash[fn[key]] = hash.delete(key) }
       hash
     end
@@ -53,7 +53,7 @@ module Transproc
     # @return [Hash]
     #
     # @api public
-    def symbolize_keys(hash)
+    def self.symbolize_keys(hash)
       symbolize_keys!(Hash[hash])
     end
 
@@ -62,8 +62,38 @@ module Transproc
     # @see HashTransformations.symbolize_keys!
     #
     # @api public
-    def symbolize_keys!(hash)
-      map_keys!(hash, Transproc(:to_symbol).fn)
+    def self.symbolize_keys!(hash)
+      map_keys!(hash, Coercions[:to_symbol].fn)
+    end
+
+    # Symbolize keys in a hash recursively
+    #
+    # @example
+    #
+    #   input = { 'foo' => 'bar', 'baz' => [{ 'one' => 1 }] }
+    #
+    #   t(:deep_symbolize_keys)[input]
+    #   # => { :foo => "bar", :baz => [{ :one => 1 }] }
+    #
+    # @param [Hash]
+    #
+    # @return [Hash]
+    #
+    # @api public
+    def self.deep_symbolize_keys(hash)
+      hash.each_with_object({}) do |(key, value), output|
+        output[key.to_sym] =
+          case value
+          when Hash
+            deep_symbolize_keys(value)
+          when Array
+            value.map { |item|
+              item.is_a?(Hash) ? deep_symbolize_keys(item) : item
+            }
+          else
+            value
+          end
+      end
     end
 
     # Stringify all keys in a hash
@@ -77,7 +107,7 @@ module Transproc
     # @return [Hash]
     #
     # @api public
-    def stringify_keys(hash)
+    def self.stringify_keys(hash)
       stringify_keys!(Hash[hash])
     end
 
@@ -86,8 +116,8 @@ module Transproc
     # @see HashTransformations.stringify_keys
     #
     # @api public
-    def stringify_keys!(hash)
-      map_keys!(hash, Transproc(:to_string).fn)
+    def self.stringify_keys!(hash)
+      map_keys!(hash, Coercions[:to_string].fn)
     end
 
     # Map all values in a hash using transformation function
@@ -101,7 +131,7 @@ module Transproc
     # @return [Hash]
     #
     # @api public
-    def map_values(hash, fn)
+    def self.map_values(hash, fn)
       map_values!(Hash[hash], fn)
     end
 
@@ -114,7 +144,7 @@ module Transproc
     # @return [Hash]
     #
     # @api public
-    def map_values!(hash, fn)
+    def self.map_values!(hash, fn)
       hash.each { |key, value| hash[key] = fn[value] }
       hash
     end
@@ -131,7 +161,7 @@ module Transproc
     # @return [Hash]
     #
     # @api public
-    def rename_keys(hash, mapping)
+    def self.rename_keys(hash, mapping)
       rename_keys!(Hash[hash], mapping)
     end
 
@@ -140,7 +170,7 @@ module Transproc
     # @see HashTransformations.rename_keys
     #
     # @api public
-    def rename_keys!(hash, mapping)
+    def self.rename_keys!(hash, mapping)
       mapping.each { |k, v| hash[v] = hash.delete(k) }
       hash
     end
@@ -157,7 +187,7 @@ module Transproc
     # @return [Hash]
     #
     # @api public
-    def reject_keys(hash, keys)
+    def self.reject_keys(hash, keys)
       reject_keys!(Hash[hash], keys)
     end
 
@@ -166,7 +196,7 @@ module Transproc
     # @see HashTransformations.reject_keys
     #
     # @api public
-    def reject_keys!(hash, keys)
+    def self.reject_keys!(hash, keys)
       hash.reject { |k, _| keys.include?(k) }
     end
 
@@ -182,7 +212,7 @@ module Transproc
     # @return [Hash]
     #
     # @api public
-    def accept_keys(hash, keys)
+    def self.accept_keys(hash, keys)
       accept_keys!(Hash[hash], keys)
     end
 
@@ -191,7 +221,7 @@ module Transproc
     # @see HashTransformations.accept
     #
     # @api public
-    def accept_keys!(hash, keys)
+    def self.accept_keys!(hash, keys)
       reject_keys!(hash, hash.keys - keys)
     end
 
@@ -206,7 +236,7 @@ module Transproc
     # @return [Hash]
     #
     # @api public
-    def map_value(hash, key, fn)
+    def self.map_value(hash, key, fn)
       hash.merge(key => fn[hash[key]])
     end
 
@@ -215,7 +245,7 @@ module Transproc
     # @see HashTransformations.map_value
     #
     # @api public
-    def map_value!(hash, key, fn)
+    def self.map_value!(hash, key, fn)
       hash.update(key => fn[hash[key]])
     end
 
@@ -230,7 +260,7 @@ module Transproc
     # @return [Hash]
     #
     # @api public
-    def nest(hash, key, keys)
+    def self.nest(hash, key, keys)
       nest!(Hash[hash], key, keys)
     end
 
@@ -239,7 +269,7 @@ module Transproc
     # @see HashTransformations.nest
     #
     # @api public
-    def nest!(hash, root, keys)
+    def self.nest!(hash, root, keys)
       nest_keys = hash.keys & keys
 
       if nest_keys.size > 0
@@ -263,7 +293,7 @@ module Transproc
     # @return [Hash]
     #
     # @api public
-    def unwrap(hash, root, keys = nil)
+    def self.unwrap(hash, root, keys = nil)
       copy = Hash[hash].merge(root => Hash[hash[root]])
       unwrap!(copy, root, keys)
     end
@@ -273,7 +303,7 @@ module Transproc
     # @see HashTransformations.unwrap
     #
     # @api public
-    def unwrap!(hash, root, selected = nil)
+    def self.unwrap!(hash, root, selected = nil)
       if nested_hash = hash[root]
         keys = nested_hash.keys
         keys &= selected if selected
@@ -303,7 +333,7 @@ module Transproc
     # @return [Hash]
     #
     # @api public
-    def fold(hash, key, tuple_key)
+    def self.fold(hash, key, tuple_key)
       fold!(Hash[hash], key, tuple_key)
     end
 
@@ -312,7 +342,7 @@ module Transproc
     # @see HashTransformations.fold
     #
     # @api public
-    def fold!(hash, key, tuple_key)
+    def self.fold!(hash, key, tuple_key)
       hash.update(key => ArrayTransformations.extract_key(hash[key], tuple_key))
     end
 
@@ -344,7 +374,7 @@ module Transproc
     # @return [Array<Hash>]
     #
     # @api public
-    def split(hash, key, keys)
+    def self.split(hash, key, keys)
       list = Array(hash[key])
       return [hash.reject { |k, _| k == key }] if list.empty?
 
@@ -356,5 +386,51 @@ module Transproc
       list = list.map { |item| item.merge(reject_keys(hash, [key])) }
       ArrayTransformations.add_keys(list, ungrouped)
     end
+
+    # Recursively evaluate hash values if they are procs/lambdas
+    #
+    # @example
+    #   hash = {
+    #     num: -> i { i + 1 },
+    #     str: -> i { "num #{i}" }
+    #   }
+    #
+    #   t(:eval_values, 1)[hash]
+    #   # => {:num => 2, :str => "num 1" }
+    #
+    #   # with filters
+    #   t(:eval_values, 1, [:str])[hash]
+    #   # => {:num => #{still a proc}, :str => "num 1" }
+    #
+    # @param [Hash]
+    # @param [Array,Object] args Anything that should be passed to procs
+    # @param [Array] filters A list of attribute names that should be evaluated
+    #
+    # @api public
+    def self.eval_values(hash, args, filters = [])
+      hash.each_with_object({}) do |(key, value), output|
+        output[key] =
+          case value
+          when Proc
+            if filters.empty? || filters.include?(key)
+              value.call(*args)
+            else
+              value
+            end
+          when Hash
+            eval_values(value, args, filters)
+          when Array
+            value.map { |item|
+              item.is_a?(Hash) ? eval_values(item, args, filters) : item
+            }
+          else
+            value
+          end
+      end
+    end
+
+    # @deprecated Register methods globally
+    (methods - Registry.instance_methods - Registry.methods)
+      .each { |name| Transproc.register name, t(name) }
   end
 end