loadable_component 0.0.1 → 0.0.2

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/loadable_component.rb

@@ -35,4 +35,46 @@ class LoadableComponent
     "could not load #{self.class.name}"
   end
 
+end
+
+class SlowLoadableComponent < LoadableComponent
+  def initialize(timeout)
+    @timeout = timeout
+  end
+
+  def get
+    if loaded?
+      return self
+    end
+
+    end_time = Time.now + @timeout
+    until Time.now >= end_time
+      return self if loaded?
+      check_error
+      sleep sleep_interval
+    end
+
+    unless loaded?
+      raise UnableToLoadComponent, unable_to_load_message
+    end
+
+    self
+  end
+
+  #
+  # Override this method to check for well-known error cases, which
+  # means loading has finished, but an error condition was seen.
+  #
+
+  def check_error
+    # no-op by default
+  end
+
+  def sleep_interval
+    0.2
+  end
+
+  def unable_to_load_message
+    "#{super} after #{@timeout} seconds"
+  end
 end

data/lib/loadable_component/version.rb

@@ -1,3 +1,3 @@
 class LoadableComponent
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/loadable_component.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  # specify any dependencies here; for example:
   s.add_development_dependency "rake"
-  # s.add_runtime_dependency "rest-client"
+  s.add_development_dependency "rspec", "~> 2.0"
+  s.add_development_dependency "timecop"
 end

data/spec/loadable_component_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe LoadableComponent do
+
+  it "does nothing if component is already loaded" do
+    DetonatingComponent.new.get.should be_instance_of(DetonatingComponent)
+  end
+
+  it "calls #load if the component is not already loaded" do
+    ok = LoadsOk.new(true)
+    ok.get.should be_instance_of(LoadsOk)
+
+    ok.load_called?.should be_true
+  end
+
+  it "raises an error if calling load does not cause the component to load" do
+    ok = LoadsOk.new(false)
+    lambda { ok.get }.should raise_error(LoadableComponent::UnableToLoadComponent)
+  end
+
+end

data/spec/slow_loadable_component_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe SlowLoadableComponent do
+
+  it "does nothing if component is already loaded" do
+    SlowlyDetonatingComponent.new.get.should be_instance_of(SlowlyDetonatingComponent)
+  end
+
+  it "calls the load method if the component is not already loaded" do
+    number_of_times_through_loop = 1
+    component = SlowLoading.new(number_of_times_through_loop).get
+    component.should be_instance_of(SlowLoading)
+
+    component.loop_count.should == number_of_times_through_loop
+  end
+
+  it "calls the load method once if the component takes a long time to load" do
+    OnlyOneLoad.new(5).get
+  end
+
+  it "should throw an error if calling load does not cause the component to load before timeout" do
+    lambda { BasicSlowLoader.new(1).get }.should raise_error(LoadableComponent::UnableToLoadComponent, /after 1 seconds/)
+  end
+
+  it "should cancel loading if an error is detected" do
+    lambda { HasError.new(1).get }.should raise_error(HasError::CustomError)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,120 @@
+require 'rspec'
+require 'loadable_component'
+require 'timecop'
+
+class DetonatingComponent < LoadableComponent
+  def load
+    raise "should never be called"
+  end
+
+  def loaded?
+    # already loaded
+    true
+  end
+end
+
+class LoadsOk < LoadableComponent
+  def initialize(second_load_call_passes)
+    @second_load_call_passes = second_load_call_passes
+    @load_called = false
+  end
+
+  def load
+    @load_called = true
+  end
+
+  def loaded?
+    unless @load_called
+      return false
+    end
+
+    unless @second_load_call_passes
+      return false
+    end
+
+    true
+  end
+
+  def load_called?
+    @load_called
+  end
+end
+
+class SlowlyDetonatingComponent < SlowLoadableComponent
+  def initialize
+    super(1)
+  end
+
+  def load
+    raise "should never be called"
+  end
+
+  def loaded?
+    true
+  end
+end
+
+class SlowLoading < SlowLoadableComponent
+  attr_reader :loop_count
+
+  def initialize(count)
+    @count = count
+    @loop_count = 0
+
+    super(1)
+  end
+
+  def load
+    # does nothing
+  end
+
+  def loaded?
+    if @loop_count > @count
+      false
+    else
+      @loop_count += 1
+    end
+  end
+end
+
+class OnlyOneLoad < SlowLoading
+  def initialize(count)
+    super(count)
+    @load_called = false
+  end
+
+  def load
+    if @load_called
+      raise "load already called"
+    end
+
+    @load_called = true
+  end
+end
+
+class BasicSlowLoader < SlowLoadableComponent
+  def load
+    # does nothing
+  end
+
+  def loaded?
+    Timecop.travel 1
+    false # never loads
+  end
+end
+
+class HasError < SlowLoadableComponent
+  class CustomError < StandardError; end
+
+  def load
+    # does nothing
+  end
+
+  def loaded?
+    false
+  end
+
+  def check_error
+    raise CustomError
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: loadable_component
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Jari Bakken
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-18 00:00:00 Z
+date: 2011-12-30 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :development
@@ -31,6 +31,35 @@ dependencies:
   prerelease: false
   name: rake
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  prerelease: false
+  name: rspec
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  name: timecop
+  version_requirements: *id003
 description: Ruby implementation of http://code.google.com/p/selenium/wiki/LoadableComponent
 email: 
 - jari.bakken@gmail.com
@@ -49,6 +78,9 @@ files:
 - lib/loadable_component.rb
 - lib/loadable_component/version.rb
 - loadable_component.gemspec
+- spec/loadable_component_spec.rb
+- spec/slow_loadable_component_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/jarib/loadable_component
 licenses: []
 
@@ -82,5 +114,7 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby implementation of http://code.google.com/p/selenium/wiki/LoadableComponent
-test_files: []
-
+test_files: 
+- spec/loadable_component_spec.rb
+- spec/slow_loadable_component_spec.rb
+- spec/spec_helper.rb