ventable 1.0.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d49bbdbaf27b03c942ba8887eb4eca4c89f63cbc
-  data.tar.gz: c75ae281c96bfa5998c6f338ba5fd6d5bb164ace
+SHA256:
+  metadata.gz: 6f8a7adee18ece871971236ea00ee70c35c278259fed5cd499c1f3c8d5e097d0
+  data.tar.gz: 4e4137f676a3374e17377db94ede9c59d232358f9bc82e3fbbbf90b817bbe514
 SHA512:
-  metadata.gz: 7d130ab305df24c7f31e1fc11dcf7cc64c560edd2311ff6330ebeb33394ed819e444795b8f6c5fb3aff8ba9371c96c746dbec17db3ac3b368a149891bde5fc0c
-  data.tar.gz: 2f12228bb3d42a58d7534f077844b26c5f1212c104b5da2bbf8aa4facb2f1783f86cfa1abc10e8b08982cbcfd6a07efbd6dd8f8afb9e76e42ecd271e06f07887
+  metadata.gz: 85a2ae18e873826a4ac34790d99ac5ed4f65e9ab2995e71edcf14b7cd78f86507df842c3c78ecafaae8df21e533e4c0fa39f765429ec9992056a776caf7fd4df
+  data.tar.gz: fa01a1e9de8962f299fa332ac542d34389eb853a9ddce5047dd85fbf5897e377a139ac6f598fe2112e9ba20361a8ca5564238ec9c940a203812dbe8d7ad6a806

data/.github/workflows/rubocop.yml

@@ -0,0 +1,36 @@
+name: Rubocop
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+    name: Rubocop
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@ec02537da5712d66d4d50a0f33b7eb52773b5ed1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: Bundle Install
+        run: |
+          bundle check || bundle install -j 5
+
+      - name: Rubocop
+        run: |
+          bundle exec rubocop
+  
+

data/.github/workflows/ruby.yml

@@ -0,0 +1,34 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+name: RSpec
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: bundle
+      run: bundle check || bundle install -j 4
+    - name: RSpecs
+      run: bundle exec rspec --format documentation

data/.gitignore

@@ -1,3 +1,4 @@
+**/.DS_Store
 *.gem
 *.rbc
 .bundle
@@ -5,6 +6,7 @@
 .yardoc
 InstalledFiles
 _yardoc
+Gemfile.lock
 coverage
 doc/
 lib/bundler/man
@@ -15,3 +17,6 @@ test/tmp
 test/version_tmp
 tmp
 .idea/
+vendor/
+.rubocop/cache
+.rubocop-*

data/.rubocop.yml

@@ -0,0 +1,21 @@
+inherit_from:
+  - .rubocop_todo.yml
+  - https://relaxed.ruby.style/rubocop.yml
+
+inherit_mode:
+  merge:
+    - Exclude
+
+require: 
+  - rubocop-rspec
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: '2.7'
+  UseCache: true
+  CacheRootDirectory: ./.rubocop/cache
+  NewCops: enable
+  Exclude:
+    - 'bin/*'
+    - 'vendor/*'
+

data/.rubocop_todo.yml

@@ -0,0 +1,82 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2023-08-28 17:02:07 UTC using RuboCop version 1.56.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'ventable.gemspec'
+
+# Offense count: 11
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/ventable/ventable_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: AllowComments.
+Lint/EmptyClass:
+  Exclude:
+    - 'spec/ventable/ventable_spec.rb'
+
+# Offense count: 2
+Lint/RescueException:
+  Exclude:
+    - 'spec/ventable/ventable_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: Prefixes, AllowedPatterns.
+# Prefixes: when, with, without
+RSpec/ContextWording:
+  Exclude:
+    - 'spec/ventable/ventable_spec.rb'
+
+# Offense count: 7
+# Configuration parameters: CountAsOne.
+RSpec/ExampleLength:
+  Max: 26
+
+# Offense count: 2
+RSpec/ExpectInHook:
+  Exclude:
+    - 'spec/ventable/ventable_spec.rb'
+
+# Offense count: 12
+RSpec/LeakyConstantDeclaration:
+  Exclude:
+    - 'spec/ventable/ventable_spec.rb'
+
+# Offense count: 1
+# Configuration parameters: .
+# SupportedStyles: have_received, receive
+RSpec/MessageSpies:
+  EnforcedStyle: receive
+
+# Offense count: 5
+RSpec/MultipleExpectations:
+  Max: 9
+
+# Offense count: 1
+# Configuration parameters: AllowedGroups.
+RSpec/NestedGroups:
+  Max: 4
+
+# Offense count: 1
+# Configuration parameters: AllowedPatterns.
+# AllowedPatterns: ^expect_, ^assert_
+RSpec/NoExpectationExample:
+  Exclude:
+    - 'spec/ventable/ventable_spec.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+Rake/Desc:
+  Exclude:
+    - 'Rakefile'

data/Gemfile

@@ -1,4 +1,14 @@
-source 'https://rubygems.org'
+# frozen_string_literal: true
 
-# Specify your gem's dependencies in ventable.gemspec
+source 'https://rubygems.org'
 gemspec
+
+gem 'guard-rspec'
+gem "rake"
+gem "rspec"
+gem "rspec-its"
+gem "rspec-mocks"
+gem "rubocop"
+gem "rubocop-rake"
+gem "rubocop-rspec"
+gem "simplecov"

data/Guardfile

@@ -1,15 +1,16 @@
 #!/usr/bin/env ruby
-#^syntax detection
+# frozen_string_literal: true
+
+# ^syntax detection
 
 # A sample Guardfile
 # More info at https://github.com/guard/guard#readme
 
 guard 'rspec' do
-  watch(%r{^ventable\.gemspec}) { "spec"}
+  watch(/^ventable\.gemspec/) { "spec" }
   watch(%r{^lib/(.+)\.rb$}) { "spec" }
 
   watch(%r{^spec/.+_spec\.rb$})
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/spec_helper.rb') { "spec" }
   watch(%r{spec/support/.*}) { "spec" }
 end
-

data/README.md

@@ -1,14 +1,44 @@
-[![Gem Version](https://badge.fury.io/rb/ventable.png)](http://badge.fury.io/rb/ventable)
-[![Build status](https://secure.travis-ci.org/kigster/ventable.png)](http://travis-ci.org/kigster/ventable)
-[![Code Climate](https://codeclimate.com/github/kigster/ventable.png)](https://codeclimate.com/github/kigster/ventable)
+![Gem Version](https://badge.fury.io/rb/ventable.svg)
+[![Gitter](https://img.shields.io/gitter/room/gitterHQ/gitter.svg)](https://gitter.im/kigster/ventable)
+![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkigster%2Fventable.svg?type=shield)
 
+[![RSpec](https://github.com/kigster/ventable/actions/workflows/ruby.yml/badge.svg)](https://github.com/kigster/ventable/actions/workflows/ruby.yml)
+[![Rubocop](https://github.com/kigster/ventable/actions/workflows/rubocop.yml/badge.svg)](https://github.com/kigster/ventable/actions/workflows/rubocop.yml)
 
-# Ventable
+# Ventable — Observable Pattern On Steroids
 
-Simple eventing gem that implements Observable pattern, but with more options, ability to group observers and wrap
-them in arbitrary blocks of code.  For example, when a certain event fires, some observers may be called within
-a transaction context, while others maybe called outside of the transaction context.
+This gem is a variation of the [Observer Design Pattern](https://en.wikipedia.org/wiki/Observer_pattern). 
 
+In particular: 
+
+ * Ventable requires creation of simple event classes that may carry data and be serialized.
+ * Observers can be grouped together, and notified within a pre-defined `Proc`. For example, using grouping some observers may be called within the boundaries of a database transaction, while others maybe called outside of it.
+ * Ventable allows both compile time and run time observer binding.
+ * Ventable calls specific method on each observer, using automatically derived method name from the event class. A generic `#handle_event` method is also supported.
+
+Limitations:
+
+ * At the moment, Ventable can only notify observers within the current ruby process.
+ 
+## Plugins
+
+Ventable has several plugins that add various functionality on top of the basic event dispatch mechanism.
+
+ * [ventable-statsd](https://github.com/kigster/ventable-statsd) is an extension that allows notifying Statsd whenever an event occurs.
+ * [simple-feed](https://github.com/kigster/simple-feed) is a generic implementation of the activity feed concept commonly seen on social networks,  and it integrates nicely with Ventable.
+
+## Ruby Versions
+
+This gem has been verified to work in the following ruby versions:
+
+ * MRI Ruby
+   * 3.2
+   * 3.1
+   * 3.0
+   * 2.7
+
+The gem also likely works with non-MRI rubies, but it has not been tested.
+    
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -25,13 +55,16 @@ Or install it yourself as:
 
 ## Usage
 
-1. Create your own plain ruby Event class that optionally carries some data important to the event. Include module ```Ventable::Event```.
+1. Create your own plain ruby Event class that optionally carries some data important to the event. Include module `Ventable::Event`.
+
 2. Create one or more observers.  Observer can be any class that implements event handler method as a class method, such as a
-   generic method ```self.handle(event)``` or a more specific method mapped to the event name: say for event UserRegistered the
-   callback event would be ```self.handle_user_registered(event)```
-3. Register your observers with the event using ```notifies``` event method, or register groups using ```group``` method, and then
-   use ```notify``` with options ```inside: :group_name```
-4. Instantiate your event class (optionally with some data), and call ```fire!``` method.
+   generic method `self.handle(event)` or a more specific method mapped to the event name: say for event UserRegistered the
+   callback event would be `self.handle_user_registered(event)`
+
+3. Register your observers with the event using `notifies` event method, or register groups using `group` method, and then
+   use `notify` with options `inside: :group_name`
+
+4. Instantiate your event class (optionally with some data), and call `publish` or, a deprecated `fire!` method.
 
 ## Example
 
@@ -62,7 +95,7 @@ end
 AlarmSoundEvent.notifies SleepingPerson
 
 # Create and fire the event
-AlarmSoundEvent.new(Date.new).fire!
+AlarmSoundEvent.new(Date.new).publish
 ```
 
 ## Using #configure and groups
@@ -101,7 +134,7 @@ SomeEvent.configure do
   notifies ObserverClass1, ObserverClass2, inside: :transaction
 end
 
-SomeEvent.new.fire!
+SomeEvent.new.publish
 ```
 
 ## Callback Method Name
@@ -119,23 +152,23 @@ using the following logic:
 
 You should start by defining your event library for your application (list of events
 that are important to you),  you can place these files anywhere you like, such as
-```lib/events``` or ```app/events```, etc.
+`lib/events` or `app/events`, etc.
 
-It is recommended to ```configure``` all events and their observers in the ```event_initializer.rb``` file,
-inside the ```config/ininitalizers``` folder.  You may need to require your events in that file also.
+It is recommended to `configure` all events and their observers in the `event_initializer.rb` file,
+inside the `config/ininitalizers` folder.  You may need to require your events in that file also.
 
 When your event is tied to a creation of a "first class objects", such as user registration,
 it is recommended to create the User record first, commit it to the database, and then throw
-a ```UserRegisteredEvent.new(user).fire!```, and have all subsequent logic broeken into
-their respective classes.  For example, if you need to send an email to the user, have a ```Mailer```
-class observe the ```UserRegisteredEvent```, and so all the mailing logic can live inside the ```Mailer```
-class, instead of, say, registration controller directly calling ```Mailer.deliver_user_registration!(user)```.
+a `UserRegisteredEvent.new(user).publish`, and have all subsequent logic broeken into
+their respective classes.  For example, if you need to send an email to the user, have a `Mailer`
+class observe the `UserRegisteredEvent`, and so all the mailing logic can live inside the `Mailer`
+class, instead of, say, registration controller directly calling `Mailer.deliver_user_registration!(user)`.
 The callback method will receive the event, that wraps the User instance, or any other useful data necessary.
 
 ## Integration with tests
 
 There are times when it may be desirable to disable all eventing. For instance, when writing unit tests,
-testing that events are fired may be useful, but integrating with all observers adds complexity and confusion.
+testing that events are published may be useful, but integrating with all observers adds complexity and confusion.
 In these cases, Ventable may be globally disabled.
 
 ```ruby
@@ -153,14 +186,14 @@ Now in a spec file:
 ```ruby
 describe "Stuff", eventing: false do
   it 'does stuff' do
-    ... my code that fires events, in isolation from event observers
+    ... my code that publishes events, in isolation from event observers
   end
 
-  it 'tests that events are fired, using stubs' do
-    event = double(fire!: true)
+  it 'tests that events are published, using stubs' do
+    event = double(publish: true)
     allow(MyEvent).to receive(:new).and_return(event)
     ... my code that should fire event
-    expect(event).to have_received(:fire!)
+    expect(event).to have_received(:publish)
   end
 end
 
@@ -197,3 +230,7 @@ For more information, check out the following blog post:
 ## Author
 
 Konstantin Gredeskoul, @kig, http://github.com/kigster
+
+
+## License
+[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fkigster%2Fventable.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fkigster%2Fventable?ref=badge_large)

data/Rakefile

@@ -1,3 +1,23 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+# frozen_string_literal: true
 
+require 'bundler/gem_tasks'
+
+def shell(*args)
+  puts "running: #{args.join(' ')}"
+  system(args.join(' '))
+end
+
+task :clean do
+  shell('rm -rf pkg/ tmp/ coverage/ doc/ ' )
+end
+
+task gem: [:build] do
+  shell('gem install pkg/*')
+end
+
+task permissions: [:clean] do
+  shell("chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*")
+  shell("find . -type d -exec chmod o+x,g+x {} \\;")
+end
+
+task build: :permissions

data/lib/ventable/event.rb

@@ -1,55 +1,58 @@
+# frozen_string_literal: true
+
 require 'set'
+require 'active_support/inflector'
 
 module ::Ventable
   class Error < RuntimeError
   end
 
   module Event
-    def self.included(klazz)
-      klazz.instance_eval do
+    def self.included(klass)
+      klass.instance_eval do
         @observers = Set.new
         class << self
           attr_accessor :observers
         end
       end
 
-      klazz.extend ClassMethods
+      klass.extend ClassMethods
     end
 
     def fire!
       notify_observer_set(self.class.observers) if Ventable.enabled?
     end
 
+    alias publish fire!
+
     private
 
     def notify_observer_set(observer_set)
       observer_set.each do |observer_entry|
         if observer_entry.is_a?(Hash)
           around_block = observer_entry[:around_block]
-          inside_block = -> { notify_observer_set(observer_entry[:observers]) }
-          around_block.call(inside_block)
-        elsif observer_entry
-          notify_observer(observer_entry)
+          around_block&.call(-> { notify_observer_set(observer_entry[:observers]) })
         else
-          raise Ventable::Error.new("nil in observer_entry set #{observer_set.inspect}!")
+          notify_observer(observer_entry)
         end
       end
     end
 
     def notify_observer(observer)
       case observer
-        when Proc
-          observer.call(self)
-        else # class
-          notify_class_observer(observer)
+      when Proc
+        observer.call(self)
+      else # class
+        notify_class_observer(observer)
       end
     end
 
     def notify_class_observer(observer)
-      default_handler = self.class.default_callback_method
+      default_handler = self.class.send(:default_callback_method)
       return observer.send(default_handler, self) if observer.respond_to?(default_handler)
       return observer.send(:handle_event, self) if observer.respond_to?(:handle_event)
-      raise Ventable::Error.new("no suitable event handler method found for #{self.class} in observer #{observer} (try adding #{default_handler} to this observer)")
+
+      raise Ventable::Error, "no suitable event handler method found for #{self.class} in observer #{observer} (try adding #{default_handler} to this observer)"
     end
 
     module ClassMethods
@@ -57,43 +60,45 @@ module ::Ventable
         class_eval(&block)
       end
 
-      def notifies(*observer_list, &block)
-        options = {}
-        options.merge! observer_list.pop if observer_list.last.is_a?(Hash)
-        observer_set = self.observers
+      def notifies(*observer_list, **options, &block)
+        observer_set = observers
         if options[:inside]
-          observer_entry = self.find_observer_group(options[:inside])
-          if observer_entry.nil?
-            raise Ventable::Error.new("No group with name #{options[:inside]} found.")
-          end
+          observer_entry = find_observer_group(options[:inside])
+          raise Ventable::Error, "No group with name #{options[:inside]} found." if observer_entry.nil?
+
           observer_set = observer_entry[:observers]
         end
-        raise Ventable::Error.new("found nil observer in params #{observer_list.inspect}") if observer_list.any?{|l| l.nil?}
+        raise Ventable::Error, "found nil observer in params #{observer_list.inspect}" if observer_list.any?(&:nil?)
+
         observer_list.compact.each { |o| observer_set << o } unless observer_list.empty?
         observer_set << block if block
       end
 
       def group(name, &block)
-        g = find_observer_group(name)
-        raise "Group #{name} already defined by #{g}" if g
-        self.observers <<
-            { name: name,
-              around_block: block,
-              observers: Set.new
-            }
+        observers << { name: name,
+                       around_block: block,
+                       observers: Set.new }
       end
 
+      protected
+
       def find_observer_group(name)
-        self.observers.find { |o| o.is_a?(Hash) && o[:name] == name }
+        observers.find { |o| o.is_a?(Hash) && o[:name] == name }
       end
 
+      private
+
       # Determine method name to call when notifying observers from this event.
       def default_callback_method
         if respond_to?(:ventable_callback_method_name)
-          self.ventable_callback_method_name
+          ventable_callback_method_name
         else
           target = self
-          method = "handle_" + target.name.gsub(/::/,'__').underscore.gsub(/_event/, '')
+
+          method = "handle_#{ActiveSupport::Inflector.underscore(target.name)}".
+                   gsub(%r{/([^/]*)}, '__\1').
+                   gsub(/_event$/, '')
+
           method.to_sym
         end
       end

data/lib/ventable/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ventable
-  VERSION = "1.0.0"
+  VERSION = '1.3.1'
 end

data/lib/ventable.rb

@@ -1,8 +1,9 @@
-require "ventable/version"
-require "ventable/event"
+# frozen_string_literal: true
 
-module Ventable
+require 'ventable/version'
+require 'ventable/event'
 
+module Ventable
   def self.disable
     @disabled = true
   end
@@ -12,16 +13,16 @@ module Ventable
   end
 
   def self.enabled?
-    @disabled != true
+    !@disabled
   end
 end
 
 class String
   def underscore
-    self.gsub(/::/, '/').
-        gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
-        gsub(/([a-z\d])([A-Z])/, '\1_\2').
-        tr("-", "_").
-        downcase
+    gsub("::", '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+      gsub(/([a-z\d])([A-Z])/, '\1_\2').
+      tr('-', '_').
+      downcase
   end
 end

data/spec/spec_helper.rb

@@ -1,17 +1,13 @@
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# Require this file using `require "spec_helper"` to ensure that it is only
-# loaded once.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+# frozen_string_literal: true
+
+require 'simplecov'
+require 'rspec'
+
+SimpleCov.start
 
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-require 'rubygems'
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
 require 'ventable'
 
 RSpec.configure do |config|
-  config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
   config.filter_run :focus
 

data/spec/ventable/ventable_spec.rb

@@ -1,4 +1,6 @@
-require 'ventable'
+# frozen_string_literal: true
+
+require 'spec_helper'
 
 describe Ventable do
   before do
@@ -8,61 +10,62 @@ describe Ventable do
   end
 
   describe '::enabled?' do
-    after { Ventable.enable }
+    after { described_class.enable }
 
     it 'is true by default' do
-      expect(Ventable.enabled?).to be true
+      expect(described_class.enabled?).to be true
     end
 
     it 'is false after Ventable is disabled' do
-      Ventable.disable
-      expect(Ventable.enabled?).to be false
+      described_class.disable
+      expect(described_class.enabled?).to be false
     end
 
     it 'is true after Ventable is re-enabled' do
-      Ventable.disable
-      Ventable.enable
-      expect(Ventable.enabled?).to be true
+      described_class.disable
+      described_class.enable
+      expect(described_class.enabled?).to be true
     end
   end
 
-  describe "including Ventable::Event" do
-    it "should create a class instance variable to keep observers" do
+  describe 'including Ventable::Event' do
+    it 'creates a class instance variable to keep observers' do
       expect(TestEvent.observers).not_to be_nil
-      expect(TestEvent.observers.class.name).to eq("Set")
+      expect(TestEvent.observers.class.name).to eq('Set')
     end
 
-    it "should see observers variable from instance methods" do
+    it 'sees observers variable from instance methods' do
       observers = nil
       TestEvent.new.instance_eval do
         observers = self.class.observers
       end
-      expect(observers).to_not be_nil
+      expect(observers).not_to be_nil
     end
 
-    it "should maintain separate sets of observers for each event" do
+    it 'maintains separate sets of observers for each event' do
       class AnotherEvent
         include Ventable::Event
       end
-      expect(AnotherEvent.observers.object_id).to_not eq(TestEvent.observers.object_id)
+
+      expect(AnotherEvent.observers.object_id).not_to eq(TestEvent.observers.object_id)
     end
   end
 
-  describe "#fire" do
+  describe '#fire' do
     before do
       class TestEvent
         include Ventable::Event
       end
     end
 
-    it "should properly call a Proc observer" do
+    it 'properly call a Proc observer' do
       run_block = false
       event = nil
       TestEvent.notifies do |e|
         run_block = true
         event = e
       end
-      expect(run_block).to eq(false)
+      expect(run_block).to be(false)
       expect(event).to be_nil
 
       # fire the event
@@ -72,30 +75,65 @@ describe Ventable do
       expect(event).not_to be_nil
     end
 
-    it "should properly call a class observer" do
-      class TestEvent
-        class << self
-          attr_accessor :flag
+    describe 'class observer' do
+      before do
+        class TestEvent
+          class << self
+            attr_accessor :flag
+          end
+
+          self.flag = 'unset'
+
+          def flag=(value)
+            self.class.flag = value
+          end
         end
-        self.flag = "unset"
-        def flag= value
-          self.class.flag = value
+
+        class TestEventObserver
+          def self.handle_test(event)
+            event.flag = 'boo'
+          end
         end
-      end
 
-      class TestEventObserver
-        def self.handle_test event
-          event.flag = "boo"
+        class GlobalObserver
+          class << self
+            def handle_event(event)
+              puts event.inspect
+            end
+          end
         end
+
+        TestEvent.notifies TestEventObserver, GlobalObserver
+        expect(TestEvent.flag).to eq('unset')
+        expect(GlobalObserver).to receive(:handle_event).with(event)
       end
-      TestEvent.notifies TestEventObserver
-      expect(TestEvent.flag).to eq("unset")
 
-      TestEvent.new.fire!
-      expect(TestEvent.flag).to eq("boo")
+      let(:event) { TestEvent.new }
+
+      it 'sets the flag and call observers' do
+        event.fire!
+        expect(TestEvent.flag).to eq('boo')
+      end
+
+      it 'also fire via the publish alias' do
+        event.publish
+      end
+
+      context 'observer without a handler' do
+        before {
+          class ObserverWithoutAHandler
+          end
+
+          TestEvent.notifies ObserverWithoutAHandler
+        }
+
+        it 'raises an exception' do
+          expect { event.publish }.to raise_error(Ventable::Error)
+        end
+      end
     end
 
-    it "should properly call a group of observers" do
+    it 'properly call a group of observers' do
       transaction_called = false
       transaction_completed = false
       transaction = ->(observer_block) {
@@ -123,22 +161,22 @@ describe Ventable do
 
       TestEvent.new.fire!
 
-      expect(transaction_called).to be  true
-      expect(observer_block_called).to be  true
-      expect(transaction_called).to be  true
+      expect(transaction_called).to be true
+      expect(observer_block_called).to be true
+      expect(transaction_called).to be true
       expect(transaction_already_completed).to be false
-      expect(event_inside).to_not be_nil
+      expect(event_inside).not_to be_nil
       expect(event_inside).to be_a(TestEvent)
     end
 
     context 'when globally disabled' do
-      before { Ventable.disable }
-      after { Ventable.enable }
+      before { described_class.disable }
+      after { described_class.enable }
 
       it 'does not notify observers' do
         observers_notified = false
 
-        TestEvent.notifies do |event|
+        TestEvent.notifies do |_event|
           observers_notified = true
         end
 
@@ -148,7 +186,7 @@ describe Ventable do
     end
   end
 
-  describe "#default_callback_method" do
+  describe '#default_callback_method' do
     before do
       class SomeAwesomeEvent
         include Ventable::Event
@@ -160,9 +198,6 @@ describe Ventable do
         end
       end
 
-      class SomeOtherStuffHappened
-        include Ventable::Event
-      end
       class ClassWithCustomCallbackMethodEvent
         include Ventable::Event
 
@@ -170,18 +205,35 @@ describe Ventable do
           :handle_my_special_event
         end
       end
+
+      module Blah
+        module Foo
+          class BarClosedEvent
+            include Ventable::Event
+          end
+        end
+      end
+    end
+
+    it 'properly sets the callback method on a Module-less class' do
+      expect(SomeAwesomeEvent.send(:default_callback_method)).to eq(:handle_some_awesome)
     end
 
-    it "should properly set the callback method name" do
-      expect(SomeAwesomeEvent.default_callback_method).to eq(:handle_some_awesome)
-      expect(Blah::AnotherSweetEvent.default_callback_method).to eq(:handle_blah__another_sweet)
-      expect(SomeOtherStuffHappened.default_callback_method).to eq(:handle_some_other_stuff_happened)
-      expect(ClassWithCustomCallbackMethodEvent.default_callback_method).to eq(:handle_my_special_event)
+    it 'properly sets the callback method on a Class within a Module' do
+      expect(Blah::AnotherSweetEvent.send(:default_callback_method)).to eq(:handle_blah__another_sweet)
+    end
+
+    it 'properly sets the callback method on a class with a custom default method handler name' do
+      expect(ClassWithCustomCallbackMethodEvent.send(:default_callback_method)).to eq(:handle_my_special_event)
+    end
+
+    it 'properly sets the callback method on a class within a nested module' do
+      expect(Blah::Foo::BarClosedEvent.send(:default_callback_method)).to eq(:handle_blah__foo__bar_closed)
     end
   end
 
-  describe "#configure" do
-    it "properly configures the event with observers" do
+  describe '#configure' do
+    it 'properly configures the event with observers' do
       notified_observer = false
       TestEvent.configure do
         notifies do
@@ -192,11 +244,11 @@ describe Ventable do
       expect(notified_observer).to be true
     end
 
-    it "configures observers with groups" do
+    it 'configures observers with groups' do
       notified_observer = false
       called_transaction = false
       TestEvent.configure do
-        group :transaction, &->(b){
+        group :transaction, &->(b) {
           b.call
           called_transaction = true
         }
@@ -209,27 +261,24 @@ describe Ventable do
       expect(called_transaction).to be true
     end
 
-    it "throws exception if :inside references unknown group" do
-      begin
-        TestEvent.configure do
-          notifies inside: :transaction do
-            # some stuff
-          end
+    it 'throws exception if :inside references unknown group' do
+      TestEvent.configure do
+        notifies inside: :transaction do
+          # some stuff
         end
-        fail "Shouldn't reach here, must throw a valid exception"
-      rescue Exception => e
-        expect(e.class).to eq(Ventable::Error)
       end
+      fail 'Shouldn\'t reach here, must throw a valid exception'
+    rescue Exception => e
+      expect(e.class).to eq(Ventable::Error)
     end
-    it "throws exception if nil observer added to the list" do
-      begin
-        TestEvent.configure do
-          notifies nil
-        end
-        fail "Shouldn't reach here, must throw a valid exception"
-      rescue Exception => e
-        expect(e.class).to eq(Ventable::Error)
+
+    it 'throws exception if nil observer added to the list' do
+      TestEvent.configure do
+        notifies nil
       end
+      fail 'Shouldn\'t reach here, must throw a valid exception'
+    rescue Exception => e
+      expect(e.class).to eq(Ventable::Error)
     end
   end
 end

data/ventable.gemspec

@@ -1,23 +1,21 @@
+# frozen_string_literal: true
 
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/ventable/version', __FILE__)
+require File.expand_path('lib/ventable/version', __dir__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Konstantin Gredeskoul"]
   gem.email         = ["kigster@gmail.com"]
-  gem.description   = %q{Event/Observable design pattern in ruby}
-  gem.summary       = %q{Event/Observable design pattern in ruby}
+  gem.description   = 'Event/Observable design pattern in ruby'
+  gem.summary       = 'Event/Observable design pattern in ruby'
   gem.homepage      = "https://github.com/kigster/ventable"
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "ventable"
   gem.require_paths = ["lib"]
   gem.version       = Ventable::VERSION
 
-  gem.add_development_dependency "rake"
-  gem.add_development_dependency "rspec"
-  gem.add_development_dependency "rspec-mocks"
-  gem.add_development_dependency 'guard-rspec'
+  gem.metadata['rubygems_mfa_required'] = 'true'
+
+  gem.add_runtime_dependency 'activesupport', '>= 5'
 end

metadata

@@ -1,71 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: ventable
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Konstantin Gredeskoul
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-01-28 00:00:00.000000000 Z
+date: 2024-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec-mocks
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: '5'
 description: Event/Observable design pattern in ruby
 email:
 - kigster@gmail.com
@@ -74,11 +32,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".atom-build.json"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
@@ -91,8 +51,9 @@ files:
 - ventable.gemspec
 homepage: https://github.com/kigster/ventable
 licenses: []
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -107,11 +68,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.5.6
+signing_key:
 specification_version: 4
 summary: Event/Observable design pattern in ruby
-test_files:
-- spec/spec_helper.rb
-- spec/ventable/ventable_spec.rb
+test_files: []

data/.travis.yml

@@ -1,10 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-script: "bundle exec rspec"
-notifications:
-  email:
-    recipients:
-      - kigster@gmail.com
-    on_success: never
-    on_failure: always

data/Gemfile.lock

@@ -1,72 +0,0 @@
-PATH
-  remote: .
-  specs:
-    ventable (1.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.0)
-    diff-lcs (1.2.5)
-    ffi (1.9.10)
-    formatador (0.2.5)
-    guard (2.13.0)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, <= 4.0)
-      lumberjack (~> 1.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.9.12)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-rspec (4.6.4)
-      guard (~> 2.1)
-      guard-compat (~> 1.1)
-      rspec (>= 2.99.0, < 4.0)
-    listen (3.0.5)
-      rb-fsevent (>= 0.9.3)
-      rb-inotify (>= 0.9)
-    lumberjack (1.0.10)
-    method_source (0.8.2)
-    nenv (0.2.0)
-    notiffany (0.0.8)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
-    pry (0.10.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.8.1)
-      slop (~> 3.4)
-    rake (10.5.0)
-    rb-fsevent (0.9.7)
-    rb-inotify (0.9.5)
-      ffi (>= 0.5.0)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.1)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    shellany (0.0.1)
-    slop (3.6.0)
-    thor (0.19.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  guard-rspec
-  rake
-  rspec
-  rspec-mocks
-  ventable!
-
-BUNDLED WITH
-   1.11.2