bstard 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTJmMDJmODEzNDNjOWNjODJlMDRmOWUyZWQ3N2I3NmY5NTA2ODk3Mw==
+  data.tar.gz: !binary |-
+    NjI3YmVkYzhkYWE5YTA1MGY3MGYxN2ZlMjliNDY1YzNiODlkZTg2Mw==
+SHA512:
+  metadata.gz: !binary |-
+    ODM1MGQxYzkzNTQzYzkyNTEzYTE1MGY0YmI2MmY2OTUxMDUyOTg0YmU3MjM3
+    NWVjM2E4YjVlMTZlMjMyZmRhOTMxZmI4MTQ3Y2Q5M2IzMTRlMDcxNzU0YmVi
+    ZmM1ZTg4ZjQ3MzIzYjI5NTUzYWM3Zjc0ZGM3MjkxMTZiOTY1NTk=
+  data.tar.gz: !binary |-
+    ZGNlZDk4Njk5Zjg4OTkwMTg4Y2Q5ODI5Njc2YjZjNjgwNGQ4MTM2YjE2Mjkw
+    MTI2YmMxZTA4Y2NkNGE2NzkyZjg1MjI4MDdhNzgwNjMyOTViZmNiODg2OWQy
+    OWQzYzgxZTI4OWI1YjczMTI1OWIyYTZhZjE4NTg1NTI2ZGQ2NTc=

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tony Headford
+
+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,170 @@
+# Bstard - A New State(sman) Machine
+
+A small state machine library with a simple interface. Designed around the concept of aggregation rather than inheritance enabling its use wherever you need it without the need to derive from it or mix it in.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'bstard'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bstard
+
+## Usage
+
+Use `Bstard.define` to describe your state machine
+
+``` ruby
+  machine = Bstard.define do |fsm|
+    fsm.initial :new
+    fsm.event :submit, :new => :submitted
+    fsm.event :delete, :submitted => :deleted
+  end
+```
+
+This defines a state machine that:
+
+ - has __new__ __submitted__ and __deleted__ states
+ - responds to _submit_ and _delete_ events
+ - has an initial state of __new__
+ - transitions from __new__ to __submitted__ when triggered by the _submit_ event
+ - transitions from __submitted__ to __deleted__ when triggered by the _delete_ event
+
+Pretty simple huh?
+
+### Initial State
+Set the initial state of the machine with `initial`. If no initial state is set a default state `:uninitialized` is used.
+
+### Querying the State
+
+The current state of the machine is accessed via the `current_state` method
+
+``` ruby
+  machine.current_state
+  #=> :new
+```
+
+Helper methods are automatically generated for each state consisting of the state name appended with a question mark.  This method returns true is the current state matches the queried state or false otherwise.
+
+``` ruby
+  machine.new?
+  #=> true
+  machine.submitted?
+  #=> false
+  machine.deleted?
+  #=> false
+```
+
+### Querying Transitions
+
+Helper methods are dynamically generated to enable querying whether an event is valid for the current state.  These methods are named using the event name prefixed with 'can\_' and suffixed with a question mark.
+
+```ruby
+  machine.current_state
+  #=> :new
+  machine.can_submit?
+  #=> true
+  machine.can_delete?
+  #=> false
+```
+
+### Triggering Events
+
+Trigger events by sending a message to the state machine using the event name suffixed with an exclamation mark.
+
+```ruby
+  machine.submit!
+  #=> :submitted
+  machine.delete!
+  #=> :deleted
+```
+
+### Callbacks
+
+Callbacks can be configured for particular events and state changes, or for _any_ event or state change.
+Event callbacks are configured with `on`
+
+``` ruby
+  machine = Bstard.define do |fsm|
+    # ...
+    fsm.on :submit do |previous_state|
+      # code that needs to be run when :submit is triggered
+    end
+  end
+```
+
+State change callbacks are configured with `when`
+
+``` ruby
+  machine = Bstard.define do |fsm|
+    # ...
+    fsm.when :submitted do |previous_state|
+      # code that needs to run when state changes to :submitted
+    end
+  end
+```
+
+Use the symbol `:any` for event or state change callbacks that should by run when any event is triggered or after any state change.
+
+``` ruby
+  machine = Bstard.define do |fsm|
+    # ...
+    fsm.on :any do |previous_state|
+      # code that will run when any event is triggered
+    end
+    fsm.when :any do |previous_state|
+      # code that will run when after any state change
+    end
+  end
+```
+
+e.g. Use `initial` and `when :any` to persist state
+
+``` ruby
+class MyModel < ActiveRecord::Base
+  def make_draft
+    # do stuff
+    state.save!
+  end
+
+private
+  def state
+    @state ||= Bstard.define do |fsm|
+      fsm.initial status
+      fsm.event :save, :new => :draft
+      fsm.event :approve, :draft => :approved
+      fsm.when :any do |prev_state|
+        status = fsm.current_state
+      end
+    end
+  end
+end
+```
+
+### Exceptions
+
+An `InvalidTransition` error will be raised if an event is triggered on a state that cannot transition on that event.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+To install this gem onto your local machine, run `bundle exec rake install`.
+To run the tests, run `bundle exec rake test`.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/bstard/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bstard"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bstard.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bstard/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bstard"
+  spec.version       = Bstard::VERSION
+  spec.authors       = ["Tony Headford"]
+  spec.email         = ["tony@binarycircus.com"]
+
+  spec.summary       = %q{A Lightweight State Machine}
+  spec.description   = %q{Bstard is a New State(sman) Machine}
+  spec.homepage      = "https://github.com/tonyheadford/bstard"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  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.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
+end

data/lib/bstard.rb

@@ -0,0 +1,12 @@
+require 'bstard/version'
+require 'bstard/fsm'
+require 'bstard/errors'
+
+module Bstard
+  def self.define
+    fsm = Fsm.new
+    yield fsm if block_given?
+    fsm
+  end
+end
+

data/lib/bstard/errors.rb

@@ -0,0 +1,4 @@
+module Bstard
+  class InvalidEvent < ::ArgumentError; end
+  class InvalidTransition < ::ArgumentError; end
+end

data/lib/bstard/fsm.rb

@@ -0,0 +1,86 @@
+class Bstard::Fsm
+  attr_reader :current_state
+
+  def initialize()
+    @current_state = :uninitialized
+    @events = {}
+    @states = []
+    @event_callbacks = {}
+    @state_callbacks = {}
+  end
+
+  def initial(state)
+    @current_state = state
+    add_state(state)
+  end
+
+  def event(event_name, transitions)
+    evt = event_name.to_sym
+    t = @events.fetch(evt, {})
+    @events[evt] = t.merge(transitions)
+    transitions.each { |k,v| add_state(k); add_state(v) }
+    add_event_method(evt)
+    add_can_event_method(evt)
+  end
+
+  def on(event, &block)
+    callbacks = @event_callbacks.fetch(event.to_sym, [])
+    @event_callbacks[event.to_sym] = callbacks << block
+  end
+
+  def when(state, &block)
+    callbacks = @state_callbacks.fetch(state.to_sym, [])
+    @state_callbacks[state.to_sym] = callbacks << block
+  end
+
+  def events
+    @events.keys.sort
+  end
+
+  def states
+    @states.sort
+  end
+
+  private
+
+  def add_state(state)
+    s = state.to_sym
+    unless @states.include? s
+      @states << s
+      metaclass.send :define_method, "#{s.to_s}?" do
+        current_state == s
+      end
+    end
+  end
+
+  def add_event_method(evt)
+    unless self.respond_to? evt
+      metaclass.send :define_method, "#{evt.to_s}!" do
+        transitions = @events[evt]
+        raise Bstard::InvalidEvent.new("Unknown event <#{evt.to_s}>") if transitions.nil?
+        new_state = transitions[current_state]
+        raise Bstard::InvalidTransition.new("Cannot <#{evt.to_s}> from [#{current_state.to_s}]") if new_state.nil?
+        @event_callbacks.fetch(evt.to_sym, []).concat(@event_callbacks.fetch(:any, [])).each { |c| c.call(current_state) }
+        old_state = current_state
+        @current_state = new_state
+        @state_callbacks.fetch(current_state, []).concat(@state_callbacks.fetch(:any, [])).each { |c| c.call(old_state) }
+        current_state
+      end
+    end
+  end
+
+  def add_can_event_method(evt)
+    m = "can_#{evt.to_s}?"
+    unless self.respond_to? m
+      metaclass.send :define_method, m do
+        transitions = @events[evt]
+        transitions && transitions[current_state]
+      end 
+    end
+  end
+
+  def metaclass
+    class << self; self; end
+  end
+end
+

data/lib/bstard/version.rb

@@ -0,0 +1,4 @@
+module Bstard
+  VERSION = '0.1.0'
+end
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: bstard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tony Headford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  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: Bstard is a New State(sman) Machine
+email:
+- tony@binarycircus.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bstard.gemspec
+- lib/bstard.rb
+- lib/bstard/errors.rb
+- lib/bstard/fsm.rb
+- lib/bstard/version.rb
+homepage: https://github.com/tonyheadford/bstard
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A Lightweight State Machine
+test_files: []