stance 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5dcb8d2d1f3afe7451a48687ab8ce7c2f073b0dc9645cf958ecdb38c6673f2b
-  data.tar.gz: 756df16a830baf56ab25bcb4ee6f027f15c13ff9908516f0c1dae1b98f761b1a
+  metadata.gz: 3e3331680d4153bfa8cefa453b03db38cc87ad2ee34e5413790e70fca91e9626
+  data.tar.gz: aaf358e5b0a7f9f42c08df1860b5410536a591ee61525ab24e8449714c257d00
 SHA512:
-  metadata.gz: a770f62d1a8e6d6c58f1f2643dc6bd5403f957bcfb350bc5696ceca50dde989462f45ff317754602735445bffb43797db7452110f604c3304f67b5ab10cb63c9
-  data.tar.gz: 850c0b54c13ea154307a9788e21e3670e42ec06fa17628682aa206b1cbb7de12a741d46689c783ca9a9dc43fbf02a212473fffce8ea1c41842393fa0be5720d1
+  metadata.gz: 3f98996364a4ebd043d9718e9c0ef7052bbc0fd03048376f66736c686c2d05fd97a1cec05833ad809e8a48361e90e8af33ac01c33a87863865916a3dbd98bd4c
+  data.tar.gz: 970e10e13187da5d36c3d7dff886c9c1d4971b539ef0c57d180f56a029f2987f3231b5851c377e9b9c7d0eb94bd1cece8a32a7777a594df8ae093c3bccd5609b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stance (0.3.0)
+    stance (0.4.0)
       activerecord (>= 5)
       multi_json
       railties (>= 5)

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/event.rb

@@ -20,8 +20,15 @@ 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
@@ -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.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stance
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Joel Moss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord