stance 0.4.0 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5dcb8d2d1f3afe7451a48687ab8ce7c2f073b0dc9645cf958ecdb38c6673f2b
-  data.tar.gz: 756df16a830baf56ab25bcb4ee6f027f15c13ff9908516f0c1dae1b98f761b1a
+  metadata.gz: e0a1f7dabcadb5940fbff6909c98d24b60f1f1c50536be7e0219f77d07cd2412
+  data.tar.gz: 02a1ed28bb48015bed11b026c32528a5d473ac9ce8befb1efd66913dcf141b8f
 SHA512:
-  metadata.gz: a770f62d1a8e6d6c58f1f2643dc6bd5403f957bcfb350bc5696ceca50dde989462f45ff317754602735445bffb43797db7452110f604c3304f67b5ab10cb63c9
-  data.tar.gz: 850c0b54c13ea154307a9788e21e3670e42ec06fa17628682aa206b1cbb7de12a741d46689c783ca9a9dc43fbf02a212473fffce8ea1c41842393fa0be5720d1
+  metadata.gz: bad97f4ed5bf8da34ea4c875c833afd64207f841565199c4ae9c61237562bc633a75aabb0d714fccd1182050842270cd334f4692762496be6591eef68cc7c831
+  data.tar.gz: bb09581a78c3aad7989720e2076a88a31986cc7205dba12b9658adfd26f3744f61693528420d2f2769a4dd23b410ce4e6f684d68d21527a973a6b429d04c2c9e

data/.rubocop.yml

@@ -5,4 +5,6 @@ Style/Documentation:
 Layout/LineLength:
   Max: 100
 Metrics/MethodLength:
-  Max: 12
+  Max: 15
+Style/ClassVars:
+  Enabled: false

data/Gemfile

@@ -13,4 +13,6 @@ gem 'minitest-focus'
 gem 'mocha'
 gem 'rake', '~> 13.0'
 gem 'rubocop'
+gem 'rubocop-minitest'
+gem 'rubocop-rake'
 gem 'sqlite3'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stance (0.3.0)
+    stance (0.5.2)
       activerecord (>= 5)
       multi_json
       railties (>= 5)
@@ -9,62 +9,62 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.1.1)
-      actionview (= 6.1.1)
-      activesupport (= 6.1.1)
+    actionpack (6.1.4)
+      actionview (= 6.1.4)
+      activesupport (= 6.1.4)
       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.1.1)
-      activesupport (= 6.1.1)
+    actionview (6.1.4)
+      activesupport (= 6.1.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.1.1)
-      activesupport (= 6.1.1)
-    activerecord (6.1.1)
-      activemodel (= 6.1.1)
-      activesupport (= 6.1.1)
-    activesupport (6.1.1)
+    activemodel (6.1.4)
+      activesupport (= 6.1.4)
+    activerecord (6.1.4)
+      activemodel (= 6.1.4)
+      activesupport (= 6.1.4)
+    activesupport (6.1.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    ast (2.4.1)
+    ast (2.4.2)
     autotest-suffix (1.1.0)
     builder (3.2.4)
     combustion (1.3.1)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     crass (1.0.6)
     erubi (1.10.0)
-    i18n (1.8.7)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.9.0)
+    loofah (2.10.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
-    mini_portile2 (2.5.0)
-    minitest (5.14.3)
+    mini_portile2 (2.5.3)
+    minitest (5.14.4)
     minitest-autotest (1.1.1)
       minitest-server (~> 1.0)
       path_expander (~> 1.0)
-    minitest-focus (1.2.1)
+    minitest-focus (1.3.1)
       minitest (>= 4, < 6)
     minitest-server (1.0.6)
       minitest (~> 5.0)
-    mocha (1.12.0)
+    mocha (1.13.0)
     multi_json (1.15.0)
-    nokogiri (1.11.1)
+    nokogiri (1.11.7)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
     parallel (1.20.1)
-    parser (3.0.0.0)
+    parser (3.0.2.0)
       ast (~> 2.4.1)
     path_expander (1.1.0)
     racc (1.5.2)
@@ -76,30 +76,34 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.1.1)
-      actionpack (= 6.1.1)
-      activesupport (= 6.1.1)
+    railties (6.1.4)
+      actionpack (= 6.1.4)
+      activesupport (= 6.1.4)
       method_source
-      rake (>= 0.8.7)
+      rake (>= 0.13)
       thor (~> 1.0)
     rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.0.3)
-    rexml (3.2.4)
-    rubocop (1.8.1)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.18.3)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.0)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    rubocop-minitest (0.14.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     sqlite3 (1.4.2)
-    thor (1.0.1)
+    thor (1.1.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.0.0)
@@ -117,8 +121,10 @@ DEPENDENCIES
   mocha
   rake (~> 13.0)
   rubocop
+  rubocop-minitest
+  rubocop-rake
   sqlite3
   stance!
 
 BUNDLED WITH
-   2.1.4
+   2.2.18

data/README.md

@@ -22,7 +22,10 @@ class AppointmentEvents < Stance::Events
   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
+  event :my_recordless_event, record: false
+
+  # You can define a class event, which is published on the class instead of the instance.
+  event :my_class_event, class: true
 
   # Will be called before/after each event in this class. Have access to the event `subject` and
   # `record`.
@@ -41,6 +44,7 @@ end
 Appointment.find(1).publish_event :some_event
 Appointment.find(1).publish_event 'offers.create'
 Appointment.find(1).publish_event :event_with_metadata, foo: :bah
+Appointment.publish_event :my_class_event
 ```
 
 ### ActiveRecord Callbacks

data/app/models/stance/event_record.rb

@@ -36,7 +36,7 @@ module Stance
     end
 
     def event_class_name
-      @event_class_name ||= "#{subject.model_name.name}Events::#{name.tr('.', '/').classify}"
+      @event_class_name ||= "#{subject_type}Events::#{name.tr('.', '/').classify}"
     end
 
     def event_class

data/lib/stance/active_record_callbacks.rb

@@ -4,7 +4,7 @@ module Stance
   module ActiveRecordCallbacks
     extend ActiveSupport::Concern
 
-    CALLBACKS = %i[before_validation after_validation before_save before_create
+    CALLBACKS = %i[after_initialize 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

data/lib/stance/event.rb

@@ -20,19 +20,26 @@ module Stance
     end
 
     def initialize(name, subject, metadata, options)
-      @options = { singleton: false, record: true }.merge(options)
-      @record = Stance::EventRecord.new(name: name, subject: subject, metadata: metadata)
+      @options = { singleton: false, record: true, class: false }.merge(options)
+
+      attrs = { name: name, metadata: metadata }
+      if subject.is_a?(String)
+        attrs[:subject_type] = subject
+      else
+        attrs[:subject] = subject
+      end
+      @record = Stance::EventRecord.new(attrs)
     end
 
     def create
       return self if singleton_exists?
 
-      Rails.logger.info "Event: #{full_name}"
-
       Stance::EventRecord.transaction do
         run_callbacks :create do
           # Call each public method of the Event class if a custom class.
           if self.class.name != 'Stance::Event'
+            Rails.logger.info "Event: #{full_name}"
+
             (public_methods(false) - Stance::Event.instance_methods(false)).each do |method|
               send method
             end
@@ -46,7 +53,7 @@ module Stance
     end
 
     def full_name
-      "#{subject.model_name.singular}.#{name}"
+      "#{record.subject_type.downcase}.#{name}"
     end
 
     private

data/lib/stance/eventable.rb

@@ -8,6 +8,43 @@ module Stance
       has_many :events, as: :subject, class_name: 'Stance::EventRecord'
     end
 
+    class_methods do
+      def publish_event(name, metadata = {})
+        name = name.to_s
+        ensure_event! name
+
+        # Find the Event class - if any - and call it. Falls back to Stance::Event.
+        ev = event_class(name).new(name, model_name.name, metadata, events_class.events[name])
+
+        return ev if Stance.disabled_events.include?(ev.full_name)
+
+        events_class.new(ev).run_callbacks(:create) { ev.create }
+      end
+
+      private
+
+      # Raise EventNotFound if the class event has not been defined.
+      def ensure_event!(name)
+        return if events_class.events.one? { |event, options| name == event && options[:class] }
+
+        raise Stance::EventNotFound, "Class event `#{name}` not found"
+      end
+
+      def events_class
+        @events_class ||= events_class_name.constantize
+      end
+
+      def events_class_name
+        @events_class_name ||= "#{model_name.name}Events"
+      end
+
+      def event_class(name)
+        name.constantize
+      rescue NameError
+        Stance::Event
+      end
+    end
+
     # Publish an event.
     #
     # Creates an EventRecord with the given `name`, `metadata` and self as the 'subject'.
@@ -18,19 +55,16 @@ module Stance
       ensure_event! name
 
       # Find the Event class - if any - and call it. Falls back to Stance::Event.
-      event_class_name = "#{events_class_name}::#{name.to_s.tr('.', '/').classify}"
-      ev = event_class(event_class_name).new(name, self, metadata, events_class.events[name])
+      ev = event_class(name).new(name, self, metadata, events_class.events[name])
 
       return ev if Stance.disabled_events.include?(ev.full_name)
 
       events_class.new(ev).run_callbacks(:create) { ev.create }
     end
 
-    private
-
     # Raise EventNotFound if the event has not been defined.
     def ensure_event!(name)
-      return if events_class.events.keys.include?(name)
+      return if events_class.events.one? { |event, options| name == event && !options[:class] }
 
       raise Stance::EventNotFound, "Event `#{name}` not found"
     end
@@ -44,7 +78,7 @@ module Stance
     end
 
     def event_class(name)
-      name.constantize
+      "#{events_class_name}::#{name.tr('.', '/').classify}".constantize
     rescue NameError
       Stance::Event
     end

data/lib/stance/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stance
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.3
 platform: ruby
 authors:
 - Joel Moss
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -52,7 +52,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5'
-description: 
+description:
 email:
 - joel@developwithstyle.com
 executables: []
@@ -89,7 +89,7 @@ metadata:
   homepage_uri: https://github.com/joelmoss/stance
   source_code_uri: https://github.com/joelmoss/stance
   changelog_uri: https://github.com/joelmoss/stance/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,8 +104,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Event System for Rails
 test_files: []