wisper-active_tracker 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9653554aee66849fa191fad424789ddbbe068c4
-  data.tar.gz: 42932ac432b075229333bee3af85c146c6fabd83
+  metadata.gz: e78264d7de44631531b658fedef71c719898d930
+  data.tar.gz: b3d56509c0b63fdeffa9f76766da7f5f81db34e6
 SHA512:
-  metadata.gz: 5a4f05999713768f8addc8e04b0dfc837d580ff4f8eeb52aa09ee377a627e21d8145ed944ef0c1bccf0e1e43a2bf314b717d1f9fc92ee5d5b1dc4093b13de701
-  data.tar.gz: 25f9d244cb7abec1712a040d5b65c99ea1528fa26e725ace37680f44901fc65b90600a2c676e6ef35724c128412e1d5817d28b6b21936fa53952cee30bb839be
+  metadata.gz: 27b34ab1ca2a4cb3580f68d9ecb60da21e71afe0ac5b8eb67714d31e4bcb44b0a30c4108c19334a385299f8302fbebc76ebb5d46077434729b6ca96e8e3584e9
+  data.tar.gz: ba239e2d86ad7df740f9630482482cde90c39f8c922e8252094a16b4d51e0acccccc855a1ab5b34f0ecf322e14c926bf309d8ad141c57190fdebfc960be41156

data/Gemfile

@@ -1,18 +1,3 @@
 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/README.md

@@ -1,15 +1,13 @@
-# Wisper::ActiveChanges
+# Wisper::ActiveTracker
 
 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-activechanges'
+gem 'wisper-active_tracker'
 ```
 
 ## Usage
@@ -18,17 +16,17 @@ gem 'wisper-activechanges'
 
 ```ruby
 class Meeting < ActiveRecord::Base
-  include Wisper.model
+  include Wisper::ActiveTracker
 
   # ...
 end
 ```
 
 If you wish all models to broadcast events without having to explicitly include
-`Wisper.model` add the following to an initializer:
+`Wisper::ActiveTracker` add the following to an initializer:
 
 ```ruby
-Wisper::ActiveRecord.extend_all
+Wisper::ActiveTracker.extend_all
 ```
 
 ### Subscribing
@@ -57,11 +55,14 @@ Please refer to the [Wisper README](https://github.com/krisleech/wisper) for ful
 The events which are automatically broadcast are:
 
 * `after_create`
-* `after_create`
-* `after_destroy`
 * `create_<model_name>_{successful, failed}`
+* `after_update`
 * `update_<model_name>_{successful, failed}`
+* `before_create`
+* `after_destroy`
 * `destroy_<model_name>_successful`
+* `after_commit`
+* `<model_name>_committed`
 * `after_rollback`
 
 ### Reacting to Events
@@ -173,15 +174,3 @@ meeting.save
 ```ruby
 Auditor.audit # => [...]
 ```
-
-## Compatibility
-
-## Contributing
-
-Please submit a Pull Request with specs.
-
-### Running the specs
-
-```
-bundle exec rspec
-```

data/lib/wisper/active_tracker/tracker.rb

@@ -3,42 +3,43 @@ module Wisper
     module Tracker
       extend ActiveSupport::Concern
 
-      module ClassMethods
-        def has_tracker(options = {})
-          include Wisper::Publisher
-
-          after_validation :__track_after_validation_broadcast
-          after_commit     :__track_after_create_broadcast,  on: :create
-          after_commit     :__track_after_update_broadcast,  on: :update
-          after_commit     :__track_after_destroy_broadcast, on: :destroy
-          after_rollback   :__track_after_rollback_broadcast
-          before_destroy   :__track_before_destroy_broadcast
-
-          class_attribute  :__tracker_options
-          self.__tracker_options = options.dup
-        end
+      included do
+        include Wisper::Publisher
+
+        after_validation :__track_after_validation_broadcast
+        after_commit     :__track_after_create_broadcast,  on: :create
+        after_commit     :__track_after_update_broadcast,  on: :update
+        after_commit     :__track_after_destroy_broadcast, on: :destroy
+        after_commit     :__track_after_commit_broadcast
+        after_rollback   :__track_after_rollback_broadcast
+        before_destroy   :__track_before_destroy_broadcast
       end
 
       private
 
       def __track_after_validation_broadcast
         action = new_record? ? 'create' : 'update'
-        broadcast("#{action}_#{self.class.model_name.param_key}_failed", __tracker_args_broadcast) unless errors.empty?
+        broadcast("#{action}_#{__tracker_broadcast_key}_failed", __tracker_args_broadcast) unless errors.empty?
       end
 
       def __track_after_create_broadcast
         broadcast(:after_create, __tracker_args_broadcast)
-        broadcast("create_#{self.class.model_name.param_key}_successful", __tracker_args_broadcast)
+        broadcast("create_#{__tracker_broadcast_key}_successful", __tracker_args_broadcast)
       end
 
       def __track_after_update_broadcast
         broadcast(:after_update, __tracker_args_broadcast)
-        broadcast("update_#{self.class.model_name.param_key}_successful", __tracker_args_broadcast)
+        broadcast("update_#{__tracker_broadcast_key}_successful", __tracker_args_broadcast)
       end
 
       def __track_after_destroy_broadcast
         broadcast(:after_destroy, __tracker_args_broadcast)
-        broadcast("destroy_#{self.class.model_name.param_key}_successful", __tracker_args_broadcast)
+        broadcast("destroy_#{__tracker_broadcast_key}_successful", __tracker_args_broadcast)
+      end
+
+      def __track_after_commit_broadcast
+        broadcast(:after_commit, __tracker_args_broadcast)
+        broadcast("#{__tracker_broadcast_key}_committed", __tracker_args_broadcast)
       end
 
       def __track_after_rollback_broadcast
@@ -49,26 +50,21 @@ module Wisper
         broadcast(:before_destroy, __tracker_args_broadcast)
       end
 
-      def __tracker_args_broadcast
-        args = {}
-
-        args[:tenant] = Apartment::Tenant.current if defined?(Apartment)
-
-        if self.respond_to?(:tracker_args)
-          args.merge(self.tracker_args)
-        else
+      def __tracker_broadcast_key
+        self.class.model_name.param_key
+      end
 
-          if self.__tracker_options[:model]
-            args[:model] = self
-          else
-            args[:id] = self.id
-          end
+      def __tracker_args_broadcast
+        args = {
+          id: id,
+          global_id: to_global_id
+        }
 
-          unless self.__tracker_options[:skip_changes]
-            args[:changes] = self.changes.dup
-          end
+        args.merge(default_tracker_args) if respond_to?(:default_tracker_args)
+        args.merge(tracker_args) if respond_to?(:tracker_args)
 
-        end
+        args[:model] ||= self
+        args[:changes] ||= changes.dup
 
         args
       end

data/lib/wisper/active_tracker/version.rb

@@ -1,5 +1,5 @@
 module Wisper
   module ActiveTracker
-    VERSION = "0.1.1"
+    VERSION = '0.1.2'.freeze
   end
 end

data/lib/wisper/active_tracker.rb

@@ -1,12 +1,14 @@
-require "wisper/active_tracker/version"
-require "wisper/active_tracker/tracker"
+require 'wisper/active_tracker/version'
+require 'wisper/active_tracker/tracker'
 
 module Wisper
-  def self.tracker
-    ::Wisper::ActiveTracker::Tracker
-  end
-
   module ActiveTracker
+    extend ActiveSupport::Concern
+
+    included do
+      include Tracker
+    end
+
     def self.extend_all
       ::ActiveRecord::Base.class_eval { include Wisper.tracker }
     end

data/wisper-active_tracker.gemspec

@@ -1,24 +1,26 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+$:.push File.expand_path('../lib', __FILE__)
+
 require 'wisper/active_tracker/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "wisper-active_tracker"
+  spec.name          = 'wisper-active_tracker'
   spec.version       = Wisper::ActiveTracker::VERSION
-  spec.authors       = ["Mikko Kokkonen"]
-  spec.email         = ["mikko@mikian.com"]
-  spec.summary       = %q{Subscribe to changes on ActiveRecord models}
-  spec.description   = %q{Subscribe to changes on ActiveRecord models}
-  spec.homepage      = "https://github.com/mikian/wisper-active_tracker"
-  spec.license       = "MIT"
+  spec.authors       = ['Mikko Kokkonen']
+  spec.email         = ['mikko@mikian.com']
+  spec.summary       = 'Subscribe to changes on ActiveRecord models'
+  spec.description   = 'Subscribe to changes on ActiveRecord models'
+  spec.homepage      = 'https://github.com/mikian/wisper-active_tracker'
+  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.require_paths = ['lib']
+
+  spec.add_dependency 'wisper', '~> 2.0'
+  spec.add_dependency 'activerecord', '>= 5.0.0'
 
-  spec.add_dependency "wisper", "~> 1.3"
-  spec.add_dependency "activerecord", ">= 3.0.0"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wisper-active_tracker
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Mikko Kokkonen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-15 00:00:00.000000000 Z
+date: 2017-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: wisper
@@ -16,28 +16,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.0.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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Subscribe to changes on ActiveRecord models
 email:
 - mikko@mikian.com
@@ -47,21 +75,13 @@ 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_tracker.rb
 - lib/wisper/active_tracker/tracker.rb
 - lib/wisper/active_tracker/version.rb
-- spec/spec_helper.rb
-- spec/support/models.rb
-- spec/support/schema.rb
-- spec/wisper/activechanges_spec.rb
-- spec/wisper/publisher_spec.rb
 - wisper-active_tracker.gemspec
 homepage: https://github.com/mikian/wisper-active_tracker
 licenses:
@@ -75,7 +95,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -83,14 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.13
 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/activechanges_spec.rb
-- spec/wisper/publisher_spec.rb
-has_rdoc: 
+test_files: []

data/.travis.yml

@@ -1,11 +0,0 @@
-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/gemfiles/activerecord-3.0

@@ -1,12 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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/spec/spec_helper.rb

@@ -1,48 +0,0 @@
-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/activechanges'
-
-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

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

data/spec/support/schema.rb

@@ -1,9 +0,0 @@
-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/activechanges_spec.rb

@@ -1,85 +0,0 @@
-describe 'ActiveChanges' 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 ActiveChanges module' do
-    expect(Wisper.model).to eq Wisper::ActiveChanges::Publisher
-  end
-
-  describe '.commit' do # DEPRECATED
-    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

@@ -1,10 +0,0 @@
-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