state_machines 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3eee931d0f563b659a9e786dc0eea93ed9f9f537
-  data.tar.gz: f53da4d08eecd750e4b416f5926e31b49be341f1
+  metadata.gz: c50330d0782d72bdf4e9ed537340c4072b573b6b
+  data.tar.gz: d057ae65cec153e36b69ea5c227035d28629c314
 SHA512:
-  metadata.gz: c1fde9ad6a6b0fb3a3f066a87f7f80c90d78c9f7d633f92f67ff0f3104bc01d16bddf4485f1b24ab3dc35bd14e6e348b8bc3ee8f45cce9edc89ef771869b9229
-  data.tar.gz: 9f07e5b0c0d579557d0a4648b909922a85f45653366ed37e738a3176d52e4ef5ed586471395ea1ca1fcf22109a2d3dda0139e7676f9199666348c108904cabdc
+  metadata.gz: 362c90ff95ddf0535fef6743f267958d1c8c45be68c3bf7026dc10f20d89e48bf02333344d0692456b84ab09c737e7b7e754c766e9bfc9ea243689a2e7a5f0a5
+  data.tar.gz: 1bad1ea983e9946dc60f5a373ccd1cc180e1287d4b8f3410f4d7579987d67c584501e7c156d620bc9a8ca3864fc1eac4e6c2c96f401987b9073694c10a7de9c7

data/.travis.yml

@@ -1,8 +1,14 @@
 language: ruby
+sudo: false
 script: "bundle exec rake"
+cache: bundler
 rvm:
-  - 1.9.3
+  - 2.1
   - 2.0.0
-  - 2.1.1
-  - jruby-19mode
-  - rbx-2
+  - 2.2
+  - jruby
+  - rbx-2
+matrix:
+  allow_failures:
+    - rvm: rbx-2
+    - rvm: jruby

data/Gemfile

@@ -1,2 +1,8 @@
 source 'https://rubygems.org'
 gemspec
+
+platform :mri_20, :mri_21 do
+  gem 'pry-byebug'
+end
+
+gem 'minitest-reporters'

data/LICENSE.txt

@@ -1,5 +1,5 @@
 Copyright (c) 2006-2012 Aaron Pfeifer
-Copyright (c) 2014 Abdelkader Boudih
+Copyright (c) 2014-2015 Abdelkader Boudih
 
 MIT License
 

data/README.md

@@ -1,5 +1,5 @@
-[![Build Status](https://travis-ci.org/seuros/state_machines.svg?branch=master)](https://travis-ci.org/seuros/state_machines)
-[![Code Climate](https://codeclimate.com/github/seuros/state_machines.png)](https://codeclimate.com/github/seuros/state_machines)
+[![Build Status](https://travis-ci.org/state-machines/state_machines.svg?branch=master)](https://travis-ci.org/state-machines/state_machines)
+[![Code Climate](https://codeclimate.com/github/state-machines/state_machines.png)](https://codeclimate.com/github/state-machines/state_machines)
 # State Machines
 
 State Machines adds support for creating state machines for attributes on any Ruby class.
@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+
 
 ## Dependencies
 
@@ -30,15 +30,13 @@ Ruby versions officially supported and tested:
 * JRuby (1.9)
 * Rubinius
 
-
-
 For graphing state machine:
 
-* [state_machines-graphviz](http://github.com/seuros/state_machines-graphviz)
+* [state_machines-graphviz](http://github.com/state-machines/state_machines-graphviz)
 
 For documenting state machines:
 
-* [state_machines-yard](http://github.com/seuros/state_machines-yard)
+* [state_machines-yard](http://github.com/state-machines/state_machines-yard)
 
 
 ## TODO
@@ -47,7 +45,7 @@ Add matchers/assertions for rspec and minitest
 
 ## Contributing
 
-1. Fork it ( https://github.com/seuros/state_machines/fork )
+1. Fork it ( https://github.com/state-machines/state_machines/fork )
 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`)

data/Rakefile

@@ -1,10 +1,13 @@
-require 'rubygems'
-require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+Rake::TestTask.new(:functional) do |t|
+  # t.pattern = 'test/**/*_test.rb'
+  t.test_files = FileList['test/functional/*_test.rb']
+end
 
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new do |t|
-  t.pattern = 'spec/**/*_spec.rb'
+Rake::TestTask.new(:unit) do |t|
+  t.test_files = FileList['test/unit/**/*_test.rb']
 end
 
 desc 'Default: run all tests.'
-task :default => :spec
+task default: [:unit, :functional]

data/lib/state_machines/assertions.rb

@@ -2,7 +2,7 @@ class Hash
   # Provides a set of helper methods for making assertions about the content
   # of various objects
 
-  unless defined?(ActiveSupport)
+  unless respond_to?(:assert_valid_keys)
     # Validate all keys in a hash match <tt>*valid_keys</tt>, raising ArgumentError
     # on a mismatch. Note that keys are NOT treated indifferently, meaning if you
     # use strings for keys but assert symbols as keys, this will fail.
@@ -28,10 +28,10 @@ class Hash
   # == Examples
   #
   #   options = {:only => :on, :except => :off}
-  #   assert_exclusive_keys(options, :only)                   # => nil
-  #   assert_exclusive_keys(options, :except)                 # => nil
-  #   assert_exclusive_keys(options, :only, :except)          # => ArgumentError: Conflicting keys: only, except
-  #   assert_exclusive_keys(options, :only, :except, :with)   # => ArgumentError: Conflicting keys: only, except
+  #   options.assert_exclusive_keys(:only)                   # => nil
+  #   options.assert_exclusive_keys(:except)                 # => nil
+  #   options.assert_exclusive_keys(:only, :except)          # => ArgumentError: Conflicting keys: only, except
+  #   options.assert_exclusive_keys(:only, :except, :with)   # => ArgumentError: Conflicting keys: only, except
   def assert_exclusive_keys(*exclusive_keys)
     conflicting_keys = exclusive_keys & keys
     raise ArgumentError, "Conflicting keys: #{conflicting_keys.join(', ')}" unless conflicting_keys.length <= 1

data/lib/state_machines/error.rb

@@ -14,7 +14,8 @@ module StateMachines
   # An invalid integration was specified
   class IntegrationNotFound < Error
     def initialize(name)
-      super(nil, "#{name.inspect} is an invalid integration")
+      valid_integrations_name = Integrations.list.collect(&:integration_name)
+      super(nil, "#{name.inspect} is an invalid integration. Valid integrations are: #{valid_integrations_name.join(', ')} ")
     end
   end
 

data/lib/state_machines/integrations.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 module StateMachines
   # Integrations allow state machines to take advantage of features within the
   # context of a particular library.  This is currently most useful with
@@ -22,11 +24,10 @@ module StateMachines
 
     class << self
       #  Register integration
-      def register(arg)
-        #TODO check name conflict
-        case arg.class.to_s
+      def register(name_or_module)
+        case name_or_module.class.to_s
           when 'Module'
-            add(arg)
+            add(name_or_module)
           else
             fail IntegrationError
         end
@@ -34,6 +35,16 @@ module StateMachines
       end
 
 
+      def unregister(name) #:nodoc:#
+        @integrations.delete(name)
+      end
+
+      def reset #:nodoc:#
+        name_spaced_integrations
+        @integrations = Set.new
+        true
+      end
+
       # Gets a list of all of the available integrations for use.
       #
       # == Example
@@ -48,6 +59,7 @@ module StateMachines
         name_spaced_integrations
         @integrations
       end
+      alias_method :list, :integrations
 
 
       # Attempts to find an integration that matches the given class.  This will
@@ -104,17 +116,12 @@ module StateMachines
       def name_spaced_integrations
         self.constants.each do |const|
           integration = self.const_get(const)
-          add(integration) if integration.respond_to?(:integration_name)
+          add(integration)
         end
       end
 
       def add(integration)
-        @integrations << integration
-      end
-
-      def reset
-        @integrations = Set.new
-        name_spaced_integrations
+        @integrations << integration  if integration.respond_to?(:integration_name)
       end
     end
   end

data/lib/state_machines/machine.rb

@@ -439,14 +439,13 @@ module StateMachines
       end
 
 
-      def draw(class_names, options = {})
+      def draw(*)
         fail NotImplementedError
       end
-    end
 
-    # Default messages to use for validation errors in ORM integrations
-    class << self;
-      attr_accessor :default_messages;
+      # Default messages to use for validation errors in ORM integrations
+      attr_accessor :default_messages
+      attr_accessor :ignore_method_conflicts
     end
     @default_messages = {
         :invalid => 'is invalid',
@@ -456,9 +455,6 @@ module StateMachines
 
     # Whether to ignore any conflicts that are detected for helper methods that
     # get generated for a machine's owner class.  Default is false.
-    class << self;
-      attr_accessor :ignore_method_conflicts;
-    end
     @ignore_method_conflicts = false
 
     # The class that the machine is defined in
@@ -1828,20 +1824,20 @@ module StateMachines
     # Marks the given object as invalid with the given message.
     # 
     # By default, this is a no-op.
-    def invalidate(object, attribute, message, values = [])
+    def invalidate(_object, _attribute, _message, _values = [])
     end
 
     # Gets a description of the errors for the given object.  This is used to
     # provide more detailed information when an InvalidTransition exception is
     # raised.
-    def errors_for(object)
+    def errors_for(_object)
       ''
     end
 
     # Resets any errors previously added when invalidating the given object.
     # 
     # By default, this is a no-op.
-    def reset(object)
+    def reset(_object)
     end
 
     # Generates the message to use when invalidating the given object after
@@ -1872,7 +1868,7 @@ module StateMachines
     end
 
 
-    def draw(graph_options = {})
+    def draw(*)
       fail NotImplementedError
     end
 

data/lib/state_machines/version.rb

@@ -1,3 +1,3 @@
 module StateMachines
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/state_machines.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'state_machines/version'
@@ -7,19 +6,18 @@ Gem::Specification.new do |spec|
   spec.name          = 'state_machines'
   spec.version       = StateMachines::VERSION
   spec.authors       = ['Abdelkader Boudih', 'Aaron Pfeifer']
-  spec.email         = ['terminale@gmail.com']
+  spec.email         = %w(terminale@gmail.com aaron@pluginaweek.org)
   spec.summary       = %q(State machines for attributes)
   spec.description   = %q(Adds support for creating state machines for attributes on any Ruby class)
-  spec.homepage      = 'https://github.com/seuros/state_machines'
+  spec.homepage      = 'https://github.com/state-machines/state_machines'
   spec.license       = 'MIT'
 
-  spec.required_ruby_version     = '>= 1.9.3'
+  spec.required_ruby_version     = '>= 2.0.0'
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.test_files    = spec.files.grep(/^spec\//)
+  spec.test_files    = spec.files.grep(/^test\//)
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'bundler', '>= 1.7.6'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec' , '3.0.0.beta2'
-  spec.add_development_dependency 'rspec-its'
+  spec.add_development_dependency 'minitest', '>= 5.4'
 end

data/test/files/integrations/event_on_failure_integration.rb

@@ -0,0 +1,10 @@
+module EventOnFailureIntegration
+  include StateMachines::Integrations::Base
+  def invalidate(object, _attribute, message, values = [])
+    (object.errors ||= []) << generate_message(message, values)
+  end
+
+  def reset(object)
+    object.errors = []
+  end
+end

data/test/files/integrations/vehicle.rb

@@ -0,0 +1,7 @@
+module VehicleIntegration
+  include StateMachines::Integrations::Base
+
+  def self.matching_ancestors
+    ['Vehicle']
+  end
+end

data/{spec/internal/app → test/files}/models/car.rb

@@ -1,3 +1,5 @@
+require_relative '../../files/models/vehicle'
+
 class Car < Vehicle
   state_machine do
     event :reverse do

data/{spec/internal/app → test/files}/models/motorcycle.rb

@@ -1,3 +1,5 @@
+require_relative '../../files/models/vehicle'
+
 class Motorcycle < Vehicle
   state_machine initial: :idling do
     state :first_gear do

data/{spec/internal/app → test/files}/models/traffic_light.rb

@@ -25,7 +25,7 @@ class TrafficLight
     end
 
     state :proceed do
-      def color(transform)
+      def color(_transform)
         'green'
       end
 
@@ -35,7 +35,7 @@ class TrafficLight
     end
 
     state :caution do
-      def color(transform)
+      def color(_transform)
         'yellow'
       end
     end

data/{spec/internal/app → test/files}/models/vehicle.rb

@@ -1,3 +1,6 @@
+require_relative 'model_base'
+require_relative 'auto_shop'
+
 class Vehicle < ModelBase
   attr_accessor :auto_shop, :seatbelt_on, :insurance_premium, :force_idle, :callbacks, :saved, :time_elapsed, :last_transition_args
 
@@ -16,7 +19,7 @@ class Vehicle < ModelBase
   end
 
   # Defines the state machine for the state of the vehicled
-  state_machine initial: lambda { |vehicle| vehicle.force_idle ? :idling : :parked }, action: :save do
+  state_machine initial: ->(vehicle) { vehicle.force_idle ? :idling : :parked }, action: :save do
     before_transition { |vehicle, transition| vehicle.last_transition_args = transition.args }
     before_transition parked: any, do: :put_on_seatbelt
     before_transition any => :stalled, :do => :increase_insurance_premium
@@ -25,10 +28,10 @@ class Vehicle < ModelBase
     after_transition on: :repair, do: :fix
 
     # Callback tracking for initial state callbacks
-    after_transition any => :parked, :do => lambda { |vehicle| vehicle.callbacks << 'before_enter_parked' }
-    before_transition any => :idling, :do => lambda { |vehicle| vehicle.callbacks << 'before_enter_idling' }
+    after_transition any => :parked, :do => ->(vehicle) { vehicle.callbacks << 'before_enter_parked' }
+    before_transition any => :idling, :do => ->(vehicle) { vehicle.callbacks << 'before_enter_idling' }
 
-    around_transition do |vehicle, transition, block|
+    around_transition do |vehicle, _transition, block|
       time = Time.now
       block.call
       vehicle.time_elapsed = Time.now - time
@@ -61,7 +64,7 @@ class Vehicle < ModelBase
     end
 
     event :crash do
-      transition [:first_gear, :second_gear, :third_gear] => :stalled, :if => lambda { |vehicle| vehicle.auto_shop.available? }
+      transition [:first_gear, :second_gear, :third_gear] => :stalled, :if => ->(vehicle) { vehicle.auto_shop.available? }
     end
 
     event :repair do
@@ -106,6 +109,7 @@ class Vehicle < ModelBase
   end
 
   private
+
   # Safety first! Puts on our seatbelt
   def put_on_seatbelt
     self.seatbelt_on = true

data/test/files/node.rb

@@ -0,0 +1,5 @@
+class Node < Struct.new(:name, :value, :machine)
+  def context
+    yield
+  end
+end

data/test/files/switch.rb

@@ -0,0 +1,15 @@
+class Switch
+  def self.name
+    @name ||= "Switch_#{rand(1_000_000)}"
+  end
+
+  state_machine do
+    event :turn_on do
+      transition all => :on
+    end
+
+    event :turn_off do
+      transition all => :off
+    end
+  end
+end

data/test/functional/auto_shop_available_test.rb

@@ -0,0 +1,20 @@
+require_relative '../test_helper'
+require_relative '../files/models/auto_shop'
+
+class AutoShopAvailableTest < MiniTest::Test
+  def setup
+    @auto_shop = AutoShop.new
+  end
+
+  def test_should_be_in_available_state
+    assert_equal 'available', @auto_shop.state
+  end
+
+  def test_should_allow_tow_vehicle
+    assert @auto_shop.tow_vehicle
+  end
+
+  def test_should_not_allow_fix_vehicle
+    refute @auto_shop.fix_vehicle
+  end
+end

data/test/functional/auto_shop_busy_test.rb

@@ -0,0 +1,25 @@
+require_relative '../test_helper'
+require_relative '../files/models/auto_shop'
+
+class AutoShopBusyTest < MiniTest::Test
+  def setup
+    @auto_shop = AutoShop.new
+    @auto_shop.tow_vehicle
+  end
+
+  def test_should_be_in_busy_state
+    assert_equal 'busy', @auto_shop.state
+  end
+
+  def test_should_have_incremented_number_of_customers
+    assert_equal 1, @auto_shop.num_customers
+  end
+
+  def test_should_not_allow_tow_vehicle
+    refute @auto_shop.tow_vehicle
+  end
+
+  def test_should_allow_fix_vehicle
+    assert @auto_shop.fix_vehicle
+  end
+end

data/test/functional/car_backing_up_test.rb

@@ -0,0 +1,45 @@
+require_relative '../test_helper'
+require_relative '../files/models/car'
+
+class CarBackingUpTest < MiniTest::Test
+  def setup
+    @car = Car.new
+    @car.reverse
+  end
+
+  def test_should_be_in_backing_up_state
+    assert_equal 'backing_up', @car.state
+  end
+
+  def test_should_allow_park
+    assert @car.park
+  end
+
+  def test_should_not_allow_ignite
+    refute @car.ignite
+  end
+
+  def test_should_allow_idle
+    assert @car.idle
+  end
+
+  def test_should_allow_shift_up
+    assert @car.shift_up
+  end
+
+  def test_should_not_allow_shift_down
+    refute @car.shift_down
+  end
+
+  def test_should_not_allow_crash
+    refute @car.crash
+  end
+
+  def test_should_not_allow_repair
+    refute @car.repair
+  end
+
+  def test_should_not_allow_reverse
+    refute @car.reverse
+  end
+end

data/test/functional/car_test.rb

@@ -0,0 +1,49 @@
+require_relative '../test_helper'
+require_relative '../files/models/car'
+
+class CarTest < MiniTest::Test
+  def setup
+    @car = Car.new
+  end
+
+  def test_should_be_in_parked_state
+    assert_equal 'parked', @car.state
+  end
+
+  def test_should_not_have_the_seatbelt_on
+    refute @car.seatbelt_on
+  end
+
+  def test_should_not_allow_park
+    refute @car.park
+  end
+
+  def test_should_allow_ignite
+    assert @car.ignite
+    assert_equal 'idling', @car.state
+  end
+
+  def test_should_not_allow_idle
+    refute @car.idle
+  end
+
+  def test_should_not_allow_shift_up
+    refute @car.shift_up
+  end
+
+  def test_should_not_allow_shift_down
+    refute @car.shift_down
+  end
+
+  def test_should_not_allow_crash
+    refute @car.crash
+  end
+
+  def test_should_not_allow_repair
+    refute @car.repair
+  end
+
+  def test_should_allow_reverse
+    assert @car.reverse
+  end
+end

data/test/functional/motorcycle_test.rb

@@ -0,0 +1,46 @@
+require_relative '../test_helper'
+require_relative '../files/models/motorcycle'
+
+class MotorcycleTest < MiniTest::Test
+  def setup
+    @motorcycle = Motorcycle.new
+  end
+
+  def test_should_be_in_idling_state
+    assert_equal 'idling', @motorcycle.state
+  end
+
+  def test_should_allow_park
+    assert @motorcycle.park
+  end
+
+  def test_should_not_allow_ignite
+    refute @motorcycle.ignite
+  end
+
+  def test_should_allow_shift_up
+    assert @motorcycle.shift_up
+  end
+
+  def test_should_not_allow_shift_down
+    refute @motorcycle.shift_down
+  end
+
+  def test_should_not_allow_crash
+    refute @motorcycle.crash
+  end
+
+  def test_should_not_allow_repair
+    refute @motorcycle.repair
+  end
+
+  def test_should_inherit_decibels_from_superclass
+    @motorcycle.park
+    assert_equal 0.0, @motorcycle.decibels
+  end
+
+  def test_should_use_decibels_defined_in_state
+    @motorcycle.shift_up
+    assert_equal 1.0, @motorcycle.decibels
+  end
+end

data/test/functional/traffic_light_caution_test.rb

@@ -0,0 +1,17 @@
+require_relative '../test_helper'
+require_relative '../files/models/traffic_light'
+
+class TrafficLightCautionTest < MiniTest::Test
+  def setup
+    @light = TrafficLight.new
+    @light.state = 'caution'
+  end
+
+  def test_should_use_caution_color
+    assert_equal 'yellow', @light.color
+  end
+
+  def test_should_use_caution_capture_violations
+    assert_equal true, @light.capture_violations?
+  end
+end