statesman 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7705af0277715fcc157ab5d750e870c03ff589fb
-  data.tar.gz: e05d77943df6c572a9ea9d45b59f94f2c758cb6c
+  metadata.gz: b92fb09eece2e17c27b82fcca631fe7104352d64
+  data.tar.gz: 5d998f484ea553dfc739090859711185f6d2b79d
 SHA512:
-  metadata.gz: ed5f485322fd9c0a906d0a010812e72a704db3669bc915c2aba8b942f6a9f98ff8145907adc5ab023440b997b0f9fdf9758aa7e0e67568afc391df505b7c7476
-  data.tar.gz: bd202c6eafdbb989545e5b0f361a9713ef95fe78bb3b7454856a20e266fdd1f5a1b5242d1cc593123bf310aac202be47ccbef4f624c9d12a5dc59129dc6f1649
+  metadata.gz: c7d61e91e81cab512c7535ff42dc04428554c99db767d7efd43817119fe8387d385d005602b4bd69d10fe1f98c8e037e02ba3bd276aa0f0527a379ce3b3f8b06
+  data.tar.gz: 790bb168d54c53c16bf86290614ad78963484d1577a17f3d03e945a69dc87d1e61f4dea5b3e3be51014c5c6ff091d108ad52f331eba61bc1d76a3d572119ec23

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+.rspec
 .yardoc
 Gemfile.lock
 InstalledFiles

data/.rubocop.yml

@@ -27,3 +27,6 @@ MethodLength:
 # Don't require utf-8 encoding comment
 Encoding:
   Enabled: false
+
+LineLength:
+  Max: 80

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v0.6.0, 19 May 2014
+*Additions*
+- Generators now handle namespaced classes (patch by [@hrmrebecca](https://github.com/hrmrebecca))
+
+*Changes*
+- `Machine#transition_to` now only swallows Statesman generated errors. An exception in your guard or callback will no longer be caught by Statesman (patch by [@paulspringett](https://github.com/paulspringett))
+
 ## v0.5.0, 27 March 2014
 *Additions*
 - Scope methods. Adds a module which can be mixed in to an ActiveRecord model to provide `.in_state` and `.not_in_state` query scopes.

data/README.md

@@ -63,7 +63,7 @@ class Order < ActiveRecord::Base
 
   private
 
-  def transition_class
+  def self.transition_class
     OrderTransition
   end
 end
@@ -231,7 +231,8 @@ Transition to the passed state, returning `true` on success. Raises
 
 #### `Machine#transition_to(:state)`
 Transition to the passed state, returning `true` on success. Swallows all
-exceptions and returns false on failure.
+Statesman exceptions and returns false on failure. (NB. if your guard or
+callback code throws an exception, it will not be caught.)
 
 ## Model scopes
 
@@ -245,7 +246,7 @@ class Order < ActiveRecord::Base
   
   private
 
-  def transition_class
+  def self.transition_class
     OrderTransition
   end
 end

data/lib/generators/statesman/active_record_transition_generator.rb

@@ -1,12 +1,15 @@
 require "rails/generators"
+require "generators/statesman/generator_helpers"
 
 module Statesman
   class ActiveRecordTransitionGenerator < Rails::Generators::Base
+    include Statesman::GeneratorHelpers
+
     desc "Create an ActiveRecord-based transition model"\
          "with the required attributes"
 
     argument :parent, type: :string, desc: "Your parent model name"
-    argument :klass, type: :string, desc: "Your transition model name"
+    argument :klass,  type: :string, desc: "Your transition model name"
 
     source_root File.expand_path('../templates', __FILE__)
 
@@ -17,26 +20,10 @@ module Statesman
 
     private
 
-    def next_migration_number
-      Time.now.utc.strftime("%Y%m%d%H%M%S")
-    end
-
     def migration_file_name
       "db/migrate/#{next_migration_number}_create_#{table_name}.rb"
     end
 
-    def model_file_name
-      "app/models/#{klass.underscore}.rb"
-    end
-
-    def table_name
-      klass.underscore.pluralize
-    end
-
-    def parent_id
-      parent.underscore + "_id"
-    end
-
     def rails_4?
       Rails.version.split(".").map(&:to_i).first >= 4
     end

data/lib/generators/statesman/generator_helpers.rb

@@ -0,0 +1,31 @@
+module Statesman
+  module GeneratorHelpers
+    def class_name_option
+      ", class_name: '#{parent}'" unless parent.underscore == parent_name
+    end
+
+    def model_file_name
+      "app/models/#{klass.underscore}.rb"
+    end
+
+    def migration_class_name
+      klass.gsub(/::/, '').pluralize
+    end
+
+    def next_migration_number
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    end
+
+    def parent_name
+      parent.demodulize.underscore
+    end
+
+    def parent_id
+      parent_name + "_id"
+    end
+
+    def table_name
+      klass.demodulize.underscore.pluralize
+    end
+  end
+end

data/lib/generators/statesman/migration_generator.rb

@@ -1,8 +1,11 @@
 require "rails/generators"
+require "generators/statesman/generator_helpers"
 
 # Add statesman attributes to a pre-existing transition class
 module Statesman
   class MigrationGenerator < Rails::Generators::Base
+    include Statesman::GeneratorHelpers
+
     desc "Add the required Statesman attributes to your transition model"
 
     argument :parent, type: :string, desc: "Your parent model name"
@@ -16,20 +19,8 @@ module Statesman
 
     private
 
-    def next_migration_number
-      Time.now.utc.strftime("%Y%m%d%H%M%S")
-    end
-
     def file_name
       "db/migrate/#{next_migration_number}_add_statesman_to_#{table_name}.rb"
     end
-
-    def table_name
-      klass.underscore.pluralize
-    end
-
-    def parent_id
-      parent.underscore + "_id"
-    end
   end
 end

data/lib/generators/statesman/mongoid_transition_generator.rb

@@ -1,7 +1,10 @@
 require "rails/generators"
+require "generators/statesman/generator_helpers"
 
 module Statesman
   class MongoidTransitionGenerator < Rails::Generators::Base
+    include Statesman::GeneratorHelpers
+
     desc "Create a Mongoid-based transition model with the required attributes"
 
     argument :parent, type: :string, desc: "Your parent model name"
@@ -15,16 +18,8 @@ module Statesman
 
     private
 
-    def model_file_name
-      "app/models/#{klass.underscore}.rb"
-    end
-
     def collection_name
       klass.underscore.pluralize
     end
-
-    def parent_id
-      parent.underscore + "_id"
-    end
   end
 end

data/lib/generators/statesman/templates/active_record_transition_model.rb.erb

@@ -4,5 +4,5 @@ class <%= klass %> < ActiveRecord::Base
   <% unless rails_4? %>
   attr_accessible :to_state, :metadata, :sort_key
   <% end %>
-  belongs_to :<%= parent.underscore %>, inverse_of: :<%= table_name %>
+  belongs_to :<%= parent_name %><%= class_name_option %>, inverse_of: :<%= table_name %>
 end

data/lib/generators/statesman/templates/create_migration.rb.erb

@@ -1,10 +1,11 @@
-class Create<%= klass.pluralize %> < ActiveRecord::Migration
+class Create<%= migration_class_name %> < ActiveRecord::Migration
   def change
     create_table :<%= table_name %> do |t|
       t.string :to_state
       t.text :metadata, default: "{}"
       t.integer :sort_key
       t.integer :<%= parent_id %>
+      t.timestamps
     end
 
     add_index :<%= table_name %>, :<%= parent_id %>

data/lib/generators/statesman/templates/mongoid_transition_model.rb.erb

@@ -1,5 +1,6 @@
 class <%= klass %>
   include Mongoid::Document
+  include Mongoid::Timestamps
   include Statesman::Adapters::MongoidTransition
 
   field :to_state, type: String
@@ -8,6 +9,6 @@ class <%= klass %>
 
   index({ sort_key: 1 })
 
-  belongs_to :<%= parent.underscore %>, index: true
+  belongs_to :<%= parent %><%= class_name_option %>, index: true
 
 end

data/lib/generators/statesman/templates/update_migration.rb.erb

@@ -1,9 +1,11 @@
-class AddStatesmanTo<%= klass.pluralize %> < ActiveRecord::Migration
+class AddStatesmanTo<%= migration_class_name %> < ActiveRecord::Migration
   def change
     add_column :<%= table_name %>, :to_state, :string
     add_column :<%= table_name %>, :metadata, :text, default: "{}"
     add_column :<%= table_name %>, :sort_key, :integer
     add_column :<%= table_name %>, :<%= parent_id %>, :integer
+    add_column :<%= table_name %>, :created_at, :datetime
+    add_column :<%= table_name %>, :updated_at, :datetime
 
     add_index :<%= table_name %>, :<%= parent_id %>
     add_index :<%= table_name %>, [:sort_key, :<%= parent_id %>], unique: true

data/lib/statesman/adapters/active_record.rb

@@ -33,11 +33,15 @@ module Statesman
       end
 
       def history
-        transitions_for_parent.order(:sort_key)
+        if transitions_for_parent.loaded?
+          transitions_for_parent.sort_by(&:sort_key)
+        else
+          transitions_for_parent.order(:sort_key)
+        end
       end
 
       def last
-        @last_transition ||= transitions_for_parent.order(:sort_key).last
+        @last_transition ||= history.last
       end
 
       private

data/lib/statesman/adapters/active_record_model.rb

@@ -9,14 +9,14 @@ module Statesman
         def in_state(*states)
           joins(transition_name)
             .joins(transition_join)
-            .where("#{transition_name}.to_state" => states)
+            .where("#{transition_name}.to_state" => states.map(&:to_s))
             .where("transition2.id" => nil)
         end
 
         def not_in_state(*states)
           joins(transition_name)
             .joins(transition_join)
-            .where("#{transition_name}.to_state NOT IN (?)", states)
+            .where("#{transition_name}.to_state NOT IN (?)", states.map(&:to_s))
             .where("transition2.id" => nil)
         end
 

data/lib/statesman/adapters/memory_transition.rb

@@ -2,12 +2,14 @@ module Statesman
   module Adapters
     class MemoryTransition
       attr_accessor :created_at
+      attr_accessor :updated_at
       attr_accessor :to_state
       attr_accessor :sort_key
       attr_accessor :metadata
 
       def initialize(to, sort_key, metadata = nil)
         @created_at = Time.now
+        @updated_at = Time.now
         @to_state = to
         @sort_key = sort_key
         @metadata = metadata

data/lib/statesman/machine.rb

@@ -196,7 +196,7 @@ module Statesman
 
     def transition_to(new_state, metadata = nil)
       self.transition_to!(new_state, metadata)
-    rescue
+    rescue TransitionFailedError, GuardFailedError
       false
     end
 
@@ -224,16 +224,16 @@ module Statesman
       from = to_s_or_nil(options[:from])
       to   = to_s_or_nil(options[:to])
 
-      # Call all guards, they raise exceptions if they fail
-      guards_for(from: from, to: to).each do |guard|
-        guard.call(@object, last_transition, options[:metadata])
-      end
-
       successors = self.class.successors[from] || []
       unless successors.include?(to)
         raise TransitionFailedError,
               "Cannot transition from '#{from}' to '#{to}'"
       end
+
+      # Call all guards, they raise exceptions if they fail
+      guards_for(from: from, to: to).each do |guard|
+        guard.call(@object, last_transition, options[:metadata])
+      end
     end
 
     def to_s_or_nil(input)

data/lib/statesman/version.rb

@@ -1,3 +1,3 @@
 module Statesman
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/spec/generators/statesman/active_record_transition_generator_spec.rb

@@ -0,0 +1,28 @@
+require "spec_helper"
+require "support/generators_shared_examples"
+require "generators/statesman/active_record_transition_generator"
+
+describe Statesman::ActiveRecordTransitionGenerator, type: :generator do
+
+  it_behaves_like "a generator" do
+    let(:migration_name) { 'db/migrate/create_bacon_transitions.rb' }
+  end
+
+  describe 'properly adds class names' do
+    before { run_generator %w[Yummy::Bacon Yummy::BaconTransition] }
+    subject { file('app/models/yummy/bacon_transition.rb') }
+
+    it { should contain(/:bacon_transition/) }
+    it { should_not contain(/:yummy\/bacon/) }
+    it { should contain(/class_name: 'Yummy::Bacon'/) }
+  end
+
+  describe 'properly formats without class names' do
+    before { run_generator %w[Bacon BaconTransition] }
+    subject { file('app/models/bacon_transition.rb') }
+
+    it { should_not contain(/class_name:/) }
+    it { should contain(/class BaconTransition/) }
+  end
+
+end

data/spec/generators/statesman/migration_generator_spec.rb

@@ -0,0 +1,32 @@
+require "spec_helper"
+require "support/generators_shared_examples"
+require "generators/statesman/migration_generator"
+
+describe Statesman::MigrationGenerator, type: :generator do
+
+  it_behaves_like "a generator" do
+    let(:migration_name) { 'db/migrate/add_statesman_to_bacon_transitions.rb' }
+  end
+
+  describe 'the model contains the correct words' do
+    let(:migration_number) { '5678309' }
+
+    let(:mock_time) do
+      double('Time', utc: double('UTCTime', strftime: migration_number))
+    end
+
+    subject do
+      file(
+        "db/migrate/#{migration_number}_add_statesman_to_bacon_transitions.rb"
+      )
+    end
+
+    before do
+      Time.stub(:now).and_return(mock_time)
+      run_generator %w[Yummy::Bacon Yummy::BaconTransition]
+    end
+
+    it { should contain(/:bacon_transition/) }
+    it { should_not contain(/:yummy\/bacon/) }
+  end
+end

data/spec/generators/statesman/mongoid_transition_generator_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+require "support/generators_shared_examples"
+require "generators/statesman/mongoid_transition_generator"
+
+describe Statesman::MongoidTransitionGenerator, type: :generator do
+
+  describe 'the model contains the correct words' do
+    before { run_generator %w[Yummy::Bacon Yummy::BaconTransition] }
+    subject { file('app/models/yummy/bacon_transition.rb') }
+
+    it { should_not contain(/:yummy\/bacon/) }
+    it { should contain(/class_name: 'Yummy::Bacon'/) }
+  end
+
+  describe 'the model contains the correct words' do
+    before { run_generator %w[Bacon BaconTransition] }
+    subject { file('app/models/bacon_transition.rb') }
+
+    it { should_not contain(/class_name:/) }
+    it { should_not contain(/CreateYummy::Bacon/) }
+  end
+
+end

data/spec/statesman/adapters/active_record_spec.rb

@@ -35,9 +35,12 @@ describe Statesman::Adapters::ActiveRecord do
       described_class.new(MyActiveRecordModelTransition, model, observer)
     end
 
+    before do
+      adapter.create(:x, :y)
+    end
+
     context "with a previously looked up transition" do
       before do
-        adapter.create(:x, :y)
         adapter.last
       end
 
@@ -54,5 +57,17 @@ describe Statesman::Adapters::ActiveRecord do
         end
       end
     end
+
+    context "with a pre-fetched transition history" do
+      before do
+        # inspect the transitions to coerce a [pre-]load
+        model.my_active_record_model_transitions.inspect
+      end
+
+      it "doesn't query the database" do
+        MyActiveRecordModelTransition.should_not_receive(:connection)
+        expect(adapter.last.to_state).to eq("y")
+      end
+    end
   end
 end

data/spec/statesman/machine_spec.rb

@@ -295,7 +295,9 @@ describe Statesman::Machine do
       machine.class_eval do
         state :x, initial: true
         state :y
+        state :z
         transition from: :x, to: :y
+        transition from: :y, to: :z
       end
     end
 
@@ -313,6 +315,17 @@ describe Statesman::Machine do
         let(:new_state) { :y }
         it { should be_false }
       end
+
+      context "and is guarded" do
+        let(:guard_cb) { -> { false } }
+        let(:new_state) { :z }
+        before { machine.guard_transition(to: new_state, &guard_cb) }
+
+        it "does not fire guard" do
+          guard_cb.should_not_receive(:call)
+          should be_false
+        end
+      end
     end
 
     context "when the transition valid" do
@@ -427,6 +440,21 @@ describe Statesman::Machine do
       end
       it { should be_false }
     end
+
+    context "when a non statesman exception is raised" do
+      before do
+        instance.stub(:transition_to!).and_raise(RuntimeError,
+                                                 'user defined exception')
+      end
+
+      it "should not rescue the exception" do
+        expectation = expect do
+          instance.transition_to(:some_state, metadata)
+        end
+
+        expectation.to raise_error(RuntimeError, 'user defined exception')
+      end
+    end
   end
 
   shared_examples "a callback filter" do |definer, phase|

data/spec/statesman/transition_spec.rb

@@ -9,6 +9,7 @@ describe Statesman::Adapters::MemoryTransition do
 
     specify { expect(create.to_state).to equal(to) }
     specify { expect(create.created_at).to be_a(Time) }
+    specify { expect(create.updated_at).to be_a(Time) }
     specify { expect(create.sort_key).to be(sort_key) }
 
     context "with metadata passed" do

data/spec/support/generators_shared_examples.rb

@@ -0,0 +1,33 @@
+require "rails/version"
+require "ammeter/init"
+
+TMP_GENERATOR_PATH = File.expand_path('../generator-tmp', __FILE__)
+
+shared_examples 'a generator' do
+  destination TMP_GENERATOR_PATH
+  before { prepare_destination }
+  let(:gen) { generator %w[Yummy::Bacon Yummy::BaconTransition] }
+
+  it 'invokes create_model_file method' do
+    expect(gen).to receive(:create_model_file)
+    capture(:stdout) { gen.invoke_all }
+  end
+
+  describe 'it runs the generator and check things out' do
+
+    before { run_generator %w[Yummy::Bacon Yummy::BaconTransition] }
+
+    describe 'it generates a correctly named file' do
+      subject { file(migration_name) }
+      it { should be_a_migration }
+    end
+
+  end
+
+end
+
+RSpec.configure do |config|
+  config.after :all do
+    FileUtils.rm_rf(TMP_GENERATOR_PATH)
+  end
+end

data/statesman.gemspec

@@ -18,13 +18,14 @@ Gem::Specification.new do |spec|
   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 "bundler",       "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 2.14.1"
-  spec.add_development_dependency "guard-rspec", "~> 3.0.2"
-  spec.add_development_dependency "rubocop", "~> 0.18.1"
+  spec.add_development_dependency "rspec",         "~> 2.14.1"
+  spec.add_development_dependency "guard-rspec",   "~> 3.0.2"
+  spec.add_development_dependency "rubocop",       "~> 0.18.1"
   spec.add_development_dependency "guard-rubocop", "~> 0.2.2"
-  spec.add_development_dependency "activerecord", "~> 3.2"
-  spec.add_development_dependency "sqlite3", "~> 1.3.8"
-  spec.add_development_dependency "mongoid", "~> 3.1.5"
+  spec.add_development_dependency "sqlite3",       "~> 1.3.8"
+  spec.add_development_dependency "mongoid",       "~> 3.1.5"
+  spec.add_development_dependency "rails",         "~> 3.2"
+  spec.add_development_dependency "ammeter",       "~> 1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Harry Marr
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -96,47 +96,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.2.2
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 1.3.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 1.3.8
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: mongoid
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.8
+        version: 3.1.5
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.3.8
+        version: 3.1.5
 - !ruby/object:Gem::Dependency
-  name: mongoid
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.5
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.1.5
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: A statesmanlike state machine library
 email:
 - developers@gocardless.com
@@ -155,6 +169,7 @@ files:
 - Rakefile
 - circle.yml
 - lib/generators/statesman/active_record_transition_generator.rb
+- lib/generators/statesman/generator_helpers.rb
 - lib/generators/statesman/migration_generator.rb
 - lib/generators/statesman/mongoid_transition_generator.rb
 - lib/generators/statesman/templates/active_record_transition_model.rb.erb
@@ -175,6 +190,9 @@ files:
 - lib/statesman/guard.rb
 - lib/statesman/machine.rb
 - lib/statesman/version.rb
+- spec/generators/statesman/active_record_transition_generator_spec.rb
+- spec/generators/statesman/migration_generator_spec.rb
+- spec/generators/statesman/mongoid_transition_generator_spec.rb
 - spec/spec_helper.rb
 - spec/statesman/adapters/active_record_model_spec.rb
 - spec/statesman/adapters/active_record_spec.rb
@@ -188,6 +206,7 @@ files:
 - spec/statesman/machine_spec.rb
 - spec/statesman/transition_spec.rb
 - spec/support/active_record.rb
+- spec/support/generators_shared_examples.rb
 - spec/support/mongoid.rb
 - statesman.gemspec
 homepage: https://github.com/gocardless/statesman
@@ -210,11 +229,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A statesmanlike state machine library
 test_files:
+- spec/generators/statesman/active_record_transition_generator_spec.rb
+- spec/generators/statesman/migration_generator_spec.rb
+- spec/generators/statesman/mongoid_transition_generator_spec.rb
 - spec/spec_helper.rb
 - spec/statesman/adapters/active_record_model_spec.rb
 - spec/statesman/adapters/active_record_spec.rb
@@ -228,4 +250,5 @@ test_files:
 - spec/statesman/machine_spec.rb
 - spec/statesman/transition_spec.rb
 - spec/support/active_record.rb
+- spec/support/generators_shared_examples.rb
 - spec/support/mongoid.rb