cistern 0.2.3 → 0.3.0

data/lib/cistern.rb

@@ -2,7 +2,9 @@ require 'cistern/version'
 require 'time'
 
 module Cistern
-  Error = Class.new(StandardError)
+
+  Error   = Class.new(StandardError)
+  Timeout = Class.new(Error)
 
   require 'cistern/hash'
   require 'cistern/mock'
@@ -12,18 +14,14 @@ module Cistern
   require 'cistern/model'
   require 'cistern/service'
 
+  extend WaitFor
+  timeout_error = Timeout
+
   autoload :Formatter, 'cistern/formatter'
 
-  def self.timeout=(timeout); @timeout= timeout; end
-  def self.timeout; @timeout || 0; end
   def self.formatter=(formatter); @formatter = formatter; end
 
   def self.formatter
-    @formatter ||= if defined?(AwesomePrint)
-                     Cistern::Formatter::AwesomePrint
-                   elsif defined?(Formatador)
-                     Cistern::Formatter::Formatador
-                   else Cistern::Formatter::Default
-                   end
+    @formatter ||= Cistern::Formatter.default
   end
 end

data/lib/cistern/collection.rb

@@ -25,11 +25,20 @@ class Cistern::Collection < Array
     end
   end
 
+  attr_accessor :connection
+
+  alias build initialize
+
   def initialize(attributes = {})
     @loaded = false
     merge_attributes(attributes)
   end
 
+  def clear
+    @loaded = true
+    super
+  end
+
   def create(attributes={})
     self.new(attributes).save
   end
@@ -38,17 +47,28 @@ class Cistern::Collection < Array
     raise NotImplementedError
   end
 
-  def clear
-    @loaded = true
-    super
+  def inspect
+    lazy_load unless @loaded
+    Cistern.formatter.call(self)
+  end
+
+  # @api private
+  def lazy_load
+    self.all
+  end
+
+  def load(objects)
+    clear
+    for object in objects
+      self << new(object)
+    end
+    self
   end
 
   def model
     self.class.instance_variable_get('@model')
   end
 
-  attr_accessor :connection
-
   def new(attributes = {})
     unless attributes.is_a?(::Hash)
       raise(ArgumentError.new("Initialization parameters must be an attributes hash, got #{attributes.class} #{attributes.inspect}"))
@@ -61,28 +81,9 @@ class Cistern::Collection < Array
     )
   end
 
-  def load(objects)
-    clear
-    for object in objects
-      self << new(object)
-    end
-    self
-  end
-
   def reload
     clear
     lazy_load
     self
   end
-
-  def inspect
-    lazy_load unless @loaded
-    Cistern.formatter.call(self)
-  end
-
-  private
-
-  def lazy_load
-    self.all
-  end
 end

data/lib/cistern/formatter.rb

@@ -2,4 +2,13 @@ module Cistern::Formatter
   autoload :AwesomePrint, 'cistern/formatter/awesome_print'
   autoload :Default, 'cistern/formatter/default'
   autoload :Formatador, 'cistern/formatter/formatador'
+
+  def self.default
+    if defined?(AwesomePrint)
+      Cistern::Formatter::AwesomePrint
+    elsif defined?(Formatador)
+      Cistern::Formatter::Formatador
+    else Cistern::Formatter::Default
+    end
+  end
 end

data/lib/cistern/model.rb

@@ -33,19 +33,15 @@ class Cistern::Model
        !comparison_object.new_record?)
   end
 
-  def wait_for(timeout=Cistern.timeout, interval=1, &block)
-    reload
-    retries = 3
-    Cistern.wait_for(timeout, interval) do
-      if reload
-        retries = 3
-      elsif retries > 0
-        retries -= 1
-        sleep(1)
-      elsif retries == 0
-        raise Cistern::Error.new("Reload failed, #{self.class} #{self.identity} went away.") # FIXME: pretty much assumes you are calling #ready?
-      end
-      instance_eval(&block)
-    end
+  def service
+    self.connection ? self.connection.class : Cistern
+  end
+
+  def wait_for(timeout = self.service.timeout, interval = self.service.poll_interval, &block)
+    service.wait_for(timeout, interval) { reload && block.call(self) }
+  end
+
+  def wait_for!(timeout = self.service.timeout, interval = self.service.poll_interval, &block)
+    service.wait_for!(timeout, interval) { reload && block.call(self) }
   end
 end

data/lib/cistern/service.rb

@@ -28,10 +28,13 @@ class Cistern::Service
             #{klass.name}
           end
         end
+
         def self.service
           #{klass.name}
         end
       EOS
+
+      klass.send(:const_set, :Timeout, Class.new(Cistern::Error))
     end
 
     def model_path(model_path)
@@ -82,8 +85,8 @@ class Cistern::Service
       requests << request_name
     end
 
-    def collection(collection_name)
-      collections << collection_name
+    def collection(collection_name, options={})
+      collections << [collection_name, options]
     end
 
     def validate_options(options={})
@@ -123,8 +126,8 @@ class Cistern::Service
             EOS
           end
         end
-        collections.each do |collection|
-          require File.join(@model_path, collection.to_s)
+        collections.each do |collection, options|
+          require File.join(@model_path, collection.to_s) unless options[:require] == false
           class_name = collection.to_s.split("_").map(&:capitalize).join
           self.const_get(:Collections).module_eval <<-EOS, __FILE__, __LINE__
             def #{collection}(attributes={})
@@ -140,13 +143,12 @@ class Cistern::Service
       validate_options(options)
       setup_requirements
 
-      if self.mocking?
-        self.const_get(:Mock).send(:include, self.const_get(:Collections))
-        self.const_get(:Mock).new(options)
-      else
-        self.const_get(:Real).send(:include, self.const_get(:Collections))
-        self.const_get(:Real).new(options)
-      end
+      klass = self.const_get(self.mocking? ? :Mock : :Real)
+
+      klass.send(:include, service::Collections)
+      klass.send(:extend, Cistern::WaitFor)
+      klass.timeout_error = service::Timeout
+      klass.new(options)
     end
 
     def reset!

data/lib/cistern/timeout.rb

@@ -0,0 +1,23 @@
+module Cistern
+  module WaitFor
+    def self.wait_for(timeout = Cistern.timeout, interval = Cistern.poll_interval, &block)
+      duration = 0
+      start    = Time.now
+
+      until yield || duration > timeout
+        sleep(interval.to_f)
+        duration = Time.now - start
+      end
+
+      if duration > timeout
+        false
+      else
+        { :duration => duration }
+      end
+    end
+
+    def self.wait_for!(*arg)
+      wait_for
+    end
+  end
+end

data/lib/cistern/version.rb

@@ -1,3 +1,3 @@
 module Cistern
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lib/cistern/wait_for.rb

@@ -1,15 +1,31 @@
+require 'timeout'
+
 module Cistern
-  def self.wait_for(timeout=Cistern.timeout, interval=1, &block)
-    duration = 0
-    start = Time.now
-    until yield || duration > timeout
-      sleep(interval.to_f)
-      duration = Time.now - start
+  module WaitFor
+    DEFAULT_TIMEOUT       = 3 * 60 # 3 minutes
+    DEFAULT_POLL_INTERVAL = 10 # seconds
+
+    def timeout; @timeout || DEFAULT_TIMEOUT; end
+    def timeout=(timeout); @timeout = timeout; end
+    def poll_interval; @poll_interval || DEFAULT_POLL_INTERVAL; end
+    def poll_interval=(poll_interval); @poll_interval = poll_interval; end
+    def timeout_error=(timeout_error); @timeout_error = timeout_error; end
+    def timeout_error; @timeout_error || self.const_defined?(:Timeout) && self.const_get(:Timeout) || ::Timeout::Error; end
+
+    def wait_for(timeout = self.timeout, interval = self.poll_interval, &block)
+      duration = 0
+      start    = Time.now
+
+      until yield || duration > timeout
+        sleep(interval.to_f)
+        duration = Time.now - start
+      end
+
+      duration > timeout ? false : duration
     end
