rails_use_case 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ede9e2243fddfc8ed59a395ca97b7f14062c4180e27d1f956f793a435559e90
-  data.tar.gz: 3f56c4fe1f24f74af0226aa5adacbb1341ac042e52b0caf767d61005c8d04b9a
+  metadata.gz: c46cd0289d56e4cf86a62f9e1dd780b5fe311c9f7426dfdb942cab5a1b8b8b74
+  data.tar.gz: cd02462628e21a6fbda7bed59f237d0b1fdbf1a082d148747404ded5c2b0e365
 SHA512:
-  metadata.gz: e21f3ab1cc85466ec37bccfcc1dae363c478bb4d49a15bdcd5b1e093e5d63d270d5be3befccd66f41f0b81cd79015cdcf41f124f9321fa3d968f17300d7ba1a8
-  data.tar.gz: 34ec8bbeb3e95a0ffce45ef6945d859e71b3122b53c1a01b7d7ad122b9c2d884f681c67a47a355bd0905b4e19ca482defcd7ba572b2aaf209f29920911a53862
+  metadata.gz: 6bd525db88d52a6b9563fed40b80e69d9bc035f115fa77ae6a5668688df7576d5426e4f8caba222986e741b4fa61c9790b75751b582913b009217089998fd8ac
+  data.tar.gz: 2274ca1dfa0312c2bd9f1e2cc8245665bde540b30919c4eefe0875e3d0eba1a3609d2a55c4acac40849e8d237a20bd228ad6aabcaabac8f2c4c50f79cbd9e1bc

data/README.md

@@ -67,8 +67,19 @@ The error_code can also passed as first argument to the `failure` step definitio
 
 ### Record
 
-The UseCase should assign the main record to `@record`. Calling `save!` without argument will try to
-save that record or raises an exception. Also the `@record` will automatically passed into the outcome.
+The UseCase should assign the main record to `@record`. Calling `save!` without
+argument will try to save that record or raises an exception. Also the
+`@record` will automatically passed into the outcome.
+
+You can either set the `@record` manually or via the `record` method. This comes
+in two flavors:
+
+Either passing the name of a param as symbol. Let's assume the UseCase
+has a parameter called `user` (defined via `attr_accessor`), then you can assign
+the user to `@record` by adding `record :user` to your use case.
+
+The alternative way is to pass a block which returns the value for `@record`
+like in the example UseCase below.
 
 
 ### Example UseCase
@@ -81,16 +92,18 @@ class BlogPosts::Create < Rails::UseCase
   validates :content, presence: true
   validates :author, presence: true
 
+  record { BlogPost.new }
+
   failure :access_denied, message: 'No permission', unless: -> { author.can_publish_blog_posts? }
-  step    :build_post
+  step    :assign_attributes
   step    :save!
   succeed unless: -> { publish }
   step    :publish, do: -> { record.publish! }
   step    :notify_subscribers, unless: -> { skip_notifications }
 
 
-  private def build_post
-    @record = BlogPost.new(
+  private def assign_attributes
+    @record.assign_attributes(
       title: title,
       content: content,
       created_by: author,
@@ -154,7 +167,9 @@ class BlogPostsController < ApplicationController
       author: current_user
     }
 
-    case BlogPosts::Create.perform(parameters).code
+    outcome = BlogPosts::Create.perform(parameters).code
+
+    case outcome.code
     when :success       then redirect_to(outcome.record)
     when :access_denied then render(:new, flash: { error: "Access Denied!" })
     when :foo           then redirect_to('/')

data/lib/rails/use_case.rb

@@ -67,8 +67,24 @@ module Rails
     end
 
 
+    # DSL to set the record source.
+    # @param [Symbol|nil] Name of the param.
+    # @yields
+    def self.record(param = nil, &block)
+      block = -> { send(param.to_sym) } unless block_given?
+
+      define_method(:determine_record, &block)
+    end
+
+
     # Will run the steps of the use case.
     def process
+      @record = determine_record if respond_to?(:determine_record)
+      run_steps
+    end
+
+
+    def run_steps
       self.class.steps.each do |step|
         # Check wether to skip when :if or :unless are set.
         next if skip_step?(step)

metadata

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