servactory 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd3981fb61af74a47cc5d5279a51796d78527c2b4b16c3bdb69f7bd94e32932f
-  data.tar.gz: ca8ad9beca25c5dd04a9f7bb584ced4cef6b3f35d6d14c68c0d297ef817b8025
+  metadata.gz: 77500bca8d6ee7ee302e77b8b64eb840a2e004bece8743a2b246e49a49a42b24
+  data.tar.gz: dfff784e9b2787ac349d5e33f84f75a318814ecf64ac0df7915a500b2073f6ef
 SHA512:
-  metadata.gz: e95bffde026a1b55bca088e15d86c2ec2b78ff4838be5f683c574e9ea1ed148a993a3075c4fb7b72493d3667b7280b4fe177edd748262bd77193425571aabb96
-  data.tar.gz: c41af274f2c6c858f29cef27f7b9d0b61ebf106712f9a55ca739782f2bbb2e12758c51a4271901505fdd81028ec435b52308244a2d581ee8c82841b768169b7f
+  metadata.gz: 16091e0330a74cda1246f0a3a4ccdbc9ed572cba9c29d485e306c95c2405792e12bd9d03cbf13e1e17cf0c40bd4839ea997d75eac7f5f26a199eb8bc757af01a
+  data.tar.gz: 2d67bd5beff3c5a4d73a28a70662b3df52e61757fadc37f15751e745e28f9a3b18cd3af43d84684339debd58b6231ca70bdcbcc8b2af8c20ef76f9eb9e68c883

data/README.md

@@ -5,439 +5,14 @@ A set of tools for building reliable services of any complexity.
 [![Gem version](https://img.shields.io/gem/v/servactory?logo=rubygems&logoColor=fff)](https://rubygems.org/gems/servactory)
 [![Release Date](https://img.shields.io/github/release-date/afuno/servactory)](https://github.com/afuno/servactory/releases)
 
-## Table of contents
+## Documentation
 
-- [Requirements](#requirements)
-- [Getting started](#getting-started)
-  - [Conventions](#conventions)
-  - [Installation](#installation)
-  - [Preparation](#preparation)
-- [Usage](#usage)
-  - [Minimal example](#minimal-example)
-  - [Call](#call)
-  - [Result](#result)
-  - [Input](#input)
-    - [Type](#option-type)
-    - [Required](#option-required)
-    - [Internal](#option-internal)
-    - [Internal name](#option-as)
-    - [Array](#option-array)
-    - [Inclusion](#option-inclusion)
-    - [Must](#option-must)
-  - [Output](#output)
-  - [Internal](#internal)
-  - [Make](#make)
-  - [Failures](#failures)
-  - [Inheritance](#inheritance)
-- [I18n](#i18n)
-- [Testing](#testing)
-- [Thanks](#thanks)
-- [Contributing](#contributing)
+See [servactory.com](https://servactory.com) for documentation.
 
-## Requirements
-
-- Ruby >= 2.7
-
-## Getting started
-
-### Conventions
-
-- Services are subclasses of `Servactory::Base` and are located in the `app/services` directory. It is common practice to create and inherit from `ApplicationService::Base`, which is a subclass of `Servactory::Base`.
-- Name services by what they do, not by what they accept. Try to use verbs in names. For example, `UsersService::Create` instead of `UsersService::Creation`.
-
-### Installation
-
-Add this to `Gemfile`:
-
-```ruby
-gem "servactory"
-```
-
-And execute:
-
-```shell
-bundle install
-```
-
-### Preparation
-
-As a first step, it is recommended to prepare the base class for further inheritance.
-
-#### ApplicationService::Errors
-
-```ruby
-# app/services/application_service/errors.rb
-
-module ApplicationService
-  module Errors
-    class InputError < Servactory::Errors::InputError; end
-    class OutputError < Servactory::Errors::OutputError; end
-    class InternalError < Servactory::Errors::InternalError; end
-
-    class Failure < Servactory::Errors::Failure; end
-  end
-end
-```
-
-#### ApplicationService::Base
-
-```ruby
-# app/services/application_service/base.rb
-
-module ApplicationService
-  class Base < Servactory::Base
-    configuration do
-      input_error_class ApplicationService::Errors::InputError
-      output_error_class ApplicationService::Errors::OutputError
-      internal_error_class ApplicationService::Errors::InternalError
-
-      failure_class ApplicationService::Errors::Failure
-    end
-  end
-end
-```
-
-## Usage
-
-### Minimal example
-
-```ruby
-class MinimalService < ApplicationService::Base
-  make :call
-  
-  private
-  
-  def call
-    # ...
-  end
-end
-```
-
-[More examples](https://github.com/afuno/servactory/tree/main/examples/usual)
-
-### Call
-
-Services can only be called via `.call` and `.call!` methods.
-
-The `.call` method will only fail if it catches an exception in the input arguments.
-Internal and output attributes, as well as methods for failures - all this will be collected in the result.
-
-The `.call!` method will fail if it catches any exception.
-
-#### Via .call
-
-```ruby
-UsersService::Accept.call(user: User.first)
-```
-
-#### Via .call!
-
-```ruby
-UsersService::Accept.call!(user: User.first)
-```
-
-### Result
-
-All services have the result of their work. For example, in case of success this call:
-
-```ruby
-service_result = UsersService::Accept.call!(user: User.first)
-```
-
-Will return this:
-
-```ruby
-#<Servactory::Result:0x0000000107ad9e88 @user="...">
-```
-
-And then you can work with this result, for example, in this way:
-
-```ruby
-Notification::SendJob.perform_later(service_result.user.id)
-```
-
-### Input
-
-#### Option `type`
-
-Always required to specify. May contain one or more classes.
-
-```ruby
-class UsersService::Accept < ApplicationService::Base
-  input :user, type: User
-
-  # ...
-end
-```
-
-```ruby
-class ToggleService < ApplicationService::Base
-  input :flag, type: [TrueClass, FalseClass]
-
-  # ...
-end
-```
-
-#### Option `required`
-
-By default, `required` is set to `true`.
-
-```ruby
-class UsersService::Create < ApplicationService::Base
-  input :first_name, type: String
-  input :middle_name, type: String, required: false
-  input :last_name, type: String
-
-  # ...
-end
-```
-
-#### Option `internal`
-
-By default, `internal` is set to `false`.
-
-```ruby
-class UsersService::Accept < ApplicationService::Base
-  input :user, type: User
-
-  make :accept!
-  
-  private
-  
-  def accept!
-    inputs.user.accept!
-  end
-end
-```
-
-```ruby
-class UsersService::Accept < ApplicationService::Base
-  input :user, type: User, internal: true
-
-  make :accept!
-  
-  private
-  
-  def accept!
-    user.accept!
-  end
-end
-```
-
-#### Option `as`
-
-This option changes the name of the input within the service.
-
-```ruby
-class NotificationService::Create < ApplicationService::Base
-  input :customer, as: :user, type: User
-
-  output :notification, type: Notification
-
-  make :create_notification!
-
-  private
-
-  def create_notification!
-    self.notification = Notification.create!(user: inputs.user)
-  end
-end
-```
-
-#### Option `array`
-
-Using this option will mean that the input argument is an array, each element of which has the specified type.
-
-```ruby
-class PymentsService::Send < ApplicationService::Base
-  input :invoice_numbers, type: String, array: true
-
-  # ...
-end
-```
-
-#### Option `inclusion`
-
-```ruby
-class EventService::Send < ApplicationService::Base
-  input :event_name, type: String, inclusion: %w[created rejected approved]
-
-  # ...
-end
-```
-
-#### Option `must`
-
-Sometimes there are cases that require the implementation of a specific input attribute check. In such cases `must` can help.
-
-```ruby
-class PymentsService::Send < ApplicationService::Base
-  input :invoice_numbers,
-        type: String,
-        array: true,
-        must: {
-          be_6_characters: {
-            is: ->(value:) { value.all? { |id| id.size == 6 } }
-          }
-        }
-
-  # ...
-end
-```
-
-### Output
-
-```ruby
-class NotificationService::Create < ApplicationService::Base
-  input :user, type: User
-  
-  output :notification, type: Notification
-
-  make :create_notification!
-  
-  private
-  
-  def create_notification!
-    self.notification = Notification.create!(user: inputs.user)
-  end
-end
-```
-
-### Internal
-
-```ruby
-class NotificationService::Create < ApplicationService::Base
-  input :user, type: User
-
-  internal :inviter, type: User
-  
-  output :notification, type: Notification
-
-  make :assign_inviter
-  make :create_notification!
-  
-  private
-  
-  def assign_inviter
-    self.inviter = user.inviter
-  end
-  
-  def create_notification!
-    self.notification = Notification.create!(user: inputs.user, inviter:)
-  end
-end
-```
-
-### Make
-
-#### Minimal example
-
-```ruby
-make :something
-
-def something
-  # ...
-end
-```
-
-#### Condition
-
-```ruby
-make :something, if: -> { Settings.something.enabled }
-
-def something
-  # ...
-end
-```
-
-#### Several
-
-```ruby
-make :assign_api_model
-make :perform_api_request
-make :process_result
-
-def assign_api_model
-  self.api_model = APIModel.new
-end
-
-def perform_api_request
-  self.response = APIClient.resource.create(api_model)
-end
-
-def process_result
-  ARModel.create!(response)
-end
-```
-
-### Failures
-
-The methods that are used in `make` may fail. In order to more informatively provide information about this outside the service, the following methods were prepared.
-
-#### Fail
-
-```ruby
-make :check!
-
-def check!
-  return if inputs.invoice_number.start_with?("AA")
-
-  fail!(message: "Invalid invoice number")
-end
-```
-
-#### Fail for input
-
-```ruby
-make :check!
-
-def check!
-  return if inputs.invoice_number.start_with?("AA")
-
-  fail_input!(:invoice_number, message: "Invalid invoice number")
-end
-```
-
-#### Metadata
-
-```ruby
-fail!(
-  message: "Invalid invoice number", 
-  meta: { 
-    invoice_number: inputs.invoice_number 
-  }
-)
-```
-
-```ruby
-exception.detailed_message  # => Invalid invoice number (ApplicationService::Errors::Failure)
-exception.message           # => Invalid invoice number
-exception.type              # => :fail
-exception.meta              # => {:invoice_number=>"BB-7650AE"}
-```
-
-### Inheritance
-
-Inheritance between services is also supported.
-
-## I18n
-
-All texts are stored in the localization file. All texts can be changed or supplemented by new locales.
-
-[See en.yml file](https://github.com/afuno/servactory/tree/main/config/locales/en.yml)
-
-## Testing
-
-Testing Servactory services is the same as testing regular Ruby classes.
-
-## Thanks
+## Contributing
 
-Thanks to [@sunny](https://github.com/sunny) for [Service Actor](https://github.com/sunny/actor).
+This project is intended to be a safe, welcoming space for collaboration. Contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. We recommend reading the [contributing guide](./docs/pages/CONTRIBUTING.md) as well.
 
-## Contributing
+## License
 
-1. Fork it (https://github.com/afuno/servactory/fork);
-2. Create your feature branch (`git checkout -b my-new-feature`);
-3. Commit your changes (`git commit -am "Add some feature"`);
-4. Push to the branch (`git push origin my-new-feature`);
-5. Create a new Pull Request.
+ViewComponent is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/servactory/configuration/factory.rb

@@ -18,6 +18,10 @@ module Servactory
       def failure_class(failure_class)
         Servactory.configuration.failure_class = failure_class
       end
+
+      def method_shortcuts(method_shortcuts)
+        Servactory.configuration.method_shortcuts.merge(method_shortcuts)
+      end
     end
   end
 end

data/lib/servactory/configuration/setup.rb

@@ -6,7 +6,8 @@ module Servactory
       attr_accessor :input_error_class,
                     :internal_error_class,
                     :output_error_class,
-                    :failure_class
+                    :failure_class,
+                    :method_shortcuts
 
       def initialize
         @input_error_class = Servactory::Errors::InputError
@@ -14,6 +15,8 @@ module Servactory
         @output_error_class = Servactory::Errors::OutputError
 
         @failure_class = Servactory::Errors::Failure
+
+        @method_shortcuts = Servactory::Methods::Shortcuts::Collection.new
       end
     end
   end

data/lib/servactory/methods/dsl.rb

@@ -20,6 +20,20 @@ module Servactory
           collection_of_methods << Method.new(name, **options)
         end
 
+        def method_missing(shortcut_name, *args, &block)
+          return super unless Servactory.configuration.method_shortcuts.include?(shortcut_name)
+
+          method_options = args.last.is_a?(Hash) ? args.pop : {}
+
+          args.each do |method_name|
+            make(:"#{shortcut_name}_#{method_name}", **method_options)
+          end
+        end
+
+        def respond_to_missing?(shortcut_name, *)
+          Servactory.configuration.method_shortcuts.include?(shortcut_name) || super
+        end
+
         def collection_of_methods
           @collection_of_methods ||= Collection.new
         end

data/lib/servactory/methods/shortcuts/collection.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Servactory
+  module Methods
+    module Shortcuts
+      class Collection
+        # NOTE: http://words.steveklabnik.com/beware-subclassing-ruby-core-classes
+        extend Forwardable
+        def_delegators :@collection, :<<, :each, :merge, :include?
+
+        def initialize(*)
+          @collection = Set.new
+        end
+      end
+    end
+  end
+end

data/lib/servactory/methods/workbench.rb

@@ -34,7 +34,7 @@ module Servactory
         return false if condition.blank?
         return !Servactory::Utils.boolean?(condition) unless condition.is_a?(Proc)
 
-        !condition.call(context)
+        !condition.call(context: context)
       end
     end
   end

data/lib/servactory/version.rb

@@ -4,7 +4,7 @@ module Servactory
   module VERSION
     MAJOR = 1
     MINOR = 6
-    PATCH = 0
+    PATCH = 1
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: servactory
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Anton Sokolov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -194,7 +194,6 @@ files:
 - lib/servactory/configuration/factory.rb
 - lib/servactory/configuration/setup.rb
 - lib/servactory/context/callable.rb
-- lib/servactory/context/configuration.rb
 - lib/servactory/context/dsl.rb
 - lib/servactory/context/store.rb
 - lib/servactory/context/workspace.rb
@@ -235,6 +234,7 @@ files:
 - lib/servactory/methods/collection.rb
 - lib/servactory/methods/dsl.rb
 - lib/servactory/methods/method.rb
+- lib/servactory/methods/shortcuts/collection.rb
 - lib/servactory/methods/workbench.rb
 - lib/servactory/outputs/checks/base.rb
 - lib/servactory/outputs/checks/type.rb

data/lib/servactory/context/configuration.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Servactory
-  module Context
-    class Configuration
-      def input_error_class(input_error_class)
-        Servactory.configuration.input_error_class = input_error_class
-      end
-
-      def output_error_class(output_error_class)
-        Servactory.configuration.output_error_class = output_error_class
-      end
-
-      def internal_error_class(internal_error_class)
-        Servactory.configuration.internal_error_class = internal_error_class
-      end
-
-      def failure_class(failure_class)
-        Servactory.configuration.failure_class = failure_class
-      end
-    end
-  end
-end