flow_machine 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7c615b72e507282a2a54032525a6874fbb8961ee
-  data.tar.gz: 461ed246d3ae29d77e3818630b73c9483e4959c5
+  metadata.gz: 5ddc0a3879f962108fb9bc5616667131e0e3830e
+  data.tar.gz: 1ce4561e9efd33531e4d3754b24ef653b3c047bc
 SHA512:
-  metadata.gz: 6d5690d15116ee1c6b853289f484a1f9aef09669b13d06460b82ec5b50e0bcdf318d9acff85579fb583ebfded8e0d7cf2a3a640076f5a1b5a8d8b7a78a5b6d4a
-  data.tar.gz: 8683235ed2e91f8874941f5be89c0e4f9e53f7a4d4329e9a21d653a904210b65db28265b4b2efd9ebbb308f84543c842c3789ae2cb390a84080659e8a1d28588
+  metadata.gz: 569a2f85b79f0328cf6af65d4a2f5e11a783b7c06c88380f6ef7f6a6e7e551a2b96d541d0ead6681b5f27eeaf99f0cfd6ed50327d843895750dc6e5ee199aea0
+  data.tar.gz: 12b15553a5ec36b9e49d1fc8f801c4ccf554a0d809b75ddcafbc0cea4b64043b35f8d6a1148f423546b34fbf52d4057c33fde101296262f535b15140c47d04b3

data/README.md

@@ -8,6 +8,10 @@ The basic features will work with any PORO, and more features and callbacks are
 
 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
+
 ## Simple Usage
 
 ```ruby
@@ -132,6 +136,28 @@ Declared as an option to the `transition` method inside an `event` block.
 
 `transition to: :published, after: :send_mailing_list_email`
 
+## FlowMachine::Workflow.for
+
+You can easily access the workflow for your particular object, class, or collection of objects.
+
+Examples:
+
+```ruby
+blog = BlogPost.new
+FlowMachine::Workflow.for(blog) # => BlogPostWorkflow
+
+FlowMachine::Workflow.for(BlogPost) # => BlogPostWorkflow
+```
+
+You can also create an collection of workflow objects via:
+
+```ruby
+blog_posts = BlogPost.all
+
+FlowMachine::Workflow.collection_for(blog_posts) # => [BlogPostWorkfow.new(blog_post[0]), ..., BlogPostWorkflow.new(blog_post[n])
+```
+
+
 ## Scopes and Predicate methods
 
 If you want scopes and predicate methods defined on your model, use the following:

data/lib/flow_machine.rb

@@ -1,7 +1,6 @@
 $:.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"

data/lib/flow_machine/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flow_machine
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jason Hanggi
@@ -65,14 +65,12 @@ files:
 - 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/factory_methods.rb
 - lib/flow_machine/workflow_state.rb
 - lib/tasks/workflow_tasks.rake
-- 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
@@ -105,7 +103,6 @@ signing_key:
 specification_version: 4
 summary: A class-based state machine.
 test_files:
-- 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

data/lib/flow_machine/factory.rb

@@ -1,24 +0,0 @@
-module FlowMachine
-  # 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 = {})
-      deprecate :workflow_for, :for
-      FlowMachine::Workflow.for(object, options)
-    end
-
-    def self.workflow_for_collection(collection, options = {})
-      deprecate :workflow_for_collection, :for_collection
-      FlowMachine::Workflow.for_collection(collection, options)
-    end
-
-    def self.workflow_class_for(object_or_class)
-      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/spec/flow_machine/deprecated_factory_methods_spec.rb

@@ -1,53 +0,0 @@
-RSpec.describe FlowMachine::Factory do
-  class TestClass; end
-
-  class TestClassWorkflow
-    include FlowMachine::Workflow
-  end
-
-  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 }
-      it { should eq(TestClassWorkflow) }
-    end
-
-    describe 'with an object' do
-      let(:target) { TestClass.new }
-      it { should eq(TestClassWorkflow) }
-    end
-  end
-
-  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
-      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.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
-end