signal 0.3.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f93acc02fac0dc15d821540be7b8429a1c4ee767
-  data.tar.gz: ccbf61c85f7448b07f32e5a708905862b63a66f3
+SHA256:
+  metadata.gz: b9b02225af7234c06c7bdca60c54ca2bc5bd7b56760350fb52c603dcfcd9c6fc
+  data.tar.gz: 6ae6ad7189173f3eef745a12b0bba61444a00b6ed6da7680848d8fdfa26c9214
 SHA512:
-  metadata.gz: edebdf9690ad027d27f25a1e80d94272750b1a62434df184d6894c7a253b0f050fe06dda337601179886d22b02d4bffeb5155e695a8d7d09b27f88aef4f3d1f6
-  data.tar.gz: 055b3b383611a0de961f0f66d4cfd7b0b40fcfc36dd252e46d2cdade60dd34b9f73ce50bd07a4e677e596063c3154dbb96687ac788236d4cad9e06a6a15526ac
+  metadata.gz: aba54da3377c2f2eb8eca0d87edc44599dccb195259bf75949008cd17b780f7d2ad9fbce0e54aac6b3e2fd63e0bf61e86f02ad1e02e4bd4b5ba9c6a96baa74c9
+  data.tar.gz: b7be39534802b24399c9d732c7af050447b66ac5fff04abd6ee66f46f54324e6e6f636c2d84b62c0f20c490fc471484d3ee86e6f5faca3b833d5a8d17761fcdf

data/.github/FUNDING.yml

@@ -0,0 +1,3 @@
+---
+github: [fnando]
+custom: ["https://www.paypal.me/nandovieira/🍕"]

data/.rubocop.yml

@@ -0,0 +1,12 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.7
+  Exclude:
+    - vendor/**/*
+    - gemfiles/**/*
+
+Metrics:
+  Enabled: false

data/.travis.yml

@@ -1,12 +1,20 @@
 language: ruby
 cache: bundler
 sudo: false
-script: bundle exec rspec
+script: bundle exec rake
 rvm:
-- '2.2'
-- '2.1'
-- '2.0'
-addons:
-  code_climate:
-    repo_token:
-      secure: "ASogQTLS/xYYczRtFwuo8DIkNdOl16mez4GHOw4RtdfTQ4BMROxE/CUemdPulMW1b/p7jsp5ghOtH2EJ4jN203s83HN4QjGC2wXhigkk6LzvxqjkmHxIWxJi2JS2sLq8nzOCcD0geO1pcbBFyuAzAdlwWa2g1WDP7O0L0fNjCtM="
+  - 2.7.1
+  - 2.6.2
+before_script:
+  - "curl -L
+    https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64
+    > ./cc-test-reporter"
+  - chmod +x ./cc-test-reporter
+  - "./cc-test-reporter before-build"
+after_script:
+  - "./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT"
+notifications:
+  email: false
+env:
+  global:
+    secure: EmzkOnefLJlsAbh4tKzcdfX9PiwQMNSmWz1aTaieA1C9GJryT2JswBa/eVgU3jDKPhFFdZ5X8K6bf0ArAdDXFMW5+DPQ9nWDOCUH3QuuFTOicyTi16W8HCozbLTg49CdB0kP4iQlA3rdpje/T9zgsTvdNDuBevB90JplHy5Lu6o=

data/Gemfile

@@ -1,2 +1,4 @@
-source 'http://rubygems.org'
+# frozen_string_literal: true
+
+source "http://rubygems.org"
 gemspec

data/README.md

@@ -1,10 +1,13 @@
 # Signal
 
-[![Build Status](https://travis-ci.org/fnando/signal.svg?branch=master)](https://travis-ci.org/fnando/signal)
+[![Build Status](https://travis-ci.org/fnando/signal.svg?branch=main)](https://travis-ci.org/fnando/signal)
 [![Code Climate](https://codeclimate.com/github/fnando/signal/badges/gpa.svg)](https://codeclimate.com/github/fnando/signal)
 [![Test Coverage](https://codeclimate.com/github/fnando/signal/badges/coverage.svg)](https://codeclimate.com/github/fnando/signal)
+[![Gem](https://img.shields.io/gem/v/signal.svg)](https://rubygems.org/gems/signal)
+[![Gem](https://img.shields.io/gem/dt/signal.svg)](https://rubygems.org/gems/signal)
 
-A simple observer implementation on POROs (Plain Old Ruby Object) and ActiveRecord objects.
+A simple observer implementation on POROs (Plain Old Ruby Object) and
+ActiveRecord objects.
 
 ## Installation
 
@@ -28,7 +31,8 @@ You can use Signal with PORO (Plain Old Ruby Object) and ActiveRecord.
 
 ### Plain Ruby
 
-All you have to do is including the `Signal` module. Then you can add listeners and trigger events.
+All you have to do is including the `Signal` module. Then you can add listeners
+and trigger events.
 
 ```ruby
 class Status
@@ -49,7 +53,8 @@ status.ready!
 #=> After the ready event!
 ```
 
-You can also pass objects that implement methods like `before_*`, `on_*` and `after_*`.
+You can also pass objects that implement methods like `before_*`, `on_*` and
+`after_*`.
 
 ```ruby
 class MyListener
@@ -74,7 +79,9 @@ Status.new
 #=> After the ready event!
 ```
 
-Executed blocks don't switch context. You always have to emit the object you're interested in. The follow example uses `emit(:output, self)` to send the `Contact` instance to all listeners.
+Executed blocks don't switch context. You always have to emit the object you're
+interested in. The follow example uses `emit(:output, self)` to send the
+`Contact` instance to all listeners.
 
 ```ruby
 class Contact
@@ -119,11 +126,12 @@ Arguments.new
 
 ### ActiveRecord
 
-You can use Signal with ActiveRecord, which will give you some default events like `:create`, `:update`, `:remove` and `:validation`.
+You can use Signal with ActiveRecord, which will give you some default events
+like `:create`, `:update`, `:remove` and `:validation`.
 
 ```ruby
 class Thing < ActiveRecord::Base
-  include Signal::ActiveRecord
+  include Signal.active_record
 
   validates_presence_of :name
 end
@@ -151,22 +159,23 @@ thing.destroy
 
 These are the available events:
 
-* `before(:create)`: triggered before creating the record (record is valid).
-* `on(:create)`: triggered after `before(:create)` event.
-* `after(:create)`: triggered after the `on(:create)` event.
-* `before(:update)`: triggered before updating the record (record is valid).
-* `on(:update)`: triggered when the `before(:update)` event.
-* `after(:update)`: triggered after the `on(:update)` event.
-* `before(:remove)`: triggered before removing the record.
-* `on(:remove)`: triggered after the `before(:remove)`.
-* `after(:remove)`: triggered after the `on(:remove)` event.
-* `before(:validation)`: triggered before validating record.
-* `on(:validation)`: triggered when record is invalid.
-* `after(:validation)`: triggered after validating record.
+- `before(:create)`: triggered before creating the record (record is valid).
+- `on(:create)`: triggered after `before(:create)` event.
+- `after(:create)`: triggered after the `on(:create)` event.
+- `before(:update)`: triggered before updating the record (record is valid).
+- `on(:update)`: triggered when the `before(:update)` event.
+- `after(:update)`: triggered after the `on(:update)` event.
+- `before(:remove)`: triggered before removing the record.
+- `on(:remove)`: triggered after the `before(:remove)`.
+- `after(:remove)`: triggered after the `on(:remove)` event.
+- `before(:validation)`: triggered before validating record.
+- `on(:validation)`: triggered when record is invalid.
+- `after(:validation)`: triggered after validating record.
 
 ### Inside Rails
 
-Although there's no special code for Rails, here's just an example of how you can use it:
+Although there's no special code for Rails, here's just an example of how you
+can use it:
 
 ```ruby
 class UsersController < ApplicationController
@@ -197,7 +206,10 @@ end
 
 ### Signal::Call
 
-You can include `Signal::Call` instead, so you can have a common interface for your observable object. This will add the `.call()` method to the target class, which will delegate attributes to the observable's `initialize` method and call its `call` method.
+You can include `Signal.call` instead, so you can have a common interface for
+your observable object. This will add the `.call()` method to the target class,
+which will delegate attributes to the observable's `initialize` method and call
+its `call` method.
 
 ```ruby
 class Contact
@@ -219,7 +231,43 @@ Contact.call('John', 'john@example.com') do |o|
 end
 ```
 
-Notice that you don't have to explicit call the instance's `call` method; `Contact.call` will initialize the object with all the provided parameters and call `Contact#call` after the block has been executed.
+Notice that you don't have to explicit call the instance's `call` method;
+`Contact.call` will initialize the object with all the provided parameters and
+call `Contact#call` after the block has been executed.
+
+### Testing
+
+`Signal::Mock` can be helpful for most test situations where you don't want to
+bring other mock libraries.
+
+```ruby
+require "signal/mock"
+
+class SomeTest < Minitest::Test
+  def test_some_test
+    mock = Signal::Mock.new
+
+    # Using listener
+    sum = Sum.new
+    sum.add_listener(mock)
+
+    # Calling `mock.on(event_name)` is required because
+    # the handler doesn't receive the event name, just the
+    # arguments.
+    sum = Sum.new
+    sum.on(:result, &mock.on(:result))
+
+    # Using with Signal.call
+    Sum.call(1, 2, &mock)
+
+    assert mock.received?(:result)
+    assert mock.received?(:result, times: 1)
+    assert mock.received?(:result, with: [3])
+    assert mock.received?(:result, with: ->(result) { result == 3 } )
+  end
+end
+
+```
 
 ## Contributing
 
@@ -231,25 +279,23 @@ Notice that you don't have to explicit call the instance's `call` method; `Conta
 
 ## License
 
-Copyright (c) 2013-2015 Nando Vieira
+Copyright (c) 2013 Nando Vieira
 
 MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sub-license, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sub-license, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1 +1,15 @@
-require 'bundler/gem_tasks'
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+require "rubocop/rake_task"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.warning = false
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/examples/activerecord_model.rb

@@ -1,13 +1,15 @@
-$:.unshift File.expand_path('../../lib', __FILE__)
-require 'signal'
-require 'active_record'
+# frozen_string_literal: true
 
-ActiveRecord::Base.establish_connection({
-  :adapter => 'sqlite3',
-  :database => ':memory:'
-})
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "signal"
+require "active_record"
 
-ActiveRecord::Schema.define(:version => 0) do
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: ":memory:"
+)
+
+ActiveRecord::Schema.define(version: 0) do
   create_table :things do |t|
     t.string :name
     t.timestamps null: false
@@ -20,7 +22,7 @@ class Thing < ActiveRecord::Base
   validates_presence_of :name
 end
 
-thing = Thing.new(:name => 'Stuff')
+thing = Thing.new(name: "Stuff")
 thing.on(:create) {|model| puts model.updated_at, model.name }
 thing.on(:update) {|model| puts model.updated_at, model.name }
 thing.on(:remove) {|model| puts model.destroyed? }
@@ -30,12 +32,12 @@ thing.save!
 #=> 2013-01-26 10:32:39 -0200
 #=> Stuff
 
-thing.update_attributes(:name => 'Updated stuff')
+thing.update_attributes(name: "Updated stuff")
 #=> 2013-01-26 10:33:11 -0200
 #=> Updated stuff
 
-thing.update_attributes(:name => nil)
-#=> ['Name can't be blank']
+thing.update_attributes(name: nil)
+#=> ["Name can"t be blank"]
 
 thing.destroy
 #=> true

data/examples/arguments.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 Arguments
   include Signal

data/examples/block_context.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 Contact
   include Signal
@@ -7,7 +9,8 @@ class Contact
   attr_reader :name, :email
 
   def initialize(name, email)
-    @name, @email = name, email
+    @name = name
+    @email = email
   end
 
   def output!
@@ -15,6 +18,6 @@ class Contact
   end
 end
 
-contact = Contact.new('John Doe', 'john@example.org')
-contact.on(:output) {|contact| puts contact.name, contact.email }
+contact = Contact.new("John Doe", "john@example.org")
+contact.on(:output) {|c| puts c.name, c.email }
 contact.output!

data/examples/blocks.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
@@ -10,7 +12,7 @@ class Status
 end
 
 status = Status.new
-status.before(:ready) { puts 'Before the ready event!' }
+status.before(:ready) { puts "Before the ready event!" }
 status.on(:ready) { puts "I'm ready!" }
-status.after(:ready) { puts 'After the ready event!' }
+status.after(:ready) { puts "After the ready event!" }
 status.ready!

data/examples/call.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "signal"
+
+class Contact
+  include Signal.call
+
+  attr_reader :name, :email
+
+  def initialize(name, email)
+    @name = name
+    @email = email
+  end
+
+  def call
+    emit(:output, self)
+  end
+end
+
+Contact.call("John", "john@example.com") do |o|
+  o.on(:output) {|contact| puts contact.name }
+end

data/examples/chain.rb

@@ -1,13 +1,15 @@
-$:.unshift File.expand_path('../../lib', __FILE__)
-require 'signal'
-require 'active_record'
+# frozen_string_literal: true
 
-ActiveRecord::Base.establish_connection({
-  :adapter => 'sqlite3',
-  :database => ':memory:'
-})
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "signal"
+require "active_record"
 
-ActiveRecord::Schema.define(:version => 0) do
+ActiveRecord::Base.establish_connection(
+  adapter: "sqlite3",
+  database: ":memory:"
+)
+
+ActiveRecord::Schema.define(version: 0) do
   create_table :things do |t|
     t.string :name
     t.timestamps null: false
@@ -15,14 +17,14 @@ ActiveRecord::Schema.define(:version => 0) do
 end
 
 class Thing < ActiveRecord::Base
-  include Signal::ActiveRecord
+  include Signal.active_record
 
   validates_presence_of :name
 end
 
 class MyListener
-  [:validation, :update, :create, :remove].each do |type|
-    class_eval <<-RUBY
+  %i[validation update create remove].each do |type|
+    class_eval <<-RUBY, __FILE__, __LINE__ + 1
       def before_#{type}(thing); puts __method__; end
       def on_#{type}(thing); puts __method__; end
       def after_#{type}(thing); puts __method__; end
@@ -31,26 +33,26 @@ class MyListener
 end
 
 puts "\n=== Creating valid record"
-thing = Thing.new(:name => 'Stuff')
+thing = Thing.new(name: "Stuff")
 thing.listeners << MyListener.new
 thing.save
 
 puts "\n=== Creating invalid record"
-thing = Thing.new(:name => nil)
+thing = Thing.new(name: nil)
 thing.listeners << MyListener.new
 thing.save
 
 puts "\n=== Updating valid record"
-thing = Thing.create(:name => 'Stuff')
+thing = Thing.create(name: "Stuff")
 thing.listeners << MyListener.new
-thing.update_attributes(:name => 'Updated stuff')
+thing.update_attributes(name: "Updated stuff")
 
 puts "\n=== Updating invalid record"
-thing = Thing.create!(:name => 'Stuff')
+thing = Thing.create!(name: "Stuff")
 thing.listeners << MyListener.new
-thing.update_attributes(:name => nil)
+thing.update_attributes(name: nil)
 
 puts "\n=== Removing record"
-thing = Thing.create(:name => 'Stuff')
+thing = Thing.create(name: "Stuff")
 thing.listeners << MyListener.new
 thing.destroy

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/{active_record.rb → extensions/active_record.rb}

@@ -1,29 +1,34 @@
+# frozen_string_literal: true
+
 module Signal
-  module ActiveRecord
-    def self.included(base)
-      base.class_eval do
-        include Signal
-        include InstanceMethods
-
-        around_create     :around_create_signal
-        around_save       :around_save_signal
-        around_destroy    :around_destroy_signal
-        before_validation :before_validation_signal
-        after_validation  :after_validation_signal
+  def self.active_record
+    Extensions::ActiveRecord
+  end
+
+  module Extensions
+    module ActiveRecord
+      def self.included(base)
+        base.class_eval do
+          include Signal
+
+          around_create     :around_create_signal
+          around_save       :around_save_signal
+          around_destroy    :around_destroy_signal
+          before_validation :before_validation_signal
+          after_validation  :after_validation_signal
+        end
       end
-    end
 
-    module InstanceMethods
-      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
@@ -35,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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Signal
+  def self.call
+    Extensions::Call
+  end
+
+  module Extensions
+    module Call
+      def self.included(target)
+        target.include(Signal)
+        target.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def call(*args, **kwargs)
+          new(*args, **kwargs).tap do |instance|
+            yield(instance) if block_given?
+            instance.call
+          end
+        end
+      end
+    end
+  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