stance 0.7.1 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8a52e7f6f462c2b557f5763b3d1645d9aa13a051191d159ac90de8948426984
-  data.tar.gz: 17c2a9bd54eca8ff156a433a6a68f879935585eeaa361f28dfebe31db1e03dac
+  metadata.gz: 369e98673ef67283f9b65048d4a5163eb1de066fac3178554e78c8fbd720dc41
+  data.tar.gz: 4cfdcd75169331697db547c7e922ee2f61dc4aa472b8de6f4dab522ee6038ed1
 SHA512:
-  metadata.gz: 552521138c55d553836d1e155738dd1ee2a510b45c1540009d68992572d2c151e40303de7360896e12747356ec194e0a84ad62ead166eaa5e4a771e8a71ab569
-  data.tar.gz: d0d2364d726ee0dd5c7c56b073e161e0c492c82e138a1c01bf300ecadf6c3d3eb99d837b2bb9d84fd1e1a23b03c04de3350e49b7e25dbf4000357d6aaf16bb1f
+  metadata.gz: e2d23c6aa87c81f4fd6d60472aad3e5ac9fbfd93731e06e7da10dc5f9ea3796f90a6ea94f36beec46fac829474b70eaa909e836a0b91a9c30f959ffcb89704bf
+  data.tar.gz: beee74748db0d933c8af8a209ecf2e99d226df1d07f4c731cdd7ba917cdb2ce605f983eef994dda9e19bf0c530c6977570a360e1fac5cc13813313ca1057888b

data/.gitignore

@@ -6,5 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
-/test/internal/db/*.sqlite
+/test/internal/db/*.sqlite*
 .DS_Store

data/.rubocop.yml

@@ -8,3 +8,5 @@ Metrics/MethodLength:
   Max: 15
 Style/ClassVars:
   Enabled: false
+Metrics/AbcSize:
+  Max: 20

data/Gemfile.lock

@@ -1,115 +1,235 @@
 PATH
   remote: .
   specs:
-    stance (0.6.0)
-      activerecord (>= 6)
-      multi_json
-      railties (>= 6)
+    stance (0.8.1)
+      multi_json (~> 1.15)
+      rails (>= 7.0, < 8.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.0.3.1)
-      actionview (= 7.0.3.1)
-      activesupport (= 7.0.3.1)
-      rack (~> 2.0, >= 2.2.0)
+    actioncable (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+      zeitwerk (~> 2.6)
+    actionmailbox (7.1.2)
+      actionpack (= 7.1.2)
+      activejob (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.1.2)
+      actionpack (= 7.1.2)
+      actionview (= 7.1.2)
+      activejob (= 7.1.2)
+      activesupport (= 7.1.2)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.2)
+    actionpack (7.1.2)
+      actionview (= 7.1.2)
+      activesupport (= 7.1.2)
+      nokogiri (>= 1.8.5)
+      racc
+      rack (>= 2.2.4)
+      rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (7.0.3.1)
-      activesupport (= 7.0.3.1)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    actiontext (7.1.2)
+      actionpack (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
+    actionview (7.1.2)
+      activesupport (= 7.1.2)
       builder (~> 3.1)
-      erubi (~> 1.4)
-      rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activerecord (7.0.3.1)
-      activemodel (= 7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activesupport (7.0.3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activejob (7.1.2)
+      activesupport (= 7.1.2)
+      globalid (>= 0.3.6)
+    activemodel (7.1.2)
+      activesupport (= 7.1.2)
+    activerecord (7.1.2)
+      activemodel (= 7.1.2)
+      activesupport (= 7.1.2)
+      timeout (>= 0.4.0)
+    activestorage (7.1.2)
+      actionpack (= 7.1.2)
+      activejob (= 7.1.2)
+      activerecord (= 7.1.2)
+      activesupport (= 7.1.2)
+      marcel (~> 1.0)
+    activesupport (7.1.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
     autotest-suffix (1.1.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.5)
     builder (3.2.4)
     combustion (1.3.7)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     crass (1.0.6)
-    erubi (1.10.0)
-    i18n (1.11.0)
+    date (3.3.4)
+    drb (2.2.0)
+      ruby2_keywords
+    erubi (1.12.0)
+    globalid (1.2.1)
+      activesupport (>= 6.1)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json (2.6.2)
-    loofah (2.18.0)
+    io-console (0.7.1)
+    irb (1.11.0)
+      rdoc
+      reline (>= 0.3.8)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    loofah (2.22.0)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    method_source (1.0.0)
-    mini_portile2 (2.8.0)
-    minitest (5.16.2)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
+      mini_mime (>= 0.1.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.2)
+    mini_mime (1.1.5)
+    mini_portile2 (2.8.5)
+    minitest (5.20.0)
     minitest-autotest (1.1.1)
       minitest-server (~> 1.0)
       path_expander (~> 1.0)
-    minitest-focus (1.3.1)
+    minitest-focus (1.4.0)
       minitest (>= 4, < 6)
-    minitest-server (1.0.6)
-      minitest (~> 5.0)
-    mocha (1.14.0)
+    minitest-server (1.0.7)
+      minitest (~> 5.16)
+    mocha (2.1.0)
+      ruby2_keywords (>= 0.0.5)
     multi_json (1.15.0)
-    nokogiri (1.13.7)
-      mini_portile2 (~> 2.8.0)
+    mutex_m (0.2.0)
+    net-imap (0.4.9.1)
+      date
+      net-protocol
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.2.2)
+      timeout
+    net-smtp (0.4.0.1)
+      net-protocol
+    nio4r (2.7.0)
+    nokogiri (1.16.0)
+      mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    parallel (1.24.0)
+    parser (3.3.0.2)
       ast (~> 2.4.1)
+      racc
     path_expander (1.1.1)
-    racc (1.6.0)
-    rack (2.2.4)
-    rack-test (2.0.2)
+    psych (5.1.2)
+      stringio
+    racc (1.7.3)
+    rack (3.0.8)
+    rack-session (2.0.0)
+      rack (>= 3.0.0)
+    rack-test (2.1.0)
       rack (>= 1.3)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+    rackup (2.1.0)
+      rack (>= 3)
+      webrick (~> 1.8)
+    rails (7.1.2)
+      actioncable (= 7.1.2)
+      actionmailbox (= 7.1.2)
+      actionmailer (= 7.1.2)
+      actionpack (= 7.1.2)
+      actiontext (= 7.1.2)
+      actionview (= 7.1.2)
+      activejob (= 7.1.2)
+      activemodel (= 7.1.2)
+      activerecord (= 7.1.2)
+      activestorage (= 7.1.2)
+      activesupport (= 7.1.2)
+      bundler (>= 1.15.0)
+      railties (= 7.1.2)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.3)
-      loofah (~> 2.3)
-    railties (7.0.3.1)
-      actionpack (= 7.0.3.1)
-      activesupport (= 7.0.3.1)
-      method_source
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    railties (7.1.2)
+      actionpack (= 7.1.2)
+      activesupport (= 7.1.2)
+      irb
+      rackup (>= 1.0.0)
       rake (>= 12.2)
-      thor (~> 1.0)
-      zeitwerk (~> 2.5)
+      thor (~> 1.0, >= 1.2.2)
+      zeitwerk (~> 2.6)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rubocop (1.31.1)
+    rake (13.1.0)
+    rdoc (6.6.2)
+      psych (>= 4.0.0)
+    regexp_parser (2.8.3)
+    reline (0.4.2)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rubocop (1.59.0)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.2.4)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.18.0, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
-    rubocop-minitest (0.20.1)
-      rubocop (>= 0.90, < 2.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    rubocop-minitest (0.34.3)
+      rubocop (>= 1.39, < 2.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
     rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-    ruby-progressbar (1.11.0)
-    sqlite3 (1.4.4)
-    thor (1.2.1)
-    tzinfo (2.0.4)
+    ruby-progressbar (1.13.0)
+    ruby2_keywords (0.0.5)
+    sqlite3 (1.7.0)
+      mini_portile2 (~> 2.8.0)
+    stringio (3.1.0)
+    thor (1.3.0)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.2.0)
-    zeitwerk (2.6.0)
+    unicode-display_width (2.5.0)
+    webrick (1.8.1)
+    websocket-driver (0.7.6)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.6.12)
 
 PLATFORMS
   ruby

data/lib/stance/engine.rb

@@ -5,11 +5,5 @@ require 'rails'
 module Stance
   class Engine < ::Rails::Engine
     isolate_namespace Stance
-
-    # initializer 'active_record.include_event_concern' do
-    #   ActiveSupport.on_load(:active_record) do
-    #     ActiveRecord::Base.include Stance::EventConcern
-    #   end
-    # end
   end
 end

data/lib/stance/event.rb

@@ -5,9 +5,7 @@ module Stance
     include ActiveSupport::Callbacks
 
     define_callbacks :create
-    attr_reader :record, :options
-
-    delegate :subject, :name, to: :record
+    attr_reader :record, :options, :name
 
     class << self
       def before_create(*methods, &block)
@@ -20,14 +18,22 @@ module Stance
     end
 
     def initialize(name, subject, metadata, options)
+      @subject = subject
+      @name = name
+      @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
+      if subject.is_a?(ActiveRecord::Base)
         attrs[:subject] = subject
+      elsif subject.is_a?(Class) && subject < ActiveRecord::Base
+        attrs[:subject_type] = subject.name
+      else
+        @options[:record] = false
       end
+
+      return unless @options[:record]
+
       @record = Stance::EventRecord.new(attrs)
     end
 
@@ -40,9 +46,7 @@ module Stance
           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
+            callback_methods.each { |method| send method }
           end
 
           record.save if @options[:record]
@@ -53,11 +57,19 @@ module Stance
     end
 
     def full_name
-      "#{record.subject_type.downcase}.#{name}"
+      "#{subject.class.name.downcase}.#{name}"
+    end
+
+    def subject
+      try(:record)&.subject || @subject
     end
 
     private
 
+    def callback_methods
+      public_methods(false) - Stance::Event.instance_methods(false)
+    end
+
     # Event is a singleton and already exists.
     def singleton_exists?
       options[:singleton] && subject.events.active.exists?(name: name)

data/lib/stance/eventable.rb

@@ -5,24 +5,26 @@ module Stance
     extend ActiveSupport::Concern
 
     included do
-      has_many :events, as: :subject, class_name: 'Stance::EventRecord'
+      has_many :events, as: :subject, class_name: 'Stance::EventRecord' if respond_to?(:has_many)
     end
 
     class_methods do
-      def publish_event(name, metadata = {})
+      # An event class may also exist in one or more namespaces (see `Stance.config.namespaces`).
+      # The event will be published to all classes that define the event class, and the class which
+      # defined the event takes priority.
+      def publish_event(name, metadata = {}, subject = self)
         name = name.to_s
-        ensure_event! name
+        subject.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])
+        # Find the Event class - if any - and initialize it. Falls back to Stance::Event.
+        ev = subject.event_class(name)
+                    .new(name, subject, metadata, subject.events_class.events[name])
 
         return ev if Stance.disabled_events.include?(ev.full_name)
 
-        events_class.new(ev).run_callbacks(:create) { ev.create }
+        subject.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] }
@@ -35,7 +37,7 @@ module Stance
       end
 
       def events_class_name
-        @events_class_name ||= "#{model_name.name}Events"
+        @events_class_name ||= "#{name}Events"
       end
 
       def event_class(name)
@@ -51,22 +53,14 @@ module Stance
     #
     # Returns the results of `call`ing the event class.
     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, 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 }
+      self.class.publish_event name, metadata, self
     end
 
     # Raise EventNotFound if the event has not been defined.
     def ensure_event!(name)
       return if events_class.events.one? { |event, options| name == event && !options[:class] }
 
-      raise Stance::EventNotFound, "Event `#{name}` not found"
+      raise Stance::EventNotFound, "Event `#{name}` not found in #{events_class}"
     end
 
     def events_class
@@ -74,9 +68,10 @@ module Stance
     end
 
     def events_class_name
-      @events_class_name ||= "#{model_name.name}Events"
+      @events_class_name ||= "#{self.class.name}Events"
     end
 
+    # The class which defines the event. There will be only one.
     def event_class(name)
       "#{events_class_name}::#{name.tr('.', '/').classify}".constantize
     rescue NameError

data/lib/stance/events.rb

@@ -9,11 +9,21 @@ module Stance
     define_callbacks :create
 
     class << self
-      attr_reader :events
+      attr_accessor :events
+
+      def inherited(child)
+        @events ||= {}
+        child.events ||= @events.dup
+        super
+      end
 
       def event(name, options = {})
         @events ||= {}
-        @events[name.to_s] = options
+        sname = name.to_s
+
+        raise DuplicateEvent, "Cannot redefine event :#{sname} on #{self}" if @events.key?(sname)
+
+        @events[sname] = options
       end
 
       def before_create(*methods, &block)

data/lib/stance/version.rb

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

data/lib/stance.rb

@@ -4,7 +4,9 @@ require 'stance/version'
 require 'stance/engine'
 
 module Stance
-  class EventNotFound < StandardError; end
+  class Error < StandardError; end
+  class EventNotFound < Error; end
+  class DuplicateEvent < Error; end
 
   mattr_accessor :disabled_events
   @@disabled_events = []

data/stance.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
   spec.metadata['changelog_uri'] = "#{spec.homepage}/releases"
+  spec.metadata['rubygems_mfa_required'] = 'true'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -24,8 +25,6 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord', '>= 6'
-  spec.add_dependency 'multi_json'
-  spec.add_dependency 'railties', '>= 6'
-  spec.metadata['rubygems_mfa_required'] = 'true'
+  spec.add_dependency 'multi_json', '~> 1.15'
+  spec.add_dependency 'rails', ['>= 7.0', '< 8.0']
 end

metadata

@@ -1,57 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: stance
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.1
 platform: ruby
 authors:
 - Joel Moss
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
-  name: railties
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 description:
 email:
 - joel@developwithstyle.com
@@ -105,7 +97,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Event System for Rails