flirt 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3595d41a6ad627adc7eefdbb93242a03522ff4e5
-  data.tar.gz: d2a89c116bf434fe75827ca5c85ae3fcfe6958de
+  metadata.gz: ddeb6e470d1d83c9d031c9eadbd763929ea01863
+  data.tar.gz: b9f82e07bde11c678184ee7ac79007c6e2ce7bea
 SHA512:
-  metadata.gz: 1c42aba9604a42b718bca09e68d7ade30b6dbdfc0d10e9114ca658762bc3e72485b27f0c0740227e7621aac39c907446a3fd67ba7c97641ab78532364d9d77d6
-  data.tar.gz: 55d2e892fd50a3694b5c13da4c5d8f4e32da0839d9fbec8b39670c536fee612995d08c423c2b8c171fa6857ccac1280bad2f0a87bf3c37e630281c0a1b5970e9
+  metadata.gz: 9b57170b981b3bbcc68cb5e57304ca0ccd341898eab2d668bb0d22a434c2addab6f73792cf029c084072a6346797ab0fc254a6493cccb82616d5a34e1e88649d
+  data.tar.gz: c7519ff2ae78315188bb0ce004fc22ce36cb70708ab3cba8a62d69bcaeee1c3b6d930d87832abe1abbc90901b6270c5a5d21304acbd6d4bad880a9630c9d151d

data/README.md

@@ -29,20 +29,12 @@ Or install it yourself as:
 
 ## Usage
 
-To publish/broadcast an event:
+To publish an event:
 
-```ruby
-event_data = { fruit: "apple" }
-Flirt.broadcast :picked, event_data
-```
-    
-Or:
 
 ```ruby
 Flirt.publish :picked, event_data
 ```
-    
-(These two versions are aliases)
 
 To subscribe:
 
@@ -50,8 +42,6 @@ To subscribe:
 class MyListener
     def initialize
         Flirt.subscribe self, :picked, with: :picked_callback
-        # or the alias
-        Flirt.listen self, :picked, with: :picked_callback
     end
 
     def picked_callback(event_data)
@@ -60,7 +50,15 @@ class MyListener
 end
 ```
 
-Sytactic sugar for subscription has been provided in the form of a module:
+To unsubscribe:
+
+```ruby
+    Flirt.unsubscribe self, :picked, with: :picked_callback
+end
+```
+
+
+Syntactic sugar for subscription and unsubscription has been provided in the form of a module:
 
 ```ruby
 class MyListener
@@ -68,8 +66,10 @@ class MyListener
 
     def initialize
         subscribe_to :picked, with: :picked_callback
-        # or the alias
-        listen_to :picked, with: :picked_callback
+    end
+    
+    def before_destroy
+        unsubscribe_from :picked, with: :picked_callback
     end
 
     def picked_callback(event_data)
@@ -85,8 +85,6 @@ class MyListener
     extend Flirt::Listener
 
     subscribe_to :picked, with: :picked_callback
-    # or the alias
-    listen_to :picked, with: :picked_callback
 
     def self.picked_callback(event_data)
         puts "The #{event_data[:fruit]} has been picked"
@@ -94,6 +92,8 @@ class MyListener
 end
 ```
 
+```unsubscribe_from``` can technically be used in the class context, but probably doesn't have as much use.
+
 Flirt defaults to 'enabled'. Switch Flirt off:
 
 ```ruby
@@ -121,7 +121,7 @@ Flirt.enable only: [:topping_added, :pancake_flipped]
 Enabled status affects broadcast/publish, listeners can still be added and will be
 remembered. No listeners will be removed.
 
-Clear all listeners
+Clear all listeners:
 
 ```ruby
 Flirt.clear

data/lib/flirt/callback.rb

@@ -2,6 +2,7 @@
 # and contains a method for calling the callback.
 
 module Flirt
+
     class Callback
 
         attr_accessor :object, :callback_name

data/lib/flirt/listener.rb

@@ -32,19 +32,18 @@
 #
 
 module Flirt
+
     module Listener
+
         def subscribe_to(event_name, opts = {})
-            raise ArgumentError.new("You must pass a callback") unless opts[:with].is_a? Symbol
             Flirt.subscribe self, event_name, opts
         end
-        alias_method :listen_to, :subscribe_to
 
 
         def unsubscribe_from(event_name, opts = {})
-            raise ArgumentError.new("You must pass a callback") unless opts[:with].is_a? Symbol
             Flirt.unsubscribe self, event_name, opts
         end
-        alias_method :forget, :unsubscribe_from
 
     end
+
 end

data/lib/flirt/version.rb

@@ -1,3 +1,5 @@
 module Flirt
-  VERSION = "0.0.3"
+
+  VERSION = "0.0.4"
+    
 end

data/lib/flirt.rb

@@ -16,7 +16,6 @@ module Flirt
                 callback.call(event_data)
             end
         end
-        alias_method :broadcast, :publish
 
 
         def subscribe(object, event_name, options = {})
@@ -25,7 +24,6 @@ module Flirt
                                            callback_name: options[:with]
             add_callback(event_name, callback)
         end
-        alias_method :listen, :subscribe
 
 
         def unsubscribe(object, event_name, options = {})
@@ -34,7 +32,6 @@ module Flirt
                                            callback_name: options[:with]
             remove_callback(event_name, callback)
         end
-        alias_method :unlisten, :unsubscribe
 
 
         def enable
@@ -79,10 +76,11 @@ module Flirt
 
 
         def check_subscription_arguments(event_name, object, options)
-            raise ArgumentError.new("You must pass a callback") unless    options[:with].is_a? Symbol
-            raise ArgumentError.new("You must pass an object")  if        object.nil?
+            raise ArgumentError.new("You must pass a callback")    unless options[:with].is_a? Symbol
             raise ArgumentError.new("You must pass an event name") unless event_name.is_a? Symbol
+            raise ArgumentError.new("You must pass an object")     if     object.nil?
         end
 
     end
+
 end

data/spec/flirt/flirt_listener_spec.rb

@@ -27,29 +27,23 @@ describe Flirt::Listener do
         end
 
 
-        [:listen_to, :subscribe_to].each do |method|
-            it "subscribes to an event with ##{method}" do
-                block_event = event
-                block_callback_name = callback_name
-                expect(Flirt).to receive(:subscribe).with(test_instance, event, { with: callback_name })
-                test_instance.instance_eval do
-                    send method, block_event, with: block_callback_name
-                end
-
+        it "subscribes to an event with #subscribe_to" do
+            block_event = event
+            block_callback_name = callback_name
+            expect(Flirt).to receive(:subscribe).with(test_instance, event, { with: callback_name })
+            test_instance.instance_eval do
+                subscribe_to block_event, with: block_callback_name
             end
 
         end
 
 
-        [:forget, :unsubscribe_from].each do |method|
-            it "unsubscribes from an event with ##{method}" do
-                block_event = event
-                block_callback_name = callback_name
-                expect(Flirt).to receive(:unsubscribe).with(test_instance, event, { with: callback_name })
-                test_instance.instance_eval do
-                    send method, block_event, with: block_callback_name
-                end
-
+        it "unsubscribes from an event with #unsubscribe_from" do
+            block_event = event
+            block_callback_name = callback_name
+            expect(Flirt).to receive(:unsubscribe).with(test_instance, event, { with: callback_name })
+            test_instance.instance_eval do
+                unsubscribe_from block_event, with: block_callback_name
             end
 
         end
@@ -68,31 +62,25 @@ describe Flirt::Listener do
         let(:test_class)          { Class.new }
 
 
-        [:listen_to, :subscribe_to].each do |method|
-            it "subscribes to an event with ##{method}" do
-                block_event = event
-                block_callback_name = callback_name
-                expect(Flirt).to receive(:subscribe).with(test_class, event, { with: callback_name })
-                test_class.class_eval do
-                    extend Flirt::Listener
-                    send method, block_event, with: block_callback_name
-                end
-
+        it "subscribes to an event with #subscribe_to" do
+            block_event = event
+            block_callback_name = callback_name
+            expect(Flirt).to receive(:subscribe).with(test_class, event, { with: callback_name })
+            test_class.class_eval do
+                extend Flirt::Listener
+                subscribe_to block_event, with: block_callback_name
             end
 
         end
 
 
-        [:forget, :unsubscribe_from].each do |method|
-            it "unsubscribes from an event with ##{method}" do
-                block_event = event
-                block_callback_name = callback_name
-                expect(Flirt).to receive(:unsubscribe).with(test_class, event, { with: callback_name })
-                test_class.class_eval do
-                    extend Flirt::Listener
-                    send method, block_event, with: block_callback_name
-                end
-
+        it "unsubscribes from an event with #unsubscribe_from" do
+            block_event = event
+            block_callback_name = callback_name
+            expect(Flirt).to receive(:unsubscribe).with(test_class, event, { with: callback_name })
+            test_class.class_eval do
+                extend Flirt::Listener
+                unsubscribe_from block_event, with: block_callback_name
             end
 
         end

data/spec/flirt/flirt_spec.rb

@@ -16,85 +16,75 @@ describe Flirt do
         let!(:listener)   { Object.new }
 
 
-        [:subscribe, :listen].each do |method|
+        describe "and a listener added with #subscribe" do
 
-            describe "and a listener added with ##{method}" do
-
-                before(:each) do
-                    Flirt.send method, listener, event, with: callback
-                end
-
-
-                [:publish, :broadcast].each do |method|
-
-                    it "listens to the correct event published with ##{method}" do
-                        expect(listener).to receive(callback).with(response)
-                        Flirt.send method, event, response
-                    end
+            before(:each) do
+                Flirt.subscribe listener, event, with: callback
+            end
 
 
-                    it "doesn't listen to the wrong event published with ##{method}" do
-                        expect(listener).not_to receive(callback)
-                        Flirt.send method, wrong_event, response
-                    end
+            it "listens to the correct event published with #publish" do
+                expect(listener).to receive(callback).with(response)
+                Flirt.publish event, response
+            end
 
 
-                    describe "when disabled" do
+            it "doesn't listen to the wrong event published with #publish" do
+                expect(listener).not_to receive(callback)
+                Flirt.publish wrong_event, response
+            end
 
-                        before(:each) { Flirt.disable }
 
-                        after(:each) { Flirt.enable }
+            describe "when disabled" do
 
+                before(:each) { Flirt.disable }
 
-                        it "doesn't broadcast an event published with ##{method}" do
-                            expect(listener).not_to receive(callback)
-                            Flirt.send method, event, response
-                        end
+                after(:each) { Flirt.enable }
 
-                    end
 
+                it "doesn't publish an event" do
+                    expect(listener).not_to receive(callback)
+                    Flirt.publish event, response
                 end
 
-                describe "when cleared" do
-
-                    let(:callback2)    { :respond2 }
+            end
 
 
-                    before(:each) do
-                        Flirt.listen listener, event, with: callback2
-                        Flirt.clear
-                    end
+            describe "when cleared" do
 
+                let(:callback2)    { :respond2 }
 
-                    it "forgets listeners" do
-                        expect(listener).not_to receive(callback)
-                        expect(listener).not_to receive(callback2)
-                        Flirt.publish event, response
-                    end
 
+                before(:each) do
+                    Flirt.subscribe listener, event, with: callback2
+                    Flirt.clear
                 end
 
-                [:unsubscribe, :unlisten].each do |method|
 
-                    describe "when another listener is added and the original unsubscribed with ##{method}" do
+                it "forgets listeners" do
+                    expect(listener).not_to receive(callback)
+                    expect(listener).not_to receive(callback2)
+                    Flirt.publish event, response
+                end
+
+            end
 
-                        let(:callback2)    { :respond2 }
 
+            describe "when another listener is added and the original is unsubscribed" do
 
-                        before(:each) do
-                            Flirt.listen listener, event, with: callback2
-                            Flirt.send method, listener, event, with: callback
-                        end
+                let(:callback2)    { :respond2 }
 
 
-                        it "it forgets the original listener but remembers the new one" do
-                            expect(listener).not_to receive(callback)
-                            expect(listener).to receive(callback2).with(response)
-                            Flirt.broadcast event, response
-                        end
+                before(:each) do
+                    Flirt.subscribe listener, event, with: callback2
+                    Flirt.unsubscribe listener, event, with: callback
+                end
 
-                    end
 
+                it "it forgets the original listener but remembers the new one" do
+                    expect(listener).not_to receive(callback)
+                    expect(listener).to receive(callback2).with(response)
+                    Flirt.publish event, response
                 end
 
             end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flirt
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Benjamin Randles-Dunkley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-29 00:00:00.000000000 Z
+date: 2015-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler