statesman 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ebf6e84cf86743ab926a166de6477906ad46be9
-  data.tar.gz: 787d61de37b561637bf53cb16de85c87e272f124
+  metadata.gz: 105f8a5aeb999d07eaeb59d69bbe52ff42317895
+  data.tar.gz: b6ac7988cea6d0a5a260ceda12be3c1ca64b38d5
 SHA512:
-  metadata.gz: c9641ecdabfeb6df4359887a1de93a81df466965f5a1dd7c2343f23600a9829da270347733b145489d2e4d20befe7c3555e7fc7378a00c52d626681fc5814dae
-  data.tar.gz: ae0250320f5c320a295e41200e6ba76cb315810fe0c951de7ec9e7daa8add7fcfff74479db7534fa93ff0f530db3c45d43d55908601724a762fcb98913a8a090
+  metadata.gz: 00608fb54abb049e5615c96c0903e6564a565838c4cf6db53da2151fefef2ffdabf529b18752eae466bedcd22e26237a44fb1ce1af25fcc0f1494e3164d0454a
+  data.tar.gz: 7715676c1ea620c9509e470e285474f31fa991795abc60bb9bd45f692d90bc10453a33918567eb3a11c0cbb19a027ecf03822684b859f0d106df4a481db1c748

data/.rubocop.yml

@@ -13,6 +13,9 @@ StringLiterals:
 Documentation:
   Enabled: false
 
+SignalException:
+  Enabled: false
+
 # Avoid methods longer than 30 lines of code
 MethodLength:
   CountComments: false  # count full line comments?

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## v0.3.0, 20 February 2014
+*Additions*
+- Adds Machine#allowed_transitions method (patch by [@prikha](https://github.com/prikha))
+
 ## v0.2.1, 31 December 2013
 *Fixes*
 - Don't add attr_accessible to generated transition model if running in Rails 4

data/README.md

@@ -69,6 +69,9 @@ end
 Order.first.state_machine.current_state
 # => "pending"
 
+Order.first.state_machine.allowed_transitions
+# => ["checking_out", "cancelled"]
+
 Order.first.state_machine.can_transition_to?(:cancelled)
 # => true/false
 
@@ -201,6 +204,9 @@ Returns a sorted array of all transition objects.
 #### `Machine#last_transition`
 Returns the most recent transition object.
 
+#### `Machine#allowed_transitions`
+Returns an array of states you can `transition_to` from current state.
+
 #### `Machine#can_transition_to?(:state)`
 Returns true if the current state can transition to the passed state and all
 applicable guards pass.

data/lib/generators/statesman/active_record_transition_generator.rb

@@ -2,7 +2,7 @@ require "rails/generators"
 
 module Statesman
   class ActiveRecordTransitionGenerator < Rails::Generators::Base
-    desc "Create an ActiveRecord-based transition model" +
+    desc "Create an ActiveRecord-based transition model"\
          "with the required attributes"
 
     argument :parent, type: :string, desc: "Your parent model name"

data/lib/generators/statesman/mongoid_transition_generator.rb

@@ -26,6 +26,5 @@ module Statesman
     def parent_id
       parent.underscore + "_id"
     end
-
   end
 end

data/lib/statesman/callback.rb

@@ -21,16 +21,32 @@ module Statesman
     end
 
     def applies_to?(options = { from: nil, to: nil })
-      from = options[:from]
-      to = options[:to]
-      # rubocop:disable RedundantSelf
-      (self.from.nil? && self.to.nil?) ||
-      (from.nil? && to == self.to) ||
-      (self.from.nil? && to == self.to) ||
-      (from == self.from && to.nil?) ||
-      (from == self.from && self.to.nil?) ||
-      (from == self.from && to == self.to)
-      # rubocop:enable RedundantSelf
+      matches(options[:from], options[:to])
+    end
+
+    private
+
+    def matches(from, to)
+      matches_all_transitions ||
+      matches_to_state(from, to) ||
+      matches_from_state(from, to) ||
+      matches_both_states(from, to)
+    end
+
+    def matches_all_transitions
+      from.nil? && to.nil?
+    end
+
+    def matches_from_state(from, to)
+      (from == self.from  && (to.nil? || self.to.nil?))
+    end
+
+    def matches_to_state(from, to)
+      ((from.nil? || self.from.nil?) && to == self.to)
+    end
+
+    def matches_both_states(from, to)
+      from == self.from && to == self.to
     end
   end
 end

data/lib/statesman/guard.rb

@@ -3,13 +3,11 @@ require_relative "exceptions"
 
 module Statesman
   class Guard < Callback
-
     def call(*args)
       unless super(*args)
         raise GuardFailedError,
               "Guard on transition from: '#{from}' to '#{to}' returned false"
       end
     end
-
   end
 end

data/lib/statesman/machine.rb

@@ -98,7 +98,7 @@ module Statesman
       def validate_not_from_terminal_state(from)
         unless from.nil? || successors.keys.include?(from)
           raise InvalidTransitionError,
-                "Cannont transition away from terminal state '#{from}'"
+                "Cannot transition away from terminal state '#{from}'"
         end
       end
 
@@ -106,7 +106,7 @@ module Statesman
       def validate_not_to_initial_state(to)
         unless to.nil? || successors.values.flatten.include?(to)
           raise InvalidTransitionError,
-                "Cannont transition to initial state '#{to}'"
+                "Cannot transition to initial state '#{to}'"
         end
       end
 
@@ -152,6 +152,12 @@ module Statesman
       last_action ? last_action.to_state : self.class.initial_state
     end
 
+    def allowed_transitions
+      successors_for(current_state).select do |state|
+        can_transition_to?(state)
+      end
+    end
+
     def last_transition
       @storage_adapter.last
     end
@@ -193,6 +199,10 @@ module Statesman
 
     private
 
+    def successors_for(from)
+      self.class.successors[from] || []
+    end
+
     def guards_for(options = { from: nil, to: nil })
       select_callbacks_for(self.class.guards, options)
     end

data/lib/statesman/version.rb

@@ -1,3 +1,3 @@
 module Statesman
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/spec/statesman/callback_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Statesman::Callback do
-  let(:cb_lambda) { -> { } }
+  let(:cb_lambda) { -> {} }
   let(:callback) do
     Statesman::Callback.new(from: nil, to: nil, callback: cb_lambda)
   end

data/spec/statesman/guard_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Statesman::Guard do
-  let(:callback) { -> { } }
+  let(:callback) { -> {} }
   let(:guard) { Statesman::Guard.new(from: nil, to: nil, callback: callback) }
 
   specify { expect(guard).to be_a(Statesman::Callback) }

data/spec/statesman/machine_spec.rb

@@ -235,6 +235,41 @@ describe Statesman::Machine do
     end
   end
 
+  describe "#allowed_transitions" do
+    before do
+      machine.class_eval do
+        state :x, initial: true
+        state :y
+        state :z
+        transition from: :x, to: [:y, :z]
+        transition from: :y, to: :z
+      end
+    end
+
+    let(:instance) { machine.new(my_model) }
+    subject { instance.allowed_transitions }
+
+    context "with multiple possible states" do
+      it { should eq(%w(y z)) }
+    end
+
+    context "with one possible state" do
+      before do
+        instance.transition_to!(:y)
+      end
+
+      it { should eq(['z']) }
+    end
+
+    context "with no possible transitions" do
+      before do
+        instance.transition_to!(:z)
+      end
+
+      it { should eq([]) }
+    end
+  end
+
   describe "#last_transition" do
     let(:instance) { machine.new(my_model) }
     let(:last_action) { "Whatever" }

data/spec/support/mongoid.rb

@@ -17,10 +17,10 @@ class MyMongoidModelTransition
   field :sort_key, type: Integer
   field :statesman_metadata, type: Hash
 
-  index({ sort_key: 1 })
+  index(sort_key: 1)
 
   belongs_to :my_mongoid_model, index: true
 
   alias_method :metadata, :statesman_metadata
   alias_method :metadata=, :statesman_metadata=
-end
+end

data/statesman.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 2.14.1"
   spec.add_development_dependency "guard-rspec", "~> 3.0.2"
-  spec.add_development_dependency "rubocop", "~> 0.12.0"
+  spec.add_development_dependency "rubocop", "~> 0.18.1"
   spec.add_development_dependency "guard-rubocop", "~> 0.2.2"
   spec.add_development_dependency "activerecord", "~> 3.2"
   spec.add_development_dependency "sqlite3", "~> 1.3.8"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Harry Marr
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-31 00:00:00.000000000 Z
+date: 2014-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.18.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.18.1
 - !ruby/object:Gem::Dependency
   name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement