transitions 1.0.0 → 1.0.1

data/lib/transitions/presenter.rb

@@ -1,15 +1,11 @@
 module Transitions
   module Presenter
     def available_states
-      @state_machine.states.map(&:name).sort_by(&:to_s)
+      get_state_machine.states.map(&:name).sort_by(&:to_s)
     end
 
     def available_events
-      @state_machine.events.keys.sort
-    end
-
-    def available_transitions
-      @state_machine.events_for(current_state)
+      get_state_machine.events.keys.sort
     end
   end
 end

data/lib/transitions/state.rb

@@ -10,11 +10,11 @@ module Transitions
       update(options)
     end
 
-    def ==(state)
-      if state.is_a? Symbol
-        name == state
+    def ==(other)
+      if other.is_a? Symbol
+        name == other
       else
-        name == state.name
+        name == other.name
       end
     end
 
@@ -29,7 +29,7 @@ module Transitions
     end
 
     def display_name
-      @display_name ||= name.to_s.gsub(/_/, ' ').capitalize
+      @display_name ||= name.to_s.tr('_', ' ').capitalize
     end
 
     def for_select
@@ -45,9 +45,12 @@ module Transitions
     private
 
     def define_state_query_method(machine)
-      method_name, state_name = "#{@name}?", @name # Instance vars are out of scope when calling define_method below, so we use local variables.
+      method_name = "#{@name}?"
+      state_name = @name # Instance vars are out of scope when calling define_method below, so we use local variables.
       if machine.klass.method_defined?(method_name.to_sym)
-        fail InvalidMethodOverride, "Transitions: Can not define method `#{method_name}` because it is already defined - either rename the existing method or the state."
+        fail InvalidMethodOverride,
+             "Transitions: Can not define method `#{method_name}` because it is already"\
+             'defined - either rename the existing method or the state.'
       end
       machine.klass.send :define_method, method_name do
         current_state.to_s == state_name.to_s

data/lib/transitions/state_transition.rb

@@ -1,16 +1,45 @@
 module Transitions
   class StateTransition
-    attr_reader :from, :to, :options
+    attr_reader :from, :to, :guard, :on_transition
+    # TODO: `from` and `to` should be private as well
+    private :guard, :on_transition
 
     def initialize(opts)
-      @from, @to, @guard, @on_transition = opts[:from], opts[:to], opts[:guard], opts[:on_transition]
+      @from = opts[:from]
+      @to = opts[:to]
+      @guard = opts[:guard]
+      @on_transition = opts[:on_transition]
       @options = opts
     end
 
+    #
+    # @param obj [Any] - the subject
+    # @param args [Array<Symbol>] - any arguments passed into the transition method
+    #   E.g. something like
+    #     car.drive!(:fast, :now)
+    #   with `car` being the subject and `drive` the transition method would result
+    #   in `args` looking like this:
+    #     [:fast, :now]
+    #
+    # @return [Bool]
+    #
     def executable?(obj, *args)
       [@guard].flatten.all? { |g| perform_guard(obj, g, *args) }
     end
 
+    #
+    # @param obj [Any] - the subject
+    # @param args [Array<Symbol>] - any arguments passed into the transition method
+    #   E.g. something like
+    #     car.drive!(:fast, :now)
+    #   with `car` being the subject and `drive` the transition method would result
+    #   in `args` looking like this:
+    #     [:fast, :now]
+    #
+    # @return [void]
+    #
+    # rubocop:disable Metrics/MethodLength
+    #
     def execute(obj, *args)
       case @on_transition
       when Symbol, String
@@ -24,13 +53,15 @@ module Transitions
           obj.send(callback, *args)
         end
       else
-        # TODO We probably should check for this in the constructor and not that late.
-        fail ArgumentError, "You can only pass a Symbol, a String, a Proc or an Array to 'on_transition' - got #{@on_transition.class}." unless @on_transition.nil?
+        # TODO: We probably should check for this in the constructor and not that late.
+        fail ArgumentError,
+             "You can only pass a Symbol, a String, a Proc or an Array to 'on_transition'"\
+             " - got #{@on_transition.class}." unless @on_transition.nil?
       end
     end
 
-    def ==(obj)
-      @from == obj.from && @to == obj.to
+    def ==(other)
+      @from == other.from && @to == other.to
     end
 
     def from?(value)

data/lib/transitions/version.rb

@@ -1,3 +1,3 @@
 module Transitions
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'.freeze
 end

data/transitions.gemspec

@@ -1,29 +1,28 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/transitions/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'transitions/version'
 
-Gem::Specification.new do |s|
-  s.name        = 'transitions'
-  s.version     = Transitions::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Jakub Kuzma', 'Timo Roessner']
-  s.email       = 'timo.roessner@googlemail.com'
-  s.homepage    = 'http://github.com/troessner/transitions'
-  s.summary     = 'State machine extracted from ActiveModel'
-  s.description = 'Lightweight state machine extracted from ActiveModel'
+Gem::Specification.new do |spec|
+  spec.name          = 'transitions'
+  spec.version       = Transitions::VERSION
+  spec.authors       = ['Timo Rößner']
+  spec.email         = ['timo.roessner@googlemail.com']
 
-  s.required_rubygems_version = '>= 1.3.6'
-  s.rubyforge_project         = 'transitions'
+  spec.summary       = 'State machine extracted from ActiveModel'
+  spec.description   = 'Lightweight state machine extracted from ActiveModel'
+  spec.homepage      = 'http://github.com/troessner/transitions'
+  spec.license       = 'MIT'
 
-  s.add_development_dependency 'bundler', '~> 1'
-  s.add_development_dependency 'test-unit', '~> 2.5'
-  s.add_development_dependency 'mocha', '~> 0.11.0' # With mocha 0.12 we get: undefined method `run' for #<StateMachineMachineTest:0x94918b8> (NoMethodError)
-  s.add_development_dependency 'rake'
-  s.add_development_dependency 'random_data'
-  s.add_development_dependency 'appraisal'
-  s.add_development_dependency 'activerecord', ['>= 3.0', '<= 4.0']
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
 
-  s.files        = `git ls-files`.split("\n")
-  s.executables  = `git ls-files`.split("\n").map { |f| f =~ /^bin\/(.*)/ ? Regexp.last_match[1] : nil }.compact
-  s.require_path = 'lib'
-  s.license      = 'MIT'
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'test-unit', '~> 2.5'
+  spec.add_development_dependency 'mocha', '~> 0.11.0' # With mocha 0.12 we get: undefined method `run' for #<StateMachineMachineTest:0x94918b8> (NoMethodError)
+  spec.add_development_dependency 'random_data'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'activerecord', ['>= 3.0', '<= 4.0']
+  spec.add_development_dependency 'rubocop', '~> 0.36'
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transitions
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
-- Jakub Kuzma
-- Timo Roessner
+- Timo Rößner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-25 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -17,56 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '2.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '2.5'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: random_data
   requirement: !ruby/object:Gem::Requirement
@@ -115,23 +114,38 @@ dependencies:
     - - "<="
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.36'
 description: Lightweight state machine extracted from ActiveModel
-email: timo.roessner@googlemail.com
+email:
+- timo.roessner@googlemail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
-- MIT-LICENSE.txt
+- LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
 - gemfiles/rails_3_0.gemfile
 - gemfiles/rails_3_1.gemfile
 - gemfiles/rails_3_2.gemfile
@@ -145,27 +159,6 @@ files:
 - lib/transitions/state.rb
 - lib/transitions/state_transition.rb
 - lib/transitions/version.rb
-- test/active_record/test_active_record.rb
-- test/active_record/test_active_record_scopes.rb
-- test/active_record/test_active_record_timestamps.rb
-- test/active_record/test_custom_select.rb
-- test/event/test_event.rb
-- test/event/test_event_arguments.rb
-- test/event/test_event_being_fired.rb
-- test/event/test_event_checks.rb
-- test/helper.rb
-- test/machine/machine_template.rb
-- test/machine/test_available_states_listing.rb
-- test/machine/test_fire_event_machine.rb
-- test/machine/test_machine.rb
-- test/state/test_state.rb
-- test/state/test_state_predicate_method.rb
-- test/state_transition/test_state_transition.rb
-- test/state_transition/test_state_transition_event_failed_callback.rb
-- test/state_transition/test_state_transition_event_fired_callback.rb
-- test/state_transition/test_state_transition_guard_check.rb
-- test/state_transition/test_state_transition_on_transition_callback.rb
-- test/state_transition/test_state_transition_success_callback.rb
 - transitions.gemspec
 homepage: http://github.com/troessner/transitions
 licenses:
@@ -184,11 +177,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
-rubyforge_project: transitions
+rubyforge_project: 
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: State machine extracted from ActiveModel
 test_files: []
+has_rdoc: 

data/.ruby-gemset

@@ -1 +0,0 @@
-transitions

data/MIT-LICENSE.txt

@@ -1,21 +0,0 @@
-Copyright 2013 jQuery Foundation and other contributors
-http://jquery.com/
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/test/active_record/test_active_record.rb

@@ -1,326 +0,0 @@
-require 'helper'
-
-class CreateTrafficLights < ActiveRecord::Migration
-  def self.up
-    create_table(:traffic_lights, force: true) do |t|
-      t.string :state
-      t.string :name
-      t.string :power
-    end
-  end
-end
-
-class CreateDifferentTrafficLights < ActiveRecord::Migration
-  def self.up
-    create_table(:different_traffic_lights) do |t|
-      t.string :different_state
-      t.string :name
-    end
-  end
-end
-
-class TrafficLight < ActiveRecord::Base
-  include ActiveModel::Transitions
-
-  state_machine auto_scopes: true do
-    state :off, enter: :turn_power_on
-
-    state :red
-    state :green
-    state :yellow
-
-    event :red_on do
-      transitions to: :red, from: [:yellow]
-    end
-
-    event :green_on do
-      transitions to: :green, from: [:red]
-    end
-
-    event :yellow_on do
-      transitions to: :yellow, from: [:green]
-    end
-
-    event :reset do
-      transitions to: :red, from: [:off]
-    end
-  end
-
-  def turn_power_on
-    fail 'the power should not have been on already' if power == 'on'
-    self.power = 'on'
-  end
-end
-
-class ValidatingTrafficLight < TrafficLight
-  validate { |t| errors.add(:base, 'This TrafficLight will never validate after creation') unless t.new_record? }
-end
-
-class ConditionalValidatingTrafficLight < TrafficLight
-  validates(:name, presence: true, if: :red?)
-end
-
-class TestActiveRecord < Test::Unit::TestCase
-  def setup
-    set_up_db CreateTrafficLights
-    @light = TrafficLight.create!
-  end
-
-  test 'new record has the initial state set' do
-    @light = TrafficLight.new
-    assert_equal 'off', @light.state
-  end
-
-  test 'new active records defaults current state to the initial state' do
-    assert_equal :off, @light.current_state
-  end
-
-  test 'states initial state' do
-    assert @light.off?
-    assert_equal :off, @light.current_state
-  end
-
-  test 'calls enter when setting the initial state' do
-    @new_light = TrafficLight.new
-    assert_equal 'on', @new_light.power
-  end
-
-  test 'does not call enter when loading a persisted record' do
-    assert_equal 'on', @light.power
-    assert_nothing_raised { TrafficLight.find(@light.id) }
-  end
-
-  test 'transition to a valid state' do
-    @light.reset
-    assert @light.red?
-    assert_equal :red, @light.current_state
-
-    @light.green_on
-    assert @light.green?
-    assert_equal :green, @light.current_state
-  end
-
-  test 'transition does not persist state' do
-    @light.reset
-    assert_equal :red, @light.current_state
-    @light.reload
-    assert_equal 'off', @light.state
-  end
-
-  test 'transition does persists state' do
-    @light.reset!
-    assert_equal :red, @light.current_state
-    @light.reload
-    assert_equal 'red', @light.state
-  end
-
-  test 'transition to an invalid state' do
-    assert_raise(Transitions::InvalidTransition) { @light.yellow_on }
-    assert_equal :off, @light.current_state
-  end
-
-  test 'transition with wrong state will not validate' do
-    for s in @light.class.get_state_machine.states
-      @light.state = s.name
-      assert @light.valid?
-    end
-    @light.state = 'invalid_one'
-    assert_false @light.valid?
-  end
-
-  test 'transition raises exception when model validation fails' do
-    validating_light = ValidatingTrafficLight.create!(name: 'Foobar')
-    assert_raise(ActiveRecord::RecordInvalid) do
-      validating_light.reset!
-    end
-  end
-
-  test 'state query method used in a validation condition' do
-    validating_light = ConditionalValidatingTrafficLight.create!
-    assert_raise(ActiveRecord::RecordInvalid) do
-      validating_light.reset!
-    end
-    assert(validating_light.off?)
-  end
-
-  test 'reloading model resets current state' do
-    @light.reset
-    assert @light.red?
-    @light.update_attribute(:state, 'green')
-    assert @light.reload.green?, 'reloaded state should come from database, not instance variable'
-  end
-
-  test 'calling non-bang event updates state attribute' do
-    @light.reset!
-    assert @light.red?
-    @light.green_on
-    assert_equal 'green', @light.state
-    assert_equal 'red', @light.reload.state
-  end
-end
-
-if ActiveRecord::VERSION::MAJOR == 3
-
-  class TestMassAssignmentActiveRecord < Test::Unit::TestCase
-    # attr_protected unfortunately invokes a db call, so this test requires that
-    # we define the class after the table already exists.
-    def setup
-      set_up_db CreateTrafficLights
-
-      @light_with_protected_state = Class.new(TrafficLight) do
-        attr_protected :state
-      end
-    end
-
-    test 'transition does persists state when state is protected' do
-      protected_light = @light_with_protected_state.create!
-      protected_light.reset!
-      assert_equal :red, protected_light.current_state
-      protected_light.reload
-      assert_equal 'red', protected_light.state
-    end
-  end
-end
-
-class TestNewActiveRecord < TestActiveRecord
-  def setup
-    set_up_db CreateTrafficLights
-    @light = TrafficLight.new
-  end
-
-  test 'new active records defaults current state to the initial state' do
-    assert_equal :off, @light.current_state
-  end
-end
-
-class TestScopes < Test::Unit::TestCase
-  test 'scope returns correct object' do
-    @light = TrafficLight.create!
-    assert_respond_to TrafficLight, :off
-    assert_equal TrafficLight.off.first, @light
-    assert TrafficLight.red.empty?
-  end
-
-  test 'scopes exist' do
-    assert_respond_to TrafficLight, :off
-    assert_respond_to TrafficLight, :red
-    assert_respond_to TrafficLight, :green
-    assert_respond_to TrafficLight, :yellow
-  end
-
-  test 'scopes are only generated if we explicitly say so' do
-    assert_not_respond_to LightBulb, :off
-    assert_not_respond_to LightBulb, :on
-  end
-
-  test 'scope generation raises an exception if we try to overwrite an existing method' do
-    assert_raise(Transitions::InvalidMethodOverride) do
-      class Light < ActiveRecord::Base
-        include ActiveModel::Transitions
-
-        state_machine auto_scopes: true do
-          state :new
-          state :broken
-        end
-      end
-    end
-  end
-end
-
-class DifferentTrafficLight < ActiveRecord::Base
-  include ActiveModel::Transitions
-
-  state_machine attribute_name: :different_state, auto_scopes: true do
-    state :off
-
-    state :red
-    state :green
-    state :yellow
-
-    event :red_on do
-      transitions to: :red, from: [:yellow]
-    end
-
-    event :green_on do
-      transitions to: :green, from: [:red]
-    end
-
-    event :yellow_on do
-      transitions to: :yellow, from: [:green]
-    end
-
-    event :reset do
-      transitions to: :red, from: [:off]
-    end
-  end
-end
-
-class TestActiveRecordWithDifferentColumnName < Test::Unit::TestCase
-  def setup
-    set_up_db CreateDifferentTrafficLights
-    @light = DifferentTrafficLight.create!
-  end
-
-  test 'new record has the initial state set' do
-    @light = DifferentTrafficLight.new
-    assert_equal 'off', @light.different_state
-  end
-
-  test 'states initial state' do
-    assert @light.off?
-    assert_equal :off, @light.current_state
-  end
-
-  test 'transition to a valid state' do
-    @light.reset
-    assert @light.red?
-    assert_equal :red, @light.current_state
-
-    @light.green_on
-    assert @light.green?
-    assert_equal :green, @light.current_state
-  end
-
-  test 'transition does not persist state' do
-    @light.reset
-    assert_equal :red, @light.current_state
-    @light.reload
-    assert_equal 'off', @light.different_state
-  end
-
-  test 'transition does persists state' do
-    @light.reset!
-    assert_equal :red, @light.current_state
-    @light.reload
-    assert_equal 'red', @light.different_state
-  end
-
-  test 'transition to an invalid state' do
-    assert_raise(Transitions::InvalidTransition) { @light.yellow_on }
-    assert_equal :off, @light.current_state
-  end
-
-  test 'transition with wrong state will not validate' do
-    for s in @light.class.state_machine.states
-      @light.different_state = s.name
-      assert @light.valid?
-    end
-    @light.different_state = 'invalid_one'
-    assert_false @light.valid?
-  end
-
-  test 'reloading model resets current state' do
-    @light.reset
-    assert @light.red?
-    @light.update_attribute(:different_state, 'green')
-    assert @light.reload.green?, 'reloaded state should come from database, not instance variable'
-  end
-
-  test 'calling non-bang event updates state attribute' do
-    @light.reset!
-    assert @light.red?
-    @light.green_on
-    assert_equal 'green', @light.different_state
-    assert_equal 'red', @light.reload.different_state
-  end
-end