spine-hub 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e0ccc25b91940f8d3ad1cfe542b9b6d3fa648503
+  data.tar.gz: 2a4047e93926e7913f9b8d7236132e652e1222ed
+SHA512:
+  metadata.gz: 83d1fa219bca4ffeff20fa24d4650ad77807be5a5791cd5f359f0978d5df5672610233d882f5f7c1d039a0509fcd062e217df320174921db90eece4f1d3cd0c2
+  data.tar.gz: 5598470942c02544ea13b5fc9144650778e2791f6cece05fb11f68dc35b4f9523c05f3b8d8c6bb83c38fa88676c7a7de4d1e58f892745099e6a5102f19b9c4ce

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/bin/
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require config/default

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    spine-hub (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.4.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  rake (~> 10.0)
+  rspec (~> 3.2)
+  spine-hub!

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2015, TOGGL LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the TOGGL LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,59 @@
+# Spine::Hub
+
+[![Gem Version](https://badge.fury.io/rb/spine-hub.svg)](http://badge.fury.io/rb/spine-hub)
+[![Dependency Status](https://gemnasium.com/rspine/hub.svg)](https://gemnasium.com/rspine/hub)
+[![Code Climate](https://codeclimate.com/github/rspine/hub/badges/gpa.svg)](https://codeclimate.com/github/rspine/hub)
+[![Codeship Status for rspine/hub](https://codeship.com/projects/951d2de0-e105-0132-721b-5eabae96dc8d/status?branch=master)](https://codeship.com/projects/81031)
+
+Provides Publish/Subscribe pattern.
+
+## Installation
+
+To install it, add the gem to your Gemfile:
+
+```ruby
+gem 'spine-hub'
+```
+
+Then run `bundle`. If you're not using Bundler, just `gem install spine-hub`.
+
+## Usage
+
+```ruby
+class Service
+  include Spine::Hub::Publisher
+
+  def action
+    publish(:action_executing)
+    # ...
+    publish(:action_executed, 'OK')
+  end
+end
+
+class Listener
+  include Spine::Hub::Subscriber
+
+  def on_action_executing
+    puts 'Executing action'
+  end
+end
+
+service = Service.new
+service.subscribe(Listener)
+service.on(:action_executed) do |status|
+  puts "Action executed: #{ status }"
+end
+service.action
+```
+
+There is also `Spine::Hub::Repeater`, which repeats subscribed events. If you
+need to get more control over subscriber event handling, implement notify
+method:
+
+```ruby
+class MySubscriber
+  def notify(event, *arguments)
+    # Handle events
+  end
+end
+```

data/Rakefile

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

data/lib/spine-hub.rb

@@ -0,0 +1 @@
+require 'spine/hub'

data/lib/spine/hub.rb

@@ -0,0 +1,11 @@
+module Spine
+  module Hub
+    autoload :Publisher, 'spine/hub/publisher'
+    autoload :Subscriber, 'spine/hub/subscriber'
+    autoload :Repeater, 'spine/hub/repeater'
+
+    module Subscriptions
+      autoload :Closure, 'spine/hub/subscriptions/closure'
+    end
+  end
+end

data/lib/spine/hub/publisher.rb

@@ -0,0 +1,42 @@
+module Spine
+  module Hub
+    module Publisher
+      def subscribers
+        @subscribers ||= []
+      end
+
+      # Adds subscribers.
+      #
+      # ==== Attributes
+      # * +subscribers+ - List of addable subscribers.
+      def subscribe(*subscribers)
+        @subscribers ||= []
+        @subscribers += subscribers
+      end
+
+      # Publishes event to subscribers.
+      #
+      # ==== Attributes
+      # * +event+ - Name of event.
+      # * +arguments+ - List of event arguments.
+      def publish(event, *arguments)
+        subscribers.each do |subscriber|
+          if subscriber.respond_to?(:notify)
+            subscriber.notify(event, *arguments)
+          end
+        end
+      end
+
+      # Adds block subscriber.
+      #
+      # ==== Arguments
+      # * +event+ - Subscriber triggering event.
+      def on(event, &block)
+        if block_given?
+          subscribe(Subscriptions::Closure.new(event, block))
+        end
+        self
+      end
+    end
+  end
+end

data/lib/spine/hub/repeater.rb

@@ -0,0 +1,16 @@
+module Spine
+  module Hub
+    module Repeater
+      include Publisher
+
+      # Republishes the event.
+      #
+      # ==== Attributes
+      # * +event+ - Name of event.
+      # * +arguments+ - Arguments for event.
+      def notify(event, *arguments)
+        publish(event, *arguments)
+      end
+    end
+  end
+end

data/lib/spine/hub/subscriber.rb

@@ -0,0 +1,16 @@
+module Spine
+  module Hub
+    module Subscriber
+      # Notifies subscriber about event. It delegates processing that event
+      # to on_<event> method with specified arguments.
+      #
+      # ==== Attributes
+      # * +event+ - Name of event.
+      # * +arguments+ - Arguments for event.
+      def notify(event, *arguments)
+        method_name = "on_#{ event }".to_sym
+        send(method_name, *arguments) if respond_to?(method_name)
+      end
+    end
+  end
+end

data/lib/spine/hub/subscriptions/closure.rb

@@ -0,0 +1,37 @@
+module Spine
+  module Hub
+    module Subscriptions
+      # Subscriber for blocks.
+      #
+      # == Requirements
+      # * +event+ - Subscriber triggering event.
+      # * +action+ - Block to execute.
+      class Closure
+        attr_reader :trigger, :action
+
+        def initialize(event, action)
+          @trigger = event
+          @action = action
+        end
+
+        # Notifies subscriber about event. When event matches with triggering
+        # event it executes action.
+        #
+        # ==== Attributes
+        # * +event+ - Name of event.
+        # * +arguments+ - Arguments for event.
+        def notify(event, *arguments)
+          action.call(*arguments) if trigger?(event)
+        end
+
+        # Returns true when subscriber is triggered by specified event.
+        #
+        # ==== Attributes
+        # * +event+ - Name of event.
+        def trigger?(event)
+          trigger == event
+        end
+      end
+    end
+  end
+end

data/lib/spine/hub/version.rb

@@ -0,0 +1,5 @@
+module Spine
+  module Hub
+    VERSION = "0.1.0"
+  end
+end

data/spec/config/default.rb

@@ -0,0 +1,20 @@
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+  end
+end

data/spec/spine/hub/publisher_spec.rb

@@ -0,0 +1,54 @@
+require 'spine/hub'
+
+module Spine
+  module Hub
+    describe Publisher do
+      subject { double.extend(Publisher) }
+
+      let(:subscriber) { double }
+
+      it 'has subscribers' do
+        expect(subject.subscribers).to eq([])
+      end
+
+      it 'adds subscriber' do
+        subject.subscribe(subscriber)
+        expect(subject.subscribers).to include(subscriber)
+      end
+
+      it 'publishes event to subscriber' do
+        expect(subscriber).to receive(:notify).with(:test, 1)
+
+        subject.subscribe(subscriber)
+        subject.publish(:test, 1)
+      end
+
+      it 'published event without subscribers' do
+        subject.publish(:test, 1)
+      end
+
+      context 'when subscribing to event with closure' do
+        it 'adds closure subscription' do
+          subject.on(:test) do
+          end
+          expect(subject.subscribers.size).to eq(1)
+        end
+
+        it 'skips adding empty closure subscription' do
+          subject.on(:test)
+          expect(subject.subscribers.size).to eq(0)
+        end
+
+        it 'publishes event to closure subscription' do
+          published_value = nil
+          subject.on(:test) do |value|
+            published_value = value
+          end
+
+          subject.publish(:test, 1)
+          expect(published_value).to eq(1)
+        end
+      end
+    end
+  end
+end

data/spec/spine/hub/subscriber_spec.rb

@@ -0,0 +1,14 @@
+require 'spine/hub'
+
+module Spine
+  module Hub
+    describe Subscriber do
+      subject { double.extend(Subscriber) }
+
+      it 'delegates notification to event handler' do
+        expect(subject).to receive(:on_test).with(1)
+        subject.notify(:test, 1)
+      end
+    end
+  end
+end

data/spine-hub.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spine/hub/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spine-hub"
+  spec.version       = Spine::Hub::VERSION
+  spec.authors       = ["TOGGL LLC"]
+  spec.email         = ["support@toggl.com"]
+  spec.summary       = 'Spine hub for Ruby applications.'
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/rspine/hub'
+  spec.license       = 'BSD-3-Clause'
+
+  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

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: spine-hub
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TOGGL LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-20 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: ''
+email:
+- support@toggl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/spine-hub.rb
+- lib/spine/hub.rb
+- lib/spine/hub/publisher.rb
+- lib/spine/hub/repeater.rb
+- lib/spine/hub/subscriber.rb
+- lib/spine/hub/subscriptions/closure.rb
+- lib/spine/hub/version.rb
+- spec/config/default.rb
+- spec/spine/hub/publisher_spec.rb
+- spec/spine/hub/subscriber_spec.rb
+- spine-hub.gemspec
+homepage: https://github.com/rspine/hub
+licenses:
+- BSD-3-Clause
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Spine hub for Ruby applications.
+test_files:
+- spec/config/default.rb
+- spec/spine/hub/publisher_spec.rb
+- spec/spine/hub/subscriber_spec.rb