apollo 1.1.0 → 1.2.0

data/CHANGELOG.md

@@ -1,13 +1,20 @@
 Apollo Changelog
 ================
 
-1.1
+## 1.2
+
+* Added `StateSet` class. (ace5f98)
+* Renamed `State#sets` to `State#set_names`. (d3185f5)
+* Added `ActiveRecordExtensions` for instance & class methods. (baf6177)
+  * Added AR class method `state_set_sql` for easy SQL usage.
+
+## 1.1
 
 * Added state sets. (7498cf0)
 * Unbranded methods. E.g. `Apollo::apollo` -> `Apollo::state_machine` (f8b42b8)
 
-1.0
----
+## 1.0
+
 This is an initial release of the Apollo fork from [Workflow](http://github.com/geekq/workflow).  The reason I decided to fork Workflow, and in particular change the name, is because I feel that Workflow is an excellent starting point for my needs; however, my desire for Apollo is somewhat different from the desires of the creators of Workflow.  **In no way is my fork (and renaming) intended to be any kind of insult or intellectual rights infringement.**  I chose Workflow for the basis of Apollo because I feel it is the **best** state machine gem available.  I will most certainly maintain the original MIT-LICENSE as apart of Apollo so long as *any* portion of the code is derived from Workflow (which I suspect will always be the case).
 
 * Rebranded modules from "workflow" to "apollo".

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/apollo.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{apollo}
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Travis D. Warlick, Jr."]
@@ -25,10 +25,11 @@ Gem::Specification.new do |s|
      "VERSION",
      "apollo.gemspec",
      "lib/apollo.rb",
-     "lib/apollo/active_record_instance_methods.rb",
+     "lib/apollo/active_record_extensions.rb",
      "lib/apollo/event.rb",
      "lib/apollo/specification.rb",
      "lib/apollo/state.rb",
+     "lib/apollo/state_set.rb",
      "test/couchtiny_example.rb",
      "test/main_test.rb",
      "test/readme_example.rb",

data/lib/apollo.rb

@@ -16,10 +16,11 @@
 #     Copyright (c) 2008-2009 Vodafone
 #     Copyright (c) 2007-2008 Ryan Allen, FlashDen Pty Ltd
 module Apollo
-  autoload :Event,                        'apollo/event'
-  autoload :State,                        'apollo/state'
-  autoload :Specification,                'apollo/specification'
-  autoload :ActiveRecordInstanceMethods,  'apollo/active_record_instance_methods'
+  autoload :Event,                    'apollo/event'
+  autoload :State,                    'apollo/state'
+  autoload :StateSet,                 'apollo/state_set'
+  autoload :Specification,            'apollo/specification'
+  autoload :ActiveRecordExtensions,   'apollo/active_record_extensions'
   
   # The current version
   VERSION = File.read(File.join(File.expand_path(File.dirname(__FILE__)), '..', 'VERSION')).strip
@@ -74,7 +75,7 @@ module Apollo
       @apollo_spec.state_sets.keys.each do |set_name|
         module_eval do
           define_method "#{set_name}?" do
-            current_state.sets.include?(set_name)
+            current_state.set_names.include?(set_name.to_sym)
           end
         end
       end
@@ -219,8 +220,9 @@ module Apollo
     klass.extend ClassMethods
     if Object.const_defined?(:ActiveRecord)
       if klass < ActiveRecord::Base
-      klass.send :include, ActiveRecordInstanceMethods
-      klass.before_validation :write_initial_state
+        klass.send :include, ActiveRecordExtensions::InstanceMethods
+        klass.extend ActiveRecordExtensions::ClassMethods
+        klass.before_validation :write_initial_state
       end
     end
   end

data/lib/apollo/active_record_extensions.rb

@@ -0,0 +1,38 @@
+module Apollo
+  module ActiveRecordExtensions
+    module InstanceMethods
+      def load_current_state
+        read_attribute(self.class.current_state_column)
+      end
+
+      # On transition the new current state is immediately saved in the
+      # database.
+      def persist_current_state(new_value)
+        update_attribute self.class.current_state_column, new_value
+      end
+
+      private
+
+      # Motivation: even if NULL is stored in the current_state database column,
+      # the current_state is correctly recognized in the Ruby code. The problem
+      # arises when you want to SELECT records filtering by the value of initial
+      # state. That's why it is important to save the string with the name of the
+      # initial state in all the new records.
+      def write_initial_state
+        write_attribute self.class.current_state_column, current_state.to_s
+      end
+    end
+    
+    module ClassMethods
+      def state_set_sql( set_name, options = {} )
+        quotes    = (options[:quotes]    or %('))
+        join      = (options[:join]      or %(,))
+        surround  = (options[:surround]  or ['(',')'])
+      
+        str = state_machine.state_sets[set_name.to_sym].state_names
+        str = str.collect { |state_name| quotes + state_name + quotes }.join(join)
+        surround.first + str + surround.last
+      end
+    end
+  end
+end

data/lib/apollo/specification.rb

@@ -22,19 +22,23 @@ module Apollo
       instance_eval(&events_and_etc) if events_and_etc
     end
     
-    def state_set(name, *state_names)
-      validate_state_set_name(name)
+    def state_set(set_name, *state_names)
+      validate_state_set_name(set_name)
       
-      set = Set.new
+      state_names.flatten!
+      state_names.collect! {|n| n.to_sym}
+      state_names.uniq!
+      
+      set = StateSet.new
       state_names.each do |state_name|
         if state = @states[state_name]
           set << state
-          state.sets << name
+          state.set_names << set_name.to_sym
         else
-          raise ApolloDefinitionError, "Unknown state: #{state}"
+          raise ApolloDefinitionError, "Unknown state: #{state_name}"
         end
       end
-      @state_sets[name] = set
+      @state_sets[set_name] = set
     end
 
     def event(name, args = {}, &action)

data/lib/apollo/state.rb

@@ -1,9 +1,9 @@
 module Apollo
   class State
-    attr_accessor :name, :events, :meta, :on_entry, :on_exit, :sets
+    attr_accessor :name, :events, :meta, :on_entry, :on_exit, :set_names
 
     def initialize(name, meta = {})
-      @name, @events, @meta, @sets = name, Hash.new, meta, Set.new
+      @name, @events, @meta, @set_names = name, Hash.new, meta, Set.new
     end
 
     def to_s

data/lib/apollo/state_set.rb

@@ -0,0 +1,7 @@
+module Apollo
+  class StateSet < Set
+    def state_names
+      collect {|state| state.name.to_s}
+    end
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Travis D. Warlick, Jr.
@@ -37,10 +37,11 @@ files:
 - VERSION
 - apollo.gemspec
 - lib/apollo.rb
-- lib/apollo/active_record_instance_methods.rb
+- lib/apollo/active_record_extensions.rb
 - lib/apollo/event.rb
 - lib/apollo/specification.rb
 - lib/apollo/state.rb
+- lib/apollo/state_set.rb
 - test/couchtiny_example.rb
 - test/main_test.rb
 - test/readme_example.rb

data/lib/apollo/active_record_instance_methods.rb

@@ -1,24 +0,0 @@
-module Apollo
-  module ActiveRecordInstanceMethods
-    def load_current_state
-      read_attribute(self.class.current_state_column)
-    end
-
-    # On transition the new current state is immediately saved in the
-    # database.
-    def persist_current_state(new_value)
-      update_attribute self.class.current_state_column, new_value
-    end
-
-    private
-
-    # Motivation: even if NULL is stored in the current_state database column,
-    # the current_state is correctly recognized in the Ruby code. The problem
-    # arises when you want to SELECT records filtering by the value of initial
-    # state. That's why it is important to save the string with the name of the
-    # initial state in all the new records.
-    def write_initial_state
-      write_attribute self.class.current_state_column, current_state.to_s
-    end
-  end
-end