rails_use_case 0.0.4 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9cd28e7a8c4f8f88597a7047a12e3b342a88256798572c55fbc8f30407af566
-  data.tar.gz: 4a2a7d0e5779aaabbf3a6a172b5f88a1cfd4faf4b6a58fab1b581c76f3d7012c
+  metadata.gz: 56f84c351e857b7fd1ac1963d18138f96608376c4952fe3a12e8e7db2dbc0152
+  data.tar.gz: 46de14ac109e227a1a36dfdbb7f75a4e0595652c3d0e59189788cbbe8ea1ccd3
 SHA512:
-  metadata.gz: 5135d55bdab90e5d8cf0c454d90712afe87726b575e49a81d9b477b204f01f05b1b7f2366542b101fa9a62742e4403e8a7846be1d6e77289ca0038bc27b60af0
-  data.tar.gz: c77c6b87d683be50c54e5a3c3235738e144addc3df07292954e4aca7a209ddf1bef017dfa1dc5bcb07b5bb35f2610e5d11162032aa35fa0d641717411247a58f
+  metadata.gz: 990f15747a27962ea59d7428416c8b525cf297e5e18f592fbaf3feeed8d4eecfe231bc7608acaa6516bc6273973ab651639a272c8b885f8b672fc4cb9b699ecf
+  data.tar.gz: '009f04d247c31452fec07815ff7be8c6af90ba3e5e03ef08f3ac4fd4b87cfcd4103cf44963ffc2a09f8791e8f9430327dd7db98f0d2e11d06feba3b646cbabd1'

data/README.md

@@ -1,6 +1,8 @@
 # Rails Use Case gem
 
-Opinionated gem for UseCases and Services in rails to keep models and controllers slim.
+Opinionated gem for UseCases and Services in Rails 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.
@@ -20,7 +22,7 @@ gem 'rails_use_case'
 
 The purpose of a UseCase is to contain reusable high level business logic which would normally be
 located in the controller. It defines a process via `step` definitions. A UseCase takes params
-and has a outcome, which is successfully or failed. It doesn't have a configuration file and doesn't
+and has a outcome, which is either successful or failed. It doesn't have a configuration file and doesn't
 log anything. Examples are: Place an item in the cart, create a new user or delete a comment.
 
 Steps are executed in the defined order. Only when a step succeeds (returns true) the next step will
@@ -83,6 +85,11 @@ puts result.inspect
 # }
 ```
 
+- You can check whether a UseCase was successful via `result.success?`.
+- You can access the value of `@record` via `result.record`.
+- You can stop the UseCase process with a error message via throwing `Rails::UseCase::Error` exception.
+
+
 
 ## Behavior
 
@@ -176,8 +183,9 @@ which is available via the `config` method.
 
 ### Logging
 
-The service los to a separate log file `log/services/[service_name].log`. You can write additional
-logs via `logger.info(msg)`.
+Each service automatically logs to a separate log file `log/services/[service_name].log`. You can write additional logs via `logger.info(msg)`.
+
+It's possible to force the services to log to STDOUT by setting the environment variable `SERVICE_LOGGER_STDOUT`. This is useful for Heroku for example.
 
 
 ## License

data/lib/rails/callable.rb

@@ -8,8 +8,8 @@ module Rails
     extend ActiveSupport::Concern
 
     class_methods do
-      def call(*args)
-        new.call(*args)
+      def call(...)
+        new.call(...)
       end
 
       alias_method :perform, :call

data/lib/rails/service.rb

@@ -50,9 +50,28 @@ module Rails
 
     # Create the log file and sets @logger
     private def setup_logger
-      log_path = Rails.root.join('log', 'services')
-      FileUtils.mkdir_p(log_path) unless Dir.exist?(log_path)
-      @logger = Logger.new(Rails.root.join('log', 'services', "#{@service_name}.log").to_s)
+      if ENV['SERVICE_LOGGER_STDOUT']
+        setup_stdout_logger
+      else
+        log_path = Rails.root.join('log', 'services')
+        FileUtils.mkdir_p(log_path) unless Dir.exist?(log_path)
+
+        log_file = log_path.join("#{@service_name}.log").to_s
+
+        FileUtils.touch log_file
+        @logger = Logger.new(log_file)
+      end
+    end
+
+
+    # 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.formatter = proc do |severity, datetime, progname, msg|
+        "[#{@service_name}] #{msg}"
+      end
     end
 
 
@@ -102,8 +121,8 @@ module Rails
 
 
     # Allows call syntax on class level: SomeService.(some, args)
-    def self.call(*args)
-      new.(*args)
+    def self.call(...)
+      new.(...)
     end
 
     # Allows to use rails view helpers

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rails_use_case
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.9
 platform: ruby
 authors:
 - Benjamin Klein
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-05 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.1.0
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -167,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
@@ -182,8 +210,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Rails UseCase and Service classes
 test_files: []