rails_use_case 0.0.11 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ede9e2243fddfc8ed59a395ca97b7f14062c4180e27d1f956f793a435559e90
-  data.tar.gz: 3f56c4fe1f24f74af0226aa5adacbb1341ac042e52b0caf767d61005c8d04b9a
+  metadata.gz: 0eb1a5ed5601e1c4e070962f4d19c2e35a4ea23980151fa35ec02c6328a2fd0d
+  data.tar.gz: 20821b8d657c535ee16ae2c920e1e93a8d0b21c384d99b25e5c986ff0914b0eb
 SHA512:
-  metadata.gz: e21f3ab1cc85466ec37bccfcc1dae363c478bb4d49a15bdcd5b1e093e5d63d270d5be3befccd66f41f0b81cd79015cdcf41f124f9321fa3d968f17300d7ba1a8
-  data.tar.gz: 34ec8bbeb3e95a0ffce45ef6945d859e71b3122b53c1a01b7d7ad122b9c2d884f681c67a47a355bd0905b4e19ca482defcd7ba572b2aaf209f29920911a53862
+  metadata.gz: 64c64c919a75d87bdea7a339fd9322c33b97a30b46bfa668a3eb970b3e542af9416176e5cc9783a0f133349648beb022983d66cafd30473f77708eb0de6a9963
+  data.tar.gz: 9f26874c317b868bd84c6232a2af3562bf54feddb4851552fbbccdc8294e38bdd2a89b420cdf387f623d1f5e361de9d24232a46b77d1dec13fb885a8bb1ab99d

data/README.md

@@ -1,11 +1,13 @@
 # Rails Use Case gem
 
-Opinionated gem for UseCases and Services in Rails to keep your Models and Controllers slim.
+This gem introduces UseCases and Services to Rails which allow you to keep your Models and Controllers slim.
 
 Read more: https://dev.to/phortx/pimp-your-rails-application-32d0
 
-The purpose of a UseCase is to contain reusable high level business logic which would normally be
-located in the controller. Examples are: Place an item in the cart, create a new user or delete a comment.
+Clean Architecture suggests to put the business logic in UseCases which are classes, that contain reusable high
+level business logic which otherwise would normally be located in the controller. UseCases are easy to read,
+clean, reusable, testable and extendable.
+Examples are: Place an item in the cart, create a new user or delete a comment.
 
 The purpose of a Service is to contain low level non-domain code like communication with a API,
 generating an export, upload via FTP or generating a PDF.
@@ -67,8 +69,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 +94,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 +169,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/service.rb

@@ -38,7 +38,7 @@ module Rails
     #
     # @raise [RuntimeError] When no service_name is given
     def initialize(service_name = nil)
-      raise NotImplementedError if self.class == Service
+      raise NotImplementedError if instance_of?(Service)
       raise 'Please provide a service name!' if service_name.nil?
 
       @service_name = service_name
@@ -67,7 +67,7 @@ module Rails
     # Will setup the logger for logging to STDOUT. This can be useful for
     # Heroku for example.
     private def setup_stdout_logger
-      @logger = Logger.new(STDOUT)
+      @logger = Logger.new($stdout)
 
       @logger.formatter = proc do |severity, datetime, progname, msg|
         "[#{@service_name}] #{msg}"

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)
@@ -82,7 +98,7 @@ module Rails
         fail!(code: opts[:code], message: opts[:message]) if name == :failure
 
         # Run the lambda, when :do is set. Otherwise call the method.
-        next if opts[:do] ? instance_eval(&opts[:do]) : send(name)
+        next if opts[:do] ? instance_exec(&opts[:do]) : send(name)
 
         # result is false, so we have a failure.
         fail! code: :step_false, message: "Step '#{name}' returned false"

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.13
 platform: ruby
 authors:
 - Benjamin Klein
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-05 00:00:00.000000000 Z
+date: 2022-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -195,7 +195,7 @@ homepage: https://github.com/phortx/rails-use-case
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -211,7 +211,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key:
+signing_key: 
 specification_version: 4
 summary: Rails UseCase and Service classes
 test_files: []