wisper-activerecord-publisher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbbf26c397308935a96d6ca2937459bf72bdb08f
+  data.tar.gz: 3208f1be800e7b9657c524d279ef6f3bf9b2ff8d
+SHA512:
+  metadata.gz: 5871dfbb1ca88685f617cd6ae490788c295580d946f7bbc9b9afbaaff3537cbb1c2a282cbc9e373901be615ec186e5e0bca7708e0be89cce092e26a7419f4453
+  data.tar.gz: ca155564536f17f0680d5207e86c251b5c79ec08e817a57a4ca0bffdfa8bc1af2a750d4a78ece3c8caf3041987cde5fd33626d01f0cae378da042868606932c4

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/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wisper-activerecord-publisher.gemspec
+gemspec

data/README.md

@@ -0,0 +1,59 @@
+# Wisper::Activerecord::Publisher
+> Extract logic from your callbacks into wisper listeners for model events
+(create, update, delete)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wisper-activerecord-publisher'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Create a wisper listener with methods named to match any of the supported
+broadcast events:
+* MODEL_created - event is published after record created in DB
+* MODEL_updated - event is published after record is updated and includes attributes that changed
+* MODEL_destroyed - event is published after record is destroyed and includes a read-only copy of the model attributes
+
+This gem *does* support background event processing since the events are
+published after commit and each event includes the necessary payload (ie:
+changes).
+
+## Example
+
+```ruby
+class Foo < ActiveRecord::Base
+end
+
+class MyListener
+  def foo_created(model)
+    # do something here with the model
+  end
+
+  def foo_updated(model, changes)
+  end
+
+  def foo_destroyed(model_attributes)
+    # read-only copy of attributes
+    # model is already deleted from database
+  end
+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/betterup/wisper-activerecord-publisher.
+

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 "wisper/activerecord/publisher"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wisper/activerecord/publisher.rb

@@ -0,0 +1,50 @@
+require 'wisper/activerecord/publisher/version'
+require 'active_record'
+require 'wisper'
+
+module Wisper
+  module ActiveRecord
+    # ActiveRecord extension to automatically publish events for CRUD lifecycle
+    # see https://github.com/krisleech/wisper/wiki/Rails-CRUD-with-ActiveRecord
+    # see https://github.com/krisleech/wisper-activerecord
+    module Publisher
+      extend ActiveSupport::Concern
+
+      included do
+        include Wisper::Publisher
+
+        after_commit :broadcast_create, on: :create
+        after_commit :broadcast_update, on: :update
+        after_commit :broadcast_destroy, on: :destroy
+      end
+
+      private
+
+      # broadcast MODEL_created event to subscribed listeners
+      def broadcast_create
+        broadcast broadcast_event_name(:created), self
+      end
+
+      # broadcast MODEL_updated event to subscribed listeners
+      # pass the set of changes for background jobs to know what changed
+      # see https://github.com/krisleech/wisper-activerecord/issues/17
+      def broadcast_update
+        broadcast broadcast_event_name(:updated), self, previous_changes
+      end
+
+      # broadcast MODEL_destroyed to subscribed listeners
+      # pass a serialized version of the object attributes
+      # for listeners since the object is no longer accessible in the database
+      def broadcast_destroy
+        broadcast broadcast_event_name(:destroyed), attributes
+      end
+
+      def broadcast_event_name(lifecycle)
+        "#{self.class.model_name.param_key}_#{lifecycle}"
+      end
+    end
+  end
+end
+ActiveSupport.on_load(:active_record) do
+  include Wisper::ActiveRecord::Publisher
+end

data/lib/wisper/activerecord/publisher/version.rb

@@ -0,0 +1,7 @@
+module Wisper
+  module Activerecord
+    module Publisher
+      VERSION = "0.1.0"
+    end
+  end
+end

data/wisper-activerecord-publisher.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wisper/activerecord/publisher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'wisper-activerecord-publisher'
+  spec.version       = Wisper::Activerecord::Publisher::VERSION
+  spec.authors       = ['BetterUp Developers']
+  spec.email         = ['developers@betterup.co']
+
+  spec.summary       = 'Publish wisper events for activerecord model lifecycle'
+  spec.homepage      = 'https://github.com/betterup/wisper-activerecord-publisher'
+
+  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_runtime_dependency 'wisper'
+  spec.add_runtime_dependency 'activerecord'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: wisper-activerecord-publisher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- BetterUp Developers
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- developers@betterup.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wisper/activerecord/publisher.rb
+- lib/wisper/activerecord/publisher/version.rb
+- wisper-activerecord-publisher.gemspec
+homepage: https://github.com/betterup/wisper-activerecord-publisher
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Publish wisper events for activerecord model lifecycle
+test_files: []
+has_rdoc: