statesman 3.4.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 7aa22275abdc014b0365e925fd1e6def087e00da45d407503807b948900ed786
-  data.tar.gz: 7e7b9319cb03f9d3f718c8bc47efec8dc3626dc197626eec8ff3cacb5cbbac24
+SHA1:
+  metadata.gz: 9fb352daa2f2ec337dd202cc2615a7e0925741a4
+  data.tar.gz: 9de7812c9356e6e9f98a317b503220b3a7f7709b
 SHA512:
-  metadata.gz: 0a6a34ee714a7b860babe30605a362d0081950d8c662b013ed126b89f587fab7778064c4133d362b467d730e6a9513936b0938a436ce49373be725263dbb1f88
-  data.tar.gz: 36496a50080940acd1b97996435b8b3ece3c039140f216db6f1b6fee94d89c843e41e16a0def06b4699412a9c7886bdafe4236142d13a9f6d09aeee51e82f9f5
+  metadata.gz: fbd8b2b4b822b2f7148cb7b47111153e6cd18831e227cf6c72ca073904866025eb3e1d433f503e778853734c0f522e674ad29cad44ec5bc29fdfda7e55130275
+  data.tar.gz: d55e7635f0773babcc1b5ef9da6f75a4144c8812ce305b93e1762e6100e658bd73f2989bb867efcb0be42225f1dfa49a67aeb064c1c287df62720c8afc693d4b

data/.circleci/config.yml

@@ -36,7 +36,7 @@ jobs:
         environment:
           - RAILS_VERSION=4.2.9
           - DATABASE_DEPENDENCY_PORT=27017
-      - image: circleci/mongo:3.0.14
+      - image: circleci/mongo:3
     steps: *steps
   build-ruby241-rails-429-mysql:
     docker:
@@ -72,7 +72,7 @@ jobs:
         environment:
           - RAILS_VERSION=5.0.5
           - DATABASE_DEPENDENCY_PORT=27017
-      - image: circleci/mongo:3.0.14
+      - image: circleci/mongo:3
     steps: *steps
   build-ruby241-rails-505-mysql:
     docker:
@@ -108,7 +108,7 @@ jobs:
         environment:
           - RAILS_VERSION=5.1.3
           - DATABASE_DEPENDENCY_PORT=27017
-      - image: circleci/mongo:3.0.14
+      - image: circleci/mongo:3
     steps: *steps
   build-ruby241-rails-513-mysql:
     docker:
@@ -144,7 +144,7 @@ jobs:
         environment:
           - RAILS_VERSION=4.2.9
           - DATABASE_DEPENDENCY_PORT=27017
-      - image: circleci/mongo:3.0.14
+      - image: circleci/mongo:3
     steps: *steps
   build-ruby233-rails-429-mysql:
     docker:
@@ -180,7 +180,7 @@ jobs:
         environment:
           - RAILS_VERSION=5.0.5
           - DATABASE_DEPENDENCY_PORT=27017
-      - image: circleci/mongo:3.0.14
+      - image: circleci/mongo:3
     steps: *steps
   build-ruby233-rails-505-mysql:
     docker:
@@ -216,7 +216,7 @@ jobs:
         environment:
           - RAILS_VERSION=5.1.3
           - DATABASE_DEPENDENCY_PORT=27017
-      - image: circleci/mongo:3.0.14
+      - image: circleci/mongo:3
     steps: *steps
   build-ruby233-rails-513-mysql:
     docker:
@@ -252,7 +252,7 @@ jobs:
         environment:
           - RAILS_VERSION=4.2.9
           - DATABASE_DEPENDENCY_PORT=27017
-      - image: circleci/mongo:3.0.14
+      - image: circleci/mongo:3
     steps: *steps
   build-ruby227-rails-429-mysql:
     docker:
@@ -288,7 +288,7 @@ jobs:
         environment:
           - RAILS_VERSION=5.0.5
           - DATABASE_DEPENDENCY_PORT=27017
-      - image: circleci/mongo:3.0.14
+      - image: circleci/mongo:3
     steps: *steps
   build-ruby227-rails-505-mysql:
     docker:
@@ -324,7 +324,7 @@ jobs:
         environment:
           - RAILS_VERSION=5.1.3
           - DATABASE_DEPENDENCY_PORT=27017
-      - image: circleci/mongo:3.0.14
+      - image: circleci/mongo:3
     steps: *steps
   build-ruby227-rails-513-mysql:
     docker:

data/.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2017-12-20 11:33:28 +0000 using RuboCop version 0.52.0.
+# on 2018-06-07 12:21:30 +0100 using RuboCop version 0.56.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 5
+# Offense count: 4
 Metrics/AbcSize:
   Max: 18
 
