solid_use_case 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e7056ae1ef3157772218479526874fa94e710f7
-  data.tar.gz: fd9a2327b8919bfd623d72e7fbe66ec6e0ced364
+  metadata.gz: bc18c2e9f16bf546cfc9d56f5337456213bbbe51
+  data.tar.gz: 1e7c6aa6fd01fdd35095d2fc0d3e066b28237361
 SHA512:
-  metadata.gz: 0dcee4954826b006d3c3bda5516536db3db27c1e1eca0c7731029daec17cd00a6122f8846f48237387e3fe45d81a81da2f8998a71b0fa9d3c287cea9c77d5a76
-  data.tar.gz: 24dab826516eab7bfe84842e89c3361ac06c039edfbbe0d82c226fd339ebbc843bc24a96878c431f59071a8d5637f1aab307fa3215cbc3447fb58fa23861516d
+  metadata.gz: 41793a7fef1201f2ab179b85f7d55b8e91df49ef9fcd180c4fc6b11fe1fff29e0dd2aa01910903653dce8b0ff607f11adc5e316aa8631184096fc88ff462a562
+  data.tar.gz: a4e35588c5d5def51e02dabb961b45ffb0dfe6450e19efdc11c7a24f793b47811a9dd203095f23aa280a5653248b3ffb5ef248d7c367931f7e358dbf104887a8

data/README.md

@@ -6,7 +6,7 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'solid_use_case', '~> 1.1.0'
+    gem 'solid_use_case', '~> 2.0.0'
 
 And then execute:
 
