beaconable 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55f9fa301c3ed8240b86672ef33e1abfe95cc648f68e629cd855a905d479c007
-  data.tar.gz: 367caefeb3598b7fd9454a056b1eafca2c88c0e4d7ca226c70f0be716575baa8
+  metadata.gz: 9d87286b430dfcb3dcaf437a08cf30061ce7473de5c7c690b49fa9a1f0433cd5
+  data.tar.gz: 4f4a10e54f1bc8a3056079bc6f266fb84691bc75c006a3bc127c7c73c38d67a2
 SHA512:
-  metadata.gz: 01ed1385b08b58c60eaa4453aaaca02cca6157b313039bdea6ef543ebd71310359eb4aec19c6c6baafe8e1f8105c470921e3f99e8eac2eb86ac4a879fc1e8b37
-  data.tar.gz: 4472b96a5f7fcd8e1d69756451e06b845f80f0dc28be36d3a94dfb9b550296e43572233604f52212e1dd3e49986b0f76273ce3c14f0b1e753d86e4168c9f2bfc
+  metadata.gz: a268d17e4a4727bc872bee67784fe6bf0956ce1e3d0a3b20233a978ccd89ccd49683f12ac6aebc93c2b4e980fa2523e450e2370911766757b44fe20bfb1d51b2
+  data.tar.gz: 3b225ef36a9e871d2cc37b25c75adb306b1fed0ff2af6bab3e24d2e282baebd6d8a997ab91b5c74c3d835e63944752901bdb71bfef0f15a4d376a34448b8efb1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    beaconable (0.1.0)
+    beaconable (0.1.1)
       activerecord (>= 4.0)
 
 GEM

data/README.md

@@ -19,8 +19,36 @@ Or install it yourself as:
     $ gem install beaconable
 
 ## Usage
+When you include Beaconable in your model it will fire your Beacon everytime after you create or save an entry. Inside your Beacon you have access to the following:
 
-TODO: Write usage instructions here
+- 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 
+
+### Rails Generator
+You can use the bundled generator if you are using the library inside of
+a Rails project:
+
+    rails g beacon User
+
+This will do the following:
+1. Create a new beacon file in `app/beacons/user_beacon.rb`
+2. Will add "include Beaconable" in your User Model.
+
+
+### Beacon Definition
+
+```ruby
+class UserBeacon < Beaconable::BaseBeacon
+  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/lib/beaconable/version.rb

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

data/lib/generators/beacon/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Generates a beacon for the given model.
+
+Example:
+    rails generate beacon User
+
+    This will create:
+        app/beacons/user_beacon.rb

data/lib/generators/beacon/beacon_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+class BeaconGenerator < Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+
+  def create_beacon_file
+    template 'beacon.rb.tt', File.join('app', 'beacons', class_path, "#{file_name}_beacon.rb")
+  end
+
+  def insert_inclusion_into_model_file
+    inject_into_class "app/models/#{file_name}.rb", class_name do
+      "  include Beaconable\n"
+    end
+  end
+end

data/lib/generators/beacon/templates/beacon.rb.tt

@@ -0,0 +1,12 @@
+<% module_namespacing do -%>
+# frozen_string_literal: true
+
+class <%= class_name %>Beacon < Beaconable::BaseBeacon
+  alias <%= file_name %> object
+  alias <%= file_name %>_was object_was
+
+  def call
+    # Put your callbacks and side-effects here
+  end
+end
+<% end -%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beaconable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gerardo Raiden
@@ -131,6 +131,9 @@ files:
 - lib/beaconable/base_beacon.rb
 - lib/beaconable/object_was.rb
 - lib/beaconable/version.rb
+- lib/generators/beacon/USAGE
+- lib/generators/beacon/beacon_generator.rb
+- lib/generators/beacon/templates/beacon.rb.tt
 homepage: https://github.com/Lastimoso/beaconable
 licenses:
 - MIT