RubyGems - haku - Versions diffs - 1.4.0 → 1.5.0 - Mend

haku 1.4.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (13) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca30959f8f3163c1aa8c7179f0e4ff3d84b2c46b736733ddefdbc3071c433b08
-  data.tar.gz: 8f1aaff1f0b2c64480ca5310b42cd68892306b64ac366d7813e99cf2f2616fce
+  metadata.gz: 137f060c137bed529cdd82679e0880674ed6a6b5d62a9865bf5f52fb8c89c805
+  data.tar.gz: 8ca69778bad99f1cd7f2ea6a64fdc0784337741acbde926ff487f5bc2312ff67
 SHA512:
-  metadata.gz: 89b65efe9dc09eff84a3cf25def2301afaab54c296f8e0eb4b620750addc71af6f222aace23774edfd4b737fd88aed36fb2511373ed7fb3116eb811e97736f27
-  data.tar.gz: 296982f10418908126079b27030d5061316703cf2dbe415b8e707414954fd08d6ac36f93a236d930f7c25f818fffbfc3e475b8548f7aefb922b6dd98dcb79c9d
+  metadata.gz: 53a9a2ffdd2f719e2aad8878130a7a2359cd818947be00cedaf82477262cafab6431e357520fb14a738f9fbc80b790a42077d9a68f000c3fa769ffea45369c04
+  data.tar.gz: 56ec2ff6a811220f409ed65df974493ffb0adcb77b7eb50f9a114e63a3c79af4160728b66278126d78886892f6e35bb63d973a77d26895bca7f3612a1fbc4efc

data/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,8 @@
 ## [Unreleased]
+## [1.5.0] - 2023-01-25
+* **Breaking**: Simplify Haku::Eventable module
 ## [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

data/Gemfile CHANGED Viewed

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 gemspec
-gem "appraisal", github: "excid3/appraisal", branch: "fix-bundle-env"
+gem "activejob", ">= 6.1", "< 8.0"
 gem "minitest", "~> 5.0"
 gem "pry", "~> 0.14"
 gem "rake", "~> 13.0"

data/Gemfile.lock CHANGED Viewed

@@ -1,71 +1,67 @@
-GIT
-  remote: https://github.com/excid3/appraisal.git
-  revision: 14855fc54ce88b42def871ce8bfd4259fbf06043
-  branch: fix-bundle-env
-  specs:
-    appraisal (2.4.1)
-      bundler
-      rake
-      thor (>= 0.14.0)
 PATH
   remote: .
   specs:
-    haku (1.4.0)
+    haku (1.5.0)
       activesupport (>= 6.1, < 8.0)
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
+    activejob (7.0.4.2)
+      activesupport (= 7.0.4.2)
+      globalid (>= 0.3.6)
+    activesupport (7.0.4.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
     coderay (1.1.3)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.0)
+    globalid (1.0.1)
+      activesupport (>= 5.0)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
+    json (2.6.3)
     method_source (1.0.0)
-    minitest (5.15.0)
+    minitest (5.17.0)
     parallel (1.22.1)
-    parser (3.1.1.0)
+    parser (3.2.0.0)
       ast (~> 2.4.1)
-    pry (0.14.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.1)
+    regexp_parser (2.6.2)
     rexml (3.2.5)
-    rubocop (1.26.1)
+    rubocop (1.44.1)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
       parser (>= 3.1.1.0)
-    rubocop-minitest (0.19.0)
+    rubocop-minitest (0.26.1)
       rubocop (>= 0.90, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
-    thor (1.2.1)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.4.2)
 PLATFORMS
   arm64-darwin-21
   x86_64-linux
 DEPENDENCIES
-  appraisal!
+  activejob (>= 6.1, < 8.0)
   haku!
   minitest (~> 5.0)
   pry (~> 0.14)

data/LICENSE CHANGED Viewed

@@ -1,6 +1,6 @@
 The MIT License (MIT)
-Copyright (c) 2022 Javier Aranda
+Copyright (c) 2022-2023 Javier Aranda
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md CHANGED Viewed

@@ -2,7 +2,13 @@
 ![CI](https://github.com/javierav/haku/workflows/CI/badge.svg)
-A library for build simple service objects.
+A simple library for build simple service objects.
+## Status
+> :warning: **This project is still experimental, use with caution!**
 ## Installation
@@ -18,16 +24,18 @@ And then execute:
 bundle install
 ```
 ## Usage
 **Haku** is made up of four modules that add functionality to our service objects:
-* `Haku::Core`
-* `Haku::Delayable`
-* `Haku::Eventable`
-* `Haku::Resourceable`
+* [Haku::Core](#hakucore)
+* [Haku::Delayable](#hakudelayable)
+* [Haku::Eventable](#hakueventable)
+* [Haku::Resourceable](#hakuresourceable)
+Additionally, it's available the [Haku::Controller](#hakucontroller) module for use in ours Rails controllers.
-Additionally, it's available the `Haku::Controller` module for use in ours Rails controllers.
 ### Haku::Core
@@ -63,9 +71,8 @@ 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
+### Haku::Delayable
 ```ruby
 class Users::ComputeHours
@@ -99,10 +106,22 @@ Users::ComputeHours.delayed(job: OtherJob, queue: :low, priority: 2).call(user:
 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:
+#### Config options
-### Haku::Eventable
+```ruby
+# config/initializers/haku.rb
+Haku.configure do |config|
+  config.job_queue = "low_priority"
+end
+```
-#### Basic example
+| Config      | Description                      | Default value |
+|:------------|:---------------------------------|:--------------|
+| `job_queue` | String or Symbol with queue name | `default`     |
+### Haku::Eventable
 ```ruby
 class Users::Update
@@ -125,30 +144,39 @@ Users::Update.call(user: User.first, attributes: { name: "Javier" })
 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
+event name: "custom:name", resource: :user
 ```
 #### Properties passed to event model
-Properties that should be passed to event model are defined in `event_properties` config option and by
-default are `actor` `resource`, `target` and `context`.
+For each property passed as payload of `event` class method, it will try to:
+1. If is a block, it is called to get the value of property.
+2. If is a symbol, a method is used to get the value of property:
+3. In other case, uses the raw value.
+#### Config options
+```ruby
+# config/initializers/haku.rb
+Haku.configure do |config|
+  config.event_model = "EventLog"
+end
+```
-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.
+| Config                    | Description                                           | Default value                                          |
+|:--------------------------|:------------------------------------------------------|:-------------------------------------------------------|
+| `event_model`             | Name of the model used for create events              | `Event`                                                |
+| `event_property_for_name` | Property used for name in event model                 | `:name`                                                |
+| `event_name`              | String or Proc to determine the event name            | Custom Proc. Returns `user:create` for `Users::Create` |
 ### Haku::Resourceable
+This module include helpers to works with *ActiveRecord* compatible model resources, invoking `success!` or `failure!`
+based in the result of the performed operation.
 ```ruby
 class Users::Update
   include Haku::Core
@@ -169,6 +197,52 @@ class Users::Update
 end
 ```
+#### create_resource
+Call to `create` or `<singleton>_create` method of the `parent` object passing the `attributes` and storing
+the result object in the `ivar` instance variable. Invoke `success!` if the model is persisted or `failure!` in other
+case.
+| parameter    | type     | description                                                      |
+|--------------|----------|------------------------------------------------------------------|
+| `parent`     | `Object` | Parent object where new resource will be created                 |
+| `attributes` | `Hash`   | Attributes for create                                            |
+| `ivar`       | `Symbol` | Name of the instance variable used to access to the new resource |
+| `options`    | `Hash`   | Options hash                                                     |
+##### options
+| parameter   | type     | description                                                          |
+|-------------|----------|----------------------------------------------------------------------|
+| `singleton` | `Symbol` | If the resource should be created using `<singleton>_create` suffix. |
+#### update_resource
+Call to `update` method of the `resource` object passing `attributes`to it. Invoke `success!` if the model is updated or
+`failure!` in other case.
+| parameter    | type     | description            |
+|--------------|----------|------------------------|
+| `resource`   | `Object` | Resource to be updated |
+| `attributes` | `Hash`   | Attributes to update   |
+#### destroy_resource
+Call to `destroy` method of the `resource`. Invoke `success!` if the model is destroyed or `failure!` in other case.
+| parameter    | type     | description              |
+|--------------|----------|--------------------------|
+| `resource`   | `Object` | Resource to be destroyed |
+#### persist_resource
+| parameter      | type     | description                                 |
+|----------------|----------|---------------------------------------------|
+| `resource`     | `Object` | Resource to be destroyed                    |
+| `save_options` | `Hash`   | Options passed to `save` method of resource |
+For more info please view the [source code](lib/haku/resourceable.rb) of the module.
 ### Haku::Controller
@@ -215,81 +289,6 @@ end
 ```
-## Configure
-### Example
-```ruby
-# config/initializers/haku.rb
-Haku.configure do |config|
-  config.event_model = "EventLog"
-end
-```
-### Allowed options
-| 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
-This module include helpers to works with *ActiveRecord* compatible model resources, invoking `success!` or `failure!`
-based in the result of the performed operation.
-### create_resource
-Call to `create` or `<singleton>_create` method of the `parent` object passing the `attributes` and storing
-the result object in the `ivar` instance variable. Invoke `success!` if the model is persisted or `failure!` in other
-case.
-| parameter    | type     | description                                                      |
-|--------------|----------|------------------------------------------------------------------|
-| `parent`     | `Object` | Parent object where new resource will be created                 |
-| `attributes` | `Hash`   | Attributes for create                                            |
-| `ivar`       | `Symbol` | Name of the instance variable used to access to the new resource |
-| `options`    | `Hash`   | Options hash                                                     |
-#### options
-| parameter   | type     | description                                                          |
-|-------------|----------|----------------------------------------------------------------------|
-| `singleton` | `Symbol` | If the resource should be created using `<singleton>_create` suffix. |
-### update_resource
-Call to `update` method of the `resource` object passing `attributes`to it. Invoke `success!` if the model is updated or
-`failure!` in other case.
-| parameter    | type     | description            |
-|--------------|----------|------------------------|
-| `resource`   | `Object` | Resource to be updated |
-| `attributes` | `Hash`   | Attributes to update   |
-### destroy_resource
-Call to `destroy` method of the `resource`. Invoke `success!` if the model is destroyed or `failure!` in other case.
-| parameter    | type     | description              |
-|--------------|----------|--------------------------|
-| `resource`   | `Object` | Resource to be destroyed |
-### persist_resource
-| parameter      | type     | description                                 |
-|----------------|----------|---------------------------------------------|
-| `resource`     | `Object` | Resource to be destroyed                    |
-| `save_options` | `Hash`   | Options passed to `save` method of resource |
-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.
@@ -316,4 +315,4 @@ follow the [code of conduct](https://github.com/javierav/haku/blob/development/C
 ## License
-Copyright © 2022 Javier Aranda. Released under the terms of the [MIT license](LICENSE).
+Copyright © 2022-2023 Javier Aranda. Released under the terms of the [MIT license](LICENSE).

data/lib/haku/eventable.rb CHANGED Viewed

@@ -39,30 +39,11 @@ module Haku
     def haku_prepare_event_data(evt, data={})
       data.tap do
-        haku_event_data_base(data)
         haku_event_data_name(data, evt)
         haku_event_data_values(data, evt)
       end
     end
-    def haku_event_data_base(data)
-      Haku.event_properties.each do |property|
-        haku_event_data_base_value_for_property(data, property)
-      end
-    end
-    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] = haku_process_value(evt[key] || Haku.event_name)
@@ -78,14 +59,10 @@ module Haku
       if value.respond_to?(:call)
         instance_exec(&value)
       else
-        value.is_a?(Symbol) ? haku_process_symbol_value(value) : value
+        value.is_a?(Symbol) ? send(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 CHANGED Viewed

@@ -3,7 +3,7 @@
 module Haku
   module VERSION
     MAJOR = 1
-    MINOR = 4
+    MINOR = 5
     TINY  = 0
     PRE   = nil

data/lib/haku.rb CHANGED Viewed

@@ -11,7 +11,6 @@ require_relative "haku/version"
 module Haku
   mattr_accessor :event_model, default: "Event"
-  mattr_accessor :event_properties, default: %i[actor resource target context]
   mattr_accessor :event_property_for_name, default: :name
   mattr_accessor :event_name, default: proc {
     chain = self.class.name.underscore.split("/")

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: haku
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Javier Aranda
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-19 00:00:00.000000000 Z
+date: 2023-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,7 +44,6 @@ files:
 - ".pryrc"
 - ".rubocop.yml"
 - ".tool-versions"
-- Appraisals
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -52,8 +51,6 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- gemfiles/rails_6.1.gemfile
-- gemfiles/rails_7.0.gemfile
 - lib/haku.rb
 - lib/haku/controller.rb
 - lib/haku/core.rb
@@ -67,8 +64,8 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/javierav/haku
-  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
+  source_code_uri: https://github.com/javierav/haku/tree/v1.5.0
+  changelog_uri: https://github.com/javierav/haku/blob/v1.5.0/CHANGELOG.md
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options:
@@ -89,5 +86,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: A library for build simple service objects
+summary: A simple library for build simple service objects
 test_files: []

data/Appraisals DELETED Viewed

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

data/gemfiles/rails_6.1.gemfile DELETED Viewed

@@ -1,14 +0,0 @@
-# This file was generated by Appraisal
-source "https://rubygems.org"
-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 "rails", "~> 6.1.0"
-gemspec path: "../"

data/gemfiles/rails_7.0.gemfile DELETED Viewed

@@ -1,14 +0,0 @@
-# This file was generated by Appraisal
-source "https://rubygems.org"
-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 "rails", "~> 7.0"
-gemspec path: "../"