transitions 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7e55aa8a7f0f38f8999f825fccd4d8d7fe0891c9
-  data.tar.gz: d5fa39fd8b267931511f9f11e5820982ff8fdc80
+  metadata.gz: 0e0eecbbaa7a8c858df9799e370497da5c55691a
+  data.tar.gz: 2aeaec6cb95f64080a9a2a03a19ac1d9885db568
 SHA512:
-  metadata.gz: 4f0b94f49e68756946a20fa98993e6bcd59ae9035647d2b8a6fc2d9475112f8ec5eec3c81a7695a6d1d95ca931dee872adafe1ebb91ca0b83778bf240bba39be
-  data.tar.gz: 100ae8e228de1386b6c5ae2ea83be8ef1974126fb789a15ae121fdeeb88596cbc429671eb6f31bb72cf5b7fc1ad55ff1cffea2244cbfcba07d359415a98427c8
+  metadata.gz: 14bdc0e63e4cad7f5cf626022738509b61878964b1fd5c86eb8c87b6550ad45e8381af5d15333ca021a5c043edf521e8b4a2360d4d3f82d6587bc2537e756818
+  data.tar.gz: 8e5142a6a0448e8cb29b2b4bdd08cb8ac5bd8776ff9c2f16ae7bf900775cb4768fe70e7bbdf5d82f72ed0a006a95288350c3ba9910c4436d5702b585dbfe4c0e

data/.rubocop.yml

@@ -1,4 +1,21 @@
 Metrics/LineLength:
   Max: 120
-Style/Documentation:
+Documentation:
   Enabled: false
+Lint/AssignmentInCondition:
+  Enabled: false
+# For whatever reasons disabling the cops below via source comment does **not** work.
+# This happens only for event.rb, disabling those cops in other files via comment works well.
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/transitions/event.rb'
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/transitions/event.rb'
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - 'lib/transitions/event.rb'
+Style/ConditionalAssignment:
+  Exclude:
+    - 'lib/transitions/event.rb'
+    - 'lib/transitions/state.rb'

data/.travis.yml

@@ -1,12 +1,17 @@
 sudo: false
 cache: bundler
 language: ruby
+bundler_args: --without local_development
+script:
+  - bundle exec rake
 rvm:
   - 2.1
   - 2.2
   - rbx-2
   - jruby
 matrix:
+  allow_failures:
+    - rvm: rbx-2
   fast_finish: true
 notifications:
   email:

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.0.1
+
+* (avyy) Fix @state_machine lookup for Presenter's methods
+
 # 1.0.0
 
 * (troessner) Only support ruby 2.1 and 2.2.

data/Gemfile

@@ -2,11 +2,12 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'activerecord', '~> 3.2.14'
-gem 'activerecord-jdbcsqlite3-adapter', platforms: :jruby
-
-platforms :ruby do
-  gem 'sqlite3'
+group :local_development do
   gem 'pry'
-  gem 'byebug'
+  gem 'sqlite3'
+
+  platforms :mri do
+    gem 'pry-byebug'
+    gem 'pry-stack_explorer'
+  end
 end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Timo Rößner
+
+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/README.md

@@ -57,7 +57,7 @@ class Product
 end
 ```
 In this example we assume that you are in a rails project using Bundler, which
-would automatically require `transitions`. If this is not the case for you you
+would automatically require `transitions`. If this is not the case then you
 have to add
 ```ruby
 require 'transitions'
@@ -69,7 +69,7 @@ wherever you load your dependencies in your application.
 
 *   You can only use one state machine per model. While in theory you can
     define two or more, this won't work as you would expect. Not supporting
-    this was intentional, if you're interested in the ratione look up version
+    this was intentional, if you're interested in the rational look up version
     0.1.0 in the CHANGELOG.
 
 *   Use symbols, not strings for declaring the state machine. Using strings is
@@ -106,13 +106,13 @@ the bang(!)-version will call `save!`.  The `can_discontinue?` method will not
 modify state but instead returns a boolean letting you know if a given
 transition is possible.
 
