beaconable 0.1.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d87286b430dfcb3dcaf437a08cf30061ce7473de5c7c690b49fa9a1f0433cd5
-  data.tar.gz: 4f4a10e54f1bc8a3056079bc6f266fb84691bc75c006a3bc127c7c73c38d67a2
+  metadata.gz: b1110a4b0e426b277132f84ad26662bd312339ed2442bf300943b9607983bea4
+  data.tar.gz: c15046bf2c149a9618057da5617dbe7e3aeda9e72506bf181b68bdb4d1486ee7
 SHA512:
-  metadata.gz: a268d17e4a4727bc872bee67784fe6bf0956ce1e3d0a3b20233a978ccd89ccd49683f12ac6aebc93c2b4e980fa2523e450e2370911766757b44fe20bfb1d51b2
-  data.tar.gz: 3b225ef36a9e871d2cc37b25c75adb306b1fed0ff2af6bab3e24d2e282baebd6d8a997ab91b5c74c3d835e63944752901bdb71bfef0f15a4d376a34448b8efb1
+  metadata.gz: e0636144adbcb4f25a166fe5192617f07f8c0eb1ec22d8fb59abe4db8c2cd2fd9d195d920ad990989cc2914b779e2531aeeb7ec852e988e0506bd0b0e9b1f10b
+  data.tar.gz: 1fda0620bb1caaf045e6a017f607791cc412412edd8e2ae68bb3d0a3ac42d23a60f88dd1c2c171a0c2812508544c80a557de4639ebc908f8df64ee3661d4d45d

data/.gitignore

@@ -8,3 +8,4 @@
 /tmp/
 .ruby-version
 /vendor
+.byebug_history

data/.travis.yml

@@ -1,5 +1,8 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.6
-before_install: gem install bundler -v 1.16.1
+  - 2.5.3
+  - 2.6.3
+before_install: gem install bundler -v 1.17.2
+script:
+  - bundle exec rake

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+## 0.3.0 (2020-08-03)
+
+- Changed ObjectWas initialization to wrap al all the changes for a transaction
+
+ ## 0.2.2 (2019-12-16)
+
+- Added new tests for chained methods
+- Fixed chained methods
+
+ ## 0.2.1 (2019-12-16)
+
+- Made #field_change, #from and #to public
+
+ ## 0.2.0 (2019-12-12)
+
+- Added new test and fixes styles
+- Added #field_change, #from, #to

data/Gemfile.lock

@@ -1,28 +1,29 @@
 PATH
   remote: .
   specs:
-    beaconable (0.1.1)
+    beaconable (0.2.3)
       activerecord (>= 4.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activerecord (6.0.0)
-      activemodel (= 6.0.0)
-      activesupport (= 6.0.0)
-    activesupport (6.0.0)
+    activemodel (6.0.2)
+      activesupport (= 6.0.2)
+    activerecord (6.0.2)
+      activemodel (= 6.0.2)
+      activesupport (= 6.0.2)
+    activesupport (6.0.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
+      zeitwerk (~> 2.2)
     ansi (1.5.0)
     ast (2.4.0)
     builder (3.2.3)
-    concurrent-ruby (1.1.5)
-    i18n (1.6.0)
+    byebug (10.0.2)
+    concurrent-ruby (1.1.6)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.3)
     minitest (5.11.3)
@@ -46,10 +47,10 @@ GEM
     ruby-progressbar (1.10.1)
     sqlite3 (1.4.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.6.0)
-    zeitwerk (2.1.9)
+    zeitwerk (2.2.2)
 
 PLATFORMS
   ruby
@@ -57,6 +58,7 @@ PLATFORMS
 DEPENDENCIES
   beaconable!
   bundler (~> 1.16)
+  byebug (~> 10.0)
   minitest (~> 5.0)
   minitest-reporters (~> 1.3)
   rake (~> 10.0)

data/README.md

@@ -1,5 +1,7 @@
 # Beaconable
 
+[![Build Status](https://travis-ci.org/Lastimoso/beaconable.svg?branch=master)](https://travis-ci.org/Lastimoso/beaconable) [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/dwyl/esta/issues)
+
 Small OO patern to isolate side-effects and callbacks for your ActiveRecord Models.
 
 ## Installation
@@ -24,7 +26,11 @@ When you include Beaconable in your model it will fire your Beacon everytime aft
 - object (and an alias with the name of your model, i.e user): the instance of your object after changes.
 - object_was (and an alias with the name of your model, i.e. user_was): the instance of your object as it was before your changes
 - field_changed?(:field_name) : It allows you to check if a specific field was modified.
-- new_entry? : Returns true if the item saved is new 
+- 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
+
+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')
 
 ### Rails Generator
 You can use the bundled generator if you are using the library inside of
@@ -41,14 +47,15 @@ This will do the following:
 
 ```ruby
 class UserBeacon < Beaconable::BaseBeacon
-  alias user object 
+  alias user object
   alias user_was object_was
-  
+
   def call
     WelcomeUserJob.perform_later(self.id) if new_entry?
     UpdateExternalServiceJob.perform_later(self.id) if field_changed? :email
   end
 end
+```
 
 ## Development
 

data/beaconable.gemspec

@@ -38,4 +38,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rubocop', '~> 0.74.0'
   spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'byebug', '~> 10.0'
 end

data/lib/beaconable.rb

@@ -15,12 +15,13 @@ module Beaconable
   private
 
   def save_for_beacon
-    @object_was = ObjectWas.new(self).call
+    @object_was ||= ObjectWas.new(self).call
   end
 
   def fire_beacon
     if self.saved_changes?
       "#{self.class.name}Beacon".constantize.new(self, @object_was).call
     end
+    @object_was = nil
   end
 end

data/lib/beaconable/base_beacon.rb

@@ -9,14 +9,39 @@ module Beaconable
       @object_was = object_was
     end
 
+    def field_changed(field)
+      @field = field
+      @result = field_changed? field
+      self
+    end
+
+    def from(*values)
+      return self unless @result
+
+      @result = values.include? object_was.send(@field)
+      self
+    end
+
+    def to(*values)
+      @result && values.include?(object.send(@field))
+    end
+
     private
 
     def field_changed?(field)
       object.send(field) != object_was.send(field)
     end
 
+    def any_field_changed?(*fields)
+      fields.each do |field|
+        return true if field_changed?(field)
+      end
+      false
+    end
+
     def new_entry?
       object_was.created_at.nil?
     end
+
   end
 end

data/lib/beaconable/object_was.rb

@@ -10,7 +10,7 @@ module Beaconable
 
     def call
       hashed_object = {}
-      symbolized_column_names = object.class.column_names.map {|column_name| column_name.to_sym}
+      symbolized_column_names = object.class.column_names.map(&:to_sym)
       symbolized_column_names.each do |column_name|
         hashed_object[column_name] = object.send("#{column_name}_was")
       end

data/lib/beaconable/version.rb

@@ -1,3 +1,3 @@
 module Beaconable
-  VERSION = "0.1.1"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaconable
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Gerardo Raiden
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-25 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 description: Small OO patern to isolate side-effects and callbacks for your ActiveRecord
   Models
 email:
@@ -118,6 +132,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock