wisper-mongoid 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c417fcf4602a8f9144061fac7f8f77eb490f891a
+  data.tar.gz: cb72e823ec94e8202e44f548880390218972e8d1
+SHA512:
+  metadata.gz: 0aabd5e0cb1d8c859e348b610890d99acc2406b6af069538c993269a4a5fae814deecf73ec64b17adf6346eb8a564ada07f124411a13d0be91a70a7e8dcced05
+  data.tar.gz: e6c541b3b749363dd079d57552297d26f878021ba09422bab0187996b3f88846737729d22e57e17c33f0ece28e1f8e337e9f8b9273e71365468d94551a16e986

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/mongoid-3.1
+  - gemfiles/mongoid-4.0
+rvm:
+  - '1.9.3'
+  - '2.2.0'
+  - jruby
+  - rbx-2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (24 Mar 2015)
+
+* Initial implementation based on krisleech/wisper-activerecord (Adrian Perez / blackxored)

data/Gemfile

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rubysl', '~> 2.0', :platforms => :rbx
+
+gem 'bundler', '~> 1.5'
+gem 'rake'
+gem 'rspec'
+gem 'pry'
+
+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,199 @@
+# Wisper::Mongoid
+
+[![Gem Version](https://badge.fury.io/rb/wisper-mongoid.png)](http://badge.fury.io/rb/wisper-mongoid)
+[![Code Climate](https://codeclimate.com/github/blackxored/wisper-mongoid.png)](https://codeclimate.com/github/blackxored/wisper-mongoid)
+[![Build Status](https://travis-ci.org/blackxored/wisper-mongoid.png?branch=master)](https://travis-ci.org/blackxored/wisper-mongoid)
+
+Transparently publish model lifecycle events to subscribers.
+
+Using Wisper events is a better alternative to Mongoid callbacks and Observers.
+
+Listeners are subscribed to models at runtime.
+
+## Installation
+
+```ruby
+gem 'wisper-mongoid'
+```
+
+## Usage
+
+### Setup a publisher
+
+```ruby
+class Meeting
+  include Mongoid::Document
+  include Wisper.model
+
+  # ...
+end
+```
+
+If you wish all models to broadcast events without having to explicitly include
+`Wisper.model` add the following to an initializer:
+
+```ruby
+Wisper::Mongoid.extend_all
+```
+
+### Subscribing
+
+Subscribe a listener to model instances:
+
+```ruby
+meeting = Meeting.new
+meeting.subscribe(Auditor.new)
+```
+
+Subscribe a block to model instances:
+
+```ruby
+meeting.on(:create_meeting_successful) { |meeting| ... }
+```
+
+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 which are automatically broadcast are:
+
+* `after_create`
+* `after_destroy`
+* `create_<model_name>_{successful, failed}`
+* `update_<model_name>_{successful, failed}`
+* `destroy_<model_name>_successful`
+
+### 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
+```
+
+## 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.save
+  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.update_attributes(params[:meeting])
+  end
+end
+```
+
+Using `on` to subscribe a block to handle the response is optional,
+you can still use `if @meeting.save` if you prefer.
+
+### Listener
+
+**Which simply records an audit 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.previous_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 Mongoid ~> 3.1, ~> 4.0
+
+See the CI [build status](https://travis-ci.org/blackxored/wisper-mongoid) for more information.
+
+## Special Thanks
+
+Special thanks to krisleech for creating `wisper` and `wisper-activerecord`,
+this implementation is heavily based on the later.
+
+## 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/mongoid-3.1

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'rubysl', '~> 2.0', :platforms => :rbx
+
+gem 'rspec'
+
+gem 'mongoid', '~> 3.1'
+
+gemspec :path => '../'

data/gemfiles/mongoid-4.0

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gem 'rubysl', '~> 2.0', :platforms => :rbx
+
+gem 'rspec'
+
+gem 'mongoid', '~> 4.0'
+
+gemspec :path => '../'

data/lib/wisper/activerecord.rb

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

data/lib/wisper/mongoid.rb

@@ -0,0 +1,15 @@
+require "wisper/mongoid/version"
+require "wisper/mongoid/publisher"
+
+module Wisper
+  def self.model
+    ::Wisper::Mongoid::Publisher
+  end
+
+  module Mongoid
+    def self.extend_all
+      # TODO: Include model on all mongoid documents
+      raise NotImplementedError
+    end
+  end
+end

data/lib/wisper/mongoid/publisher.rb

@@ -0,0 +1,55 @@
+module Wisper
+  module Mongoid
+    module Publisher
+      extend ActiveSupport::Concern
+      included do
+
+        include Wisper::Publisher
+
+        after_validation :after_validation_broadcast
+        after_create     :after_create_broadcast,  on: :create
+        after_update     :after_update_broadcast,  on: :update
+        after_destroy    :after_destroy_broadcast, on: :destroy
+      end
+
+      def commit(_attributes = nil)
+        warn "[DEPRECATED] use save, create, update_attributes as usual"
+        assign_attributes(_attributes) if _attributes.present?
+        save
+      end
+
+      module ClassMethods
+        def commit(_attributes = nil)
+          warn "[DEPRECATED] use save, create, update_attributes as usual"
+          new(_attributes).save
+        end
+      end
+
+      private
+
+      def after_validation_broadcast
+        action = new_record? ? 'create' : 'update'
+        broadcast("#{action}_#{broadcast_model_name_key}_failed", self) unless errors.empty?
+      end
+
+      def after_create_broadcast
+        broadcast(:after_create, self)
+        broadcast("create_#{broadcast_model_name_key}_successful", self)
+      end
+
+      def after_update_broadcast
+        broadcast(:after_update, self)
+        broadcast("update_#{broadcast_model_name_key}_successful", self)
+      end
+
+      def after_destroy_broadcast
+        broadcast(:after_destroy, self)
+        broadcast("destroy_#{broadcast_model_name_key}_successful", self)
+      end
+
+      def broadcast_model_name_key
+        self.class.model_name.param_key
+      end
+    end
+  end
+end

data/lib/wisper/mongoid/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+begin
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter 'spec'
+  end
+rescue LoadError
+end
+
+require 'pry'
+require 'wisper'
+require 'mongoid'
+
+puts "Using Mongoid #{Mongoid::VERSION}"
+
+Mongoid.load!("spec/support/mongoid.yml", :test)
+
+require 'wisper/mongoid'
+require 'support/models'
+
+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,10 @@
+class Meeting
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  include Wisper.model
+
+  field :title, default: "My Meeting"
+  field :location
+
+  validates :title, presence: true
+end

data/spec/support/mongoid.yml

@@ -0,0 +1,6 @@
+test:
+  sessions:
+    default:
+      database: wisper_test
+      hosts:
+        - localhost:27017

data/spec/wisper/mongoid_spec.rb

@@ -0,0 +1,86 @@
+describe 'Mongoid' do
+  let(:listener)    { double('Listener') }
+  let(:model_class) { Meeting }
+
+  before { Wisper::GlobalListeners.clear }
+
+  it '.model returns Mongoid module' do
+    expect(Wisper.model).to eq(Wisper::Mongoid::Publisher)
+  end
+
+  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.create
+      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.create(title: nil)
+      end
+    end
+  end
+
+  describe 'when updating' do
+    before do
+      model_class.create!
+    end
+
+    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.title = 'foo'
+        model.save
+      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.title = nil
+        model.save
+      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 after_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,12 @@
+describe Wisper::Mongoid::Publisher do
+
+  it 'includes Wisper::Publisher' do
+    klass = Class.new do
+      include Mongoid::Document
+      include Mongoid::Timestamps
+      include Wisper::Mongoid::Publisher
+    end
+
+    expect(klass.ancestors).to include Wisper::Publisher
+  end
+end

data/wisper-mongoid.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/mongoid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wisper-mongoid"
+  spec.version       = Wisper::Mongoid::VERSION
+  spec.authors       = ["Adrian Perez"]
+  spec.email         = ["adrianperez.deb@gmail.com"]
+  spec.summary       = %q{Subscribe to changes on Mongoid models}
+  spec.description   = %q{Subscribe to changes on Mongoid models}
+  spec.homepage      = "https://github.com/blackxored/wisper-mongoid"
+  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 "mongoid", ">= 3.1", "< 5"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: wisper-mongoid
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adrian Perez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-24 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: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+description: Subscribe to changes on Mongoid models
+email:
+- adrianperez.deb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemfiles/mongoid-3.1
+- gemfiles/mongoid-4.0
+- lib/wisper/activerecord.rb
+- lib/wisper/mongoid.rb
+- lib/wisper/mongoid/publisher.rb
+- lib/wisper/mongoid/version.rb
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/mongoid.yml
+- spec/wisper/mongoid_spec.rb
+- spec/wisper/publisher_spec.rb
+- wisper-mongoid.gemspec
+homepage: https://github.com/blackxored/wisper-mongoid
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Subscribe to changes on Mongoid models
+test_files:
+- spec/spec_helper.rb
+- spec/support/models.rb
+- spec/support/mongoid.yml
+- spec/wisper/mongoid_spec.rb
+- spec/wisper/publisher_spec.rb
+has_rdoc: