RubyGems - spree-state_machine - Versions diffs - 2.0.0.beta1 - Mend

spree-state_machine 2.0.0.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (140) hide show

checksums.yaml +7 -0
data/.gitignore +8 -0
data/.travis.yml +12 -0
data/.yardopts +5 -0
data/CHANGELOG.md +502 -0
data/Gemfile +3 -0
data/LICENSE +20 -0
data/README.md +1246 -0
data/Rakefile +20 -0
data/examples/AutoShop_state.png +0 -0
data/examples/Car_state.png +0 -0
data/examples/Gemfile +5 -0
data/examples/Gemfile.lock +14 -0
data/examples/TrafficLight_state.png +0 -0
data/examples/Vehicle_state.png +0 -0
data/examples/auto_shop.rb +13 -0
data/examples/car.rb +21 -0
data/examples/doc/AutoShop.html +2856 -0
data/examples/doc/AutoShop_state.png +0 -0
data/examples/doc/Car.html +919 -0
data/examples/doc/Car_state.png +0 -0
data/examples/doc/TrafficLight.html +2230 -0
data/examples/doc/TrafficLight_state.png +0 -0
data/examples/doc/Vehicle.html +7921 -0
data/examples/doc/Vehicle_state.png +0 -0
data/examples/doc/_index.html +136 -0
data/examples/doc/class_list.html +47 -0
data/examples/doc/css/common.css +1 -0
data/examples/doc/css/full_list.css +55 -0
data/examples/doc/css/style.css +322 -0
data/examples/doc/file_list.html +46 -0
data/examples/doc/frames.html +13 -0
data/examples/doc/index.html +136 -0
data/examples/doc/js/app.js +205 -0
data/examples/doc/js/full_list.js +173 -0
data/examples/doc/js/jquery.js +16 -0
data/examples/doc/method_list.html +734 -0
data/examples/doc/top-level-namespace.html +105 -0
data/examples/merb-rest/controller.rb +51 -0
data/examples/merb-rest/model.rb +28 -0
data/examples/merb-rest/view_edit.html.erb +24 -0
data/examples/merb-rest/view_index.html.erb +23 -0
data/examples/merb-rest/view_new.html.erb +13 -0
data/examples/merb-rest/view_show.html.erb +17 -0
data/examples/rails-rest/controller.rb +43 -0
data/examples/rails-rest/migration.rb +7 -0
data/examples/rails-rest/model.rb +23 -0
data/examples/rails-rest/view__form.html.erb +34 -0
data/examples/rails-rest/view_edit.html.erb +6 -0
data/examples/rails-rest/view_index.html.erb +25 -0
data/examples/rails-rest/view_new.html.erb +5 -0
data/examples/rails-rest/view_show.html.erb +19 -0
data/examples/traffic_light.rb +9 -0
data/examples/vehicle.rb +33 -0
data/lib/state_machine/assertions.rb +36 -0
data/lib/state_machine/branch.rb +225 -0
data/lib/state_machine/callback.rb +236 -0
data/lib/state_machine/core.rb +7 -0
data/lib/state_machine/core_ext/class/state_machine.rb +5 -0
data/lib/state_machine/core_ext.rb +2 -0
data/lib/state_machine/error.rb +13 -0
data/lib/state_machine/eval_helpers.rb +87 -0
data/lib/state_machine/event.rb +257 -0
data/lib/state_machine/event_collection.rb +141 -0
data/lib/state_machine/extensions.rb +149 -0
data/lib/state_machine/graph.rb +92 -0
data/lib/state_machine/helper_module.rb +17 -0
data/lib/state_machine/initializers/rails.rb +25 -0
data/lib/state_machine/initializers.rb +4 -0
data/lib/state_machine/integrations/active_model/locale.rb +11 -0
data/lib/state_machine/integrations/active_model/observer.rb +33 -0
data/lib/state_machine/integrations/active_model/observer_update.rb +42 -0
data/lib/state_machine/integrations/active_model/versions.rb +31 -0
data/lib/state_machine/integrations/active_model.rb +585 -0
data/lib/state_machine/integrations/active_record/locale.rb +20 -0
data/lib/state_machine/integrations/active_record/versions.rb +123 -0
data/lib/state_machine/integrations/active_record.rb +525 -0
data/lib/state_machine/integrations/base.rb +100 -0
data/lib/state_machine/integrations.rb +121 -0
data/lib/state_machine/machine.rb +2287 -0
data/lib/state_machine/machine_collection.rb +74 -0
data/lib/state_machine/macro_methods.rb +522 -0
data/lib/state_machine/matcher.rb +123 -0
data/lib/state_machine/matcher_helpers.rb +54 -0
data/lib/state_machine/node_collection.rb +222 -0
data/lib/state_machine/path.rb +120 -0
data/lib/state_machine/path_collection.rb +90 -0
data/lib/state_machine/state.rb +297 -0
data/lib/state_machine/state_collection.rb +112 -0
data/lib/state_machine/state_context.rb +138 -0
data/lib/state_machine/transition.rb +470 -0
data/lib/state_machine/transition_collection.rb +245 -0
data/lib/state_machine/version.rb +3 -0
data/lib/state_machine/yard/handlers/base.rb +32 -0
data/lib/state_machine/yard/handlers/event.rb +25 -0
data/lib/state_machine/yard/handlers/machine.rb +344 -0
data/lib/state_machine/yard/handlers/state.rb +25 -0
data/lib/state_machine/yard/handlers/transition.rb +47 -0
data/lib/state_machine/yard/handlers.rb +12 -0
data/lib/state_machine/yard/templates/default/class/html/setup.rb +30 -0
data/lib/state_machine/yard/templates/default/class/html/state_machines.erb +12 -0
data/lib/state_machine/yard/templates.rb +3 -0
data/lib/state_machine/yard.rb +8 -0
data/lib/state_machine.rb +8 -0
data/lib/yard-state_machine.rb +2 -0
data/state_machine.gemspec +22 -0
data/test/files/en.yml +17 -0
data/test/files/switch.rb +15 -0
data/test/functional/state_machine_test.rb +1066 -0
data/test/test_helper.rb +7 -0
data/test/unit/assertions_test.rb +40 -0
data/test/unit/branch_test.rb +969 -0
data/test/unit/callback_test.rb +704 -0
data/test/unit/error_test.rb +43 -0
data/test/unit/eval_helpers_test.rb +270 -0
data/test/unit/event_collection_test.rb +398 -0
data/test/unit/event_test.rb +1196 -0
data/test/unit/graph_test.rb +98 -0
data/test/unit/helper_module_test.rb +17 -0
data/test/unit/integrations/active_model_test.rb +1245 -0
data/test/unit/integrations/active_record_test.rb +2551 -0
data/test/unit/integrations/base_test.rb +104 -0
data/test/unit/integrations_test.rb +71 -0
data/test/unit/invalid_event_test.rb +20 -0
data/test/unit/invalid_parallel_transition_test.rb +18 -0
data/test/unit/invalid_transition_test.rb +115 -0
data/test/unit/machine_collection_test.rb +603 -0
data/test/unit/machine_test.rb +3395 -0
data/test/unit/matcher_helpers_test.rb +37 -0
data/test/unit/matcher_test.rb +155 -0
data/test/unit/node_collection_test.rb +362 -0
data/test/unit/path_collection_test.rb +266 -0
data/test/unit/path_test.rb +485 -0
data/test/unit/state_collection_test.rb +352 -0
data/test/unit/state_context_test.rb +441 -0
data/test/unit/state_machine_test.rb +31 -0
data/test/unit/state_test.rb +1101 -0
data/test/unit/transition_collection_test.rb +2168 -0
data/test/unit/transition_test.rb +1558 -0
metadata +264 -0

data/examples/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,105 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.7.5
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a id="class_list_link" href="#">Class List</a>
+    <a id="method_list_link" href="#">Method List</a>
+    <a id="file_list_link" href="#">File List</a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><h1>Top Level Namespace
+</h1>
+<dl class="box">
+</dl>
+<div class="clear"></div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="AutoShop.html" title="AutoShop (class)">AutoShop</a></span>, <span class='object_link'><a href="Car.html" title="Car (class)">Car</a></span>, <span class='object_link'><a href="TrafficLight.html" title="TrafficLight (class)">TrafficLight</a></span>, <span class='object_link'><a href="Vehicle.html" title="Vehicle (class)">Vehicle</a></span>
+</p>
+</div>
+    <div id="footer">
+  Generated on Fri Feb 17 08:30:35 2012 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.7.5 (ruby-1.9.2).
+</div>
+  </body>
+</html>

data/examples/merb-rest/controller.rb ADDED Viewed

@@ -0,0 +1,51 @@
+class Users < Application
+  # GET /users
+  def index
+    @users = User.all
+    display @users
+  end
+  # GET /users/1
+  def show(id)
+    @user = User.get(id)
+    raise NotFound unless @user
+    display @user
+  end
+  # GET /users/new
+  def new
+    only_provides :html
+    @user = User.new
+    display @user
+  end
+  # GET /users/1/edit
+  def edit(id)
+    only_provides :html
+    @user = User.get(id)
+    raise NotFound unless @user
+    display @user
+  end
+  # POST /users
+  def create(user)
+    @user = User.new(user)
+    if @user.save
+      redirect resource(@user), :message => {:notice => "User was successfully created"}
+    else
+      message[:error] = "User failed to be created"
+      render :new
+    end
+  end
+  # PUT /users/1
+  def update(id, user)
+    @user = User.get(id)
+    raise NotFound unless @user
+    if @user.update_attributes(user)
+       redirect resource(@user)
+    else
+      display @user, :edit
+    end
+  end
+end

