state_machines-activerecord 0.3.0 → 0.4.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05961f0c1b5b3ab64919dcde984de7b32760a238
-  data.tar.gz: d1ec7191b20c2a0bb489e07204a01ebdf6df5f8f
+  metadata.gz: b08f23fe776a36406ccb74f5d177acb8a6fc030e
+  data.tar.gz: fa00fc7d5506ca635f50682c159393e39a15b88c
 SHA512:
-  metadata.gz: 38056137768ae3c54e2ac920f88a87f0acf135f3aeaa2b00fb4d5288532a214574a1737dc93e2c598cccb24165491f27917224ef7eaa550d4484dd82b9eceb14
-  data.tar.gz: 9362187783fa4720309dc6a27043376a6792d6058aafb7b762cf058d01b73eb087a6009f53d12f2a87db573a72015d18c2c6f66798cce14fd44f546d08407f14
+  metadata.gz: 9ae6270e99bac4395564478cb42fd2d6b9a787055e670d47f4f760d2f8c6a2e5747d9283d6f82a55717c853658e0c0b6a855931acfa82f5b3a06ae1ec931e6b2
+  data.tar.gz: b4fe5baa32f92b424e6df7c45216385fd971d7ba191be7dc2b6998aae1b096106ec54abb344a3c9633317068048db004016716e02b0bc6d25f1d65acaf8e9d61

data/.travis.yml

@@ -13,6 +13,12 @@ gemfile:
   - gemfiles/active_record_4.2.gemfile
 
 matrix:
+  include:
+    - gemfile: gemfiles/active_record_edge.gemfile
+      rvm: 2.2
   allow_failures:
     - rvm: jruby
     - rvm: rbx-2
+    - gemfile: gemfiles/active_record_edge.gemfile
+      rvm: 2.2
+

data/Appraisals

@@ -9,3 +9,13 @@ appraise "active_record_4.2" do
   gem "activerecord-jdbcsqlite3-adapter", platform: :jruby
   gem "activerecord", github: 'rails/rails',  branch: '4-2-stable'
 end
+
+appraise "active_record_edge" do
+  gem "sqlite3", platforms: [:mri, :rbx]
+  gem "activerecord-jdbcsqlite3-adapter", platform: :jruby
+  gem "activerecord", github: 'rails/rails',  branch: 'master'
+  gem "method_source"  # appears to be a missing dependency of activerecord
+  gem "arel", github: 'rails/arel', branch: 'master'
+  gem "activemodel", github: 'rails/rails', branch: 'master'
+  gem "state_machines-activemodel", '0.4.0.pre'
+end

data/README.md

