pretty_state_machine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d85359c4d2c29e4e2a1aa08e0120fc04e71eb542
+  data.tar.gz: 4067a1ff77c21c1a703b5cdc3c0e47c10bcbe5c4
+SHA512:
+  metadata.gz: fb7cda2d6b96642c4929b66d836135d1b52e0693a0465fc6104f13bb109b6392b15b39364a6a4efaaec0342c01c6f7ff95f127d12a508deac0f009f7a9516d66
+  data.tar.gz: 33a6319bbbb9ac550e0b15f27f35e30c52f07164a2995c98da8753de74ef65e8bd624ff1ef39909bf0856e04b85b0f10a728a8493156c06f6d8234a57a99c626

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,36 @@
+[![Build Status](https://travis-ci.org/ags/pretty_state_machine.png?branch=master)](https://travis-ci.org/ags/pretty_state_machine)
+
+Pretty State Machine
+====================
+
+Simple FSM class-oriented DSL. Somewhere between [MicroMachine](https://github.com/soveran/micromachine) and [state_machine](https://github.com/pluginaweek/state_machine/).
+
+Usage
+-----
+
+```ruby
+class Reznor < PrettyStateMachine::Machine
+  state :up_above_it, initial: true
+
+  state :down_in_it
+
+  state :gave_up
+
+  transition :get_down! do
+    from :up_above_it
+    to :down_in_it
+  end
+
+  transition :give_up! do
+    from :up_above_it, :down_in_it
+    to :gave_up
+  end
+end
+
+>> machine = Reznor.new
+>> machine.state.name
+=> :up_above_it
+>> machine.get_down!
+>> machine.state.name
+=> :down_in_it
+```

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require 'rubygems'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/pretty_state_machine.rb

@@ -0,0 +1,9 @@
+require_relative 'pretty_state_machine/machine'
+require_relative 'pretty_state_machine/state'
+require_relative 'pretty_state_machine/transition'
+
+module PrettyStateMachine
+  InvalidMachine = Class.new(Exception)
+  InvalidTransition = Class.new(Exception)
+  InvalidState = Class.new(Exception)
+end

data/lib/pretty_state_machine/machine.rb

@@ -0,0 +1,66 @@
+module PrettyStateMachine
+  class Machine
+
+    attr_reader :state
+
+    def self.states
+      @_states ||= {}
+    end
+
+    def self.transitions
+      @_transitions ||= {}
+    end
+
+    def self.initial_state
+      states.values.find(&:initial?)
+    end
+
+    def self.state(name, options={})
+      initial = options.fetch(:initial) { false }
+      state = State.new(name, initial: initial)
+      states[name] = state
+    end
+
+    def self.transition(name, &block)
+      transition = Transition.new(self, name)
+      transition.instance_eval(&block)
+
+      if transition.to_state.nil?
+        raise InvalidTransition, "transition '#{name}' requires an end state"
+      end
+
+      define_method(name) do
+        if transition.permitted_from?(@state)
+          @state = transition.to_state
+        else
+          raise InvalidTransition, "cannot transition to '#{transition.to_state}' via '#{name}' from '#{@state}'"
+        end
+      end
+
+      transitions[name] = transition
+    end
+
+    def initialize(state=self.class.initial_state)
+      raise InvalidMachine.new('an initial state is required') if state.nil?
+      @state = State(state)
+    end
+
+    protected
+
+    def self.state_from_name(state_name)
+      states.fetch(state_name) do
+        raise InvalidState.new("'#{state_name}' is an invalid state")
+      end
+    end
+
+    def State(arg)
+      case arg
+      when State then arg
+      when Symbol then self.class.state_from_name(arg)
+      else
+        raise TypeError, "cannot convert #{arg.inspect} to State"
+      end
+    end
+
+  end
+end

data/lib/pretty_state_machine/state.rb

@@ -0,0 +1,21 @@
+require 'forwardable'
+
+module PrettyStateMachine
+  class State
+    extend Forwardable
+
+    attr_reader :name
+
+    def_delegator :name, :to_s
+
+    def initialize(name, options={})
+      @name = name
+      @initial = options.fetch(:initial) { false }
+    end
+
+    def initial?
+      @initial
+    end
+
+  end
+end

data/lib/pretty_state_machine/transition.rb

@@ -0,0 +1,26 @@
+module PrettyStateMachine
+  class Transition
+    attr_reader :to_state
+
+    def initialize(machine_class, name)
+      @machine_class = machine_class
+      @name = name
+      @from_states = []
+    end
+
+    def from(*state_names)
+      @from_states = state_names.flatten.compact.map { |state_name|
+        @machine_class.state_from_name(state_name)
+      }
+    end
+
+    def to(state_name)
+      @to_state = @machine_class.state_from_name(state_name)
+    end
+
+    def permitted_from?(state)
+      @from_states.include?(state)
+    end
+  end
+
+end

data/lib/pretty_state_machine/version.rb

@@ -0,0 +1,3 @@
+module PrettyStateMachine
+  VERSION = '0.1.0'
+end

data/spec/lib/pretty_state_machine/machine_spec.rb

@@ -0,0 +1,74 @@
+require './lib/pretty_state_machine'
+
+describe PrettyStateMachine::Machine do
+  class Empty < PrettyStateMachine::Machine; end
+
+  class Reznor < PrettyStateMachine::Machine
+    state :up_above_it, initial: true
+
+    state :down_in_it
+
+    state :gave_up
+
+    transition :get_down! do
+      from :up_above_it
+      to :down_in_it
+    end
+
+    transition :give_up! do
+      from :down_in_it
+      to :gave_up
+    end
+  end
+
+  it "sets state to provided initial state on creation" do
+    expect(Reznor.new.state.name).to eq(:up_above_it)
+  end
+
+  it "initial state can be overriden on initialization" do
+    expect(Reznor.new(:down_in_it).state.name).to eq(:down_in_it)
+  end
+
+  it "raises InvalidMachine without an initial state" do
+    expect do
+      Empty.new
+    end.to raise_error(PrettyStateMachine::InvalidMachine,
+                       'an initial state is required')
+  end
+
+  it "defines transition methods that change state" do
+    machine = Reznor.new
+    expect do
+      machine.get_down!
+    end.to change { machine.state.name }.from(:up_above_it).to(:down_in_it)
+  end
+
+  it "does not allow definition of transitions without a to" do
+    expect do
+      class NoTransitionTo < PrettyStateMachine::Machine
+        state :foo, initial: true
+        transition :bar do from :foo end
+      end
+    end.to raise_error(PrettyStateMachine::InvalidTransition,
+                       "transition 'bar' requires an end state")
+  end
+
+  it "enforces transition from declarations" do
+    machine = Reznor.new
+    expect do
+      machine.give_up!
+    end.to raise_error(PrettyStateMachine::InvalidTransition,
+                       "cannot transition to 'gave_up' via 'give_up!' from 'up_above_it'")
+    expect(machine.state.name).to eq(:up_above_it)
+  end
+
+  context "when given an invalid initial state" do
+    it "raises PrettyStateMachine::InvalidState" do
+      expect do
+        Reznor.new(:foobar)
+      end.to raise_error(PrettyStateMachine::InvalidState,
+                         "'foobar' is an invalid state")
+    end
+  end
+
+end

data/spec/lib/pretty_state_machine/state_spec.rb

@@ -0,0 +1,22 @@
+require './lib/pretty_state_machine'
+
+describe PrettyStateMachine::State do
+  describe "#initial?" do
+    it "is false by default" do
+      state = PrettyStateMachine::State.new(:foobar)
+      expect(PrettyStateMachine::State.new(:foobar).initial?).to be_false
+    end
+
+    it "is true when state is created with 'initial' parameter" do
+      state = PrettyStateMachine::State.new(:foobar, initial: true)
+      expect(state.initial?).to be_true
+    end
+  end
+
+  describe "#to_s" do
+    it "returns the state name" do
+      state = PrettyStateMachine::State.new(:foobar, initial: true)
+      expect(state.to_s).to eq('foobar')
+    end
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: pretty_state_machine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-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.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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Simple DSL for state machine classes
+email:
+- alex@thatalexguy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pretty_state_machine/machine.rb
+- lib/pretty_state_machine/state.rb
+- lib/pretty_state_machine/transition.rb
+- lib/pretty_state_machine/version.rb
+- lib/pretty_state_machine.rb
+- MIT-LICENSE
+- Rakefile
+- README.md
+- spec/lib/pretty_state_machine/machine_spec.rb
+- spec/lib/pretty_state_machine/state_spec.rb
+homepage: https://github.com/ags/pretty_state_machine
+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: Simple DSL for state machine classes
+test_files:
+- spec/lib/pretty_state_machine/machine_spec.rb
+- spec/lib/pretty_state_machine/state_spec.rb