actionizer 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c2200e547ac2adeb77d8ab2394037f7006550c5
-  data.tar.gz: d8865ebe73d8d765f8452b31db58ed24b804f69c
+  metadata.gz: 7d164afc660031126496b00a38e931702afd5814
+  data.tar.gz: ddd5bf72049506461b926b387355dffadfd4dc42
 SHA512:
-  metadata.gz: cb086adc3bb250d211d585f92379ca3fa9292c4b5336676e49beb2cf59c0f18d2274f7137cd1480e2ef82a6f8854c20467b8d453788cb36fda5da85b0e134f94
-  data.tar.gz: 63a124f87db6bd8ee1c6aa2808adfbe6a6cb82cfdf214ab56c9a7191a8e9f3e82e4f21df88f7bafd4cb2e475b3a99e52ad0adc875bfd488e82b6d6c11b9aead5
+  metadata.gz: e335eb30321f19c246d4087b6ad7aa824efbca9971b1aa1a0dc42c9c2d9bfe2fca5d9ceb59160aef88d49b8961c6a2a19fcad1e84f4d7d8ed7d9f7aa41017ebe
+  data.tar.gz: 9fc717ebadfb532442bc080ff3ff49300611ed1ef3a07eabad9c33f498ee7c074e7653e352a363576fd730e228af0447ab59ab8208ee6b43b77e220caef78daa

data/README.md

@@ -24,82 +24,81 @@ Or install it yourself as:
 
 ## Usage
 
-Here's how you define an Action:
+Include `Actionizer` in your class and define an instance method. That instance method will be automatically invoked when you call the class method of the same name. Any Action defined with `Actionizer` will automatically return a hash-like result you can check for `success?` or `failure?`.
 
-```ruby
-module Action
-  module Users
-
-    class Create
-      include Actionizer
+Inputs are available on the `input` instance variable. Use `output` to set any variables you want returned in the result.
 
-      def call
-        # Do stuff here
-        output.user = user
-      end
-    end
+```ruby
+class CreateUser
+  include Actionizer
 
+  def call
+    # Some validation here...
+    output.user = User.create(name: input.name)
   end
 end
 ```
 
-You can immediately stop execution with the `fail!` method
+Actions are successful by default:
 ```ruby
-module Action
-  module Users
+result = SuccessfulAction.call(id: 1234)
 
-    class Delete
-      include Actionizer
+result.success?
+#=> true
+result.failure?
+#=> false
+```
 
-      def call
-        # Possibly failing code here
-        fail!(error: "Nope, didn't work") if failure_condition
+You can immediately stop execution with the `fail!` method.
+```ruby
+class DeleteAccount
+  include Actionizer
 
-        # This code never runs
-        output.foo = 'bar'
-      end
-    end
+  def run
+    # Possibly failing code here
+    fail!(error: "Nope, didn't work") if failure_condition
 
+    # This code never runs
+    output.foo = 'bar'
   end
 end
 ```
 
-Here's how you invoke it:
+When an action fails with `fail!`, the result it returns will return false for `success?` and true for `failure?`.
 ```ruby
-module Action
-  module Users
+result = FailingAction.call(id: 1234)
 
-    class Onboard
-      include Actionizer
+result.success?
+#=> false
+result.failure?
+#=> true
+```
 
-      def call
-        result = Action::Users::Create.call(name: name, email: email)
-        fail!(error: result.error) if result.failure?
+The most common way to use Actionizer is to compose small pieces of functionality (which can themselves be Actions) into larger pieces of functionality to give that sequence of Actions a name and simple interface.
+```ruby
+class OnboardUser
+  include Actionizer
 
-        result = Action::Users::SendWelcomeEmail.call(name: name, email: email)
-        fail!(error: result.error) if result.failure?
-      end
-    end
+  def call
+    result = CreateUser.call(name: input.name, email: input.email)
+    fail!(error: result.error) if result.failure?
 
+    result = SendWelcomeEmail.deliver_now(name: input.name, email: input.email)
+    fail!(error: result.error) if result.failure?
   end
 end
 ```
 
-This pattern is so common, there's a shorthand: `call_and_check_failure!`
-```ruby
-module Action
-  module Users
 
-    class Onboard
-      include Actionizer
-
-      def call
-        # This code is identical to the example above
-        call_and_check_failure!(Action::Users::Create, name: name, email: email)
-        call_and_check_failure!(Action::Users::SendWelcomeEmail, name: name, email: email)
-      end
-    end
+This pattern is so common, there's a shorthand: `<METHOD>_or_fail`. It works for any instance method defined on the class you specify.
+```ruby
+class OnboardUser
+  include Actionizer
 
+  def call
+    # This code is identical to the example above
+    call_or_fail(CreateUser, name: input.name, email: input.email)
+    deliver_now_or_fail(SendWelcomeEmail, name: input.name, email: input.email)
   end
 end
 ```

data/actionizer.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.11'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'byebug', '~> 8.2'
+  spec.add_development_dependency 'pry-byebug', '~> 3.3'
   spec.add_development_dependency 'rubocop', '~> 0.37'
   spec.add_development_dependency 'simplecov', '~> 0.11'
 end

data/lib/actionizer.rb

@@ -6,17 +6,25 @@ module Actionizer
   attr_reader :input, :output
 
   def self.included(base)
-    base.class_eval do
-      extend ClassMethods
-    end
+    base.extend(ClassMethods)
   end
 
   module ClassMethods
-    def call(inputs = {})
-      new(inputs).tap(&:call).output
+    def method_missing(method_name, *args, &block)
+      instance = new(*args)
+
+      if instance.respond_to?(method_name)
+        instance.tap(&method_name).output
+      else
+        super
+      end
     rescue Actionizer::Failure => af
       af.output
     end
+
+    def respond_to_missing?(method_name, include_private = false)
+      new.respond_to?(method_name, include_private)
+    end
   end
 
   def initialize(initial_input = {})
@@ -32,14 +40,23 @@ module Actionizer
     raise Actionizer::Failure.new('Failed!', output)
   end
 
-  def call_and_check_failure!(action_class, params = {})
+  # Allows you to call *_or_fail
+  def method_missing(method_name, *args, &block)
+    return super unless method_name.to_s.end_with?('_or_fail')
+
+    action_class, params = *args
+
     unless action_class.include? Actionizer
       raise ArgumentError, "#{action_class.name} must include Actionizer"
     end
 
-    result = action_class.call(params)
+    result = action_class.send(method_name.to_s.chomp('_or_fail'), params)
     fail!(error: result.error) if result.failure?
 
     result
   end
+
+  def respond_to_missing?(method_name, _include_private = false)
+    method_name.to_s.end_with?('_or_fail')
+  end
 end

data/lib/actionizer/version.rb

@@ -1,3 +1,3 @@
 module Actionizer
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionizer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Mike Nichols
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-03 00:00:00.000000000 Z
+date: 2016-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.2'
+        version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '8.2'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement