signal 0.3.0 → 1.3.0

data/lib/signal/mock.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Signal
+  class Mock
+    def calls
+      @calls ||= []
+    end
+
+    def method_missing(name, *args)
+      return super unless respond_to_missing?(name)
+
+      calls << {event: name.to_s.gsub(/^on_/, "").to_sym, args: args}
+    end
+
+    def respond_to_missing?(name, _include_all = false)
+      name =~ /^on_/
+    end
+
+    def received?(event, options = {})
+      received_event?(event, options[:times] || -1) &&
+        received_with?(event, options[:with])
+    end
+
+    def to_proc
+      proc {|action| action.add_listener(self) }
+    end
+
+    def on(event)
+      proc {|*args| calls << {event: event, args: args} }
+    end
+
+    private def received_event?(event, count)
+      received_calls = calls.count {|call| call[:event] == event }
+
+      return received_calls.nonzero? if count == -1
+
+      received_calls == count
+    end
+
+    private def received_with?(event, args)
+      return true unless args
+
+      calls.any? do |call|
+        next unless call[:event] == event
+        next args.call(call[:args]) if args.is_a?(Proc)
+
+        args == call[:args]
+      end
+    end
+  end
+end

data/lib/signal/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Signal
-  VERSION = '0.3.0'
+  VERSION = "1.3.0"
 end

data/lib/signal.rb

@@ -1,7 +1,9 @@
-require 'signal/active_record'
-require 'signal/listener'
-require 'signal/call'
-require 'signal/version'
+# frozen_string_literal: true
+
+require "signal/version"
+require "signal/listener"
+require "signal/extensions/active_record"
+require "signal/extensions/call"
 
 module Signal
   def on(event, &block)
@@ -35,11 +37,13 @@ module Signal
     @listeners ||= []
   end
 
-  private
-  def emit_signal(type, event, *args)
+  private def emit_signal(type, event, *args)
     listeners.each do |listener|
       method_name = "#{type}_#{event}"
-      listener.send(method_name, *args) if listener.respond_to?(method_name, true)
+
+      if listener.respond_to?(method_name, true)
+        listener.send(method_name, *args)
+      end
     end
   end
 end

data/signal.gemspec

@@ -1,21 +1,34 @@
-require './lib/signal/version'
+# frozen_string_literal: true
 
-Gem::Specification.new do |gem|
-  gem.name          = 'signal'
-  gem.version       = Signal::VERSION
-  gem.authors       = ['Nando Vieira']
-  gem.email         = ['fnando.vieira@gmail.com']
-  gem.description   = 'A simple observer implementation for POROs (Plain Old Ruby Object) and ActiveRecord objects.'
-  gem.summary       = gem.description
-  gem.homepage      = 'http://github.com/fnando/signal'
+require "./lib/signal/version"
 
-  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.require_paths = ['lib']
+Gem::Specification.new do |spec|
+  spec.name          = "signal"
+  spec.version       = Signal::VERSION
+  spec.authors       = ["Nando Vieira"]
+  spec.email         = ["fnando.vieira@gmail.com"]
+  spec.description   = %w[
+    A simple observer implementation for POROs (Plain Old Ruby Object) and
+    ActiveRecord objects.
+  ].join(" ")
+  spec.summary       = spec.description
+  spec.homepage      = "http://github.com/fnando/signal"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
-  gem.add_development_dependency 'activerecord'
-  gem.add_development_dependency 'sqlite3'
-  gem.add_development_dependency 'rspec'
-  gem.add_development_dependency 'codeclimate-test-reporter'
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.executables   = spec.files.grep(%r{^bin/}).map {|f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "pry-meta"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "sqlite3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signal
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-09-24 00:00:00.000000000 Z
+date: 2021-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: minitest-utils
+  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: pry-meta
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +67,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: codeclimate-test-reporter
+  name: rubocop
+  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: rubocop-fnando
+  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: simplecov
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -74,8 +130,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/FUNDING.yml"
 - ".gitignore"
-- ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -85,27 +142,20 @@ files:
 - examples/arguments.rb
 - examples/block_context.rb
 - examples/blocks.rb
+- examples/call.rb
 - examples/chain.rb
 - examples/listener.rb
 - lib/signal.rb
-- lib/signal/active_record.rb
-- lib/signal/call.rb
+- lib/signal/extensions/active_record.rb
+- lib/signal/extensions/call.rb
 - lib/signal/listener.rb
+- lib/signal/mock.rb
 - lib/signal/version.rb
 - signal.gemspec
-- spec/signal/activerecord_spec.rb
-- spec/signal/call_spec.rb
-- spec/signal/listener_spec.rb
-- spec/signal/signal_spec.rb
-- spec/spec_helper.rb
-- spec/support/callable.rb
-- spec/support/observable.rb
-- spec/support/observable_with_call.rb
-- spec/support/user.rb
 homepage: http://github.com/fnando/signal
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,26 +163,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: A simple observer implementation for POROs (Plain Old Ruby Object) and ActiveRecord
   objects.
-test_files:
-- spec/signal/activerecord_spec.rb
-- spec/signal/call_spec.rb
-- spec/signal/listener_spec.rb
-- spec/signal/signal_spec.rb
-- spec/spec_helper.rb
-- spec/support/callable.rb
-- spec/support/observable.rb
-- spec/support/observable_with_call.rb
-- spec/support/user.rb
+test_files: []

data/.rspec

@@ -1 +0,0 @@
---color

data/lib/signal/call.rb

@@ -1,21 +0,0 @@
-module Signal
-  def self.call
-    Call
-  end
-
-  module Call
-    def self.included(target)
-      target.include(Signal)
-      target.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      def call(*args, &block)
-        new(*args).tap do |instance|
-          yield(instance)
-          instance.call
-        end
-      end
-    end
-  end
-end

data/spec/signal/activerecord_spec.rb

@@ -1,132 +0,0 @@
-require 'spec_helper'
-
-describe Signal::ActiveRecord do
-  let(:callable) { Callable.new }
-  let(:user) { User.new(:username => 'johndoe') }
-
-  context 'create event' do
-    it 'triggers before event' do
-      user.before(:create, &callable)
-      expect(callable).to receive(:called).with(user)
-      user.save!
-    end
-
-    it 'triggers event' do
-      user.on(:create, &callable)
-      expect(callable).to receive(:called).with(user)
-      user.save!
-    end
-
-    it 'triggers after event' do
-      user.after(:create, &callable)
-      expect(callable).to receive(:called).with(user)
-      user.save!
-    end
-
-    it 'does not trigger on/after events when record is invalid' do
-      user = User.new
-
-      on_callable = Callable.new
-      after_callable = Callable.new
-
-      user
-        .on(:create, &on_callable)
-        .after(:create, &after_callable)
-
-      expect(on_callable).not_to receive(:called)
-      expect(after_callable).not_to receive(:called)
-
-      user.save
-    end
-  end
-
-  context 'validation event' do
-    it 'triggers before event' do
-      user.before(:validation, &callable)
-      expect(callable).to receive(:called).with(user)
-      user.save!
-    end
-
-    it 'triggers after event' do
-      user.after(:validation, &callable)
-      expect(callable).to receive(:called).with(user)
-      user.save!
-    end
-
-    it 'triggers validation event when record is invalid' do
-      user.username = nil
-      user.on(:validation, &callable)
-      expect(callable).to receive(:called).with(user)
-      user.save
-    end
-
-    it 'skips validation event when record is valid' do
-      user.on(:validation, &callable)
-      expect(callable).not_to receive(:called)
-      user.save!
-    end
-  end
-
-  context 'update event' do
-    let(:user) { User.create!(:username => 'johndoe') }
-
-    it 'triggers before event' do
-      user.before(:update, &callable)
-      expect(callable).to receive(:called).with(user)
-      user.update_attributes!(:username => 'johnd')
-    end
-
-    it 'triggers on event' do
-      user.on(:update, &callable)
-      expect(callable).to receive(:called).with(user)
-      user.update_attributes!(:username => 'johnd')
-    end
-
-    it 'triggers after event' do
-      user.after(:update, &callable)
-      expect(callable).to receive(:called).with(user)
-      user.update_attributes!(:username => 'johnd')
-    end
-
-    it 'does not trigger on/after events when record is invalid' do
-      user.username = nil
-
-      on_callable = Callable.new
-      after_callable = Callable.new
-
-      user
-        .on(:update, &on_callable)
-        .after(:update, &after_callable)
-
-      expect(on_callable).not_to receive(:called)
-      expect(after_callable).not_to receive(:called)
-
-      user.save
-    end
-  end
-
-  context 'remove event' do
-    let(:user) { User.create!(:username => 'johndoe') }
-
-    it 'triggers before event' do
-      user.before(:remove, &callable)
-      expect(callable).to receive(:called).with(user)
-
-      user.destroy
-    end
-
-    it 'triggers on event' do
-      user.on(:remove, &callable)
-      expect(callable).to receive(:called).with(user)
-
-      user.destroy
-    end
-
-    it 'triggers after event' do
-      user.after(:remove, &callable)
-      expect(callable).to receive(:called).with(user)
-
-      user.destroy
-    end
-  end
-end

data/spec/signal/call_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-
-describe Signal::Call do
-  let(:callable) { Callable.new }
-
-  it 'initializes observable with arguments' do
-    observable = ObservableWithCall.call(1, 2, 3) {}
-    expect(observable.args).to eq([1, 2, 3])
-  end
-
-  it 'triggers event' do
-    expect(callable).to receive(:called).with([1, 2, 3])
-
-    ObservableWithCall.call(1, 2, 3) do |o|
-      o.on(:args, &callable)
-    end
-  end
-end

data/spec/signal/listener_spec.rb

@@ -1,8 +0,0 @@
-require 'spec_helper'
-
-describe Signal::Listener do
-  it 'sets string representation' do
-    listener = Signal::Listener.new(self, :on, :ready, &->{})
-    expect(listener.to_s).to eq('<Signal::Listener event: on_ready>')
-  end
-end

data/spec/signal/signal_spec.rb

@@ -1,123 +0,0 @@
-require 'spec_helper'
-
-describe Signal do
-  let(:observable) { Observable.new }
-  let(:callable) { Callable.new }
-
-  context 'add listener' do
-    it 'runs listener' do
-      callable.respond_to(:on_ready)
-      observable.add_listener(callable)
-      expect(callable).to receive(:called).with(no_args)
-
-      observable.emit(:ready)
-    end
-
-    it 'returns itself' do
-      expect(observable.add_listener(callable)).to eq(observable)
-    end
-  end
-
-  context 'using blocks' do
-    it 'triggers event' do
-      observable.on(:ready, &callable)
-      expect(callable).to receive(:called).with(no_args)
-
-      observable.emit(:ready)
-    end
-
-    it 'triggers event with arguments' do
-      observable.on(:ready, &callable)
-      expect(callable).to receive(:called).with(1, 2, 3)
-
-      observable.emit(:ready, 1, 2, 3)
-    end
-
-    it 'triggers before event' do
-      observable.before(:ready, &callable)
-      expect(callable).to receive(:called).with(no_args)
-
-      observable.emit(:ready)
-    end
-
-    it 'triggers before event with arguments' do
-      observable.before(:ready, &callable)
-      expect(callable).to receive(:called).with(1, 2, 3)
-
-      observable.emit(:ready, 1, 2, 3)
-    end
-
-    it 'triggers after event' do
-      observable.after(:ready, &callable)
-      expect(callable).to receive(:called).with(no_args)
-
-      observable.emit(:ready)
-    end
-
-    it 'triggers after event with arguments' do
-      observable.after(:ready, &callable)
-      expect(callable).to receive(:called).with(1, 2, 3)
-
-      observable.emit(:ready, 1, 2, 3)
-    end
-
-    it 'chains events' do
-      before_callable = Callable.new
-      on_callable = Callable.new
-      after_callable = Callable.new
-
-      observable
-        .before(:ready, &before_callable)
-        .on(:ready, &on_callable)
-        .after(:ready, &after_callable)
-
-      expect(before_callable).to receive(:called).with(no_args).ordered
-      expect(on_callable).to receive(:called).with(no_args).ordered
-      expect(after_callable).to receive(:called).with(no_args).ordered
-
-      observable.emit(:ready)
-    end
-
-    it 'keeps context' do
-      context = nil
-      callable = -> { context = self }
-      observable.on(:ready, &callable)
-      observable.emit(:ready)
-
-      expect(context).to eql(self)
-    end
-  end
-
-  context 'using listeners' do
-    it 'triggers event for listener' do
-      callable.respond_to(:on_ready)
-      observable.listeners << callable
-      expect(callable).to receive(:called).with(no_args)
-
-      observable.emit(:ready)
-    end
-
-    it 'triggers event for listener with arguments' do
-      callable.respond_to(:on_ready)
-      observable.listeners << callable
-      expect(callable).to receive(:called).with(1, 2, 3)
-
-      observable.emit(:ready, 1, 2, 3)
-    end
-  end
-
-  context 'mixed listeners' do
-    it 'calls all listeners' do
-      callable.respond_to(:on_ready)
-      another_callable = Callable.new
-
-      expect(callable).to receive(:called).ordered
-      expect(another_callable).to receive(:called).ordered
-
-      observable
-        .add_listener(callable)
-        .on(:ready, &another_callable)
-        .emit(:ready)
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,24 +0,0 @@
-require 'codeclimate-test-reporter'
-CodeClimate::TestReporter.start
-
-require 'bundler/setup'
-require 'active_record'
-
-I18n.enforce_available_locales = false
-
-require 'signal'
-require 'support/observable'
-require 'support/observable_with_call'
-require 'support/callable'
-require 'support/user'
-
-ActiveRecord::Base.establish_connection({
-  :adapter => 'sqlite3',
-  :database => ':memory:'
-})
-
-ActiveRecord::Schema.define(:version => 0) do
-  create_table :users do |t|
-    t.string :username
-  end
-end

data/spec/support/callable.rb

@@ -1,10 +0,0 @@
-class Callable
-  def to_proc
-    callable = self
-    proc {|*args| callable.called(*args) }
-  end
-
-  def respond_to(method_name)
-    define_singleton_method(method_name, &to_proc)
-  end
-end

data/spec/support/observable.rb

@@ -1,3 +0,0 @@
-class Observable
-  include Signal
-end

data/spec/support/observable_with_call.rb

@@ -1,13 +0,0 @@
-class ObservableWithCall
-  include Signal.call
-
-  attr_reader :args
-
-  def initialize(*args)
-    @args = args
-  end
-
-  def call
-    emit(:args, @args)
-  end
-end

data/spec/support/user.rb

@@ -1,4 +0,0 @@
-class User < ActiveRecord::Base
-  include Signal::ActiveRecord
-  validates_presence_of :username
-end