@@ -1,11 +1,15 @@
 [![Build Status](https://travis-ci.org/state-machines/state_machines-activerecord.svg?branch=master)](https://travis-ci.org/state-machines/state_machines-activerecord)
-[![Code Climate](https://codeclimate.com/github/state-machines/state_machines-activerecord.png)](https://codeclimate.com/github/state-machines/state_machines-activerecord)
+[![Code Climate](https://codeclimate.com/github/state-machines/state_machines-activerecord.svg)](https://codeclimate.com/github/state-machines/state_machines-activerecord)
 
 # StateMachines Active Record Integration
 
-The Active Record integration adds support for database transactions, automatically
+The Active Record 4.1+ integration adds support for database transactions, automatically
 saving the record, named scopes, validation errors.
 
+## Dependencies
+
+Active Record 4.1+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -60,11 +64,6 @@ Vehicle.with_state(:parked)                         # also plural #with_states
 Vehicle.without_states(:first_gear, :second_gear)   # also singular #without_state
 ```
 
-
-Dependencies
-
-Active Record 4.1+
-
 ## Contributing
 
 1. Fork it ( https://github.com/state-machines/state_machines-activerecord/fork )

data/gemfiles/active_record_edge.gemfile

@@ -0,0 +1,17 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sqlite3", :platforms => [:mri, :rbx]
+gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+gem "activerecord", :github => "rails/rails", :branch => "master"
+gem "method_source"
+gem "arel", :github => "rails/arel", :branch => "master"
+gem "activemodel", :github => "rails/rails", :branch => "master"
+gem "state_machines-activemodel", "0.4.0.pre"
+
+platforms :mri_20, :mri_21 do
+  gem "pry-byebug"
+end
+
+gemspec :path => "../"

data/lib/state_machines/integrations/active_record.rb

@@ -5,12 +5,12 @@ require 'state_machines/integrations/active_record/version'
 module StateMachines
   module Integrations #:nodoc:
     # Adds support for integrating state machines with ActiveRecord models.
-    # 
+    #
     # == Examples
-    # 
+    #
     # Below is an example of a simple state machine defined within an
     # ActiveRecord model:
-    # 
+    #
     #   class Vehicle < ActiveRecord::Base
     #     state_machine :initial => :parked do
     #       event :ignite do
@@ -18,138 +18,138 @@ module StateMachines
     #       end
     #     end
     #   end
-    # 
+    #
     # The examples in the sections below will use the above class as a
     # reference.
-    # 
+    #
     # == Actions
-    # 
+    #
     # By default, the action that will be invoked when a state is transitioned
     # is the +save+ action.  This will cause the record to save the changes
     # made to the state machine's attribute.  *Note* that if any other changes
     # were made to the record prior to transition, then those changes will
     # be saved as well.
-    # 
+    #
     # For example,
-    # 
+    #
     #   vehicle = Vehicle.create          # => #<Vehicle id: 1, name: nil, state: "parked">
     #   vehicle.name = 'Ford Explorer'
     #   vehicle.ignite                    # => true
     #   vehicle.reload                    # => #<Vehicle id: 1, name: "Ford Explorer", state: "idling">
-    # 
-    # *Note* that if you want a transition to update additional attributes of the record, 
-    # either the changes need to be made in a +before_transition+ callback or you need 
+    #
+    # *Note* that if you want a transition to update additional attributes of the record,
+    # either the changes need to be made in a +before_transition+ callback or you need
     # to save the record manually.
     #
     # == Events
-    # 
+    #
     # As described in StateMachines::InstanceMethods#state_machine, event
     # attributes are created for every machine that allow transitions to be
     # performed automatically when the object's action (in this case, :save)
     # is called.
-    # 
+    #
     # In ActiveRecord, these automated events are run in the following order:
     # * before validation - Run before callbacks and persist new states, then validate
     # * before save - If validation was skipped, run before callbacks and persist new states, then save
     # * after save - Run after callbacks
-    # 
+    #
     # For example,
-    # 
+    #
     #   vehicle = Vehicle.create          # => #<Vehicle id: 1, name: nil, state: "parked">
     #   vehicle.state_event               # => nil
     #   vehicle.state_event = 'invalid'
     #   vehicle.valid?                    # => false
     #   vehicle.errors.full_messages      # => ["State event is invalid"]
-    #   
+    #
     #   vehicle.state_event = 'ignite'
     #   vehicle.valid?                    # => true
     #   vehicle.save                      # => true
     #   vehicle.state                     # => "idling"
     #   vehicle.state_event               # => nil
-    # 
+    #
     # Note that this can also be done on a mass-assignment basis:
-    # 
+    #
     #   vehicle = Vehicle.create(:state_event => 'ignite')  # => #<Vehicle id: 1, name: nil, state: "idling">
     #   vehicle.state                                       # => "idling"
-    # 
+    #
     # This technique is always used for transitioning states when the +save+
     # action (which is the default) is configured for the machine.
-    # 
+    #
     # === Security implications
-    # 
+    #
     # Beware that public event attributes mean that events can be fired
     # whenever mass-assignment is being used.  If you want to prevent malicious
     # users from tampering with events through URLs / forms, the attribute
     # should be protected like so:
-    # 
+    #
     #   class Vehicle < ActiveRecord::Base
     #     attr_protected :state_event
     #     # attr_accessible ... # Alternative technique
-    #     
+    #
     #     state_machine do
     #       ...
     #     end
     #   end
-    # 
+    #
     # If you want to only have *some* events be able to fire via mass-assignment,
     # you can build two state machines (one public and one protected) like so:
-    # 
+    #
     #   class Vehicle < ActiveRecord::Base
     #     attr_protected :state_event # Prevent access to events in the first machine
-    #     
+    #
     #     state_machine do
     #       # Define private events here
     #     end
-    #     
+    #
     #     # Public machine targets the same state as the private machine
     #     state_machine :public_state, :attribute => :state do
     #       # Define public events here
     #     end
     #   end
-    # 
+    #
     # == Transactions
-    # 
+    #
     # In order to ensure that any changes made during transition callbacks
     # are rolled back during a failed attempt, every transition is wrapped
     # within a transaction.
-    # 
+    #
     # For example,
-    # 
+    #
     #   class Message < ActiveRecord::Base
     #   end
-    #   
+    #
     #   Vehicle.state_machine do
     #     before_transition do |vehicle, transition|
     #       Message.create(:content => transition.inspect)
     #       false
     #     end
     #   end
-    #   
+    #
     #   vehicle = Vehicle.create      # => #<Vehicle id: 1, name: nil, state: "parked">
     #   vehicle.ignite                # => false
     #   Message.count                 # => 0
-    # 
+    #
     # *Note* that only before callbacks that halt the callback chain and
     # failed attempts to save the record will result in the transaction being
     # rolled back.  If an after callback halts the chain, the previous result
     # still applies and the transaction is *not* rolled back.
-    # 
+    #
     # To turn off transactions:
-    # 
+    #
     #   class Vehicle < ActiveRecord::Base
     #     state_machine :initial => :parked, :use_transactions => false do
     #       ...
     #     end
     #   end
-    # 
+    #
     # == Validations
-    # 
+    #
     # As mentioned in StateMachines::Machine#state, you can define behaviors,
     # like validations, that only execute for certain states. One *important*
     # caveat here is that, due to a constraint in ActiveRecord's validation
     # framework, custom validators will not work as expected when defined to run
     # in multiple states.  For example:
-    # 
+    #
     #   class Vehicle < ActiveRecord::Base
     #     state_machine do
     #       ...
@@ -158,11 +158,11 @@ module StateMachines
     #       end
     #     end
     #   end
-    # 
+    #
     # In this case, the <tt>:speed_is_legal</tt> validation will only get run
     # for the <tt>:second_gear</tt> state.  To avoid this, you can define your
     # custom validation like so:
-    # 
+    #
     #   class Vehicle < ActiveRecord::Base
     #     state_machine do
     #       ...
@@ -171,124 +171,124 @@ module StateMachines
     #       end
     #     end
     #   end
-    # 
+    #
     # == Validation errors
-    # 
+    #
     # If an event fails to successfully fire because there are no matching
     # transitions for the current record, a validation error is added to the
     # record's state attribute to help in determining why it failed and for
     # reporting via the UI.
-    # 
+    #
     # For example,
-    # 
+    #
     #   vehicle = Vehicle.create(:state => 'idling')  # => #<Vehicle id: 1, name: nil, state: "idling">
     #   vehicle.ignite                                # => false
     #   vehicle.errors.full_messages                  # => ["State cannot transition via \"ignite\""]
-    # 
+    #
     # If an event fails to fire because of a validation error on the record and
     # *not* because a matching transition was not available, no error messages
     # will be added to the state attribute.
-    # 
+    #
     # In addition, if you're using the <tt>ignite!</tt> version of the event,
     # then the failure reason (such as the current validation errors) will be
     # included in the exception that gets raised when the event fails.  For
     # example, assuming there's a validation on a field called +name+ on the class:
-    # 
+    #
     #   vehicle = Vehicle.new
     #   vehicle.ignite!       # => StateMachines::InvalidTransition: Cannot transition state via :ignite from :parked (Reason(s): Name cannot be blank)
-    # 
+    #
     # == Scopes
-    # 
+    #
     # To assist in filtering models with specific states, a series of named
     # scopes are defined on the model for finding records with or without a
     # particular set of states.
-    # 
+    #
     # These named scopes are essentially the functional equivalent of the
     # following definitions:
-    # 
+    #
     #   class Vehicle < ActiveRecord::Base
     #     named_scope :with_states, lambda {|*states| {:conditions => {:state => states}}}
     #     # with_states also aliased to with_state
-    #     
+    #
     #     named_scope :without_states, lambda {|*states| {:conditions => ['state NOT IN (?)', states]}}
     #     # without_states also aliased to without_state
     #   end
-    # 
+    #
     # *Note*, however, that the states are converted to their stored values
     # before being passed into the query.
-    # 
+    #
     # Because of the way named scopes work in ActiveRecord, they can be
     # chained like so:
-    # 
+    #
     #   Vehicle.with_state(:parked).all(:order => 'id DESC')
-    # 
+    #
     # Note that states can also be referenced by the string version of their
     # name:
-    # 
+    #
     #   Vehicle.with_state('parked')
-    # 
+    #
     # == Callbacks
-    # 
+    #
     # All before/after transition callbacks defined for ActiveRecord models
     # behave in the same way that other ActiveRecord callbacks behave.  The
     # object involved in the transition is passed in as an argument.
-    # 
+    #
     # For example,
-    # 
+    #
     #   class Vehicle < ActiveRecord::Base
     #     state_machine :initial => :parked do
     #       before_transition any => :idling do |vehicle|
     #         vehicle.put_on_seatbelt
     #       end
-    #       
+    #
     #       before_transition do |vehicle, transition|
     #         # log message
     #       end
-    #       
+    #
     #       event :ignite do
     #         transition :parked => :idling
     #       end
     #     end
-    #     
+    #
     #     def put_on_seatbelt
     #       ...
     #     end
     #   end
-    # 
+    #
     # Note, also, that the transition can be accessed by simply defining
     # additional arguments in the callback block.
-    # 
+    #
     # === Failure callbacks
-    # 
+    #
     # +after_failure+ callbacks allow you to execute behaviors when a transition
     # is allowed, but fails to save.  This could be useful for something like
     # auditing transition attempts.  Since callbacks run within transactions in
     # ActiveRecord, a save failure will cause any records that get created in
     # your callback to roll back.  You can work around this issue like so:
-    # 
+    #
     #   class TransitionLog < ActiveRecord::Base
     #     establish_connection Rails.env.to_sym
     #   end
-    #   
+    #
     #   class Vehicle < ActiveRecord::Base
     #     state_machine do
     #       after_failure do |vehicle, transition|
     #         TransitionLog.create(:vehicle => vehicle, :transition => transition)
     #       end
-    #       
+    #
     #       ...
     #     end
     #   end
-    # 
+    #
     # The +TransitionLog+ model establishes a second connection to the database
     # that allows new records to be saved without being affected by rollbacks
     # in the +Vehicle+ model's transaction.
-    # 
+    #
     # === Callback Order
-    # 
+    #
     # Callbacks occur in the following order.  Callbacks specific to state_machine
     # are bolded.  The remaining callbacks are part of ActiveRecord.
-    # 
+    #
     # * (-) save
     # * (-) begin transaction (if enabled)
     # * (1) *before_transition*
@@ -304,9 +304,9 @@ module StateMachines
     # * (8) *after_transition*
     # * (-) end transaction (if enabled)
     # * (9) after_commit
-    # 
+    #
     # == Observers
-    # 
+    #
     # In addition to support for ActiveRecord-like hooks, there is additional
     # support for ActiveRecord observers.  Because of the way ActiveRecord
     # observers are designed, there is less flexibility around the specific
@@ -323,49 +323,49 @@ module StateMachines
     # * before/after/after_failure_to-_transition_state_to_idling
     # * before/after/after_failure_to-_transition_state
     # * before/after/after_failure_to-_transition
-    # 
+    #
     # The following class shows an example of some of these hooks:
-    # 
+    #
     #   class VehicleObserver < ActiveRecord::Observer
     #     def before_save(vehicle)
     #       # log message
     #     end
-    #     
+    #
     #     # Callback for :ignite event *before* the transition is performed
     #     def before_ignite(vehicle, transition)
     #       # log message
     #     end
-    #     
+    #
     #     # Callback for :ignite event *after* the transition has been performed
     #     def after_ignite(vehicle, transition)
     #       # put on seatbelt
     #     end
-    #     
+    #
     #     # Generic transition callback *before* the transition is performed
     #     def after_transition(vehicle, transition)
     #       Audit.log(vehicle, transition)
     #     end
     #   end
-    # 
+    #
     # More flexible transition callbacks can be defined directly within the
     # model as described in StateMachines::Machine#before_transition
     # and StateMachines::Machine#after_transition.
-    # 
+    #
     # To define a single observer for multiple state machines:
-    # 
+    #
     #   class StateMachineObserver < ActiveRecord::Observer
     #     observe Vehicle, Switch, Project
-    #     
+    #
     #     def after_transition(record, transition)
     #       Audit.log(record, transition)
     #     end
     #   end
-    # 
+    #
     # == Internationalization
-    # 
+    #
     # In Rails 2.2+, any error message that is generated from performing invalid
     # transitions can be localized.  The following default translations are used:
-    # 
+    #
     #   en:
     #     activerecord:
     #       errors:
@@ -375,19 +375,19 @@ module StateMachines
     #           invalid_event: "cannot transition when %{state}"
     #           # %{value} = attribute value, %{event} = Human event name, %{state} = Human current state name
     #           invalid_transition: "cannot transition via %{event}"
-    # 
+    #
     # Notice that the interpolation syntax is %{key} in Rails 3+.  In Rails 2.x,
     # the appropriate syntax is {{key}}.
-    # 
+    #
     # You can override these for a specific model like so:
-    # 
+    #
     #   en:
     #     activerecord:
     #       errors:
     #         models:
     #           user:
     #             invalid: "is not valid"
-    # 
+    #
     # In addition to the above, you can also provide translations for the
     # various states / events in each state machine.  Using the Vehicle example,
     # state translations will be looked for using the following keys, where
@@ -396,16 +396,16 @@ module StateMachines
     # * <tt>activerecord.state_machines.#{model_name}.states.#{state_name}</tt>
     # * <tt>activerecord.state_machines.#{machine_name}.states.#{state_name}</tt>
     # * <tt>activerecord.state_machines.states.#{state_name}</tt>
-    # 
+    #
     # Event translations will be looked for using the following keys, where
     # +model_name+ = "vehicle", +machine_name+ = "state" and +event_name+ = "ignite":
     # * <tt>activerecord.state_machines.#{model_name}.#{machine_name}.events.#{event_name}</tt>
     # * <tt>activerecord.state_machines.#{model_name}.events.#{event_name}</tt>
     # * <tt>activerecord.state_machines.#{machine_name}.events.#{event_name}</tt>
     # * <tt>activerecord.state_machines.events.#{event_name}</tt>
-    # 
+    #
     # An example translation configuration might look like so:
-    # 
+    #
     #   es:
     #     activerecord:
     #       state_machines:
@@ -448,7 +448,16 @@ module StateMachines
       end
 
       def define_state_initializer
-        if ::ActiveRecord.gem_version >= Gem::Version.new('4.2')
+        if ::ActiveRecord.gem_version >= Gem::Version.new('5.0.0.alpha')
+          define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
+            def initialize(attributes = nil)
+              super(attributes) do |*args|
+                self.class.state_machines.initialize_states(self, {}, attributes || {})
+                yield(*args) if block_given?
+              end
+            end
+          end_eval
+        elsif ::ActiveRecord.gem_version >= Gem::Version.new('4.2')
           define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
             def initialize(attributes = nil, options = {})
               super(attributes, options) do |*args|
@@ -491,12 +500,12 @@ module StateMachines
               def save(*)
                 self.class.state_machine(#{name.inspect}).send(:around_save, self) { super }
               end
-              
+
               def save!(*)
                 result = self.class.state_machine(#{name.inspect}).send(:around_save, self) { super }
                 result || raise(ActiveRecord::RecordInvalid.new(self))
               end
-              
+
               def changed_for_autosave?
                 super || self.class.state_machines.any? {|name, machine| machine.action == :save && machine.read(self, :event)}
               end

data/lib/state_machines/integrations/active_record/version.rb

@@ -1,7 +1,7 @@
 module StateMachines
   module Integrations
     module ActiveRecord
-      VERSION = '0.3.0'
+      VERSION = '0.4.0.pre'
     end
   end
 end

data/state_machines-activerecord.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = %w(terminale@gmail.com aaron@pluginaweek.org)
   spec.summary       = %q(State machines Active Record Integration)
   spec.description   = %q(Adds support for creating state machines for attributes on ActiveRecord)
-  spec.homepage      = 'https://github.com/seuros/state_machines-activerecord'
+  spec.homepage      = 'https://github.com/state-machines/state_machines-activerecord/'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'state_machines-activemodel', '>= 0.3.0'
-  spec.add_dependency 'activerecord' , '~> 4.1'
+  spec.add_dependency 'activerecord' , '>=4.1', '<5.0'
   spec.add_development_dependency 'rake', '~> 10.3'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
   spec.add_development_dependency 'appraisal', '>= 1'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: state_machines-activerecord
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0.pre
 platform: ruby
 authors:
 - Abdelkader Boudih
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-13 00:00:00.000000000 Z
+date: 2015-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: state_machines-activemodel
@@ -29,16 +29,22 @@ dependencies:
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -126,6 +132,7 @@ files:
 - Rakefile
 - gemfiles/active_record_4.1.gemfile
 - gemfiles/active_record_4.2.gemfile
+- gemfiles/active_record_edge.gemfile
 - lib/state_machines-activerecord.rb
 - lib/state_machines/integrations/active_record.rb
 - lib/state_machines/integrations/active_record/locale.rb
@@ -183,7 +190,7 @@ files:
 - test/machine_without_transactions_test.rb
 - test/model_test.rb
 - test/test_helper.rb
-homepage: https://github.com/seuros/state_machines-activerecord
+homepage: https://github.com/state-machines/state_machines-activerecord/
 licenses:
 - MIT
 metadata: {}
@@ -198,12 +205,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: State machines Active Record Integration
@@ -259,3 +266,4 @@ test_files:
 - test/machine_without_transactions_test.rb
 - test/model_test.rb
 - test/test_helper.rb
+has_rdoc: