statesman 3.4.0 → 3.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 171ee6b0234ee7909d9af5b91ee09e8cb397adac1c1e90db5e53b1e08413d137
-  data.tar.gz: fd445775c6f034e067b492e79191803c4b5f48127599e9395374fb7934ea9d8e
+  metadata.gz: 7aa22275abdc014b0365e925fd1e6def087e00da45d407503807b948900ed786
+  data.tar.gz: 7e7b9319cb03f9d3f718c8bc47efec8dc3626dc197626eec8ff3cacb5cbbac24
 SHA512:
-  metadata.gz: 0b88f58d64734af53bbf5155059a5f56ad96578c7d7be57e0f4b52b77bf1f57db6629438d91da1acd5068ea456d16893070555a720e1d153f7b5111cfa2f4ce2
-  data.tar.gz: 3e07fafb2c37ae74a9c60f38ac186110d7f01e2024ff0361948b8dc039e282845748f31737f25a36d228eb8188788f2f7be8db2e1e2d978486e82153c82a7474
+  metadata.gz: 0a6a34ee714a7b860babe30605a362d0081950d8c662b013ed126b89f587fab7778064c4133d362b467d730e6a9513936b0938a436ce49373be725263dbb1f88
+  data.tar.gz: 36496a50080940acd1b97996435b8b3ece3c039140f216db6f1b6fee94d89c843e41e16a0def06b4699412a9c7886bdafe4236142d13a9f6d09aeee51e82f9f5

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v3.4.1, 14 February 2018 ❤️
+
+- Support ActiveRecord transition classes which don't include `Statesman::Adapters::ActiveRecordTransition`, and thus don't have a `.updated_timestamp_column` method (see #310 for further details) (patch by [@timrogers](https://github.com/timrogers))
+
 ## 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))

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.4.0'
+gem 'statesman', '~> 3.4.1'
 ```
 
 ## Usage
@@ -121,7 +121,7 @@ Order.not_in_state(:checking_out) # => [#<Order id: "123">]
 
 By default Statesman stores transition history in memory only. It can be
 persisted by configuring Statesman to use a different adapter. For example,
-ActiveRecord within Rails:
+for ActiveRecord within Rails:
 
 `config/initializers/statesman.rb`:
 
@@ -137,6 +137,10 @@ Generate the transition model:
 $ rails g statesman:active_record_transition Order OrderTransition
 ```
 
+Your transition class should
+`include Statesman::Adapters::ActiveRecordTransition` if you're using the
+ActiveRecord adapter.
+
 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
@@ -178,8 +182,12 @@ or 5. To do that
   t.json :metadata, default: {}
   ```
 
-* Remove `include Statesman::Adapters::ActiveRecordTransition` statement from your
-  transition model
+* Remove the `include Statesman::Adapters::ActiveRecordTransition` statement from
+  your transition model. (If you want to customise your transition class's "updated
+  timestamp column", as described above, you should define a
+  `.updated_timestamp_column` method on your class and return the name of the column
+  as a symbol, or `nil` if you don't want to record an updated timestamp on
+  transitions.)
 
 ## Configuration
 

data/lib/statesman/adapters/active_record.rb

@@ -123,7 +123,20 @@ module Statesman
       end
 
       def with_updated_timestamp(params)
-        return params if @transition_class.updated_timestamp_column.nil?
+        # TODO: Once we've set expectations that transition classes should conform to
+        # the interface of Adapters::ActiveRecordTransition as a breaking change in the
+        # next major version, we can stop calling `#respond_to?` first and instead
+        # assume that there is a `.updated_timestamp_column` method we can call.
+        #
+        # At the moment, most transition classes will include the module, but not all,
+        # not least because it doesn't work with PostgreSQL JSON columns for metadata.
+        column = if @transition_class.respond_to?(:updated_timestamp_column)
+                   @transition_class.updated_timestamp_column
+                 else
+                   ActiveRecordTransition::DEFAULT_UPDATED_TIMESTAMP_COLUMN
+                 end
+
+        return params if column.nil?
 
         timestamp = if ::ActiveRecord::Base.default_timezone == :utc
                       Time.now.utc
@@ -131,7 +144,7 @@ module Statesman
                       Time.now
                     end
 
-        params.merge(@transition_class.updated_timestamp_column => timestamp)
+        params.merge(column => timestamp)
       end
     end
   end

data/lib/statesman/version.rb

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

data/spec/statesman/adapters/active_record_spec.rb

@@ -163,6 +163,19 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
             to(change { previous_transition.reload.updated_at })
         end
 
+        context "for a transition class without an updated timestamp column attribute" do
+          let!(:adapter) do
+            described_class.new(MyActiveRecordModelTransitionWithoutInclude,
+                                model,
+                                observer)
+          end
+
+          it "defaults to touching the previous transition's updated_at timestamp" do
+            expect { Timecop.freeze(Time.now + 5.seconds) { create } }.
+              to(change { previous_transition.reload.updated_at })
+          end
+        end
+
         context "with a custom updated timestamp column set" do
           around do |example|
             MyActiveRecordModelTransition.updated_timestamp_column.tap do |original_value|

data/spec/support/active_record.rb

@@ -40,6 +40,13 @@ class MyActiveRecordModelTransition < ActiveRecord::Base
   serialize :metadata, JSON
 end
 
+class MyActiveRecordModelTransitionWithoutInclude < ActiveRecord::Base
+  self.table_name = "my_active_record_model_transitions"
+
+  belongs_to :my_active_record_model
+  serialize :metadata, JSON
+end
+
 class CreateMyActiveRecordModelMigration < MIGRATION_CLASS
   def change
     create_table :my_active_record_models do |t|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.4.1
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-12 00:00:00.000000000 Z
+date: 2018-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ammeter