solid_use_case 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ddf3a778dbf1eb61bc2f63319813267790aa806
-  data.tar.gz: 11b3e39668ca2ca7502255f90999eb2b8181753e
+  metadata.gz: 5810571bbc17faba88269dbdbe7f205d1e28d13b
+  data.tar.gz: 9576bcb516c93bd5e2f7b71ef1432746c3181f54
 SHA512:
-  metadata.gz: 9c6177ff65b30961fce7808ecce96401259926075f8d55340767efc6ff104180728e00365fce5044a24dbf4413b8ae08a8df65229e604e61366f98930c57d589
-  data.tar.gz: 77ff94dd60cb46f013ae170e92863c1c60f027d8dd74817676b644f6385863ac71039f7353c1e7c7cc799691b1bc273ad6838089823acea803a46b04d67def49
+  metadata.gz: 51fbf7ebc22c9ee27484bf6834e00cece81b165b233142d1fde1e7509fac6bddb4c1c050fdf173e59c77cd577d77452c5b6e8a0ecf0e41add6e32bc0bdb2afe5
+  data.tar.gz: adf744a459a4b8a70febc3bdcc7a0632751e0f0dfb25c895e38df316b8a1bef9bb37cf98bbb0a657846fa4bd6da07a3b7ee71dfdb39d32487af750003c10e306

data/README.md

@@ -6,7 +6,7 @@
 
 Add this line to your application's Gemfile:
 
-    gem 'solid_use_case', '~> 2.0.2'
+    gem 'solid_use_case', '~> 2.1.0'
 
 And then execute:
 
@@ -26,7 +26,7 @@ The only thing required is using the `#steps` method:
 
 ```ruby
 class UserSignup
-  include SolidUseCase::Composable
+  include SolidUseCase
 
   steps :validate, :save_user, :email_user
 
@@ -57,7 +57,7 @@ class UserSignup
 end
 ```
 
-Now you can run your use case in your controller and easily respond to the different outcomes (with **pattern matching**!):
+Now you can run your use case in your controller and easily respond to the different outcomes (with pattern matching!):
 
 ```ruby
 class UsersController < ApplicationController
@@ -95,6 +95,10 @@ end
 
 ## Control Flow Helpers
 
+Because we're using consistent successes and failures, we can use different functions to gain some nice control flow while avoiding those pesky if-else statements :)
+
+### #check_exists
+
 `check_exists` (alias `maybe_continue`) allows you to implicitly return a failure when a value is nil:
 
 ```ruby