@@ -20,12 +20,13 @@ Or install it yourself as:
 
 At its core, this library is a light wrapper around [Deterministic](https://github.com/pzol/deterministic), a practical abstraction over the Either monad. Don't let that scare you - you don't have to understand monad theory to reap its benefits.
 
-The only required method is the `#run` method.
+The only thing required is using the `#steps` method:
 
 ### Rails Example
 
 ```ruby
-class UserSignup < SolidUseCase::Base
+class UserSignup
+  include SolidUseCase::Composable
 
   steps :validate, :save_user, :email_user
 
@@ -92,6 +93,45 @@ class UsersController < ApplicationController
 end
 ```
 
+## RSpec Matchers
+
+If you're using RSpec, Solid Use Case provides some helpful matchers for testing.
+
+First you mix them them into RSpec:
+
+```ruby
+# In your spec_helper.rb
+require 'solid_use_case'
+require 'solid_use_case/rspec_matchers'
+
+RSpec.configure do |config|
+  config.include(SolidUseCase::RSpecMatchers)
+end
+```
+
+And then you can use the matchers, with helpful error messages:
+
+```ruby
+describe MyApp::SignUp do
+  it "runs successfully" do
+    result = MyApp::SignUp.run(:username => 'alice', :password => '123123')
+    expect(result).to be_a_success
+  end
+
+  it "fails when password is too short" do
+    result = MyApp::SignUp.run(:username => 'alice', :password => '5')
+    expect(result).to fail_with(:invalid_password)
+
+    # The above `fail_with` line is equivalent to:
+    # expect(result.value).to be_a SolidUseCase::Composable::ErrorStruct
+    # expect(result.value.type).to eq :invalid_password
+
+    # You still have access to your arbitrary error data
+    expect(result.value.something).to eq 'whatever'
+  end
+end
+```
+
 ## Testing
 
     $ bundle exec rspec

data/lib/solid_use_case/composable/class_methods.rb

@@ -0,0 +1,20 @@
+module SolidUseCase
+  module Composable
+    module ClassMethods
+
+      def run(input_hash={})
+        self.new.run(input_hash)
+      end
+
+      def steps(*args)
+        @__steps ||= []
+        @__steps += args
+      end
+
+      def composable?
+        true
+      end
+
+    end
+  end
+end

data/lib/solid_use_case/composable/error_struct.rb

@@ -0,0 +1,9 @@
+module SolidUseCase
+  module Composable
+    class ErrorStruct < OpenStruct
+      def ==(error_type_symbol)
+        self[:type] == error_type_symbol
+      end
+    end
+  end
+end

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

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

data/lib/solid_use_case/{base.rb → composable.rb}

@@ -1,15 +1,9 @@
 module SolidUseCase
-  class Base
-    include Deterministic::CoreExt::Either
-    include BaseUtil
+  module Composable
 
-    def self.run(input_hash={})
-      self.new.run(input_hash)
-    end
-
-    def self.steps(*args)
-      @__steps ||= []
-      @__steps += args
+    def self.included(includer)
+      includer.send :include, Deterministic::CoreExt::Either
+      includer.extend ClassMethods
     end
 
     def run(inputs)
@@ -20,7 +14,7 @@ module SolidUseCase
       while steps.count > 0
         next_step = steps.shift
 
-        if next_step.is_a?(Class) && (next_step < SolidUseCase::Base)
+        if next_step.is_a?(Class) && (next_step.respond_to? :composable?) && next_step.composable?
           subresult = next_step.run(result.value)
         elsif next_step.is_a?(Symbol)
           subresult = self.send(next_step, result.value)

data/lib/solid_use_case/rspec_matchers.rb

@@ -17,7 +17,7 @@ module SolidUseCase
 
       def failure_message_for_should
         "expected result to be a success\n" +
-        if @result.value.is_a? SolidUseCase::ErrorStruct
+        if @result.value.is_a? SolidUseCase::Composable::ErrorStruct
           "Error & Data:\n    #{@result.value.type} - #{@result.value.inspect}"
         elsif @result.value.is_a? Exception
           backtrace = @result.value.backtrace.reject do |file|

data/lib/solid_use_case/version.rb

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

data/lib/solid_use_case.rb

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

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

@@ -1,9 +1,11 @@
 require 'spec_helper'
 
-describe SolidUseCase::Base do
+describe SolidUseCase::Composable do
 
   describe 'Stepping' do
-    class GiantSteps < SolidUseCase::Base
+    class GiantSteps
+      include SolidUseCase::Composable
+
       def run(inputs)
         attempt_all do
           step { step_1(inputs) }
@@ -31,7 +33,8 @@ describe SolidUseCase::Base do
 
 
   describe 'Stepping DSL' do
-    class GiantStepsDSL < SolidUseCase::Base
+    class GiantStepsDSL
+      include SolidUseCase::Composable
 
       steps :step_1, :step_2
 
@@ -59,7 +62,8 @@ describe SolidUseCase::Base do
       expect(result.value[:number]).to eq(40)
     end
 
-    class SubStep < SolidUseCase::Base
+    class SubStep
+      include SolidUseCase::Composable
       steps GiantStepsDSL, :last_step
 
       def last_step(inputs)
@@ -77,7 +81,9 @@ describe SolidUseCase::Base do
 
 
   describe 'Failure Matching' do
-    class FailureMatch < SolidUseCase::Base
+    class FailureMatch
+      include SolidUseCase::Composable
+
       def run(inputs)
         attempt_all do
           step { fail_it(inputs) }
@@ -95,7 +101,7 @@ describe SolidUseCase::Base do
       # Custom RSpec matcher
       expect(result).to_not be_a_success
 
-      expect(result.value).to be_a SolidUseCase::ErrorStruct
+      expect(result.value).to be_a SolidUseCase::Composable::ErrorStruct
       expect(result.value.type).to eq :abc
 
       matched = false

data/spec/rspec_matchers_spec.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: solid_use_case
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Gilbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2014-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deterministic
@@ -81,13 +81,14 @@ files:
 - README.md
 - Rakefile
 - lib/solid_use_case.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/composable.rb
+- lib/solid_use_case/composable/class_methods.rb
+- lib/solid_use_case/composable/error_struct.rb
+- lib/solid_use_case/composable/util.rb
 - lib/solid_use_case/rspec_matchers.rb
 - lib/solid_use_case/version.rb
 - solid_use_case.gemspec
-- spec/base_spec.rb
+- spec/composable_spec.rb
 - spec/rspec_matchers_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mindeavor/solid_use_case
@@ -115,7 +116,7 @@ signing_key:
 specification_version: 4
 summary: A flexible UseCase pattern that works *with* your workflow, not against it.
 test_files:
-- spec/base_spec.rb
+- spec/composable_spec.rb
 - spec/rspec_matchers_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/solid_use_case/base/error_struct.rb

@@ -1,7 +0,0 @@
-module SolidUseCase
-  class ErrorStruct < OpenStruct
-    def ==(error_type_symbol)
-      self[:type] == error_type_symbol
-    end
-  end
-end