transitions 0.0.17 → 0.0.18

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.0.18 (2012-05-18)
+
+* (troessner) Remove `define_state_query_method` from public API
+* (troessner) Do not override existing methods when defining state query methods but warn the user.
+
 # 0.0.17 (2012-05-02):
 
 * (zmillman) Add write_state_without_persistence.

data/lib/transitions/state.rb

@@ -27,7 +27,7 @@ module Transitions
     def initialize(name, options = {})
       @name = name
       if machine = options.delete(:machine)
-        machine.klass.define_state_query_method(name)
+        define_state_query_method(machine)
       end
       update(options)
     end
@@ -63,5 +63,30 @@ module Transitions
       @options = options
       self
     end
+
+    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.
+      if method_already_defined_on_recipient?(machine, method_name)
+        override_warning method_name
+      else
+        machine.klass.send :define_method, method_name do
+          current_state.to_s == state_name.to_s
+        end
+      end
+    end
+
+    def method_already_defined_on_recipient?(machine, method_name)
+      machine.klass.new.respond_to?(method_name)
+    end
+
+    def override_warning(method_name)
+      warning = "Transitions: Can not define method #{method_name} because it is already defined, please rename either the existing method or the state."
+      if Rails && Rails.logger
+        Rails.logger.warn warning
+      else
+        puts warning
+      end
+    end
   end
 end

data/lib/transitions/version.rb

@@ -1,3 +1,3 @@
 module Transitions
-  VERSION = "0.0.17"
+  VERSION = "0.0.18"
 end

data/lib/transitions.rb

@@ -32,7 +32,7 @@ module Transitions
 
   module ClassMethods
     def inherited(klass)
-      super
+      super # Make sure we call other callbacks possibly defined upstream the ancestor chain.
       klass.state_machines = state_machines
     end
 
@@ -40,6 +40,7 @@ module Transitions
       @state_machines ||= {}
     end
 
+    # The only reason we need this method is for the inherited callback.
     def state_machines=(value)
       @state_machines = value ? value.dup : nil
     end
@@ -57,18 +58,13 @@ module Transitions
     def available_states(name = :default)
       state_machines[name].states.map(&:name).sort_by {|x| x.to_s}
     end
-
-    def define_state_query_method(state_name)
-      name = "#{state_name}?"
-      undef_method(name) if method_defined?(name)
-      define_method(name) { current_state.to_s == %(#{state_name}) }
-    end
   end
 
   def self.included(base)
     base.extend(ClassMethods)
   end
 
+  # TODO Do we need this method really? Also, it's not a beauty, refactor at least.
   def current_state(name = nil, new_state = nil, persist = false)
     sm   = self.class.state_machine(name)
     ivar = sm.current_state_variable

data/test/db/create_db.rb

@@ -5,6 +5,9 @@ class CreateDb < ActiveRecord::Migration
       t.string :state
       t.string :name
     end
+    create_table(:bunnies, :force => true) do |t|
+      t.string :state
+    end
     
     create_table(:orders, :force => true) do |t|
       t.string :state

data/test/helper.rb

@@ -7,6 +7,7 @@ require "db/create_db"
 
 require "transitions"
 require "active_model/transitions"
+require 'random_data'
 
 def create_database
   ActiveRecord::Base.establish_connection(:adapter  => "sqlite3", :database => ":memory:")

data/test/test_active_record.rb

@@ -1,6 +1,8 @@
 require "helper"
 require 'active_support/core_ext/module/aliasing'
 
+# TODO Tests here are quite messy, clean up.
+
 ActiveRecord::Base.establish_connection(:adapter  => "sqlite3", :database => ":memory:")
 
 class CreateTrafficLights < ActiveRecord::Migration
@@ -188,34 +190,49 @@ class TestNewActiveRecord < TestActiveRecord
 
 end
 
+class CreateBunnies < ActiveRecord::Migration
+  def self.up
+    create_table(:bunnies) do |t|
+      t.string :state
+    end
+  end
+end
+
+CreateBunnies.migrate(:up)
+
+class Bunny < ActiveRecord::Base
+  include ActiveModel::Transitions
+
+  state_machine :auto_scopes => true do
+    state :hobbling
+  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?
+  def setup
+    create_database
+    @bunny = Bunny.create!
   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
+    assert_respond_to Bunny, :hobbling
+  end
+
+  test "scope returns correct object" do
+    assert_equal Bunny.hobbling.first, @bunny
   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) {
-      class Light < ActiveRecord::Base
+      class TrafficLight < ActiveRecord::Base
         include ActiveModel::Transitions
 
         state_machine :auto_scopes => true do
           state :new
-          state :broken
         end
       end
     }

data/test/test_state.rb

@@ -1,50 +1,50 @@
 require "helper"
 
-class StateTestSubject
-  include Transitions
-
-  state_machine do
-  end
-end
-
 class TestState < Test::Unit::TestCase
   def setup
+    @state_test_subject = Class.new do
+      include Transitions
+      state_machine do
+      end
+    end
     @state_name = :astate
-    @machine = StateTestSubject.state_machine
-    @options = { :crazy_custom_key => "key", :machine => @machine }
+    @machine = @state_test_subject.state_machine
+    @options = { :machine => @machine, :custom_key => :my_key }
+    @state   = Transitions::State.new(@state_name, @options)
   end
 
-  def new_state(options={})
-    Transitions::State.new(@state_name, @options.merge(options))
+  def new_state_name
+    Random.alphanumeric(16)
   end
 
   test "sets the name" do
-    assert_equal :astate, new_state.name
+    assert_equal :astate, @state.name
   end
 
   test "sets the display_name from name" do
-    assert_equal "Astate", new_state.display_name
+    assert_equal "Astate", @state.display_name
   end
 
   test "sets the display_name from options" do
-    assert_equal "A State", new_state(:display => "A State").display_name
+    assert_equal "A State", Transitions::State.new(new_state_name, @options.merge(:display => "A State")).display_name
   end
 
   test "sets the options and expose them as options" do
     @options.delete(:machine)
-    assert_equal @options, new_state.options
+    state = Transitions::State.new new_state_name, @options
+    assert_equal @options, state.options
   end
 
   test "equals a symbol of the same name" do
-    assert_equal new_state, :astate
+    assert_equal @state, :astate
   end
 
   test "equals a State of the same name" do
-    assert_equal new_state, new_state
+    assert_equal @state, @state
   end
 
   test "should send a message to the record for an action if the action is present as a symbol" do
-    state = new_state(:entering => :foo)
+    state = Transitions::State.new new_state_name, @options.merge(:entering => :foo)
 
     record = stub
     record.expects(:foo)
@@ -53,7 +53,7 @@ class TestState < Test::Unit::TestCase
   end
 
   test "should send a message to the record for an action if the action is present as a string" do
-    state = new_state(:entering => "foo")
+    state = Transitions::State.new new_state_name, @options.merge(:entering => "foo")
 
     record = stub
     record.expects(:foo)
@@ -62,7 +62,7 @@ class TestState < Test::Unit::TestCase
   end
 
   test "should call a proc, passing in the record for an action if the action is present" do
-    state = new_state(:entering => Proc.new {|r| r.foobar})
+    state = Transitions::State.new new_state_name, @options.merge(:entering => Proc.new {|r| r.foobar})
 
     record = stub
     record.expects(:foobar)
@@ -70,3 +70,32 @@ class TestState < Test::Unit::TestCase
     state.call_action(:entering, record)
   end
 end
+
+class StateOverrideMethodTestSubject
+  include Transitions
+
+  state_machine do
+  end
+
+  def a_state_name?; :foo; end
+end
+
+
+class TestStateQueryOverrideMethod < Test::Unit::TestCase
+  def setup
+    @state_name = 'a_state_name'
+    @machine = StateOverrideMethodTestSubject.state_machine
+    @options = { :machine => @machine }
+  end
+
+  test "warn on creation when we try to overwrite an existing method" do
+    # TODO
+  end
+
+  test "should not override an already existing method" do
+    Transitions::State.new :dummy, @options
+    expected_result = :foo
+    actual_result   = StateOverrideMethodTestSubject.new.a_state_name?
+    assert_equal expected_result, actual_result
+  end
+end

data/transitions.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "test-unit", "~> 2.2"
   s.add_development_dependency "mocha"
   s.add_development_dependency "rake"
+  s.add_development_dependency "random_data"
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "activerecord", "~> 3"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: transitions
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-02 00:00:00.000000000Z
+date: 2012-05-18 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &80694140 !ruby/object:Gem::Requirement
+  requirement: &76418870 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '1'
   type: :development
   prerelease: false
-  version_requirements: *80694140
+  version_requirements: *76418870
 - !ruby/object:Gem::Dependency
   name: test-unit
-  requirement: &80692960 !ruby/object:Gem::Requirement
+  requirement: &76418470 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: '2.2'
   type: :development
   prerelease: false
-  version_requirements: *80692960
+  version_requirements: *76418470
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &80692570 !ruby/object:Gem::Requirement
+  requirement: &76418120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80692570
+  version_requirements: *76418120
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &80682540 !ruby/object:Gem::Requirement
+  requirement: &76417650 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80682540
+  version_requirements: *76417650
+- !ruby/object:Gem::Dependency
+  name: random_data
+  requirement: &76417170 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *76417170
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &80681530 !ruby/object:Gem::Requirement
+  requirement: &76416820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *80681530
+  version_requirements: *76416820
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &80680830 !ruby/object:Gem::Requirement
+  requirement: &76416030 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,7 +88,7 @@ dependencies:
         version: '3'
   type: :development
   prerelease: false
-  version_requirements: *80680830
+  version_requirements: *76416030
 description: Lightweight state machine extracted from ActiveModel
 email: timo.roessner@googlemail.com
 executables: []
@@ -129,7 +140,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1021171215
+      hash: -1015670387
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: