flow_machine 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4f2854b32591eca32664799e2989ca782d48a210
-  data.tar.gz: 67dc2d6d227bfd8d9d6e206cabd68fe9744a671f
+SHA256:
+  metadata.gz: 6cd2fd744bfa9fae413fd4c4f5c9d47d05f80520623fdc5d95dd8be0bf0e13b1
+  data.tar.gz: f8f593c69fe42dbce33166fa81c3a92886bb70fe81169f24f1620f6c7d7733d8
 SHA512:
-  metadata.gz: 66e5f0523da68517a158f700e6a8513ca0fc39988e105ac047c6e23d44a1ed389471f95f7ce6af1f577305cbd6d0b888053e25dc5d3296e16e5e26d4f30eb211
-  data.tar.gz: e439a8fc84df57039721fb849e39037f045b0d6ed82711710091c03506271ee529f94401500be86aba05866e1e941aae0174ffaf9df37729f685372eb4f27f1a
+  metadata.gz: 1459686da1123e9358ec5bbfc73d52e5db44058aa1f691b9a5ce36f0fddd01ba1a38f28eea8646974c0463843b1c5c2ad26b4d260649431bfade61294e0e9bd6
+  data.tar.gz: 7006a927ea623460f60069e2ae9b082996fa571799651830692920924b61147fec783895093d3b1bf29dbebd76a4777606a61b658ffc3249012e7dfbf3d9d127

data/README.md

@@ -4,13 +4,14 @@ Build finite state machines in a backend-agnostic, class-centric way.
 
 The basic features will work with any PORO, and more features and callbacks are available when used with an ORM like `ActiveRecord` and/or `ActiveModel::Dirty`.
 
+ _Circle CI Status:_ [![Circle CI](https://circleci.com/gh/tablexi/flow_machine.svg?style=svg)](https://circleci.com/gh/tablexi/flow_machine)
 ## *Raison d'être*
 
 After exploring several of the existing Ruby state machine options, they all seem too tightly coupled to an ORM models and tend to pollute the object model's code far too much. The goal of this gem is to provide a clean, testable interface for working with a state machine that decouples as much as possible from the model object itself.
 
 ## Upgrading
 
-See [UPGRADE.md](UPGRADE.md) for details
+[CHANGELOG.md](CHANGELOG.md) will contain changes that need to be made at each version
 
 ## Requirements
 

data/lib/flow_machine/version.rb

@@ -1,3 +1,3 @@
 module FlowMachine
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/lib/flow_machine/workflow/model_extension.rb

@@ -0,0 +1,32 @@
+module FlowMachine
+  module Workflow
+    module ModelExtension
+      # resolves to
+      # class Model
+      #   def self.published
+      #     where(status: 'published')
+      #   end
+      #
+      #   def published?
+      #     self.status == 'published'
+      #   end
+      # end
+      def create_scopes_on(content_class)
+        state_method = self.state_method
+        state_names.each do |status|
+          # Don't add the scope classes if `where` is not defined since it means
+          # you're likely not in a ORM class.
+          if content_class.respond_to?(:where)
+            content_class.singleton_class.send(:define_method, status) do
+              where(state_method => status)
+            end
+          end
+
+          content_class.send(:define_method, "#{status}?") do
+            public_send(state_method) == status
+          end
+        end
+      end
+    end
+  end
+end

data/lib/flow_machine/workflow.rb

@@ -1,6 +1,7 @@
 require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/object/try"
 require "flow_machine/workflow/factory_methods"
+require "flow_machine/workflow/model_extension"
 
 module FlowMachine
   module Workflow
@@ -8,31 +9,11 @@ module FlowMachine
 
     def self.included(base)
       base.extend(ClassMethods)
+      base.extend(ModelExtension)
       base.send(:attr_reader, :object)
     end
 
     module ClassMethods
-      # resolves to
-      # class Model
-      #   def self.published
-      #     where(status: 'published')
-      #   end
-      #
-      #   def published?
-      #     self.status == 'published'
-      #   end
-      # end
-      def create_scopes_on(content_class)
-        self.state_names.each do |status|
-          content_class.singleton_class.send(:define_method, status) do
-            where(status: status)
-          end
-
-          content_class.send(:define_method, "#{status}?") do
-            self.status == status
-          end
-        end
-      end
 
       attr_accessor :callbacks
 

data/spec/flow_machine/workflow/model_extension_spec.rb

@@ -0,0 +1,55 @@
+require 'ostruct'
+
+RSpec.describe FlowMachine::Workflow::ModelExtension do
+  class Test1State < FlowMachine::WorkflowState
+  end
+
+  class Test2State < FlowMachine::WorkflowState
+  end
+
+  class TestWorkflow
+    include FlowMachine::Workflow
+    state Test1State
+    state Test2State
+  end
+
+  describe '.create_scopes_on' do
+    class PersistedModel < Struct.new(:state)
+      def self.where(opts)
+        [new(opts[:state])]
+      end
+
+      TestWorkflow.create_scopes_on(self)
+    end
+
+    class UnPersistedModel < Struct.new(:state)
+      TestWorkflow.create_scopes_on(self)
+    end
+
+    it 'adds the predicate model for state 1' do
+      expect(PersistedModel.new('test1')).to be_test1
+      expect(PersistedModel.new('test2')).not_to be_test1
+    end
+
+    it 'adds the predicate model for state 2' do
+      expect(PersistedModel.new('test1')).not_to be_test2
+      expect(PersistedModel.new('test2')).to be_test2
+    end
+
+    it 'adds a scope for test1' do
+      expect(PersistedModel.test1).to be_an(Array)
+      expect(PersistedModel.test1).to be_one
+      expect(PersistedModel.test1.first).to eq(PersistedModel.new('test1'))
+    end
+
+    it 'adds a scope for test2' do
+      expect(PersistedModel.test2).to be_an(Array)
+      expect(PersistedModel.test2).to be_one
+      expect(PersistedModel.test2.first).to eq(PersistedModel.new('test2'))
+    end
+
+    it 'does not add scopes if where is not defined' do
+      expect(UnPersistedModel).not_to respond_to(:test1)
+    end
+  end
+end

data/spec/flow_machine/workflow_spec.rb

@@ -121,8 +121,7 @@ RSpec.describe FlowMachine::Workflow do
 
       it 'does not call for invalid states' do
         expect(workflow).not_to receive(:after_transition_callback)
-        # Will throw an ArgumentError for invalid state
-        expect { workflow.transition to: :invalid_state }.to raise_error
+        expect { workflow.transition to: :invalid_state }.to raise_error(ArgumentError)
       end
 
       it 'does not call for ending in the same state' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flow_machine
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Jason Hanggi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2019-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rspec-its
   requirement: !ruby/object:Gem::Requirement
@@ -69,10 +69,12 @@ files:
 - lib/flow_machine/version.rb
 - lib/flow_machine/workflow.rb
 - lib/flow_machine/workflow/factory_methods.rb
+- lib/flow_machine/workflow/model_extension.rb
 - lib/flow_machine/workflow_state.rb
 - lib/tasks/workflow_tasks.rake
 - spec/flow_machine/factory_methods_spec.rb
 - spec/flow_machine/multiple_workflow_spec.rb
+- spec/flow_machine/workflow/model_extension_spec.rb
 - spec/flow_machine/workflow_callback_spec.rb
 - spec/flow_machine/workflow_change_callback_spec.rb
 - spec/flow_machine/workflow_spec.rb
@@ -98,16 +100,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: A class-based state machine.
 test_files:
+- spec/spec_helper.rb
+- spec/flow_machine/workflow_spec.rb
+- spec/flow_machine/workflow_state_spec.rb
 - spec/flow_machine/factory_methods_spec.rb
-- spec/flow_machine/multiple_workflow_spec.rb
 - spec/flow_machine/workflow_callback_spec.rb
+- spec/flow_machine/workflow/model_extension_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
-has_rdoc: 
+- spec/flow_machine/multiple_workflow_spec.rb