signal 1.0.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0da1e84da778b581b1e7b325a1437ecc720f56ca
-  data.tar.gz: d1356905f81403f12aac8bebc3205ffb1c031f74
+SHA256:
+  metadata.gz: 42c616e824230754896cad89c03eec41fc73d84743d93d0f869291a4f9a0305f
+  data.tar.gz: f87c40855eac4f158c70a76441e02dc7e3f28c1d2c3a81ede9d0a008013b1fcf
 SHA512:
-  metadata.gz: 1dd9dc2736009aefe24b4aa0dea8d4febd50a3ab9c6b0a8b5eadb95c15e513007c8fedb0bf332809e229e38a0606059b9a8f2a44507f74a47bfabfcb788fbac1
-  data.tar.gz: 292aa7515e1e260860a298da7680235e5418462301042d260d44bc23b0016619eeec6654cc5c045a2ce2527b17b13a1dec9d6808b6f1c2fa67d889c7646057ce
+  metadata.gz: c0fa93fccec13f76eb3b3b47a19c5cf24bcd18a3c8a5c185615c6119c4e65241daf3939198e32489973a4e807d14ee80829d3e43a14c42fd9fd8a813cebf3558
+  data.tar.gz: b8ea8d8a3e015ce73f57b337b83df1a27584c439cf92c0c65fdf5a06f0c3cf477362d7d8c05c1a01e1769402d5245b778c523b63debd35a2c6c8c73e3c67d26b

data/.github/CODEOWNERS

@@ -0,0 +1,4 @@
+# You can read more about CODEOWNERS at
+# https://help.github.com/github/creating-cloning-and-archiving-repositories/about-code-owners
+
+* @fnando

data/.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+---
+github: [fnando]
+custom: ["https://paypal.me/nandovieira/🍕"]

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,41 @@
+---
+name: "🐛 Bug Report"
+about: Report a reproducible bug or regression.
+title: 'Bug: '
+labels: 'Status: Unconfirmed'
+
+---
+
+<!--
+  - Please provide a clear and concise description of what the bug is.
+  - If possible, add an example reproducing your issue.
+  - Please test using the latest version of rails_env
+    to make sure your issue has not already been fixed.
+-->
+
+## Description
+
+[Add bug description here]
+
+## How to reproduce
+
+[Add steps on how to reproduce this issue]
+
+## What do you expect
+
+[Describe what do you expect to happen]
+
+## What happened instead
+
+[Describe the actual results]
+
+## Software:
+
+- Gem version: [Add gem version here]
+- Ruby version: [Add version here]
+
+## Full backtrace
+
+```text
+[Paste full backtrace here]
+```

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: "💡 Feature request"
+about: Have an idea that may be useful? Make a suggestion!
+title: 'Feature Request: '
+labels: 'Feature request'
+
+---
+
+## Description
+
+_A clear and concise description of what the problem is._
+
+## Describe the solution
+
+_A clear and concise description of what you want to happen._
+
+## Alternatives you considered
+
+_A clear and concise description of any alternative solutions or features you've considered._
+
+## Additional context
+
+_Add any other context, screenshots, links, etc about the feature request here._

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,38 @@
+<!--
+If you're making a doc PR or something tiny where the below is irrelevant,
+delete this template and use a short description, but in your description aim to
+include both what the change is, and why it is being made, with enough context
+for anyone to understand.
+-->
+
+<details>
+  <summary>PR Checklist</summary>
+
+### PR Structure
+
+- [ ] This PR has reasonably narrow scope (if not, break it down into smaller
+      PRs).
+- [ ] This PR avoids mixing refactoring changes with feature changes (split into
+      two PRs otherwise).
+- [ ] This PR's title starts is concise and descriptive.
+
+### Thoroughness
+
+- [ ] This PR adds tests for the most critical parts of the new functionality or
+      fixes.
+- [ ] I've updated any docs, `.md` files, etc… affected by this change.
+
+</details>
+
+### What
+
+[TODO: Short statement about what is changing.]
+
+### Why
+
+[TODO: Why this change is being made. Include any context required to understand
+the why.]
+
+### Known limitations
+
+[TODO or N/A]

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+---
+# Documentation:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "daily"
+
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"

data/.github/workflows/ruby-tests.yml

@@ -0,0 +1,53 @@
+---
+name: ruby-tests
+
+on:
+  pull_request:
+  push:
+  workflow_dispatch:
+    inputs: {}
+
+jobs:
+  build:
+    name: Tests with Ruby ${{ matrix.ruby }} and ${{ matrix.gemfile }}
+    runs-on: "ubuntu-latest"
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7", "3.0"]
+        gemfile:
+          - Gemfile
+
+    steps:
+      - uses: actions/checkout@v2.4.0
+
+      - uses: actions/cache@v2.1.7
+        with:
+          path: vendor/bundle
+          key: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles(matrix.gemfile) }}
+          restore-keys: >
+            ${{ runner.os }}-${{ matrix.ruby }}-gems-${{
+            hashFiles(matrix.gemfile) }}
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install gem dependencies
+        env:
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle update --jobs 4 --retry 3
+
+      - name: Run Tests
+        env:
+          PGHOST: localhost
+          PGUSER: postgres
+          BUNDLE_GEMFILE: ${{ matrix.gemfile }}
+        run: |
+          bundle exec rake

data/.rubocop.yml

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

data/Gemfile

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

data/README.md

@@ -1,17 +1,18 @@
 # Signal
 
-[![Build Status](https://travis-ci.org/fnando/signal.svg?branch=master)](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)
+[![Tests](https://github.com/fnando/signal/actions/workflows/ruby-tests.yml/badge.svg)](https://github.com/fnando/signal/actions/workflows/ruby-tests.yml)
+[![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
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'signal'
+gem "signal"
 ```
 
 And then execute:
@@ -28,7 +29,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 +51,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 +77,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,7 +124,8 @@ 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
@@ -151,22 +157,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 +204,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 +229,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 +277,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