manana 0.1.0 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4260f96ef0f5a33bc8a66db747e1759388927bc1
+  data.tar.gz: 9cb8a090b23e690c940fdefbbd1ababa97c41fd7
+SHA512:
+  metadata.gz: bd56b8099f8cfad6e654fb4c2093d95e583c96dd433d3a690661e63d98c0228337e6c48739feda76a5757a8232ffb90d4bd63785cff5179d90d1181b17ee91a3
+  data.tar.gz: 46bcc0990610755a158174ce7715c41c2d70bbd55d7858e289714a013bee6cb4e460bc910f178dab0ec6ef7541089795ab4063401d40d2fd96fdd3b90c9372d7

data/.travis.yml

@@ -2,6 +2,7 @@ language: ruby
 rvm:
   - 1.9.2
   - 1.9.3
+  - 2.1.5
 env:  
   global:
     - "TRAVIS=1"

data/Gemfile

@@ -10,10 +10,12 @@ unless ENV["TRAVIS"] == "1"
     gem 'yard'
     gem 'redcarpet'
 
-    gem 'pry'
-    gem 'pry-debugger'
-    gem 'pry-rescue'
-    gem 'pry-stack_explorer'
+    if RUBY_VERSION =~ /^2\./
+      gem 'pry-byebug'
+    else
+      gem 'pry'
+    end
+
   end
 
   group :samples do
@@ -29,6 +31,5 @@ end
 
 # for travis.cl
 group :test do
-  gem 'rake'
   gem 'mocha'
 end

data/README.md

@@ -58,7 +58,7 @@ Or install it yourself as:
 require 'manana'
 
 # initialization...
-client = Manana.deferred_init {
+client = Manana.wrap {
   Weather.setup    # web service adapter setup
   Weather          # return the class instance
 }

data/lib/manana/version.rb

@@ -1,3 +1,3 @@
 class Manana
-  VERSION = "0.1.0"
+  VERSION = "0.5.0"
 end

data/lib/manana.rb

@@ -4,7 +4,7 @@ require "manana/version"
 # *Manana* lets you defer the initialization of an object until its methods are called.
 # @example basic usage - see {https://github.com/coldnebo/manana/blob/master/samples/self_healing.rb samples/self_healing.rb}
 #   #   initialization...
-#   client = Manana.deferred_init {
+#   client = Manana.wrap {
 #     Weather.setup
 #     Weather
 #   }
@@ -16,50 +16,52 @@ require "manana/version"
 #   }
 #
 class Manana
-  
-  # wraps an initialization block so that it can be deferred to a later time when object methods are called.
+  private_class_method :new
+
+  # wraps the initialization of an object so that it can be deferred to a later time when object methods are called.
   # @example wrap an object - see {https://github.com/coldnebo/manana/blob/master/samples/self_healing.rb samples/self_healing.rb}
-  #   client = Manana.deferred_init {
+  #   client = Manana.wrap {
   #     Weather.setup  # initialize the class 
   #     Weather        # return the Weather class
   #   }
   # 
   # @param initialization_block [Proc] object initialization. the block must return the object to be wrapped.
-  # @return [Manana] a wrapped version of the object.
-  def self.deferred_init(&initialization_block)
-    Manana.new(&initialization_block)
+  # @return [Deferrable] a wrapped version of the object.
+  def self.wrap(&initialization_block)
+    Deferrable.send(:new,&initialization_block)
   end 
 
-  # passes any method call through to the wrapped object after ensuring that the initialization block has 
-  # successfully completed once (setting a valid instance of the object).  
-  # @note Once the initialization block succeeds, it keeps the resulting object instance for subsequent method calls. 
-  #
-  # @example calling a wrapped object - see {https://github.com/coldnebo/manana/blob/master/samples/self_healing.rb samples/self_healing.rb}
-  #   weather = client.city_weather("02201")
-  #
-  def method_missing(method, *args, &block)
-    instance = safe_get_instance
-    instance.send(method, *args, &block);
-  end
-
-  private
+  # class that proxies all requests to the wrapped object, ensuring that the object has been correctly initialized first.
+  class Deferrable < ::BasicObject
+    private_class_method :new 
 
-  def initialize(&initialization_block)
-    @mutex = Mutex.new
-    @deferred_initialization = initialization_block
-  end
+    # passes any method call through to the wrapped object after ensuring that the initialization block has 
+    # successfully completed once (thereby initializing the wrapped object).  
+    # @note Once the initialization block succeeds, it keeps the resulting object for subsequent method calls. 
+    #
+    # @example calling a wrapped object - see {https://github.com/coldnebo/manana/blob/master/samples/self_healing.rb samples/self_healing.rb}
+    #   weather = client.city_weather("02201")
+    #
+    def method_missing(method, *args, &block)
+      _object.send(method, *args, &block);
+    end
 
-  def safe_get_instance
-    @mutex.synchronize do 
-      get_instance
+    # allows direct access to the wrapped object -- useful for debugging
+    # @return [Object] the object being wrapped
+    def _object
+      @mutex.synchronize do 
+        if @object.nil?
+          @object = @deferred_initialization.call
+        end
+        @object
+      end
     end
-  end
 
-  def get_instance
-    if @instance.nil?
-      @instance = @deferred_initialization.call
+  private
+    def initialize(&initialization_block)
+      @mutex = ::Mutex.new
+      @deferred_initialization = initialization_block
     end
-    @instance
   end
 
 end

data/manana.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest"
 end

data/samples/exponential_backoff.rb

@@ -31,7 +31,7 @@ end
 
 # ------------ initialization code
 
-client = Manana.deferred_init {
+client = Manana.wrap {
   # exponential backkoff logic in the initialization block
   retries = 0
   obj = nil

data/samples/fast_startup.rb

@@ -44,7 +44,7 @@ mini_death_star = nil
 puts "[Vader]: requsition a new DeathStar and make it snappy!"
 # boss said requisitions have to be faster*!  Manana to the rescue!
 puts Benchmark.measure {
-  mini_death_star = Manana.deferred_init {
+  mini_death_star = Manana.wrap {
     DeathStar.new
   }
 }

data/samples/self_healing.rb

@@ -47,7 +47,7 @@ end
 
 # Before we start, we use Manana to wrap the client setup so that method calls on the client can be self-healing in case of failure.
 # NOTE: that the caller doesn't have to deal with whether or not this initialization succeeded, they can just call the client methods repeatedly.
-client = Manana.deferred_init {
+client = Manana.wrap {
   Weather.setup
   Weather
 }

data/test/base_klass.rb

@@ -0,0 +1,17 @@
+# something like ActiveRecord::Base
+class BaseKlass
+
+  def self.connected?
+    @@connected ||= false
+  end
+
+  def self.establish_connection
+    @@connected = true
+  end
+
+  def self.find
+    raise "not connected!" unless self.connected?
+    [1,2,3]
+  end
+
+end

data/test/minitest_helper.rb

@@ -9,6 +9,7 @@ end
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'manana'
 
+
 require 'minitest/autorun'
 require 'mocha/setup'
 

data/test/test_manana.rb

@@ -33,10 +33,10 @@ class TestManana < Minitest::Test
     end
   end
 
-  def test_deferred_init
+  def test_wrap
     obj = nil
     out, err = capture_io do
-      obj = Manana.deferred_init {
+      obj = Manana.wrap {
         Klass.new
       }
     end
@@ -65,11 +65,12 @@ class TestManana < Minitest::Test
     end
   end
 
+
   # https://github.com/coldnebo/manana/issues/1 
   def test_that_init_is_threadsafe
     Klass.reset
 
-    klass = Manana.deferred_init {
+    klass = Manana.wrap {
       sleep(1)
       Klass.incr
       Klass

data/test/test_with_subclass.rb

@@ -0,0 +1,42 @@
+require 'minitest_helper'
+require 'base_klass'
+
+class TestWithSubclass < Minitest::Test
+  
+  # initialize a very generic example object that does some stuff in initialization and has some instance methods you can call.
+  def setup
+    BaseKlass.class_variable_set(:@@connected, false)
+  end
+
+  # sanity check
+  def test_that_things_work_without_manana
+    @subklass = Class.new(BaseKlass)
+
+    assert_raises RuntimeError do
+      res = @subklass.find
+    end
+
+    BaseKlass.establish_connection
+
+    res = @subklass.find
+    refute_empty(res)
+
+  end
+
+  def test_wrap
+
+    @subklass = Manana.wrap {
+      unless BaseKlass.connected?
+        BaseKlass.establish_connection 
+      end
+      subklass = Class.new(BaseKlass)
+    }
+
+    res = @subklass.find
+    refute_empty(res)
+    assert(BaseKlass.connected?)
+
+  end
+
+
+end

metadata

@@ -1,62 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: manana
 version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+  version: 0.5.0
 platform: ruby
 authors:
 - coldnebo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-17 00:00:00.000000000 Z
+date: 2015-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: provides a simple way to defer initialization of an object until its
@@ -67,9 +60,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
-- .yardopts
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -83,43 +76,40 @@ files:
 - samples/exponential_backoff.rb
 - samples/fast_startup.rb
 - samples/self_healing.rb
+- test/base_klass.rb
 - test/klass.rb
 - test/minitest_helper.rb
 - test/test_manana.rb
+- test/test_with_subclass.rb
 homepage: https://github.com/coldnebo/manana
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3306959934859244204
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -3306959934859244204
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.4.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: provides a simple way to defer initialization of an object until its methods
   are called
 test_files:
+- test/base_klass.rb
 - test/klass.rb
 - test/minitest_helper.rb
 - test/test_manana.rb
+- test/test_with_subclass.rb
 has_rdoc: