state_pattern 1.3.0 → 2.0.0

data/examples/rails_3_button_example/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/lib/state_pattern.rb

@@ -1,5 +1,5 @@
+require 'forwardable'
 require 'state_pattern/state'
-require 'state_pattern/invalid_transition_exception'
 
 module StatePattern
   def self.included(base)
@@ -13,100 +13,32 @@ module StatePattern
 
     def set_initial_state(state_class)
       @initial_state_class = state_class
-      create_methods
-    end
-
-    def state_methods
-      state_classes_with_their_bases = state_classes.map{|c| c.ancestors.select{|a| a.ancestors.include?(StatePattern::State) && a != StatePattern::State}}.flatten.uniq
-      (state_classes_with_their_bases.map{|state_class| state_class.public_instance_methods(false)}.flatten.uniq - ["enter", "exit"]).map{|s| s.to_sym}
-    end
-
-    def state_events
-      transitions_hash.to_a.flatten.uniq.select{|t| t.respond_to?(:to_sym)}.map{|s| s.to_sym}
-    end
-
-    def state_classes
-      (transitions_hash.to_a << initial_state_class).flatten.uniq.select{|t| t.respond_to?(:ancestors) && t.ancestors.include?(StatePattern::State)}
-    end
-
-    def valid_transitions(transitions_hash)
-      @transitions_hash = transitions_hash
-      @transitions_hash.each do |key, value|
-        @transitions_hash[key] = [value] if !value.respond_to?(:to_ary)
-      end
-      create_methods
-    end
-
-    def transitions_hash
-      @transitions_hash
-    end
-
-  private
-    def create_methods
-      delegate_all_state_methods
-      create_query_methods
-    end
-
-    def delegate_all_state_methods
-      state_methods.each do |state_method|
-        define_method state_method do |*args|
-          delegate_to_state(state_method, *args)
-        end unless respond_to?(state_method)
-      end
+      include ::StatePattern::Delegation
     end
+  end
 
-    def create_query_methods
-      state_classes.each do |state_class|
-        method_name = "#{underscore(state_class.name.split("::").last)}?"
-        define_method method_name do
-          current_state_instance.class == state_class
-        end unless respond_to?(method_name)
-      end
-    end
+  module Delegation
+    extend Forwardable
 
-    def underscore(camel_cased_word)
-      camel_cased_word.to_s.gsub(/\W/, "_")
-      camel_cased_word.to_s.gsub(/::/, '/').
-      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-      gsub(/([a-z\d])([A-Z])/,'\1_\2').
-      tr("-", "_").
-      downcase
+    def self.included(base)
+      def_delegators :current_state_instance, *base.initial_state_class.state_methods
     end
   end
 
-  def set_state(state_class = nil)
-    state_class ||= self.class.initial_state_class
-    return @current_state_instance if @current_state_instance.class == state_class
-    @current_state_instance = state_class.new(self, @current_state_instance)
-  end
-
   def current_state_instance
     set_state if @current_state_instance.nil?
     @current_state_instance
   end
 
-  def delegate_to_state(state_method_name, *args, &block)
-    @current_method = state_method_name.to_sym
-    self.current_state_instance.send(@current_method, *args, &block)
+  def set_state(state_class = self.class.initial_state_class)
+    return @current_state_instance if @current_state_instance.class == state_class
+    @current_state_instance = state_class.new(self, @current_state_instance)
   end
 
   def transition_to(next_state_class)
-    raise_invalid_transition_to(next_state_class) unless valid_transition?(current_state_instance.class, next_state_class)
     current_state_instance.exit
     set_state(next_state_class)
   end
-
-  def raise_invalid_transition_to(state_class)
-    raise InvalidTransitionException.new(current_state_instance.class, state_class, @current_method)
-  end
-
-  def valid_transition?(from_state, to_state)
-    transitions = self.class.transitions_hash
-    return true if transitions.nil?
-
-    valid_transition_targets = transitions[from_state] || transitions[[from_state, @current_method]]
-    valid_transition_targets && valid_transition_targets.include?(to_state)
-  end
 end
 
 require 'state_pattern/active_record' if defined? ActiveRecord::Base

