flow_machine 0.1.0

data/spec/flow_machine/workflow_state_spec.rb

@@ -0,0 +1,253 @@
+RSpec.describe FlowMachine::WorkflowState do
+  class StateTestClass < described_class
+    def self.state_name; :test; end
+    def guard1?; end
+    def guard2?; end
+    def after_hook; end
+  end
+
+  class WorkflowTestClass
+    include FlowMachine::Workflow
+    def workflow_guard?; end
+    def workflow_hook; end
+  end
+
+  let(:state_class) { Class.new(StateTestClass) }
+  let(:workflow_class) { Class.new WorkflowTestClass }
+
+  before :each do
+    workflow_class.state state_class
+  end
+
+  let(:object) { double state: :test, changes: {}, save: true, new_record?: true }
+  let(:workflow) { workflow_class.new(object) }
+
+  describe 'defining events' do
+    context 'a basic event' do
+
+      before { state_class.event :event1 }
+      subject(:state) { state_class.new(workflow) }
+
+      it 'defines the event on the object' do
+        expect(state).to respond_to :event1
+      end
+
+      it 'defines may_event1?' do
+        expect(state).to respond_to :may_event1?
+      end
+
+      it 'defines the bang event' do
+        expect(state).to respond_to :event1!
+      end
+    end
+  end
+
+  describe 'events' do
+    let(:state_class2) do
+      Class.new(described_class) do
+        def self.state_name; :test2; end
+      end
+    end
+    before :each do
+      state_class.event(:event1) { transition to: :test2 }
+      workflow_class.refresh_state_methods!
+      workflow_class.state state_class2
+    end
+
+    it 'returns false when trying to transition to the current state' do
+      expect(object).to receive(:state).and_return :test2
+      expect(workflow.event1).to be false
+    end
+  end
+
+  describe 'guards' do
+    subject(:state) { workflow.current_state }
+
+    context 'a single guard' do
+      before { state_class.event(:event1, guard: :guard1?) {} }
+      it 'calls the guard' do
+        expect(state).to receive(:guard1?).and_return true
+        state.event1
+      end
+
+      context 'may?' do
+        it 'is able to transition if the guard returns true' do
+          expect(state).to receive(:guard1?).and_return true
+          expect(state.may_event1?).to be true
+        end
+
+        it 'is not able to transition if the guard returns false' do
+          expect(state).to receive(:guard1?).and_return false
+          expect(state.may_event1?).to be false
+        end
+      end
+    end
+
+    context 'the guard method is on the workflow instead' do
+      before { state_class.event(:event1, guard: :workflow_guard?) {} }
+      it 'calls the guard' do
+        expect(workflow).to receive(:workflow_guard?).and_return true
+        state.event1
+      end
+    end
+
+    context 'the guard method is on the object' do
+      before { state_class.event(:event1, guard: :object_guard?) {} }
+      it 'calls the guard' do
+        expect(object).to receive(:object_guard?).and_return true
+        state.event1
+      end
+    end
+
+    context 'multiple guards' do
+      before do
+        state_class.event(:event1, guard: [:guard1?, :guard2?]) {}
+        workflow_class.refresh_state_methods!
+      end
+      it 'calls all the guards' do
+        expect(state).to receive(:guard1?).and_return true
+        expect(state).to receive(:guard2?).and_return true
+        state.event1
+      end
+
+      context 'one guard returns false' do
+        before :each do
+          expect(state).to receive(:guard1?).and_return false
+          expect(state).to receive(:guard2?).and_return true
+        end
+
+        it 'gets the guard errors on may_event' do
+          workflow.may_event1?
+          expect(workflow.guard_errors).to eq([:guard1?])
+        end
+
+        it 'gets the guard errors on transition' do
+          workflow.event1
+          expect(workflow.guard_errors).to eq([:guard1?])
+        end
+      end
+    end
+
+    it 'does not call the event block if the guard fails' do
+      state_class.event(:event1, guard: [:guard1?]) { raise 'Should not call block' }
+      expect(state).to receive(:guard1?).and_return false
+      state.event1
+    end
+  end
+
+  describe 'triggering workflow after_transition hook' do
+    let(:state) { workflow.current_state }
+    before do
+      workflow_class.after_transition :workflow_hook
+
+      state_class.event :event1, guard: :guard1? do
+        transition to: :state2
+      end
+
+      workflow_class.refresh_state_methods!
+    end
+
+    it 'calls the hook on transition' do
+      # allow the transition, and make it think it's a different state
+      expect(workflow).to receive(:current_state_name=).with('state2')
+      expect(state).to receive(:==).and_return false
+
+      expect(state).to receive(:guard1?).and_return(true)
+      expect(workflow).to receive(:workflow_hook)
+      workflow.event1
+    end
+
+    it 'does not call the hook on failure' do
+      expect(state).to receive(:guard1?).and_return(false)
+      expect(workflow).not_to receive(:workflow_hook)
+      workflow.event1
+    end
+  end
+
+  describe 'after transition hooks' do
+    let(:state) { workflow.current_state }
+    before :each do
+      state_class.event :event1 do
+        transition to: :state2, after: :after_hook
+      end
+
+      workflow_class.refresh_state_methods!
+
+      expect(workflow).to receive(:current_state_name=).with('state2')
+    end
+
+    it 'does not call the hook before saving' do
+      expect(state).to receive(:after_hook).never
+      workflow.event1
+    end
+
+    it 'calls the hook after saving the transition' do
+      expect(state).to receive(:after_hook).once
+      workflow.event1
+      workflow.persist
+    end
+  end
+
+  describe 'after_enter' do
+    let(:state) { state_class.new(workflow) }
+    context 'the method is on the workflow' do
+      before { state_class.after_enter :workflow_hook }
+      it "can call the method" do
+        expect(workflow).to receive(:workflow_hook)
+        state.fire_callbacks(:after_enter, {})
+      end
+    end
+
+    context 'the method is on the object' do
+      before { state_class.after_enter :object_hook }
+
+      it "can call the method" do
+        expect(object).to receive(:object_hook)
+        state.fire_callbacks(:after_enter, {})
+      end
+    end
+  end
+
+  describe '#run_workflow_method' do
+    let(:state) { state_class.new(workflow) }
+
+    context 'nothing in the chain has the method' do
+      it 'raises a NoMethodError' do
+        expect { state.run_workflow_method :some_method }.to raise_error(NoMethodError)
+      end
+    end
+
+    context 'the object defines the method' do
+      before :each do
+        allow(object).to receive(:some_method)
+      end
+
+      it 'calls the method on object' do
+        expect(object).to receive(:some_method)
+        state.run_workflow_method :some_method
+      end
+
+      context 'and the workflow defines the method' do
+        before :each do
+          workflow.singleton_class.send(:define_method, :some_method) {}
+        end
+
+        it 'calls the method on workflow' do
+          expect(workflow).to receive(:some_method)
+          state.run_workflow_method :some_method
+        end
+
+        context 'and the state defines the method' do
+          before :each do
+            state.singleton_class.send(:define_method, :some_method) {}
+          end
+
+          it 'calls the method on the state' do
+            expect(state).to receive(:some_method)
+            state.run_workflow_method :some_method
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+GEM_ROOT = File.expand_path('../../', __FILE__)
+$LOAD_PATH.unshift File.join(GEM_ROOT, 'lib')
+
+require 'rspec/its'
+require 'flow_machine'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  # config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  # config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: flow_machine
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jason Hanggi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: Build finite state machines in a backend-agnostic, class-centric way.
+email:
+- jason@tablexi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/flow_machine.rb
+- lib/flow_machine/callback.rb
+- lib/flow_machine/change_callback.rb
+- lib/flow_machine/factory.rb
+- lib/flow_machine/state_callback.rb
+- lib/flow_machine/version.rb
+- lib/flow_machine/workflow.rb
+- lib/flow_machine/workflow_state.rb
+- lib/tasks/workflow_tasks.rake
+- spec/flow_machine/factory_spec.rb
+- spec/flow_machine/multiple_workflow_spec.rb
+- spec/flow_machine/workflow_callback_spec.rb
+- spec/flow_machine/workflow_change_callback_spec.rb
+- spec/flow_machine/workflow_spec.rb
+- spec/flow_machine/workflow_state_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.github.com/tablexi/flow_machine
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A class-based state machine.
+test_files:
+- spec/flow_machine/factory_spec.rb
+- spec/flow_machine/multiple_workflow_spec.rb
+- spec/flow_machine/workflow_callback_spec.rb
+- spec/flow_machine/workflow_change_callback_spec.rb
+- spec/flow_machine/workflow_spec.rb
+- spec/flow_machine/workflow_state_spec.rb
+- spec/spec_helper.rb