signal 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bab949237a86fb74f7d3d89ce215a614f87f725
-  data.tar.gz: cc343238a6eacaa010c910ebff962729baa62f30
+  metadata.gz: f93acc02fac0dc15d821540be7b8429a1c4ee767
+  data.tar.gz: ccbf61c85f7448b07f32e5a708905862b63a66f3
 SHA512:
-  metadata.gz: 1358d2e51f6f5fb757fdad35e74325adc15be310d6a1b56ea7dd432b7861afee4ffd2b32fbe41d473bd8335eb39b11d7957ce29fb587cdfdbb7012e191c34034
-  data.tar.gz: 55b1bd38fbb3b9ac9eb10c29feb6f3cfb5bf4116e30400e91da211571661080132ba3edd5bbd780139747c0271fcc9497e5bd1c15e717d810f2b66743210cf10
+  metadata.gz: edebdf9690ad027d27f25a1e80d94272750b1a62434df184d6894c7a253b0f050fe06dda337601179886d22b02d4bffeb5155e695a8d7d09b27f88aef4f3d1f6
+  data.tar.gz: 055b3b383611a0de961f0f66d4cfd7b0b40fcfc36dd252e46d2cdade60dd34b9f73ce50bd07a4e677e596063c3154dbb96687ac788236d4cad9e06a6a15526ac

data/README.md

@@ -172,13 +172,55 @@ Although there's no special code for Rails, here's just an example of how you ca
 class UsersController < ApplicationController
   def create
     @user = User.new(user_params)
+
     Signup.new(@user)
       .on(:success) { redirect_to login_path, notice: 'Welcome to MyApp!' }
       .on(:failure) { render :new }
+      .call
   end
 end
 ```
 
+If you're using plain ActiveRecord, just do something like the following:
+
+```ruby
+class UsersController < ApplicationController
+  def create
+    @user = User.new(user_params)
+    @user
+      .on(:create) { redirect_to login_path, notice: 'Welcome to MyApp!' }
+      .on(:validation) { render :new }
+      .save
+  end
+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.
+
+```ruby
+class Contact
+  include Signal.call
+
+  attr_reader :name, :email
+
+  def initialize(name, email)
+    @name, @email = name, email
+  end
+
+  def call
+    emit(:output, self)
+  end
+end
+
+Contact.call('John', 'john@example.com') do |o|
+  o.on(:output) {|contact| puts contact }
+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.
+
 ## Contributing
 
 1. Fork it
@@ -197,7 +239,7 @@ 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, sublicense, and/or sell copies of the Software, and to
+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:
 

data/lib/signal.rb

@@ -1,5 +1,6 @@
 require 'signal/active_record'
 require 'signal/listener'
+require 'signal/call'
 require 'signal/version'
 
 module Signal

data/lib/signal/call.rb

@@ -0,0 +1,21 @@
+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/lib/signal/version.rb

@@ -1,3 +1,3 @@
 module Signal
-  VERSION = '0.2.2'
+  VERSION = '0.3.0'
 end

data/spec/signal/call_spec.rb

@@ -0,0 +1,18 @@
+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/spec_helper.rb

@@ -8,6 +8,7 @@ I18n.enforce_available_locales = false
 
 require 'signal'
 require 'support/observable'
+require 'support/observable_with_call'
 require 'support/callable'
 require 'support/user'
 

data/spec/support/observable_with_call.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: signal
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-10 00:00:00.000000000 Z
+date: 2015-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -89,15 +89,18 @@ files:
 - examples/listener.rb
 - lib/signal.rb
 - lib/signal/active_record.rb
+- lib/signal/call.rb
 - lib/signal/listener.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: []
@@ -125,10 +128,11 @@ summary: A simple observer implementation for POROs (Plain Old Ruby Object) and
   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
-has_rdoc: