beaconable 0.3.1 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bec79a862ecc4920422fa44d559651bf347e777851475e52477c42ef33873839
-  data.tar.gz: a0d5adad3dd5446597f72f74a8d04bb327317f907037312dc15b93f1d7159092
+  metadata.gz: 8bdeff81b271551aee7e8f733efc822fbbecd6fc1770f8f4e1a991bd2555efda
+  data.tar.gz: 3145a97b3a02ae7d11f12c636c2c94924a7d86c44adc103433547c91ed6c15e8
 SHA512:
-  metadata.gz: 7c048d0131bcc789c886077b1e6dc3d1a4a198760da76ae0f881de26f3016638553c167507d1232e4be125aa445d4521d3cb3eeb97cbc9cdbd07634fa8c1530b
-  data.tar.gz: 93c58a920aa1d8b3ed2d80cc34460ccb8ee576489589cfb5f79289fa6de2f4a648ea6ea86f304834c9d41dec0201dcc51b8d66cd378776cf89b8758a28b21a99
+  metadata.gz: 372d885268948c09f5edeccccec24ebf36e7a3cb4200415ddfc930c00185e6b6a3427ae6959554ad1a45fca846ec69d97694b4f2c314355f0e6c381171bb0283
+  data.tar.gz: c210f9ba73d61fe5389927166069cd9e238fa9fd630c1ebaa59d10404d9933c4d60791942d524157827a576bbf045600fb8967612ae356d1874004878a8c47b8

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.3.4 (2022-03-14)
+
+### Improvements
+
+- Add `#beacon_metadata` & `#beacon_metadata=` method to included classes
+
+## 0.3.3 (2020-11-02)
+
+-  Fixes a bug that causes an error when a beaconable was touch by an association without changes
+
+### Improvements
+- Add `#skip_beacon` method to included clases
+
+## 0.3.2 (2020-10-07)
+
+### Improvements
+- Add `#destroyed_entry?` method
+
 ## 0.3.1 (2020-09-16)
 
 - Fixes #fire_beacon not to use dirty attributes to check changes

data/Gemfile.lock

@@ -1,29 +1,29 @@
 PATH
   remote: .
   specs:
-    beaconable (0.3.1)
+    beaconable (0.3.4)
       activerecord (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.2)
-      activesupport (= 6.0.2)
-    activerecord (6.0.2)
-      activemodel (= 6.0.2)
-      activesupport (= 6.0.2)
-    activesupport (6.0.2)
+    activemodel (6.1.4.6)
+      activesupport (= 6.1.4.6)
+    activerecord (6.1.4.6)
+      activemodel (= 6.1.4.6)
+      activesupport (= 6.1.4.6)
+    activesupport (6.1.4.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ansi (1.5.0)
     ast (2.4.0)
     builder (3.2.3)
     byebug (10.0.2)
-    concurrent-ruby (1.1.6)
-    i18n (1.8.2)
+    concurrent-ruby (1.1.9)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.3)
     minitest (5.11.3)
@@ -36,7 +36,7 @@ GEM
     parser (2.6.3.0)
       ast (~> 2.4.0)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
     rubocop (0.74.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -46,11 +46,10 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.7)
     ruby-progressbar (1.10.1)
     sqlite3 (1.4.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (1.6.0)
-    zeitwerk (2.2.2)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
@@ -61,7 +60,7 @@ DEPENDENCIES
   byebug (~> 10.0)
   minitest (~> 5.0)
   minitest-reporters (~> 1.3)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rubocop (~> 0.74.0)
   sqlite3 (~> 1.3)
 

data/README.md

@@ -28,6 +28,7 @@ When you include Beaconable in your model it will fire your Beacon everytime aft
 - field_changed?(:field_name) : It allows you to check if a specific field was modified.
 - any_field_changed?(:field_name, :other_field_name) : It allows you to check if any of multiple fields was modified.
 - new_entry? : Returns true if the item saved is new
+- destroyed_entry? :  Returns true if the item has been destroyed
 
 You can also used the following chained methods
 - field_change(:field_name).from('first_alternative', 'n_alternative').to('first_alternative_for_to', 'second_alternative_for_to', 'n_alternative_for_toq')
@@ -57,6 +58,66 @@ class UserBeacon < Beaconable::BaseBeacon
 end
 ```
 
+### Avoid firing a beacon
+
+You can skip beacon calls if you pass true to the method `#skip_beacon`. I.E:
+```
+...
+ user.update(user_params)
+ user.skip_beacon = true
+ user.save # The user beacon won't be fired.
+```
+
+### Beacon metadata
+
+You can pass `beacon_metadata` to the `object` that will be available on the **Beacon**.
+
+Some uses might be:
+
+- to determine whether a certain action should be performed or not. For example when creating users in batch actions or in through the console you might want to skip just the welcome email but still perform all the other side effects associated with the user creation.
+- to pass information that is generated / available in memory, will not be persisted in the model but is relevant in the side effects. For example, if you want to implement your own event logging system you could pass the current user id from the controller action to the beacon where you are going to create the Event.
+
+```ruby
+User.create(
+  email: "new_user@email.com",
+  beacon_metadata: {
+    skip_welcome_user_job: true,
+    triggered_by: "admin@myapp.com"
+  }
+)
+
+# app/beacons/user_beacon.rb
+class UserBeacon < Beaconable::BaseBeacon
+  alias user object
+  alias user_was object_was
+
+  def call
+    WelcomeUserJob.perform_later(self.id) if should_perform_welcome_user_job?
+    UpdateExternalServiceJob.perform_later(self.id) if field_changed? :email
+    Event.create do |event|
+      event.content = UserSerializer.new(user).event_content
+      event.ocurred_at = user.updated_at
+      if beacon_metadata.present?
+        event.triggered_by = beacon_metadata.dig(:triggered_by)
+        event.source = beacon_metadata.dig(:source)
+      end
+    end
+  end
+
+  private
+
+  def should_perform_welcome_user_job?
+    new_entry? && !skip_welcome_user_job?
+  end
+
+  def skip_welcome_user_job?
+    beacon_metadata[:skip_welcome_user_job] if beacon_metadata.present?
+  end
+end
+```
+
+**Important**: once the beacon has been _fired_ the `beacon_metadata` will be cleared.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/beaconable.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rubocop', '~> 0.74.0'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
   spec.add_development_dependency 'byebug', '~> 10.0'

data/lib/beaconable/base_beacon.rb

@@ -2,11 +2,12 @@
 
 module Beaconable
   class BaseBeacon
-    attr_reader :object, :object_was
+    attr_reader :object, :object_was, :beacon_metadata
 
     def initialize(object, object_was)
       @object = object
       @object_was = object_was
+      @beacon_metadata = object.beacon_metadata
     end
 
     def field_changed(field)
@@ -28,6 +29,10 @@ module Beaconable
 
     private
 
+    def destroyed_entry?
+      object.destroyed?
+    end
+
     def field_changed?(field)
       object.send(field) != object_was.send(field)
     end
@@ -42,6 +47,5 @@ module Beaconable
     def new_entry?
       object_was.created_at.nil?
     end
-
   end
 end

data/lib/beaconable/version.rb

@@ -1,3 +1,3 @@
 module Beaconable
-  VERSION = "0.3.1"
+  VERSION = "0.3.4"
 end

data/lib/beaconable.rb

@@ -8,8 +8,13 @@ require 'active_record'
 module Beaconable
   extend ActiveSupport::Concern
   included do
-    before_save :save_for_beacon
-    after_commit :fire_beacon
+    attr_accessor :beacon_metadata
+    attr_accessor :skip_beacon
+
+    before_save :save_for_beacon, unless: :skip_beacon
+    before_destroy :save_for_beacon, unless: :skip_beacon
+    after_touch :save_for_beacon, unless: :skip_beacon
+    after_commit :fire_beacon, unless: :skip_beacon
   end
 
   private
@@ -21,5 +26,6 @@ module Beaconable
   def fire_beacon
     "#{self.class.name}Beacon".constantize.new(self, @object_was).call
     @object_was = nil
+    self.beacon_metadata = nil
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaconable
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.4
 platform: ruby
 authors:
 - Gerardo Raiden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2022-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement