linear_work_flow 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 53a0f25050636262e9a70c54fbc1d38824faff7d
+  data.tar.gz: f88f42d717458e68efdcaf2bd496ab9687cbbbdf
+SHA512:
+  metadata.gz: 80ddc8acd2c3a7aa0515193ead91df37e4f67ef465a567219b32874956d2cc2ce4639f02b69a297979d698176cdea29b677e4e7d7419e00ca3c7f0347258c73a
+  data.tar.gz: 87329a11b4e1c6e48b0b0fd904ce2ea296a395c345d84461b7117e512175e182e8635779ed698c9b990b8beb584e5cda5cb74e296ca3fc3fbc03a2b4525c62c7

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in linear_work_flow.gemspec
+gemspec
+
+group :test do
+  gem "minitest-reporters"
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rob Nichols
+
+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,100 @@
+# LinearWorkFlow
+
+`LinearWorkFlow` is a basic state machine for managing state change through a
+single linear set of states. That is, there is only one valid sequence of states
+and the work flow is either forward or backward through those steps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'linear_work_flow'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install linear_work_flow
+
+## Usage
+
+### Define a new work flow
+
+To create a new linear work flow, create a new class that inherits from
+`LinearWorkFlow::WorkFlow` with a class method `states` that defines the series
+of steps as an array, in the order the states are to be traversed.
+
+```ruby
+class WorkFlow < LinearWorkFlow::WorkFlow
+
+  def self.states
+    [:one, :two, :three, :four]
+  end
+
+end
+```
+
+### Use the work flow
+
+A new instance of `WorkFlow` will be created via `new` and will have its state
+set as the first state as defined in `WorkFlow.states`.
+
+```ruby
+work_flow = WorkFlow.new
+work_flow.state == :one
+```
+
+### Changing state
+
+Use the methods `forward!` and `back!` to change state.
+
+```ruby
+work_flow.forward!
+work_flow.state == :two
+
+work_flow.forward!
+work_flow.state == :three
+
+work_flow.back!
+work_flow.state == :two
+```
+
+### Check first and last
+
+`first?` and `last?` methods can be used to check if that is at the beginning or
+end of the defined states.
+
+```ruby
+work_flow = WorkFlow.new
+work_flow.first? == true
+work_flow.last? == false
+```
+
+### Initiate at a particular state
+
+A work flow can be initiate at a particular state.
+
+```ruby
+last_state = WorkFlow.states.last
+work_flow = WorkFlow.at last_state
+work_flow.state == last_state == :four
+work_flow.last? == true
+```
+
+### Check where a state can be changed
+
+Use the `can?` method to check whether a work flow can be move forward or back.
+
+```ruby
+work_flow = WorkFlow.new
+work_flow.can?(:back) == false
+work_flow.can?(:forward) == true
+
+work_flow.forward!
+work_flow.can?(:back) == true
+```
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "linear_work_flow"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/linear_work_flow/version.rb

@@ -0,0 +1,3 @@
+module LinearWorkFlow
+  VERSION = "0.1.0"
+end

data/lib/linear_work_flow.rb

@@ -0,0 +1,6 @@
+require "linear_work_flow/version"
+require "linear_work_flow/errors"
+require "linear_work_flow/work_flow"
+
+module LinearWorkFlow
+end

data/linear_work_flow.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'linear_work_flow/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "linear_work_flow"
+  spec.version       = LinearWorkFlow::VERSION
+  spec.authors       = ["Rob Nichols"]
+  spec.email         = ["robnichols@warwickshire.gov.uk"]
+
+  spec.summary       = %q{A state machine for linear work flows}
+  spec.description   = %q{LinearWorkFlow is a basic state machine for managing state change through a single linear path}
+  spec.homepage      = "https://github.com/reggieb/linear_work_flow"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: linear_work_flow
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Nichols
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: LinearWorkFlow is a basic state machine for managing state change through
+  a single linear path
+email:
+- robnichols@warwickshire.gov.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/linear_work_flow.rb
+- lib/linear_work_flow/version.rb
+- linear_work_flow.gemspec
+homepage: https://github.com/reggieb/linear_work_flow
+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.4.8
+signing_key: 
+specification_version: 4
+summary: A state machine for linear work flows
+test_files: []