stairway 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 991f7c1a984f7ba0288ce5f67c93cc96714aeb4f
+  data.tar.gz: 7635b04e3800dc5314a02055bdaa515ab46d4eac
+SHA512:
+  metadata.gz: 0bab126c567ecdb508b0822090285f6c5777ce2ef8ae6c571eeddc14e8661a5e3b188507ac98152df8d316c8f2dd4c1531ccddacfc25a3a182260c1c73081515
+  data.tar.gz: 39f2697bb8b338e1d757901e03009bd3cf18f7995d62f2f185dc1425a38e606617aef05ea6b2a32e04916b0a803f7c7908a51ac0ee341480ff07b9848bc5d204

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+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.

data/README.md

@@ -0,0 +1,77 @@
+# Stairway
+Easy and intuitive step by step processing of your business logic.
+
+---
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```
+gem 'stairway'
+```
+
+## Usage
+
+First, create a new *initializer* to define the different steps of your Stairway:
+
+```
+# config/initializers/stairways.rb
+
+import = Stairway.new(:import)
+import.steps = {
+  download:    ImportSchedule::Download.new,
+  unzip:       ImportSchedule::Unzip.new,
+  convert_sql: ImportSchedule::ConvertToSQL.new,
+  import:      ImportSchedule::Import.new
+  clean:       ImportSchedule::Cleanup.new
+}
+
+Stairway.register(import)
+```
+
+Now, you can run the logic from anywhere in your application using:
+
+```
+Stairway.mount(:import).run(options)
+```
+
+## 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.
+
+```
+class DownloadContent
+
+	def run(context, options)
+		…do stuff here…		
+	end
+
+end
+```
+
+## Break the flow
+
+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
+    end
+  end
+
+end
+```
+
+## Run a single step
+
+Sometime, I guess, you'll want to run a single step.
+
+```
+Stairway.mount(:import).run_step(:download, context, options)
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/stairway/version.rb

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

data/lib/stairway.rb

@@ -0,0 +1,5 @@
+require "stairway/version"
+
+module Stairway
+  # Your code goes here...
+end

data/stairway.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stairway/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "stairway"
+  spec.version       = Stairway::VERSION
+  spec.authors       = ["Samuel Garneau"]
+  spec.email         = ["samgarneau@gmail.com"]
+  spec.description   = %q{Easy and intuitive step by step processing of your business logic.}
+  spec.summary       = %q{Easy and intuitive step by step processing of your business logic.}
+  spec.homepage      = "https://github.com/garno/stairway"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  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 "rake"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: stairway
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Samuel Garneau
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy and intuitive step by step processing of your business logic.
+email:
+- samgarneau@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stairway.rb
+- lib/stairway/version.rb
+- stairway.gemspec
+homepage: https://github.com/garno/stairway
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Easy and intuitive step by step processing of your business logic.
+test_files: []