@@ -14,3 +14,68 @@ Metrics/AbcSize:
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
   Max: 14
+
+# Offense count: 7
+# Configuration parameters: Max.
+RSpec/ExampleLength:
+  Exclude:
+    - 'spec/statesman/adapters/active_record_spec.rb'
+    - 'spec/statesman/adapters/shared_examples.rb'
+    - 'spec/statesman/machine_spec.rb'
+
+# Offense count: 7
+RSpec/ExpectInHook:
+  Exclude:
+    - 'spec/statesman/adapters/active_record_spec.rb'
+    - 'spec/statesman/machine_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AssignmentOnly.
+RSpec/InstanceVariable:
+  Exclude:
+    - 'spec/statesman/config_spec.rb'
+
+# Offense count: 1
+RSpec/IteratedExpectation:
+  Exclude:
+    - 'spec/statesman/machine_spec.rb'
+
+# Offense count: 3
+RSpec/LetSetup:
+  Exclude:
+    - 'spec/statesman/adapters/active_record_spec.rb'
+    - 'spec/statesman/adapters/shared_examples.rb'
+
+# Offense count: 1
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  Exclude:
+    - 'spec/statesman/callback_spec.rb'
+
+# Offense count: 9
+# Configuration parameters: AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Max: 3
+
+# Offense count: 50
+RSpec/NestedGroups:
+  Max: 6
+
+# Offense count: 16
+RSpec/ScatteredSetup:
+  Exclude:
+    - 'spec/statesman/adapters/active_record_spec.rb'
+    - 'spec/statesman/adapters/mongoid_spec.rb'
+    - 'spec/statesman/adapters/shared_examples.rb'
+    - 'spec/statesman/machine_spec.rb'
+
+# Offense count: 8
+# Configuration parameters: IgnoreSymbolicNames.
+RSpec/VerifiedDoubles:
+  Exclude:
+    - 'spec/generators/statesman/active_record_transition_generator_spec.rb'
+    - 'spec/generators/statesman/migration_generator_spec.rb'
+    - 'spec/statesman/adapters/active_record_spec.rb'
+    - 'spec/statesman/adapters/mongoid_spec.rb'
+    - 'spec/statesman/adapters/shared_examples.rb'

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v3.5.0, 2 November 2018
+
+- Expose `most_recent_transition_join` - ActiveRecords `or` requires that both
+    sides of the query match up. Exposing this methods makes things easier if
+    one side of the `or` uses `in_state` or `not_in_state`. (patch by [@adambutler](https://github.com/adambutler))
+- Various Readme and CI related changes.
+
 ## 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))

data/Gemfile

@@ -10,7 +10,3 @@ group :development do
   # test/unit is no longer bundled with Ruby 2.2, but required by Rails
   gem "test-unit", "~> 3.0" if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.2.0")
 end
-
-group :development, :test do
-  gem "gc_ruboconfig", "~> 2.1.0"
-end

data/README.md

@@ -5,9 +5,10 @@ A statesmanlike state machine library.
 For our policy on compatibility with Ruby and Rails versions, see [COMPATIBILITY.md](docs/COMPATIBILITY.md).
 
 [![Gem Version](https://badge.fury.io/rb/statesman.svg)](http://badge.fury.io/rb/statesman)
-[![CircleCI](https://circleci.com/gh/gocardless/statesman.svg?style=svg)](https://circleci.com/gh/gocardless/statesman)
+[![CircleCI](https://circleci.com/gh/gocardless/statesman.svg?style=shield)](https://circleci.com/gh/gocardless/statesman)
 [![Code Climate](https://codeclimate.com/github/gocardless/statesman.svg)](https://codeclimate.com/github/gocardless/statesman)
 [![Gitter](https://badges.gitter.im/join.svg)](https://gitter.im/gocardless/statesman?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=statesman&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=statesman&package-manager=bundler&version-scheme=semver)
 
 Statesman is an opinionated state machine library designed to provide a robust
 audit trail and data integrity. It decouples the state machine logic from the
@@ -100,6 +101,8 @@ Next, you'll need to create a further model to represent state transitions:
 class OrderTransition < ActiveRecord::Base
   include Statesman::Adapters::ActiveRecordTransition
 
+  validates :to_state, inclusion: { in: OrderStateMachine.states }
+
   belongs_to :order, inverse_of: :order_transitions
 end
 ```
@@ -371,6 +374,17 @@ 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.
 
+
+### `Model.most_recent_transition_join`
+This joins the model to its most recent transition whatever that may be.
+We expose this method to ease use of ActiveRecord's `or` e.g
+
+```ruby
+Model.in_state(:state_1).or(
+  Model.most_recent_transition_join.where(model_field: 123)
+)
+```
+
 ## Frequently Asked Questions
 
 #### Storing the state on the model object

data/lib/generators/statesman/active_record_transition_generator.rb

@@ -11,7 +11,7 @@ module Statesman
     argument :parent, type: :string, desc: "Your parent model name"
     argument :klass,  type: :string, desc: "Your transition model name"
 
-    source_root File.expand_path("../templates", __FILE__)
+    source_root File.expand_path("templates", __dir__)
 
     def create_model_file
       template("create_migration.rb.erb", migration_file_name)

data/lib/generators/statesman/migration_generator.rb

@@ -11,7 +11,7 @@ module Statesman
     argument :parent, type: :string, desc: "Your parent model name"
     argument :klass, type: :string, desc: "Your transition model name"
 
-    source_root File.expand_path("../templates", __FILE__)
+    source_root File.expand_path("templates", __dir__)
 
     def create_model_file
       template("update_migration.rb.erb", file_name)

data/lib/generators/statesman/mongoid_transition_generator.rb

@@ -10,7 +10,7 @@ module Statesman
     argument :parent, type: :string, desc: "Your parent model name"
     argument :klass, type: :string, desc: "Your transition model name"
 
-    source_root File.expand_path("../templates", __FILE__)
+    source_root File.expand_path("templates", __dir__)
 
     def create_model_file
       template("mongoid_transition_model.rb.erb", model_file_name)

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

@@ -17,13 +17,13 @@ class Create<%= migration_class_name %> < ActiveRecord::Migration<%= "[#{ActiveR
     add_foreign_key :<%= table_name %>, :<%= parent_table_name %>
 
     add_index(:<%= table_name %>,
-              [:<%= parent_id %>, :sort_key],
+              %i(<%= parent_id %> sort_key),
               unique: true,
               name: "<%= index_name :parent_sort %>")
     add_index(:<%= table_name %>,
-              [:<%= parent_id %>, :most_recent],
+              %i(<%= parent_id %> most_recent),
               unique: true,
-              <%= "where: 'most_recent'," if database_supports_partial_indexes? %>
+              <%= 'where: "most_recent",' if database_supports_partial_indexes? %>
               name: "<%= index_name :parent_most_recent %>")
   end
 end

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

@@ -8,7 +8,7 @@ class AddStatesmanTo<%= migration_class_name %> < ActiveRecord::Migration<%= "[#
     add_column :<%= table_name %>, :created_at, :datetime, null: false
     add_column :<%= table_name %>, :updated_at, :datetime, null: false
 
-    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 %>"
+    add_index :<%= table_name %>, %i(<%= parent_id %> sort_key), unique: true, name: "<%= index_name :parent_sort  %>"
+    add_index :<%= table_name %>, %i(<%= parent_id %> most_recent), unique: true, <%= 'where: "most_recent", ' if database_supports_partial_indexes? %>name: "<%= index_name :parent_most_recent %>"
   end
 end

data/lib/statesman/adapters/active_record.rb

@@ -117,9 +117,9 @@ module Statesman
         end
       end
 
-      def transition_conflict_error?(e)
-        e.message.include?(@transition_class.table_name) &&
-          (e.message.include?("sort_key") || e.message.include?("most_recent"))
+      def transition_conflict_error?(err)
+        err.message.include?(@transition_class.table_name) &&
+          (err.message.include?("sort_key") || err.message.include?("most_recent"))
       end
 
       def with_updated_timestamp(params)

data/lib/statesman/adapters/active_record_queries.rb

@@ -21,6 +21,13 @@ module Statesman
                   states)
         end
 
+        def most_recent_transition_join
+          "LEFT OUTER JOIN #{model_table} AS #{most_recent_transition_alias}
+             ON #{table_name}.id =
+                  #{most_recent_transition_alias}.#{model_foreign_key}
+             AND #{most_recent_transition_alias}.most_recent = #{db_true}"
+        end
+
         private
 
         def transition_class
@@ -55,13 +62,6 @@ module Statesman
           transition_reflection.table_name
         end
 
-        def most_recent_transition_join
-          "LEFT OUTER JOIN #{model_table} AS #{most_recent_transition_alias}
-             ON #{table_name}.id =
-                  #{most_recent_transition_alias}.#{model_foreign_key}
-             AND #{most_recent_transition_alias}.most_recent = #{db_true}"
-        end
-
         def states_where(temporary_table_name, states)
           if initial_state.to_s.in?(states.map(&:to_s))
             "#{temporary_table_name}.to_state IN (?) OR " \

data/lib/statesman/adapters/memory.rb

@@ -8,7 +8,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, _opts = {})
         @history = []
         @transition_class = transition_class
         @parent_model = parent_model
@@ -28,7 +28,7 @@ module Statesman
       end
 
       def last(*)
-        @history.sort_by(&:sort_key).last
+        @history.max_by(&:sort_key)
       end
 
       def history(*)

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, _opts = {})
         @transition_class = transition_class
         @parent_model = parent_model
         @observer = observer

data/lib/statesman/config.rb

@@ -12,6 +12,5 @@ module Statesman
     def storage_adapter(adapter_class)
       @adapter_class = adapter_class
     end
-    # rubocop:enable TrivialAccessors
   end
 end

data/lib/statesman/machine.rb

@@ -100,7 +100,7 @@ module Statesman
 
       # Check that the 'from' state is not terminal
       def validate_not_from_terminal_state(from)
-        unless from.nil? || successors.keys.include?(from)
+        unless from.nil? || successors.key?(from)
           raise InvalidTransitionError,
                 "Cannot transition away from terminal state '#{from}'"
         end

data/lib/statesman/version.rb

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

data/spec/generators/statesman/active_record_transition_generator_spec.rb

@@ -8,40 +8,45 @@ describe Statesman::ActiveRecordTransitionGenerator, type: :generator do
   end
 
   describe "creates a migration" do
-    subject { file("db/migrate/#{time}_create_bacon_transitions.rb") }
+    subject(:migration) { file("db/migrate/#{time}_create_bacon_transitions.rb") }
 
-    before { allow(Time).to receive(:now).and_return(mock_time) }
-    before { run_generator %w[Yummy::Bacon Yummy::BaconTransition] }
+    before do
+      allow(Time).to receive(:now).and_return(mock_time)
+      run_generator %w[Yummy::Bacon Yummy::BaconTransition]
+    end
 
     let(:mock_time) { double("Time", utc: double("UTCTime", strftime: time)) }
     let(:time) { "5678309" }
 
     it "includes a foreign key" do
-      expect(subject).to contain("add_foreign_key :bacon_transitions, :bacons")
+      expect(migration).to contain("add_foreign_key :bacon_transitions, :bacons")
     end
   end
 
   describe "properly adds class names" do
-    before { run_generator %w[Yummy::Bacon Yummy::BaconTransition] }
     subject { file("app/models/yummy/bacon_transition.rb") }
 
+    before { run_generator %w[Yummy::Bacon Yummy::BaconTransition] }
+
     it { is_expected.to contain(/:bacon_transition/) }
-    it { is_expected.not_to contain(%r{:yummy/bacon}) }
+    it { is_expected.to_not contain(%r{:yummy/bacon}) }
     it { is_expected.to contain(/class_name: 'Yummy::Bacon'/) }
   end
 
   describe "properly formats without class names" do
-    before { run_generator %w[Bacon BaconTransition] }
     subject { file("app/models/bacon_transition.rb") }
 
-    it { is_expected.not_to contain(/class_name:/) }
+    before { run_generator %w[Bacon BaconTransition] }
+
+    it { is_expected.to_not contain(/class_name:/) }
     it { is_expected.to contain(/class BaconTransition/) }
   end
 
   describe "it doesn't create any double-spacing" do
-    before { run_generator %w[Yummy::Bacon Yummy::BaconTransition] }
     subject { file("app/models/yummy/bacon_transition.rb") }
 
+    before { run_generator %w[Yummy::Bacon Yummy::BaconTransition] }
+
     it { is_expected.to_not contain(/\n\n\n/) }
   end
 end

data/spec/generators/statesman/migration_generator_spec.rb

@@ -8,34 +8,34 @@ describe Statesman::MigrationGenerator, type: :generator do
   end
 
   describe "the model contains the correct words" do
+    subject(:migration) do
+      file(
+        "db/migrate/#{migration_number}_add_statesman_to_bacon_transitions.rb",
+      )
+    end
+
     let(:migration_number) { "5678309" }
 
     let(:mock_time) do
       double("Time", utc: double("UTCTime", strftime: migration_number))
     end
 
-    subject do
-      file(
-        "db/migrate/#{migration_number}_add_statesman_to_bacon_transitions.rb",
-      )
-    end
-
     before do
       allow(Time).to receive(:now).and_return(mock_time)
       run_generator %w[Yummy::Bacon Yummy::BaconTransition]
     end
 
     it { is_expected.to contain(/:bacon_transition/) }
-    it { is_expected.not_to contain(%r{:yummy/bacon}) }
+    it { is_expected.to_not contain(%r{:yummy/bacon}) }
     it { is_expected.to contain(/null: false/) }
 
     it "names the sorting index appropriately" do
-      expect(subject).
+      expect(migration).
         to contain("name: \"index_bacon_transitions_parent_sort\"")
     end
 
     it "names the most_recent index appropriately" do
-      expect(subject).
+      expect(migration).
         to contain("name: \"index_bacon_transitions_parent_most_recent\"")
     end
   end