event_train 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8aabf11a90dd8a08cc0f3d71b074610ea7f3ad16
+  data.tar.gz: 5e8e65714bb2f169a0fa2c88057faaaa5ca81146
+SHA512:
+  metadata.gz: f12d2c19067f7533b1c0f2dbdcaa617522956cdb1241ae5184853ea2e6f86ab4f5ca3bb0a8d22ed3d585510d5bf017fc60ce239a6bcb27832de9547ae150a930
+  data.tar.gz: 90dd532f0decc0dfdf5420ff7f9c29142fdbade0fd5818d4f953a4e8ed9615de859558f3d7b7e017793f5bb0f8e018254c8a551736b79ec7863e50aaad2f6fc5

data/.codeclimate.yml

@@ -0,0 +1,10 @@
+engines:
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+    - config/**
+    - lib/**
+    - "**.rb"
+exclude_paths:
+  - spec/**/*

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,12 @@
+Style/LineLength:
+  Max: 120
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Style/EmptyLinesAroundBody:
+  Enabled: false
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+Style/EmptyLinesAroundClass:
+  Enabled: false
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.11.2
+after_success:
+  - bundle exec codeclimate-test-reporter

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 pro@rchampourlier.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,16 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem"s dependencies in event_train.gemspec
+gemspec
+
+group :development do
+  gem "guard"
+  gem "guard-rspec"
+end
+
+group :test do
+  gem "simplecov", require: false
+  gem "terminal-notifier-guard"
+  gem "codeclimate-test-reporter"
+end

data/Guardfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+ignore %r{^coverage/}
+notification :terminal_notifier, activate: "com.googlecode.iterm2"
+
+group :test do
+  # Note: The cmd option is now required due to the increasing number of ways
+  #       rspec may be run, below are examples of the most common uses.
+  #  * bundler: "bundle exec rspec"
+  #  * bundler binstubs: "bin/rspec"
+  #  * spring: "bin/rsspec" (This will use spring if running and you have
+  #                          installed the spring binstubs per the docs)
+  #  * zeus: "zeus rspec" (requires the server to be started separetly)
+  #  * "just" rspec: "rspec"
+  guard :rspec, cmd: "bundle exec rspec" do
+    watch(%r{^spec/.+_spec\.rb$})
+    watch(%r{^lib/(.+)\.rb$}) { "spec" }
+    watch("spec/spec_helper.rb") { "spec" }
+    watch(%r{spec/support/(.+)\.rb}) { "spec" }
+  end
+end

data/README.md

@@ -0,0 +1,48 @@
+# EventTrain
+
+[![Build Status](https://travis-ci.org/rchampourlier/event_train.svg?branch=master)](https://travis-ci.org/rchampourlier/event_train)
+[![Code Climate](https://codeclimate.com/github/rchampourlier/event_train/badges/gpa.svg)](https://codeclimate.com/github/rchampourlier/event_train)
+[![Test Coverage](https://codeclimate.com/github/rchampourlier/event_train/badges/coverage.svg)](https://codeclimate.com/github/rchampourlier/event_train/coverage)
+[![Issue Count](https://codeclimate.com/github/rchampourlier/event_train/badges/issue_count.svg)](https://codeclimate.com/github/rchampourlier/event_train)
+
+EventTrain is a really simple implementation of an EventTrain in Ruby. It enables you to start implementing your application using an event bus pattern without relying on some specific pub/sub service or component (like Redis, RabbitMQ). This will enable to move to such future-proof implementation just by using the same interface, thus reducing the need for refactoring or rewrites!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "event_train"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install event_train
+
+## Usage
+
+```ruby
+# Subscribe and publish to the :global channel
+EventTrain.subscribe do |event_name:, event_data:|
+  puts "Received event named #{event_name} with data #{event_data}"
+end
+EventTrain.publish(event_name: :my_first_event, event_data: true)
+# => "Received event named my_first_event with data true"
+
+# To subscribe / publish to a specific channel, just add the :channel_name parameter:
+EventTrain.publish(channel_name: :my_first_channel, ...)
+```
+
+## 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/rchampourlier/event_train. 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.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+task test: :spec

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/bin/console

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "event_train"
+
+# 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/event_train.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "event_train/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "event_train"
+  spec.version       = EventTrain::VERSION
+  spec.authors       = ["Romain Champourlier"]
+  spec.email         = ["public@rchampourlier.com"]
+
+  spec.summary       = "A really simple implementation of an event bus in Ruby, mostly for my own projects."
+  spec.description   = "This provides a simple implementation of an event bus. It makes easy to use the abstraction" \
+                       "without needing dedicated components, like RabbitMQ. Using this will however make it easy" \
+                       "to rewrite your code to use more solid foundations for the future."
+  spec.homepage      = "https://github.com/rchampourlier/event_train"
+
+  # Prevent pushing this gem to RubyGems.org by setting "allowed_push_host", or
+  # delete this section to allow pushing this gem to any host.
+  unless spec.respond_to?(:metadata)
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+  #spec.metadata["allowed_push_host"] = 'TODO: Set to "http://mygemserver.com"'
+
+  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.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/event_train.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require "event_train/version"
+require "event_train/channel"
+
+# A basic pub/sub event bus.
+#
+# How to use
+# ==========
+#
+# EventTrain.subscribe { |event_name:, event_data:| puts "received #{event_name}"}
+# EventTrain.publish(event_name: :some_event, event_data: true)
+module EventTrain
+  @channels = {}
+
+  # Publishes a new event on the specified channel.
+  def publish(event_name:, event_data:, channel_name: :global)
+    channel = get_channel(name: channel_name)
+    channel.publish(event_name: event_name, event_data: event_data)
+  end
+  module_function :publish
+
+  def subscribe(channel_name: :global, &block)
+    channel = get_channel(name: channel_name)
+    channel.subscribe(&block)
+  end
+  module_function :subscribe
+
+  def get_channel(name:)
+    @channels[name] ||= build_channel(name: name)
+  end
+  module_function :get_channel
+
+  def build_channel(name:)
+    Channel.new(name: name)
+  end
+  module_function :build_channel
+
+  # Reset all channels, removing all subscribed blocks.
+  def reset_all_channels
+    @channels = {}
+  end
+  module_function :reset_all_channels
+end

data/lib/event_train/channel.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+require "logger"
+
+module EventTrain
+
+  # A channel where events may be published and to which consumers
+  # may subscribe.
+  #
+  # Interacting with a channel directly is not mandatory, you may
+  # use the global EventTrain module to access it without the channel
+  # instance. The top-level module acts as a singleton.
+  class Channel
+    attr_reader :name, :logger
+
+    def initialize(name:, logger: default_logger)
+      @name = name
+      @logger = logger
+      @subscribed_blocks = []
+    end
+
+    def publish(event_name:, event_data:)
+      raise ArgumentError, "event_name must be a Symbol" unless event_name.is_a?(Symbol)
+      subscribed_blocks.map do |block|
+        block.call(event_name: event_name, event_data: event_data)
+      end
+    end
+
+    def subscribe(&block)
+      unless block_given?
+        raise ArgumentError, "A block must be passed to subscribe"
+      end
+      add_subscribed_block(&block)
+    end
+
+    private
+
+    attr_reader :subscribed_blocks
+
+    def add_subscribed_block(&block)
+      subscribed_blocks.push(block)
+    end
+
+    def default_logger
+      logger = Logger.new(STDOUT)
+      logger.level = Logger::DEBUG
+      logger
+    end
+  end
+end

data/lib/event_train/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# Top-level module.
+module EventTrain
+  VERSION = File.read(File.expand_path("../../../VERSION", __FILE__)).strip
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: event_train
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Romain Champourlier
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: This provides a simple implementation of an event bus. It makes easy
+  to use the abstractionwithout needing dedicated components, like RabbitMQ. Using
+  this will however make it easyto rewrite your code to use more solid foundations
+  for the future.
+email:
+- public@rchampourlier.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- VERSION
+- bin/console
+- bin/setup
+- event_train.gemspec
+- lib/event_train.rb
+- lib/event_train/channel.rb
+- lib/event_train/version.rb
+homepage: https://github.com/rchampourlier/event_train
+licenses: []
+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: A really simple implementation of an event bus in Ruby, mostly for my own
+  projects.
+test_files: []