flirt 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b120f2410701ad2d63d29cc453c273021a5a23dc
+  data.tar.gz: da528cc1e2678262357854934f86064e723a6568
+SHA512:
+  metadata.gz: 8ebacbf7408b4e5d48702204e9b16490c4e1ef1e4810f56ae0940d6e9af7ea3cd03e47f01c56cc67cec8eaf63130dbfa2aa1e5965414719482ae60b30c425949
+  data.tar.gz: 00232c11f40b4b5051d679c95af55e4a6f974790befbd511acd99a9777d67b29f52df01136cde92a2cdd4f707d37211f72bcc18f7bce9a81223e05b72881c594

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flirt.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 chemica
+
+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 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/README.md

@@ -0,0 +1,136 @@
+# Flirt
+
+This Ruby gem is a brutally simple take on the observer pattern.
+
+Flirt acts as a single point to which events can be sent and listeners 
+can be registered, in order to promote extreme decoupling between components.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'flirt'
+```
+
+And then execute:
+
+```ruby
+$ bundle
+```
+
+Or install it yourself as:
+
+```ruby
+    $ gem install flirt
+```
+
+
+## Usage
+
+To publish/broadcast 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:
+
+```ruby
+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)
+        puts "The #{event_data[:fruit]} has been picked"
+    end
+end
+```
+
+Sytactic sugar for subscription has been provided in the form of a module:
+
+```ruby
+class MyListener
+    include Flirt::Listener
+
+    def initialize
+        subscribe_to :picked, with: :picked_callback
+        # or the alias
+        listen_to :picked, with: :picked_callback
+    end
+
+    def picked_callback(event_data)
+        puts "The #{event_data[:fruit]} has been picked"
+    end
+end
+```
+
+or even:
+
+```ruby
+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"
+    end
+end
+```
+
+Flirt defaults to 'enabled'. Switch Flirt off:
+
+```ruby
+Flirt.disable
+```
+
+And back on again:
+
+```ruby
+Flirt.enable
+```
+
+TODO: Disable only a set of events:
+
+```ruby
+Flirt.disable only: [:pancake_cooked, :picked]
+```
+
+TODO: Enable only a set of events:
+
+```ruby
+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
+
+```ruby
+Flirt.clear
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/flirt/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/flirt.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flirt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flirt"
+  spec.version       = Flirt::VERSION
+  spec.authors       = ["Benjamin Randles-Dunkley"]
+  spec.email         = ["ben@chemica.co.uk"]
+  spec.summary       = %q{ A brutally simple take on the observer pattern. }
+  spec.description   = %q{ Provides a single point for the publication and subscription of events, promoting extreme decoupling. }
+  spec.homepage      = "https://github.com/chemica/flirt"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

data/lib/flirt/callback.rb

@@ -0,0 +1,16 @@
+# Represents a single callback. Contains knowledge of the callback name and object
+# and contains a method for calling the callback.
+
+module Flirt
+    class Callback
+        attr_accessor :object, :callback_name
+        def initialize(opts = {})
+            self.callback_name = opts.fetch(:callback_name)
+            self.object        = opts.fetch(:object)
+        end
+
+        def call(event_data)
+            object.send callback_name, event_data
+        end
+    end
+end

data/lib/flirt/listener.rb

@@ -0,0 +1,42 @@
+# Syntactic sugar for adding a listener. Use include or extend to
+# add listen/subscribe behaviour to your class instance
+# or class body.
+
+# class MyListener
+#     include Flirt::Listener
+#
+#     def initialize
+#         subscribe_to :picked, with: :picked_callback
+#         # or the alias
+#         listen_to :picked, with: :picked_callback
+#     end
+#
+#     def picked_callback(event_data)
+#         puts "The #{event_data[:fruit]} has been picked"
+#     end
+# end
+#
+# or:
+#
+# 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"
+#     end
+# end
+#
+
+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
+    end
+end

data/lib/flirt/version.rb

@@ -0,0 +1,3 @@
+module Flirt
+  VERSION = "0.0.1"
+end

data/lib/flirt.rb

@@ -0,0 +1,58 @@
+require "flirt/version"
+require "flirt/callback"
+require "flirt/listener"
+# The Flirt module provides the main interface for dealing with Flirt.
+#
+
+module Flirt
+
+    class << self
+
+        def broadcast(event_name, event_data)
+            return if disabled
+            raise ArgumentError.new("Event name must be a symbol") unless event_name.is_a? Symbol
+            (callbacks[event_name] || []).each do |callback|
+                callback.call(event_data)
+            end
+        end
+        alias_method :publish, :broadcast
+
+        def subscribe(object, event_name, 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 an event name") unless event_name.is_a? Symbol
+            callback = Flirt::Callback.new object: object,
+                                           callback_name: options[:with]
+            add_callback(event_name, callback)
+        end
+        alias_method :listen, :subscribe
+
+        def enable
+            self.disabled = false
+        end
+
+        def disable
+            self.disabled = true
+        end
+
+        def clear
+            @callbacks = {}
+        end
+
+        private
+
+        attr_reader   :callbacks
+        attr_accessor :disabled
+
+        def callbacks
+            @callbacks ||= {}
+        end
+
+        def add_callback(event_name, callback)
+            callbacks[event_name] ||= []
+            callbacks[event_name] << callback
+        end
+
+    end
+
+end

data/spec/flirt/flirt_callback_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Flirt::Callback do
+    before(:each) do
+        Flirt.enable
+    end
+
+    describe "when instantiated with an object and callback" do
+
+        let(:listener) { Object.new }
+        let(:callback_name) { :call_me }
+
+        let(:callback) { Flirt::Callback.new object: listener, callback_name: callback_name }
+
+        it "sets the object" do
+            expect(callback.object).to eq(listener)
+        end
+
+        it "sets the callback" do
+            expect(callback.callback_name).to eq(callback_name)
+        end
+
+        describe "when called" do
+
+            let(:event_data) { {event: :data} }
+
+            it "calls the callback with the event data" do
+                expect(listener).to receive(callback_name).with(event_data)
+                callback.call(event_data)
+            end
+        end
+    end
+end

data/spec/flirt/flirt_listener_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'flirt/flirt_test_classes'
+
+describe Flirt::Listener do
+    before(:each) do
+        Flirt.enable
+    end
+
+    describe "when included in an instance" do
+        let(:event)               { :grabbed_coin }
+        let(:callback_name)       { :increase_score }
+        let(:event_data)          { { value: 100 } }
+        let(:instance_subscriber) { TestInstanceSubscriber.new event, callback_name }
+        let(:instance_listener)   { TestInstanceListener.new event, callback_name }
+
+        it "subscribes to an event" do
+            expect(instance_subscriber).to receive(callback_name).with(event_data)
+            Flirt.broadcast event, event_data
+        end
+
+        it "listens to an event" do
+            expect(instance_listener).to receive(callback_name).with(event_data)
+            Flirt.broadcast event, event_data
+        end
+    end
+
+    describe "when included in a class" do
+        let(:event)               { :event_name }
+        let(:callback_name)       { :callback_name }
+        let(:event_data)          { { value: 100 } }
+        let(:class_subscriber)    { TestClassSubscriber }
+        let(:class_listener)      { TestClassListener }
+
+        # Because rspec has to clear the Flirt callbacks for each test,
+        # we need to require the test classes after rspec init.
+
+        it "subscribes to an event" do
+            require 'flirt/test_class_subscriber'
+            expect(class_subscriber).to receive(callback_name).with(event_data)
+            Flirt.broadcast event, event_data
+        end
+
+        it "listens to an event" do
+            require 'flirt/test_class_listener'
+            expect(class_listener).to receive(callback_name).with(event_data)
+            Flirt.broadcast event, event_data
+        end
+    end
+end

data/spec/flirt/flirt_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'flirt/flirt_test_classes'
+
+describe Flirt do
+
+    describe "with a single :pancake_fried subscriber" do
+
+        let(:response)    { { topping: "cream" } }
+        let(:event)       { :pancake_fried }
+        let(:wrong_event) { :spud_baked }
+        let!(:listener)   { TestListener.new(event) }
+
+        it "listens to the correct broadcast event" do
+            Flirt.broadcast event, response
+            expect(listener.responded).to eq(response)
+        end
+
+        it "listens to the correct publish event" do
+            Flirt.publish event, response
+            expect(listener.responded).to eq(response)
+        end
+
+        it "doesn't listen to the wrong broadcast event" do
+            Flirt.broadcast wrong_event, response
+            expect(listener.responded).to be_nil
+        end
+
+        it "doesn't listen to the wrong publish event" do
+            Flirt.broadcast wrong_event, response
+            expect(listener.responded).to be_nil
+        end
+    end
+end

data/spec/flirt/flirt_test_classes.rb

@@ -0,0 +1,45 @@
+
+class TestSubscriber
+
+    attr_accessor :responded
+
+    def initialize(event)
+        Flirt.subscribe self, event, with: :respond
+    end
+
+    def respond(event_data)
+        self.responded = event_data
+    end
+end
+
+
+class TestListener
+
+    attr_accessor :responded
+
+    def initialize(event)
+        Flirt.listen self, event, with: :respond
+    end
+
+    def respond(event_data)
+        self.responded = event_data
+    end
+end
+
+class TestInstanceSubscriber
+    include Flirt::Listener
+
+    def initialize(event, callback)
+        subscribe_to event, with: callback
+    end
+end
+
+class TestInstanceListener
+    include Flirt::Listener
+
+    attr_accessor :responded
+
+    def initialize(event, callback)
+        listen_to event, with: callback
+    end
+end

data/spec/flirt/test_class_listener.rb

@@ -0,0 +1,9 @@
+class TestClassListener
+    extend Flirt::Listener
+
+    class << self
+        attr_accessor :responded
+    end
+
+    listen_to :event_name, with: :callback_name
+end

data/spec/flirt/test_class_subscriber.rb

@@ -0,0 +1,9 @@
+class TestClassSubscriber
+    extend Flirt::Listener
+
+    class << self
+        attr_accessor :responded
+    end
+
+    subscribe_to :event_name, with: :callback_name
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+require 'rubygems'
+require 'bundler/setup'
+Bundler.setup
+
+require 'flirt'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.before(:each) do
+      Flirt.clear
+  end
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: flirt
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Benjamin Randles-Dunkley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: " Provides a single point for the publication and subscription of events,
+  promoting extreme decoupling. "
+email:
+- ben@chemica.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- flirt.gemspec
+- lib/flirt.rb
+- lib/flirt/callback.rb
+- lib/flirt/listener.rb
+- lib/flirt/version.rb
+- spec/flirt/flirt_callback_spec.rb
+- spec/flirt/flirt_listener_spec.rb
+- spec/flirt/flirt_spec.rb
+- spec/flirt/flirt_test_classes.rb
+- spec/flirt/test_class_listener.rb
+- spec/flirt/test_class_subscriber.rb
+- spec/spec_helper.rb
+homepage: https://github.com/chemica/flirt
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A brutally simple take on the observer pattern.
+test_files:
+- spec/flirt/flirt_callback_spec.rb
+- spec/flirt/flirt_listener_spec.rb
+- spec/flirt/flirt_spec.rb
+- spec/flirt/flirt_test_classes.rb
+- spec/flirt/test_class_listener.rb
+- spec/flirt/test_class_subscriber.rb
+- spec/spec_helper.rb