data/examples/merb-rest/model.rb ADDED Viewed

@@ -0,0 +1,28 @@
+class User
+  include DataMapper::Resource
+  property :id, Serial
+  property :name, String
+  validates_present :name, :state, :access_state
+  state_machine :initial => :unregistered do
+    event :register do
+      transition :unregistered => :registered
+    end
+    event :unregister do
+      transition :registered => :unregistered
+    end
+  end
+  state_machine :access_state, :initial => :enabled do
+    event :enable do
+      transition all => :enabled
+    end
+    event :disable do
+      transition all => :disabled
+    end
+  end
+end

data/examples/merb-rest/view_edit.html.erb ADDED Viewed

@@ -0,0 +1,24 @@
+<h1>Editing User</h1>
+<%= form_for @user, :action => resource(@user) do %>
+  <%= error_messages %>
+  <p>
+    <%= text_field :name, :label => 'Name' %>
+  </p>
+  <p>
+    <%= label :state %><br />
+    <%= select :state_event, :selected => @user.state_event.to_s, :collection => @user.state_transitions, :value_method => :event, :text_method => :human_to_name, :prompt => @user.human_state_name %>
+  </p>
+  <p>
+    <%= label :access_state %><br />
+    <%= select :access_state_event, :selected => @user.access_state_event.to_s, :collection => @user.access_state_transitions, :value_method => :event, :text_method => :human_event, :prompt => "don't change" %>
+  </p>
+  <p><%= submit 'Update' %></p>
+<% end =%>
+<%= link_to 'Show', resource(@user) %> |
+<%= link_to 'Back', resource(:users) %>

data/examples/merb-rest/view_index.html.erb ADDED Viewed

@@ -0,0 +1,23 @@
+<h1>Listing Users</h1>
+<table>
+  <tr>
+    <th>Name</th>
+    <th>State</th>
+    <th>Access State</th>
+  </tr>
+<% @users.each do |user| %>
+  <tr>
+    <td><%=h user.name %></td>
+    <td><%=h user.human_state_name %></td>
+    <td><%=h user.human_access_state_name %></td>
+    <td><%= link_to 'Show', resource(user) %></td>
+    <td><%= link_to 'Edit', resource(user, :edit) %></td>
+  </tr>
+<% end %>
+</table>
+<br />
+<%= link_to 'New User', resource(:users, :new) %>

data/examples/merb-rest/view_new.html.erb ADDED Viewed

