statesman 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dc520c4907fb1573b7682bd1db4affe787b1d036
-  data.tar.gz: 796e3a0482fc5814b9ae9da4ec870dc97d43b851
+  metadata.gz: a4cc83b59dfad9ed139c2215211c93550f06d4ea
+  data.tar.gz: 170879ce893bcd74ab1742dd609d4a9abb163ffd
 SHA512:
-  metadata.gz: 3ae6ba2af2f37b4df09d025d2bdfce5849aba5ba3e23a3d7c341061db4ad8002547177302a155b29c2770bc58d5b0988c1df2854e186a36d0236f9d5f0ca96e9
-  data.tar.gz: 57d5ab47d228ae72de01cff8e9b03db86bdb755bb70b8231a5f7639d7d45320fc647587061c76053353c4d56004a3dbefa8a52045e4bbd6e6175bc58fbc69cc3
+  metadata.gz: a1c4175b5bc89dbe750b758f37cef8e08469515eb94f470f7872b7dcba2c7dec4650e4ed28670e7fc7d2f64647abf8dbc35e6f2ea0b980041fe38586a8eebfd9
+  data.tar.gz: fb34e4fd474a1ca62585e7837bc16525b872b9b69f99b65ccb10e69f06b359c2cadc14ef04f75ff90ee459d779e9a15a8769fb7c6b06a2704b84cc6c15869173

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.2.2 24 March 2015
+
+- Add support for namespaced transition models (patch by [@DanielWright](https://github.com/DanielWright))
+
 ## v1.2.1 24 March 2015
 
 - Add support for Postgres 9.4's `jsonb` column type (patch by [@isaacseymour](https://github.com/isaacseymour))

data/README.md

@@ -134,11 +134,12 @@ And add an association from the parent model:
 
 ```ruby
 class Order < ActiveRecord::Base
-  has_many :order_transitions
+  has_many :transitions, class_name: "OrderTransition"
 
   # Initialize the state machine
   def state_machine
-    @state_machine ||= OrderStateMachine.new(self, transition_class: OrderTransition)
+    @state_machine ||= OrderStateMachine.new(self, transition_class: OrderTransition,
+                                                   association_name: :transitions)
   end
 
   # Optionally delegate some methods
@@ -298,6 +299,29 @@ class Order < ActiveRecord::Base
 end
 ```
 
+If the transition class-name differs from the association name, you will also
+need to define a corresponding `transition_name` class method:
+
+```ruby
+class Order < ActiveRecord::Base
+  has_many :transitions, class_name: "OrderTransition"
+
+  private
+
+  def self.transition_name
+    :transitions
+  end
+
+  def self.transition_class
+    OrderTransition
+  end
+
+  def self.initial_state
+    OrderStateMachine.initial_state
+  end
+end
+```
+
 #### `Model.in_state(:state_1, :state_2, etc)`
 Returns all models currently in any of the supplied states.
 

data/lib/statesman/adapters/active_record.rb

@@ -8,7 +8,7 @@ module Statesman
 
       JSON_COLUMN_TYPES = %w(json jsonb).freeze
 
-      def initialize(transition_class, parent_model, observer)
+      def initialize(transition_class, parent_model, observer, options = {})
         serialized = serialized?(transition_class)
         column_type = transition_class.columns_hash['metadata'].sql_type
         if !serialized && !JSON_COLUMN_TYPES.include?(column_type)
@@ -22,6 +22,8 @@ module Statesman
         @transition_class = transition_class
         @parent_model = parent_model
         @observer = observer
+        @association_name =
+          options[:association_name] || @transition_class.table_name
       end
 
       def create(from, to, metadata = {})
@@ -76,7 +78,7 @@ module Statesman
       end
 
       def transitions_for_parent
-        @parent_model.send(@transition_class.table_name)
+        @parent_model.send(@association_name)
       end
 
       def unset_old_most_recent

data/lib/statesman/adapters/active_record_queries.rb

@@ -66,23 +66,31 @@ module Statesman
           transition_class.table_name.to_sym
         end
 
+        def transition_reflection
+          reflect_on_association(transition_name)
+        end
+
         def model_foreign_key
-          reflect_on_association(transition_name).foreign_key
+          transition_reflection.foreign_key
+        end
+
+        def model_table
+          transition_reflection.table_name
         end
 
         def transition1_join
-          "LEFT OUTER JOIN #{transition_name} transition1
+          "LEFT OUTER JOIN #{model_table} transition1
              ON transition1.#{model_foreign_key} = #{table_name}.id"
         end
 
         def transition2_join
-          "LEFT OUTER JOIN #{transition_name} transition2
+          "LEFT OUTER JOIN #{model_table} transition2
              ON transition2.#{model_foreign_key} = #{table_name}.id
              AND transition2.sort_key > transition1.sort_key"
         end
 
         def most_recent_transition_join
-          "LEFT OUTER JOIN #{transition_name} AS last_transition
+          "LEFT OUTER JOIN #{model_table} AS last_transition
              ON #{table_name}.id = last_transition.#{model_foreign_key}
              AND last_transition.most_recent = #{db_true}"
         end

data/lib/statesman/adapters/memory.rb

@@ -9,7 +9,7 @@ module Statesman
 
       # We only accept mode as a parameter to maintain a consistent interface
       # with other adapters which require it.
-      def initialize(transition_class, parent_model, observer)
+      def initialize(transition_class, parent_model, observer, _ = {})
         @history = []
         @transition_class = transition_class
         @parent_model = parent_model

data/lib/statesman/adapters/mongoid.rb

@@ -6,7 +6,7 @@ module Statesman
       attr_reader :transition_class
       attr_reader :parent_model
 
-      def initialize(transition_class, parent_model, observer)
+      def initialize(transition_class, parent_model, observer, _ = {})
         @transition_class = transition_class
         @parent_model = parent_model
         @observer = observer

data/lib/statesman/machine.rb

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

data/lib/statesman/version.rb

@@ -1,3 +1,3 @@
 module Statesman
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

data/spec/spec_helper.rb

@@ -39,7 +39,12 @@ RSpec.configure do |config|
   end
 
   config.before(:each, active_record: true) do
-    tables = %w(my_active_record_models my_active_record_model_transitions)
+    tables = %w(
+      my_active_record_models
+      my_active_record_model_transitions
+      my_namespace_my_active_record_models
+      my_namespace_my_active_record_model_transitions
+    )
     tables.each do |table_name|
       sql = "DROP TABLE IF EXISTS #{table_name};"
       ActiveRecord::Base.connection.execute(sql)

data/spec/statesman/adapters/active_record_spec.rb

@@ -204,4 +204,25 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
       end
     end
   end
+
+  context "with a namespaced model" do
+    before do
+      silence_stream(STDOUT) do
+        CreateNamespacedARModelMigration.migrate(:up)
+        CreateNamespacedARModelTransitionMigration.migrate(:up)
+      end
+    end
+
+    before do
+      MyNamespace::MyActiveRecordModelTransition.serialize(:metadata, JSON)
+    end
+    let(:observer) { double(Statesman::Machine, execute: nil) }
+    let(:model) do
+      MyNamespace::MyActiveRecordModel.create(current_state: :pending)
+    end
+
+    it_behaves_like "an adapter",
+                    described_class, MyNamespace::MyActiveRecordModelTransition,
+                    association_name: :my_active_record_model_transitions
+  end
 end

data/spec/statesman/adapters/shared_examples.rb

@@ -11,9 +11,16 @@ require "spec_helper"
 #   history:          Returns the full transition history
 #   last:             Returns the latest transition history item
 #
-shared_examples_for "an adapter" do |adapter_class, transition_class|
+# rubocop:disable Metrics/LineLength
+# NOTE This line cannot reasonably be shortened.
+shared_examples_for "an adapter" do |adapter_class, transition_class, options = {}|
+  # rubocop:enable Metrics/LineLength
+
   let(:observer) { double(Statesman::Machine, execute: nil) }
-  let(:adapter) { adapter_class.new(transition_class, model, observer) }
+  let(:adapter) do
+    adapter_class.new(transition_class,
+                      model, observer, options)
+  end
 
   describe "#initialize" do
     subject { adapter }

data/spec/statesman/machine_spec.rb

@@ -316,21 +316,23 @@ describe Statesman::Machine do
     context "transition class" do
       it "sets a default" do
         expect(Statesman.storage_adapter).to receive(:new).once.
-          with(Statesman::Adapters::MemoryTransition, my_model, anything)
+          with(Statesman::Adapters::MemoryTransition,
+               my_model, anything, anything)
         machine.new(my_model)
       end
 
       it "sets the passed class" do
         my_transition_class = Class.new
         expect(Statesman.storage_adapter).to receive(:new).once.
-          with(my_transition_class, my_model, anything)
+          with(my_transition_class, my_model, anything, anything)
         machine.new(my_model, transition_class: my_transition_class)
       end
 
       it "falls back to Memory without transaction_class" do
         allow(Statesman).to receive(:storage_adapter).and_return(Class.new)
         expect(Statesman::Adapters::Memory).to receive(:new).once.
-          with(Statesman::Adapters::MemoryTransition, my_model, anything)
+          with(Statesman::Adapters::MemoryTransition,
+               my_model, anything, anything)
         machine.new(my_model)
       end
     end

data/spec/support/active_record.rb

@@ -37,7 +37,7 @@ class CreateMyActiveRecordModelMigration < ActiveRecord::Migration
   def change
     create_table :my_active_record_models do |t|
       t.string :current_state
-      t.timestamps(null: false)
+      t.timestamps null: false
     end
   end
 end
@@ -59,7 +59,7 @@ class CreateMyActiveRecordModelTransitionMigration < ActiveRecord::Migration
         t.text :metadata, default: '{}'
       end
 
-      t.timestamps(null: false)
+      t.timestamps null: false
     end
 
     add_index :my_active_record_model_transitions,
@@ -82,3 +82,65 @@ class DropMostRecentColumn < ActiveRecord::Migration
     remove_column :my_active_record_model_transitions, :most_recent
   end
 end
+
+module MyNamespace
+  class MyActiveRecordModel < ActiveRecord::Base
+    has_many :my_active_record_model_transitions,
+             class_name: "MyNamespace::MyActiveRecordModelTransition"
+
+    def self.table_name_prefix
+      "my_namespace_"
+    end
+
+    def state_machine
+      @state_machine ||= MyStateMachine.new(
+        self, transition_class: MyNameSpace::MyActiveRecordModelTransition,
+              association_name: :my_active_record_model_transitions)
+    end
+
+    def metadata
+      super || {}
+    end
+  end
+
+  class MyActiveRecordModelTransition < ActiveRecord::Base
+    belongs_to :my_active_record_model,
+               class_name: "MyNamespace::MyActiveRecordModel"
+    serialize :metadata, JSON
+
+    def self.table_name_prefix
+      "my_namespace_"
+    end
+  end
+end
+
+class CreateNamespacedARModelMigration < ActiveRecord::Migration
+  def change
+    create_table :my_namespace_my_active_record_models do |t|
+      t.string :current_state
+      t.timestamps null: false
+    end
+  end
+end
+
+class CreateNamespacedARModelTransitionMigration < ActiveRecord::Migration
+  def change
+    create_table :my_namespace_my_active_record_model_transitions do |t|
+      t.string  :to_state
+      t.integer :my_active_record_model_id
+      t.integer :sort_key
+
+      # MySQL doesn't allow default values on text fields
+      if ActiveRecord::Base.connection.adapter_name == 'Mysql2'
+        t.text :metadata
+      else
+        t.text :metadata, default: '{}'
+      end
+
+      t.timestamps null: false
+    end
+
+    add_index :my_namespace_my_active_record_model_transitions, :sort_key,
+              unique: true, name: 'my_namespaced_key'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Harry Marr