stance 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 593f0e612e270f03cdacbe2338c181287094558be03d721588db3ab54b094f52
-  data.tar.gz: 20fb411cd404fa4762e195c44a4a730670ea07862499d50b12f855b41d97cc22
+  metadata.gz: 4da3d0518f890cfeff617a5751efd1cfa9267735425489cd60fda3cc756fb7c3
+  data.tar.gz: 63ed6c237aba36901be39c205b86f27339c2adc950a119a02eb70be8d9313827
 SHA512:
-  metadata.gz: cdd07c0676ff44d4ebf2137747d573992c7dc7015c00b3520452aa2478aad46fc4bbf94b8c9d22cd90380a10dad9be96ab091945e1842e3f0529c2d7f70641ab
-  data.tar.gz: 1b1939a3e0b0686172b4a0edf7fa91cea2fac0a5c7257a18f7003f117bd43674d772692643f9d8bfdc96776a8f00eb8c451b6451a9c911e18673e591942245ce
+  metadata.gz: 95260c2c651deebe0b4f00f667d9961c88128100e5d56cb5f956ae098af00e0421f35fdcbccf17ddd4fea63a8f5050206560c69c3daea18961b5a5501c364338
+  data.tar.gz: 6c72c0b24be0c1a2ad4c5943914ee74c24ed9b1c3d70a5581429f445a81c27d183473a36885fe1ba0bf72afea929062c14107be489d65edd75413ac85c34a54d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stance (0.1.0)
+    stance (0.2.0)
       activerecord (>= 5)
       multi_json
       railties (>= 5)
@@ -43,7 +43,7 @@ GEM
     concurrent-ruby (1.1.6)
     crass (1.0.6)
     erubi (1.9.0)
-    i18n (1.8.3)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     loofah (2.6.0)
       crass (~> 1.0.2)
@@ -58,8 +58,8 @@ GEM
       minitest (>= 4, < 6)
     minitest-server (1.0.6)
       minitest (~> 5.0)
-    multi_json (1.14.1)
-    nokogiri (1.10.9)
+    multi_json (1.15.0)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
     parallel (1.19.2)
     parser (2.7.1.4)
@@ -83,17 +83,17 @@ GEM
     rake (12.3.3)
     regexp_parser (1.7.1)
     rexml (3.2.4)
-    rubocop (0.86.0)
+    rubocop (0.89.0)
       parallel (~> 1.10)
-      parser (>= 2.7.0.1)
+      parser (>= 2.7.1.1)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.7)
       rexml
-      rubocop-ast (>= 0.0.3, < 1.0)
+      rubocop-ast (>= 0.1.0, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
+    rubocop-ast (0.3.0)
+      parser (>= 2.7.1.4)
     ruby-progressbar (1.10.1)
     sqlite3 (1.4.2)
     thor (1.0.1)
@@ -101,7 +101,7 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -10,25 +10,26 @@ class AppointmentEvents < Stance::Events
   event 'offers.create'
   event 'offers.delete'
 
-  # Singleton event: only one event with this name can exist for the same subject.
+  # Singleton event: only one active event with this name can exist for the same subject.
   event :my_event, singleton: true
 
+  # Will be called before/after each event in this class. Have access to the event `subject` and
+  # `record`.
+  before_create :do_something_before
+  after_create :do_something_after
+
   # Optionally, create a class for an event.
   class SomeEvent < Stance::Event
-    # Return false if you do not want the event to be created.
-    def callable?
-      false
-    end
-
-    def call
-      # do something when the event is created.
-    end
+    # Define optional callbacks which have access to the `subject` and event `record`.
+    before_create :do_something_before
+    after_create :do_something_after
   end
 end
 
 # Publish events from the model
 Appointment.find(1).publish_event :some_event
 Appointment.find(1).publish_event 'offers.create'
+Appointment.find(1).publish_event :event_with_metadata, foo: :bah
 ```
 
 ## Installation

data/lib/stance/event.rb

@@ -2,29 +2,49 @@
 
 module Stance
   class Event
+    include ActiveSupport::Callbacks
+
+    define_callbacks :create
     attr_reader :record, :options
 
     delegate :subject, :name, to: :record
 
+    class << self
+      def before_create(*methods, &block)
+        set_callback :create, :before, *methods, &block
+      end
+
+      def after_create(*methods, &block)
+        set_callback :create, :after, *methods, &block
+      end
+    end
+
     def initialize(name, subject, metadata, options)
       @options = { singleton: false }.merge(options)
       @record = Stance::EventRecord.new(name: name, subject: subject, metadata: metadata)
     end
 
-    def valid?
-      # If event is a singleton, check there is no other active event with the same name. If there
-      # is, return false.
-      return false if options[:singleton] && subject.events.active.exists?(name: name)
+    def create
+      return self if singleton_exists?
+
+      Stance::EventRecord.transaction do
+        run_callbacks :create do
+          record.save
+        end
+      end
 
-      callable? && record.save
+      self
     end
 
-    def callable?
-      true
+    def full_name
+      "#{subject.model_name.singular}.#{name}"
     end
 
-    def call
-      true
+    private
+
+    # Event is a singleton and already exists.
+    def singleton_exists?
+      options[:singleton] && subject.events.active.exists?(name: name)
     end
   end
 end

data/lib/stance/eventable.rb

@@ -21,8 +21,8 @@ module Stance
       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])
 
-      Stance::EventRecord.transaction do
-        ev.valid? && ev.call
+      events_class.new(ev).run_callbacks :create do
+        ev.create
       end
     end
 

data/lib/stance/events.rb

@@ -2,6 +2,12 @@
 
 module Stance
   class Events
+    include ActiveSupport::Callbacks
+
+    attr_reader :event
+
+    define_callbacks :create
+
     class << self
       attr_reader :events
 
@@ -9,6 +15,18 @@ module Stance
         @events ||= {}
         @events[name.to_s] = options
       end
+
+      def before_create(*methods, &block)
+        set_callback :create, :before, *methods, &block
+      end
+
+      def after_create(*methods, &block)
+        set_callback :create, :after, *methods, &block
+      end
+    end
+
+    def initialize(event)
+      @event = event
     end
   end
 end

data/lib/stance/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stance
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joel Moss
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2020-08-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord