signal 1.0.0 → 1.3.1

data/examples/listener.rb

@@ -1,5 +1,7 @@
-$:.unshift File.expand_path('../../lib', __FILE__)
-require 'signal'
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "signal"
 
 class Status
   include Signal
@@ -11,7 +13,7 @@ end
 
 class MyListener
   def before_ready
-    puts 'Before the ready event!'
+    puts "Before the ready event!"
   end
 
   def on_ready
@@ -19,7 +21,7 @@ class MyListener
   end
 
   def after_ready
-    puts 'After the ready event!'
+    puts "After the ready event!"
   end
 end
 

data/lib/signal/extensions/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Signal
   def self.active_record
     Extensions::ActiveRecord
@@ -17,16 +19,16 @@ module Signal
         end
       end
 
-      private
-      def around_create_signal
+      private def around_create_signal
         emit_signal(:before, :create, self)
         yield
         return unless persisted?
+
         emit_signal(:on, :create, self)
         emit_signal(:after, :create, self)
       end
 
-      def around_save_signal
+      private def around_save_signal
         if new_record?
           yield
           return
@@ -38,18 +40,18 @@ module Signal
         emit_signal(:after, :update, self)
       end
 
-      def around_destroy_signal
+      private def around_destroy_signal
         emit_signal(:before, :remove, self)
         yield
         emit_signal(:on, :remove, self)
         emit_signal(:after, :remove, self)
       end
 
-      def before_validation_signal
+      private def before_validation_signal
         emit_signal(:before, :validation, self)
       end
 
-      def after_validation_signal
+      private def after_validation_signal
         emit_signal(:on, :validation, self) if errors.any?
         emit_signal(:after, :validation, self)
       end

data/lib/signal/extensions/call.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Signal
   def self.call
     Extensions::Call
@@ -11,9 +13,9 @@ module Signal
       end
 
       module ClassMethods
-        def call(*args, &block)
-          new(*args).tap do |instance|
-            yield(instance)
+        def call(*args, **kwargs)
+          new(*args, **kwargs).tap do |instance|
+            yield(instance) if block_given?
             instance.call
           end
         end

data/lib/signal/listener.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Signal
   class Listener
     def initialize(context, type, event, &block)
@@ -10,6 +12,7 @@ module Signal
 
     def method_missing(method_name, *args)
       return super unless respond_to_missing?(method_name, false)
+
       @block.call(*args)
     end
 
@@ -17,7 +20,7 @@ module Signal
       "<#{self.class} event: #{@event_method}>"
     end
 
-    def respond_to_missing?(method_name, include_private)
+    def respond_to_missing?(method_name, _include_private)
       method_name == @event_method
     end
   end

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 = '1.0.0'
+  VERSION = "1.3.1"
 end

data/lib/signal.rb

@@ -1,7 +1,9 @@
-require 'signal/version'
-require 'signal/listener'
-require 'signal/extensions/active_record'
-require 'signal/extensions/call'
+# 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,43 @@
-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.post_install_message =
+    "\n====================================================================\n" \
+    "`signal` has been deprecated in favor of `voltage`.\n" \
+    "To install it, use `gem install voltage` or add it to your gemfile.\n" \
+    "For details, please visit https://github.com/fnando/signal/issues/6" \
+    "\n====================================================================\n\n"
+
+  spec.add_dependency "voltage"
+
+  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,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: signal
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Nando Vieira
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-10-21 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: voltage
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -25,7 +39,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 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +81,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,10 +144,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODEOWNERS"
+- ".github/FUNDING.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/dependabot.yml"
+- ".github/workflows/ruby-tests.yml"
 - ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CHANGELOG.md
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -86,29 +161,27 @@ 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/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/issues/2_spec.rb
-- spec/signal/listener_spec.rb
-- spec/signal/signal_spec.rb
-- spec/spec_helper.rb
-- spec/support/callable.rb
-- spec/support/emitter.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: |2+
+
+  ====================================================================
+  `signal` has been deprecated in favor of `voltage`.
+  To install it, use `gem install voltage` or add it to your gemfile.
+  For details, please visit https://github.com/fnando/signal/issues/6
+  ====================================================================
+
 rdoc_options: []
 require_paths:
 - lib
@@ -116,28 +189,17 @@ 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/issues/2_spec.rb
-- spec/signal/listener_spec.rb
-- spec/signal/signal_spec.rb
-- spec/spec_helper.rb
-- spec/support/callable.rb
-- spec/support/emitter.rb
-- spec/support/observable.rb
-- spec/support/observable_with_call.rb
-- spec/support/user.rb
+test_files: []
+...

data/.rspec

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

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-cache: bundler
-sudo: false
-script: bundle exec rspec
-rvm:
-- '2.2'
-- '2.1'
-addons:
-  code_climate:
-    repo_token:
-      secure: "ASogQTLS/xYYczRtFwuo8DIkNdOl16mez4GHOw4RtdfTQ4BMROxE/CUemdPulMW1b/p7jsp5ghOtH2EJ4jN203s83HN4QjGC2wXhigkk6LzvxqjkmHxIWxJi2JS2sLq8nzOCcD0geO1pcbBFyuAzAdlwWa2g1WDP7O0L0fNjCtM="

data/CHANGELOG.md

@@ -1,5 +0,0 @@
-# Signal
-
-### v1.0.0
-
-- Use `include Signal.active_record` instead of `include Signal::ActiveRecord`. This fixes problems with [constant lookup](https://github.com/fnando/signal/issues/2).

data/spec/signal/activerecord_spec.rb

@@ -1,132 +0,0 @@
-require 'spec_helper'
-
-describe Signal::Extensions::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::Extensions::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/issues/2_spec.rb

@@ -1,13 +0,0 @@
-require 'spec_helper'
-
-describe 'Constant lookup', 'https://github.com/fnando/signal/issues/2' do
-  let(:callable) { Callable.new }
-
-  it 'triggers event' do
-    emitter = Emitter.new
-    emitter.on(:success, &callable)
-    expect(callable).to receive(:called).with(no_args)
-
-    emitter.call
-  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