statesman 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 747626de855901f8252afbc7bae793d67c3e062a
-  data.tar.gz: f6b3c8239d7b92883c4bffce040d133cfc7cedfd
+  metadata.gz: 8247dd4b145c4c16a848f6cba121782199a05f43
+  data.tar.gz: 2f4b476e0b585f432f06985d759357d84f1ac1d1
 SHA512:
-  metadata.gz: 3db31cb3e861d3230ab1f631c30727709251d70e109a27c3b723bcfe0f213ed3f73f82920a939e9ac897e87db8cee5852c20f4e8103fc3a7a210a57b62445f07
-  data.tar.gz: b17bfbc8186d3c0bc888cb0c92e282cd8174b0cb64dcd78185b6b40ed9bac8b2112314ca4ee0031d0293af07aeaa7cc7b2960809e7daa9ec89a8e5d785ad5550
+  metadata.gz: 52b5b0d12f0b0741874afa857633c91e0eeba7c79678cb8f4da9d474b2227f7ca870cfa5ead883ad780a503a77028de7fa830e890e7d5611683245da0f00500d
+  data.tar.gz: df47a34f64bcea46519b56c450ceb0cec66233316fb03ff515578074babb6ecdcb98136ff357e8c7fb7fbf12359187c320f1101abd7aab97e1dab936ebfab2d3

data/.rubocop.yml

@@ -42,3 +42,7 @@ SingleSpaceBeforeFirstArg:
 
 DotPosition:
   EnforcedStyle: trailing
+
+# Allow class and message or instance raises
+Style/RaiseArgs:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v1.2.4 16 June 2015
+
+- Clarify error messages when misusing `Statesman::Adapters::ActiveRecordTransition` (patch by [@isaacseymour](https://github.com/isaacseymour))
+
 ## v1.2.3 14 April 2015
 
 - Fix use of most_recent column in MySQL (partial indexes aren't supported) (patch by [@greysteil](https://github.com/greysteil))

data/README.md

@@ -200,7 +200,7 @@ an array of states (`.transition(from: :some_state, to: [:another_state, :some_o
 
 #### `Machine.guard_transition`
 ```ruby
-Machine.guard_transition(from: :some_state, to: another_state) do |object|
+Machine.guard_transition(from: :some_state, to: :another_state) do |object|
   object.some_boolean?
 end
 ```
@@ -210,7 +210,7 @@ be idempotent as it could be called many times.
 
 #### `Machine.before_transition`
 ```ruby
-Machine.before_transition(from: :some_state, to: another_state) do |object|
+Machine.before_transition(from: :some_state, to: :another_state) do |object|
   object.side_effect
 end
 ```
@@ -220,7 +220,7 @@ have side-effects as it will only be run once immediately before the transition.
 
 #### `Machine.after_transition`
 ```ruby
-Machine.after_transition(from: :some_state, to: another_state) do |object, transition|
+Machine.after_transition(from: :some_state, to: :another_state) do |object, transition|
   object.side_effect
 end
 ```
@@ -394,9 +394,8 @@ Callbacks are tested by asserting that the action they perform occurs:
 describe "some callback" do
   it "adds one to the count property on the model" do
     expect { some_model.transition_to!(:some_state) }.
-      to change {
-        some_model.reload.count
-      }.by(1)
+      to change { some_model.reload.count }.
+      by(1)
   end
 end
 ```

data/lib/statesman/adapters/active_record.rb

@@ -21,12 +21,9 @@ module Statesman
         serialized = serialized?(transition_class)
         column_type = transition_class.columns_hash['metadata'].sql_type
         if !serialized && !JSON_COLUMN_TYPES.include?(column_type)
-          raise UnserializedMetadataError,
-                "#{transition_class.name}#metadata is not serialized"
+          raise UnserializedMetadataError.new(transition_class.name)
         elsif serialized && JSON_COLUMN_TYPES.include?(column_type)
-          raise IncompatibleSerializationError,
-                "#{transition_class.name}#metadata column type cannot be json
-                  and serialized simultaneously"
+          raise IncompatibleSerializationError.new(transition_class.name)
         end
         @transition_class = transition_class
         @parent_model = parent_model

data/lib/statesman/exceptions.rb

@@ -4,7 +4,34 @@ module Statesman
   class InvalidCallbackError < StandardError; end
   class GuardFailedError < StandardError; end
   class TransitionFailedError < StandardError; end
-  class UnserializedMetadataError < StandardError; end
-  class IncompatibleSerializationError < StandardError; end
   class TransitionConflictError < StandardError; end
+
+  class UnserializedMetadataError < StandardError
+    def initialize(transition_class_name)
+      super(_message(transition_class_name))
+    end
+
+    private
+
+    def _message(transition_class_name)
+      "#{transition_class_name}#metadata is not serialized. If you " \
+      "are using a non-json column type, you should `include " \
+      "Statesman::Adapters::ActiveRecordTransition`"
+    end
+  end
+
+  class IncompatibleSerializationError < StandardError
+    def initialize(transition_class_name)
+      super(_message(transition_class_name))
+    end
+
+    private
+
+    def _message(transition_class_name)
+      "#{transition_class_name}#metadata column type cannot be json " \
+      "and serialized simultaneously. If you are using a json " \
+      "column type, it is not necessary to `include " \
+      "Statesman::Adapters::ActiveRecordTransition`"
+    end
+  end
 end

data/lib/statesman/version.rb

@@ -1,3 +1,3 @@
 module Statesman
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

data/spec/spec_helper.rb

@@ -1,9 +1,15 @@
 require "statesman"
 require "sqlite3"
 require "active_record"
+# We have to include all of Rails to make rspec-rails work
+require "rails"
+require "action_view"
+require "action_dispatch"
+require "action_controller"
+require "rspec/rails"
 require "support/active_record"
 require "mongoid"
-require 'rspec/its'
+require "rspec/its"
 
 RSpec.configure do |config|
   config.raise_errors_for_deprecations!

data/spec/support/generators_shared_examples.rb

@@ -1,4 +1,5 @@
 require "rails/version"
+require "rspec/rails"
 require "ammeter/init"
 
 TMP_GENERATOR_PATH = File.expand_path('../generator-tmp', __FILE__)

data/statesman.gemspec

@@ -21,13 +21,14 @@ Gem::Specification.new do |spec|
   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 "mongoid",       ">= 3.1"
-  spec.add_development_dependency "activerecord",  ">= 3.2"
+  spec.add_development_dependency "rails",         ">= 3.2"
   spec.add_development_dependency "pg",            "~> 0.18"
   spec.add_development_dependency "mysql2",        "~> 0.3"
   spec.add_development_dependency "ammeter",       "~> 1.1"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Harry Marr
@@ -9,188 +9,202 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-06-16 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: activerecord
+  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.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.3'
 - !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 +214,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rubocop.yml
-- .travis.yml
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -274,17 +288,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.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: A statesmanlike state machine library
@@ -312,3 +326,4 @@ test_files:
 - spec/support/active_record.rb
 - spec/support/generators_shared_examples.rb
 - spec/support/mongoid.rb
+has_rdoc: