basic_subscriber 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2fc4c82ad1c7bbf0bcf58a9ebffd0251811b2207
+  data.tar.gz: 0cb0d9d386f4e97f0fffc8797caef2e38b35cf3a
+SHA512:
+  metadata.gz: 0b0c8e7688a120c83cd8e93fd2b3db396271206c6784c8abf98f217ea851415a7db8c9d90022522d9edfe9f62ea85138e9f2b04158a6c66caf23cb3c98540040
+  data.tar.gz: 5f5f7f6e38bc3caf971156d2f24a722dfa5ebbb75d392143c46be2f77ea8281ec81fcad3021367019f87bf91ff993a5f3876ce72e6e3b04ddaa2314af6c50d50

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at corlinus@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yuriy Esaulov
+
+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,131 @@
+# BasicSubscriber
+
+Basic PubSub realization.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'basic_subscriber'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install basic_subscriber
+
+## Usage
+
+### Subscriber class
+
+```ruby
+class MySubscription < BasicSubscriber::Subscriber
+  # register event subscription
+  on :event do
+    # do something...
+  end
+
+  # register anoter event subscription
+  on :event do
+    # do something else...
+  end
+
+  # register subscription to multiple events
+  on :event, :another_event do
+    # do something...
+  end
+
+  # register event in scope
+  scope :my_scope do
+    on :scoped_event do
+      # trigger this event as :'scoped_event.my_scope'
+    end
+
+    # it's also possible to create nested scopes
+    scope :another_scope do
+      on :event do
+        # this is event :'event.another_scope.my_scope'
+      end
+    end
+  end
+
+  # set scope for all events below
+  scope :my_another_scope
+
+  on :event do
+    # this is event :'event.my_another_scope'
+  end
+
+  on :my_event do
+    # this event is also in :my_another_scope
+  end
+
+  # nested scope will be created if `scope` called twice without block
+  scope :my_scope
+
+  on :event do
+    # this is :'event.my_scope.my_another_scope'
+  end
+end
+```
+
+### Subscription class
+
+```ruby
+class MySubscription < BasicSubscriber::Subscription
+  subscribe MySubscriber
+end
+```
+
+To subscribe another subscriptions pass multiple classes to `subscribe` or call it several times
+
+```ruby
+subscribe MySubscriber, MyAnotherSubscriber
+subscribe SomeSubscriber
+```
+
+### Trigger event
+
+To trigger event use
+
+```ruby
+MySubscription.trigger :'event.my_scope', some: :data
+```
+
+### In subscriber instance
+
+There are methods available In all event subscriptions
+
+```ruby
+# returns hash passed on event trigger
+payload # => {some: :data}
+
+# returns full event name
+event_name # => :'event.my_scope'
+
+# returns first event name part
+unscoped_event_name # => :event
+
+# returns event scope
+scope_name # => :my_scope
+```
+
+## 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/corlinus/basic_subscriber. 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/basic_subscriber.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'basic_subscriber/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "basic_subscriber"
+  spec.version       = BasicSubscriber::VERSION
+  spec.authors       = ["Yuriy Esaulov"]
+  spec.email         = ["corlinus@gmail.com"]
+
+  spec.summary       = %q{Basic event subscriber implementation.}
+  spec.description   = %q{Basic event subscriber implementation.}
+  spec.homepage      = "https://github.com/corlinus/basic_subscriber"
+  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 do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "basic_subscriber"
+
+# 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/basic_subscriber.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+require "basic_subscriber/version"
+require "basic_subscriber/subscription"
+require "basic_subscriber/subscriber"
+
+module BasicSubscriber
+end

data/lib/basic_subscriber/subscriber.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+module BasicSubscriber
+  class Subscriber
+    NAME_SEPARATOR = '.'
+    attr_reader :event_name, :payload
+
+    class << self
+      def trigger(event_name, **payload)
+        event_name = event_name.to_sym
+
+        subscriber = new event_name, payload
+        subscriptions[event_name].each { |block| subscriber.instance_exec(&block) }
+        nil
+      end
+
+      def on(*event_names, &block)
+        event_names.each { |name| subscriptions[scoped_name(name)].push block }
+      end
+
+      def scope(scope_name)
+        scope_name = scope_name.to_sym
+        if block_given?
+          previous_scope = current_scope.dup
+          subscope scope_name
+          yield
+          self.current_scope = previous_scope
+        else
+          parent_scope = current_scope[1..-1]
+          self.current_scope = parent_scope if parent_scope&.any?
+          subscope scope_name
+        end
+      end
+
+      def known_events
+        subscriptions.keys
+      end
+
+      private
+
+      def subscriptions
+        @subscriptions ||= Hash.new { |h, k| h[k] = [] }
+      end
+
+      def scoped_name(name)
+        ([name] + current_scope).join(NAME_SEPARATOR).to_sym
+      end
+
+      def current_scope
+        @current_scope ||= []
+      end
+
+      attr_writer :current_scope
+
+      def subscope(name)
+        @current_scope.unshift name
+      end
+    end
+
+    def initialize(event_name, **payload)
+      @event_name = event_name
+      @payload = payload
+    end
+
+    def unscoped_event_name
+      @unscoped_event_name ||= split_event_name.first.to_sym
+    end
+
+    def scope_name
+      return @scope_name if defined? @scope_name
+      @scope_name = begin
+        scope_name = split_event_name[2]
+        scope_name == '' ? nil : scope_name.to_sym
+      end
+    end
+
+    private
+
+    def split_event_name
+      @split_event_name ||= event_name.to_s.partition NAME_SEPARATOR
+    end
+  end
+end

data/lib/basic_subscriber/subscription.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+module BasicSubscriber
+  class Subscription
+    class << self
+      def subscribe(*subscriptions)
+        subscriptions.each { |s| s.known_events.each { |e| mounts[e].push(s).uniq! } }
+      end
+
+      def trigger(event_name, **payload)
+        event_name = event_name.to_sym
+        mounts[event_name].each { |subscriber| subscriber.trigger event_name, payload }
+        nil
+      end
+
+      private
+
+      def mounts
+        @mounts ||= Hash.new { |h, k| h[k] = [] }
+      end
+    end
+  end
+end

data/lib/basic_subscriber/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module BasicSubscriber
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: basic_subscriber
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuriy Esaulov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+description: Basic event subscriber implementation.
+email:
+- corlinus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- basic_subscriber.gemspec
+- bin/console
+- bin/setup
+- lib/basic_subscriber.rb
+- lib/basic_subscriber/subscriber.rb
+- lib/basic_subscriber/subscription.rb
+- lib/basic_subscriber/version.rb
+homepage: https://github.com/corlinus/basic_subscriber
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Basic event subscriber implementation.
+test_files: []