shouter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f01d5e611309eff3f12fc296e56ba81bbf46a71c
+  data.tar.gz: 312e00888703e49abc114f2840a8503c3162bdef
+SHA512:
+  metadata.gz: 636653c15d3730feb4d45f944e4f0d3f161cb5c6bc6d5edabf78247b69e77f9539222df61ed074b225797eadb4f84b3783aee7d6033836b833ec0d0ac8da48f9
+  data.tar.gz: a55ead88d51bef5703734ee883834c6ca9bde9c9a1d3367292c3414e125c1f0dbb60a9c7d1bb7e5f4eaf50a2e07d0698e6ddc87b3374868d262112ad3a07d591

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at wizard.oneandonly@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bouncer.gemspec
+gemspec
+gem 'byebug', group: :test
+gem 'codecov', group: :test, require: false

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Stefan Slaveykov
+
+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,88 @@
+# Shouter
+[![Build Status](https://travis-ci.org/wizardone/bouncer.svg?branch=master)](https://travis-ci.org/wizardone/bouncer)
+[![codecov](https://codecov.io/gh/wizardone/bouncer/branch/master/graph/badge.svg)](https://codecov.io/gh/wizardone/bouncer)
+
+`Shouter` is a very simple and lightweight publish/subscription DSL for
+Ruby applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'shouter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shouter
+
+## Usage
+```ruby
+class A
+  extend Shouter
+  subscribe(Listener.new, for: :my_scope)
+end
+
+class Listener
+  def on_change
+    "I`m changed"
+  end
+end
+
+A.publish(:my_scope, :on_change)
+=> "I`m changed"
+```
+
+You can subscribe multiple objects:
+```ruby
+class A
+  extend Shouter
+  subscribe(Listener.new, Listener1.new, Listener2.new, for: :my_scope)
+end
+```
+
+You can subscribe an object for single execution, after that the object
+will be removed from the listener store
+```ruby
+class A
+  extend Shouter
+  subscribe(Listener.new, for: :my_scope, single: true)
+end
+
+A.publish(:my_scope, :on_change)
+=> "I`m changed"
+
+A.publish(:my_scope, :on_change)
+=> nil
+
+```
+
+You can also pass a block to the publish method, which will serve as a
+successful callback, meaning it will only get executed after the event
+has been triggered
+```ruby
+A.publish(:my_scope, :on_change) do
+  puts "I am callback"
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wizardone/shouter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shouter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shouter.rb

@@ -0,0 +1,22 @@
+require 'shouter/version'
+require 'shouter/listener'
+require 'shouter/store'
+
+module Shouter
+  def subscribe(*objects, **options)
+    Shouter::Store.register(objects, options)
+  end
+
+  def unsubscribe(*objects)
+    Shouter::Store.unregister(objects)
+  end
+
+  def publish(scope, event, *args, &block)
+    Shouter::Store.notify(scope, event, args, &block)
+  end
+
+  def clear
+    Shouter::Store.clear
+  end
+  alias_method :clear_listeners, :clear
+end

data/lib/shouter/listener.rb

@@ -0,0 +1,27 @@
+module Shouter
+
+  class ScopeMissingError < StandardError
+    def initialize
+      'You must supply a scope for running the events'
+    end
+  end
+
+  class Listener
+    attr_reader :object, :options
+
+    def initialize(object, options)
+      raise Shouter::ScopeMissingError unless options[:scope]
+
+      @object = object
+      @options = options
+    end
+
+    def for?(scope)
+      options[:scope] == scope
+    end
+
+    def single?
+      options[:single] == true
+    end
+  end
+end

data/lib/shouter/store.rb

@@ -0,0 +1,57 @@
+module Shouter
+
+  NoInheritanceAllowedError = Class.new(StandardError)
+
+  class Store
+
+    # Implement a simple Singleton pattern
+    private_class_method :new
+    @@listeners = []
+    @@mutex = Mutex.new
+
+    class << self
+
+      def inherited(subclass)
+        raise NoInheritanceAllowedError.new("#{self.class.to_s} is meant to be a singleton class and not to be inherited")
+      end
+
+      def register(objects, options)
+        mutex.synchronize do
+          objects.each { |object| @@listeners << Shouter::Listener.new(object, options) }
+        end
+      end
+
+      def unregister(objects)
+        mutex.synchronize do
+          [*objects].each { |object| listeners.delete_if { |listener| listener.object == object } }
+        end
+      end
+
+      def clear
+        mutex.synchronize do
+          @@listeners = []
+        end
+      end
+
+      def notify(scope, event, args)
+        return if listeners.empty?
+
+        listeners.select { |listener| listener.for?(scope) }.each do |listener|
+          klass = listener.object
+          klass.public_send(event, *args) if klass.respond_to?(event)
+          # Serves as callback
+          yield if block_given?
+          unregister(klass) if listener.single?
+        end
+      end
+
+      def listeners
+        @@listeners
+      end
+
+      def mutex
+        @@mutex
+      end
+    end
+  end
+end

data/lib/shouter/version.rb

@@ -0,0 +1,3 @@
+module Shouter
+  VERSION = "0.1.0"
+end

data/shouter.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'shouter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "shouter"
+  spec.version       = Shouter::VERSION
+  spec.authors       = ["Stefan Slaveykov"]
+  spec.email         = ["wizard.oneandonly@gmail.com"]
+
+  spec.summary       = %q{Small publish/subscription based system in Ruby}
+  spec.description   = %q{A small gem that allows you to publish and subscribe to events}
+  spec.homepage      = "https://github.com/wizardone/bouncer"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '~> 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: shouter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stefan Slaveykov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A small gem that allows you to publish and subscribe to events
+email:
+- wizard.oneandonly@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shouter.rb
+- lib/shouter/listener.rb
+- lib/shouter/store.rb
+- lib/shouter/version.rb
+- shouter.gemspec
+homepage: https://github.com/wizardone/bouncer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Small publish/subscription based system in Ruby
+test_files: []