@@ -0,0 +1,13 @@
+<h1>New User</h1>
+<%= form_for @user, :action => resource(:users) do %>
+  <%= error_messages %>
+  <p>
+    <%= text_field :name, :label => 'Name' %>
+  </p>
+  <p><%= submit 'Create' %></p>
+<% end =%>
+<%= link_to 'Back', resource(:users) %>

data/examples/merb-rest/view_show.html.erb ADDED Viewed

@@ -0,0 +1,17 @@
+<p>
+  <b>Name:</b>
+  <%=h @user.name %>
+</p>
+<p>
+  <b>State:</b>
+  <%=h @user.human_state_name %>
+</p>
+<p>
+  <b>Access State:</b>
+  <%=h @user.human_access_state_name %>
+</p>
+<%= link_to 'Edit', resource(@user, :edit) %> |
+<%= link_to 'Back', resource(:users) %>

data/examples/rails-rest/controller.rb ADDED Viewed

@@ -0,0 +1,43 @@
+class UsersController < ApplicationController
+  # GET /users
+  def index
+    @users = User.all
+  end
+  # GET /users/1
+  def show
+    @user = User.find(params[:id])
+  end
+  # GET /users/new
+  def new
+    @user = User.new
+  end
+  # GET /users/1/edit
+  def edit
+    @user = User.find(params[:id])
+  end
+  # POST /users
+  def create
+    @user = User.new(params[:user])
+    if @user.save
+      redirect_to(@user)
+    else
+      render :action => 'new'
+    end
+  end
+  # PUT /users/1
+  def update
+    @user = User.find(params[:id])
+    if @user.update_attributes(params[:user])
+      redirect_to(@user)
+    else
+      render :action => 'edit'
+    end
+  end
+end

data/examples/rails-rest/migration.rb ADDED Viewed

@@ -0,0 +1,7 @@
+class CreateUsers < ActiveRecord::Migration
+  def change
+    create_table :users do |t|
+      t.string :name, :state, :access_state
+    end
+  end
+end

data/examples/rails-rest/model.rb ADDED Viewed

@@ -0,0 +1,23 @@
+class User < ActiveRecord::Base
+  validates_presence_of :name, :state, :access_state
+  state_machine :initial => :unregistered do
+    event :register do
+      transition :unregistered => :registered
+    end
+    event :unregister do
+      transition :registered => :unregistered
+    end
+  end
+  state_machine :access_state, :initial => :enabled do
+    event :enable do
+      transition all => :enabled
+    end
+    event :disable do
+      transition all => :disabled
+    end
+  end
+end

data/examples/rails-rest/view__form.html.erb ADDED Viewed

@@ -0,0 +1,34 @@
+<%= form_for(@user) do |f| %>
+  <% if @user.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@user.errors.count, "error") %> prohibited this user from being saved:</h2>
+      <ul>
+      <% @user.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+  <div class="field">
+    <%= f.label :name %><br />
+    <%= f.text_field :name %>
+  </div>
+  <% unless @user.new_record? %>
+  <div class="field">
+    <%= f.label :state %><br />
+    <%= f.collection_select :state_event, @user.state_transitions, :event, :human_to_name, :include_blank => @user.human_state_name %>
+  </div>
+  <div class="field">
+    <%= f.label :access_state %><br />
+    <%= f.collection_select :access_state_event, @user.access_state_transitions, :event, :human_event, :include_blank => "don't change" %>
+  </div>
+  <% end %>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/examples/rails-rest/view_edit.html.erb ADDED Viewed

@@ -0,0 +1,6 @@
+<h1>Editing user</h1>
+<%= render 'form' %>
+<%= link_to 'Show', @user %> |
+<%= link_to 'Back', users_path %>

data/examples/rails-rest/view_index.html.erb ADDED Viewed

@@ -0,0 +1,25 @@
+<h1>Listing users</h1>
+<table>
+  <tr>
+    <th>Name</th>
+    <th>State</th>
+    <th>Access State</th>
+    <th></th>
+    <th></th>
+  </tr>
+<% @users.each do |user| %>
+  <tr>
+    <td><%= user.name %></td>
+    <td><%= user.human_state_name %></td>
+    <td><%= user.human_access_state_name %></td>
+    <td><%= link_to 'Show', user %></td>
+    <td><%= link_to 'Edit', edit_user_path(user) %></td>
+  </tr>
+<% end %>
+</table>
+<br />
+<%= link_to 'New User', new_user_path %>

data/examples/rails-rest/view_new.html.erb ADDED Viewed

@@ -0,0 +1,5 @@
+<h1>New user</h1>
+<%= render 'form' %>
+<%= link_to 'Back', users_path %>

data/examples/rails-rest/view_show.html.erb ADDED Viewed

@@ -0,0 +1,19 @@
+<p id="notice"><%= notice %></p>
+<p>
+  <b>Name:</b>
+  <%= @user.name %>
+</p>
+<p>
+  <b>State:</b>
+  <%= @user.human_state_name %>
+</p>
+<p>
+  <b>Access State:</b>
+  <%= @user.human_access_state_name %>
+</p>
+<%= link_to 'Edit', edit_user_path(@user) %> |
+<%= link_to 'Back', users_path %>

data/examples/traffic_light.rb ADDED Viewed

@@ -0,0 +1,9 @@
+require 'state_machine'
+class TrafficLight
+  state_machine :initial => :stop do
+    event :cycle do
+      transition :stop => :proceed, :proceed => :caution, :caution => :stop
+    end
+  end
+end

data/examples/vehicle.rb ADDED Viewed

@@ -0,0 +1,33 @@
+require 'state_machine'
+class Vehicle
+  state_machine :initial => :parked do
+    event :park do
+      transition [:idling, :first_gear] => :parked
+    end
+    event :ignite do
+      transition :stalled => same, :parked => :idling
+    end
+    event :idle do
+      transition :first_gear => :idling
+    end
+    event :shift_up do
+      transition :idling => :first_gear, :first_gear => :second_gear, :second_gear => :third_gear
+    end
+    event :shift_down do
+      transition :third_gear => :second_gear, :second_gear => :first_gear
+    end
+    event :crash do
+      transition [:first_gear, :second_gear, :third_gear] => :stalled
+    end
+    event :repair do
+      transition :stalled => :parked
+    end
+  end
+end

data/lib/state_machine/assertions.rb ADDED Viewed

@@ -0,0 +1,36 @@
+module StateMachine
+  # Provides a set of helper methods for making assertions about the content
+  # of various objects
+  module Assertions
+    # Validates that the given hash *only* includes the specified valid keys.
+    # If any invalid keys are found, an ArgumentError will be raised.
+    #
+    # == Examples
+    #
+    #   options = {:name => 'John Smith', :age => 30}
+    #
+    #   assert_valid_keys(options, :name)           # => ArgumentError: Invalid key(s): age
+    #   assert_valid_keys(options, 'name', 'age')   # => ArgumentError: Invalid key(s): age, name
+    #   assert_valid_keys(options, :name, :age)     # => nil
+    def assert_valid_keys(hash, *valid_keys)
+      invalid_keys = hash.keys - valid_keys
+      raise ArgumentError, "Invalid key(s): #{invalid_keys.join(', ')}" unless invalid_keys.empty?
+    end
+    # Validates that the given hash only includes at *most* one of a set of
+    # exclusive keys.  If more than one key is found, an ArgumentError will be
+    # raised.
+    #
+    # == Examples
+    #
+    #   options = {:only => :on, :except => :off}
+    #   assert_exclusive_keys(options, :only)                   # => nil
+    #   assert_exclusive_keys(options, :except)                 # => nil
+    #   assert_exclusive_keys(options, :only, :except)          # => ArgumentError: Conflicting keys: only, except
+    #   assert_exclusive_keys(options, :only, :except, :with)   # => ArgumentError: Conflicting keys: only, except
+    def assert_exclusive_keys(hash, *exclusive_keys)
+      conflicting_keys = exclusive_keys & hash.keys
+      raise ArgumentError, "Conflicting keys: #{conflicting_keys.join(', ')}" unless conflicting_keys.length <= 1
+    end
+  end
+end