stance 0.1.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 593f0e612e270f03cdacbe2338c181287094558be03d721588db3ab54b094f52
-  data.tar.gz: 20fb411cd404fa4762e195c44a4a730670ea07862499d50b12f855b41d97cc22
+  metadata.gz: 6b55abfe34c74dfe170cc5adda3b174c120bc7b953f174c815350145954697de
+  data.tar.gz: 0b407ba5c2fc0f5784ef3489f676f0894d8116211a097096cba8a4c41030c785
 SHA512:
-  metadata.gz: cdd07c0676ff44d4ebf2137747d573992c7dc7015c00b3520452aa2478aad46fc4bbf94b8c9d22cd90380a10dad9be96ab091945e1842e3f0529c2d7f70641ab
-  data.tar.gz: 1b1939a3e0b0686172b4a0edf7fa91cea2fac0a5c7257a18f7003f117bd43674d772692643f9d8bfdc96776a8f00eb8c451b6451a9c911e18673e591942245ce
+  metadata.gz: ff33b9da2fd7cf166f7ecb316c1afe04cc61ffefd140a1c4b8164443258673e2f6c440757e90706700cfd7b2b07a830ac34a8c9f039394308f214e5a246922c3
+  data.tar.gz: 587bdd935ea27aaff3df1201691c21d7340e1fea876c7857c94d17f94af86013816986cd4efbfcefcfc87ac3355fd510c2ea3c1c2e74d02765eeac447cfde9c2

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.1.0)
+    stance (0.5.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.3.1)
+      actionview (= 6.1.3.1)
+      activesupport (= 6.1.3.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.3.1)
+      activesupport (= 6.1.3.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.3.1)
+      activesupport (= 6.1.3.1)
+    activerecord (6.1.3.1)
+      activemodel (= 6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activesupport (6.1.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-      zeitwerk (~> 2.2, >= 2.2.2)
-    ast (2.4.1)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
     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.3)
+    erubi (1.10.0)
+    i18n (1.8.10)
       concurrent-ruby (~> 1.0)
-    loofah (2.6.0)
+    loofah (2.9.1)
       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.4)
     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)
-    multi_json (1.14.1)
-    nokogiri (1.10.9)
-      mini_portile2 (~> 2.4.0)
-    parallel (1.19.2)
-    parser (2.7.1.4)
+    mocha (1.12.0)
+    multi_json (1.15.0)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.1.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.3.1)
+      actionpack (= 6.1.3.1)
+      activesupport (= 6.1.3.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)
-    rexml (3.2.4)
-    rubocop (0.86.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.12.1)
       parallel (~> 1.10)
-      parser (>= 2.7.0.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.0.3, < 1.0)
+      rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (0.0.3)
-      parser (>= 2.7.0.1)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      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.3.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.0.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -112,10 +114,11 @@ DEPENDENCIES
   minitest
   minitest-autotest
   minitest-focus
-  rake (~> 12.0)
+  mocha
+  rake (~> 13.0)
   rubocop
   sqlite3
   stance!
 
 BUNDLED WITH
-   2.1.4
+   2.2.9

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
@@ -10,25 +18,62 @@ 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
 
+  # By default, events are recorded in the database, unless you set the `record` option to false,
+  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`.
+  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
+Appointment.publish_event :my_class_event
+```
+
+### 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

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

@@ -6,7 +6,19 @@ require 'stance/engine'
 module Stance
   class EventNotFound < StandardError; end
 
+  mattr_accessor :disabled_events
+  @@disabled_events = []
+
+  def self.disable(*events)
+    disabled_events.concat events
+    yield
+  ensure
+    self.disabled_events -= events
+  end
+
   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

@@ -2,29 +2,65 @@
 
 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)
+      @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 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?
 
-      callable? && record.save
+      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'
+            (public_methods(false) - Stance::Event.instance_methods(false)).each do |method|
+              send method
+            end
+          end
+
+          record.save if @options[:record]
+        end
+      end
+
+      self
     end
 
-    def callable?
-      true
+    def full_name
+      "#{record.subject_type.downcase}.#{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

@@ -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])
 
-      Stance::EventRecord.transaction do
-        ev.valid? && ev.call
-      end
-    end
+      return ev if Stance.disabled_events.include?(ev.full_name)
 
-    private
+      events_class.new(ev).run_callbacks(:create) { ev.create }
+    end
 
     # 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/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.5.1'
 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.1.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Joel Moss
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-24 00:00:00.000000000 Z
+date: 2021-04-14 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: []
@@ -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
@@ -87,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
@@ -95,15 +97,15 @@ 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
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Event System for Rails
 test_files: []