statesman 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9dde77bdcc9a2b9cde16e90f5d00e82a30d1efc7
-  data.tar.gz: '0927b94d3a461059051083ae3d62b6df62f07658'
+  metadata.gz: 32bb973d8f35e81d00d5f6424d26dfb7af6f101b
+  data.tar.gz: 2cfacba286b5a45f15f784cf94a91cd2abc34cc7
 SHA512:
-  metadata.gz: f479c08a14edf813e36a035ffb3db9f1985ddffad74eebd6a9ff9ffa41b4a3bcc16d27f43f1048690f0b93acc4b286cf75184059903c5722d333a7bac0839c42
-  data.tar.gz: 210f9b2ceb2d079bb40540b4a68765397df10e31795e71edbe9204a413b9839b6ce2eecd1f335ef65258bcd2ffc58d4ed1bf42cf83ac71d6275da222a8e91367
+  metadata.gz: d2cd17ce3c5cb346912126ff09bb0048647347495bbd21ddb5fd4beaa36225189daae1cd6ca5c6df69bd78f247240e6d03b9c16cb8625b49713b4e4a3b4319f8
+  data.tar.gz: b8e32db8300886d2db38d7a6e8ef00666f7d7ad018b1a04e89c4bd40a8a0cabb415eed02019b3c7745a4bcc5572d6876f7d932990632bb4c50e21bcfdcfd7599

data/.rubocop.yml

@@ -1,13 +1,9 @@
-# For all options see https://github.com/bbatsov/rubocop/tree/master/config
-
 inherit_from: .rubocop_todo.yml
+inherit_gem:
+  ruboconfig: rubocop.yml
 
 AllCops:
   DisplayCopNames: true
-  Include:
-    - Rakefile
-    - statesman.gemfile
-    - lib/tasks/*.rake
   Exclude:
     - vendor/**/*
     - .*/**
@@ -16,45 +12,19 @@ AllCops:
 StringLiterals:
   Enabled: false
 
-Documentation:
-  Enabled: false
-
-SignalException:
-  EnforcedStyle: only_raise
-
-# Avoid methods longer than 15 lines of code
 MethodLength:
   CountComments: false
   Max: 15
 
 AbcSize:
-  Max: 25
-
-# Don't require utf-8 encoding comment
-Encoding:
-  Enabled: false
+  Max: 18
 
 LineLength:
   Max: 80
 
-GuardClause:
-  Enabled: false
-
-Layout/SpaceBeforeFirstArg:
-  Enabled: false
-
-DotPosition:
-  EnforcedStyle: trailing
-
 # Allow class and message or instance raises
 Style/RaiseArgs:
   Enabled: false
 
-Metrics/BlockLength:
-  Exclude:
-    - spec/**/*
-
-Style/FileName:
-  Exclude:
-    - Gemfile
-    - Guardfile
+Lint/RescueWithoutErrorClass:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+
+## v3.2.0, 27 November 2017
+
+- Allow specifying metadata with `Machine#allowed_transitions` (patch by [@vvondra](https://github.com/vvondra))
+
 ## v3.1.0, 1 September 2017
 
 - Add support for Rails 5.0.x and 5.1.x (patch by [@kenchan0130](https://github.com/kenchan0130) and [@timrogers](https://github.com/timrogers))

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem "rails", "~> #{ENV['RAILS_VERSION']}" if ENV["RAILS_VERSION"]
+gem "ruboconfig", git: "https://github.com/gocardless/ruboconfig", tag: "v1.0.1"
 
 group :development do
   gem "mongoid", ">= 3.1" unless ENV["EXCLUDE_MONGOID"]

data/README.md

@@ -102,6 +102,7 @@ class OrderTransition < ActiveRecord::Base
 
   belongs_to :order, inverse_of: :order_transitions
 end
+```
 
 Now, you can start working with your state machine:
 

data/docs/COMPATIBILITY.md

@@ -4,7 +4,7 @@ Our goal as Statesman maintainers is for the library to be compatible with all s
 
 Specifically, any CRuby/MRI version that has not received an End of Life notice ([e.g. this notice for Ruby 2.1](https://www.ruby-lang.org/en/news/2017/04/01/support-of-ruby-2-1-has-ended/)) is supported. Similarly, any version of Rails listed as currently supported on [this page](http://guides.rubyonrails.org/maintenance_policy.html) is one we aim to support in Statesman.
 
-To that end, [our build matrix](../.travis.yml) includes all these versions.
+To that end, [our build matrix](../.circleci/config.yml) includes all these versions.
 
 Any time Statesman doesn't work on a supported combination of Ruby and Rails, it's a bug, and can be reported [here](https://github.com/gocardless/statesman/issues).
 

data/lib/statesman/adapters/active_record.rb

@@ -107,7 +107,7 @@ module Statesman
 
       def serialized?(transition_class)
         if ::ActiveRecord.respond_to?(:gem_version) &&
-           ::ActiveRecord.gem_version >= Gem::Version.new('4.2.0.a')
+            ::ActiveRecord.gem_version >= Gem::Version.new('4.2.0.a')
           transition_class.type_for_attribute("metadata").
             is_a?(::ActiveRecord::Type::Serialized)
         else

data/lib/statesman/machine.rb

@@ -49,7 +49,7 @@ module Statesman
           before:       [],
           after:        [],
           after_commit: [],
-          guards:       []
+          guards:       [],
         }
       end
 
@@ -170,7 +170,7 @@ module Statesman
 
     def initialize(object,
                    options = {
-                     transition_class: Statesman::Adapters::MemoryTransition
+                     transition_class: Statesman::Adapters::MemoryTransition,
                    })
       @object = object
       @transition_class = options[:transition_class]
@@ -189,9 +189,9 @@ module Statesman
       states.flatten.any? { |state| current_state == state.to_s }
     end
 
-    def allowed_transitions
+    def allowed_transitions(metadata = {})
       successors_for(current_state).select do |state|
-        can_transition_to?(state)
+        can_transition_to?(state, metadata)
       end
     end
 

data/lib/statesman/version.rb

@@ -1,3 +1,3 @@
 module Statesman
-  VERSION = "3.1.0".freeze
+  VERSION = "3.2.0".freeze
 end

data/lib/tasks/statesman.rake

@@ -29,20 +29,20 @@ namespace :statesman do
         subsequent_t = initial_t.alias
 
         later_row_for_same_parent = initial_t[parent_fk].
-                                    eq(subsequent_t[parent_fk]).
-                                    and(initial_t[:sort_key].
+          eq(subsequent_t[parent_fk]).
+          and(initial_t[:sort_key].
                                     lt(subsequent_t[:sort_key]))
 
         no_later_row = subsequent_t[:id].eq(nil)
         in_current_parent_batch = initial_t[parent_fk].in(models.map(&:id))
 
         latest_ids_query = initial_t.join(subsequent_t, Arel::Nodes::OuterJoin).
-                           on(later_row_for_same_parent).
-                           where(no_later_row.and(in_current_parent_batch)).
-                           project(initial_t[:id]).to_sql
+          on(later_row_for_same_parent).
+          where(no_later_row.and(in_current_parent_batch)).
+          project(initial_t[:id]).to_sql
 
         latest_ids = transition_class.find_by_sql(latest_ids_query).
-                     to_a.collect(&:id)
+          to_a.collect(&:id)
 
         transition_class.where(id: latest_ids).update_all(most_recent: true)
       end

data/spec/generators/statesman/migration_generator_spec.rb

@@ -16,7 +16,7 @@ describe Statesman::MigrationGenerator, type: :generator do
 
     subject do
       file(
-        "db/migrate/#{migration_number}_add_statesman_to_bacon_transitions.rb"
+        "db/migrate/#{migration_number}_add_statesman_to_bacon_transitions.rb",
       )
     end
 

data/spec/statesman/adapters/active_record_spec.rb

@@ -21,7 +21,7 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
         allow(MyActiveRecordModelTransition).to receive_messages(columns_hash:
                                            { 'metadata' => metadata_column })
         if ::ActiveRecord.respond_to?(:gem_version) &&
-           ::ActiveRecord.gem_version >= Gem::Version.new('4.2.0.a')
+            ::ActiveRecord.gem_version >= Gem::Version.new('4.2.0.a')
           expect(MyActiveRecordModelTransition).
             to receive(:type_for_attribute).with("metadata").
             and_return(ActiveRecord::Type::Value.new)
@@ -46,7 +46,7 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
         allow(MyActiveRecordModelTransition).to receive_messages(columns_hash:
                                            { 'metadata' => metadata_column })
         if ::ActiveRecord.respond_to?(:gem_version) &&
-           ::ActiveRecord.gem_version >= Gem::Version.new('4.2.0.a')
+            ::ActiveRecord.gem_version >= Gem::Version.new('4.2.0.a')
           serialized_type = ::ActiveRecord::Type::Serialized.new(
             '', ::ActiveRecord::Coders::JSON
           )
@@ -74,7 +74,7 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
         allow(MyActiveRecordModelTransition).to receive_messages(columns_hash:
                                            { 'metadata' => metadata_column })
         if ::ActiveRecord.respond_to?(:gem_version) &&
-           ::ActiveRecord.gem_version >= Gem::Version.new('4.2.0.a')
+            ::ActiveRecord.gem_version >= Gem::Version.new('4.2.0.a')
           serialized_type = ::ActiveRecord::Type::Serialized.new(
             '', ::ActiveRecord::Coders::JSON
           )
@@ -125,7 +125,7 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
       context "ActiveRecord::RecordNotUnique unrelated to this transition" do
         let(:error) do
           if ::ActiveRecord.respond_to?(:gem_version) &&
-             ::ActiveRecord.gem_version >= Gem::Version.new('4.0.0')
+              ::ActiveRecord.gem_version >= Gem::Version.new('4.0.0')
             ActiveRecord::RecordNotUnique.new("unrelated")
           else
             ActiveRecord::RecordNotUnique.new("unrelated", nil)
@@ -163,7 +163,7 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
               allow(observer).to receive(:execute) do |phase|
                 next unless phase == :before
                 expect(
-                  model.transitions.where(most_recent: true).first.to_state
+                  model.transitions.where(most_recent: true).first.to_state,
                 ).to eq("y")
               end
 
@@ -176,7 +176,7 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
               allow(observer).to receive(:execute) do |phase|
                 next unless phase == :after
                 expect(
-                  model.transitions.where(most_recent: true).first.to_state
+                  model.transitions.where(most_recent: true).first.to_state,
                 ).to eq("z")
               end
 

data/spec/statesman/machine_spec.rb

@@ -441,7 +441,8 @@ describe Statesman::Machine do
     end
 
     let(:instance) { machine.new(my_model) }
-    subject { instance.allowed_transitions }
+    let(:metadata) { { some: :metadata } }
+    subject { instance.allowed_transitions(metadata) }
 
     context "with multiple possible states" do
       it { is_expected.to eq(%w[y z]) }
@@ -450,6 +451,26 @@ describe Statesman::Machine do
     context "with one possible state" do
       before { instance.transition_to!(:y) }
       it { is_expected.to eq(['z']) }
+
+      context "guarded using metadata" do
+        before do
+          machine.guard_transition(to: :z) do |_, _, metadata|
+            metadata[:some] == :metadata
+          end
+        end
+
+        it { is_expected.to eq(['z']) }
+      end
+
+      context "excluded by guard using metadata" do
+        before do
+          machine.guard_transition(to: :z) do |_, _, metadata|
+            metadata[:some] != :metadata
+          end
+        end
+
+        it { is_expected.to eq([]) }
+      end
     end
 
     context "with no possible transitions" do
@@ -481,7 +502,8 @@ describe Statesman::Machine do
     end
 
     let(:instance) { machine.new(my_model) }
-    subject { instance.can_transition_to?(new_state) }
+    let(:metadata) { { some: :metadata } }
+    subject { instance.can_transition_to?(new_state, metadata) }
 
     context "when the transition is invalid" do
       context "with an initial to state" do
@@ -515,6 +537,26 @@ describe Statesman::Machine do
         before { machine.guard_transition(to: :y) { false } }
         it { is_expected.to be_falsey }
       end
+
+      context "but it has a failing guard based on metadata" do
+        before do
+          machine.guard_transition(to: :y) do |_, _, metadata|
+            metadata[:some] != :metadata
+          end
+        end
+
+        it { is_expected.to be_falsey }
+      end
+
+      context "and has a passing guard based on metadata" do
+        before do
+          machine.guard_transition(to: :y) do |_, _, metadata|
+            metadata[:some] == :metadata
+          end
+        end
+
+        it { is_expected.to be_truthy }
+      end
     end
   end
 

data/spec/support/active_record.rb

@@ -20,7 +20,7 @@ end
 
 class MyActiveRecordModel < ActiveRecord::Base
   has_many :my_active_record_model_transitions, autosave: false
-  alias transitions my_active_record_model_transitions
+  alias_method :transitions, :my_active_record_model_transitions
 
   def state_machine
     @state_machine ||= MyStateMachine.new(
@@ -98,7 +98,7 @@ end
 
 class OtherActiveRecordModel < ActiveRecord::Base
   has_many :other_active_record_model_transitions, autosave: false
-  alias transitions other_active_record_model_transitions
+  alias_method :transitions, :other_active_record_model_transitions
 
   def state_machine
     @state_machine ||= MyStateMachine.new(

data/statesman.gemspec

@@ -1,5 +1,3 @@
-# coding: utf-8
-
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'statesman/version'
@@ -21,16 +19,16 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.2'
 
+  spec.add_development_dependency "ammeter",               "~> 1.1"
   spec.add_development_dependency "bundler",               "~> 1.3"
-  spec.add_development_dependency "rake",                  "~> 12.0.0"
+  spec.add_development_dependency "mysql2",                "~> 0.4"
+  spec.add_development_dependency "pg",                    "~> 0.18"
+  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-rails",           "~> 3.1"
   spec.add_development_dependency "rspec-its",             "~> 1.1"
-  spec.add_development_dependency "rubocop",               "~> 0.49.1"
-  spec.add_development_dependency "sqlite3",               "~> 1.3"
-  spec.add_development_dependency "rails",                 ">= 3.2"
-  spec.add_development_dependency "pg",                    "~> 0.18"
-  spec.add_development_dependency "mysql2",                "~> 0.4"
-  spec.add_development_dependency "ammeter",               "~> 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.51.0"
+  spec.add_development_dependency "sqlite3",               "~> 1.3"
 end

metadata

@@ -1,183 +1,183 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-01 00:00:00.000000000 Z
+date: 2017-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: ammeter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.0.0
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 12.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.49.1
+        version: 12.3.0
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: mysql2
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: ammeter
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.51.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 0.51.0
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: '1.3'
 description: A statesman-like state machine library
 email:
 - developers@gocardless.com