statesman 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4180ca332c6a592c0e0816d6b4f718aaf4fa423
-  data.tar.gz: a61d0a4cd39ed4712092855d61a8ec06bf2e0cbb
+  metadata.gz: 776828e7a0c09b55f59d7b9efe5709f1ab3b95e8
+  data.tar.gz: 8c95a4d4af92bf1a64f3f02fd3715b4a6816358b
 SHA512:
-  metadata.gz: 2105f8a7709db6abdb666ea0a8f3ba8778170fa59bf8f6f2f845d2f8456896ee4088f2a44e1be83e90b758bd4b0f49b1eee78048a8230b6581011dae10b7ca3b
-  data.tar.gz: f8395d6ce314a2ff1411ede761211029f95f9c32cc0c54948f534f334f98df64bea193472464ab1187099f1b9064551c4d05add078619fdec653099ad5470cd8
+  metadata.gz: 0fe311fde00f43e4dfe1ebe1ba0eb74262e2d6b916ec0eb4560ca54f268c58534e2384af7a0164921b4270f4c19816e4bda34e4cfac8b7fbac5e8d5a689286a5
+  data.tar.gz: c5c6ae72993e773438e3e620c2b8c4439fabb172bd0af19566cfb822f7d3c56da9f1652d48f929420cc7b5dd681779c107457d8087ceec9889d6a15fc4940e56

data/.travis.yml

@@ -1,15 +1,24 @@
 language: ruby
 
+cache: bundler
+
 rvm:
-  - 2.3.0
-  - 2.2.4
-  - 2.1
-  - 2.0.0
+  - 2.4.1
+  - 2.3.3
+  - 2.2.6
 
 sudo: false
 
 services: mongodb
 
+before_install:
+ - gem update --system
+ - gem install bundler
+
+branches:
+  only:
+    - "master"
+
 before_script:
   - mysql -e 'CREATE DATABASE statesman_test;'
   - psql -c 'CREATE DATABASE statesman_test;' -U postgres
@@ -19,17 +28,10 @@ script:
   - bundle exec rake
 
 env:
-  - "RAILS_VERSION=3.2.21"
-  - "RAILS_VERSION=4.0.13"
-  - "RAILS_VERSION=4.1.14"
-  - "RAILS_VERSION=4.2.5"
-  - "RAILS_VERSION=4.2.5 DATABASE_URL=mysql2://root@localhost/statesman_test"
-  - "RAILS_VERSION=4.2.5 DATABASE_URL=postgres://postgres@localhost/statesman_test"
-  - "RAILS_VERSION=5.0.0.beta3 EXCLUDE_MONGOID=true"
+  - "RAILS_VERSION=4.2.8"
+  - "RAILS_VERSION=4.2.8 DATABASE_URL=mysql2://root@localhost/statesman_test"
+  - "RAILS_VERSION=4.2.8 DATABASE_URL=postgres://postgres@localhost/statesman_test"
+  - "RAILS_VERSION=5.0.0 EXCLUDE_MONGOID=true"
 
 matrix:
-  exclude:
-    - rvm: 2.1
-      env: "RAILS_VERSION=5.0.0.beta3 EXCLUDE_MONGOID=true"
-    - rvm: 2.0.0
-      env: "RAILS_VERSION=5.0.0.beta3 EXCLUDE_MONGOID=true"
+  exclude: []

data/CHANGELOG.md

@@ -1,8 +1,22 @@
+## v3.0.0, 3 July 2017
+
+*Breaking changes*
+
+- Drop support for Rails < 4.2
+- Drop support for Ruby < 2.2
+
+For details on our compatibility policy, see `docs/COMPATIBILITY.md`.
+
+*Changes*
+
+- Better handling of custom transition association names (patch by [@greysteil](https://github.com/greysteil))
+- Add foreign keys to transition table generator (patch by [@greysteil](https://github.com/greysteil))
+- Support partial indexes in transition table update generator (patch by [@kenchan0130](https://github.com/kenchan0130))
+
 ## v2.0.1, 29 March 2016
 
 - Add support for Rails 5 (excluding Mongoid adapter)
 
-
 ## v2.0.0, 5 January 2016
 
 - No changes from v2.0.0.rc1

data/README.md

@@ -1,11 +1,13 @@
 ![Statesman](http://f.cl.ly/items/410n2A0S3l1W0i3i0o2K/statesman.png)
 
-A statesmanlike state machine library for Ruby 2.0.0 and up.
+A statesmanlike state machine library.
 
-[![Gem Version](https://badge.fury.io/rb/statesman.png)](http://badge.fury.io/rb/statesman)
-[![Build Status](https://travis-ci.org/gocardless/statesman.png?branch=master)](https://travis-ci.org/gocardless/statesman)
-[![Code Climate](https://codeclimate.com/github/gocardless/statesman.png)](https://codeclimate.com/github/gocardless/statesman)
-[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/gocardless/statesman?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+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)
+[![Build Status](https://travis-ci.org/gocardless/statesman.svg?branch=master)](https://travis-ci.org/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)
 
 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
@@ -77,7 +79,6 @@ class Order < ActiveRecord::Base
   def self.transition_class
     OrderTransition
   end
-  private_class_method :transition_class
 
   def self.initial_state
     :pending
@@ -150,15 +151,18 @@ end
 #### Using PostgreSQL JSON column
 
 By default, Statesman uses `serialize` to store the metadata in JSON format.
-It is also possible to use the PostgreSQL JSON column if you are using Rails 4. To do that
+It is also possible to use the PostgreSQL JSON column if you are using Rails 4
+or 5. To do that
 
-* Change `metadata` column type in the transition model migration to `json`
+* Change `metadata` column type in the transition model migration to `json` or `jsonb`
 
   ```ruby
   # Before
   t.text :metadata, default: "{}"
-  # After
+  # After (Rails 4)
   t.json :metadata, default: "{}"
+  # After (Rails 5)
+  t.json :metadata, default: {}
   ```
 
 * Remove `include Statesman::Adapters::ActiveRecordTransition` statement from your
@@ -316,7 +320,6 @@ class Order < ActiveRecord::Base
   def self.transition_class
     OrderTransition
   end
-  private_class_method :transition_class
 
   def self.initial_state
     OrderStateMachine.initial_state
@@ -409,6 +412,10 @@ describe "some callback" do
 end
 ```
 
+# Third-party extensions
+
+[statesman-sequel](https://github.com/badosu/statesman-sequel) - An adapter to make Statesman work with [Sequel](https://github.com/jeremyevans/sequel)
+
 ---
 
-GoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/jobs#software-engineer).
+GoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/about/jobs/software-engineer).

data/docs/COMPATIBILITY.md

@@ -0,0 +1,17 @@
+# Compatibility
+
+Our goal as Statesman maintainers is for the library to be compatible with all supported versions of Ruby and Rails.
+
+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.
+
+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).
+
+# Deprecation
+
+Whenever a version of Ruby or Rails falls out of support, we will mirror that change in Statesman by updating the build matrix and releasing a new major version.
+
+At that point, we will close any issues that only affect the unsupported version, and may choose to remove any workarounds from the code that are only necessary for the unsupported version.
+
+We will then bump the major version of Statesman, to indicate the break in compatibility. Even if the new version of Statesman happens to work on the unsupported version of Ruby or Rails, we consider compatibility to be broken at this point.

data/lib/generators/statesman/active_record_transition_generator.rb

@@ -24,7 +24,7 @@ module Statesman
       "db/migrate/#{next_migration_number}_create_#{table_name}.rb"
     end
 
-    def rails_4?
+    def rails_4_or_higher?
       Rails.version.split(".").map(&:to_i).first >= 4
     end
   end

data/lib/generators/statesman/generator_helpers.rb

@@ -20,6 +20,10 @@ module Statesman
       parent.demodulize.underscore
     end
 
+    def parent_table_name
+      parent.demodulize.underscore.pluralize
+    end
+
     def parent_id
       parent_name + "_id"
     end

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

@@ -1,9 +1,10 @@
 class <%= klass %> < ActiveRecord::Base
   include Statesman::Adapters::ActiveRecordTransition
 
-<% unless rails_4? %>
+<%- unless rails_4_or_higher? -%>
   attr_accessible :to_state, :metadata, :sort_key
-<% end %>
+
+<%- end -%>
   belongs_to :<%= parent_name %><%= class_name_option %>, inverse_of: :<%= table_name %>
 
   after_destroy :update_most_recent, if: :most_recent?

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

@@ -9,6 +9,9 @@ class Create<%= migration_class_name %> < ActiveRecord::Migration
       t.timestamps null: false
     end
 
+    # Foreign keys are optional, but highly recommended
+    add_foreign_key :<%= table_name %>, :<%= parent_table_name %>
+
     add_index(:<%= table_name %>,
               [:<%= parent_id %>, :sort_key],
               unique: true,

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

@@ -9,6 +9,6 @@ class AddStatesmanTo<%= migration_class_name %> < ActiveRecord::Migration
     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", name: "<%= index_name :parent_most_recent %>"
+    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/statesman/adapters/active_record_queries.rb

@@ -38,7 +38,13 @@ module Statesman
         end
 
         def transition_reflection
-          reflect_on_association(transition_name)
+          reflect_on_all_associations(:has_many).each do |value|
+            return value if value.klass == transition_class
+          end
+
+          raise MissingTransitionAssociation,
+                "Could not find has_many association between #{self.class} " \
+                "and #{transition_class}."
         end
 
         def model_foreign_key

data/lib/statesman/exceptions.rb

@@ -5,6 +5,7 @@ module Statesman
   class GuardFailedError < StandardError; end
   class TransitionFailedError < StandardError; end
   class TransitionConflictError < StandardError; end
+  class MissingTransitionAssociation < StandardError; end
 
   class UnserializedMetadataError < StandardError
     def initialize(transition_class_name)

data/lib/statesman/version.rb

@@ -1,3 +1,3 @@
 module Statesman
-  VERSION = "2.0.1"
+  VERSION = "3.0.0"
 end

data/spec/generators/statesman/active_record_transition_generator_spec.rb

@@ -7,6 +7,20 @@ describe Statesman::ActiveRecordTransitionGenerator, type: :generator do
     let(:migration_name) { 'db/migrate/create_bacon_transitions.rb' }
   end
 
+  describe 'creates a migration' do
+    subject { 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) }
+
+    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")
+    end
+  end
+
   describe 'properly adds class names' do
     before { run_generator %w(Yummy::Bacon Yummy::BaconTransition) }
     subject { file('app/models/yummy/bacon_transition.rb') }
@@ -23,4 +37,11 @@ describe Statesman::ActiveRecordTransitionGenerator, type: :generator do
     it { is_expected.not_to 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') }
+
+    it { is_expected.to_not contain(/\n\n\n/) }
+  end
 end

data/spec/statesman/adapters/active_record_queries_spec.rb

@@ -125,14 +125,18 @@ describe Statesman::Adapters::ActiveRecordQueries, active_record: true do
     end
   end
 
-  context "with a transition name" do
+  context "with a custom name for the transition association" do
     before do
+      # Switch to using OtherActiveRecordModelTransition, so the existing
+      # relation with MyActiveRecordModelTransition doesn't interfere with
+      # this spec.
       MyActiveRecordModel.send(:has_many,
                                :custom_name,
-                               class_name: 'MyActiveRecordModelTransition')
+                               class_name: 'OtherActiveRecordModelTransition')
+
       MyActiveRecordModel.class_eval do
-        def self.transition_name
-          :custom_name
+        def self.transition_class
+          OtherActiveRecordModelTransition
         end
       end
     end
@@ -142,4 +146,24 @@ describe Statesman::Adapters::ActiveRecordQueries, active_record: true do
       specify { expect { query }.to_not raise_error }
     end
   end
+
+  context "with no association with the transition class" do
+    before do
+      class UnknownModelTransition < OtherActiveRecordModelTransition; end
+
+      MyActiveRecordModel.class_eval do
+        def self.transition_class
+          UnknownModelTransition
+        end
+      end
+    end
+
+    describe ".in_state" do
+      subject(:query) { MyActiveRecordModel.in_state(:succeeded) }
+
+      it "raises a helpful error" do
+        expect { query }.to raise_error(Statesman::MissingTransitionAssociation)
+      end
+    end
+  end
 end

data/spec/support/active_record.rb

@@ -187,7 +187,7 @@ module MyNamespace
 
     def state_machine
       @state_machine ||= MyStateMachine.new(
-        self, transition_class: MyNameSpace::MyActiveRecordModelTransition,
+        self, transition_class: MyNamespace::MyActiveRecordModelTransition,
               association_name: :my_active_record_model_transitions)
     end
 

data/statesman.gemspec

@@ -18,14 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = '>= 2.2'
   spec.add_development_dependency "bundler",       "~> 1.3"
   spec.add_development_dependency "rake"
   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 "guard-rspec",   "~> 4.3"
   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 "rails",         ">= 3.2"
   spec.add_development_dependency "pg",            "~> 0.18"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Harry Marr
@@ -9,188 +9,160 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2017-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.30.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.30.0
-- !ruby/object:Gem::Dependency
-  name: guard-rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.18'
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
 - !ruby/object:Gem::Dependency
   name: ammeter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.1'
 description: A statesmanlike state machine library
@@ -200,9 +172,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -210,6 +182,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- docs/COMPATIBILITY.md
 - lib/generators/statesman/active_record_transition_generator.rb
 - lib/generators/statesman/generator_helpers.rb
 - lib/generators/statesman/migration_generator.rb
@@ -266,17 +239,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A statesmanlike state machine library