stately 0.2.0 → 0.3.0

data/.gitignore

@@ -9,3 +9,5 @@ test/dummy/db/*.sqlite3
 test/dummy/log/*.log
 test/dummy/tmp/
 test/dummy/.sass-cache
+.ruby-version
+.ruby-gemset

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+branches:
+  only:
+    - master
+script:
+  - bundle exec rake spec

data/Gemfile

@@ -1,3 +1,5 @@
 source 'http://rubygems.org'
 
+gem 'rake'
+
 gemspec

data/Gemfile.lock

@@ -1,12 +1,16 @@
 PATH
   remote: .
   specs:
-    stately (0.2.0)
+    stately (0.3.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.3)
+    json (1.8.0)
+    rake (10.0.4)
+    rdoc (4.0.1)
+      json (~> 1.4)
     redcarpet (2.2.2)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
@@ -22,6 +26,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  rake
+  rdoc (= 4.0.1)
   redcarpet (~> 2.2.2)
   rspec (~> 2.0)
   stately!

data/README.md

@@ -1,5 +1,7 @@
 # Stately
 
+[![Build Status](https://api.travis-ci.org/rtwomey/stately.png)](https://travis-ci.org/rtwomey/stately)
+
 A minimal, elegant state machine for your ruby objects.
 
 ![A stately fellow.](https://dl.dropbox.com/u/2754528/exquisite_cat.jpg "A stately fellow.")
@@ -10,12 +12,12 @@ Stately is a state machine for ruby objects, with an elegant, easy-to-read DSL.
 
 ```ruby
 class Order
-  stately start: :processing do
+  stately :start => :processing do
     state :completed do
       prevent_from :refunded
 
-      before_transition from: :processing, do: :calculate_total
-      after_transition do: :email_receipt
+      before_transition :from => :processing, :do => :calculate_total
+      after_transition :do => :email_receipt
 
       validate :validates_credit_card
     end
@@ -27,7 +29,7 @@ class Order
     state :refunded do
       allow_from :completed
 
-      after_transition do: :email_receipt
+      after_transition :do => :email_receipt
     end
   end
 end
@@ -71,12 +73,12 @@ Be sure to run `bundle install` afterwards.
 The first step is to add the following to your object:
 
 ```ruby
-stately start: :initial_state, attr: :my_state_attr do
+stately :start => :initial_state, :attr => :my_state_attr do
   # ...
 end
 ```
 
-This sets up Stately to look for an attribute named `my_state_attr`, and initially set it to `initial_state`. If you omit `attr: :my_state_attr`, Stately will automatically look for an attribute named `state`.
+This sets up Stately to look for an attribute named `my_state_attr`, and initially set it to `initial_state`. If you omit `:attr => :my_state_attr`, Stately will automatically look for an attribute named `state`.
 
 ## Defining a state
 
@@ -84,8 +86,8 @@ States make up the core of Stately and define two things: the name of the state
 
 ```ruby
 class Order
-  stately start: :processing do
-    state :my_state, action: transition_to_my_state
+  stately :start => :processing do
+    state :my_state, :action => transition_to_my_state
   end
 end
 
@@ -127,13 +129,13 @@ If you're using Stately with some kind of persistence layer, sych as activerecor
 
 ```ruby
 class Order
-  stately start: :processing do
+  stately :start => :processing do
     # ...
 
     state :completed do
-      before_transition from: :processing, do: :before_completed
-      before_transition from: :invalid, do: :cleanup_invalid
-      after_transition do: :after_completed
+      before_transition :from => :processing, :do => :before_completed
+      before_transition :from => :invalid, :do => :cleanup_invalid
+      after_transition :do => :after_completed
     end
   end
 
@@ -155,9 +157,9 @@ Let's say you are modeling a Bicycle object for your rental shop and you're usin
 
 ```ruby
 class Bicycle < ActiveRecord::Base
-  stately start: :available do
-    state :rented, action: :rent do
-      after_transition do: :save
+  stately :start => :available do
+    state :rented, :action => :rent do
+      after_transition :do => :save
     end
   end
 end
@@ -169,8 +171,8 @@ As you can see, Stately is slightly more verbose than other state machine gems,
 
 ## Requirements
 
-Stately requires Ruby 1.9. If you'd like to contribute to Stately, you'll need Rspec 2.0+.
+Stately requires Ruby 1.8.7 or newer. If you'd like to contribute to Stately, you'll need Rspec 2.0+.
 
 ## License
 
-Stately is Copyright © 2012 Ryan Twomey. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Stately is Copyright © 2013 Ryan Twomey. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.

data/lib/stately/state.rb

@@ -51,12 +51,12 @@ module Stately
 
     private
 
-    ACTIONS = { completed: :complete, converting: :convert, invalid: :invalidate,
-      preparing: :prepare, processing: :process, refunded: :refund, reticulating: :reticulate,
-      saving: :save, searching: :search, started: :start, stopped: :stop }
+    ACTIONS = { :completed => :complete, :converting => :convert, :invalid => :invalidate,
+      :preparing => :prepare, :processing => :process, :refunded => :refund, :reticulating => :reticulate,
+      :saving => :save, :searching => :search, :started => :start, :stopped => :stop }
 
     def guess_action_for(name)
-      ACTIONS[name.to_sym]
+      ACTIONS.fetch(name.to_sym, name)
     end
 
     class StateConfigurator

data/lib/stately/version.rb

@@ -1,3 +1,3 @@
 module Stately
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/spec/functional/stately_spec.rb

@@ -4,13 +4,13 @@ require 'spec_helper'
 describe Stately do
   before do
     @order_class = Class.new(OpenStruct) do
-      stately start: :processing do
+      stately :start => :processing do
         state :completed do
           prevent_from :refunded
 
-          before_transition from: :processing, do: :before_completed
-          before_transition from: :invalid, do: :cleanup_invalid
-          after_transition do: :after_completed
+          before_transition :from => :processing, :do => :before_completed
+          before_transition :from => :invalid, :do => :cleanup_invalid
+          after_transition :do => :after_completed
 
           validate :validates_amount
           validate :validates_credit_card
@@ -27,8 +27,8 @@ describe Stately do
         state :refunded do
           allow_from :completed
 
-          before_transition from: :completed, do: :before_refunded
-          after_transition from: :completed, do: :after_refunded
+          before_transition :from => :completed, :do => :before_refunded
+          after_transition :from => :completed, :do => :after_refunded
         end
       end
 
@@ -115,7 +115,7 @@ describe Stately do
 
   def self.should_prevent_transition(from, to, action)
     before do
-      @order = @order_class.new(amount: 99, cc_number: 123)
+      @order = @order_class.new(:amount => 99, :cc_number => 123)
       @order.state = from
     end
 
@@ -141,7 +141,7 @@ describe Stately do
 
   describe 'initial state' do
     before do
-      @order = @order_class.new(amount: 99, cc_number: 123)
+      @order = @order_class.new(:amount => 99, :cc_number => 123)
     end
 
     it 'creates actions for each state' do
@@ -179,7 +179,7 @@ describe Stately do
 
   describe '#complete' do
     before do
-      @order = @order_class.new(amount: 99, cc_number: 123)
+      @order = @order_class.new(:amount => 99, :cc_number => 123)
     end
 
     describe 'from processing' do
@@ -243,7 +243,7 @@ describe Stately do
   describe '#invalidate' do
     describe 'from processing' do
       before do
-        @order = @order_class.new(amount: 99, cc_number: 123)
+        @order = @order_class.new(:amount => 99, :cc_number => 123)
         @order.invalidate
       end
 
@@ -272,7 +272,7 @@ describe Stately do
 
     describe 'from completed' do
       before do
-        @order = @order_class.new(amount: 99, cc_number: 123)
+        @order = @order_class.new(:amount => 99, :cc_number => 123)
         @order.state = 'completed'
       end
 

data/spec/unit/stately/machine_spec.rb

@@ -43,7 +43,7 @@ describe Stately::Machine do
     describe 'with name and action' do
       describe 'of a new state' do
         before do
-          @machine.state(:new_state, action: :transition_to_new_state)
+          @machine.state(:new_state, :action =>  :transition_to_new_state)
         end
 
         it 'adds a new state' do
@@ -57,7 +57,7 @@ describe Stately::Machine do
 
       describe 'of a previously defined state' do
         before do
-          @machine.state(:processing, action: :transition_to_processing)
+          @machine.state(:processing, :action =>  :transition_to_processing)
         end
 
         it "doesn't add a new state" do
@@ -73,7 +73,7 @@ describe Stately::Machine do
     describe 'with name, action, and block' do
       describe 'of a new state' do
         before do
-          @machine.state(:new_state, action: :transition_to_new_state) do
+          @machine.state(:new_state, :action =>  :transition_to_new_state) do
             allow_from :completed
           end
 
@@ -95,7 +95,7 @@ describe Stately::Machine do
 
       describe 'of a previously defined state' do
         before do
-          @machine.state(:processing, action: :transition_to_processing) do
+          @machine.state(:processing, :action =>  :transition_to_processing) do
             allow_from :completed
           end
 

data/spec/unit/stately/state_spec.rb

@@ -2,6 +2,13 @@ require 'spec_helper'
 
 describe Stately::State do
   describe 'initialize' do
+    describe 'with an unrecognized action' do
+      it 'should not have an empty string for an action' do
+        state = Stately::State.new :pending
+        state.action.should == 'pending'
+      end
+    end
+
     describe 'with a block given' do
       describe 'new' do
         before do
@@ -9,10 +16,10 @@ describe Stately::State do
             allow_from :completed
             prevent_from :completed, :refunded
 
-            before_transition do: :prepare
-            before_transition from: :processing, do: :before_completed
-            after_transition do: :cleanup
-            after_transition from: :processing, do: :after_processing
+            before_transition :do => :prepare
+            before_transition :from => :processing, :do => :before_completed
+            after_transition :do => :cleanup
+            after_transition :from => :processing, :do => :after_processing
 
             validate :validates_amount
             validate :validates_credit_card
@@ -25,10 +32,10 @@ describe Stately::State do
           @state.allow_from_states.should == [:completed]
           @state.prevent_from_states.should == [:completed, :refunded]
 
-          @state.before_transitions.should == [{do: :prepare}, {from: :processing,
-            do: :before_completed}]
-          @state.after_transitions.should == [{do: :cleanup}, {from: :processing,
-            do: :after_processing}]
+          @state.before_transitions.should == [{:do => :prepare}, {:from => :processing,
+            :do => :before_completed}]
+          @state.after_transitions.should == [{:do => :cleanup}, {:from => :processing,
+            :do => :after_processing}]
           @state.validations.should == [:validates_amount, :validates_credit_card]
         end
       end
@@ -64,9 +71,9 @@ describe Stately::State do
 
       describe 'without a given action' do
         before do
-          @actions = { completed: :complete, converting: :convert, invalid: :invalidate,
-            preparing: :prepare, processing: :process, refunded: :refund, reticulating: :reticulate,
-            saving: :save, searching: :search, started: :start, stopped: :stop }
+          @actions = { :completed => :complete, :converting => :convert, :invalid => :invalidate,
+            :preparing => :prepare, :processing => :process, :refunded => :refund, :reticulating => :reticulate,
+            :saving => :save, :searching => :search, :started => :start, :stopped => :stop }
         end
 
         it 'should set the correct action verb' do

data/spec/unit/stately_spec.rb

@@ -6,7 +6,7 @@ describe Stately::InstanceMethods do
     @test_class = Class.new(Object) do
       attr_accessor :state
 
-      stately start: :processing do
+      stately :start => :processing do
         state :completed
       end
     end

data/stately.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'http://github.com/rtwomey/stately'
   s.summary     = 'A simple, elegant state machine for Ruby'
   s.description = 'Add an elegant state machine to your ruby objects with a simple DSL'
+  s.license     = 'MIT'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {spec}/*`.split("\n")
@@ -16,7 +17,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'redcarpet', '~> 2.2.2'
   s.add_development_dependency 'rspec', '~> 2.0'
   s.add_development_dependency 'yard', '~> 0.8.3'
+  s.add_development_dependency 'rdoc', '4.0.1'
 
-  s.required_ruby_version = Gem::Requirement.new('>= 1.9.2')
+  s.required_ruby_version = Gem::Requirement.new('>= 1.8.7')
   s.require_paths = ['lib']
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stately
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-21 00:00:00.000000000 Z
+date: 2013-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redcarpet
@@ -59,6 +59,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.0.1
 description: Add an elegant state machine to your ruby objects with a simple DSL
 email:
 - rtwomey@gmail.com
@@ -68,6 +84,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - .yardopts
 - Gemfile
 - Gemfile.lock
@@ -87,7 +104,8 @@ files:
 - spec/unit/stately_spec.rb
 - stately.gemspec
 homepage: http://github.com/rtwomey/stately
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -97,16 +115,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -4046456697569839142
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A simple, elegant state machine for Ruby