kitty_events 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3d19addf46fc6a9e07c54d606f8d1b9b74c61cd7
+  data.tar.gz: 619aa7703318720ce799cf6da904ef24572a6936
+SHA512:
+  metadata.gz: 8e941134a1b2733f7d9182b72e22a236466ea3a4d85ba18df30ffca0beeff91ebb470c75296e664a76d2413646a162af12669be062401153501ddf389c122aa1
+  data.tar.gz: 1fddb6183fa7f8d783ba8fae13694dc4f9a59fea1a38cde9902139b91698891515d6c15d2f60e39056a41759f50b0dc9d8150d0d758bcfed5063b5b181d88598

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 @@
+Documentation:
+  Enabled: false
+FrozenStringLiteralComment:
+  Enabled: false
+ClassVars:
+  Enabled: false
+Metrics/LineLength:
+  Max: 140
+AllCops:
+  TargetRubyVersion: 2.3
+  Exclude:
+    - 'bin/*'

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.6
+script:
+  - bundle exec rspec
+  - bundle exec rubocop --config .rubocop.yml

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 coutermarsh.mike@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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kitty_events.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Mike Coutermarsh
+
+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,95 @@
+# :heart_eyes_cat: KittyEvents
+
+Super simple event system built on top of ActiveJob.
+
+KittyEvents implements the [publish/subscribe](https://en.wikipedia.org/wiki/Publish%E2%80%93subscribe_pattern) pattern using ActiveJob. You setup your events and list the subscribers for them. When an event is triggered, KittyEvents will fanout the event to each of your subscribers.
+
+### Why use this
+- Uses ActiveJob. No need to add a new dependency for pub/sub.
+- Reduce complexity/establish patterns. Can be used to replace `after_commit`'s. This creates easier to follow/read code. Less surprises = good!
+- Replace several `perform_later`'s with a single event `trigger`. Reducing the amount of I/O happening in request (less I/O = faster response times)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kitty_events'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Usage
+
+In Rails, setup your events and subscribers in an initializer.
+
+```Ruby
+# config/initializers/application_events.rb
+module ApplicationEvents
+  extend KittyEvents
+
+  event :user_signup, [
+    WelcomeEmailWorker,
+    WelcomeTweetWorker,
+    SyncProfileImageWorker,
+    ExampleWorker.set(wait: 5.minutes), # standard ActiveJob settings work as well!
+  ]
+  
+  event :user_upvote, [
+    SomeWorker,
+    AnotherWorker,
+  ]
+end
+```
+
+Each subscriber must be an ActiveJob and respond to `perform_later(object)`.
+
+```Ruby
+class ExampleWorker < ActiveJob::Base
+  def perform(user)
+    # do work
+  end
+end
+```
+
+Then in your application, to trigger an event. Do the following.
+
+```Ruby
+ApplicationEvents.trigger(:user_signup, user)
+```
+
+Using the above example, triggering this event would pass `user` to each of the subscribers defined in our initializer:
+```
+WelcomeEmailWorker,
+WelcomeTweetWorker,
+SyncProfileImageWorker,
+ExampleWorker.set(wait: 5.minutes)
+```
+
+## 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/producthunt/kittyevents. 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
+
+[![Product Hunt](http://i.imgur.com/dtAr7wC.png)](https://www.producthunt.com)
+
+```
+ _________________
+< The MIT License >
+ -----------------
+        \   ^__^
+         \  (oo)\_______
+            (__)\       )\/\
+                ||----w |
+                ||     ||
+```

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 'kitty_events'
+
+# 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/kitty_events.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kitty_events/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kitty_events'
+  spec.version       = KittyEvents::VERSION
+  spec.authors       = ['Mike Coutermarsh', 'Radoslav Stankov']
+  spec.email         = ['coutermarsh.mike@gmail.com', 'rstankov@gmail.com']
+
+  spec.summary       = 'Super simple event system on top of ActiveJob'
+  spec.description   = 'Super simple event system on top of ActiveJob'
+  spec.homepage      = 'https://github.com/producthunt/kittyevents'
+  spec.license       = 'MIT'
+
+  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_dependency 'activejob', '>= 4.2'
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.35'
+end

data/lib/kitty_events.rb

@@ -0,0 +1,60 @@
+require 'kitty_events/version'
+require 'kitty_events/handle_worker'
+
+# Super simple event system on top of ActiveJob
+#
+# # Create event emitter
+# module ApplicationEvents
+#   extends KittyEvents
+#
+#   # Subscribe to event
+#   # An event handler is ActiveJob worker that implements `.perform(object)`
+#   event :upvote, [
+#    SpamDetector::UpvoteEventHandler,
+#    Achievements::UpvoteEventHandler,
+#    CacheCleaner::UpvoteEventHandler
+#  ]
+# end
+#
+# # Trigger event
+# # When an event is triggered, It will fan out to all handlers via ActiveJob
+# ApplicationEvents.trigger :upvote, vote
+module KittyEvents
+  def self.extended(mod)
+    mod.class_variable_set :@@handlers, {}
+    mod.mattr_reader :handlers
+    mod.const_set 'HandleWorker', Class.new(::KittyEvents::HandleWorker)
+  end
+
+  def handle_worker
+    self::HandleWorker
+  end
+
+  def event(event, event_handlers)
+    raise ArgumentError, "#{event} already registered" if handlers[event.to_sym]
+
+    handlers[event.to_sym] = validate_handlers(event_handlers)
+  end
+
+  def trigger(event, object)
+    raise ArgumentError, "#{event} is not registered" unless handlers[event.to_sym]
+
+    handle_worker.perform_later(event.to_s, object)
+  end
+
+  def handle(event, object)
+    (handlers[event.to_sym] || []).each do |handler|
+      handler.perform_later(object)
+    end
+  end
+
+  private
+
+  def validate_handlers(handlers)
+    Array(handlers).each do |handler|
+      unless handler.respond_to? :perform_later
+        raise ArgumentError, "#{handler} has to respond to `perform_later`"
+      end
+    end
+  end
+end

data/lib/kitty_events/handle_worker.rb

@@ -0,0 +1,10 @@
+require 'active_job'
+require 'active_support/core_ext/module/introspection'
+
+module KittyEvents
+  class HandleWorker < ActiveJob::Base
+    def perform(event, object)
+      self.class.parent.handle(event, object)
+    end
+  end
+end

data/lib/kitty_events/version.rb

@@ -0,0 +1,3 @@
+module KittyEvents
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: kitty_events
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mike Coutermarsh
+- Radoslav Stankov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.35'
+description: Super simple event system on top of ActiveJob
+email:
+- coutermarsh.mike@gmail.com
+- rstankov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- kitty_events.gemspec
+- lib/kitty_events.rb
+- lib/kitty_events/handle_worker.rb
+- lib/kitty_events/version.rb
+homepage: https://github.com/producthunt/kittyevents
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Super simple event system on top of ActiveJob
+test_files: []