data/lib/state_pattern/active_record.rb

@@ -6,7 +6,7 @@ module StatePattern
 
         after_initialize :set_state_from_db
         def set_state_from_db
-          set_state(state_string_as_class)
+          set_state(state_string_as_class || self.class.initial_state_class)
         end
 
         #enable after_initialize callback
@@ -16,7 +16,7 @@ module StatePattern
           def after_initialize; end
         end
 
-        def set_state_with_active_record_attribute(state_class = nil)
+        def set_state_with_active_record_attribute(state_class)
           set_state_without_active_record_attribute(state_class)
           write_attribute(self.class.state_attribute, @current_state_instance.class.name)
         end

data/lib/state_pattern/state.rb

@@ -1,14 +1,18 @@
 module StatePattern
   class State
-    attr_reader :stateable, :previous_state
-    def initialize(stateable, previous_state)
-      @stateable = stateable
+    attr_reader :stateful, :previous_state
+    def initialize(stateful, previous_state)
+      @stateful = stateful
       @previous_state = previous_state
       enter
     end
 
+    def self.state_methods
+      public_instance_methods - State.public_instance_methods
+    end
+
     def transition_to(state_class)
-      @stateable.transition_to(state_class)
+      @stateful.transition_to(state_class)
     end
 
     def enter

data/rails/init.rb

@@ -1,3 +1,2 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'vendor/state_pattern/lib'))
 require 'state_pattern'
 

data/test/hook_test.rb

@@ -4,15 +4,15 @@ module Hooks
   class On < StatePattern::State
     def press
       transition_to(Off)
-      stateable.messages << "#{stateable.button_name} is off"
+      stateful.messages << "#{stateful.button_name} is off"
     end
 
     def enter
-      stateable.messages << "Entered the On state"
+      stateful.messages << "Entered the On state"
     end
 
     def exit
-      stateable.messages << "Exited the On state"
+      stateful.messages << "Exited the On state"
     end
 
   private 
@@ -23,22 +23,21 @@ module Hooks
   class Off < StatePattern::State
     def press
       transition_to(On)
-      stateable.messages << "#{stateable.button_name} is on"
+      stateful.messages << "#{stateful.button_name} is on"
     end
 
     def enter
-      stateable.messages << "Entered the Off state"
+      stateful.messages << "Entered the Off state"
     end
 
     def exit
-      stateable.messages << "Exited the Off state"
+      stateful.messages << "Exited the Off state"
     end
   end
 
   class Button
     include StatePattern
     set_initial_state Off
-    valid_transitions [On, :press] => Off, [Off, :press] => On
 
     def button_name
       "Button"

data/test/state_pattern/active_record/active_record_test.rb

@@ -4,20 +4,19 @@ class ARButton < ActiveRecord::Base
   class On < StatePattern::State
     def press
       transition_to(Off)
-      "#{stateable.button_name} is off"
+      "#{stateful.button_name} is off"
     end
   end
 
   class Off < StatePattern::State
     def press
       transition_to(On)
-      "#{stateable.button_name} is on"
+      "#{stateful.button_name} is on"
     end
   end
 
   include StatePattern::ActiveRecord
   set_initial_state Off
-  valid_transitions [On, :press] => Off, [Off, :press] => On
 
   def button_name
     "The button"

data/test/state_pattern/active_record/test_helper.rb

@@ -1,4 +1,5 @@
 require 'test_helper'
+require 'rails'
 require 'active_record'
 
 {
@@ -13,7 +14,7 @@ require 'active_record'
 end
 
 #Nulldb expects Rails.root to be defined
-class Rails
+module Rails
   def self.root
     File.dirname(__FILE__)
   end

data/test/state_pattern_test.rb

@@ -4,7 +4,7 @@ module Family
   class James < StatePattern::State
     def name
       transition_to(Lynn)
-      "James #{stateable.last_name}"
+      "James #{stateful.last_name}"
     end
 
     def james_method
@@ -14,18 +14,19 @@ module Family
   class Lynn < StatePattern::State
     def name
       transition_to(James)
-      "Lynn #{stateable.last_name}"
+      "Lynn #{stateful.last_name}"
+    end
+
+    def james_method
     end
   end
 
   class Member
     include StatePattern
     set_initial_state Lynn
-    valid_transitions [James, :name] => Lynn, [Lynn, :name] => James
 
-    #notice this method is optional, it will be delegated automatically if removed
     def name
-      delegate_to_state :name
+      super
     end
 
     def last_name
@@ -37,20 +38,20 @@ end
 Expectations do
   expect "Lynn Holbrook" do
     member = Family::Member.new
-    member.name 
+    member.name
   end
 
   expect "James Holbrook" do
     member = Family::Member.new
-    member.name 
-    member.name 
+    member.name
+    member.name
   end
 
   expect "Lynn Holbrook" do
     member = Family::Member.new
-    member.name 
-    member.name 
-    member.name 
+    member.name
+    member.name
+    member.name
   end
 
   expect true do

data/test/test_class_creation_helper.rb

@@ -23,17 +23,6 @@ module TestClassCreationHelper
     created_consts << create_class(main_state_module_name) do
       include StatePattern
       set_initial_state Object.const_get(options[:initial_state]) if options.has_key?(:initial_state)
-      if options.has_key?(:valid_transitions)
-        valid_transitions_with_constants = {}
-        options[:valid_transitions].each do |from_module_string_or_array, to_module_string|
-          if from_module_string_or_array.respond_to?(:to_ary)
-            valid_transitions_with_constants[[Object.const_get(from_module_string_or_array.first), from_module_string_or_array.last]] = Object.const_get(to_module_string)
-          else
-            valid_transitions_with_constants[Object.const_get(from_module_string_or_array)] = Object.const_get(to_module_string)
-          end
-        end
-        valid_transitions valid_transitions_with_constants
-      end
     end
 
     begin

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: state_pattern
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 15
   prerelease: false
   segments: 
-  - 1
-  - 3
+  - 2
   - 0
-  version: 1.3.0
+  - 0
+  version: 2.0.0
 platform: ruby
 authors: 
 - Daniel Cadenas
@@ -36,7 +36,6 @@ files:
 - Rakefile
 - rails/init.rb
 - ./lib/state_pattern/active_record.rb
-- ./lib/state_pattern/invalid_transition_exception.rb
 - ./lib/state_pattern/state.rb
 - ./lib/state_pattern.rb
 - ./examples/rails_2_3_8_button_example/app/controllers/application_controller.rb
@@ -91,6 +90,10 @@ files:
 - ./examples/rails_3_button_example/app/models/button/off.rb
 - ./examples/rails_3_button_example/app/models/button/on.rb
 - ./examples/rails_3_button_example/app/models/button.rb
+- ./examples/rails_3_button_example/app/views/buttons/_form.html.erb
+- ./examples/rails_3_button_example/app/views/buttons/edit.html.erb
+- ./examples/rails_3_button_example/app/views/buttons/index.html.erb
+- ./examples/rails_3_button_example/app/views/buttons/new.html.erb
 - ./examples/rails_3_button_example/app/views/buttons/show.html.erb
 - ./examples/rails_3_button_example/app/views/layouts/application.html.erb
 - ./examples/rails_3_button_example/config/application.rb
@@ -98,6 +101,8 @@ files:
 - ./examples/rails_3_button_example/config/database.yml
 - ./examples/rails_3_button_example/config/environment.rb
 - ./examples/rails_3_button_example/config/environments/development.rb
+- ./examples/rails_3_button_example/config/environments/production.rb
+- ./examples/rails_3_button_example/config/environments/test.rb
 - ./examples/rails_3_button_example/config/initializers/backtrace_silencers.rb
 - ./examples/rails_3_button_example/config/initializers/inflections.rb
 - ./examples/rails_3_button_example/config/initializers/mime_types.rb
@@ -114,22 +119,24 @@ files:
 - ./examples/rails_3_button_example/Gemfile.lock
 - ./examples/rails_3_button_example/log/development.log
 - ./examples/rails_3_button_example/public/javascripts/application.js
+- ./examples/rails_3_button_example/public/javascripts/controls.js
+- ./examples/rails_3_button_example/public/javascripts/dragdrop.js
+- ./examples/rails_3_button_example/public/javascripts/effects.js
 - ./examples/rails_3_button_example/public/javascripts/prototype.js
 - ./examples/rails_3_button_example/public/javascripts/rails.js
+- ./examples/rails_3_button_example/public/robots.txt
 - ./examples/rails_3_button_example/public/stylesheets/scaffold.css
 - ./examples/rails_3_button_example/Rakefile
 - ./examples/rails_3_button_example/script/rails
 - ./examples/semaphore.rb
 - ./test/arguments_of_event_delegation_test.rb
 - ./test/hook_test.rb
-- ./test/querying_test.rb
 - ./test/state_pattern/active_record/active_record_test.rb
 - ./test/state_pattern/active_record/schema.rb
 - ./test/state_pattern/active_record/test_helper.rb
 - ./test/state_pattern_test.rb
 - ./test/test_class_creation_helper.rb
 - ./test/test_helper.rb
-- ./test/transition_validations_test.rb
 has_rdoc: true
 homepage: http://github.com/dcadenas/state_pattern
 licenses: []
@@ -217,6 +224,10 @@ test_files:
 - ./examples/rails_3_button_example/app/models/button/off.rb
 - ./examples/rails_3_button_example/app/models/button/on.rb
 - ./examples/rails_3_button_example/app/models/button.rb
+- ./examples/rails_3_button_example/app/views/buttons/_form.html.erb
+- ./examples/rails_3_button_example/app/views/buttons/edit.html.erb
+- ./examples/rails_3_button_example/app/views/buttons/index.html.erb
+- ./examples/rails_3_button_example/app/views/buttons/new.html.erb
 - ./examples/rails_3_button_example/app/views/buttons/show.html.erb
 - ./examples/rails_3_button_example/app/views/layouts/application.html.erb
 - ./examples/rails_3_button_example/config/application.rb
@@ -224,6 +235,8 @@ test_files:
 - ./examples/rails_3_button_example/config/database.yml
 - ./examples/rails_3_button_example/config/environment.rb
 - ./examples/rails_3_button_example/config/environments/development.rb
+- ./examples/rails_3_button_example/config/environments/production.rb
+- ./examples/rails_3_button_example/config/environments/test.rb
 - ./examples/rails_3_button_example/config/initializers/backtrace_silencers.rb
 - ./examples/rails_3_button_example/config/initializers/inflections.rb
 - ./examples/rails_3_button_example/config/initializers/mime_types.rb
@@ -240,19 +253,21 @@ test_files:
 - ./examples/rails_3_button_example/Gemfile.lock
 - ./examples/rails_3_button_example/log/development.log
 - ./examples/rails_3_button_example/public/javascripts/application.js
+- ./examples/rails_3_button_example/public/javascripts/controls.js
+- ./examples/rails_3_button_example/public/javascripts/dragdrop.js
+- ./examples/rails_3_button_example/public/javascripts/effects.js
 - ./examples/rails_3_button_example/public/javascripts/prototype.js
 - ./examples/rails_3_button_example/public/javascripts/rails.js
+- ./examples/rails_3_button_example/public/robots.txt
 - ./examples/rails_3_button_example/public/stylesheets/scaffold.css
 - ./examples/rails_3_button_example/Rakefile
 - ./examples/rails_3_button_example/script/rails
 - ./examples/semaphore.rb
 - ./test/arguments_of_event_delegation_test.rb
 - ./test/hook_test.rb
-- ./test/querying_test.rb
 - ./test/state_pattern/active_record/active_record_test.rb
 - ./test/state_pattern/active_record/schema.rb
 - ./test/state_pattern/active_record/test_helper.rb
 - ./test/state_pattern_test.rb
 - ./test/test_class_creation_helper.rb
 - ./test/test_helper.rb
-- ./test/transition_validations_test.rb