-In addition, a `can_transition?` method is added to the object that expects one or more event names as arguments. This semi-verbose method name is used to avoid collission with [https://github.com/ryanb/cancan](the authorization gem CanCan).
+In addition, a `can_transition?` method is added to the object that expects one or more event names as arguments. This semi-verbose method name is used to avoid collisions with [https://github.com/ryanb/cancan](the authorization gem CanCan).
 ```ruby
 >> Product.new.can_transition? :out_of_stock
 => true
 ```
 
-If you need to get all available transitions for current state you can simply call:
+If you need to get all available transitions for the current state you can simply call:
 ```ruby
 >> Product.new.available_transitions
 => [:discontinued, :out_of_stock]
@@ -289,6 +289,11 @@ end
 Any arguments passed to the event method will be passed on to the `guard`
 predicate.
 
+Note that guards will **not** raise on failure on their own. This means that if you want to
+treat the failure of a guard exceptional you'll need to raise an exception yourself explicitly
+in that guard (see [here](https://github.com/troessner/transitions/issues/149) for the
+corresponding discussion).
+
 
 #### Timestamps
 

data/Rakefile

@@ -1,14 +1,19 @@
-require 'bundler'
-Bundler::GemHelper.install_tasks
-Bundler.setup
+require 'bundler/gem_tasks'
 
 require 'appraisal'
-
 require 'rake/testtask'
+require 'rubocop/rake_task'
+
 Rake::TestTask.new(:test) do |test|
   test.libs = %w(lib test)
   test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
 
+RuboCop::RakeTask.new do |task|
+  task.options << '--display-cop-names'
+  task.patterns = ['lib/**/*.rb']
+end
+
 task default: :test
+task default: :rubocop

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'transitions'
+
+require 'pry'
+Pry.start

data/lib/active_model/transitions.rb

@@ -3,7 +3,7 @@ module ActiveModel
     extend ActiveSupport::Concern
 
     included do
-      class ::Transitions::Machine
+      ::Transitions::Machine.class_eval do
         unless method_defined?(:new_transitions_initialize) || method_defined?(:new_transitions_update)
           attr_reader :attribute_name
           alias_method :old_transitions_initialize, :initialize
@@ -64,28 +64,35 @@ module ActiveModel
       self[transitions_state_column_name] && self[transitions_state_column_name].to_sym
     end
 
+    #
+    # rubocop:disable Metrics/AbcSize
+    #
     def set_initial_state
-      # In case we use a query with a custom select that excludes our state attribute name we need to skip the initialization below.
-      if self.attribute_names.include?(transitions_state_column_name.to_s) && state_not_set?
-        self[transitions_state_column_name] = self.class.get_state_machine.initial_state.to_s
-        self.class.get_state_machine.state_index[self[transitions_state_column_name].to_sym].call_action(:enter, self)
-      end
+      # In case we use a query with a custom select that excludes our state attribute
+      # name we need to skip the initialization below.
+      return unless attribute_names.include?(transitions_state_column_name.to_s) && state_not_set?
+      self[transitions_state_column_name] = self.class.get_state_machine.initial_state.to_s
+      self.class.get_state_machine.state_index[self[transitions_state_column_name].to_sym].call_action(:enter, self)
     end
 
     def state_presence
-      unless self[transitions_state_column_name].present?
-        errors.add(transitions_state_column_name, :presence)
-      end
+      return if self[transitions_state_column_name].present?
+      errors.add(transitions_state_column_name, :presence)
     end
 
     def state_inclusion
-      unless self.class.get_state_machine.states.map { |s| s.name.to_s }.include?(self[transitions_state_column_name].to_s)
-        errors.add(transitions_state_column_name, :inclusion, value: self[transitions_state_column_name])
-      end
+      return if state_included?
+      errors.add(transitions_state_column_name, :inclusion, value: self[transitions_state_column_name])
     end
 
     def state_not_set?
       self[transitions_state_column_name].nil?
     end
+
+    def state_included?
+      self.class.get_state_machine.states
+          .map { |s| s.name.to_s }
+          .include?(self[transitions_state_column_name].to_s)
+    end
   end
 end

data/lib/transitions.rb

@@ -6,11 +6,13 @@ require 'transitions/state_transition'
 require 'transitions/version'
 
 module Transitions
-  class InvalidTransition     < StandardError; end
+  class InvalidTransition < StandardError; end
   class InvalidMethodOverride < StandardError; end
   include Presenter
 
   module ClassMethods
+    include Presenter
+
     def inherited(klass)
       super # Make sure we call other callbacks possibly defined upstream the ancestor chain.
       klass.state_machine = state_machine
@@ -26,37 +28,34 @@ module Transitions
       block ? @state_machine.update(options, &block) : @state_machine
     end
 
+    # rubocop:disable Style/AccessorMethodName
     def get_state_machine
       @state_machine
     end
-
-    def available_states
-      @state_machine.states.map(&:name).sort_by(&:to_s)
-    end
-
-    def available_events
-      @state_machine.events.keys.sort
-    end
   end
 
   def self.included(base)
     base.extend(ClassMethods)
   end
 
+  def get_state_machine
+    self.class.get_state_machine
+  end
+
   def update_current_state(new_state, persist = false)
-    sm   = self.class.get_state_machine
-    ivar = sm.current_state_variable
+    ivar = get_state_machine.current_state_variable
 
     if Transitions.active_model_descendant?(self.class)
       write_state(new_state) if persist
-      write_state_without_persistence(new_state) # TODO This seems like a duplicate, `write_new` already calls `write_state_without_persistence`.
+      # TODO: This seems like a duplicate, `write_new` already calls `write_state_without_persistence`.
+      write_state_without_persistence(new_state)
     end
 
     instance_variable_set(ivar, new_state)
   end
 
   def available_transitions
-    self.class.get_state_machine.events_for(current_state)
+    get_state_machine.events_for(current_state)
   end
 
   def can_transition?(*events)
@@ -70,7 +69,7 @@ module Transitions
   end
 
   def current_state
-    sm   = self.class.get_state_machine
+    sm   = get_state_machine
     ivar = sm.current_state_variable
 
     value = instance_variable_get(ivar)
@@ -84,6 +83,7 @@ module Transitions
   end
 
   def self.active_model_descendant?(klazz)
-    defined?(ActiveModel) && klazz.included_modules.include?(ActiveModel::Dirty) # Checking directly for "ActiveModel" wouldn't work so we use some arbitrary module close to it.
+    # Checking directly for "ActiveModel" wouldn't work so we use some arbitrary module close to it.
+    defined?(ActiveModel) && klazz.included_modules.include?(ActiveModel::Dirty)
   end
 end

data/lib/transitions/event.rb

@@ -1,9 +1,12 @@
 module Transitions
+  # rubocop:disable Metrics/ClassLength
   class Event
     attr_reader :name, :success, :timestamp
 
     def initialize(machine, name, options = {}, &block)
-      @machine, @name, @transitions = machine, name, []
+      @machine = machine
+      @name = name
+      @transitions = []
       if machine
         machine.klass.send(:define_method, "#{name}!") do |*args|
           machine.fire_event(name, self, true, *args)
@@ -34,12 +37,12 @@ module Transitions
       next_state = nil
       transitions.each do |transition|
         next if to_state && !Array(transition.to).include?(to_state)
-        if transition.executable?(obj, *args)
-          next_state = to_state || Array(transition.to).first
-          transition.execute(obj, *args)
-          update_event_timestamp(obj, next_state) if timestamp_defined?
-          break
-        end
+        next unless transition.executable?(obj, *args)
+
+        next_state = to_state || Array(transition.to).first
+        transition.execute(obj, *args)
+        update_event_timestamp(obj, next_state) if timestamp_defined?
+        break
       end
       # Update timestamps on obj if a timestamp has been defined
       next_state
@@ -53,11 +56,11 @@ module Transitions
       @transitions.select { |t| t.from? state }.any? { |t| t.executable?(obj, *args) }
     end
 
-    def ==(event)
-      if event.is_a? Symbol
-        name == event
+    def ==(other)
+      if other.is_a? Symbol
+        name == other
       else
-        name == event.name
+        name == other.name
       end
     end
 
@@ -100,8 +103,8 @@ module Transitions
 
     # If @timestamp is true, try a default timestamp name
     def default_timestamp_name(obj, next_state)
-      at_name = '%s_at' % next_state
-      on_name = '%s_on' % next_state
+      at_name = "#{next_state}_at"
+      on_name = "#{next_state}_on"
       case
       when obj.respond_to?(at_name) then at_name
       when obj.respond_to?(on_name) then on_name
@@ -128,12 +131,13 @@ module Transitions
       when Proc
         callback_names
       when Symbol
-        lambda { |record| record.send(callback_names) }
+        ->(record) { record.send(callback_names) }
       end
     end
 
     def error_message_for_invalid_transitions(obj)
-      "Can't fire event `#{name}` in current state `#{obj.current_state}` for `#{obj.class.name}` #{obj.class < ActiveRecord::Base && obj.persisted? ? "with ID #{obj.id} " : nil}"
+      "Can't fire event `#{name}` in current state `#{obj.current_state}` for `#{obj.class.name}`"\
+      " #{obj.class < ActiveRecord::Base && obj.persisted? ? "with ID #{obj.id} " : nil}"
     end
   end
 end

data/lib/transitions/machine.rb

@@ -5,7 +5,10 @@ module Transitions
     attr_reader :klass, :auto_scopes
 
     def initialize(klass, options = {}, &block)
-      @klass, @states, @state_index, @events = klass, [], {}, {}
+      @klass = klass
+      @states = []
+      @state_index = {}
+      @events = {}
       update(options, &block)
     end
 
@@ -21,7 +24,9 @@ module Transitions
       self
     end
 
-    # TODO There is still way to much parameter passing around going on down below.
+    #
+    # rubocop:disable Metrics/MethodLength
+    #
     def fire_event(event, record, persist, *args)
       handle_state_exit_callback record
       if new_state = transition_to_new_state(record, event, *args)
@@ -35,12 +40,9 @@ module Transitions
         return false
       end
     rescue => e
-      if record.respond_to?(:event_failed)
-        record.send(:event_failed, event)
-        return false
-      else
-        raise e
-      end
+      raise e unless record.respond_to?(:event_failed)
+      record.send(:event_failed, event)
+      return false
     end
 
     def events_for(state)
@@ -49,7 +51,7 @@ module Transitions
     end
 
     def current_state_variable
-      # TODO Refactor me away.
+      # TODO: Refactor me away.
       :@current_state
     end
 
@@ -68,9 +70,8 @@ module Transitions
     end
 
     def handle_event_fired_callback(record, new_state, event)
-      if record.respond_to?(:event_fired, true)
-        record.send(:event_fired, record.current_state, new_state, event)
-      end
+      return unless record.respond_to?(:event_fired, true)
+      record.send(:event_fired, record.current_state, new_state, event)
     end
 
     def handle_event_success_callback(record, event)
@@ -78,18 +79,16 @@ module Transitions
     end
 
     def handle_event_failed_callback(record, event)
-      if record.respond_to?(:event_failed, true)
-        record.send(:event_failed, event)
-      end
+      return unless record.respond_to?(:event_failed, true)
+      record.send(:event_failed, event)
     end
 
     def state(name, options = {})
-      unless @state_index.key? name # Just ignore duplicates
-        state = State.new(name, machine: self)
-        state.update options
-        @state_index[name] = state
-        @states << state
-      end
+      return if @state_index.key?(name) # Just ignore duplicates
+      state = State.new(name, machine: self)
+      state.update options
+      @state_index[name] = state
+      @states << state
     end
 
     def event(name, options = {}, &block)
@@ -100,7 +99,9 @@ module Transitions
       @states.each do |state|
         state_name = state.name.to_s
         if @klass.respond_to?(state_name)
-          fail InvalidMethodOverride, "Transitions: Can not define scope `#{state_name}` because there is already an equally named method defined - either rename the existing method or the state."
+          fail InvalidMethodOverride,
+               "Transitions: Can not define scope `#{state_name}` because there is already"\
+               'an equally named method defined - either rename the existing method or the state.'
         end
         @klass.scope state_name, -> { @klass.where(@klass.state_machine.attribute_name => state_name) }
       end