wisper-activerecord 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 451585256ebdbf75f46b68cc6553221ccde75b4e
+  data.tar.gz: ed8138655b491c53530bd4ef515b649e2bbfd57f
+SHA512:
+  metadata.gz: 2af4ab484e153bdf2f0095e2dc29e52f205f3eef135a9d5755eccdfa49851196e2b878c277308e7ded811af7c16d99b15ea7ae03c1f2e37a769e52ac70d08d5c
+  data.tar.gz: f80a718f09e0f5102fef9df9932f516b19d4669818bf80831a2e7c30126edca13fae893570f060bc6276c7ad7e8086787c3cad02d3e304f02560e2a742398c91

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+spec/db.sqlite3

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+bundler_args: --without=metrics
+script: bundle exec rspec spec
+gemfile:
+  - gemfiles/activerecord-3.0
+  - gemfiles/activerecord-4.0
+rvm:
+  - '1.9.3'
+  - '2.1.1'
+  - jruby
+  - rbx-2

data/Gemfile

@@ -0,0 +1,18 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rubysl', '~> 2.0', :platforms => :rbx
+
+gem 'bundler', '~> 1.5'
+gem 'rake'
+gem 'rspec'
+gem 'pry'
+
+gem "sqlite3",                          :platform => :ruby
+gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+
+group :metrics do
+  gem 'flay'
+  gem 'simplecov'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Kris Leech
+
+MIT License
+
+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,210 @@
+# Wisper::ActiveRecord
+
+[![Build Status](https://travis-ci.org/krisleech/wisper-activerecord.png?branch=master)](https://travis-ci.org/krisleech/wisper-activerecord)
+
+Transparently publish model lifecycle events to subscribers.
+
+Using Wisper events is a better alternative to ActiveRecord callbacks and Observers.
+
+Listeners are subscribed to models at runtime.
+
+## Installation
+
+```ruby
+gem 'wisper-activerecord'
+```
+
+## Usage
+
+### The Model
+
+```ruby
+class Meeting < ActiveRecord::Base
+  include Wisper.model
+
+  # ...
+end
+```
+
+If you wish all models to broadcast events without having explicitly include
+`Wisper.model` in each you can add the following to an initializer:
+
+```ruby
+# config/initializers/wisper.rb
+Wisper::ActiveRecord.extend_all
+```
+
+#### Subscribing Listeners
+
+Subscribe a listener to instances of models:
+
+```ruby
+meeting = Meeting.new
+meeting.subscribe(Auditor.new)
+```
+
+Subscribe a listener to all instances of a model:
+
+```ruby
+Meeting.subscribe(Auditor.new)
+```
+
+Please refer to the [Wisper README](https://github.com/krisleech/wisper) for full details about subscribing.
+
+The events broadcast are:
+
+* `before_{create, update, destroy}`
+* `after_{create, update, destroy}`
+
+### Subscribing blocks
+
+```ruby
+meeting.on(:create_meeting_successful) { |meeting| ... }
+```
+
+### Reacting to events
+
+To receive an event the listener must implement a method matching the name of
+the event with a single argument, the instance of the model.
+
+```ruby
+def create_meeting_successful(meeting)
+  # ...
+end
+```
+
+### Success and Failure events for Create and Update
+
+To have event broadcast for success and failure of create and
+update you must use the `commit` method.
+
+```ruby
+meeting.title = 'My Meeting'
+meeting.commit
+```
+
+You can also pass attributes directly to `commit`:
+
+```ruby
+meeting.commit(title: 'My Meeting')
+```
+
+And use the class method for creating new records:
+
+```ruby
+Meeting.commit(title: 'My Meeting')
+```
+
+In addition the the regular events broadcast the following events are also broadcast:
+
+* `{create, update}_<model_name>_{successful, failed}`
+
+### Example controller
+
+```ruby
+class MeetingsController < ApplicationController
+  def new
+    @meeting = Meeting.new
+  end
+
+  def create
+    @meeting = Meeting.new(params[:meeting])
+    @meeting.subscribe(Auditor.instance)
+    @meeting.on(:meeting_create_successful) { redirect_to meeting_path }
+    @meeting.on(:meeting_create_failed)     { render action: :new }
+    @meeting.commit
+  end
+
+  def edit
+    @meeting = Meeting.find(params[:id])
+  end
+
+  def update
+    @meeting = Meeting.find(params[:id])
+    @meeting.subscribe(Auditor.instance)
+    @meeting.on(:meeting_update_successful) { redirect_to meeting_path }
+    @meeting.on(:meeting_update_failed)     { render :action => :edit }
+    @meeting.commit(params[:meeting])
+  end
+end
+```
+
+#### An example Listener
+
+**Which simply logs all events in memory**
+
+```ruby
+class Auditor
+  include Singleton
+
+  attr_accessor :audit
+
+  def initialize
+    @audit = []
+  end
+
+  def after_create(subject)
+    push_audit_for('create', subject)
+  end
+
+  def after_update(subject)
+    push_audit_for('update', subject)
+  end
+
+  def after_destroy(subject)
+    push_audit_for('destroy', subject)
+  end
+
+  def self.audit
+    instance.audit
+  end
+
+  private
+
+  def push_audit_for(action, subject)
+    audit.push(audit_for(action, subject))
+  end
+
+  def audit_for(action, subject)
+    {
+      action: action,
+      subject_id: subject.id,
+      subject_class: subject.class.to_s,
+      changes: subject.changes,
+      created_at: Time.now
+    }
+  end
+end
+```
+
+**Do some CRUD**
+
+```ruby
+Meeting.create(:description => 'Team Retrospective', :starts_at => Time.now + 2.days)
+
+meeting = Meeting.find(1)
+meeting.starts_at = Time.now + 2.months
+meeting.save
+```
+
+**And check the audit**
+
+```ruby
+Auditor.audit # => [...]
+```
+
+## Compatibility
+
+Tested on 1.9.3, 2.x, Rubinius and JRuby for ActiveRecord ~> 3.0 and ~> 4.0
+
+See the CI [build status](https://travis-ci.org/krisleech/wisper-activerecord) for more information.
+
+## Contributing
+
+Please submit a Pull Request with specs.
+
+### Running the specs
+
+```
+bundle exec rspec
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/gemfiles/activerecord-3.0

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rubysl', '~> 2.0', :platforms => :rbx
+
+gem 'rspec'
+
+gem "sqlite3",                          :platform => :ruby
+gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+
+gem 'activerecord', '~> 3.0'
+
+gemspec :path => '../'

data/gemfiles/activerecord-4.0

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'rubysl', '~> 2.0', :platforms => :rbx
+
+gem 'rspec'
+
+gem "sqlite3",                          :platform => :ruby
+gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+
+gem 'activerecord', '~> 4.0'
+
+gemspec :path => '../'

data/lib/wisper/active_record.rb

@@ -0,0 +1,14 @@
+require "wisper/active_record/version"
+require "wisper/active_record/publisher"
+
+module Wisper
+  def self.model
+    ::Wisper::ActiveRecord::Publisher
+  end
+
+  module ActiveRecord
+    def self.extend_all
+      ::ActiveRecord::Base.class_eval { include Wisper.model }
+    end
+  end
+end

data/lib/wisper/active_record/publisher.rb

@@ -0,0 +1,48 @@
+module Wisper
+  module ActiveRecord
+    module Publisher
+      extend ActiveSupport::Concern
+      included do
+
+        include Wisper::Publisher
+
+        after_commit :publish_creation, on: :create
+        after_commit :publish_update,   on: :update
+        after_commit :publish_destroy,  on: :destroy
+      end
+
+      def commit(_attributes = nil)
+        _action = new_record? ? 'create' : 'update'
+        assign_attributes(_attributes) if _attributes.present?
+        result = save
+        if result
+          broadcast("#{_action}_#{self.class.model_name.param_key}_successful", self)
+        else
+          broadcast("#{_action}_#{self.class.model_name.param_key}_failed", self)
+        end
+        result
+      end
+
+      module ClassMethods
+        def commit(_attributes = nil)
+          new(_attributes).commit
+        end
+      end
+
+      private
+
+      def publish_creation
+        broadcast(:after_create, self)
+      end
+
+      def publish_update
+        broadcast(:after_update, self)
+      end
+
+      def publish_destroy
+        broadcast(:after_destroy, self)
+        broadcast("destroy_#{self.class.model_name.param_key}_successful", self)
+      end
+    end
+  end
+end

data/lib/wisper/active_record/version.rb

@@ -0,0 +1,5 @@
+module Wisper
+  module ActiveRecord
+    VERSION = "0.1.0"
+  end
+end

data/lib/wisper/activerecord.rb

@@ -0,0 +1 @@
+require "wisper/active_record"

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+begin
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'spec'
+  end
+rescue LoadError
+end
+
+require 'wisper'
+require 'active_record'
+
+puts "Using ActiveRecord #{ActiveRecord::VERSION::STRING}"
+
+adapter = RUBY_PLATFORM == "java" ? 'jdbcsqlite3' : 'sqlite3'
+
+ActiveRecord::Base.establish_connection(:adapter => adapter,
+                                        :database => File.dirname(__FILE__) + "/db.sqlite3")
+
+load File.dirname(__FILE__) + '/support/schema.rb'
+
+require 'support/models'
+
+require 'wisper/activerecord'
+
+RSpec.configure do |config|
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  if config.files_to_run.one?
+    config.full_backtrace = true
+    config.default_formatter = 'doc'
+  end
+
+  config.profile_examples = 10
+
+  config.order = :random
+
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = :expect
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = :expect
+    mocks.verify_partial_doubles = true
+  end
+end

data/spec/support/models.rb

@@ -0,0 +1,3 @@
+class Meeting < ActiveRecord::Base
+  validates :title, presence: true # database default to non-blank value
+end

data/spec/support/schema.rb

@@ -0,0 +1,9 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :meetings, :force => true do |t|
+    t.string  :title, default: 'My Meeting'
+    t.string  :location
+    t.timestamps
+  end
+end

data/spec/wisper/activerecord_spec.rb

@@ -0,0 +1,87 @@
+describe 'ActiveRecord' do
+  let(:listener)    { double('Listener') }
+  let(:model_class) { Class.new(Meeting) { include Wisper.model } }
+
+  before { Wisper::GlobalListeners.clear }
+  before { allow(model_class).to receive(:name).and_return('Meeting') }
+
+  it '.model returns ActiveRecord module' do
+    expect(Wisper.model).to eq Wisper::ActiveRecord::Publisher
+  end
+
+  describe '.commit' do
+
+    describe 'when creating' do
+
+      context 'and model is valid' do
+        it 'publishes create_<model_name>_successful event to listener' do
+          expect(listener).to receive(:create_meeting_successful).with(instance_of(model_class))
+          model_class.subscribe(listener)
+          model_class.commit
+        end
+      end
+
+      context 'and model is not valid' do
+        it 'publishes create_<model_name>_failed event to listener' do
+          expect(listener).to receive(:create_meeting_failed).with(instance_of(model_class))
+          model_class.subscribe(listener)
+          model_class.commit(title: nil)
+        end
+      end
+    end
+
+    describe 'when updating' do
+      before { model_class.create! }
+
+      let(:model) { model_class.first }
+
+      context 'and model is valid' do
+        it 'publishes update_<model_name>_successful event to listener' do
+          expect(listener).to receive(:update_meeting_successful).with(instance_of(model_class))
+          model_class.subscribe(listener)
+          model.commit(title: 'foo')
+        end
+      end
+
+      context 'and model is not valid' do
+        it 'publishes update_<model_name>_failed event to listener' do
+          expect(listener).to receive(:update_meeting_failed).with(instance_of(model_class))
+          model_class.subscribe(listener)
+          model.commit(title: nil)
+        end
+      end
+    end
+  end
+
+  describe 'create' do
+    it 'publishes an after_create event to listener' do
+      expect(listener).to receive(:after_create).with(instance_of(model_class))
+      model_class.subscribe(listener)
+      model_class.create
+    end
+  end
+
+  describe 'update' do
+    before { model_class.create! }
+
+    let(:model) { model_class.first }
+
+    it 'publishes an after_update event to listener' do
+      expect(listener).to receive(:after_update).with(instance_of(model_class))
+      model.subscribe(listener)
+      model.update_attributes(title: 'new title')
+    end
+  end
+
+  describe 'destroy' do
+    before { model_class.create! }
+
+    let(:model) { model_class.first }
+
+    it 'publishes an on_destroy event to listener' do
+      expect(listener).to receive(:after_destroy).with(instance_of(model_class))
+      model_class.subscribe(listener)
+      model.destroy
+    end
+  end
+end

data/spec/wisper/publisher_spec.rb

@@ -0,0 +1,10 @@
+describe Wisper::ActiveRecord::Publisher do
+
+  it 'includes Wisper::Publisher' do
+    klass = Class.new(ActiveRecord::Base) do
+      include Wisper::ActiveRecord::Publisher
+    end
+
+    expect(klass.ancestors).to include Wisper::Publisher
+  end
+end

data/wisper-activerecord.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wisper/active_record/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wisper-activerecord"
+  spec.version       = Wisper::ActiveRecord::VERSION
+  spec.authors       = ["Kris Leech"]
+  spec.email         = ["kris.leech@gmail.com"]
+  spec.summary       = %q{Subscribe to changes on ActiveRecord models}
+  spec.description   = %q{Subscribe to changes on ActiveRecord models}
+  spec.homepage      = "https://github.com/krisleech/wisper-activerecord"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 1.9.3"
+
+  spec.add_dependency "wisper", "~> 1.3"
+  spec.add_dependency "activerecord", ">= 3.0.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: wisper-activerecord
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kris Leech
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: wisper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Subscribe to changes on ActiveRecord models
+email:
+- kris.leech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/activerecord-3.0
+- gemfiles/activerecord-4.0
+- lib/wisper/active_record.rb
+- lib/wisper/active_record/publisher.rb
+- lib/wisper/active_record/version.rb
+- lib/wisper/activerecord.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+- spec/wisper/activerecord_spec.rb
+- spec/wisper/publisher_spec.rb
+- wisper-activerecord.gemspec
+homepage: https://github.com/krisleech/wisper-activerecord
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Subscribe to changes on ActiveRecord models
+test_files:
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/schema.rb
+- spec/wisper/activerecord_spec.rb
+- spec/wisper/publisher_spec.rb