@@ -118,6 +122,8 @@ find_tag(tag)
 end
 ```
 
+### #attempt
+
 `attempt` allows you to catch an exception. It's useful when you want to attempt something that might fail, but don't want to write all that exception-handling boilerplate.
 
 `attempt` also **auto-wraps your values**; in other words, the inner code does **not** have to return a success or failure.
@@ -164,7 +170,7 @@ describe MyApp::SignUp do
     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).to be_a SolidUseCase::Either::ErrorStruct
     # expect(result.value.type).to eq :invalid_password
 
     # You still have access to your arbitrary error data

data/lib/solid_use_case/{composable → either}/class_methods.rb

@@ -1,5 +1,5 @@
 module SolidUseCase
-  module Composable
+  module Either
     module ClassMethods
 
       def run(input_hash={})
@@ -11,7 +11,7 @@ module SolidUseCase
         @__steps += args
       end
 
-      def composable?
+      def can_run_either?
         true
       end
 

data/lib/solid_use_case/{composable → either}/error_struct.rb

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

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

@@ -1,10 +1,5 @@
 module SolidUseCase
-  module Composable
-
-    def self.included(includer)
-      includer.send :include, Deterministic::CoreExt::Either
-      includer.extend ClassMethods
-    end
+  module Either
 
     def run(inputs)
       steps = self.class.instance_variable_get("@__steps").clone
@@ -14,7 +9,7 @@ module SolidUseCase
       while steps.count > 0
         next_step = steps.shift
 
-        if next_step.is_a?(Class) && (next_step.respond_to? :composable?) && next_step.composable?
+        if next_step.is_a?(Class) && (next_step.respond_to? :can_run_either?) && next_step.can_run_either?
           subresult = next_step.run(result.value)
         elsif next_step.is_a?(Symbol)
           subresult = self.send(next_step, result.value)
@@ -46,6 +41,16 @@ module SolidUseCase
       end
     end
 
+    def catch(required, *exceptions)
+      exceptions << required
+      result = attempt_all do
+        try { yield }
+      end
+      if result.is_a?(Failure) && exceptions.any?
+        raise result.value unless exceptions.include?(result.value)
+      end
+    end
+
     def fail(type, data={})
       data[:type] = type
       Failure(ErrorStruct.new(data))

data/lib/solid_use_case/rspec_matchers.rb

@@ -17,7 +17,7 @@ module SolidUseCase
 
       def failure_message
         "expected result to be a success\n" +
-        if @result.value.is_a? SolidUseCase::Composable::ErrorStruct
+        if @result.value.is_a? SolidUseCase::Either::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 = "2.0.2"
+  VERSION = "2.1.0"
 end

data/lib/solid_use_case.rb

@@ -2,12 +2,17 @@ require "deterministic"
 require "deterministic/core_ext/either"
 
 require "solid_use_case/version"
-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'
+require 'solid_use_case/either/class_methods.rb'
+require 'solid_use_case/either/error_struct.rb'
+require 'solid_use_case/either/util.rb'
+require 'solid_use_case/either.rb'
 
 module SolidUseCase
+  def self.included(includer)
+    includer.send :include, Deterministic::CoreExt::Either
+    includer.send :include, Either
+    includer.extend Either::ClassMethods
+  end
 end
 
 class Deterministic::Either

data/spec/control_flow_spec.rb

@@ -4,7 +4,7 @@ describe "Control Flow Helpers" do
 
   describe '#check_exists' do
     class FloodGate
-      include SolidUseCase::Composable
+      include SolidUseCase
 
       def basic(input)
         check_exists(input).and_then {|x| Success(x * 2) }
@@ -44,7 +44,7 @@ describe "Control Flow Helpers" do
 
   describe '#attempt' do
     class Bubble
-      include SolidUseCase::Composable
+      include SolidUseCase
 
       def pop1
         attempt { "pop!" }

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

@@ -1,10 +1,10 @@
 require 'spec_helper'
 
-describe SolidUseCase::Composable do
+describe SolidUseCase::Either do
 
   describe 'Stepping' do
     class GiantSteps
-      include SolidUseCase::Composable
+      include SolidUseCase
 
       def run(inputs)
         attempt_all do
@@ -34,7 +34,7 @@ describe SolidUseCase::Composable do
 
   describe 'Stepping DSL' do
     class GiantStepsDSL
-      include SolidUseCase::Composable
+      include SolidUseCase
 
       steps :step_1, :step_2
 
@@ -63,7 +63,7 @@ describe SolidUseCase::Composable do
     end
 
     class SubStep
-      include SolidUseCase::Composable
+      include SolidUseCase
       steps GiantStepsDSL, :last_step
 
       def last_step(inputs)
@@ -82,7 +82,7 @@ describe SolidUseCase::Composable do
 
   describe 'Failure Matching' do
     class FailureMatch
-      include SolidUseCase::Composable
+      include SolidUseCase
 
       def run(inputs)
         attempt_all do
@@ -101,7 +101,7 @@ describe SolidUseCase::Composable do
       # Custom RSpec matcher
       expect(result).to_not be_a_success
 
-      expect(result.value).to be_a SolidUseCase::Composable::ErrorStruct
+      expect(result.value).to be_a SolidUseCase::Either::ErrorStruct
       expect(result.value.type).to eq :abc
 
       matched = false

data/spec/rspec_matchers_spec.rb

@@ -4,21 +4,21 @@ describe 'Custom RSpec Matchers' do
   include SolidUseCase::RSpecMatchers
 
   class FailCase
-    include SolidUseCase::Composable
+    include SolidUseCase
     def run(error)
       fail(error)
     end
   end
 
   class SuccessCase
-    include SolidUseCase::Composable
+    include SolidUseCase
     def run(val)
       continue(val)
     end
   end
 
   class ExceptionCase
-    include SolidUseCase::Composable
+    include SolidUseCase
     def run(val)
       attempt_all do
         try { raise_exception }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: solid_use_case
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Gilbert
@@ -81,15 +81,15 @@ files:
 - README.md
 - Rakefile
 - lib/solid_use_case.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/either.rb
+- lib/solid_use_case/either/class_methods.rb
+- lib/solid_use_case/either/error_struct.rb
+- lib/solid_use_case/either/util.rb
 - lib/solid_use_case/rspec_matchers.rb
 - lib/solid_use_case/version.rb
 - solid_use_case.gemspec
-- spec/composable_spec.rb
 - spec/control_flow_spec.rb
+- spec/either_spec.rb
 - spec/rspec_matchers_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/mindeavor/solid_use_case
@@ -117,8 +117,8 @@ signing_key:
 specification_version: 4
 summary: A flexible UseCase pattern that works *with* your workflow, not against it.
 test_files:
-- spec/composable_spec.rb
 - spec/control_flow_spec.rb
+- spec/either_spec.rb
 - spec/rspec_matchers_spec.rb
 - spec/spec_helper.rb
 has_rdoc: