pattern-matching 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 16f7fd19a880e5d513cc2c48abb1ee42b580daf4
-  data.tar.gz: aabdb877f6c81402fcd459da73b60df396ad2577
+  metadata.gz: 1f2ca66eef8d4d13adbeb30543b7e94041cff2f3
+  data.tar.gz: f3bc1eb0cc656c4dc3c94fdd9acca81f37fc3bb8
 SHA512:
-  metadata.gz: 660d6aad1d0f2eafa481e5d43b9ee581b4551b9845968b3f229d7ef2b9bd444e0f690791dfde39a8f0ec11014cf334386120b2a2ee7303d786bfb3942846c47f
-  data.tar.gz: bafa502a02e91ee80ae206700913dc9c208f93fbca85865967fe6242ee21ce8ba15f40dd814f9e2ca9b58d3f37944392d953b6e9ba59b3186a7fbd70f4bf040f
+  metadata.gz: 70efb1797316f271897879dcb889b323c5471f4d9bf82dca6956b234b1e87a488ce106bfd99c11e6ce076921fab2472331efec3adfcf1e795471f9d6508ed408
+  data.tar.gz: 3a65bdb66509b7274a604415198009b9d01da4453ddfc63cdc49d7536a43c80721be76fa07cfc8e50e8c153b8e6279f06da76de8ccad136d824573d58997d4ff

data/README.md

@@ -2,8 +2,6 @@
 
 A gem for adding Erlang-style function/method overloading through pattern matching to Ruby classes.
 
-*NOTE: This is a work in progress. Expect changes.*
-
 The project is hosted on the following sites:
 
 * [RubyGems project page](https://rubygems.org/gems/pattern-matching)
@@ -26,7 +24,8 @@ Pattern matching is like function overloading cranked to 11. So one day I was mu
 that I'd like to see Erlang-stype pattern matching in Ruby and one of my friends responded "Build it!"
 So I did. And here it is.
 
-For fun I've also thrown in Erlang's sparsely documented [-behaviour](http://www.erlang.org/doc/design_principles/gen_server_concepts.html).
+For fun I've also thrown in Erlang's sparsely documented [-behaviour](http://www.erlang.org/doc/design_principles/gen_server_concepts.html)
+functionality plus a few other functions and constants I find useful.
 
 ### Goals
 
@@ -85,7 +84,23 @@ gem 'pattern-matching'
 
 and run `bundle install` from your shell.
 
-## Usage
+Once you've installed the gem you must `require` it in your project. Becuase this gem includes multiple features
+that not all users may want, several `require` options are available:
+
+```ruby
+require 'behavior'
+require 'behaviour' # alternate spelling
+require 'pattern_matching'
+require 'pattern_matching/functions'
+```
+
+If you want everything you can do that, too:
+
+```ruby
+require 'pattern_matching/all'
+```
+
+## PatternMatching
 
 First, familiarize yourself with Erlang [pattern matching](http://learnyousomeerlang.com/syntax-in-functions#pattern-matching).
 This gem may not make much sense if you don't understand how Erlang dispatches
@@ -306,11 +321,11 @@ in Ruby. Please read them. Please don't submit a bug report if you use a
 `return` statement within your `defn` and your code blows up with a
 [LocalJumpError](http://ruby-doc.org/core-2.0/LocalJumpError.html). 
 
-## Examples
+### Examples
 
 For more examples see the integration tests in *spec/integration_spec.rb*.
 
-### Simple Functions
+#### Simple Functions
 
 This example is based on [Syntax in defnctions: Pattern Matching](http://learnyousomeerlang.com/syntax-in-defnctions) in [Learn You Some Erlang for Great Good!](http://learnyousomeerlang.com/).
 
@@ -349,7 +364,7 @@ class Foo
 end
 ```
 
-### Simple Functions with Overloading
+#### Simple Functions with Overloading
 
 This example is based on [Syntax in defnctions: Pattern Matching](http://learnyousomeerlang.com/syntax-in-defnctions) in [Learn You Some Erlang for Great Good!](http://learnyousomeerlang.com/).
 
@@ -394,7 +409,7 @@ class Foo
 end
 ```
 
-### Constructor Overloading
+#### Constructor Overloading
 
 ```ruby
 require 'pattern_matching'
@@ -407,7 +422,7 @@ class Foo
 end
 ```
 
-### Matching by Class/Datatype
+#### Matching by Class/Datatype
 
 ```ruby
 require 'pattern_matching'
@@ -430,7 +445,7 @@ class Foo
 end
 ```
 
-### Matching a Hash Parameter
+#### Matching a Hash Parameter
 
 ```ruby
 require 'pattern_matching'
@@ -473,7 +488,7 @@ foo.hashable({bar: :baz})      #=> {bar: :baz}
 foo.hashable({})               #=> :empty 
 ```
 
-### Variable Length Argument Lists with ALL
+#### Variable Length Argument Lists with ALL
 
 ```ruby
 defn(:all, :one, ALL) { |args|
@@ -498,7 +513,7 @@ foo.all('a', 'bee', :see)       #=> ['a', 'bee', :see]
 foo.all()                       #=> NoMethodError: no method `all` matching [] found for class Foo
 ```
 
-### Guard Clauses
+#### Guard Clauses
 
 These examples are based on [Syntax in defnctions: Pattern Matching](http://learnyousomeerlang.com/syntax-in-defnctions)
 in [Learn You Some Erlang for Great Good!](http://learnyousomeerlang.com/).
@@ -541,9 +556,9 @@ defn(:wrong_age, _) {
 }
 ```
 
-### Behavior
+## Behavior
 
-The `behavior` functionality is not import by default. It requires a separate require statement:
+The `behavior` functionality is not imported by default. It requires a separate `require` statement:
 
 ```ruby
 require 'behavior'
@@ -641,6 +656,31 @@ foo.behaves_as?(:bogus)     #=> false
 'foo'.behaves_as? :gen_foo  #=> false
 ```
 
+## Functions
+
+Convenience functions are not imported by default. It require a separate `require` statement:
+
+```ruby
+require 'pattern_matching/functions'
+```
+
+```ruby
+Infinity #=> Infinity
+NaN #=> NaN
+
+repl? #=> true when called under irb, pry, bundle console, or rails console
+
+safe(1, 2){|a, b| a + b} #=> 3
+safe{ eval 'puts "Hello World!"' } #=> SecurityError: Insecure operation
+
+pp_s [1,2,3,4] #=> "[1, 2, 3, 4]\n" props to Rha7
+
+delta(-1, 1) #=> 2
+delta({count: -1}, {count: 1}){|item| item[:count]} #=> 2
+```
+
+This gives you access to a few constants and functions:
+
 ## Copyright
 
 *PatternMatching* is Copyright © 2013 [Jerry D'Antonio](https://twitter.com/jerrydantonio).

data/lib/pattern_matching.rb

@@ -1,7 +1,5 @@
 module PatternMatching
 
-  VERSION = '0.4.0'
-
   UNBOUND = Class.new
   ALL = Class.new
 
@@ -64,7 +62,7 @@ module PatternMatching
     matchers = clazz.__function_pattern_matches__[func]
     return [:nodef, nil] if matchers.nil?
 
-    index = matchers.index do |matcher|
+    match = matchers.detect do |matcher|
       if PatternMatching.__match_pattern__(args, matcher.first)
         if matcher.last.nil?
           true # no guard clause
@@ -74,11 +72,7 @@ module PatternMatching
       end
     end
 
-    if index.nil?
-      return [:nomatch, nil]
-    else
-      return [:ok, matchers[index]]
-    end
+    return (match ? [:ok, match] : [:nomatch, nil])
   end
 
   protected

data/lib/pattern_matching/all.rb

@@ -0,0 +1,4 @@
+require 'behavior'
+require 'pattern_matching'
+require 'pattern_matching/functions'
+require 'pattern_matching/version'

data/lib/pattern_matching/functions.rb

@@ -0,0 +1,62 @@
+require 'pp'
+require 'stringio'
+
+Infinity = 1/0.0 unless defined?(Infinity)
+NaN = 0/0.0 unless defined?(NaN)
+
+module Kernel
+
+  private
+
+  def repl?
+    return ($0 == 'irb' || $0 == 'pry' || $0 == 'script/rails' || !!($0 =~ /bin\/bundle$/))
+  end
+  module_function :repl?
+
+  def safe(*args, &block)
+    raise ArgumentError.new('no block given') unless block_given?
+    result = nil
+    t = Thread.new do
+      $SAFE = 3
+      result = self.instance_exec(*args, &block)
+    end
+    t.join
+    return result
+  end
+  module_function :safe
+
+  # http://rhaseventh.blogspot.com/2008/07/ruby-and-rails-how-to-get-pp-pretty.html
+  def pp_s(*objs)
+    s = StringIO.new
+    objs.each {|obj|
+      PP.pp(obj, s)
+    }
+    s.rewind
+    s.read
+  end
+  module_function :pp_s
+
+  # Compute the difference (delta) between two values.
+  # 
+  # When a block is given the block will be applied to both arguments.
+  # Using a block in this way allows computation against a specific field
+  # in a data set of hashes or objects.
+  #
+  # @yield iterates over each element in the data set
+  # @yieldparam item each element in the data set
+  #
+  # @param [Object] v1 the first value
+  # @param [Object] v2 the second value
+  #
+  # @return [Float] positive value representing the difference
+  #   between the two parameters
+  def delta(v1, v2)
+    if block_given?
+      v1 = yield(v1)
+      v2 = yield(v2)
+    end
+    return (v1 - v2).abs
+  end
+  module_function :delta
+
+end

data/lib/pattern_matching/version.rb

@@ -0,0 +1,3 @@
+module PatternMatching
+  VERSION = '0.4.1'
+end

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
-require 'pattern_matching'
-require 'behavior'
+require 'pattern_matching/all'
 
 # import all the support files
 Dir[File.join(File.dirname(__FILE__), 'support/**/*.rb')].each { |f| require File.expand_path(f) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pattern-matching
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jerry D'Antonio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
+date: 2013-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -26,6 +26,9 @@ dependencies:
         version: '0'
 description: |2
       A gem for adding Erlang-style function/method overloading through pattern matching to Ruby classes.
+
+      For fun I've also thrown in Erlang's sparsely documented -behaviour
+      functionality plus a few other functions and constants I find useful.
 email: jerry.dantonio@gmail.com
 executables: []
 extensions: []
@@ -37,6 +40,9 @@ files:
 - LICENSE
 - lib/behavior.rb
 - lib/behaviour.rb
+- lib/pattern_matching/all.rb
+- lib/pattern_matching/functions.rb
+- lib/pattern_matching/version.rb
 - lib/pattern_matching.rb
 - spec/behavior_spec.rb
 - spec/integration_spec.rb