stance 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51b0695fffdd5e9543b325277fabfd2244cac3a84ffefb2660ed9c48499bdf12
-  data.tar.gz: 28c77b84783964cc08617e2d28b8c1906105fe621b4ad83236bb571327e6dfc0
+  metadata.gz: e5dcb8d2d1f3afe7451a48687ab8ce7c2f073b0dc9645cf958ecdb38c6673f2b
+  data.tar.gz: 756df16a830baf56ab25bcb4ee6f027f15c13ff9908516f0c1dae1b98f761b1a
 SHA512:
-  metadata.gz: 2816cde14c5643554d55faa81122667e13b123bc8591e8d959d412a40e204b72aeca434b41a4b98a5270b07f828652f59064e60851c5e9e83a34aa21b6c97b52
-  data.tar.gz: '049bd51dd0ddb46eaa7e52b4a2fa0f7a709fd1c101510499637411c5d55e0ae374e5fca1de23a30760276213b1b38b43a56c353f392df9fe20272cee46eb0dcc'
+  metadata.gz: a770f62d1a8e6d6c58f1f2643dc6bd5403f957bcfb350bc5696ceca50dde989462f45ff317754602735445bffb43797db7452110f604c3304f67b5ab10cb63c9
+  data.tar.gz: 850c0b54c13ea154307a9788e21e3670e42ec06fa17628682aa206b1cbb7de12a741d46689c783ca9a9dc43fbf02a212473fffce8ea1c41842393fa0be5720d1

data/Gemfile

@@ -10,6 +10,7 @@ gem 'combustion'
 gem 'minitest'
 gem 'minitest-autotest'
 gem 'minitest-focus'
-gem 'rake', '~> 12.0'
+gem 'mocha'
+gem 'rake', '~> 13.0'
 gem 'rubocop'
 gem 'sqlite3'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stance (0.2.0)
+    stance (0.3.0)
       activerecord (>= 5)
       multi_json
       railties (>= 5)
@@ -9,48 +9,48 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.3.2)
-      actionview (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-      rack (~> 2.0, >= 2.0.8)
+    actionpack (6.1.1)
+      actionview (= 6.1.1)
+      activesupport (= 6.1.1)
+      rack (~> 2.0, >= 2.0.9)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.3.2)
-      activesupport (= 6.0.3.2)
+    actionview (6.1.1)
+      activesupport (= 6.1.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activerecord (6.0.3.2)
-      activemodel (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
-    activesupport (6.0.3.2)
+    activemodel (6.1.1)
+      activesupport (= 6.1.1)
+    activerecord (6.1.1)
+      activemodel (= 6.1.1)
+      activesupport (= 6.1.1)
+    activesupport (6.1.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.1)
     autotest-suffix (1.1.0)
     builder (3.2.4)
-    combustion (1.3.0)
+    combustion (1.3.1)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.8)
     crass (1.0.6)
-    erubi (1.9.0)
-    i18n (1.8.5)
+    erubi (1.10.0)
+    i18n (1.8.7)
       concurrent-ruby (~> 1.0)
-    loofah (2.6.0)
+    loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
+    mini_portile2 (2.5.0)
+    minitest (5.14.3)
     minitest-autotest (1.1.1)
       minitest-server (~> 1.0)
       path_expander (~> 1.0)
@@ -58,13 +58,16 @@ GEM
       minitest (>= 4, < 6)
     minitest-server (1.0.6)
       minitest (~> 5.0)
+    mocha (1.12.0)
     multi_json (1.15.0)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    nokogiri (1.11.1)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
       ast (~> 2.4.1)
     path_expander (1.1.0)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -73,35 +76,34 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.3.2)
-      actionpack (= 6.0.3.2)
-      activesupport (= 6.0.3.2)
+    railties (6.1.1)
+      actionpack (= 6.1.1)
+      activesupport (= 6.1.1)
       method_source
       rake (>= 0.8.7)
-      thor (>= 0.20.3, < 2.0)
+      thor (~> 1.0)
     rainbow (3.0.0)
-    rake (12.3.3)
-    regexp_parser (1.7.1)
+    rake (13.0.3)
+    regexp_parser (2.0.3)
     rexml (3.2.4)
-    rubocop (0.89.0)
+    rubocop (1.8.1)
       parallel (~> 1.10)
-      parser (>= 2.7.1.1)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.7)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 0.1.0, < 1.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.3.0)
-      parser (>= 2.7.1.4)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
     sqlite3 (1.4.2)
     thor (1.0.1)
-    thread_safe (0.3.6)
-    tzinfo (1.2.7)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.7.0)
-    zeitwerk (2.4.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -112,7 +114,8 @@ DEPENDENCIES
   minitest
   minitest-autotest
   minitest-focus
-  rake (~> 12.0)
+  mocha
+  rake (~> 13.0)
   rubocop
   sqlite3
   stance!

data/README.md

@@ -1,6 +1,14 @@
-# Stance - Simple Events for Rails apps
+# Stance - Simple & Explicit Events for Rails apps
+
+## Usage
 
 ```ruby
+# Your model
+class Appointment < ActiveRecord::Base
+  include Stance::Eventable
+end
+
+# Define your events
 class AppointmentEvents < Stance::Events
   # Define events.
   event :my_event
@@ -13,6 +21,9 @@ class AppointmentEvents < Stance::Events
   # Singleton event: only one active event with this name can exist for the same subject.
   event :my_event, singleton: true
 
+  # By default, events are recorded in the database, unless you set the `record` option to false,
+  event :my_recordless_event, record: true
+
   # Will be called before/after each event in this class. Have access to the event `subject` and
   # `record`.
   before_create :do_something_before
@@ -32,6 +43,35 @@ Appointment.find(1).publish_event 'offers.create'
 Appointment.find(1).publish_event :event_with_metadata, foo: :bah
 ```
 
+### ActiveRecord Callbacks
+
+Stance comes with a couple of opt-in modules to help ease your Callback spaghetti...
+
+```ruby
+class Appointment < ActiveRecord::Base
+  include Stance::Eventable
+  include Stance::ActiveRecordCallbacks
+end
+
+class AppointmentEvents < Stance::Events
+  include Stance::ActiveRecordEvents
+end
+
+# Now all your model callbacks will trigger an event of the same name, where any public methods
+# defined will be called.
+class AppointmentEvents::AfterCreate < Stance::Event
+  include Stance::ActiveRecordEvents
+
+  # This method will be called upon the :after_create callback of the Appointment model.
+  def do_something;end
+
+  private
+
+    # Private methods will not be called by the callback.
+    def my_private_method;end
+end
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/stance.rb

@@ -19,4 +19,6 @@ module Stance
   autoload :Events, 'stance/events'
   autoload :Event, 'stance/event'
   autoload :Eventable, 'stance/eventable'
+  autoload :ActiveRecordCallbacks, 'stance/active_record_callbacks'
+  autoload :ActiveRecordEvents, 'stance/active_record_events'
 end

data/lib/stance/active_record_callbacks.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Stance
+  module ActiveRecordCallbacks
+    extend ActiveSupport::Concern
+
+    CALLBACKS = %i[before_validation after_validation before_save before_create
+                   after_create before_update after_update before_destroy after_destroy after_save
+                   after_touch after_commit after_save_commit after_create_commit
+                   after_update_commit after_destroy_commit after_rollback].freeze
+
+    included do
+      CALLBACKS.each do |cb|
+        send(cb) { publish_event cb }
+      end
+    end
+  end
+end

data/lib/stance/active_record_events.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Stance
+  module ActiveRecordEvents
+    extend ActiveSupport::Concern
+
+    included do
+      with_options record: false do
+        Stance::ActiveRecordCallbacks::CALLBACKS.each { |ev| event(ev) }
+      end
+    end
+  end
+end

data/lib/stance/event.rb

@@ -20,16 +20,25 @@ module Stance
     end
 
     def initialize(name, subject, metadata, options)
-      @options = { singleton: false }.merge(options)
+      @options = { singleton: false, record: true }.merge(options)
       @record = Stance::EventRecord.new(name: name, subject: subject, metadata: metadata)
     end
 
     def create
       return self if singleton_exists?
 
+      Rails.logger.info "Event: #{full_name}"
+
       Stance::EventRecord.transaction do
         run_callbacks :create do
-          record.save
+          # Call each public method of the Event class if a custom class.
+          if self.class.name != 'Stance::Event'
+            (public_methods(false) - Stance::Event.instance_methods(false)).each do |method|
+              send method
+            end
+          end
+
+          record.save if @options[:record]
         end
       end
 

data/lib/stance/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stance
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/stance.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary       = 'Event System for Rails'
   spec.homepage      = 'https://github.com/joelmoss/stance'
   spec.license       = 'MIT'
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7.0')
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stance
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Joel Moss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-24 00:00:00.000000000 Z
+date: 2021-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -74,6 +74,8 @@ files:
 - lib/generators/stance/install_generator.rb
 - lib/generators/stance/templates/migration.rb.tt
 - lib/stance.rb
+- lib/stance/active_record_callbacks.rb
+- lib/stance/active_record_events.rb
 - lib/stance/engine.rb
 - lib/stance/event.rb
 - lib/stance/eventable.rb
@@ -95,14 +97,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Event System for Rails