haku 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5fcbccd5d1d9c9be3d0d66259a210f75e52392ba1d76a7eff4b0ef375caae684
-  data.tar.gz: 93632c6b6124810c8d08a316a162b449f8680612dec73ffaa931f01490a65a9c
+  metadata.gz: ca30959f8f3163c1aa8c7179f0e4ff3d84b2c46b736733ddefdbc3071c433b08
+  data.tar.gz: 8f1aaff1f0b2c64480ca5310b42cd68892306b64ac366d7813e99cf2f2616fce
 SHA512:
-  metadata.gz: f9fe64de95c0c910d76f0309e746298f20aad3e64ce7222b7e7300645387a585b42a850cfdae520a7a12d5771dbc64c46660a935d9ac658e2b838dff0c7cf55b
-  data.tar.gz: 5f0d174e5e0676e8fcee566bdb4d980b6a732cf028da40eb9fc1849585757e226add08f8f210bbdbb591ba31425ab9ee337ef57984d6044585bb26b1da069609
+  metadata.gz: 89b65efe9dc09eff84a3cf25def2301afaab54c296f8e0eb4b620750addc71af6f222aace23774edfd4b737fd88aed36fb2511373ed7fb3116eb811e97736f27
+  data.tar.gz: 296982f10418908126079b27030d5061316703cf2dbe415b8e707414954fd08d6ac36f93a236d930f7c25f818fffbfc3e475b8548f7aefb922b6dd98dcb79c9d

data/.rubocop.yml

@@ -15,11 +15,29 @@ AllCops:
     - "**/gemfiles/**/*"
     - "**/Appraisals"
   NewCops: enable
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
 
 Layout/SpaceAroundEqualsInParameterDefault:
   EnforcedStyle: no_space
 
+Metrics/ClassLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+Metrics/MethodLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
+Metrics/ModuleLength:
+  CountAsOne:
+    - array
+    - hash
+    - heredoc
+
 Style/Documentation:
   Enabled: false
 

data/Appraisals

@@ -1,11 +1,7 @@
-appraise "activesupport-6.0" do
-  gem "activesupport", "6.0"
+appraise "rails-6.1" do
+  gem "rails", "~> 6.1.0"
 end
 
-appraise "activesupport-6.1" do
-  gem "activesupport", "6.1"
-end
-
-appraise "activesupport-7.0" do
-  gem "activesupport", "7.0"
+appraise "rails-7.0" do
+  gem "rails", "~> 7.0"
 end

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## [Unreleased]
 
+## [1.4.0] - 2022-09-19
+- Improve `Haku::Eventable` module to support more data sources for event properties
+- Add `Haku::Delayable` module to execute service object in background
+- Improve README
+- **Breaking**: Require `activesupport` >= 6.1
+- **Breaking**: Require Ruby >= 2.7
+- Fix CI test invocation
+
 ## [1.3.1] - 2022-04-27
 - Fix Haku::Controller
 

data/Gemfile.lock

@@ -11,13 +11,13 @@ GIT
 PATH
   remote: .
   specs:
-    haku (1.3.1)
-      activesupport (>= 6.0, < 8.0)
+    haku (1.4.0)
+      activesupport (>= 6.1, < 8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2.4)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -25,7 +25,7 @@ GEM
     ast (2.4.2)
     coderay (1.1.3)
     concurrent-ruby (1.1.10)
-    i18n (1.10.0)
+    i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
     minitest (5.15.0)
@@ -56,7 +56,7 @@ GEM
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     thor (1.2.1)
-    tzinfo (2.0.4)
+    tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
 

data/README.md

@@ -20,9 +20,18 @@ bundle install
 
 ## Usage
 
-### Basic example
+**Haku** is made up of four modules that add functionality to our service objects:
 
-````ruby
+* `Haku::Core`
+* `Haku::Delayable`
+* `Haku::Eventable`
+* `Haku::Resourceable`
+
+Additionally, it's available the `Haku::Controller` module for use in ours Rails controllers.
+
+### Haku::Core
+
+```ruby
 class Users::Update
   include Haku::Core
 
@@ -49,11 +58,98 @@ response = Users::Update.call(user: User.first, attributes: { name: "Javier" })
 response.success? # => true
 response.result # => { resource: <User id="1" ...> }
 response.resource # => <User id="1" ...>
-````
+```
+
+As you can see, if the payload passed to `success!` or `failure!` is a hash, each key of the hash can be accessed
+directly in response object.
+
+### Haku::Delayable
+
+#### Basic example
+
+```ruby
+class Users::ComputeHours
+  include Haku::Core
+  include Haku::Delayable
+
+  input :user
+
+  def call
+    # compute expensive data for user
+  end
+end
+
+Users::ComputeHours.delayed.call(user: User.first)
+```
+
+Use `delayed.call` instead of `call` for execute service object in background using `ActiveJob` job.
+
+#### Customize job
+
+```ruby
+Users::ComputeHours.delayed(job: OtherJob).call(user: User.first)
+```
+
+#### Customize job options
+
+```ruby
+Users::ComputeHours.delayed(job: OtherJob, queue: :low, priority: 2).call(user: User.first)
+```
+
+You can pass the same options allowed by ActiveJob
+[set](https://api.rubyonrails.org/v7.0.4/classes/ActiveJob/Core/ClassMethods.html#method-i-set) method:
+
+
+### Haku::Eventable
+
+#### Basic example
+
+```ruby
+class Users::Update
+  include Haku::Core
+  include Haku::Eventable
+
+  input :user, :attributes
+  event resource: :user
+
+  def call
+    success! resource: user
+  end
+end
+
+Users::Update.call(user: User.first, attributes: { name: "Javier" })
+
+# => call Event.create(name: "user:update", resource: User.first)
+```
+
+The `name` attribute are calculated using the custom proc from `event_name` config option. You can change it with
+
+```ruby
+event name: 'custom:name', resource: :user
+```
 
-### Using resourceable helpers
+#### Properties passed to event model
 
-````ruby
+Properties that should be passed to event model are defined in `event_properties` config option and by
+default are `actor` `resource`, `target` and `context`.
+
+1. Append base properties. For each property defined in `event_properties` config option, it will try to:
+   1. If defined a instance variable `@event_<property>`, uses the instance variable value to get the value of property.
+   2. If respond_to method called `event_<property>`, method is used to get the value of property.
+   3. If defined a instance variable `@<property>`, uses the instance variable value to get the value of property.
+   4. If respond_to method called `<property>`, method is used to get the value of property.
+   5. In other case, the property is not appended.
+2. Append properties defined in `event` class method. Overwrites previous values. For each property, will try to:
+   1. If is a block, it is called to get the value of property.
+   2. If is a symbol:
+      1. If defined a instance variable `@<property>`, uses the instance variable value to get the value of property.
+      2. If respond_to `<property>`, method is used to get the value of property.
+   3. In other case, uses the raw value.
+
+
+### Haku::Resourceable
+
+```ruby
 class Users::Update
   include Haku::Core
   include Haku::Resourceable
@@ -71,12 +167,15 @@ class Users::Update
     UserMailer.with(user: user).update.deliver_later
   end
 end
-````
+```
+
 
-### Controller helpers
+### Haku::Controller
 
 ```ruby
 class UsersController < ApplicationController
+  include Haku::Controller
+
   before_action :find_user
 
   def update
@@ -101,26 +200,6 @@ class UsersController < ApplicationController
 end
 ```
 
-### Using eventable
-
-````ruby
-class Users::Update
-  include Haku::Core
-  include Haku::Resourceable
-  include Haku::Eventable
-
-  input :user, :attributes
-  event resource: :user
-
-  def call
-    update_resource(user, attributes)
-  end
-end
-
-Users::Update.call(user: User.first, attributes: { name: "Javier" })
-
-# => call Event.create(name: "user:update", resource: User.first)
-````
 
 ### Using parent class
 
@@ -135,6 +214,7 @@ class Users::Update < ApplicationAction
 end
 ```
 
+
 ## Configure
 
 ### Example
@@ -149,14 +229,13 @@ end
 
 ### Allowed options
 
-| Config                             | Description                                            | Default value                                            |
-|:-----------------------------------|:-------------------------------------------------------|:---------------------------------------------------------|
-| `enable_in_action_controller_base` | Include controller helpers in `ActionController::Base` | `true`                                                     |
-| `enable_in_action_controller_api`  | Include controller helpers in `ActionController::API`  | `true`                                                     |
-| `event_model`                      | Name of the model used for create events               | `Event`                                                  |
-| `event_properties`                 | List of attributes passed from service to event model  | `%i[actor resource target context]`                      |
-| `event_property_for_name`          | Property used for name in event model                  | `:name`                                                  |
-| `event_name`                       | String or Proc to determine the event name             | Custom Proc. Example: `user:created` for `Users::Create` |
+| Config                    | Description                                           | Default value                                           |
+|:--------------------------|:------------------------------------------------------|:--------------------------------------------------------|
+| `event_model`             | Name of the model used for create events              | `Event`                                                 |
+| `event_properties`        | List of attributes passed from service to event model | `%i[actor resource target context]`                     |
+| `event_property_for_name` | Property used for name in event model                 | `:name`                                                 |
+| `event_name`              | String or Proc to determine the event name            | Custom Proc. Example: `user:create` for `Users::Create` |
+| `job_queue`               | String or Symbol with queue name                      | `default`                                               |
 
 
 ## Resourceable
@@ -210,6 +289,7 @@ Call to `destroy` method of the `resource`. Invoke `success!` if the model is de
 
 For more info please view the [source code](lib/haku/resourceable.rb) of the module.
 
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
@@ -221,16 +301,19 @@ To release a new version, update the version number in `version.rb`, and then ru
 which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to
 [rubygems.org](https://rubygems.org).
 
+
 ## Contributing
 
 Bug reports and pull requests are welcome, please follow
 [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow).
 
+
 ## Code of Conduct
 
 Everyone interacting in the Haku project's codebases, issue trackers, chat rooms and mailing lists is expected to
 follow the [code of conduct](https://github.com/javierav/haku/blob/development/CODE_OF_CONDUCT.md).
 
+
 ## License
 
 Copyright © 2022 Javier Aranda. Released under the terms of the [MIT license](LICENSE).

data/gemfiles/{activesupport_6.1.gemfile → rails_6.1.gemfile}

@@ -2,13 +2,13 @@
 
 source "https://rubygems.org"
 
-gem "appraisal", "~> 2.4"
+gem "appraisal", github: "excid3/appraisal", branch: "fix-bundle-env"
 gem "minitest", "~> 5.0"
 gem "pry", "~> 0.14"
 gem "rake", "~> 13.0"
 gem "rubocop", "~> 1.21"
 gem "rubocop-minitest", "~> 0.19"
 gem "rubocop-rake", "~> 0.6"
-gem "activesupport", "6.1"
+gem "rails", "~> 6.1.0"
 
 gemspec path: "../"

data/gemfiles/{activesupport_6.0.gemfile → rails_7.0.gemfile}

@@ -2,13 +2,13 @@
 
 source "https://rubygems.org"
 
-gem "appraisal", "~> 2.4"
+gem "appraisal", github: "excid3/appraisal", branch: "fix-bundle-env"
 gem "minitest", "~> 5.0"
 gem "pry", "~> 0.14"
 gem "rake", "~> 13.0"
 gem "rubocop", "~> 1.21"
 gem "rubocop-minitest", "~> 0.19"
 gem "rubocop-rake", "~> 0.6"
-gem "activesupport", "6.0"
+gem "rails", "~> 7.0"
 
 gemspec path: "../"

data/lib/haku/core.rb

@@ -14,6 +14,7 @@ module Haku
       attr_reader :params
 
       class_attribute :haku_inputs, default: []
+      class_attribute :haku_before_call_callbacks, default: []
       class_attribute :haku_success_callbacks, default: []
       class_attribute :haku_failure_callbacks, default: []
     end
@@ -35,6 +36,10 @@ module Haku
         self.haku_inputs += names
       end
 
+      def before_call(*methods)
+        self.haku_before_call_callbacks += methods
+      end
+
       def on_success(*methods)
         self.haku_success_callbacks += methods
       end
@@ -48,13 +53,16 @@ module Haku
 
     module Callable
       def call
-        response = catch(:finish) { super }
+        response = catch(:finish) do
+          (self.class.send(:haku_before_call_callbacks) || []).each { |cb| send(cb) }
+          super
+        end
 
         status = response.is_a?(Finish) ? response.status : :success
         payload = response.is_a?(Finish) ? response.payload : response
 
         Result.new(status, payload).tap do
-          _haku_run_callbacks(status)
+          haku_run_callbacks(status)
         end
       end
     end
@@ -77,7 +85,7 @@ module Haku
       throw :finish, Finish.new(:failure, data)
     end
 
-    def _haku_run_callbacks(status)
+    def haku_run_callbacks(status)
       (self.class.send("haku_#{status}_callbacks") || []).each { |cb| send(cb) }
     end
   end

data/lib/haku/delayable.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_support/core_ext/string/inflections"
+
+module Haku
+  module Delayable
+    extend ActiveSupport::Concern
+
+    if defined?(ActiveJob::Base)
+      class Job < ActiveJob::Base
+        def perform(klass, params)
+          klass.call(params)
+        end
+      end
+    end
+
+    class Delayed
+      def initialize(service, options={})
+        @service = service
+        @options = options.reverse_merge(
+          job: "::Haku::Delayable::Job",
+          queue: Haku.job_queue
+        )
+      end
+
+      def call(params={})
+        if job.present? && defined?(job)
+          job.set(@options).perform_later(@service, params)
+        else
+          @service.call(params)
+        end
+      end
+
+      private
+
+      def job
+        @job ||= begin
+          job = @options.delete(:job)
+          job.is_a?(String) ? job.safe_constantize : job
+        end
+      end
+    end
+
+    module ClassMethods
+      def delayed(options={})
+        ::Haku::Delayable::Delayed.new(self, options)
+      end
+    end
+  end
+end

data/lib/haku/eventable.rb

@@ -47,21 +47,25 @@ module Haku
 
     def haku_event_data_base(data)
       Haku.event_properties.each do |property|
-        data[property] = send(property) if respond_to?(property)
+        haku_event_data_base_value_for_property(data, property)
       end
     end
 
-    def haku_process_value(value)
-      if value.respond_to?(:call)
-        instance_exec(&value)
-      else
-        value.is_a?(Symbol) ? send(value) : value
+    def haku_event_data_base_value_for_property(data, property)
+      if instance_variable_defined?("@event_#{property}")
+        data[property] = instance_variable_get("@event_#{property}")
+      elsif respond_to?("event_#{property}", true)
+        data[property] = send("event_#{property}")
+      elsif instance_variable_defined?("@#{property}")
+        data[property] = instance_variable_get("@#{property}")
+      elsif respond_to?(property, true)
+        data[property] = send(property)
       end
     end
 
     def haku_event_data_name(data, evt)
       key = Haku.event_property_for_name.to_sym
-      data[key] = evt[key] || haku_process_value(Haku.event_name)
+      data[key] = haku_process_value(evt[key] || Haku.event_name)
     end
 
     def haku_event_data_values(data, evt)
@@ -70,6 +74,18 @@ module Haku
       end
     end
 
+    def haku_process_value(value)
+      if value.respond_to?(:call)
+        instance_exec(&value)
+      else
+        value.is_a?(Symbol) ? haku_process_symbol_value(value) : value
+      end
+    end
+
+    def haku_process_symbol_value(value)
+      instance_variable_defined?("@#{value}") ? instance_variable_get("@#{value}") : send(value)
+    end
+
     def haku_create_event(data)
       Haku.event_model.safe_constantize&.create(data)
     end

data/lib/haku/version.rb

@@ -3,8 +3,8 @@
 module Haku
   module VERSION
     MAJOR = 1
-    MINOR = 3
-    TINY  = 1
+    MINOR = 4
+    TINY  = 0
     PRE   = nil
 
     STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")

data/lib/haku.rb

@@ -4,6 +4,7 @@ require "active_support/core_ext/module/attribute_accessors"
 require "active_support/core_ext/string/inflections"
 require_relative "haku/controller"
 require_relative "haku/core"
+require_relative "haku/delayable"
 require_relative "haku/eventable"
 require_relative "haku/resourceable"
 require_relative "haku/version"
@@ -16,6 +17,7 @@ module Haku
     chain = self.class.name.underscore.split("/")
     (chain[0...-1].map(&:singularize) + [chain.last]).join(":")
   }
+  mattr_accessor :job_queue, default: :default
 
   class << self
     def configure

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haku
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
 - Javier Aranda
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-27 00:00:00.000000000 Z
+date: 2022-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'
@@ -52,12 +52,12 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/activesupport_6.0.gemfile
-- gemfiles/activesupport_6.1.gemfile
-- gemfiles/activesupport_7.0.gemfile
+- gemfiles/rails_6.1.gemfile
+- gemfiles/rails_7.0.gemfile
 - lib/haku.rb
 - lib/haku/controller.rb
 - lib/haku/core.rb
+- lib/haku/delayable.rb
 - lib/haku/eventable.rb
 - lib/haku/resourceable.rb
 - lib/haku/result.rb
@@ -67,8 +67,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/javierav/haku
-  source_code_uri: https://github.com/javierav/haku/tree/v1.3.1
-  changelog_uri: https://github.com/javierav/haku/blob/v1.3.1/CHANGELOG.md
+  source_code_uri: https://github.com/javierav/haku/tree/v1.4.0
+  changelog_uri: https://github.com/javierav/haku/blob/v1.4.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options:
@@ -79,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/gemfiles/activesupport_7.0.gemfile

@@ -1,14 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "appraisal", "~> 2.4"
-gem "minitest", "~> 5.0"
-gem "pry", "~> 0.14"
-gem "rake", "~> 13.0"
-gem "rubocop", "~> 1.21"
-gem "rubocop-minitest", "~> 0.19"
-gem "rubocop-rake", "~> 0.6"
-gem "activesupport", "7.0"
-
-gemspec path: "../"