Add the ability to ignore method conflicts for helpers

CHANGELOG.rdoc

@@ -1,5 +1,6 @@
 == master
 
+* Add the ability to ignore method conflicts for helpers
 * Generate warnings for any helper, not just state helpers, that has a conflicting method defined in the class
 * Fix scopes in Sequel not working if the table name contains double underscores or is not a string/symbol
 * Add full support for chaining state scopes within Sequel integrations

lib/state_machine/machine.rb

@@ -376,6 +376,11 @@ class << self; attr_accessor :default_messages; end
       :invalid_transition => 'cannot transition via "%s"'
     }
 
+    # Whether to ignore any conflicts that are detected for helper methods that
+    # get generated for a machine's owner class.  Default is false.
+    class << self; attr_accessor :ignore_method_conflicts; end
+    @ignore_method_conflicts = false
+
     # The class that the machine is defined in
     attr_accessor :owner_class
 
@@ -619,7 +624,7 @@ def define_helper(scope, method, *args, &block)
       helper_module = @helper_modules.fetch(scope)
 
       if block_given?
-        if conflicting_ancestor = owner_class_ancestor_has_method?(scope, method)
+        if !self.class.ignore_method_conflicts && conflicting_ancestor = owner_class_ancestor_has_method?(scope, method)
           ancestor_name = conflicting_ancestor.name && !conflicting_ancestor.name.empty? ? conflicting_ancestor.name : conflicting_ancestor.to_s
           warn "#{scope == :class ? 'Class' : 'Instance'} method \"#{method}\" is already defined in #{ancestor_name}, use generic helper instead."
         else

test/unit/machine_test.rb

@@ -1192,6 +1192,26 @@ def park
     $stderr = @original_stderr
   end
 
+  def test_should_define_if_ignoring_method_conflicts_and_defined_in_superclass
+    require 'stringio'
+    @original_stderr, $stderr = $stderr, StringIO.new
+    StateMachine::Machine.ignore_method_conflicts = true
+
+    superclass = Class.new do
+      def park
+      end
+    end
+    klass = Class.new(superclass)
+    machine = StateMachine::Machine.new(klass)
+
+    machine.define_helper(:instance, :park) {true}
+    assert_equal '', $stderr.string
+    assert_equal true, klass.new.park
+  ensure
+    StateMachine::Machine.ignore_method_conflicts = false
+    $stderr = @original_stderr
+  end
+
   def test_should_define_nonexistent_methods
     @machine.define_helper(:instance, :state) {'parked'}
     assert_equal 'parked', @object.state
@@ -1342,6 +1362,26 @@ def park
     $stderr = @original_stderr
   end
 
+  def test_should_define_if_ignoring_method_conflicts_and_defined_in_superclass
+    require 'stringio'
+    @original_stderr, $stderr = $stderr, StringIO.new
+    StateMachine::Machine.ignore_method_conflicts = true
+
+    superclass = Class.new do
+      def self.park
+      end
+    end
+    klass = Class.new(superclass)
+    machine = StateMachine::Machine.new(klass)
+
+    machine.define_helper(:class, :park) {true}
+    assert_equal '', $stderr.string
+    assert_equal true, klass.park
+  ensure
+    StateMachine::Machine.ignore_method_conflicts = false
+    $stderr = @original_stderr
+  end
+
   def test_should_define_nonexistent_methods
     @machine.define_helper(:class, :states) {[]}
     assert_equal [], @klass.states