shouter 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: f01d5e611309eff3f12fc296e56ba81bbf46a71c
4
+ data.tar.gz: 312e00888703e49abc114f2840a8503c3162bdef
5
+ SHA512:
6
+ metadata.gz: 636653c15d3730feb4d45f944e4f0d3f161cb5c6bc6d5edabf78247b69e77f9539222df61ed074b225797eadb4f84b3783aee7d6033836b833ec0d0ac8da48f9
7
+ data.tar.gz: a55ead88d51bef5703734ee883834c6ca9bde9c9a1d3367292c3414e125c1f0dbb60a9c7d1bb7e5f4eaf50a2e07d0698e6ddc87b3374868d262112ad3a07d591
@@ -0,0 +1,10 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /Gemfile.lock
4
+ /_yardoc/
5
+ /coverage/
6
+ /doc/
7
+ /pkg/
8
+ /spec/reports/
9
+ /tmp/
10
+ .byebug_history
data/.rspec ADDED
@@ -0,0 +1,2 @@
1
+ --format documentation
2
+ --color
@@ -0,0 +1,5 @@
1
+ sudo: false
2
+ language: ruby
3
+ rvm:
4
+ - 2.3.1
5
+ before_install: gem install bundler -v 1.12.5
@@ -0,0 +1,49 @@
1
+ # Contributor Code of Conduct
2
+
3
+ As contributors and maintainers of this project, and in the interest of
4
+ fostering an open and welcoming community, we pledge to respect all people who
5
+ contribute through reporting issues, posting feature requests, updating
6
+ documentation, submitting pull requests or patches, and other activities.
7
+
8
+ We are committed to making participation in this project a harassment-free
9
+ experience for everyone, regardless of level of experience, gender, gender
10
+ identity and expression, sexual orientation, disability, personal appearance,
11
+ body size, race, ethnicity, age, religion, or nationality.
12
+
13
+ Examples of unacceptable behavior by participants include:
14
+
15
+ * The use of sexualized language or imagery
16
+ * Personal attacks
17
+ * Trolling or insulting/derogatory comments
18
+ * Public or private harassment
19
+ * Publishing other's private information, such as physical or electronic
20
+ addresses, without explicit permission
21
+ * Other unethical or unprofessional conduct
22
+
23
+ Project maintainers have the right and responsibility to remove, edit, or
24
+ reject comments, commits, code, wiki edits, issues, and other contributions
25
+ that are not aligned to this Code of Conduct, or to ban temporarily or
26
+ permanently any contributor for other behaviors that they deem inappropriate,
27
+ threatening, offensive, or harmful.
28
+
29
+ By adopting this Code of Conduct, project maintainers commit themselves to
30
+ fairly and consistently applying these principles to every aspect of managing
31
+ this project. Project maintainers who do not follow or enforce the Code of
32
+ Conduct may be permanently removed from the project team.
33
+
34
+ This code of conduct applies both within project spaces and in public spaces
35
+ when an individual is representing the project or its community.
36
+
37
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
38
+ reported by contacting a project maintainer at wizard.oneandonly@gmail.com. All
39
+ complaints will be reviewed and investigated and will result in a response that
40
+ is deemed necessary and appropriate to the circumstances. Maintainers are
41
+ obligated to maintain confidentiality with regard to the reporter of an
42
+ incident.
43
+
44
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
45
+ version 1.3.0, available at
46
+ [http://contributor-covenant.org/version/1/3/0/][version]
47
+
48
+ [homepage]: http://contributor-covenant.org
49
+ [version]: http://contributor-covenant.org/version/1/3/0/
data/Gemfile ADDED
@@ -0,0 +1,6 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in bouncer.gemspec
4
+ gemspec
5
+ gem 'byebug', group: :test
6
+ gem 'codecov', group: :test, require: false
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2016 Stefan Slaveykov
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,88 @@
1
+ # Shouter
2
+ [![Build Status](https://travis-ci.org/wizardone/bouncer.svg?branch=master)](https://travis-ci.org/wizardone/bouncer)
3
+ [![codecov](https://codecov.io/gh/wizardone/bouncer/branch/master/graph/badge.svg)](https://codecov.io/gh/wizardone/bouncer)
4
+
5
+ `Shouter` is a very simple and lightweight publish/subscription DSL for
6
+ Ruby applications.
7
+
8
+ ## Installation
9
+
10
+ Add this line to your application's Gemfile:
11
+
12
+ ```ruby
13
+ gem 'shouter'
14
+ ```
15
+
16
+ And then execute:
17
+
18
+ $ bundle
19
+
20
+ Or install it yourself as:
21
+
22
+ $ gem install shouter
23
+
24
+ ## Usage
25
+ ```ruby
26
+ class A
27
+ extend Shouter
28
+ subscribe(Listener.new, for: :my_scope)
29
+ end
30
+
31
+ class Listener
32
+ def on_change
33
+ "I`m changed"
34
+ end
35
+ end
36
+
37
+ A.publish(:my_scope, :on_change)
38
+ => "I`m changed"
39
+ ```
40
+
41
+ You can subscribe multiple objects:
42
+ ```ruby
43
+ class A
44
+ extend Shouter
45
+ subscribe(Listener.new, Listener1.new, Listener2.new, for: :my_scope)
46
+ end
47
+ ```
48
+
49
+ You can subscribe an object for single execution, after that the object
50
+ will be removed from the listener store
51
+ ```ruby
52
+ class A
53
+ extend Shouter
54
+ subscribe(Listener.new, for: :my_scope, single: true)
55
+ end
56
+
57
+ A.publish(:my_scope, :on_change)
58
+ => "I`m changed"
59
+
60
+ A.publish(:my_scope, :on_change)
61
+ => nil
62
+
63
+ ```
64
+
65
+ You can also pass a block to the publish method, which will serve as a
66
+ successful callback, meaning it will only get executed after the event
67
+ has been triggered
68
+ ```ruby
69
+ A.publish(:my_scope, :on_change) do
70
+ puts "I am callback"
71
+ end
72
+ ```
73
+
74
+ ## Development
75
+
76
+ 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.
77
+
78
+ 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).
79
+
80
+ ## Contributing
81
+
82
+ 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.
83
+
84
+
85
+ ## License
86
+
87
+ The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
88
+
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "shouter"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,22 @@
1
+ require 'shouter/version'
2
+ require 'shouter/listener'
3
+ require 'shouter/store'
4
+
5
+ module Shouter
6
+ def subscribe(*objects, **options)
7
+ Shouter::Store.register(objects, options)
8
+ end
9
+
10
+ def unsubscribe(*objects)
11
+ Shouter::Store.unregister(objects)
12
+ end
13
+
14
+ def publish(scope, event, *args, &block)
15
+ Shouter::Store.notify(scope, event, args, &block)
16
+ end
17
+
18
+ def clear
19
+ Shouter::Store.clear
20
+ end
21
+ alias_method :clear_listeners, :clear
22
+ end
@@ -0,0 +1,27 @@
1
+ module Shouter
2
+
3
+ class ScopeMissingError < StandardError
4
+ def initialize
5
+ 'You must supply a scope for running the events'
6
+ end
7
+ end
8
+
9
+ class Listener
10
+ attr_reader :object, :options
11
+
12
+ def initialize(object, options)
13
+ raise Shouter::ScopeMissingError unless options[:scope]
14
+
15
+ @object = object
16
+ @options = options
17
+ end
18
+
19
+ def for?(scope)
20
+ options[:scope] == scope
21
+ end
22
+
23
+ def single?
24
+ options[:single] == true
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,57 @@
1
+ module Shouter
2
+
3
+ NoInheritanceAllowedError = Class.new(StandardError)
4
+
5
+ class Store
6
+
7
+ # Implement a simple Singleton pattern
8
+ private_class_method :new
9
+ @@listeners = []
10
+ @@mutex = Mutex.new
11
+
12
+ class << self
13
+
14
+ def inherited(subclass)
15
+ raise NoInheritanceAllowedError.new("#{self.class.to_s} is meant to be a singleton class and not to be inherited")
16
+ end
17
+
18
+ def register(objects, options)
19
+ mutex.synchronize do
20
+ objects.each { |object| @@listeners << Shouter::Listener.new(object, options) }
21
+ end
22
+ end
23
+
24
+ def unregister(objects)
25
+ mutex.synchronize do
26
+ [*objects].each { |object| listeners.delete_if { |listener| listener.object == object } }
27
+ end
28
+ end
29
+
30
+ def clear
31
+ mutex.synchronize do
32
+ @@listeners = []
33
+ end
34
+ end
35
+
36
+ def notify(scope, event, args)
37
+ return if listeners.empty?
38
+
39
+ listeners.select { |listener| listener.for?(scope) }.each do |listener|
40
+ klass = listener.object
41
+ klass.public_send(event, *args) if klass.respond_to?(event)
42
+ # Serves as callback
43
+ yield if block_given?
44
+ unregister(klass) if listener.single?
45
+ end
46
+ end
47
+
48
+ def listeners
49
+ @@listeners
50
+ end
51
+
52
+ def mutex
53
+ @@mutex
54
+ end
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,3 @@
1
+ module Shouter
2
+ VERSION = "0.1.0"
3
+ end
@@ -0,0 +1,34 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'shouter/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "shouter"
8
+ spec.version = Shouter::VERSION
9
+ spec.authors = ["Stefan Slaveykov"]
10
+ spec.email = ["wizard.oneandonly@gmail.com"]
11
+
12
+ spec.summary = %q{Small publish/subscription based system in Ruby}
13
+ spec.description = %q{A small gem that allows you to publish and subscribe to events}
14
+ spec.homepage = "https://github.com/wizardone/bouncer"
15
+ spec.license = "MIT"
16
+
17
+ # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
18
+ # to allow pushing to a single host or delete this section to allow pushing to any host.
19
+ if spec.respond_to?(:metadata)
20
+ #spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
21
+ else
22
+ raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
23
+ end
24
+
25
+ spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+ spec.required_ruby_version = '~> 2.0'
30
+
31
+ spec.add_development_dependency "bundler", "~> 1.12"
32
+ spec.add_development_dependency "rake", "~> 10.0"
33
+ spec.add_development_dependency "rspec", "~> 3.0"
34
+ end
metadata ADDED
@@ -0,0 +1,101 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: shouter
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Stefan Slaveykov
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2017-01-10 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.12'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.12'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - "~>"
32
+ - !ruby/object:Gem::Version
33
+ version: '10.0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - "~>"
39
+ - !ruby/object:Gem::Version
40
+ version: '10.0'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rspec
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - "~>"
46
+ - !ruby/object:Gem::Version
47
+ version: '3.0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - "~>"
53
+ - !ruby/object:Gem::Version
54
+ version: '3.0'
55
+ description: A small gem that allows you to publish and subscribe to events
56
+ email:
57
+ - wizard.oneandonly@gmail.com
58
+ executables: []
59
+ extensions: []
60
+ extra_rdoc_files: []
61
+ files:
62
+ - ".gitignore"
63
+ - ".rspec"
64
+ - ".travis.yml"
65
+ - CODE_OF_CONDUCT.md
66
+ - Gemfile
67
+ - LICENSE.txt
68
+ - README.md
69
+ - Rakefile
70
+ - bin/console
71
+ - bin/setup
72
+ - lib/shouter.rb
73
+ - lib/shouter/listener.rb
74
+ - lib/shouter/store.rb
75
+ - lib/shouter/version.rb
76
+ - shouter.gemspec
77
+ homepage: https://github.com/wizardone/bouncer
78
+ licenses:
79
+ - MIT
80
+ metadata: {}
81
+ post_install_message:
82
+ rdoc_options: []
83
+ require_paths:
84
+ - lib
85
+ required_ruby_version: !ruby/object:Gem::Requirement
86
+ requirements:
87
+ - - "~>"
88
+ - !ruby/object:Gem::Version
89
+ version: '2.0'
90
+ required_rubygems_version: !ruby/object:Gem::Requirement
91
+ requirements:
92
+ - - ">="
93
+ - !ruby/object:Gem::Version
94
+ version: '0'
95
+ requirements: []
96
+ rubyforge_project:
97
+ rubygems_version: 2.5.1
98
+ signing_key:
99
+ specification_version: 4
100
+ summary: Small publish/subscription based system in Ruby
101
+ test_files: []