abstractivator 0.0.23 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5cf5eda70ec67c313b2df05ad3280682c8785f40
-  data.tar.gz: 9a0d1adaf5762a97cbf854086bb09edff5577169
+  metadata.gz: e68abf828440fc78dcde5dcfd7ffbdfb97d12947
+  data.tar.gz: 36c75eb045436c4af77795747cec641e8aaf3b3d
 SHA512:
-  metadata.gz: b04ee0b54f862440283a251cb940d05c55412d6dd9312286935302c9d26b9aeeeb892e3632cfdb433f3d7b9c65c7c804ca9a78e3080039d3cd19b709d928b4e3
-  data.tar.gz: 6d3f90b0717a52ef4ef069dea162070b3b0cf4bd7e96d36911475afeec513ef79a3b933152bcc3f488a300cf7caa4b1f46ec3b8858755b7e814bf2a18d20f7f5
+  metadata.gz: 6253948262fb4db237c054869d8cf198a39d3abc0d9ba8115ce9ef56c6c06b7322d416604782d8ddd7398b07394b7fd16fb377b8bc477903a2c9770c2fe13be5
+  data.tar.gz: f367bfbca002208c663a7d96decec94a3f010f56b731c760f9ac6f2b79ed45c13c1caaa00ccc6564884637783476df96c44ba1015dcd685952b661e95f4672af

data/lib/abstractivator/array_ext.rb

@@ -1,14 +1,21 @@
 class Array
+  # returns the first element of a 2-element array.
+  # useful when dealing with hashes in array form.
+  # e.g., pairs.map(&:key)
   def key
     size == 2 or raise 'array must contain exactly two elements'
     first
   end
 
+  # returns the second element of a 2-element array.
+  # useful when dealing with hashes in array form.
+  # e.g., pairs.map(&:value)
   def value
     size == 2 or raise 'array must contain exactly two elements'
     last
   end
 
+  # A backport of Array@to_h from Ruby 2.1
   unless instance_methods.include?(:to_h)
     define_method(:to_h) do
       Hash[self]

data/lib/abstractivator/enumerable_ext.rb

@@ -41,7 +41,7 @@ module Enumerable
   end
 
   def self.get_default(default, other_side_value)
-    proc?(default) ? default.(other_side_value) : default
+    default.callable? ? default.call(other_side_value) : default
   end
 
   def self.proc?(x)
@@ -73,7 +73,7 @@ module Enumerable
   define_method :detect do |*args, &block|
     detect = orig_detect.bind(self)
 
-    if args.size == 1 && !args.first.respond_to?(:call) && block
+    if args.size == 1 && !args.first.callable? && block
       value = args.first
       detect.call {|x| block.call(x) == value}
     elsif args.size == 2 && !block

data/lib/abstractivator/proc_ext.rb

@@ -1,6 +1,7 @@
 require 'abstractivator/enumerable_ext'
 
 module MethodAndProcExtensions
+  # returns a version of the procedure that accepts any number of arguments
   def loosen_args
     proc do |*args, &block|
       Proc.loose_call(self, args, &block)
@@ -11,27 +12,37 @@ end
 class Proc
   include MethodAndProcExtensions
 
+  # composes this procedure with another procedure
+  # f.compose(g) ==> proc { |x| f.call(g.call(x)) }
   def compose(other)
     proc{|x| self.call(other.call(x))}
   end
 
+  # composes procedures.
+  # compose(f, g, h) returns the procedure
+  # proc { |x| f.call(g.call(h.call(x))) }
   def self.compose(*procs)
     procs.map(&:to_proc).inject_right(identity) { |inner, p| p.compose(inner) }
   end
 
+  # returns the identity function
   def self.identity
     proc {|x| x}
   end
 
+  # returns a version of the procedure with the argument list reversed
   def reverse_args
     proc do |*args, &block|
       self.call(*args.reverse, &block)
     end
   end
 
+  # tries to coerce x into a procedure, then calls it with
+  # the given argument list.
+  # If x cannot be coerced into a procedure, returns x.
   def self.loose_call(x, args, &block)
     x = x.to_proc if x.respond_to?(:to_proc)
-    x.respond_to?(:call) or return x
+    x.callable? or return x
     args = args.take(x.arity).pad_right(x.arity) if x.arity >= 0
     x.call(*args, &block)
   end
@@ -42,6 +53,9 @@ class Method
 end
 
 class UnboundMethod
+  # returns a version of the procedure that takes the receiver
+  # (that would otherwise need to be bound with .bind()) as
+  # the first argument
   def explicit_receiver
     proc do |receiver, *args, &block|
       self.bind(receiver).call(*args, &block)
@@ -50,8 +64,18 @@ class UnboundMethod
 end
 
 class Array
+  # A syntactic hack to get hash values.
+  # xs.map(&:name)      works when xs is an array of objects, each with a #name method. (built into ruby)
+  # xs.map(&[:name])    works when xs is an array of hashes, each with a :name key.
+  # xs.map(&['name'])   works when xs is an array of hashes, each with a 'name' key.
   def to_proc
     raise 'size must be exactly one' unless size == 1
     proc{|x| x[first]}
   end
 end
+
+class Object
+  def callable?
+    respond_to?(:call)
+  end
+end

data/lib/abstractivator/trees/recursive_delete.rb

@@ -6,6 +6,7 @@ require 'set'
 
 module Abstractivator
   module Trees
+    # recursively deletes the specified keys
     def recursive_delete!(hash, keys)
       x = hash # hash is named 'hash' for documentation purposes but may be anything
       case x

data/lib/abstractivator/trees/tree_compare.rb

@@ -1,5 +1,6 @@
 require 'active_support/core_ext/object/deep_dup'
 require 'abstractivator/trees/block_collector'
+require 'abstractivator/proc_ext'
 require 'sourcify'
 require 'delegate'
 require 'set'
@@ -12,6 +13,9 @@ module Abstractivator
       SetMask.new(items, get_key)
     end
 
+    # Compares a tree to a mask.
+    # Returns a diff of where the tree differs from the mask.
+    # Ignores parts of the tree not specified in the mask.
     def tree_compare(tree, mask, path=[], index=nil)
       if mask == [:*] && tree.is_a?(Enumerable)
         []
@@ -19,7 +23,7 @@ module Abstractivator
         []
       elsif mask == :- && tree != :__missing__
         [diff(path, tree, :__absent__)]
-      elsif mask.respond_to?(:call)
+      elsif mask.callable?
         are_equivalent = mask.call(tree)
         are_equivalent ? [] : [diff(path, tree, mask)]
       else
@@ -109,7 +113,7 @@ module Abstractivator
     end
 
     def massage_mask_for_diff(mask)
-      if mask.respond_to?(:call)
+      if mask.callable?
         massaged = :__predicate__
         begin
           massaged = mask.to_source

data/lib/abstractivator/trees/tree_map.rb

@@ -79,7 +79,7 @@ module Abstractivator
       end
 
       def leaf?(path_tree)
-        path_tree.respond_to?(:call)
+        path_tree.callable?
       end
 
       def deleted?(value)

data/lib/abstractivator/version.rb

@@ -1,3 +1,3 @@
 module Abstractivator
-  VERSION = '0.0.23'
+  VERSION = '0.0.24'
 end

data/spec/lib/abstractivator/proc_ext_spec.rb

@@ -84,3 +84,11 @@ describe 'Array#to_proc' do
     expect{[:a, :b].to_proc}.to raise_error 'size must be exactly one'
   end
 end
+
+describe 'Object#callable?' do
+  it 'determines whether or not the object has a public :call method' do
+    expect(1.callable?).to be_falsey
+    expect(proc{}).to be_truthy
+    expect(double(call: 1)).to be_truthy
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstractivator
 version: !ruby/object:Gem::Version
-  version: 0.0.23
+  version: 0.0.24
 platform: ruby
 authors:
 - Peter Winton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-15 00:00:00.000000000 Z
+date: 2015-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler