flow_machine 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e9a4fd3c30a8e7920333c34c4cb23b075648f91
-  data.tar.gz: 6df24793c54c72d1498ab49b40da25b3aa29820f
+  metadata.gz: 7c615b72e507282a2a54032525a6874fbb8961ee
+  data.tar.gz: 461ed246d3ae29d77e3818630b73c9483e4959c5
 SHA512:
-  metadata.gz: 4d287bcf3788aeec09232337a905d8c851065c0e2067455480f95308dd764d8c8567e5b11beadf316919e64ee94c3921ec9d2035afb6c014bc43205820433ae6
-  data.tar.gz: cfc7ec61704bb070cf216704edd496f5d1719f3f4c52c026c6e92dd1de013ea4ab9ce4bdcc72e4bd18eb85a019e1ad2c5ff3536ed76d8a4d65d3c5be2e6b5a7d
+  metadata.gz: 6d5690d15116ee1c6b853289f484a1f9aef09669b13d06460b82ec5b50e0bcdf318d9acff85579fb583ebfded8e0d7cf2a3a640076f5a1b5a8d8b7a78a5b6d4a
+  data.tar.gz: 8683235ed2e91f8874941f5be89c0e4f9e53f7a4d4329e9a21d653a904210b65db28265b4b2efd9ebbb308f84543c842c3789ae2cb390a84080659e8a1d28588

data/README.md

@@ -172,6 +172,6 @@ class PublishedState < FlowMachine::WorkflowState
 end
 
 workflow = PublishingWorkflow.new(blog_post, current_user: User.find(123))
-workflow.published
+workflow.publish
 blog_post.published_by # => User #123
 ```

data/lib/flow_machine.rb

@@ -2,6 +2,7 @@ $:.unshift(File.dirname(__FILE__))
 
 require "flow_machine/workflow"
 require "flow_machine/factory"
+require "flow_machine/workflow/factory_methods"
 require "flow_machine/workflow_state"
 require "flow_machine/callback"
 require "flow_machine/state_callback"

data/lib/flow_machine/factory.rb

@@ -1,27 +1,24 @@
 module FlowMachine
-  class Factory
+  # Deprecated in favor of calling these methods directly off of FlowMachine
+  # which are defined in FlowMachine::FactoryMethods
+  module Factory
     def self.workflow_for(object, options = {})
-      # If the object is enumerable, delegate. This allows workflow_for
-      # as shorthand
-      return workflow_for_collection(object, options) if object.respond_to?(:map)
-
-      klazz = workflow_class_for(object)
-      return nil unless klazz
-      klazz.new(object, options)
+      deprecate :workflow_for, :for
+      FlowMachine::Workflow.for(object, options)
     end
 
     def self.workflow_for_collection(collection, options = {})
-      collection.map { |item| workflow_for(item, options) }
+      deprecate :workflow_for_collection, :for_collection
+      FlowMachine::Workflow.for_collection(collection, options)
     end
 
     def self.workflow_class_for(object_or_class)
-      if object_or_class.is_a? Class
-        "#{object_or_class.name}Workflow".constantize
-      else
-        workflow_class_for(object_or_class.class)
-      end
-    rescue NameError # if the workflow class doesn't exist
-      nil
+      deprecate :workflow_class_for, :class_for
+      FlowMachine::Workflow.class_for(object_or_class)
+    end
+
+    def self.deprecate(old_method_name, new_method_name)
+      warn "FlowMachine::Factory.#{old_method_name} is deprecated. Use FlowMachine::Workflow.#{new_method_name} instead."
     end
   end
 end

data/lib/flow_machine/version.rb

@@ -1,3 +1,3 @@
 module FlowMachine
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/flow_machine/workflow.rb

@@ -1,8 +1,11 @@
 require "active_support/core_ext/module/delegation"
 require "active_support/core_ext/object/try"
+require "flow_machine/workflow/factory_methods"
 
 module FlowMachine
   module Workflow
+    extend FlowMachine::FactoryMethods
+
     def self.included(base)
       base.extend(ClassMethods)
       base.send(:attr_reader, :object)

data/lib/flow_machine/workflow/factory_methods.rb

@@ -0,0 +1,28 @@
+# These methods are extended in the base FlowMachine module
+module FlowMachine
+  module FactoryMethods
+    def for(object, options = {})
+      # If the object is enumerable, delegate. This allows workflow_for
+      # as shorthand
+      return for_collection(object, options) if object.respond_to?(:map)
+
+      klazz = class_for(object)
+      return nil unless klazz
+      klazz.new(object, options)
+    end
+
+    def for_collection(collection, options = {})
+      collection.map { |item| self.for(item, options) }
+    end
+
+    def class_for(object_or_class)
+      if object_or_class.is_a? Class
+        "#{object_or_class.name}Workflow".constantize
+      else
+        self.class_for(object_or_class.class)
+      end
+    rescue NameError # if the workflow class doesn't exist
+      nil
+    end
+  end
+end

data/spec/flow_machine/{factory_spec.rb → deprecated_factory_methods_spec.rb}

@@ -7,6 +7,7 @@ RSpec.describe FlowMachine::Factory do
 
   describe '.workflow_class_for' do
     subject(:workflow_class) { described_class.workflow_class_for(target) }
+    before { expect(described_class).to receive(:deprecate) }
 
     describe 'with a class' do
       let(:target) { TestClass }
@@ -21,6 +22,8 @@ RSpec.describe FlowMachine::Factory do
 
   describe '.workflow_for' do
     subject(:workflow) { described_class.workflow_for(target) }
+    before { expect(described_class).to receive(:deprecate) }
+
     class SomeNewClass; end
 
     describe 'not found' do
@@ -42,6 +45,8 @@ RSpec.describe FlowMachine::Factory do
 
   describe '.workflow_for_collection' do
     subject(:result) { described_class.workflow_for_collection(target) }
+    before { expect(described_class).to receive(:deprecate) }
+
     let(:target) { [TestClass.new, TestClass.new] }
     it { should match [an_instance_of(TestClassWorkflow), an_instance_of(TestClassWorkflow)] }
   end

data/spec/flow_machine/factory_methods_spec.rb

@@ -0,0 +1,48 @@
+RSpec.describe FlowMachine::Workflow do
+  class TestClass; end
+
+  class TestClassWorkflow
+    include FlowMachine::Workflow
+  end
+
+  describe '.class_for' do
+    subject(:workflow_class) { described_class.class_for(target) }
+
+    describe 'with a class' do
+      let(:target) { TestClass }
+      it { should eq(TestClassWorkflow) }
+    end
+
+    describe 'with an object' do
+      let(:target) { TestClass.new }
+      it { should eq(TestClassWorkflow) }
+    end
+  end
+
+  describe '.for' do
+    subject(:workflow) { described_class.for(target) }
+    class SomeNewClass; end
+
+    describe 'not found' do
+      let(:target) { SomeNewClass.new }
+      it { should be_nil }
+    end
+
+    describe 'with an object' do
+      let(:target) { TestClass.new }
+      it { should be_an_instance_of(TestClassWorkflow) }
+      its(:object) { should eq(target) }
+    end
+
+    describe 'with an array of objects' do
+      let(:target) { [TestClass.new, TestClass.new] }
+      it { should match [an_instance_of(TestClassWorkflow), an_instance_of(TestClassWorkflow)] }
+    end
+  end
+
+  describe '.workflow_for_collection' do
+    subject(:result) { described_class.for_collection(target) }
+    let(:target) { [TestClass.new, TestClass.new] }
+    it { should match [an_instance_of(TestClassWorkflow), an_instance_of(TestClassWorkflow)] }
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flow_machine
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jason Hanggi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-24 00:00:00.000000000 Z
+date: 2015-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -69,9 +69,11 @@ files:
 - lib/flow_machine/state_callback.rb
 - lib/flow_machine/version.rb
 - lib/flow_machine/workflow.rb
+- lib/flow_machine/workflow/factory_methods.rb
 - lib/flow_machine/workflow_state.rb
 - lib/tasks/workflow_tasks.rake
-- spec/flow_machine/factory_spec.rb
+- spec/flow_machine/deprecated_factory_methods_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_change_callback_spec.rb
@@ -103,7 +105,8 @@ signing_key:
 specification_version: 4
 summary: A class-based state machine.
 test_files:
-- spec/flow_machine/factory_spec.rb
+- spec/flow_machine/deprecated_factory_methods_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_change_callback_spec.rb