enum_state_machine 0.0.2 → 0.1.0

data/lib/enum_state_machine/graph.rb

@@ -0,0 +1,93 @@
+begin
+  require 'rubygems'
+  gem 'ruby-graphviz', '>=0.9.17'
+  require 'graphviz'
+rescue LoadError => ex
+  $stderr.puts "Cannot draw the machine (#{ex.message}). `gem install ruby-graphviz` >= v0.9.17 and try again."
+  raise
+end
+
+require 'enum_state_machine/assertions'
+
+module EnumStateMachine
+  # Provides a set of higher-order features on top of the raw GraphViz graphs
+  class Graph < GraphViz
+    include Assertions
+    
+    # The name of the font to draw state names in
+    attr_reader :font
+    
+    # The graph's full filename
+    attr_reader :file_path
+    
+    # The image format to generate the graph in
+    attr_reader :file_format
+    
+    # Creates a new graph with the given name.
+    # 
+    # Configuration options:
+    # * <tt>:path</tt> - The path to write the graph file to.  Default is the
+    #   current directory (".").
+    # * <tt>:format</tt> - The image format to generate the graph in.
+    #   Default is "png'.
+    # * <tt>:font</tt> - The name of the font to draw state names in.
+    #   Default is "Arial".
+    # * <tt>:orientation</tt> - The direction of the graph ("portrait" or
+    #   "landscape").  Default is "portrait".
+    def initialize(name, options = {})
+      font = (RUBY_PLATFORM =~ /darwin/) ? 'ArialMT' : 'Arial'
+      options = {:path => '.', :format => 'png', :font => font, :orientation => 'portrait'}.merge(options)
+      assert_valid_keys(options, :path, :format, :font, :orientation)
+      
+      @font = options[:font]
+      @file_path = File.join(options[:path], "#{name}.#{options[:format]}")
+      @file_format = options[:format]
+      
+      super('G', :rankdir => options[:orientation] == 'landscape' ? 'LR' : 'TB')
+    end
+    
+    # Generates the actual image file based on the nodes / edges added to the
+    # graph.  The path to the file is based on the configuration options for
+    # this graph.
+    def output
+      super(@file_format => @file_path)
+    end
+    
+    # Adds a new node to the graph.  The font for the node will be automatically
+    # set based on the graph configuration.  The generated node will be returned.
+    # 
+    # For example,
+    # 
+    #   graph = EnumStateMachine::Graph.new('test')
+    #   graph.add_nodes('parked', :label => 'Parked', :width => '1', :height => '1', :shape => 'ellipse')
+    def add_nodes(*args)
+      node = v0_api? ? add_node(*args) : super
+      node.fontname = @font
+      node
+    end
+    
+    # Adds a new edge to the graph.  The font for the edge will be automatically
+    # set based on the graph configuration.  The generated edge will be returned.
+    # 
+    # For example,
+    # 
+    #   graph = EnumStateMachine::Graph.new('test')
+    #   graph.add_edges('parked', 'idling', :label => 'ignite')
+    def add_edges(*args)
+      edge = v0_api? ? add_edge(*args) : super
+      edge.fontname = @font
+      edge
+    end
+    
+    private
+    # Determines whether the old v0 api is in use
+    def v0_api?
+      version[0] == '0' || version[0] == '1' && version[1] == '0' && version[2] <= '2'
+    end
+    
+    # The ruby-graphviz version data
+    def version
+      Constants::RGV_VERSION.split('.')
+    end
+  end
+end

data/lib/enum_state_machine/helper_module.rb

@@ -0,0 +1,17 @@
+module EnumStateMachine
+  # Represents a type of module that defines instance / class methods for a
+  # state machine
+  class HelperModule < Module #:nodoc:
+    def initialize(machine, kind)
+      @machine = machine
+      @kind = kind
+    end
+    
+    # Provides a human-readable description of the module
+    def to_s
+      owner_class = @machine.owner_class
+      owner_class_name = owner_class.name && !owner_class.name.empty? ? owner_class.name : owner_class.to_s
+      "#{owner_class_name} #{@machine.name.inspect} #{@kind} helpers"
+    end
+  end
+end

data/lib/enum_state_machine/initializers/rails.rb

@@ -0,0 +1,22 @@
+if defined?(Rails)
+  # Track all of the applicable locales to load
+  locale_paths = []
+  EnumStateMachine::Integrations.all.each do |integration|
+    locale_paths << integration.locale_path if integration.available? && integration.locale_path
+  end
+  
+  if defined?(Rails::Engine)
+    # Rails 3.x
+    class EnumStateMachine::RailsEngine < Rails::Engine
+      rake_tasks do
+        load 'tasks/enum_state_machine.rb'
+      end
+    end
+    
+    if Rails::VERSION::MAJOR == 3 && Rails::VERSION::MINOR == 0
+      EnumStateMachine::RailsEngine.paths.config.locales = locale_paths
+    else
+      EnumStateMachine::RailsEngine.paths['config/locales'] = locale_paths
+    end
+  end
+end

data/lib/enum_state_machine/initializers.rb

@@ -0,0 +1,4 @@
+# Load each application initializer
+Dir["#{File.dirname(__FILE__)}/initializers/*.rb"].sort.each do |path|
+  require "enum_state_machine/initializers/#{File.basename(path)}"
+end

data/lib/enum_state_machine/integrations/active_model/locale.rb

@@ -0,0 +1,11 @@
+{:en => {
+  :activemodel => {
+    :errors => {
+      :messages => {
+        :invalid => EnumStateMachine::Machine.default_messages[:invalid],
+        :invalid_event => EnumStateMachine::Machine.default_messages[:invalid_event] % ['%{state}'],
+        :invalid_transition => EnumStateMachine::Machine.default_messages[:invalid_transition] % ['%{event}']
+      }
+    }
+  }
+}}

data/lib/enum_state_machine/integrations/active_model/observer.rb

@@ -0,0 +1,33 @@
+module EnumStateMachine
+  module Integrations #:nodoc:
+    module ActiveModel
+      # Adds support for invoking callbacks on ActiveModel observers with more
+      # than one argument (e.g. the record *and* the state transition).  By
+      # default, ActiveModel only supports passing the record into the
+      # callbacks.
+      # 
+      # For example:
+      # 
+      #   class VehicleObserver < ActiveModel::Observer
+      #     # The default behavior: only pass in the record
+      #     def after_save(vehicle)
+      #     end
+      #     
+      #     # Custom behavior: allow the transition to be passed in as well
+      #     def after_transition(vehicle, transition)
+      #       Audit.log(vehicle, transition)
+      #     end
+      #   end
+      module Observer
+        def update_with_transition(observer_update)
+          method = observer_update.method
+          send(method, *observer_update.args) if respond_to?(method)
+        end
+      end
+    end
+  end
+end
+
+ActiveModel::Observer.class_eval do
+  include EnumStateMachine::Integrations::ActiveModel::Observer
+end if defined?(ActiveModel::Observer)

data/lib/enum_state_machine/integrations/active_model/observer_update.rb

@@ -0,0 +1,42 @@
+module EnumStateMachine
+  module Integrations #:nodoc:
+    module ActiveModel
+      # Represents the encapsulation of all of the details to be included in an
+      # update to state machine observers.  This allows multiple arguments to
+      # get passed to an observer method (instead of just a single +object+)
+      # while still respecting the way in which ActiveModel checks for the
+      # object's list of observers.
+      class ObserverUpdate
+        # The method to invoke on the observer
+        attr_reader :method
+        
+        # The object being transitioned
+        attr_reader :object
+        
+        # The transition being run
+        attr_reader :transition
+        
+        def initialize(method, object, transition) #:nodoc:
+          @method, @object, @transition = method, object, transition
+        end
+        
+        # The arguments to pass into the method
+        def args
+          [object, transition]
+        end
+        
+        # The class of the object being transitioned.  Normally the object
+        # getting passed into observer methods is the actual instance of the
+        # ActiveModel class.  ActiveModel uses that instance's class to check
+        # for enabled / disabled observers.
+        # 
+        # Since state_machine is passing an ObserverUpdate instance into observer
+        # methods, +class+ needs to be overridden so that ActiveModel can still
+        # get access to the enabled / disabled observers.
+        def class
+          object.class
+        end
+      end
+    end
+  end
+end

data/lib/enum_state_machine/integrations/active_model/versions.rb

@@ -0,0 +1,31 @@
+module EnumStateMachine
+  module Integrations #:nodoc:
+    module ActiveModel
+      version '2.x' do
+        def self.active?
+          !defined?(::ActiveModel::VERSION) || ::ActiveModel::VERSION::MAJOR == 2
+        end
+        
+        def define_validation_hook
+          define_helper :instance, <<-end_eval, __FILE__, __LINE__ + 1
+            def valid?(*)
+              self.class.state_machines.transitions(self, #{action.inspect}, :after => false).perform { super }
+            end
+          end_eval
+        end
+      end
+      
+      version '3.0.x' do
+        def self.active?
+          defined?(::ActiveModel::VERSION) && ::ActiveModel::VERSION::MAJOR == 3 && ::ActiveModel::VERSION::MINOR == 0
+        end
+        
+        def define_validation_hook
+          # +around+ callbacks don't have direct access to results until AS 3.1
+          owner_class.set_callback(:validation, :after, 'value', :prepend => true)
+          super
+        end
+      end
+    end
+  end
+end