-    if duration > timeout
-      false
-    else
-      { :duration => duration }
+
+    def wait_for!(timeout = self.timeout, interval = self.poll_interval, &block)
+      wait_for(timeout, interval, &block) || raise(timeout_error, "wait_for(#{timeout}) exceeded")
     end
   end
 end

data/spec/wait_for_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+class WaitForService < Cistern::Service
+  model :wait_for_model, require: false
+  collection :wait_for_models, require: false
+
+  class Real
+    def initialize(*args)
+    end
+  end
+end
+
+class WaitForService::WaitForModel < Cistern::Model
+  identity :id
+
+  attribute :name
+end
+
+class WaitForService::WaitForModels < Cistern::Collection
+  model WaitForService::WaitForModel
+
+  def get(identity)
+    self
+  end
+end
+
+describe 'Cistern#wait_for' do
+  it "should return false if timeout exceeded" do
+    Cistern.wait_for(0, 0) { false }.should be_false
+  end
+end
+
+describe 'Cistern#wait_for!' do
+  it "should raise if timeout exceeded" do
+    lambda { Cistern.wait_for!(0, 0) { false } }.should raise_exception(Cistern::Timeout)
+  end
+end
+
+describe 'Cistern::Model#wait_for!' do
+  let(:service) { WaitForService.new }
+  let(:model)   { service.wait_for_models.new(identity: 1) }
+
+  it "should raise if timeout exceeded" do
+    lambda { model.wait_for!(0, 0) { false } }.should raise_exception(WaitForService::Timeout)
+  end
+end
+
+
+describe "WaitForModel#timeout" do
+  let(:service) { WaitForService.new }
+  let(:model)   { service.wait_for_models.new(identity: 1) }
+
+  it "should use service-specific timeout in #wait_for" do
+    service.class.timeout = 0.1
+    service.class.poll_interval = 0
+
+    elapsed = 0
+
+    timeout(2) do
+      lambda do
+        model.wait_for! { sleep(0.2); elapsed += 0.2; elapsed > 0.2 }
+      end.should raise_exception(WaitForService::Timeout)
+    end
+  end
+
+  it "should favor explicit timeout" do
+    service.class.timeout = 1
+    service.class.poll_interval = 0
+
+    elapsed = 0
+
+    timeout(2) do
+      lambda do
+        model.wait_for!(0.1) { sleep(0.2); elapsed += 0.2; elapsed > 0.2 }
+      end.should raise_exception(WaitForService::Timeout)
+    end
+  end
+end

metadata

@@ -2,14 +2,14 @@
 name: cistern
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Josh Lane
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-17 00:00:00.000000000 Z
+date: 2013-07-29 00:00:00.000000000 Z
 dependencies: []
 description: API client framework extracted from Fog
 email:
@@ -37,12 +37,14 @@ files:
 - lib/cistern/mock.rb
 - lib/cistern/model.rb
 - lib/cistern/service.rb
+- lib/cistern/timeout.rb
 - lib/cistern/version.rb
 - lib/cistern/wait_for.rb
 - spec/cistern_spec.rb
 - spec/collection_spec.rb
 - spec/model_spec.rb
 - spec/spec_helper.rb
+- spec/wait_for_spec.rb
 homepage: http://joshualane.com/cistern
 licenses: []
 post_install_message: 
@@ -72,4 +74,5 @@ test_files:
 - spec/collection_spec.rb
 - spec/model_spec.rb
 - spec/spec_helper.rb
+- spec/wait_for_spec.rb
 has_rdoc: