call_by_need 0.1.0 → 0.1.1

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    call_by_need (0.1.0)
+    call_by_need (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 fronx
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/lib/call_by_need/call_by_need.rb

@@ -25,7 +25,7 @@ module CallByNeed
   end
 
   def get(name)
-    if var_get(name).respond_to?(:call)
+    unless evaluated?(name)
       store[name] = var_get(name).call(self)
     else
       var_get(name)
@@ -40,6 +40,10 @@ module CallByNeed
     var_get(key)
   end
 
+  def evaluated?(name)
+    !var_get(name).respond_to?(:call)
+  end
+
 private
   def var_get(name)
     if store.has_key?(name)

data/lib/call_by_need/version.rb

@@ -1,3 +1,3 @@
 module CallByNeed
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/readme.md

@@ -1,3 +1,112 @@
 # Call By Need
 
 So yeah, uhm, you can read about what that means on [Wikipedia](http://en.wikipedia.org/wiki/Evaluation_strategy#Call_by_need). It's like an on-line encyclopedia type thing.
+
+## Examples
+
+### Simple memoization
+
+```ruby
+require 'call_by_need'
+
+c = CallByNeed::Context.new do |c|
+  c.declare(:b) { |x| x.a + 10 }
+  c.declare(:a) { Time.now.utc }
+end
+
+c.a
+# => 2013-09-07 14:48:55 UTC
+c.b
+# => 2013-09-07 14:49:05 UTC
+c.a
+# => 2013-09-07 14:48:55 UTC
+```
+
+### Merging of contexts
+
+```ruby
+require 'call_by_need'
+
+c1 = CallByNeed::Context.new do |c|
+  c.declare(:a, &:b) # b doesn't exist yet
+  c.declare(:x) { |x| x.b + 'x' }
+end
+
+c1.a
+# NoMethodError: undefined method `b'
+
+c2 = CallByNeed::Context.new(c1) do |c|
+  c.declare(:b) { 'b' }
+end
+
+c2.a
+# => 'b'
+c2.x
+# => 'bx'
+```
+
+### You can also give your contexts names
+
+This example is ultimately pointless, but it shows some more elaborate potential usage context that involves slow things and fast things.
+
+```ruby
+require 'call_by_need'
+require 'benchmark'
+
+class Genderizer
+  def self.genders(name)
+    [].tap do |_genders|
+      _genders << :girl if girl?(name)
+      _genders << :boy  if boy?(name)
+    end
+  end
+
+  def self.girl?(name)
+    sleep(0.5)
+    name =~ /^[amk]/
+  end
+
+  def self.boy?(name)
+    sleep(0.5)
+    name =~ /^[bk]/
+  end
+end
+
+class People
+  include CallByNeed
+
+  def initialize(genderizer)
+    declare(:kids) do
+      [ 'alice', 'bob', 'marie', 'kim' ]
+    end
+    declare(:genders) do |x|
+      x.kids.inject({}) do |acc, name|
+        acc.merge!(name => genderizer.genders(name))
+      end
+    end
+    declare(:girls) do |x|
+      x.kids.select { |name| genders[name].include?(:girl) }
+    end
+    declare(:boys) do |x|
+      x.kids.select { |name| genders[name].include?(:boy) }
+    end
+    declare(:unknown) do |x|
+      x.kids.select { |name| [ :boy, :girl ] & genders[name] == [ :boy, :girl ] }
+    end
+  end
+end
+
+people = People.new(Genderizer)
+people.evaluated?(:unknown)
+# => false
+Benchmark.realtime { people.girls }
+# => 4.005
+people.evaluated?(:unknown)
+# => false
+Benchmark.realtime { people.unknown }
+# => 0.00003
+```
+
+## Okay…
+
+It's basically just a generalized `||=`. So maybe the name is a little misleading.

metadata

@@ -2,7 +2,7 @@
 name: call_by_need
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - fronx
@@ -44,8 +44,10 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
 - Gemfile
 - Gemfile.lock
+- LICENSE
 - Rakefile
 - call_by_need.gemspec
 - lib/call_by_need.rb
@@ -67,7 +69,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1747255289361994175
+      hash: -360440508039470097
       segments: 
       - 0
       version: "0"
@@ -76,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 1747255289361994175
+      hash: -360440508039470097
       segments: 
       - 0
       version: "0"