statesman 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ea9661229864328ca481ff132837554323967d265616d38c295c5fa94ca9103
-  data.tar.gz: 8974f12e8e70d925f0b35e3753a9977d1ff94a1a76bf05c0a967535037ce6a24
+  metadata.gz: 171ee6b0234ee7909d9af5b91ee09e8cb397adac1c1e90db5e53b1e08413d137
+  data.tar.gz: fd445775c6f034e067b492e79191803c4b5f48127599e9395374fb7934ea9d8e
 SHA512:
-  metadata.gz: ec7c81ee5c313377acaf35c1196ccf74036769bb945c636d93f56d346deda319534ea9dbeff87bbfe84a2f3d71d7a1a4ae3d435d80c2fa46dc43d2ff3304661a
-  data.tar.gz: 78ed181ce45c7517f8617f61e26c20780f0f2c5b3a04236e4766761b985d42172774d05a54d05bcc2d72bc379eb2f6ed3fe68c122ce8989f19d3d5ba16d286af
+  metadata.gz: 0b88f58d64734af53bbf5155059a5f56ad96578c7d7be57e0f4b52b77bf1f57db6629438d91da1acd5068ea456d16893070555a720e1d153f7b5111cfa2f4ce2
+  data.tar.gz: 3e07fafb2c37ae74a9c60f38ac186110d7f01e2024ff0361948b8dc039e282845748f31737f25a36d228eb8188788f2f7be8db2e1e2d978486e82153c82a7474

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v3.4.0, 12 February 2018
+
+- When unsetting the `most_recent` flag during a transition, don't assume that transitions have an `updated_at` attribute, but rather allow the "updated timestamp column" to be re-configured or disabled entirely (patch by [@timrogers](https://github.com/timrogers))
+
 ## v3.3.0, 5 January 2018
 
 - Touch `updated_at` on transitions when unsetting `most_recent` flag (patch by [@NGMarmaduke](https://github.com/NGMarmaduke))

data/README.md

@@ -29,7 +29,7 @@ protection.
 To get started, just add Statesman to your `Gemfile`, and then run `bundle`:
 
 ```ruby
-gem 'statesman', '~> 3.3.0'
+gem 'statesman', '~> 3.4.0'
 ```
 
 ## Usage
@@ -137,6 +137,11 @@ Generate the transition model:
 $ rails g statesman:active_record_transition Order OrderTransition
 ```
 
+If you're using the ActiveRecord adapter and decide not to include the default
+`updated_at` column in your transition table, you'll need to configure the
+`updated_timestamp_column` option on the transition class, setting it to another column
+name (e.g. `:updated_on`) or `nil`.
+
 And add an association from the parent model:
 
 `app/models/order.rb`:

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

@@ -1,6 +1,13 @@
 class <%= klass %> < <%= Statesman::Utils.rails_5_or_higher? ? 'ApplicationRecord' : 'ActiveRecord::Base' %>
   include Statesman::Adapters::ActiveRecordTransition
 
+  # If your transition table doesn't have the default `updated_at` timestamp column,
+  # you'll need to configure the `updated_timestamp_column` option, setting it to
+  # another column name (e.g. `:updated_on`) or `nil`.
+  #
+  # self.updated_timestamp_column = :updated_on
+  # self.updated_timestamp_column = nil
+
 <%- unless Statesman::Utils.rails_4_or_higher? -%>
   attr_accessible :to_state, :metadata, :sort_key
 

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

@@ -6,6 +6,10 @@ class Create<%= migration_class_name %> < ActiveRecord::Migration<%= "[#{ActiveR
       t.integer :sort_key, null: false
       t.integer :<%= parent_id %>, null: false
       t.boolean :most_recent<%= ", null: false" if database_supports_partial_indexes? %>
+
+      # If you decide not to include an updated timestamp column in your transition
+      # table, you'll need to configure the `updated_timestamp_column` setting in your
+      # migration class.
       t.timestamps null: false
     end
 

data/lib/statesman/adapters/active_record.rb

@@ -88,11 +88,7 @@ module Statesman
 
       def unset_old_most_recent
         most_recent = transitions_for_parent.where(most_recent: true)
-        updated_at = if ::ActiveRecord::Base.default_timezone == :utc
-                       Time.now.utc
-                     else
-                       Time.now
-                     end
+
         # Check whether the `most_recent` column allows null values. If it
         # doesn't, set old records to `false`, otherwise, set them to `NULL`.
         #
@@ -101,9 +97,9 @@ module Statesman
         # 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
-          most_recent.update_all(most_recent: false, updated_at: updated_at)
+          most_recent.update_all(with_updated_timestamp(most_recent: false))
         else
-          most_recent.update_all(most_recent: nil, updated_at: updated_at)
+          most_recent.update_all(with_updated_timestamp(most_recent: nil))
         end
       end
 
@@ -125,6 +121,18 @@ module Statesman
         e.message.include?(@transition_class.table_name) &&
           (e.message.include?("sort_key") || e.message.include?("most_recent"))
       end
+
+      def with_updated_timestamp(params)
+        return params if @transition_class.updated_timestamp_column.nil?
+
+        timestamp = if ::ActiveRecord::Base.default_timezone == :utc
+                      Time.now.utc
+                    else
+                      Time.now
+                    end
+
+        params.merge(@transition_class.updated_timestamp_column => timestamp)
+      end
     end
   end
 end

data/lib/statesman/adapters/active_record_transition.rb

@@ -3,8 +3,15 @@ require "json"
 module Statesman
   module Adapters
     module ActiveRecordTransition
-      def self.included(base)
-        base.send(:serialize, :metadata, JSON)
+      DEFAULT_UPDATED_TIMESTAMP_COLUMN = :updated_at
+
+      extend ActiveSupport::Concern
+
+      included do
+        serialize :metadata, JSON
+
+        class_attribute :updated_timestamp_column
+        self.updated_timestamp_column = DEFAULT_UPDATED_TIMESTAMP_COLUMN
       end
     end
   end

data/lib/statesman/version.rb

@@ -1,3 +1,3 @@
 module Statesman
-  VERSION = "3.3.0".freeze
+  VERSION = "3.4.0".freeze
 end

data/spec/spec_helper.rb

@@ -11,6 +11,7 @@ require "action_controller"
 require "rspec/rails"
 require "support/active_record"
 require "rspec/its"
+require "pry"
 
 RSpec.configure do |config|
   config.raise_errors_for_deprecations!

data/spec/statesman/adapters/active_record_spec.rb

@@ -163,6 +163,46 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
             to(change { previous_transition.reload.updated_at })
         end
 
+        context "with a custom updated timestamp column set" do
+          around do |example|
+            MyActiveRecordModelTransition.updated_timestamp_column.tap do |original_value|
+              MyActiveRecordModelTransition.updated_timestamp_column = :updated_on
+              example.run
+              MyActiveRecordModelTransition.updated_timestamp_column = original_value
+            end
+          end
+
+          it "touches the previous transition's updated_on timestamp" do
+            expect { Timecop.freeze(Time.now + 1.day) { create } }.
+              to(change { previous_transition.reload.updated_on })
+          end
+
+          it "doesn't update the updated_at column" do
+            expect { Timecop.freeze(Time.now + 5.seconds) { create } }.
+              to_not(change { previous_transition.reload.updated_at })
+          end
+        end
+
+        context "with no updated timestamp column set" do
+          around do |example|
+            MyActiveRecordModelTransition.updated_timestamp_column.tap do |original_value|
+              MyActiveRecordModelTransition.updated_timestamp_column = nil
+              example.run
+              MyActiveRecordModelTransition.updated_timestamp_column = original_value
+            end
+          end
+
+          it "just updates the most_recent" do
+            expect { Timecop.freeze(Time.now + 5.seconds) { create } }.
+              to(change { previous_transition.reload.most_recent })
+          end
+
+          it "doesn't update the updated_at column" do
+            expect { Timecop.freeze(Time.now + 5.seconds) { create } }.
+              to_not(change { previous_transition.reload.updated_at })
+          end
+        end
+
         context "and a query on the parent model's state is made" do
           context "in a before action" do
             it "still has the old state" do

data/spec/support/active_record.rb

@@ -50,7 +50,7 @@ class CreateMyActiveRecordModelMigration < MIGRATION_CLASS
 end
 
 # TODO: make this a module we can extend from the app? Or a generator?
-# rubocop:disable MethodLength
+# rubocop:disable MethodLength, Metrics/AbcSize
 class CreateMyActiveRecordModelTransitionMigration < MIGRATION_CLASS
   def change
     create_table :my_active_record_model_transitions do |t|
@@ -72,6 +72,10 @@ class CreateMyActiveRecordModelTransitionMigration < MIGRATION_CLASS
       end
 
       t.timestamps null: false
+
+      # We'll use this to test customising the updated_timestamp_column setting on the
+      # transition class.
+      t.date :updated_on
     end
 
     add_index :my_active_record_model_transitions,
@@ -94,7 +98,7 @@ class CreateMyActiveRecordModelTransitionMigration < MIGRATION_CLASS
     end
   end
 end
-# rubocop:enable MethodLength
+# rubocop:enable MethodLength, Metrics/AbcSize
 
 class OtherActiveRecordModel < ActiveRecord::Base
   has_many :other_active_record_model_transitions, autosave: false
@@ -206,6 +210,8 @@ module MyNamespace
   end
 
   class MyActiveRecordModelTransition < ActiveRecord::Base
+    include Statesman::Adapters::ActiveRecordTransition
+
     belongs_to :my_active_record_model,
                class_name: "MyNamespace::MyActiveRecordModel"
     serialize :metadata, JSON

data/statesman.gemspec

@@ -23,13 +23,14 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler",               "~> 1.3"
   spec.add_development_dependency "mysql2",                "~> 0.4"
   spec.add_development_dependency "pg",                    "~> 0.18"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rails",                 ">= 3.2"
   spec.add_development_dependency "rake",                  "~> 12.3.0"
   spec.add_development_dependency "rspec",                 "~> 3.1"
   spec.add_development_dependency "rspec-its",             "~> 1.1"
   spec.add_development_dependency "rspec-rails",           "~> 3.1"
   spec.add_development_dependency "rspec_junit_formatter", "~> 0.3.0"
-  spec.add_development_dependency "rubocop",               "~> 0.52.0"
-  spec.add_development_dependency "sqlite3",               "~> 1.3"
-  spec.add_development_dependency "timecop",               "~> 0.9.1"
+  spec.add_development_dependency "rubocop", "~> 0.52.0"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "timecop", "~> 0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-05 00:00:00.000000000 Z
+date: 2018-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ammeter
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -279,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: A statesman-like state machine library