nanomachine 1.0.1 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8700d4a90a91dab6251130620aa30143dcca6a02
+  data.tar.gz: 146d5b6046e62314bfb7ce7c6ea2678d21204794
+SHA512:
+  metadata.gz: 93d15ec3b077ccdd871d2f23d23ee6b935ea2d776183d6d53e7f956533c7c32d87f92f6230d3fb69212b80d1c9c831215ed570353378d9416bf4991b3cfde0e9
+  data.tar.gz: 5b8edab1a67ff0ed7421ecfa25d2dc71b10aa01cbd821ee5b0bf958b021232ec6e2d91a74301af897313db0812cf075a7fa88896cfc01ff1a64b8b136cd6ba4f

data/.travis.yml

@@ -1,8 +1,11 @@
+language: ruby
 rvm:
-  - "1.9.3"
-  - "1.9.2"
-  - "jruby-19mode"
-  - "rbx-19mode"
-  - "1.8.7"
-  - "jruby-18mode"
-  - "rbx-18mode"
+  - 2.1
+  - 2.2
+  - ruby-head
+  - jruby
+  - rbx-2
+sudo: false
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGES

@@ -1,3 +1,7 @@
+# 1.1
+
+- Added #transition_to?
+
 # 1.0.0 to 1.0.1
 
 - Removed gem description because it’s ugly on rubygems. Use the summary.

data/README.md

@@ -1,5 +1,7 @@
 # Nanomachine
 
+[![Build Status](https://travis-ci.org/elabs/nanomachine.svg?branch=master)](http://travis-ci.org/elabs/nanomachine)
+
 A really tiny state machine for ruby. No events, only accepted transitions and transition callbacks.
 
 The difference between Nanomachine, and otherwise known Micromachine (https://rubygems.org/gems/micromachine) is that

data/lib/nanomachine.rb

@@ -1,5 +1,6 @@
 require "nanomachine/version"
 require "set"
+require "monitor"
 
 # A minimal state machine where you transition between states, instead
 # of transition by input symbols or events.
@@ -54,11 +55,7 @@ class Nanomachine
   # @yield [self] yields the machine for easy definition of states
   # @yieldparam [Nanomachine] self
   def initialize(initial_state)
-    if initial_state.nil?
-      raise InvalidStateError, "initial state cannot be nil"
-    end
-
-    @state = initial_state.to_s
+    @state = to_state(initial_state)
     @transitions = Hash.new(Set.new)
     @callbacks = Hash.new { |h, k| h[k] = [] }
     yield self if block_given?
@@ -85,7 +82,7 @@ class Nanomachine
   # @param [#to_s] from
   # @param [#each] to each target state must respond to #to_s
   def transition(from, to)
-    transitions[from.to_s] = Set.new(to).map!(&:to_s)
+    transitions[to_state(from)] = Set.new(to).map! { |state| to_state(state) }
   end
 
   # Define a callback to be executed on transition.
@@ -125,10 +122,10 @@ class Nanomachine
     end
 
     from = options.delete(:from)
-    from &&= from.to_s
+    from &&= to_state(from)
 
     to = options.delete(:to)
-    to &&= to.to_s
+    to &&= to_state(to)
 
     unless options.empty?
       raise ArgumentError, "unknown options: #{options.keys.join(", ")}"
@@ -151,12 +148,12 @@ class Nanomachine
   # @param block passed to callbacks defined with {#on_transition}
   # @return [String, false] state the machine was in before transition, or false if transition is not allowed
   def transition_to(other_state, *args, &block)
-    other_state &&= other_state.to_s
-    if transitions[state].include?(other_state)
+    if transition_to?(other_state)
+      other_state = to_state(other_state)
       previous_state, @state = @state, other_state
-      [[nil, nil], [previous_state, nil], [nil, @state], [previous_state, @state]].each do |combo|
+      [[nil, nil], [previous_state, nil], [nil, other_state], [previous_state, other_state]].each do |combo|
         @callbacks[combo].each do |callback|
-          callback.call([previous_state, @state], *args, &block)
+          callback.call([previous_state, other_state], *args, &block)
         end
       end
       previous_state
@@ -180,4 +177,25 @@ class Nanomachine
       raise InvalidTransitionError, "cannot transition from #{state.inspect} to #{other_state.inspect}"
     end
   end
+
+  # Query to see if it's possible to transition to the given state.
+  #
+  # @example
+  #   fsm.transition_to?("state") # => true
+  #
+  # @param (see #transition_to)
+  # @return [Boolean]
+  def transition_to?(other_state)
+    transitions[state].include?(to_state(other_state))
+  end
+
+  private
+
+  def to_state(state)
+    if state.nil?
+      raise InvalidStateError, "state cannot be nil"
+    else
+      state.to_s
+    end
+  end
 end

data/lib/nanomachine/version.rb

@@ -1,4 +1,4 @@
 class Nanomachine
   # @see http://semver.org/
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

data/nanomachine.gemspec

@@ -20,5 +20,5 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
 
   gem.add_development_dependency "rake"
-  gem.add_development_dependency "rspec", "~> 2.0"
+  gem.add_development_dependency "rspec", "~> 3.0"
 end

data/spec/nano_machine_spec.rb

@@ -39,7 +39,7 @@ describe "Nanomachine state machine" do
 
   describe "#initialize" do
     it "raises an error if given an invalid initial state" do
-      expect { Nanomachine.new(nil) }.to raise_error(Nanomachine::InvalidStateError, /initial state/)
+      expect { Nanomachine.new(nil) }.to raise_error(Nanomachine::InvalidStateError)
     end
   end
 
@@ -76,7 +76,7 @@ describe "Nanomachine state machine" do
 
     it "does not transition when the transition is undefined" do
       fsm.transition_to("X")
-      expect { fsm.transition_to("A").should be_false }.to_not change { fsm.state }
+      expect { fsm.transition_to("A").should be_falsy }.to_not change { fsm.state }
     end
 
     it "returns the previous state" do
@@ -84,7 +84,11 @@ describe "Nanomachine state machine" do
     end
 
     it "returns false if transition failed" do
-      fsm.transition_to("D").should be_false
+      fsm.transition_to("D").should be_falsy
+    end
+
+    it "raises a type error if state is nil" do
+      expect { fsm.transition_to(nil) }.to raise_error(Nanomachine::InvalidStateError)
     end
 
     context "callbacks" do
@@ -144,7 +148,7 @@ describe "Nanomachine state machine" do
       end
 
       it "executes no callbacks on failed transitions" do
-        fsm.transition_to("D").should be_false
+        fsm.transition_to("D").should be_falsy
         @callbacks.should be_empty
       end
     end
@@ -159,5 +163,23 @@ describe "Nanomachine state machine" do
     it "returns the previous state on success" do
       fsm.transition_to!("B").should eq "A"
     end
+
+    it "raises a type error if state is nil" do
+      expect { fsm.transition_to!(nil) }.to raise_error(Nanomachine::InvalidStateError)
+    end
+  end
+
+  describe "#transition_to?" do
+    it "returns false if it cannot transition to the given state" do
+      fsm.transition_to?("D").should be_falsy
+    end
+
+    it "returns true if it can transition to the given state" do
+      fsm.transition_to?("B").should be_truthy
+    end
+
+    it "raises a type error if state is nil" do
+      expect { fsm.transition_to?(nil) }.to raise_error(Nanomachine::InvalidStateError)
+    end
   end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,12 @@
 require "rspec"
 require "nanomachine"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = [:expect, :should]
+  end
+
+  config.mock_with :rspec do |c|
+    c.syntax = [:expect, :should]
+  end
+end

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nanomachine
 version: !ruby/object:Gem::Version
-  version: 1.0.1
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Ivan Navarrete
@@ -10,30 +9,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-15 00:00:00.000000000 Z
+date: 2015-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2167133420 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2167133420
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2167132520 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
-  version_requirements: *2167132520
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 description: 
 email:
 - crzivn@gmail.com
@@ -42,9 +47,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGES
 - Gemfile
 - README.md
@@ -57,27 +62,26 @@ files:
 homepage: https://github.com/elabs/nanomachine
 licenses:
 - MIT License
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A really tiny state machine for ruby. No events, only acceptable transitions
   and transition callbacks.
 test_files: