light-services 2.0.0.rc6 → 2.0.0.rc8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06c568f730742de7555fcdccd76689a7ae983dbc97880935b2587439f1707d29
-  data.tar.gz: 48ad82deadfae1e28300aea79fdb6b220f3c2a29e4e082419cb43743aebfda15
+  metadata.gz: 033745e056484b3cb06dd7047bde7aa8f57d3e7a831f5f9eb2495aec0f9f96e9
+  data.tar.gz: 6927b650f82197c0ee0403487f18f71015096d244785ae947d0b8ea4dd56373f
 SHA512:
-  metadata.gz: e55a6a1b112d794368d08c4c487734613e24d8fbf1ec5d9b097f0cba22148f37325053db5568a9715ab0d1c8ba3abb22b5762657e5b838048fe6e4c11a6cb6ec
-  data.tar.gz: 84ffbca0ddfade25831c0b2c7597455200a98149e6a2e102923ec9298faa4d0486a97c5b06d2d2e0a974cb47a43feb84bc4748ee3bda3aec5731b5ff132bd089
+  metadata.gz: c87c5af17cccc1cce0514a65dd8f87b84d21599fcafec91ea92fa9f5d068842bfb01f0055b98c62340809a47e4eb3721a974b5958c7cd6b6410249251cf4cdca
+  data.tar.gz: a48e79125c81939dd5967ea08e6fcafcb6474f9a13edbc07f1e1d4ec69fc83b23e2bc43a660bf978d999d4b97a57c4f543f5f14b65219c555f2266ce3d06b51f

data/Gemfile

@@ -9,12 +9,12 @@ group :test do
   gem "database_cleaner-active_record", "~> 1.8"
   gem "sqlite3", "~> 1.4"
 
-  gem "codecov", "~> 0.1.17"
+  gem "codecov", "~> 0.6.0"
   gem "rake", "~> 13.0"
-  gem "rspec", "~> 3.9"
-  gem "simplecov", "~> 0.18"
+  gem "rspec", "~> 3.11"
+  gem "simplecov", "~> 0.21"
 
-  gem "rubocop", "~> 0.86",            require: false
-  gem "rubocop-performance", "~> 1.6", require: false
-  gem "rubocop-rspec", "~> 1.40",      require: false
+  gem "rubocop", "~> 1.27",             require: false
+  gem "rubocop-performance", "~> 1.13", require: false
+  gem "rubocop-rspec", "~> 2.9",        require: false
 end

data/Gemfile.lock

@@ -1,101 +1,98 @@
 PATH
   remote: .
   specs:
-    light-services (2.0.0.rc5)
+    light-services (2.0.0.rc8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.4)
-      activesupport (= 6.1.4)
-    activerecord (6.1.4)
-      activemodel (= 6.1.4)
-      activesupport (= 6.1.4)
-    activesupport (6.1.4)
+    activemodel (6.1.5)
+      activesupport (= 6.1.5)
+    activerecord (6.1.5)
+      activemodel (= 6.1.5)
+      activesupport (= 6.1.5)
+    activesupport (6.1.5)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
     ast (2.4.2)
-    codecov (0.1.21)
-      json
-      simplecov
-    concurrent-ruby (1.1.9)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    concurrent-ruby (1.1.10)
     database_cleaner (1.99.0)
     database_cleaner-active_record (1.99.0)
       activerecord
       database_cleaner (~> 1.99.0)
-    diff-lcs (1.4.4)
+    diff-lcs (1.5.0)
     docile (1.4.0)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    json (2.5.1)
-    minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.2.0)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.3.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (0.93.1)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.27.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.6.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.8.0)
-      parser (>= 3.0.1.1)
-    rubocop-performance (1.10.2)
-      rubocop (>= 0.90.0, < 2.0)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.13.3)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rspec (1.44.1)
-      rubocop (~> 0.87)
-      rubocop-ast (>= 0.7.1)
+    rubocop-rspec (2.9.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
+    simplecov_json_formatter (0.1.4)
     sqlite3 (1.4.2)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.4.2)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   activerecord (~> 6.0)
-  codecov (~> 0.1.17)
+  codecov (~> 0.6.0)
   database_cleaner-active_record (~> 1.8)
   light-services!
   rake (~> 13.0)
-  rspec (~> 3.9)
-  rubocop (~> 0.86)
-  rubocop-performance (~> 1.6)
-  rubocop-rspec (~> 1.40)
-  simplecov (~> 0.18)
+  rspec (~> 3.11)
+  rubocop (~> 1.27)
+  rubocop-performance (~> 1.13)
+  rubocop-rspec (~> 2.9)
+  simplecov (~> 0.21)
   sqlite3 (~> 1.4)
 
 BUNDLED WITH

data/README.md

@@ -1,4 +1,328 @@
-# Light Services
-![CI](https://github.com/light-ruby/light-services/workflows/CI/badge.svg)
-[![Codecov](https://codecov.io/gh/light-ruby/light-services/branch/master/graph/badge.svg)](https://codecov.io/gh/light-ruby/light-services)
+# 🚀 Light Services <sup>BETA</sup>
 
+Implementation of Service Object pattern for Ruby/Rails applications.
+
+## 👀 Table of Contents
+1. [Simple Example](#simple-example)
+2. [Usage](#usage)
+   1. [Arguments](#arguments)
+   2. [Steps](#steps)
+   3. [Outputs](#outputs)
+   4. [Context](#context)
+3. [Complex Example](#complex-example)
+4. [More Examples](#more-examples)
+
+## 💪 Features
+
+1. Ability to define `arguments`, `steps` and `outputs`
+2. Isolated behaviour of each service object
+3. Raising of errors to stop processing next steps
+4. Wrapping actions into database transactions
+5. Ability to pass context to child service object
+6. Framework agnostic
+7. 100% test coverage
+
+## ❌ Problems
+
+As this gem was just for internal usage, it has some problems:
+
+1. Gem isn't documented well
+2. Code doesn't have any comments
+3. Repo doesn't have any CI/CD
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'light-services', '~> 2.0.0.rc7' 
+```
+
+## Simple Example
+
+### Send notification
+
+Let's create an elementary service object that sends a notification to the user. 
+
+```ruby
+class User::SendNotification < ApplicationService
+  # Arguments
+  arg :user, type: User
+  arg :text, type: :string
+
+  # Steps
+  step :validate_user
+  step :validate_text
+  step :send_notification
+  
+  # Outputs
+  output :response
+
+  private
+
+  def validate_user
+    return if user.active?
+    
+    errors.add(:user, "isn't active")
+  end
+
+  def validate_text
+    return if text.present?
+
+    errors.add(:text, "must be present")
+  end
+
+  def send_notification
+    self.response = ExternalAPI.send_message(...)
+  rescue ExternalAPI::Error
+    errors.add(:base, "External API doesn't work")
+  end
+end
+```
+
+## Usage
+
+### Arguments
+
+You may send some arguments into the service object.
+
+**How to define arguments:**
+```ruby
+class User::SendNotification < ApplicationService
+  # Required argument
+  arg :user, type: User
+  
+  # Optional argument
+  arg :device, type: Device, optional: true
+  
+  # Argument with default value
+  arg :text, type: :string, default: "Hello, how are you?"
+  
+  # Argument with multiple allowed types
+  arg :retry, type: [TrueClass, FalseClass], default: false
+  
+  # Argument which will be automatically passed into child components
+  arg :provider, type: Provider, context: true
+end
+```
+
+**How to pass arguments in controller:**
+```ruby
+class UsersController
+  def send_notification
+    service = User::SendNotification.run(user: User.first, provider: Provider.first)
+    # ...
+  end
+end
+```
+
+**How to pass arguments and context from parent to child service object:**
+```ruby
+class User::Update
+  # Arguments
+  arg :user, type: User, context: true
+
+  # Steps
+  # ...
+  step :send_notification
+
+  private
+
+  # ...
+
+  def send_notification
+    User::SendNotification
+      .with(self) # This line specifies the current service object as a parent and passes all context arguments into a child service object
+      .run(text: "Your profile was updated") # We don't need to pass `user` here as it's a context argument
+  end
+end
+```
+
+### Steps
+
+Steps are a bit more powerful than you think.
+
+```ruby
+class User::Charge
+  # Run step only when condition meets
+  step :create_payment_account, unless: :payment_account?
+  
+  # Run step only when condition meets
+  step :charge_credit_card, if: :pay_with_credit_card?
+  
+  # Run step after other step
+  step :update_payment_account, after: :create_payment_account
+  
+  # Or before
+  step :save_information, before: :log_action
+end
+```
+
+### Outputs
+
+Outputs are pretty straightforward.
+
+```ruby
+class User::Charge
+  # Simple output
+  output :payment
+  
+  # Output with initial value
+  output :items, default: []
+end
+```
+
+### Context
+
+The context specifies the relationship between parent and child service objects.
+
+What context does:
+1. It tells the parent service object to pass context arguments into a child service object
+2. When the child service object fails, it tells the parent service object to fail too (customizable)
+
+```ruby
+class User::Charge
+  # Arguments
+  arg :user, type: User, context: true
+  arg :cents, type: Integer
+  
+  # ...
+  
+  private
+  
+  # ...
+  
+  def send_notification
+    # Run service object w/o any context
+    User::SendNotification
+      .run(user: user, text: "...")
+  
+    # Run service object and specify current one as a parent
+    User::SendNotification
+      .with(self)
+      .run(text: "...")
+      
+    # Run service object with context but don't load errors from the child service object
+    service = User::SendNotification
+      .with(self, load_errors: false)
+      .run(text: "...")
+      
+    if service.failed?
+      # That's ok. Process it somehow...
+    end
+  end
+end
+```
+
+## Complex Example
+
+### Creation of records
+
+Let's investigate a more exciting example where we create a wrapper to create database records.
+
+**Here is an example of controller (pretty thin, yeah? but we can make it even thinner):**
+```ruby
+class ContactsController < ApplicationController
+  # ...
+
+  def create
+    service = Contact::Create.run(service_args)
+    
+    if service.success?
+      render locals: { contact: service.contact }, status: :ok
+    else
+      render "shared/errors", locals: { service: service }, status: :bad_request
+    end
+  end
+
+  # ...
+end
+```
+
+**Then, let's create a service object (no way, it couldn't be so simple):**
+```ruby
+class Contact::Create < CreateService
+  # We create alias just for a better readability
+  # so that we can call `service.contact` instead of `service.record`  
+  alias contact record
+  
+  private
+  
+  def filtered_params
+    params.require(:contact).permit(:name, :phone)
+  end
+end
+```
+
+**Let's check what logic we put into `CreateService`:**
+```ruby
+class CreateService < ApplicationService
+  # Arguments
+  arg :attributes, type: Hash, optional: true
+
+  # Outputs
+  output :record
+
+  # Steps
+  step :initialize_record
+  step :assign_attributes
+  step :authorize
+  step :validate
+  step :save_record
+
+  private
+
+  def initialize_record
+    self.record = self.class.module_parent.new
+  end
+
+  def assign_attributes
+    record.assign_attributes(filtered_params)
+  end
+
+  def authorize
+    return if force || attributes
+
+    # Here is some Pundit logic 👇
+    authorize!(record, with_action: :create?)
+  end
+
+  def validate
+    return if record.valid?
+
+    errors.copy_from(record)
+  end
+
+  def save_record
+    record.save_with!(self)
+  end
+
+  def filtered_params
+    raise NotImplementedError
+  end
+end
+```
+
+**Now we can easily reuse all this code and create as many services as we want:**
+```ruby
+class Team::Create < CreateService
+  alias team record
+  
+  private
+  
+  def filtered_params
+    params.require(:team).permit(:name)
+  end
+end
+```
+
+## More examples
+
+You can find more examples here:
+[https://github.com/light-ruby/light-services/tree/v2/spec/data/services](https://github.com/light-ruby/light-services/tree/v2/spec/data/services)
+
+# Happy coding!
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/light/services/base.rb

@@ -28,14 +28,10 @@ module Light
       mount_class_based_collection :arguments, item_class: Settings::Argument, shortcut: :arg, allow_redefine: true
 
       # Arguments
-      # TODO: Rename internal arguments
+      arg :verbose, default: false
       arg :benchmark, default: false
       arg :deepness, default: 0, context: true
 
-      # Steps
-      step :load_defaults_and_validate
-      step :log_header, if: :benchmark?
-
       # Getters
       attr_reader :outputs, :arguments, :errors, :warnings
 
@@ -78,6 +74,9 @@ module Light
       end
 
       def call
+        load_defaults_and_validate
+        log_header if benchmark? || verbose?
+
         time = Benchmark.ms do
           run_steps
           run_steps_with_always
@@ -103,7 +102,7 @@ module Light
 
         def with(service_or_config = {}, config = {})
           service = service_or_config.is_a?(Hash) ? nil : service_or_config
-          config = service ? config : service_or_config
+          config = service_or_config unless service
 
           BaseWithContext.new(self, service, config)
         end
@@ -181,9 +180,9 @@ module Light
         log "🏎 Run service #{self.class}"
       end
 
-      def within_transaction
+      def within_transaction(&block)
         if @config[:use_transactions] && defined?(ActiveRecord::Base)
-          ActiveRecord::Base.transaction(requires_new: true) { yield }
+          ActiveRecord::Base.transaction(requires_new: true, &block)
         else
           yield
         end

data/lib/light/services/collection/base.rb

@@ -40,7 +40,11 @@ module Light
           settings_collection.each do |name, settings|
             next if !settings.default_exists || key?(name)
 
-            set(name, deep_dup(settings.default))
+            if settings.default.is_a?(Proc)
+              set(name, settings.default.call)
+            else
+              set(name, deep_dup(settings.default))
+            end
           end
         end
 

data/lib/light/services/messages.rb

@@ -10,12 +10,12 @@ module Light
         @messages = {}
       end
 
-      def add(key, text, opts = {})
-        raise Light::Services::Error, "Error text can't be blank" if !text || text.blank?
+      def add(key, texts, opts = {})
+        raise Light::Services::Error, "Error text can't be blank" if !texts || texts.blank?
 
         message = nil
 
-        [*text].each do |text|
+        [*texts].each do |text|
           message = text.is_a?(Message) ? text : Message.new(key, text, opts)
 
           @messages[key] ||= []
@@ -48,7 +48,7 @@ module Light
       end
 
       def copy_to(entity)
-        if defined?(ActiveRecord::Base) && entity.is_a?(ActiveRecord::Base) || entity.is_a?(Light::Services::Base)
+        if (defined?(ActiveRecord::Base) && entity.is_a?(ActiveRecord::Base)) || entity.is_a?(Light::Services::Base)
           each do |key, messages|
             messages.each do |message|
               entity.errors.add(key, message.to_s)
@@ -67,7 +67,7 @@ module Light
       end
 
       def to_h
-        @messages.to_h.map { |key, value| [key, value.map(&:to_s)] }.to_h
+        @messages.to_h.transform_values { |value| value.map(&:to_s) }
       end
 
       def method_missing(method, *args, &block)

data/lib/light/services/settings/argument.rb

@@ -25,9 +25,10 @@ module Light
 
         def valid_type?(value)
           return if !@type || [*@type].any? do |type|
-            if type == :boolean
+            case type
+            when :boolean
               value.is_a?(TrueClass) || value.is_a?(FalseClass)
-            elsif type.is_a?(Symbol)
+            when Symbol
               arg_type(value) == type
             else
               value.is_a?(type)
@@ -45,9 +46,9 @@ module Light
 
           @arg_types_cache[klass] ||= klass
             .name
-            .gsub(/::/, '/')
-            .gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2')
-            .gsub(/([a-z\d])([A-Z])/,'\1_\2')
+            .gsub(/::/, "/")
+            .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+            .gsub(/([a-z\d])([A-Z])/, '\1_\2')
             .tr("-", "_")
             .downcase
             .to_sym

data/lib/light/services/version.rb

@@ -2,6 +2,6 @@
 
 module Light
   module Services
-    VERSION = "2.0.0.rc6"
+    VERSION = "2.0.0.rc8"
   end
 end

data/light-services.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: light-services
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc6
+  version: 2.0.0.rc8
 platform: ruby
 authors:
 - Andrew Emelianenko
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-20 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies: []
 description: Powerful implementation of Service Object pattern for Ruby and Rails
 email:
@@ -56,6 +56,7 @@ metadata:
   homepage_uri: https://github.com/light-ruby/light-services
   source_code_uri: https://github.com/light-ruby/light-services
   changelog_uri: https://github.com/light-ruby/light-services/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -71,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Powerful implementation of Service Object pattern for Ruby and Rails