statesman 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7c29dcf767aa7177b818dafdc99e8645dddfcc8
-  data.tar.gz: 1d4db155c8fb031a4e58dafa44febca452110dcd
+  metadata.gz: 7705af0277715fcc157ab5d750e870c03ff589fb
+  data.tar.gz: e05d77943df6c572a9ea9d45b59f94f2c758cb6c
 SHA512:
-  metadata.gz: 1aff94dc8f2c327b232c93123fa781a5f583f4b9fa08b39df79d8dd93c8600992ca67e05b277531fb58da92014eb5c1240a9d622cff3195a84266624bef7e4ef
-  data.tar.gz: 6882412cf48ed98015601b22a26c4d038405d1b9208a723d0fdeeddb875629e47fb267ba97ceac712bbac5572d6c3f647188047e6f17532a528baa2c6b9897ab
+  metadata.gz: ed5f485322fd9c0a906d0a010812e72a704db3669bc915c2aba8b942f6a9f98ff8145907adc5ab023440b997b0f9fdf9758aa7e0e67568afc391df505b7c7476
+  data.tar.gz: bd202c6eafdbb989545e5b0f361a9713ef95fe78bb3b7454856a20e266fdd1f5a1b5242d1cc593123bf310aac202be47ccbef4f624c9d12a5dc59129dc6f1649

data/.rubocop.yml

@@ -10,6 +10,9 @@ AllCops:
 StringLiterals:
   Enabled: false
 
+LineEndConcatenation:
+  Enabled: false
+
 Documentation:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 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.
+- Adds `Machine#after_initialize` hook (patch by [@att14](https://github.com/att14))
+
+*Fixes*
+- Added MongoidTransition to the autoload statements, fixing [#29](https://github.com/gocardless/statesman/issues/29) (patch by [@tomclose](https://github.com/tomclose))
+
 ## v0.4.0, 27 February 2014
 *Additions*
 - Adds after_commit flag to after_transition for callbacks to be executed after the transaction has been

data/README.md

@@ -53,11 +53,19 @@ class OrderStateMachine
 end
 
 class Order < ActiveRecord::Base
+  include Statesman::Adapters::ActiveRecordModel
+
   has_many :order_transitions
 
   def state_machine
     OrderStateMachine.new(self, transition_class: OrderTransition)
   end
+
+  private
+
+  def transition_class
+    OrderTransition
+  end
 end
 
 class OrderTransition < ActiveRecord::Base
@@ -78,6 +86,12 @@ Order.first.state_machine.can_transition_to?(:cancelled)
 Order.first.state_machine.transition_to(:cancelled, optional: :metadata)
 # => true/false
 
+Order.in_state(:cancelled)
+# => [#<Order id: "123">]
+
+Order.not_in_state(:checking_out)
+# => [#<Order id: "123">]
+
 Order.first.state_machine.transition_to!(:cancelled)
 # => true/exception
 ```
@@ -219,6 +233,30 @@ Transition to the passed state, returning `true` on success. Raises
 Transition to the passed state, returning `true` on success. Swallows all
 exceptions and returns false on failure.
 
+## Model scopes
+
+A mixin is provided for the ActiveRecord adapter which adds scopes to easily
+find all models currently in (or not in) a given state. Include it into your
+model and define a `transition_class` method.
+
+```ruby
+class Order < ActiveRecord::Base
+  include Statesman::Adapters::ActiveRecordModel
+  
+  private
+
+  def transition_class
+    OrderTransition
+  end
+end
+```
+
+#### `Model.in_state(:state_1, :state_2, etc)`
+Returns all models currently in any of the supplied states.
+
+#### `Model.not_in_state(:state_1, :state_2, etc)`
+Returns all models not currently in any of the supplied states.
+
 ---
 
 GoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/jobs/backend_developer).

data/lib/statesman.rb

@@ -9,7 +9,11 @@ module Statesman
     autoload :ActiveRecord, "statesman/adapters/active_record"
     autoload :ActiveRecordTransition,
              "statesman/adapters/active_record_transition"
+    autoload :ActiveRecordModel,
+             "statesman/adapters/active_record_model"
     autoload :Mongoid,      "statesman/adapters/mongoid"
+    autoload :MongoidTransition,
+             "statesman/adapters/mongoid_transition"
   end
 
   # Example:

data/lib/statesman/adapters/active_record_model.rb

@@ -0,0 +1,46 @@
+module Statesman
+  module Adapters
+    module ActiveRecordModel
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def in_state(*states)
+          joins(transition_name)
+            .joins(transition_join)
+            .where("#{transition_name}.to_state" => states)
+            .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("transition2.id" => nil)
+        end
+
+        private
+
+        def transition_class
+          raise NotImplementedError, "A transition_class method should be " +
+                                     "defined on the model"
+        end
+
+        def transition_name
+          transition_class.table_name.to_sym
+        end
+
+        def model_foreign_key
+          reflections[transition_name].foreign_key
+        end
+
+        def transition_join
+          "LEFT OUTER JOIN #{transition_name} transition2
+             ON transition2.#{model_foreign_key} = #{table_name}.id
+             AND transition2.sort_key > #{transition_name}.sort_key"
+        end
+      end
+    end
+  end
+end

data/lib/statesman/machine.rb

@@ -145,6 +145,7 @@ module Statesman
       @transition_class = options[:transition_class]
       @storage_adapter = Statesman.storage_adapter.new(
                                             @transition_class, object, self)
+      send(:after_initialize) if respond_to? :after_initialize
     end
 
     def current_state

data/lib/statesman/version.rb

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

data/spec/statesman/adapters/active_record_model_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+describe Statesman::Adapters::ActiveRecordModel do
+  before do
+    prepare_model_table
+    prepare_transitions_table
+  end
+
+  before do
+    MyActiveRecordModel.send(:include, Statesman::Adapters::ActiveRecordModel)
+    MyActiveRecordModel.class_eval do
+      def self.transition_class
+        MyActiveRecordModelTransition
+      end
+    end
+  end
+
+  let!(:model) do
+    model = MyActiveRecordModel.create
+    model.my_active_record_model_transitions.create(to_state: :state_a)
+    model
+  end
+
+  let!(:other_model) do
+    model = MyActiveRecordModel.create
+    model.my_active_record_model_transitions.create(to_state: :state_b)
+    model
+  end
+
+  describe ".in_state" do
+    context "given a single state" do
+      subject { MyActiveRecordModel.in_state(:state_a) }
+
+      it { should include model }
+    end
+
+    context "given multiple states" do
+      subject { MyActiveRecordModel.in_state(:state_a, :state_b) }
+
+      it { should include model }
+      it { should include other_model }
+    end
+  end
+
+  describe ".not_in_state" do
+    context "given a single state" do
+      subject { MyActiveRecordModel.not_in_state(:state_b) }
+      it { should include model }
+      it { should_not include other_model }
+    end
+
+    context "given multiple states" do
+      subject { MyActiveRecordModel.not_in_state(:state_a, :state_b) }
+      it { should == [] }
+    end
+  end
+end

data/spec/statesman/machine_spec.rb

@@ -206,6 +206,16 @@ describe Statesman::Machine do
     end
   end
 
+  describe "#after_initialize" do
+    it "is called after initialize" do
+      machine.class_eval do
+        def after_initialize; end
+      end
+      expect_any_instance_of(machine).to receive :after_initialize
+      machine.new(my_model)
+    end
+  end
+
   describe "#current_state" do
     before do
       machine.class_eval do

data/spec/statesman/transition_spec.rb

@@ -1,4 +1,5 @@
 require "spec_helper"
+require "statesman/adapters/memory_transition"
 
 describe Statesman::Adapters::MemoryTransition do
   describe "#initialize" do

data/spec/support/active_record.rb

@@ -1,4 +1,5 @@
 require "support/active_record"
+require "json"
 
 DB = Pathname.new("test.sqlite3")
 
@@ -8,6 +9,7 @@ end
 
 class MyActiveRecordModelTransition < ActiveRecord::Base
   belongs_to :my_active_record_model
+  serialize :metadata, JSON
 end
 
 class CreateMyActiveRecordModelMigration < ActiveRecord::Migration

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Harry Marr
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-10 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -163,6 +163,7 @@ files:
 - lib/generators/statesman/templates/update_migration.rb.erb
 - lib/statesman.rb
 - lib/statesman/adapters/active_record.rb
+- lib/statesman/adapters/active_record_model.rb
 - lib/statesman/adapters/active_record_transition.rb
 - lib/statesman/adapters/memory.rb
 - lib/statesman/adapters/memory_transition.rb
@@ -175,6 +176,7 @@ files:
 - lib/statesman/machine.rb
 - lib/statesman/version.rb
 - spec/spec_helper.rb
+- spec/statesman/adapters/active_record_model_spec.rb
 - spec/statesman/adapters/active_record_spec.rb
 - spec/statesman/adapters/active_record_transition_spec.rb
 - spec/statesman/adapters/memory_spec.rb
@@ -214,6 +216,7 @@ specification_version: 4
 summary: A statesmanlike state machine library
 test_files:
 - spec/spec_helper.rb
+- spec/statesman/adapters/active_record_model_spec.rb
 - spec/statesman/adapters/active_record_spec.rb
 - spec/statesman/adapters/active_record_transition_spec.rb
 - spec/statesman/adapters/memory_spec.rb