statesman 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 61f598e4190a05d2e32ef11247ede6d8e4688aa4
-  data.tar.gz: c15948c3ca18fc6b5ccf5aee6780cddff80c8893
+  metadata.gz: e4180ca332c6a592c0e0816d6b4f718aaf4fa423
+  data.tar.gz: a61d0a4cd39ed4712092855d61a8ec06bf2e0cbb
 SHA512:
-  metadata.gz: 8720300f61e6dc672a0c8f96c650f08d387975402f12c10fd7c05deba610a1b9624084bf127a5729a32f98bd188aecf448e341bb4b281debfdda77b2e5cc8462
-  data.tar.gz: 6d51847d3d1a3a85cec09e3c7a23ff98c432e4acd7d670bb35d56d5051997aad2c8014474ce98f1848151b0c4a281a19b6af9d1c78d79b73170009d17ebec7c3
+  metadata.gz: 2105f8a7709db6abdb666ea0a8f3ba8778170fa59bf8f6f2f845d2f8456896ee4088f2a44e1be83e90b758bd4b0f49b1eee78048a8230b6581011dae10b7ca3b
+  data.tar.gz: f8395d6ce314a2ff1411ede761211029f95f9c32cc0c54948f534f334f98df64bea193472464ab1187099f1b9064551c4d05add078619fdec653099ad5470cd8

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 
 rvm:
   - 2.3.0
-  - 2.2
+  - 2.2.4
   - 2.1
   - 2.0.0
 
@@ -21,7 +21,15 @@ script:
 env:
   - "RAILS_VERSION=3.2.21"
   - "RAILS_VERSION=4.0.13"
-  - "RAILS_VERSION=4.1.10"
-  - "RAILS_VERSION=4.2.2"
-  - "RAILS_VERSION=4.2.2 DATABASE_URL=mysql2://root@localhost/statesman_test"
-  - "RAILS_VERSION=4.2.2 DATABASE_URL=postgres://postgres@localhost/statesman_test"
+  - "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"
+
+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"

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 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/Gemfile

@@ -4,7 +4,11 @@ gemspec
 
 gem "rails", "~> #{ENV["RAILS_VERSION"]}" if ENV["RAILS_VERSION"]
 
-# test/unit is no longer bundled with Ruby 2.2, but required by Rails
-if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.2.0")
-  gem "test-unit", "~> 3.0"
+group :development do
+  gem "mongoid", ">= 3.1" unless ENV["EXCLUDE_MONGOID"]
+
+  # test/unit is no longer bundled with Ruby 2.2, but required by Rails
+  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.2.0")
+    gem "test-unit", "~> 3.0"
+  end
 end

data/README.md

@@ -19,7 +19,7 @@ to which they should apply.
 - State transitions are also modelled as a class, which can optionally be
 persisted to the database for a full audit history. This audit history can
 include JSON metadata set during a transition.
-- Database indicies are used to offer database-level transaction duplication
+- Database indices are used to offer database-level transaction duplication
 protection.
 
 ## TL;DR Usage
@@ -74,15 +74,15 @@ class Order < ActiveRecord::Base
     @state_machine ||= OrderStateMachine.new(self, transition_class: OrderTransition)
   end
 
-  private
-
   def self.transition_class
     OrderTransition
   end
+  private_class_method :transition_class
 
   def self.initial_state
     :pending
   end
+  private_class_method :initial_state
 end
 
 ####################
@@ -290,15 +290,15 @@ model and define `transition_class` and `initial_state` class methods:
 class Order < ActiveRecord::Base
   include Statesman::Adapters::ActiveRecordQueries
 
-  private
-
   def self.transition_class
     OrderTransition
   end
+  private_class_method :transition_class
 
   def self.initial_state
     OrderStateMachine.initial_state
   end
+  private_class_method :initial_state
 end
 ```
 
@@ -309,8 +309,6 @@ need to define a corresponding `transition_name` class method:
 class Order < ActiveRecord::Base
   has_many :transitions, class_name: "OrderTransition", autosave: false
 
-  private
-
   def self.transition_name
     :transitions
   end
@@ -318,10 +316,12 @@ class Order < ActiveRecord::Base
   def self.transition_class
     OrderTransition
   end
+  private_class_method :transition_class
 
   def self.initial_state
     OrderStateMachine.initial_state
   end
+  private_class_method :initial_state
 end
 ```
 

data/Rakefile

@@ -1,6 +1,10 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:spec) do |task|
+  if ENV["EXCLUDE_MONGOID"]
+    task.rspec_opts = "--tag ~mongo --exclude-pattern **/*mongo*"
+  end
+end
 
 task default: :spec

data/lib/statesman/adapters/active_record.rb

@@ -108,8 +108,8 @@ module Statesman
       def serialized?(transition_class)
         if ::ActiveRecord.respond_to?(:gem_version) &&
            ::ActiveRecord.gem_version >= Gem::Version.new('4.2.0.a')
-          transition_class.columns_hash["metadata"].
-            cast_type.is_a?(::ActiveRecord::Type::Serialized)
+          transition_class.type_for_attribute("metadata").
+            is_a?(::ActiveRecord::Type::Serialized)
         else
           transition_class.serialized_attributes.include?("metadata")
         end

data/lib/statesman/machine.rb

@@ -66,25 +66,21 @@ module Statesman
         successors[from] += to
       end
 
-      def before_transition(options = { from: nil, to: nil }, &block)
-        add_callback(
-          options.merge(callback_class: Callback, callback_type: :before),
-          &block)
+      def before_transition(options = {}, &block)
+        add_callback(callback_type: :before, callback_class: Callback,
+                     from: options[:from], to: options[:to], &block)
       end
 
-      def guard_transition(options = { from: nil, to: nil }, &block)
-        add_callback(
-          options.merge(callback_class: Guard, callback_type: :guards),
-          &block)
+      def guard_transition(options = {}, &block)
+        add_callback(callback_type: :guards, callback_class: Guard,
+                     from: options[:from], to: options[:to], &block)
       end
 
-      def after_transition(options = { from: nil, to: nil,
-                                       after_commit: false }, &block)
+      def after_transition(options = { after_commit: false }, &block)
         callback_type = options[:after_commit] ? :after_commit : :after
 
-        add_callback(
-          options.merge(callback_class: Callback, callback_type: callback_type),
-          &block)
+        add_callback(callback_type: callback_type, callback_class: Callback,
+                     from: options[:from], to: options[:to], &block)
       end
 
       def validate_callback_condition(options = { from: nil, to: nil })
@@ -128,15 +124,26 @@ module Statesman
 
       private
 
-      def add_callback(options, &block)
-        from = to_s_or_nil(options[:from])
-        to   = array_to_s_or_nil(options[:to])
-        callback_klass = options.fetch(:callback_class)
-        callback_type = options.fetch(:callback_type)
+      def add_callback(callback_type: nil, callback_class: nil,
+                       from: nil, to: nil, &block)
+        validate_callback_type_and_class(callback_type, callback_class)
+
+        from = to_s_or_nil(from)
+        to   = array_to_s_or_nil(to)
 
         validate_callback_condition(from: from, to: to)
+
         callbacks[callback_type] <<
-          callback_klass.new(from: from, to: to, callback: block)
+          callback_class.new(from: from, to: to, callback: block)
+      end
+
+      def validate_callback_type_and_class(callback_type, callback_class)
+        if callback_type.nil?
+          raise ArgumentError.new("missing keyword: callback_type")
+        end
+        if callback_class.nil?
+          raise ArgumentError.new("missing keyword: callback_class")
+        end
       end
 
       def validate_state(state)

data/lib/statesman/version.rb

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

data/spec/spec_helper.rb

@@ -2,7 +2,6 @@ require "statesman"
 require "sqlite3"
 require "mysql2"
 require "pg"
-require "mongoid"
 require "active_record"
 # We have to include all of Rails to make rspec-rails work
 require "rails"
@@ -27,23 +26,29 @@ RSpec.configure do |config|
     end
   end
 
-  # Try a mongo connection at the start of the suite and raise if it fails
-  begin
-    Mongoid.configure do |mongo_config|
-      if defined?(Moped)
-        mongo_config.connect_to("statesman_test")
-        mongo_config.sessions["default"]["options"]["max_retries"] = 2
-      else
-        mongo_config.connect_to("statesman_test", server_selection_timeout: 2)
+  if config.exclusion_filter[:mongo]
+    puts "Skipping Mongo tests"
+  else
+    require "mongoid"
+
+    # Try a mongo connection at the start of the suite and raise if it fails
+    begin
+      Mongoid.configure do |mongo_config|
+        if defined?(Moped)
+          mongo_config.connect_to("statesman_test")
+          mongo_config.sessions["default"]["options"]["max_retries"] = 2
+        else
+          mongo_config.connect_to("statesman_test", server_selection_timeout: 2)
+        end
       end
+      # Attempting a mongo operation will trigger 2 retries then throw an
+      # exception if mongo is not running.
+      Mongoid.purge!
+    rescue connection_failure => error
+      puts "The spec suite requires MongoDB to be installed and running locally"
+      puts "Mongo dependent specs can be filtered with rspec --tag '~mongo'"
+      raise(error)
     end
-    # Attempting a mongo operation will trigger 2 retries then throw an
-    # exception if mongo is not running.
-    Mongoid.purge! unless config.exclusion_filter[:mongo]
-  rescue connection_failure => error
-    puts "The spec suite requires MongoDB to be installed and running locally"
-    puts "Mongo dependent specs can be filtered with rspec --tag '~mongo'"
-    raise(error)
   end
 
   if config.exclusion_filter[:active_record]
@@ -56,6 +61,9 @@ RSpec.configure do |config|
 
     db_adapter = ActiveRecord::Base.connection.adapter_name
     puts "Running with database adapter '#{db_adapter}'"
+
+    # Silence migration output
+    ActiveRecord::Migration.verbose = false
   end
 
   config.before(:each, active_record: true) do
@@ -73,29 +81,21 @@ RSpec.configure do |config|
     end
 
     def prepare_model_table
-      silence_stream(STDOUT) do
-        CreateMyActiveRecordModelMigration.migrate(:up)
-      end
+      CreateMyActiveRecordModelMigration.migrate(:up)
     end
 
     def prepare_transitions_table
-      silence_stream(STDOUT) do
-        CreateMyActiveRecordModelTransitionMigration.migrate(:up)
-        MyActiveRecordModelTransition.reset_column_information
-      end
+      CreateMyActiveRecordModelTransitionMigration.migrate(:up)
+      MyActiveRecordModelTransition.reset_column_information
     end
 
     def prepare_other_model_table
-      silence_stream(STDOUT) do
-        CreateOtherActiveRecordModelMigration.migrate(:up)
-      end
+      CreateOtherActiveRecordModelMigration.migrate(:up)
     end
 
     def prepare_other_transitions_table
-      silence_stream(STDOUT) do
-        CreateOtherActiveRecordModelTransitionMigration.migrate(:up)
-        OtherActiveRecordModelTransition.reset_column_information
-      end
+      CreateOtherActiveRecordModelTransitionMigration.migrate(:up)
+      OtherActiveRecordModelTransition.reset_column_information
     end
 
     MyNamespace::MyActiveRecordModelTransition.serialize(:metadata, JSON)

data/spec/statesman/adapters/active_record_spec.rb

@@ -22,9 +22,11 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
                                            { 'metadata' => metadata_column })
         if ::ActiveRecord.respond_to?(:gem_version) &&
            ::ActiveRecord.gem_version >= Gem::Version.new('4.2.0.a')
-          allow(metadata_column).to receive_messages(cast_type: '')
+          expect(MyActiveRecordModelTransition).
+            to receive(:type_for_attribute).with("metadata").
+            and_return(ActiveRecord::Type::Value.new)
         else
-          allow(MyActiveRecordModelTransition).
+          expect(MyActiveRecordModelTransition).
             to receive_messages(serialized_attributes: {})
         end
       end
@@ -48,8 +50,8 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
           serialized_type = ::ActiveRecord::Type::Serialized.new(
             '', ::ActiveRecord::Coders::JSON
           )
-          expect(metadata_column).
-            to receive(:cast_type).
+          expect(MyActiveRecordModelTransition).
+            to receive(:type_for_attribute).with("metadata").
             and_return(serialized_type)
         else
           expect(MyActiveRecordModelTransition).
@@ -76,8 +78,8 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
           serialized_type = ::ActiveRecord::Type::Serialized.new(
             '', ::ActiveRecord::Coders::JSON
           )
-          expect(metadata_column).
-            to receive(:cast_type).
+          expect(MyActiveRecordModelTransition).
+            to receive(:type_for_attribute).with("metadata").
             and_return(serialized_type)
         else
           expect(MyActiveRecordModelTransition).
@@ -248,10 +250,8 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
 
   context "with a namespaced model" do
     before do
-      silence_stream(STDOUT) do
-        CreateNamespacedARModelMigration.migrate(:up)
-        CreateNamespacedARModelTransitionMigration.migrate(:up)
-      end
+      CreateNamespacedARModelMigration.migrate(:up)
+      CreateNamespacedARModelTransitionMigration.migrate(:up)
     end
 
     before do

data/statesman.gemspec

@@ -27,7 +27,6 @@ Gem::Specification.new do |spec|
   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 "mongoid",       ">= 3.1"
   spec.add_development_dependency "rails",         ">= 3.2"
   spec.add_development_dependency "pg",            "~> 0.18"
   spec.add_development_dependency "mysql2",        "~> 0.4"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Harry Marr
@@ -9,202 +9,188 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-03-29 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: mongoid
-  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: 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
@@ -214,9 +200,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".travis.yml"
+- .gitignore
+- .rubocop.yml
+- .travis.yml
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -280,17 +266,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A statesmanlike state machine library