solid_use_case 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc73aaa654b2bb9094f89bdc59eadb2c6e6850ad
-  data.tar.gz: daf146af027dca257b571f6ee43487a1a30343cd
+  metadata.gz: 4e7056ae1ef3157772218479526874fa94e710f7
+  data.tar.gz: fd9a2327b8919bfd623d72e7fbe66ec6e0ced364
 SHA512:
-  metadata.gz: a18e3f021309842f666d8c8ee25d95468aa68c23d8c8d0bae297dbbe0a0868a125f23c436c7207ad3536b4aa1bfe645b51fa50069d246628f9eaa4e1f9b74fde
-  data.tar.gz: cfca654335a96807e4e95351981643a6e0a1dff902a604fadda53905b85da1c52a3e955981700a11344400499d6d25524f1eb34b688fce5d299c23481cc48d35
+  metadata.gz: 0dcee4954826b006d3c3bda5516536db3db27c1e1eca0c7731029daec17cd00a6122f8846f48237387e3fe45d81a81da2f8998a71b0fa9d3c287cea9c77d5a76
+  data.tar.gz: 24dab826516eab7bfe84842e89c3361ac06c039edfbbe0d82c226fd339ebbc843bc24a96878c431f59071a8d5637f1aab307fa3215cbc3447fb58fa23861516d

data/README.md

@@ -6,7 +6,7 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'solid_use_case', '~> 1.0.2'
+    gem 'solid_use_case', '~> 1.1.0'
 
 And then execute:
 
@@ -25,22 +25,17 @@ The only required method is the `#run` method.
 ### Rails Example
 
 ```ruby
-class UserSignup < SolidUseCase::Command
-  def run(params)
-    attempt_all do
-      step { validate(params) }
-      step {|params| save_user(params) }
-      try {|params| email_user(params) }
-    end
-  end
+class UserSignup < SolidUseCase::Base
+
+  steps :validate, :save_user, :email_user
 
   def validate(params)
     user = User.new(params[:user])
-    if user.valid?
+    if !user.valid?
       fail :invalid_user, :user => user
     else
       params[:user] = user
-      Success(params)
+      continue(params)
     end
   end
 
@@ -49,13 +44,14 @@ class UserSignup < SolidUseCase::Command
     if user.save
       fail :user_save_failed, :user => user
     else
-      Success(params)
+      continue(params)
     end
   end
 
   def email_user(params)
     UserMailer.async.deliver(:welcome, params[:user].id)
-    Success(params[:user])
+    # Because this is the last step, we want to end with the created user
+    continue(params[:user])
   end
 end
 ```
@@ -72,15 +68,15 @@ class UsersController < ApplicationController
       end
 
       failure(:invalid_user) do |error_data|
-        render_new(error_data, "Oops, fix your mistakes and try again")
+        render_form_errors(error_data, "Oops, fix your mistakes and try again")
       end
 
       failure(:user_save_failed) do |error_data|
-        render_new(error_data, "Sorry, something went wrong on our side.")
+        render_form_errors(error_data, "Sorry, something went wrong on our side.")
       end
 
       failure do |exception|
-        flash[:error] = "Something went terribly wrong"
+        flash[:error] = "something went terribly wrong"
         render 'new'
       end
     end
@@ -88,7 +84,7 @@ class UsersController < ApplicationController
 
   private
 
-  def render_new(user, error_message)
+  def render_form_errors(user, error_message)
     @user = user
     @error_message = error_message
     render 'new'

data/lib/solid_use_case.rb

@@ -2,9 +2,9 @@ require "deterministic"
 require "deterministic/core_ext/either"
 
 require "solid_use_case/version"
-require 'solid_use_case/command/util.rb'
-require 'solid_use_case/command/error_struct.rb'
-require 'solid_use_case/command.rb'
+require 'solid_use_case/base/util.rb'
+require 'solid_use_case/base/error_struct.rb'
+require 'solid_use_case/base.rb'
 
 module SolidUseCase
 end

data/lib/solid_use_case/base.rb

@@ -0,0 +1,48 @@
+module SolidUseCase
+  class Base
+    include Deterministic::CoreExt::Either
+    include BaseUtil
+
+    def self.run(input_hash={})
+      self.new.run(input_hash)
+    end
+
+    def self.steps(*args)
+      @__steps ||= []
+      @__steps += args
+    end
+
+    def run(inputs)
+      steps = self.class.instance_variable_get("@__steps").clone
+      result = Success(inputs)
+      return result unless steps
+
+      while steps.count > 0
+        next_step = steps.shift
+
+        if next_step.is_a?(Class) && (next_step < SolidUseCase::Base)
+          subresult = next_step.run(result.value)
+        elsif next_step.is_a?(Symbol)
+          subresult = self.send(next_step, result.value)
+        else
+          raise "Invalid step type: #{next_step.inspect}"
+        end
+
+        result = result.and(subresult)
+      end
+
+      result
+    end
+
+    # # # # # #
+    # Helpers #
+    # # # # # #
+
+    def fail(type, data={})
+      data[:type] = type
+      Failure(ErrorStruct.new(data))
+    end
+
+    alias :continue :Success
+  end
+end

data/lib/solid_use_case/{command → base}/util.rb

@@ -1,5 +1,5 @@
 module SolidUseCase
-  module CommandUtil
+  module BaseUtil
 
     def symbolize_names(object)
       case object

data/lib/solid_use_case/version.rb

@@ -1,3 +1,3 @@
 module SolidUseCase
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/solid_use_case.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.0'
 
-  spec.add_dependency "deterministic", '~> 0.2.0'
+  spec.add_dependency "deterministic", '~> 0.6.0'
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/spec/{command_spec.rb → base_spec.rb}

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe SolidUseCase::Command do
+describe SolidUseCase::Base do
 
   describe 'Stepping' do
-    class GiantSteps < SolidUseCase::Command
+    class GiantSteps < SolidUseCase::Base
       def run(inputs)
         attempt_all do
           step { step_1(inputs) }
@@ -13,12 +13,12 @@ describe SolidUseCase::Command do
 
       def step_1(inputs)
         inputs[:number] += 10
-        next_step(inputs)
+        continue(inputs)
       end
 
       def step_2(inputs)
         inputs[:number] *= 2
-        succeed(inputs)
+        continue(inputs)
       end
     end
 
@@ -30,8 +30,54 @@ describe SolidUseCase::Command do
   end
 
 
+  describe 'Stepping DSL' do
+    class GiantStepsDSL < SolidUseCase::Base
+
+      steps :step_1, :step_2
+
+      def step_1(inputs)
+        inputs[:number] += 10
+        continue(inputs)
+      end
+
+      def step_2(inputs)
+        inputs[:number] *= 2
+        continue(inputs)
+      end
+    end
+
+    it "pipes one step result to the next step" do
+      result = GiantStepsDSL.run(:number => 10)
+      expect(result).to be_a_success
+      expect(result.value[:number]).to eq(40)
+    end
+
+    it "can run multiple times" do
+      result = GiantStepsDSL.run(:number => 10)
+      result = GiantStepsDSL.run(:number => 10)
+      expect(result).to be_a_success
+      expect(result.value[:number]).to eq(40)
+    end
+
+    class SubStep < SolidUseCase::Base
+      steps GiantStepsDSL, :last_step
+
+      def last_step(inputs)
+        inputs[:number] += 1
+        continue(inputs[:number])
+      end
+    end
+
+    it "pipes one step result to the next step" do
+      result = SubStep.run(:number => 10)
+      expect(result).to be_a_success
+      expect(result.value).to eq(41)
+    end
+  end
+
+
   describe 'Failure Matching' do
-    class FailureMatch < SolidUseCase::Command
+    class FailureMatch < SolidUseCase::Base
       def run(inputs)
         attempt_all do
           step { fail_it(inputs) }

data/spec/rspec_matchers_spec.rb

@@ -3,19 +3,19 @@ require 'spec_helper'
 describe 'Custom RSpec Matchers' do
   include SolidUseCase::RSpecMatchers
 
-  class FailCase < SolidUseCase::Command
+  class FailCase < SolidUseCase::Base
     def run(error)
       fail(error)
     end
   end
 
-  class SuccessCase < SolidUseCase::Command
+  class SuccessCase < SolidUseCase::Base
     def run(val)
-      succeed(val)
+      continue(val)
     end
   end
 
-  class ExceptionCase < SolidUseCase::Command
+  class ExceptionCase < SolidUseCase::Base
     def run(val)
       attempt_all do
         try { raise_exception }

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: solid_use_case
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Gilbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2014-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deterministic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.6.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 2.14.1
 description: Create use cases the way they were meant to be. Easily verify inputs
@@ -74,20 +74,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
+- .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/solid_use_case.rb
-- lib/solid_use_case/command.rb
-- lib/solid_use_case/command/error_struct.rb
-- lib/solid_use_case/command/util.rb
+- lib/solid_use_case/base.rb
+- lib/solid_use_case/base/error_struct.rb
+- lib/solid_use_case/base/util.rb
 - lib/solid_use_case/rspec_matchers.rb
 - lib/solid_use_case/version.rb
 - solid_use_case.gemspec
-- spec/command_spec.rb
+- spec/base_spec.rb
 - spec/rspec_matchers_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mindeavor/solid_use_case
@@ -100,12 +100,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ~>
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -115,6 +115,7 @@ signing_key:
 specification_version: 4
 summary: A flexible UseCase pattern that works *with* your workflow, not against it.
 test_files:
-- spec/command_spec.rb
+- spec/base_spec.rb
 - spec/rspec_matchers_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/solid_use_case/command.rb

@@ -1,22 +0,0 @@
-module SolidUseCase
-  class Command
-    include Deterministic::CoreExt::Either
-    include CommandUtil
-
-    def self.run(input_hash={})
-      self.new.run(input_hash)
-    end
-
-    # # # # # #
-    # Helpers #
-    # # # # # #
-
-    def fail(type, data={})
-      data[:type] = type
-      Failure(ErrorStruct.new(data))
-    end
-
-    alias :next_step :Success
-    alias :succeed :Success
-  end
-end