finite 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efb775ca43d0ce5dddd4215fde0c54b5f764e097
-  data.tar.gz: f617e7113c8f30f590c353dfa664776e74cb6c32
+  metadata.gz: e38ef2b1b5515d6ae12b8fba4f0e5c6a96e497bc
+  data.tar.gz: 406818e0855c7fabe2b6400702f1a5a84517696a
 SHA512:
-  metadata.gz: 7e6a27d3620e1ed8a3d80099d9ff9ae7ac693ac04a81ba570b6048565e9cc6d94cd4a7ff69e5944489d652aec55ace9cabc9b688ae60d64e6c6d37762352f3e0
-  data.tar.gz: ad0e60854b2334e045f78c35e0649e610e56abb9253ed0f22c6260972a8b469206e385052a1748dccc23ef84d7602bee120b44aafd2488aa6ab61f0583197d80
+  metadata.gz: a90dc4be0bf9b90267fe93a7d5f03af3eb032451032ff6a758a05ef3348cf9bf2042eef00bdacfe13a9ddc200c1c4682dcb9d2f5d325f9f4ba36002d92a21efc
+  data.tar.gz: 662f8bcc2153fed063d61866abbcd1388b965b94ab52ac5d3646238b874e533fd6dd1a173b719d530d35b2ed4e12494bfe189ff053e88fabcb0356f3b106a8d6

data/.gitignore

@@ -15,4 +15,3 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-spec/null.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -1,6 +1,5 @@
 language: ruby
 rvm:
+  - 2.1.0
   - 2.0.0
-  - 1.9.3
-  - jruby-19mode # JRuby in 1.9 mode
-  - rbx-19mode
+  - 1.9.3

data/README.md

@@ -19,14 +19,19 @@ Or install it yourself as:
 
 ## Usage
 ```ruby
+require 'finite'
 
 class Elevator
     include Finite
 
+    def initialize
+        @broken = false
+    end
+
     finite initial: :idle do
 
         before do
-            "This is called before every state but has no purpose other than to show it's existence in this example."
+            "This is called before every state but has no purpose other than to show its existence in this example."
         end
 
         before :doors_closing do
@@ -38,7 +43,7 @@ class Elevator
         end
 
         event :prepare do
-            go from: :idle, to: :doors_closing
+            go from: :idle, to: :doors_closing, if: -> { not @broken }
         end
 
         event :go_up do
@@ -98,7 +103,7 @@ elevator = Elevator.new
 elevator.current_state          # => :idle
 elevator.can_prepare?           # => true
 elevator.can_open_doors?        # => false
-elevator.open_doors             # => RuntimeError 'Invalid Transition'
+elevator.open_doors             # => Finite::Error 'Invalid Transition'
 elevator.idle?                  # => true
 elevator.prepare                # => 'Doors Closing!'
 elevator.current_state          # => :doors_closing
@@ -114,7 +119,7 @@ elevator.possible_events        # => [:go_up, :go_down]
 5. Create new Pull Request
 
 ## License
-Copyright (c) 2013 Kristen Mills
+Copyright (c) 2014 Kristen Mills
 
 MIT License
 
@@ -135,4 +140,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/finite.gemspec

@@ -21,6 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", '~>3.0'
   spec.add_development_dependency "yard"
 end

data/lib/finite.rb

@@ -16,4 +16,4 @@ module Finite
     base.extend(ClassMethods)
     super
   end
-end
+end

data/lib/finite/event.rb

@@ -30,7 +30,7 @@ module Finite
       end
     end
 
-    # overrriden for puts and print
+    # Overridden for puts and print
     def to_s
       @name.to_s
     end
@@ -40,29 +40,29 @@ module Finite
       @name
     end
 
-    private
-    # The transition method for the dsl
-    #
-    # @param opts [Hash] the options for a transition
-    def go(opts)
-      options = []
-      if opts[:from].is_a? Array
-        opts[:from].each do |from|
-          options << {from: from, to: opts[:to]}
+  private
+      # The transition method for the dsl
+      #
+      # @param opts [Hash] the options for a transition
+      def go(opts)
+        options = []
+        if opts[:from].is_a? Array
+          opts[:from].each do |from|
+            options << {from: from, to: opts[:to]}
+          end
+        else
+          options << opts
+        end
+        options.each do |opt|
+          @transitions[opt[:from]] = Transition.new(opt)
         end
-      else
-        options << opts
-      end
-      options.each do |opt|
-        @transitions[opt[:from]] = Transition.new(opt)
       end
-    end
 
-    # Create the callback methods
-    [:after, :before].each do |callback|
-      define_method callback do |*args, &block|
-        @callbacks[callback] << block
+      # Create the callback methods
+      [:after, :before].each do |callback|
+        define_method callback do |*args, &block|
+          @callbacks[callback] << block
+        end
       end
-    end
   end
 end

data/lib/finite/machine.rb

@@ -34,51 +34,70 @@ module Finite
       raise 'Event #{event_name} already exists. Rename or combine the events' if events.include? event_name
       event = Event.new(event_name, &block)
       @events[event_name] = event
+
+      # Add the states from the transition
       event.transitions.each_value do |transition|
         add_state transition.to
         add_state transition.from
       end
+
+      # Creates the method can_event_name?
       @class.send(:define_method, :"can_#{event_name}?") do
         event.transitions.key? current_state.name
       end
+
+      # Creates the method event_name
       @class.send(:define_method, :"#{event_name}") do
         if event.transitions.key? current_state.name
 
-          event.callbacks[:before].each do |callback|
-            self.instance_eval &callback
-          end
+          # Makes sure the transition can happen
+          transition = event.transitions[current_state.name]
+          if transition.condition.nil? or self.instance_exec(&transition.condition)
+
+            new_state = states[event.transitions[current_state.name].to]
 
-          if callbacks[:before].key? :all
-            callbacks[:before][:all].each do |callback|
+            # Call all of the "before event" callbacks
+            event.callbacks[:before].each do |callback|
               self.instance_eval &callback
             end
-          end
 
-          new_state = states[event.transitions[current_state.name].to]
+            # Call all of the before_all callbacks
+            if callbacks[:before].key? :all
+              callbacks[:before][:all].each do |callback|
+                self.instance_eval &callback
+              end
+            end
 
-          if callbacks[:before].key? new_state.name
-            callbacks[:before][new_state.name].each do |callback|
-              self.instance_eval &callback
+            # Call the "before state" callbacks
+            if callbacks[:before].key? new_state.name
+              callbacks[:before][new_state.name].each do |callback|
+                self.instance_eval &callback
+              end
             end
-          end
-          @current_state = new_state
 
-          if callbacks[:after].key? :all
-            callbacks[:after][:all].each do |callback|
-              self.instance_eval &callback
+            # Set the current state
+            @current_state = new_state
+
+            # call the "after state" callbacks
+            if callbacks[:after].key? current_state.name
+              callbacks[:after][current_state.name].each do |callback|
+                self.instance_eval &callback
+              end
             end
-          end
-          if callbacks[:after].key? current_state.name
-            callbacks[:after][current_state.name].each do |callback|
-              self.instance_eval &callback
+
+            # call the "after all" callbacks
+            if callbacks[:after].key? :all
+              callbacks[:after][:all].each do |callback|
+                self.instance_eval &callback
+              end
             end
-          end
 
-          event.callbacks[:after].each do |callback|
-            self.instance_eval &callback
+            # Call the "after event" callbacks
+            event.callbacks[:after].each do |callback|
+              self.instance_eval &callback
+            end
+            self
           end
-        else
-          raise 'Invalid Transition'
         end
       end
     end
@@ -118,4 +137,4 @@ module Finite
       end
     end
   end
-end
+end

data/lib/finite/transition.rb

@@ -3,14 +3,15 @@ module Finite
   # The transition class. Represents a transition between two states
   class Transition
 
-    attr_reader :to, :from
+    attr_reader :to, :from, :condition
 
     # Create a new transition object
     #
-    # @param opts [Hash] the options for a transition. Include :to and :from
+    # @param opts [Hash] the options for a transition. Include :to, :from, and :if
     def initialize(opts)
       @from = opts[:from]
       @to = opts[:to]
+      @condition = opts[:if]
     end
 
     # Does this transition equal another transition?
@@ -18,7 +19,7 @@ module Finite
     # @param other [Transition] another transition
     # @return true if they are equal false if not
     def ==(other)
-      from == other.from and to == other.to
+      from == other.from and to == other.to and condition == other.condition
     end
   end
 end

data/lib/finite/version.rb

@@ -1,4 +1,4 @@
 module Finite
   # The version number
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/elevator_spec.rb

@@ -1,9 +1,8 @@
 require 'spec_helper'
 
 describe Elevator do
-  before(:each) do
-    @elevator = Elevator.new
-  end
+
+  let(:elevator) { Elevator.new }
 
   it 'has a state machine' do
     expect(Finite::StateMachine.machines[Elevator]).to_not be_nil
@@ -11,49 +10,59 @@ describe Elevator do
 
   context 'states' do
     it 'has a current state' do
-      expect(@elevator.current_state).to_not be_nil
-      expect(@elevator.current_state).to eq(:idle)
+      expect(elevator.current_state).to_not be_nil
+      expect(elevator.current_state).to eq(:idle)
     end
 
     it 'has methods to tell whether it is in a state or not' do
-      expect(@elevator.idle?).to be_true
-      expect(@elevator.moving?).to be_false
+      expect(elevator.idle?).to be true
+      expect(elevator.moving?).to be false
     end
 
     it 'can access all states' do
-      expect(@elevator.states).to_not be_nil
-      expect(@elevator.states.count).to be(9)
+      expect(elevator.states).to_not be_nil
+      expect(elevator.states.count).to be(9)
     end
   end
 
   context 'events' do
     it 'can access all events' do
-      expect(@elevator.events).to_not be_nil
-      expect(@elevator.events.count).to be(10)
+      expect(elevator.events).to_not be_nil
+      expect(elevator.events.count).to be(10)
     end
 
     it 'can access possible events for a given state' do
-      expect(@elevator.possible_events).to eq([:prepare])
+      expect(elevator.possible_events).to eq([:prepare])
     end
 
     it 'has methods to tell whether an event can be performed' do
-      expect(@elevator.can_prepare?).to be_true
-      expect(@elevator.can_go_up?).to be_false
+      expect(elevator.can_prepare?).to be true
+      expect(elevator.can_go_up?).to be false
     end
 
     it 'can perform events' do
-      @elevator.prepare
-      expect(@elevator.current_state).to eq(:doors_closing)
-      expect(@elevator.doors_closing?).to be_true
-      expect(@elevator.idle?).to be_false
-      expect(@elevator.possible_events).to eq([:go_up,:go_down])
-      expect{@elevator.start}.to raise_error
-      @elevator.go_down
-      expect(@elevator.can_start?).to be_true
-      @elevator.start
-      @elevator.approach
-      @elevator.stop
+      elevator.prepare
+      expect(elevator.current_state).to eq(:doors_closing)
+      expect(elevator.doors_closing?).to be true
+      expect(elevator.idle?).to be false
+      expect(elevator.possible_events).to eq([:go_up,:go_down])
+      elevator.start
+      expect(elevator.current_state).to eq(:doors_closing)
+      elevator.go_down
+      expect(elevator.can_start?).to be true
+      elevator.start
+      elevator.approach
+      elevator.stop
+    end
+
+    it 'will respond to conditions' do
+      elevator.broken = true
+      elevator.prepare
+      expect(elevator.current_state).to eq(:idle)
+      elevator.broken = false
+      elevator.prepare
+      expect(elevator.current_state).to eq(:doors_closing)
     end
   end
 
-end
+end

data/spec/event_spec.rb

@@ -42,9 +42,9 @@ describe Finite::Event do
 
   it 'should create transitions' do
     event = Finite::Event.new(:event1, &@block)
-    event.transitions.count.should be(1)
-    event.transitions[:state1].to.should eq(:state2)
-    event.transitions[:state1].from.should eq(:state1)
+    expect(event.transitions.count).to eql(1)
+    expect(event.transitions[:state1].to).to eq(:state2)
+    expect(event.transitions[:state1].from).to eq(:state1)
   end
 
   it 'should create callbacks' do
@@ -61,4 +61,4 @@ describe Finite::Event do
     expect(event.to_s).to eq('event')
     expect(event.inspect).to eq(:event)
   end
-end
+end

data/spec/models/elevator.rb

@@ -1,10 +1,11 @@
 
 class Elevator
   include Finite
-
+  attr_accessor :broken
   def initialize
     @before_called = 0
     @after_called = 0
+    @broken = false
   end
 
   finite initial: :idle do
@@ -31,7 +32,7 @@ class Elevator
 
 
     event :prepare do
-      go from: :idle, to: :doors_closing
+      go from: :idle, to: :doors_closing, if: -> { not @broken }
     end
 
     event :go_up do
@@ -91,4 +92,4 @@ end
 # elevator.approach
 # elevator.stop
 # puts elevator.can_open_doors?
-# puts elevator.can_finish?
+# puts elevator.can_finish?

data/spec/spec_helper.rb

@@ -10,11 +10,11 @@ RSpec.configure do |config|
   original_stdout = $stdout
   config.before(:all) do
     # Redirect stderr and stdout
-    $stderr = File.new(File.join(File.dirname(__FILE__), 'null.txt'), 'w')
-    $stdout = File.new(File.join(File.dirname(__FILE__), 'null.txt'), 'w')
+    $stderr = StringIO.new
+    $stdout = StringIO.new
   end
   config.after(:all) do
     $stderr = original_stderr
     $stdout = original_stdout
   end
-end
+end

data/spec/state_spec.rb

@@ -6,7 +6,7 @@ describe Finite::State do
   end
 
   it 'has a name' do
-    Finite::State.new(@name).name.should eq(:state_name)
+    expect(Finite::State.new(@name).name).to eq(:state_name)
   end
   context 'equality' do
     it 'equals a symbol of the same name' do
@@ -33,4 +33,4 @@ describe Finite::State do
     expect(state.to_s).to eq('state_name')
     expect(state.inspect).to eq(:state_name)
   end
-end
+end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: finite
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kristen Mills
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-31 00:00:00.000000000 Z
+date: 2014-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A simple state machine implementation for ruby
@@ -87,8 +87,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -119,17 +120,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: A simple state machine implementation for ruby