zeevex_delayed 0.9.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in zeevex_delayed.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,32 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+namespace :spec do
+  desc "Run on three Rubies"
+  task :platforms do
+    current = %x{rvm-prompt v}
+    
+    fail = false
+    %w{1.8.7 1.9.3 ree}.each do |version|
+      puts "Switching to #{version}"
+      Bundler.with_clean_env do
+        system %{bash -c 'source ~/.rvm/scripts/rvm && rvm #{version} && bundle exec rake spec'}
+      end
+      if $?.exitstatus != 0
+        fail = true
+        break
+      end
+    end
+
+    system %{rvm #{current}}
+
+    exit (fail ? 1 : 0)
+  end
+end
+
+task :default => 'spec:platforms'

data/lib/zeevex_delayed/promise.rb

@@ -0,0 +1,34 @@
+require 'zeevex_proxy'
+
+module ZeevexDelayed
+  class Promise < ZeevexProxy::Base
+
+    def initialize(obj=nil, &block)
+      super
+      @__promise_block = block
+      raise ArgumentError, "Must supply a block!" unless block
+    end
+    
+    def method_missing(name, *args, &block)
+      __force__.__send__(name, *args, &block)
+    end
+    
+    def __force__
+      unless @__promise_forced
+        @obj = @__promise_block.call
+        @__promise_forced = true
+      end
+      @obj
+    end
+  end
+end
+
+module Kernel
+  def force_promise(promise)
+    promise.__force__
+  end
+  
+  def promise(&block)
+    ZeevexDelayed::Promise.new &block
+  end
+end

data/lib/zeevex_delayed/thread_promise.rb

@@ -0,0 +1,45 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'promise'))
+require 'zeevex_proxy'
+
+module ZeevexDelayed
+  #
+  # Like a Promise, but evaluate and cache values on a per-thread basis
+  #
+  # e.g. will act just like a Promise if only called from one thread, but if
+  # Thread A and Thread B both access a Promise created like so:
+  #
+  #   promise { Thread.current.object_id }
+  #
+  # Then they will see different values.  This does cache, and it does not
+  # GC its cache when threads exit.  Thus if you expect to have a very
+  # long-lived Promise accessed from many different threads that come and
+  # go, don't use this.
+  #
+
+  class ThreadPromise < ZeevexProxy::Base
+
+    def initialize(obj=nil, &block)
+      raise ArgumentError, "Must supply a block!" unless block_given?
+      super
+      @__promise_thread_map = {}
+      @__promise_block = block
+    end
+
+    def method_missing(name, *args, &block)
+      __force__.__send__(name, *args, &block)
+    end
+
+    def __force__
+      unless @__promise_thread_map.has_key?(Thread.current.object_id)
+        @__promise_thread_map[Thread.current.object_id] = @__promise_block.call
+      end
+      @__promise_thread_map[Thread.current.object_id]
+    end
+  end
+end
+
+module Kernel
+  def thread_promise(&block)
+    ZeevexDelayed::ThreadPromise.new &block
+  end
+end

data/lib/zeevex_delayed/version.rb

@@ -0,0 +1,3 @@
+module ZeevexDelayed
+  VERSION = "0.9.0"
+end

data/lib/zeevex_delayed.rb

@@ -0,0 +1,6 @@
+module ZeevexDelayed
+  VERSION = "0.9.0"
+end
+
+require 'zeevex_delayed/promise'
+require 'zeevex_delayed/thread_promise'

data/spec/promise_spec.rb

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper.rb')
+
+describe ZeevexDelayed::Promise do
+
+  let :promise_class do
+    ZeevexDelayed::Promise
+  end
+
+  context "as a basic promise" do
+    it_should_behave_like "basic promise"
+  end
+  
+  context "when called from different threads" do
+    it "should call the block once for all threads" do
+      canary = mock("canary")
+      canary.should_receive(:life).once.and_return(42)
+
+      @val = promise_class.new { canary.life }
+
+      Thread.new { @val.to_i }.join
+      Thread.new { @val.to_i }.join
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,95 @@
+# -*- coding: utf-8 -*-
+
+$: << File.expand_path(File.dirname(__FILE__) + '../lib')
+
+require 'rspec'
+require 'zeevex_delayed'
+
+puts "loading spec helper..."
+
+# Be sure to include AuthenticatedTestHelper in spec/spec_helper.rb instead.
+# Then, you can remove it from this and the functional test.
+
+shared_examples_for "results caching" do
+  it "should only call the block once" do
+    @val = promise_class.new { canary.life }
+    @val.__force__
+    @val.__force__
+  end
+end
+
+
+shared_examples_for "basic promise" do
+
+  let :canary do
+    mock("canary").tap do |mock|
+      mock.stub(:doit).and_return("hello")
+    end
+  end
+
+  let :test_promise do
+    promise_class.new { canary.doit }
+  end
+
+  subject { test_promise }
+
+  context "#initialize" do
+    it "should not invoke the block during initialization" do
+      canary = mock("canary")
+      canary.should_receive(:oops).never
+
+      @val = promise_class.new { canary.oops }
+    end
+  end
+
+  it "should require a block" do
+    expect { promise_class.new }.
+        to raise_exception(ArgumentError)
+  end
+
+  it "should return the value of the block on to_s" do
+    promise_class.new { "a" + "b" }.should == "ab"
+  end
+
+  it "should call the block only when needed" do
+    foo = 1
+    @val = promise_class.new { foo }
+    foo = 2
+    @val.should == 2
+  end
+
+  context "when forcing computation" do
+    it "should respond to __force__" do
+      # check here because respond_to? invoked on a promise would delegate
+      promise_class.instance_methods.should include("__force__")
+    end
+
+    it "should be computed when Kernel#force_promise is called" do
+      canary.should_receive(:doit).and_return('abcde')
+      force_promise subject
+    end
+  end
+
+  it "should return the block's value from __force__" do
+    subject.__force__.should == "hello"
+  end
+
+
+  context "for blocks that return false" do
+    let :canary do
+      canary = mock("canary")
+      canary.should_receive(:life).once.and_return(false)
+      canary
+    end
+    it_should_behave_like "results caching"
+  end
+
+  context "for blocks that return nil" do
+    let :canary do
+      canary = mock("canary")
+      canary.should_receive(:life).once.and_return(nil)
+      canary
+    end
+    it_should_behave_like "results caching"
+  end
+end

data/spec/thread_promise_spec.rb

@@ -0,0 +1,35 @@
+
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper.rb')
+
+describe ZeevexDelayed::ThreadPromise do
+
+  let :promise_class do
+    ZeevexDelayed::ThreadPromise
+  end
+
+  context "as a basic promise" do
+    it_should_behave_like "basic promise"
+  end
+
+  context "when called from different threads" do
+    it "should call the block again for each new thread" do
+      canary = mock("canary")
+      canary.should_receive(:life).twice.and_return(42)
+
+      @val = promise_class.new { canary.life }
+
+      Thread.new { @val.to_i }.join
+      Thread.new { @val.to_i }.join
+    end
+
+    it "should call the block only once for each thread" do
+      canary = mock("canary")
+      canary.should_receive(:life).twice.and_return(42)
+
+      @val = promise_class.new { canary.life }
+
+      Thread.new { @val.to_i; @val.to_i }.join
+      Thread.new { @val.to_i; @val.to_i }.join
+    end
+  end
+end

data/zeevex_delayed.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "zeevex_delayed/version"
+
+Gem::Specification.new do |s|
+  s.name        = "zeevex_delayed"
+  s.version     = ZeevexDelayed::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Robert Sanders"]
+  s.email       = ["robert@zeevex.com"]
+  s.homepage    = ""
+  s.summary     = %q{Basic and per-thread promise classes.}
+  s.description = %q{This gem provides a couple of classes useful for deferred computation.}
+
+  s.rubyforge_project = "zeevex_delayed"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'zeevex_proxy'
+
+  s.add_development_dependency 'rspec', '~> 2.9.0'
+  s.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: zeevex_delayed
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  - 0
+  version: 0.9.0
+platform: ruby
+authors: 
+- Robert Sanders
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-05-02 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: zeevex_proxy
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 9
+        - 0
+        version: 2.9.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: This gem provides a couple of classes useful for deferred computation.
+email: 
+- robert@zeevex.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/zeevex_delayed.rb
+- lib/zeevex_delayed/promise.rb
+- lib/zeevex_delayed/thread_promise.rb
+- lib/zeevex_delayed/version.rb
+- spec/promise_spec.rb
+- spec/spec_helper.rb
+- spec/thread_promise_spec.rb
+- zeevex_delayed.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: zeevex_delayed
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Basic and per-thread promise classes.
+test_files: 
+- spec/promise_spec.rb
+- spec/spec_helper.rb
+- spec/thread_promise_spec.rb