statesman 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4cc83b59dfad9ed139c2215211c93550f06d4ea
-  data.tar.gz: 170879ce893bcd74ab1742dd609d4a9abb163ffd
+  metadata.gz: 747626de855901f8252afbc7bae793d67c3e062a
+  data.tar.gz: f6b3c8239d7b92883c4bffce040d133cfc7cedfd
 SHA512:
-  metadata.gz: a1c4175b5bc89dbe750b758f37cef8e08469515eb94f470f7872b7dcba2c7dec4650e4ed28670e7fc7d2f64647abf8dbc35e6f2ea0b980041fe38586a8eebfd9
-  data.tar.gz: fb34e4fd474a1ca62585e7837bc16525b872b9b69f99b65ccb10e69f06b359c2cadc14ef04f75ff90ee459d779e9a15a8769fb7c6b06a2704b84cc6c15869173
+  metadata.gz: 3db31cb3e861d3230ab1f631c30727709251d70e109a27c3b723bcfe0f213ed3f73f82920a939e9ac897e87db8cee5852c20f4e8103fc3a7a210a57b62445f07
+  data.tar.gz: b17bfbc8186d3c0bc888cb0c92e282cd8174b0cb64dcd78185b6b40ed9bac8b2112314ca4ee0031d0293af07aeaa7cc7b2960809e7daa9ec89a8e5d785ad5550

data/.rubocop.yml

@@ -17,11 +17,11 @@ Documentation:
   Enabled: false
 
 SignalException:
-  Enabled: false
+  EnforcedStyle: only_raise
 
-# Avoid methods longer than 30 lines of code
+# Avoid methods longer than 15 lines of code
 MethodLength:
-  CountComments: false  # count full line comments?
+  CountComments: false
   Max: 15
 
 AbcSize:
@@ -40,5 +40,5 @@ GuardClause:
 SingleSpaceBeforeFirstArg:
   Enabled: false
 
-Style/DotPosition:
-  EnforcedStyle: 'trailing'
+DotPosition:
+  EnforcedStyle: trailing

data/.travis.yml

@@ -20,8 +20,8 @@ script:
 
 env:
   - "RAILS_VERSION=3.2.21"
-  - "RAILS_VERSION=4.0.12"
-  - "RAILS_VERSION=4.1.8"
-  - "RAILS_VERSION=4.2.0"
-  - "RAILS_VERSION=4.2.0 DATABASE_URL=mysql2://root@localhost/statesman_test"
-  - "RAILS_VERSION=4.2.0 DATABASE_URL=postgres://postgres@localhost/statesman_test"
+  - "RAILS_VERSION=4.0.13"
+  - "RAILS_VERSION=4.1.10"
+  - "RAILS_VERSION=4.2.1"
+  - "RAILS_VERSION=4.2.1 DATABASE_URL=mysql2://root@localhost/statesman_test"
+  - "RAILS_VERSION=4.2.1 DATABASE_URL=postgres://postgres@localhost/statesman_test"

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.2.3 14 April 2015
+
+- Fix use of most_recent column in MySQL (partial indexes aren't supported) (patch by [@greysteil](https://github.com/greysteil))
+
 ## v1.2.2 24 March 2015
 
 - Add support for namespaced transition models (patch by [@DanielWright](https://github.com/DanielWright))

data/lib/generators/statesman/generator_helpers.rb

@@ -36,5 +36,9 @@ module Statesman
       ActiveRecord::Base.configurations[Rails.env].
         try(:[], "adapter").try(:match, /mysql/)
     end
+
+    def database_supports_partial_indexes?
+      Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+    end
   end
 end

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

@@ -2,12 +2,18 @@ class AddConstraintsToMostRecentFor<%= migration_class_name %> < ActiveRecord::M
   disable_ddl_transaction!
 
   def up
+    <%- if database_supports_partial_indexes? -%>
     add_index :<%= table_name %>, [:<%= parent_id %>, :most_recent], unique: true, where: "most_recent", name: "index_<%= table_name %>_parent_most_recent", algorithm: :concurrently
     change_column_null :<%= table_name %>, :most_recent, false
+    <%- else -%>
+    add_index :<%= table_name %>, [:<%= parent_id %>, :most_recent], unique: true, name: "index_<%= table_name %>_parent_most_recent", algorithm: :concurrently
+    <%- end -%>
   end
 
   def down
     remove_index :<%= table_name %>, name: "index_<%= table_name %>_parent_most_recent"
+    <%- if database_supports_partial_indexes? -%>
     change_column_null :<%= table_name %>, :most_recent, true
+    <%- end -%>
   end
 end

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

@@ -5,11 +5,18 @@ class Create<%= migration_class_name %> < ActiveRecord::Migration
       t.text :metadata<%= ", default: \"{}\"" unless mysql? %>
       t.integer :sort_key, null: false
       t.integer :<%= parent_id %>, null: false
-      t.boolean :most_recent, null: false
+      t.boolean :most_recent<%= ", null: false" if database_supports_partial_indexes? %>
       t.timestamps null: false
     end
 
-    add_index :<%= table_name %>, [:<%= parent_id %>, :sort_key], unique: true, name: "<%= index_name :parent_sort %>"
-    add_index :<%= table_name %>, [:<%= parent_id %>, :most_recent], unique: true, where: "most_recent", name: "<%= index_name :parent_most_recent %>"
+    add_index(:<%= table_name %>,
+              [:<%= parent_id %>, :sort_key],
+              unique: true,
+              name: "<%= index_name :parent_sort %>")
+    add_index(:<%= table_name %>,
+              [:<%= parent_id %>, :most_recent],
+              unique: true,
+              <%= "where: 'most_recent'," if database_supports_partial_indexes? %>
+              name: "<%= index_name :parent_most_recent %>")
   end
 end

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

@@ -1,14 +1,14 @@
 class <%= klass %>
   include Mongoid::Document
   include Mongoid::Timestamps
-  include Statesman::Adapters::MongoidTransition
 
   field :to_state, type: String
   field :sort_key, type: Integer
   field :statesman_metadata, type: Hash
 
+  include Statesman::Adapters::MongoidTransition
+
   index({ sort_key: 1 })
 
   belongs_to :<%= parent %><%= class_name_option %>, index: true
-
 end

data/lib/statesman/adapters/active_record.rb

@@ -8,6 +8,15 @@ module Statesman
 
       JSON_COLUMN_TYPES = %w(json jsonb).freeze
 
+      def self.database_supports_partial_indexes?
+        # Rails 3 doesn't implement `supports_partial_index?`
+        if ::ActiveRecord::Base.connection.respond_to?(:supports_partial_index?)
+          ::ActiveRecord::Base.connection.supports_partial_index?
+        else
+          ::ActiveRecord::Base.connection.adapter_name == 'PostgreSQL'
+        end
+      end
+
       def initialize(transition_class, parent_model, observer, options = {})
         serialized = serialized?(transition_class)
         column_type = transition_class.columns_hash['metadata'].sql_type
@@ -27,15 +36,10 @@ module Statesman
       end
 
       def create(from, to, metadata = {})
-        from = from.to_s
-        to = to.to_s
-        create_transition(from, to, metadata)
+        create_transition(from.to_s, to.to_s, metadata)
       rescue ::ActiveRecord::RecordNotUnique => e
-        if e.message.include?(@transition_class.table_name) &&
-           e.message.include?('sort_key') || e.message.include?('most_recent')
-          raise TransitionConflictError, e.message
-        else raise
-        end
+        raise TransitionConflictError, e.message if transition_conflict_error? e
+        raise
       ensure
         @last_transition = nil
       end
@@ -83,7 +87,18 @@ module Statesman
 
       def unset_old_most_recent
         return unless most_recent_column?
-        transitions_for_parent.update_all(most_recent: false)
+        # Check whether the `most_recent` column allows null values. If it
+        # doesn't, set old records to `false`, otherwise, set them to `NULL`.
+        #
+        # Some conditioning here is required to support databases that don't
+        # support partial indexes. By doing the conditioning on the column,
+        # rather than Rails' opinion of whether the database supports partial
+        # indexes, we're robust to DBs later adding support for partial indexes.
+        if transition_class.columns_hash['most_recent'].null == false
+          transitions_for_parent.update_all(most_recent: false)
+        else
+          transitions_for_parent.update_all(most_recent: nil)
+        end
       end
 
       def most_recent_column?
@@ -103,6 +118,11 @@ module Statesman
           transition_class.serialized_attributes.include?("metadata")
         end
       end
+
+      def transition_conflict_error?(e)
+        e.message.include?(@transition_class.table_name) &&
+          (e.message.include?('sort_key') || e.message.include?('most_recent'))
+      end
     end
   end
 end

data/lib/statesman/callback.rb

@@ -38,7 +38,7 @@ module Statesman
     end
 
     def matches_from_state(from, to)
-      (from == self.from  && (to.nil? || self.to.empty?))
+      (from == self.from && (to.nil? || self.to.empty?))
     end
 
     def matches_to_state(from, to)

data/lib/statesman/machine.rb

@@ -77,7 +77,7 @@ module Statesman
         if event
           events[event] ||= {}
           events[event][from] ||= []
-          events[event][from]  += to
+          events[event][from] += to
         end
       end
 

data/lib/statesman/version.rb

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

data/lib/tasks/statesman.rake

@@ -15,9 +15,14 @@ namespace :statesman do
 
     parent_class.find_in_batches(batch_size: batch_size) do |models|
       ActiveRecord::Base.transaction do
-        # Set all transitions' most_recent to FALSE
-        transition_class.where(parent_fk => models.map(&:id)).
-          update_all(most_recent: false)
+        if transition_class.columns_hash['most_recent'].null == false
+          # Set all transitions' most_recent to FALSE
+          transition_class.where(parent_fk => models.map(&:id)).
+            update_all(most_recent: false)
+        else
+          transition_class.where(parent_fk => models.map(&:id)).
+            update_all(most_recent: nil)
+        end
 
         # Set current transition's most_recent to TRUE
         ActiveRecord::Base.connection.execute %{

data/spec/fixtures/add_constraints_to_most_recent_for_bacon_transitions_without_partial_index.rb

@@ -0,0 +1,11 @@
+class AddConstraintsToMostRecentForBaconTransitions < ActiveRecord::Migration
+  disable_ddl_transaction!
+
+  def up
+    add_index :bacon_transitions, [:bacon_id, :most_recent], unique: true, name: "index_bacon_transitions_parent_most_recent", algorithm: :concurrently
+  end
+
+  def down
+    remove_index :bacon_transitions, name: "index_bacon_transitions_parent_most_recent"
+  end
+end

data/spec/generators/statesman/active_record_transition_generator_spec.rb

@@ -12,7 +12,7 @@ describe Statesman::ActiveRecordTransitionGenerator, type: :generator do
     subject { file('app/models/yummy/bacon_transition.rb') }
 
     it { is_expected.to contain(/:bacon_transition/) }
-    it { is_expected.not_to contain(/:yummy\/bacon/) }
+    it { is_expected.not_to contain(%r{:yummy/bacon}) }
     it { is_expected.to contain(/class_name: 'Yummy::Bacon'/) }
   end
 

data/spec/generators/statesman/add_constraints_to_most_recent_generator_spec.rb

@@ -22,8 +22,13 @@ describe Statesman::AddConstraintsToMostRecentGenerator, type: :generator do
     end
 
     let(:fixture_file) do
-      File.read("spec/fixtures/add_constraints_to_most_recent_for_"\
-                "bacon_transitions.rb")
+      if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+        File.read("spec/fixtures/add_constraints_to_most_recent_for_"\
+                  "bacon_transitions_with_partial_index.rb")
+      else
+        File.read("spec/fixtures/add_constraints_to_most_recent_for_"\
+                  "bacon_transitions_without_partial_index.rb")
+      end
     end
 
     before do

data/spec/generators/statesman/migration_generator_spec.rb

@@ -26,7 +26,7 @@ describe Statesman::MigrationGenerator, type: :generator do
     end
 
     it { is_expected.to contain(/:bacon_transition/) }
-    it { is_expected.not_to contain(/:yummy\/bacon/) }
+    it { is_expected.not_to contain(%r{:yummy/bacon}) }
     it { is_expected.to contain(/null: false/) }
 
     it "names the sorting index appropriately" do

data/spec/generators/statesman/mongoid_transition_generator_spec.rb

@@ -7,7 +7,7 @@ describe Statesman::MongoidTransitionGenerator, type: :generator do
     before { run_generator %w(Yummy::Bacon Yummy::BaconTransition) }
     subject { file('app/models/yummy/bacon_transition.rb') }
 
-    it { is_expected.not_to contain(/:yummy\/bacon/) }
+    it { is_expected.not_to contain(%r{:yummy/bacon}) }
     it { is_expected.to contain(/class_name: 'Yummy::Bacon'/) }
   end
 

data/spec/spec_helper.rb

@@ -31,7 +31,7 @@ RSpec.configure do |config|
   else
     # Connect to the database for activerecord tests
     db_conn_spec = ENV["DATABASE_URL"]
-    db_conn_spec ||=  { adapter: "sqlite3", database: ":memory:" }
+    db_conn_spec ||= { adapter: "sqlite3", database: ":memory:" }
     ActiveRecord::Base.establish_connection(db_conn_spec)
 
     db_adapter = ActiveRecord::Base.connection.adapter_name

data/spec/statesman/adapters/active_record_spec.rb

@@ -145,7 +145,7 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
         it "updates the previous transition's most_recent flag" do
           expect { create }.
             to change { previous_transition.reload.most_recent }.
-            from(true).to(false)
+            from(true).to be_falsey
         end
 
         context "and the parent model is updated in a callback" do
@@ -162,6 +162,18 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
           end
         end
       end
+
+      context "with two previous transitions" do
+        let!(:previous_transition) { adapter.create(from, to) }
+        let!(:another_previous_transition) { adapter.create(from, to) }
+        its(:most_recent) { is_expected.to eq(true) }
+
+        it "updates the previous transition's most_recent flag" do
+          expect { create }.
+            to change { another_previous_transition.reload.most_recent }.
+            from(true).to be_falsey
+        end
+      end
     end
 
     context "when the transition_class doesn't have a most_recent column" do

data/spec/support/active_record.rb

@@ -50,7 +50,6 @@ class CreateMyActiveRecordModelTransitionMigration < ActiveRecord::Migration
       t.string  :to_state
       t.integer :my_active_record_model_id
       t.integer :sort_key
-      t.boolean :most_recent, default: true, null: false
 
       # MySQL doesn't allow default values on text fields
       if ActiveRecord::Base.connection.adapter_name == 'Mysql2'
@@ -59,17 +58,33 @@ class CreateMyActiveRecordModelTransitionMigration < ActiveRecord::Migration
         t.text :metadata, default: '{}'
       end
 
+      if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+        t.boolean :most_recent, default: true, null: false
+      else
+        t.boolean :most_recent, default: true
+      end
+
       t.timestamps null: false
     end
 
     add_index :my_active_record_model_transitions,
               [:my_active_record_model_id, :sort_key],
               unique: true, name: "sort_key_index"
-    add_index :my_active_record_model_transitions,
-              [:my_active_record_model_id, :most_recent],
-              unique: true, where: "most_recent",
-              name: "index_my_active_record_model_transitions_"\
-                    "parent_most_recent"
+
+    if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+      add_index :my_active_record_model_transitions,
+                [:my_active_record_model_id, :most_recent],
+                unique: true,
+                where: "most_recent",
+                name: "index_my_active_record_model_transitions_"\
+                      "parent_most_recent"
+    else
+      add_index :my_active_record_model_transitions,
+                [:my_active_record_model_id, :most_recent],
+                unique: true,
+                name: "index_my_active_record_model_transitions_"\
+                      "parent_most_recent"
+    end
   end
 end
 # rubocop:enable MethodLength

data/spec/support/mongoid.rb

@@ -14,6 +14,7 @@ end
 
 class MyMongoidModelTransition
   include Mongoid::Document
+  include Mongoid::Timestamps
 
   field :to_state, type: String
   field :sort_key, type: Integer
@@ -23,6 +24,5 @@ class MyMongoidModelTransition
 
   belongs_to :my_mongoid_model, index: true
 
-  alias_method :metadata, :statesman_metadata
-  alias_method :metadata=, :statesman_metadata=
+  include Statesman::Adapters::MongoidTransition
 end

data/statesman.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec",         "~> 3.1"
   spec.add_development_dependency "rspec-its",     "~> 1.1"
   spec.add_development_dependency "guard-rspec",   "~> 4.3"
-  spec.add_development_dependency "rubocop",       "~> 0.29.1"
+  spec.add_development_dependency "rubocop",       "~> 0.30.0"
   spec.add_development_dependency "guard-rubocop", "~> 1.2"
   spec.add_development_dependency "sqlite3",       "~> 1.3"
   spec.add_development_dependency "mongoid",       ">= 3.1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - Harry Marr
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2015-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: 0.30.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.29.1
+        version: 0.30.0
 - !ruby/object:Gem::Dependency
   name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -240,7 +240,8 @@ files:
 - lib/statesman/railtie.rb
 - lib/statesman/version.rb
 - lib/tasks/statesman.rake
-- spec/fixtures/add_constraints_to_most_recent_for_bacon_transitions.rb
+- spec/fixtures/add_constraints_to_most_recent_for_bacon_transitions_with_partial_index.rb
+- spec/fixtures/add_constraints_to_most_recent_for_bacon_transitions_without_partial_index.rb
 - spec/fixtures/add_most_recent_to_bacon_transitions.rb
 - spec/generators/statesman/active_record_transition_generator_spec.rb
 - spec/generators/statesman/add_constraints_to_most_recent_generator_spec.rb
@@ -283,12 +284,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A statesmanlike state machine library
 test_files:
-- spec/fixtures/add_constraints_to_most_recent_for_bacon_transitions.rb
+- spec/fixtures/add_constraints_to_most_recent_for_bacon_transitions_with_partial_index.rb
+- spec/fixtures/add_constraints_to_most_recent_for_bacon_transitions_without_partial_index.rb
 - spec/fixtures/add_most_recent_to_bacon_transitions.rb
 - spec/generators/statesman/active_record_transition_generator_spec.rb
 - spec/generators/statesman/add_constraints_to_most_recent_generator_spec.rb
@@ -310,4 +312,3 @@ test_files:
 - spec/support/active_record.rb
 - spec/support/generators_shared_examples.rb
 - spec/support/mongoid.rb
-has_rdoc: