state_pattern 1.2.0 → 1.3.0

data/examples/rails_3_button_example/public/javascripts/rails.js

@@ -0,0 +1,175 @@
+(function() {
+  // Technique from Juriy Zaytsev
+  // http://thinkweb2.com/projects/prototype/detecting-event-support-without-browser-sniffing/
+  function isEventSupported(eventName) {
+    var el = document.createElement('div');
+    eventName = 'on' + eventName;
+    var isSupported = (eventName in el);
+    if (!isSupported) {
+      el.setAttribute(eventName, 'return;');
+      isSupported = typeof el[eventName] == 'function';
+    }
+    el = null;
+    return isSupported;
+  }
+
+  function isForm(element) {
+    return Object.isElement(element) && element.nodeName.toUpperCase() == 'FORM'
+  }
+
+  function isInput(element) {
+    if (Object.isElement(element)) {
+      var name = element.nodeName.toUpperCase()
+      return name == 'INPUT' || name == 'SELECT' || name == 'TEXTAREA'
+    }
+    else return false
+  }
+
+  var submitBubbles = isEventSupported('submit'),
+      changeBubbles = isEventSupported('change')
+
+  if (!submitBubbles || !changeBubbles) {
+    // augment the Event.Handler class to observe custom events when needed
+    Event.Handler.prototype.initialize = Event.Handler.prototype.initialize.wrap(
+      function(init, element, eventName, selector, callback) {
+        init(element, eventName, selector, callback)
+        // is the handler being attached to an element that doesn't support this event?
+        if ( (!submitBubbles && this.eventName == 'submit' && !isForm(this.element)) ||
+             (!changeBubbles && this.eventName == 'change' && !isInput(this.element)) ) {
+          // "submit" => "emulated:submit"
+          this.eventName = 'emulated:' + this.eventName
+        }
+      }
+    )
+  }
+
+  if (!submitBubbles) {
+    // discover forms on the page by observing focus events which always bubble
+    document.on('focusin', 'form', function(focusEvent, form) {
+      // special handler for the real "submit" event (one-time operation)
+      if (!form.retrieve('emulated:submit')) {
+        form.on('submit', function(submitEvent) {
+          var emulated = form.fire('emulated:submit', submitEvent, true)
+          // if custom event received preventDefault, cancel the real one too
+          if (emulated.returnValue === false) submitEvent.preventDefault()
+        })
+        form.store('emulated:submit', true)
+      }
+    })
+  }
+
+  if (!changeBubbles) {
+    // discover form inputs on the page
+    document.on('focusin', 'input, select, texarea', function(focusEvent, input) {
+      // special handler for real "change" events
+      if (!input.retrieve('emulated:change')) {
+        input.on('change', function(changeEvent) {
+          input.fire('emulated:change', changeEvent, true)
+        })
+        input.store('emulated:change', true)
+      }
+    })
+  }
+
+  function handleRemote(element) {
+    var method, url, params;
+
+    var event = element.fire("ajax:before");
+    if (event.stopped) return false;
+
+    if (element.tagName.toLowerCase() === 'form') {
+      method = element.readAttribute('method') || 'post';
+      url    = element.readAttribute('action');
+      params = element.serialize();
+    } else {
+      method = element.readAttribute('data-method') || 'get';
+      url    = element.readAttribute('href');
+      params = {};
+    }
+
+    new Ajax.Request(url, {
+      method: method,
+      parameters: params,
+      evalScripts: true,
+
+      onComplete:    function(request) { element.fire("ajax:complete", request); },
+      onSuccess:     function(request) { element.fire("ajax:success",  request); },
+      onFailure:     function(request) { element.fire("ajax:failure",  request); }
+    });
+
+    element.fire("ajax:after");
+  }
+
+  function handleMethod(element) {
+    var method = element.readAttribute('data-method'),
+        url = element.readAttribute('href'),
+        csrf_param = $$('meta[name=csrf-param]')[0],
+        csrf_token = $$('meta[name=csrf-token]')[0];
+
+    var form = new Element('form', { method: "POST", action: url, style: "display: none;" });
+    element.parentNode.insert(form);
+
+    if (method !== 'post') {
+      var field = new Element('input', { type: 'hidden', name: '_method', value: method });
+      form.insert(field);
+    }
+
+    if (csrf_param) {
+      var param = csrf_param.readAttribute('content'),
+          token = csrf_token.readAttribute('content'),
+          field = new Element('input', { type: 'hidden', name: param, value: token });
+      form.insert(field);
+    }
+
+    form.submit();
+  }
+
+
+  document.on("click", "*[data-confirm]", function(event, element) {
+    var message = element.readAttribute('data-confirm');
+    if (!confirm(message)) event.stop();
+  });
+
+  document.on("click", "a[data-remote]", function(event, element) {
+    if (event.stopped) return;
+    handleRemote(element);
+    event.stop();
+  });
+
+  document.on("click", "a[data-method]", function(event, element) {
+    if (event.stopped) return;
+    handleMethod(element);
+    event.stop();
+  });
+
+  document.on("submit", function(event) {
+    var element = event.findElement(),
+        message = element.readAttribute('data-confirm');
+    if (message && !confirm(message)) {
+      event.stop();
+      return false;
+    }
+
+    var inputs = element.select("input[type=submit][data-disable-with]");
+    inputs.each(function(input) {
+      input.disabled = true;
+      input.writeAttribute('data-original-value', input.value);
+      input.value = input.readAttribute('data-disable-with');
+    });
+
+    var element = event.findElement("form[data-remote]");
+    if (element) {
+      handleRemote(element);
+      event.stop();
+    }
+  });
+
+  document.on("ajax:after", "form", function(event, element) {
+    var inputs = element.select("input[type=submit][disabled=true][data-disable-with]");
+    inputs.each(function(input) {
+      input.value = input.readAttribute('data-original-value');
+      input.removeAttribute('data-original-value');
+      input.disabled = false;
+    });
+  });
+})();

data/examples/rails_3_button_example/public/stylesheets/scaffold.css

@@ -0,0 +1,56 @@
+body { background-color: #fff; color: #333; }
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size:   13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a { color: #000; }
+a:visited { color: #666; }
+a:hover { color: #fff; background-color:#000; }
+
+div.field, div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px;
+  padding-bottom: 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px;
+  margin-bottom: 0px;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}

data/examples/rails_3_button_example/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require File.expand_path('../../config/boot',  __FILE__)
+require 'rails/commands'

data/examples/semaphore.rb

@@ -0,0 +1,58 @@
+  $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+  require 'state_pattern'
+
+    def wait(seconds)
+      seconds.downto(1) do |i|
+        print " #{i}"
+        $stdout.flush
+        sleep 1
+      end
+    end
+
+    class Stop < StatePattern::State
+      def next
+        wait 3
+        transition_to(Go)
+      end
+
+      def color
+        "Red"
+      end
+    end
+
+    class Go < StatePattern::State
+      def next
+        wait 2
+        transition_to(Caution)
+      end
+
+      def color
+        "Green"
+      end
+    end
+
+    class Caution < StatePattern::State
+      def next
+        wait 1
+        transition_to(Stop)
+      end
+
+      def color
+        "Amber"
+      end
+    end
+
+  class TrafficSemaphore
+    include StatePattern
+    set_initial_state Stop
+  end
+
+  semaphore = TrafficSemaphore.new
+
+  loop do
+    print semaphore.color
+    semaphore.next
+    puts
+  end
+
+

data/lib/state_pattern.rb

@@ -79,7 +79,7 @@ module StatePattern
     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
@@ -108,3 +108,5 @@ module StatePattern
     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

@@ -0,0 +1,44 @@
+module StatePattern
+  module ActiveRecord
+    def self.included(base)
+      base.class_eval do
+        include StatePattern
+
+        after_initialize :set_state_from_db
+        def set_state_from_db
+          set_state(state_string_as_class)
+        end
+
+        #enable after_initialize callback
+        if Rails.version >= "3.0.0"
+          def self.after_initialize; end
+        else
+          def after_initialize; end
+        end
+
+        def set_state_with_active_record_attribute(state_class = nil)
+          set_state_without_active_record_attribute(state_class)
+          write_attribute(self.class.state_attribute, @current_state_instance.class.name)
+        end
+        alias_method_chain :set_state, :active_record_attribute
+
+        def state=(new_state_string)
+          set_state(state_string_as_class(new_state_string))
+        end
+
+        def state_string_as_class(state_string = @attributes[self.class.state_attribute])
+          state_string.camelize.constantize unless state_string.nil?
+        end
+
+        def self.state_attribute
+          @state_attribute ||= "state"
+        end
+
+        def self.set_state_attribute(state_attr)
+          @state_attribute = state_attr.to_s
+        end
+      end
+    end
+  end
+end
+

data/rails/init.rb

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

data/test/state_pattern/active_record/active_record_test.rb

@@ -0,0 +1,71 @@
+require 'state_pattern/active_record/test_helper'
+
+class ARButton < ActiveRecord::Base
+  class On < StatePattern::State
+    def press
+      transition_to(Off)
+      "#{stateable.button_name} is off"
+    end
+  end
+
+  class Off < StatePattern::State
+    def press
+      transition_to(On)
+      "#{stateable.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"
+  end
+end
+
+class ARButton2 < ARButton
+  set_state_attribute :state2
+  set_initial_state ARButton::Off
+end
+
+Expectations do
+  expect "ARButton::Off" do
+    ARButton.create.state
+  end
+
+  expect "The button is on" do
+    button = ARButton.create
+    button.press
+  end
+
+  expect "ARButton::On" do
+    button = ARButton.create
+    button.press
+    button.state
+  end
+
+  expect "The button is off" do
+    button = ARButton.create
+    button.state = "ARButton::On"
+    button.press
+  end
+
+  expect "The button is off" do
+    button = ARButton.create
+    button.press
+    button.press
+  end
+
+  expect "ARButton::On" do
+    ARButton.create(:state => "ARButton::On").state
+  end
+
+  expect nil do
+    ARButton2.create.state
+  end
+
+  expect "ARButton::Off" do
+    ARButton2.create.state2
+  end
+end

data/test/state_pattern/active_record/schema.rb

@@ -0,0 +1,7 @@
+::ActiveRecord::Schema.define do
+  create_table "ar_buttons" do |t|
+    t.integer  "button_id"
+    t.string   "state"
+    t.string   "state2"
+  end
+end

data/test/state_pattern/active_record/test_helper.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+require 'active_record'
+
+{
+  "nulldb" => "active_record/connection_adapters/nulldb_adapter",
+  "expectations" => "expectations"
+}.each do |gem_name, require_arg|
+  begin
+    require require_arg
+  rescue LoadError
+    puts "You need to install the #{gem_name} gem to run the tests"
+  end
+end
+
+#Nulldb expects Rails.root to be defined
+class Rails
+  def self.root
+    File.dirname(__FILE__)
+  end
+end
+
+ActiveRecord::Base.establish_connection :adapter => :nulldb, :schema => 'schema.rb'
+
+require 'rails/init'
+require 'state_pattern/active_record'