rails_use_case 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96f24873c4a93a2084c377f236b387605286fd7cbae9915fc53fd85d8f5b07c1
-  data.tar.gz: 7b2d97ab8d3ac97e3cbe5a9b78ec6f0e1590a8f7692bce3a9b207e5891d40577
+  metadata.gz: 7ede9e2243fddfc8ed59a395ca97b7f14062c4180e27d1f956f793a435559e90
+  data.tar.gz: 3f56c4fe1f24f74af0226aa5adacbb1341ac042e52b0caf767d61005c8d04b9a
 SHA512:
-  metadata.gz: dca166f3929ce6782995814218a95cd9d485f2c83ce4f7cd0282d0aa7e3fc83d58c79a65a70a407c8157883f8d6833c371dfc2b64948ba8c9f74aec368b6fe79
-  data.tar.gz: 03b6342cdbd9c244a07ffd034d9873fff5baaef554dd69a1da07f406f4e6dff27da095f1210a4914398b7bf1ba55c005586707c9b59c3e35b467857507a90eb6
+  metadata.gz: e21f3ab1cc85466ec37bccfcc1dae363c478bb4d49a15bdcd5b1e093e5d63d270d5be3befccd66f41f0b81cd79015cdcf41f124f9321fa3d968f17300d7ba1a8
+  data.tar.gz: 34ec8bbeb3e95a0ffce45ef6945d859e71b3122b53c1a01b7d7ad122b9c2d884f681c67a47a355bd0905b4e19ca482defcd7ba572b2aaf209f29920911a53862

data/README.md

@@ -74,7 +74,7 @@ save that record or raises an exception. Also the `@record` will automatically p
 ### Example UseCase
 
 ```ruby
-class CreateBlogPost < Rails::UseCase
+class BlogPosts::Create < Rails::UseCase
   attr_accessor :title, :content, :author, :skip_notifications, :publish
 
   validates :title, presence: true
@@ -107,10 +107,10 @@ end
 Example usage of that UseCase:
 
 ```ruby
-result = CreateBlogPost.perform(
+result = BlogPosts::Create.perform(
   title: 'Super Awesome Stuff!',
   content: 'Lorem Ipsum Dolor Sit Amet',
-  created_by: current_user,
+  author: current_user,
   skip_notifications: false
 )
 
@@ -130,6 +130,44 @@ puts result.inspect
 - You can stop the UseCase process with a error message via throwing `Rails::UseCase::Error` exception.
 
 
+### Working with the result
+
+The `perform` method of a UseCase returns an outcome object which contains a
+`code` field with the error code or `:success` otherwise. This comes handy when
+using in controller actions for example and is a great way to delegate the
+business logic part of a controller action to the respective UseCase.
+Everything the controller has to do, is to setup the params and dispatch the
+result.
+
+Given the Example above, here is the same call within a controller action with
+an case statement.
+
+```ruby
+class BlogPostsController < ApplicationController
+  # ...
+
+  def create
+    parameters = {
+      title: params[:post][:title],
+      content: params[:post][:content],
+      publish: params[:post][:publish],
+      author: current_user
+    }
+
+    case BlogPosts::Create.perform(parameters).code
+    when :success       then redirect_to(outcome.record)
+    when :access_denied then render(:new, flash: { error: "Access Denied!" })
+    when :foo           then redirect_to('/')
+    else                     render(:new, flash: { error: outcome.message })
+    end
+  end
+
+  # ...
+end
+```
+
+However this is not rails specific and can be used in any context.
+
 
 ## Behavior
 

data/lib/rails/use_case/outcome.rb

@@ -23,7 +23,7 @@ module Rails
         @record = record
         @exception = exception
         @message = message || exception&.message || errors&.full_messages
-        @code = code&.to_sym
+        @code = success ? :success : code&.to_sym
       end
       # rubocop:enable Metrics/ParameterLists
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_use_case
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Benjamin Klein
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-04 00:00:00.000000000 Z
+date: 2021-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel