state_machines_rspec 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7bc32e2082329c18f5e6cd5a9f31a144ff030365
+  data.tar.gz: dd57f80ca2701a0a84e26f9ca513521f1300e45b
+SHA512:
+  metadata.gz: 648b785d5d365c292681bad98c02c6ae46cfb9dd052089a6e6f6e75d573c57ef43bb724e16a1772a52dfcfb9187ad1e85e9bfac4b181b48a61f2f884c902be38
+  data.tar.gz: bb21728cca9bd477710f8fcb6a7bf6f6be82b9422ba17f22fa53588fd2e869247751dc3aff4ad2f53a73fc277a0346e8357181827ba0f1c5259f1bcffb22511e

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.ruby-gemset

@@ -0,0 +1 @@
+state_machines_rspec

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.2

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## [0.1.3](https://github.com/modocache/state_machine_rspec/compare/v0.1.2...v0.1.3)
+
+- Add `#description` to matchers.
+- Update rspec dependency.
+
+## [0.1.2](https://github.com/modocache/state_machine_rspec/compare/v0.1.1...v0.1.2)
+
+- state_machine dependency updated from "~> 1.1.0" to ">= 1.1.0".
+  Fixes https://github.com/modocache/state_machine_rspec/issues/5.
+
+## [0.1.1](https://github.com/modocache/state_machine_rspec/compare/v0.1.0...v0.1.1)
+
+- `StateMachineRspec::Matchers::Events` conform to `Matchers::States` API, and now
+  take a `:on` parameter when specifying a non-default state_machine attribute. This
+  used to be specified with a `:state` parameter.
+- Add Travis-CI build status image to README.
+- Update README with instructions on including module in during RSpec configuration.
+
+## [0.1.0](https://github.com/modocache/state_machine_rspec/tree/v0.1.0)
+
+- Initial release.

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in state_machine_rspec.gemspec
+gemspec
+
+group :development do
+  gem 'pry'
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 modocache
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.md

@@ -0,0 +1,62 @@
+# state_machine_rspec
+
+[![Build Status](https://travis-ci.org/modocache/state_machine_rspec.png?branch=master)](https://travis-ci.org/modocache/state_machine_rspec)
+
+Custom matchers for [pluginaweek/state_machine](https://github.com/pluginaweek/state_machine).
+
+
+## Matchers
+
+### `have_state` & `reject_state`
+
+```ruby
+describe Vehicle do
+  it { should have_states :parked, :idling, :stalled, :first_gear,
+                          :second_gear, :third_gear }
+  it { should reject_state :flying }
+
+  it { should have_states :active, :off, on: :alarm_state }
+  it { should have_state :active, on: :alarm_state, value: 1 }
+  it { should reject_states :broken, :ringing, on: :alarm_state }
+end
+```
+
+### `handle_event` & `reject_event`
+
+```ruby
+describe Vehicle do
+  it { should handle_events :shift_down, :crash, when: :third_gear }
+  it { should handle_events :enable_alarm, :disable_alarm,
+                            when: :active, on: :alarm_state }
+  it { should reject_events :park, :ignite, :idle, :shift_up, :repair,
+                            when: :third_gear }
+end
+```
+
+
+## Installation
+
+Add these lines to your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'state_machine_rspec'
+end
+```
+
+And include the matchers in `spec/spec_helper.rb`:
+
+```ruby
+RSpec.configure do |config|
+  config.include StateMachineRspec::Matchers
+end
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default  => :spec

data/lib/matchers/events/handle_event.rb

@@ -0,0 +1,35 @@
+require 'matchers/events/matcher'
+
+module StateMachinesRspec
+  module Matchers
+    def handle_events(value, *values)
+      HandleEventMatcher.new(values.unshift(value))
+    end
+    alias_method :handle_event, :handle_events
+
+    class HandleEventMatcher < StateMachinesRspec::Matchers::Events::Matcher
+      def matches_events?(events)
+        !invalid_events?
+      end
+
+      def description
+        message = super
+        message << " on #{state_machine_scope.inspect}" if state_machine_scope
+        "handle #{message}"
+      end
+
+      private
+
+      def invalid_events?
+        invalid_events = @introspector.invalid_events(@events)
+        unless invalid_events.empty?
+          @failure_message = "Expected to be able to handle events: " +
+                              "#{invalid_events.join(', ')} in state: " +
+                              "#{@introspector.current_state_value}"
+        end
+
+        !invalid_events.empty?
+      end
+    end
+  end
+end

data/lib/matchers/events/matcher.rb

@@ -0,0 +1,71 @@
+require 'active_support/core_ext/array/extract_options'
+
+module StateMachinesRspec
+  module Matchers
+    module Events
+      class Matcher
+        attr_reader :failure_message
+
+        def initialize(events)
+          @options = events.extract_options!
+          @events = events
+        end
+
+        def matches?(subject)
+          @subject = subject
+          @introspector = StateMachinesIntrospector.new(@subject,
+                                                       @options.fetch(:on, nil))
+          enter_when_state
+          return false if undefined_events?
+          return false unless matches_events?(@events)
+          @failure_message.nil?
+        end
+
+        def matches_events?(events)
+          raise NotImplementedError,
+            "subclasses of #{self.class} must override matches_events?"
+        end
+
+        def description
+          message = @events.map{ |event| event.inspect }.join(', ')
+          message << " when #{state_name.inspect}" if state_name
+          message
+        end
+
+        protected
+
+        def state_machine_scope
+          @options.fetch(:on, nil)
+        end
+
+        private
+
+        def enter_when_state
+          if state_name
+            unless when_state = @introspector.state(state_name)
+              raise StateMachinesIntrospectorError,
+                "#{@subject.class} does not define state: #{state_name}"
+            end
+
+            @subject.send("#{@introspector.state_machine_attribute}=",
+                          when_state.value)
+          end
+        end
+
+        def state_name
+          @options.fetch(:when, nil)
+        end
+
+        def undefined_events?
+          undefined_events = @introspector.undefined_events(@events)
+          unless undefined_events.empty?
+            @failure_message = "state_machine: #{@introspector.state_machine_attribute} " +
+                               "does not define events: #{undefined_events.join(', ')}"
+          end
+
+          !undefined_events.empty?
+        end
+      end
+    end
+  end
+end

data/lib/matchers/events/reject_event.rb

@@ -0,0 +1,35 @@
+require 'matchers/events/matcher'
+
+module StateMachinesRspec
+  module Matchers
+    def reject_events(value, *values)
+      RejectEventMatcher.new(values.unshift(value))
+    end
+    alias_method :reject_event, :reject_events
+
+    class RejectEventMatcher < StateMachinesRspec::Matchers::Events::Matcher
+      def matches_events?(events)
+        !valid_events?
+      end
+
+      def description
+        message = super
+        message << " on #{state_machine_scope.inspect}" if state_machine_scope
+        "reject #{message}"
+      end
+
+      private
+
+      def valid_events?
+        valid_events = @introspector.valid_events(@events)
+        unless valid_events.empty?
+          @failure_message = "Did not expect to be able to handle events: " +
+                              "#{valid_events.join(', ')} in state: " +
+                              "#{@introspector.current_state_value}"
+        end
+
+        !valid_events.empty?
+      end
+    end
+  end
+end

data/lib/matchers/states/have_state.rb

@@ -0,0 +1,46 @@
+require 'matchers/states/matcher'
+
+module StateMachinesRspec
+  module Matchers
+    def have_states(state, *states)
+      HaveStateMatcher.new(states.unshift(state))
+    end
+    alias_method :have_state, :have_states
+
+    class HaveStateMatcher < StateMachinesRspec::Matchers::States::Matcher
+      def matches_states?(states)
+        return false if undefined_states?
+        return false if incorrect_value?
+        @failure_message.nil?
+      end
+
+      def description
+        message = super
+        message << " == #{state_value.inspect}" if state_value
+        message << " on #{state_machine_scope.inspect}" if state_machine_scope
+        "have #{message}"
+      end
+
+      private
+
+      def undefined_states?
+        undefined_states = @introspector.undefined_states(@states)
+        unless undefined_states.empty?
+          @failure_message = "Expected #{@introspector.state_machine_attribute} " +
+                             "to allow states: #{undefined_states.join(', ')}"
+        end
+
+        !undefined_states.empty?
+      end
+
+      def incorrect_value?
+        if state_value && @introspector.state(@states.first).value != state_value
+          @failure_message = "Expected #{@states.first} to have value #{state_value}"
+          true
+        end
+
+        false
+      end
+    end
+  end
+end

data/lib/matchers/states/matcher.rb

@@ -0,0 +1,56 @@
+require 'active_support/core_ext/array/extract_options'
+
+module StateMachinesRspec
+  module Matchers
+    module States
+      class Matcher
+        attr_reader :failure_message
+
+        def initialize(states)
+          @options = states.extract_options!
+          @states = states
+        end
+
+        def description
+          @states.map{ |event| event.inspect }.join(', ')
+        end
+
+        def matches?(subject)
+          raise_if_multiple_values
+
+          @subject = subject
+          @introspector = StateMachinesIntrospector.new(@subject,
+                                                       state_machine_scope)
+
+          return false unless matches_states?(@states)
+          @failure_message.nil?
+        end
+
+        def matches_states?(states)
+          raise NotImplementedError,
+            "subclasses of #{self.class} must override matches_states?"
+        end
+
+        protected
+
+        def state_machine_scope
+          @options.fetch(:on, nil)
+        end
+
+        def state_value
+          @options.fetch(:value, nil)
+        end
+
+        private
+
+        def raise_if_multiple_values
+          if @states.count > 1 && state_value
+            raise ArgumentError, 'cannot make value assertions on ' +
+                                 'multiple states at once'
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/matchers/states/reject_state.rb

@@ -0,0 +1,34 @@
+require 'matchers/states/matcher'
+
+module StateMachinesRspec
+  module Matchers
+    def reject_states(state, *states)
+      RejectStateMatcher.new(states.unshift(state))
+    end
+    alias_method :reject_state, :reject_states
+
+    class RejectStateMatcher < StateMachinesRspec::Matchers::States::Matcher
+      def matches_states?(states)
+        no_defined_states?
+      end
+
+      def description
+        message = super
+        message << " on #{state_machine_scope.inspect}" if state_machine_scope
+        "not have #{message}"
+      end
+
+      private
+
+      def no_defined_states?
+        defined_states = @introspector.defined_states(@states)
+        unless defined_states.empty?
+          @failure_message = "Did not expect #{@introspector.state_machine_attribute} " +
+                             "to allow states: #{defined_states.join(', ')}"
+        end
+
+        defined_states.empty?
+      end
+    end
+  end
+end