stairway 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 991f7c1a984f7ba0288ce5f67c93cc96714aeb4f
-  data.tar.gz: 7635b04e3800dc5314a02055bdaa515ab46d4eac
+  metadata.gz: ee68673b1df74306c0cf9e9ad5c3b72bd8550155
+  data.tar.gz: 266a0032df11a160e8ef30a5186eac5b2cb40925
 SHA512:
-  metadata.gz: 0bab126c567ecdb508b0822090285f6c5777ce2ef8ae6c571eeddc14e8661a5e3b188507ac98152df8d316c8f2dd4c1531ccddacfc25a3a182260c1c73081515
-  data.tar.gz: 39f2697bb8b338e1d757901e03009bd3cf18f7995d62f2f185dc1425a38e606617aef05ea6b2a32e04916b0a803f7c7908a51ac0ee341480ff07b9848bc5d204
+  metadata.gz: 23e16e340229d6b479e00a6a039a22a3cee78f7f73747084c7bc8b6fc34f1fd9f1f2840f567aa8cdf3651f7d136d2892f53496d555939de39c1df8eadffa68f5
+  data.tar.gz: cd799981dd6a86941af2600586f4c976e693ec09ba538bb4d4e49d9a636807e8bf720271f15455d111a18eb11632d93de095bd20617979c18a0a1fe93cfe0ec7

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--colour --format=Fivemat

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    stairway (0.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    fivemat (1.2.1)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  fivemat (~> 1.2)
+  rake
+  rspec (~> 2.14)
+  stairway!

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2013-2014 Samuel Garneau
+
+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/README.md

@@ -1,13 +1,11 @@
 # Stairway
-Easy and intuitive step by step processing of your business logic.
-
----
+Easy step by step processing of your business logic.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```
+```ruby
 gem 'stairway'
 ```
 
@@ -15,10 +13,10 @@ gem 'stairway'
 
 First, create a new *initializer* to define the different steps of your Stairway:
 
-```
+```ruby
 # config/initializers/stairways.rb
 
-import = Stairway.new(:import)
+import = Stairway::Stairs.new(:import)
 import.steps = {
   download:    ImportSchedule::Download.new,
   unzip:       ImportSchedule::Unzip.new,
@@ -32,21 +30,26 @@ Stairway.register(import)
 
 Now, you can run the logic from anywhere in your application using:
 
-```
-Stairway.mount(:import).run(options)
+```ruby
+Stairway.mount(:import).run
 ```
 
 ## Define your steps
 
-In the above section, you can see a `DownloadContent` class being intanciated. All your step should at least, respond to the `run` method. This method will be automatically called.
+In the above section, you can see a `ImportSchedule::Download` class being intanciated. All your step should at least, respond to the `run` method. This method will be automatically called.
 
-```
-class DownloadContent
+```ruby
+module ImportSchedule
+  class Download < Stairway::Step
+    def run
+      # do stuff here…
 
-	def run(context, options)
-		…do stuff here…		
-	end
+      context[:file_path] = '/tmp/boom.zip'
 
+      # `context` is available in all the steps
+      # and can be modified.
+    end
+  emd
 end
 ```
 
@@ -54,17 +57,17 @@ end
 
 At any time, if you want to stop the processing for whatever reason, you can do this:
 
-```
-class DownloadContent
-
-  def run(context, options)
-    begin
-      …download your content…
-    rescue DownloadError	
-      Stairway.stop
+```ruby
+module ImportSchedule
+  class Download < Stairway::Step
+    def run
+      begin
+        # download your content…
+      rescue DownloadError
+        Stairway.stop
+      end
     end
   end
-
 end
 ```
 
@@ -72,6 +75,10 @@ end
 
 Sometime, I guess, you'll want to run a single step.
 
-```
+```ruby
 Stairway.mount(:import).run_step(:download, context, options)
-```
+```
+
+## License
+
+Stairway is © 2013-2014 [Samuel Garneau](http://twitter.com/garno) and may be freely distributed under the [MIT license](https://github.com/garno/stairway/blob/master/LICENSE). See the `LICENSE` file.

data/lib/stairway.rb

@@ -1,5 +1,42 @@
+require "stairway/stairs"
+require "stairway/step"
 require "stairway/version"
 
+# Exceptions
+require "stairway/exceptions/stop"
+require "stairway/exceptions/unregistered_stairs"
+require "stairway/exceptions/invalid_stairs_object"
+
 module Stairway
-  # Your code goes here...
+
+  @@stairs = {}
+
+  def self.register(*stairs)
+    stairs.each do |s|
+      if valid_stairs?(s)
+        @@stairs.merge! s.name.to_sym => s
+      else
+        raise InvalidStairsObject
+      end
+    end
+
+    true
+  end
+
+  def self.mount(stairs_name)
+    raise UnregisteredStairs unless @@stairs.include?(stairs_name)
+
+    @@stairs[stairs_name]
+  end
+
+  def self.stop
+    raise Stop
+  end
+
+protected
+
+  def self.valid_stairs?(stairs)
+    stairs.respond_to?(:name)
+  end
+
 end

data/lib/stairway/exceptions/invalid_stairs_object.rb

@@ -0,0 +1,4 @@
+module Stairway
+  class InvalidStairsObject < StandardError
+  end
+end

data/lib/stairway/exceptions/stop.rb

@@ -0,0 +1,4 @@
+module Stairway
+  class Stop < StandardError
+  end
+end

data/lib/stairway/exceptions/unregistered_stairs.rb

@@ -0,0 +1,4 @@
+module Stairway
+  class UnregisteredStairs < StandardError
+  end
+end

data/lib/stairway/stairs.rb

@@ -0,0 +1,52 @@
+require 'observer'
+
+module Stairway
+  class Stairs
+    include Observable
+
+    attr_accessor :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def steps
+      @steps
+    end
+
+    def steps=(steps)
+      @steps = steps
+
+      @steps.each do |name, klass|
+        add_observer(klass)
+      end
+    end
+
+    def run(context={}, options={})
+      notify(context, options)
+
+      @steps.each do |name, klass|
+        begin
+          klass.run
+          notify(klass.context, klass.options)
+        rescue Stairway::Stop
+          exit
+        end
+      end
+    end
+
+    def run_step(name, context={}, options={})
+      notify(context, options)
+
+      @steps[name].run
+    end
+
+  protected
+
+    def notify(context, options)
+      changed
+      notify_observers(context, options)
+    end
+
+  end
+end

data/lib/stairway/step.rb

@@ -0,0 +1,16 @@
+module Stairway
+  class Step
+
+    attr_accessor :context, :options
+
+    def initialize
+      @context = {}
+    end
+
+    def update(context, options)
+      @context = context
+      @options = options
+    end
+
+  end
+end

data/lib/stairway/version.rb

@@ -1,3 +1,3 @@
 module Stairway
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+$:.unshift File.expand_path('../lib', __FILE__)
+
+require 'rspec'
+require 'stairway'
+
+RSpec.configure do |config|
+end

data/spec/stairway_spec.rb

@@ -0,0 +1,45 @@
+require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+
+class Klass; end
+
+describe Stairway do
+  subject { Stairway }
+  let(:stairs) { Stairway::Stairs.new(:stairs) }
+  let(:klass) { Klass.new }
+
+  describe '#register' do
+    context 'register a valid Stairs class' do
+      it 'should return true' do
+        Stairway.register(stairs).should be_true
+      end
+    end
+
+    context 'register an unvalid Stairs class' do
+      it 'should raise an UnvalidStairsObject error' do
+        expect { Stairway.register(klass) }.to raise_error(Stairway::InvalidStairsObject)
+      end
+    end
+  end
+
+  describe '#mount' do
+    context 'mount registered stairs' do
+      before { Stairway.register(stairs) }
+
+      it 'should return an intanciated Stairs class' do
+        Stairway.mount(:stairs).class.should eq(Stairway::Stairs)
+      end
+    end
+
+    context 'mount unregistered stairs' do
+      it 'should raise a UnregisteredStairs exception' do
+        expect { Stairway.mount(:ladder) }.to raise_error(Stairway::UnregisteredStairs)
+      end
+    end
+  end
+
+  describe '#stop' do
+    it 'should raise a Stop exception' do
+      expect { Stairway.stop }.to raise_error(Stairway::Stop)
+    end
+  end
+end

data/stairway.gemspec

@@ -20,4 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 2.14'
+  spec.add_development_dependency 'fivemat', '~> 1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stairway
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Samuel Garneau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-29 00:00:00.000000000 Z
+date: 2013-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: fivemat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
 description: Easy and intuitive step by step processing of your business logic.
 email:
 - samgarneau@gmail.com
@@ -45,12 +73,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- .rspec
 - Gemfile
-- LICENSE.txt
+- Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
 - lib/stairway.rb
+- lib/stairway/exceptions/invalid_stairs_object.rb
+- lib/stairway/exceptions/stop.rb
+- lib/stairway/exceptions/unregistered_stairs.rb
+- lib/stairway/stairs.rb
+- lib/stairway/step.rb
 - lib/stairway/version.rb
+- spec/spec_helper.rb
+- spec/stairway_spec.rb
 - stairway.gemspec
 homepage: https://github.com/garno/stairway
 licenses:
@@ -76,4 +114,6 @@ rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
 summary: Easy and intuitive step by step processing of your business logic.
-test_files: []
+test_files:
+- spec/spec_helper.rb
+- spec/stairway_spec.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 Samuel Garneau
-
-MIT License
-
-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.