pattern-proc 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e6e5c92ff2acd52f48ad6a3499622f6b6605ce3
-  data.tar.gz: 48d17c98cf20548f02d4fb5a317c412235c22c3c
+  metadata.gz: e3db802617a6112ea03388bb5ed687030deaace5
+  data.tar.gz: 26a129d119fef62f511cc6182f87c6fa15b66d14
 SHA512:
-  metadata.gz: 331e688e706805d3e03687107141f45b2652f8c0e568c02c79bdd3de0de7e7c0c78b4764708da4968d8215cdb288563f5a5d6ab13438e0315f82b3d59ce6bb4e
-  data.tar.gz: acbdae026983fe1db56d77a1b88fd0aeca837980eb9637a5ccf421dcf03f2c1cf47b4ca26b92804959909838da7018f34bb60162f2fce614e3166d28da40aa4e
+  metadata.gz: 04f254c90a249e889c9a2e69111e668bb69253ab71abdb5bb3279f7e6df8b58d19d44ff353e9792ac0a270cb7b43bdcce4d633d7a4b6a002c195157c0753e68e
+  data.tar.gz: ae9b8b38c777eda4bd6608b512d11dd6976661a5ce02f262b58724ea1c78b9ff50185f1cf7d13051bf8f7dad156a64ae35b5a9efeb276c6b1bacc3d3814074c5

data/README.md

@@ -2,3 +2,86 @@ pattern-proc
 ============
 
 pattern matching Proc definitions
+
+pattern-proc is a Ruby gem designed to allow creation of pattern-matching procs in a repeated declaration mechanism similar to Haskell.
+
+Usage:
+
+    require 'pattern-proc'
+
+* manually instantiate a proc
+
+      cool_proc = PatternProc.new
+      cool_proc.with(5,10).returns(30)
+      cool_proc.with(3,70).returns(111)
+      cool_proc.with(3) do |second_arg|
+        second_arg * 10
+      end
+      cool_proc.with do |first_arg, second_arg| do
+        first_arg * second_arg
+      end
+
+      # later...
+
+      regular_proc = cool_proc.to_proc
+      regular_proc.(5,10)
+      \> 30
+      regular_proc.(3).(70)
+      \> 111
+      regular_proc.(3).(15)
+      \> 150 # second_arg * 10 case
+      regular_proc.(5,5)
+      \> 25 # first_arg * second_arg case
+
+* declare methods in a class
+
+      class MyClass
+        include PatternProc::ClassMethods
+    
+        pattern(:my_func).with(3,10).returns(30)
+        pattern(:my_func).with(4,11).returns(40)
+      end
+
+      # later...
+
+      obj = MyClass.new
+      obj.my_func(3,10)
+      \> 30
+      obj.my_func(4).(11)
+      \> 40
+
+      # or
+
+      class MySingletonClass
+        class << self
+          include PatternProc::ClassMethods
+          pattern(:my_class_func).with(:a, :b).returns(:c)
+          pattern(:my_class_func).with(:c) do |other|
+            other.to_s
+          end
+        end
+      end
+
+* "mock" out Funkify-style partial application methods in tests
+
+      include PatternProc::TestMethods
+      
+      describe 'something' do
+        it '"mocks" methods' do
+          mock_obj = mock 'anything'
+          mock_obj.pattern(:my_func).with(1,2).returns(10)
+          mock_obj.pattern(:my_func).with(1) do |x| x + 3 end
+          
+          mock_obj.my_func(1).(2).should == 10
+          mock_obj.my_func(1,5).should == 8
+          
+          SomeClass.pattern(:existing_func).with("hello").returns("goodbye")
+          
+          SomeClass.exsting_func("hello").should == "goodbyes"
+        end
+      end
+
+This gem was initially created to ease testing when using the Funkify gem, as is most clear in the last example.  However I would like to build on this library and make the ClassMethods "DSL" more robust. Additionally, right now pattern matching is done by specificity rather than declaration order, and you can only define a proc implementation for the rightmost N arguments (as opposed to any set of arguments, eg.   
+
+    do_stuff 5 x = x * 2
+in Haskell).  Finally I would like PatternProc to subclass Proc directly rather than requiring a call to to_proc.

data/lib/pattern-proc.rb

@@ -0,0 +1 @@
+require 'pattern_proc.rb'

data/pattern-proc.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'pattern-proc'
-  s.version     = '0.0.6'
+  s.version     = '0.0.7'
   s.date        = '2014-07-01'
   s.summary     = 'Pattern Proc'
   s.description = 'define a Proc with pattern matching "re-declaration" ala Haskell'

data/spec/lib/object_method_spec.rb

@@ -1,4 +1,4 @@
-require 'pattern_proc'
+require 'pattern-proc'
 include PatternProc::TestMethods
 
 class TestObjectClass

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pattern-proc
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - William Pleasant-Ryan
@@ -21,6 +21,7 @@ files:
 - Gemfile.lock
 - LICENSE
 - README.md
+- lib/pattern-proc.rb
 - lib/pattern-proc/class_methods.rb
 - lib/pattern-proc/object_methods.rb
 - lib/pattern-proc/pattern_proc.rb