eventifier 0.0.2 → 0.0.3

data/spec/notification_helper_spec.rb

@@ -16,27 +16,34 @@ describe Eventifier::NotificationHelper do
         :destroy => "{{user.name}} just deleted an Post",
         :update => {
           :single => "{{user.name}} made a change to their Post",
-          :multiple => "{{user.name}} made some changes to their Post"
+          :multiple => "{{user.name}} made some changes to their Post",
+          :attributes => {
+            :deleted_at => "{{user.name}} deleted their Post"
+          }
         }
       }
     }
     I18n.backend.store_translations :en, :notifications => @notification_strings
   end
 
-  describe ".notification_message" do
+  describe "#notification_message" do
     it "should return the I18n message for that event" do
 
-      event = Eventifier::Event.make! :eventable => Post.make!, :verb => :create
+      event = Fabricate(:event, :eventable => Fabricate(:post), :verb => :create)
       helper.notification_message(event).should == "<strong>#{event.user.name}</strong> just created an Post - you should check it out"
     end
 
     it "should return a message specific to a single change if only 1 change has been made" do
-      event = Eventifier::Event.make! :eventable => Post.make!, :verb => :update, :change_data => { :name => ["Fred", "Mike"] }
+      event = Fabricate(:event, :eventable => Fabricate(:post), :verb => :update, :change_data => { :name => ["Fred", "Mike"] })
       helper.notification_message(event).should == "<strong>#{event.user.name}</strong> made a change to their Post"
     end
+    it "should return a message specific to a particular field change if configuration is present" do
+      event = Fabricate(:event, :eventable => Fabricate(:post), :verb => :update, :change_data => { :deleted_at => [nil, Time.now] })
+      helper.notification_message(event).should == "<strong>#{event.user.name}</strong> deleted their Post"
+    end
 
     it "should return a message specific to multiple changes if more than 1 change has been made" do
-      event = Eventifier::Event.make! :eventable => Post.make!, :verb => :update, :change_data => { :name => ["Fred", "Mike"], :age => [55, 65] }
+      event = Fabricate(:event, :eventable => Fabricate(:post), :verb => :update, :change_data => { :name => ["Fred", "Mike"], :age => [55, 65] })
       helper.notification_message(event).should == "<strong>#{event.user.name}</strong> made some changes to their Post"
     end
 
@@ -50,7 +57,7 @@ describe Eventifier::NotificationHelper do
       }
       I18n.backend.store_translations :test, :notifications => @notification_strings
       I18n.with_locale("test") do
-        event = Eventifier::Event.make! :eventable => Post.make!, :verb => :create
+        event = Fabricate(:event, :eventable => Fabricate(:post), :verb => :create)
         helper.notification_message(event).should == "<strong>#{event.user.name}</strong> created a <strong>Post</strong>"
       end
     end

data/spec/notification_mailer_spec.rb

@@ -2,11 +2,16 @@ require 'spec_helper'
 
 describe Eventifier::NotificationMailer do
   describe "#notification_email" do
+    before do
+      Eventifier::NotificationMailer.any_instance.stub main_app: double('app', url_for: true)
+    end
+
     it "should response to notification emails" do
       Eventifier::NotificationMailer.should respond_to(:notification_email)
     end
+
     it "should be able to send a 'notification' email" do
-      proc { Eventifier::NotificationMailer.notification_email(Eventifier::Notification.make!).deliver }.should change(ActionMailer::Base.deliveries, :count)
+      proc { Eventifier::NotificationMailer.notification_email(Fabricate(:notification)).deliver }.should change(ActionMailer::Base.deliveries, :count)
     end
   end
 end

data/spec/notification_spec.rb

@@ -1,13 +1,17 @@
 require 'spec_helper'
 
 describe Eventifier::Notification do
-  let(:notification) { Eventifier::Notification.make! }
+  let(:notification) { Fabricate(:notification) }
+
+  before do
+    Eventifier::NotificationMailer.any_instance.stub main_app: double('app', url_for: true)
+  end
 
   describe '.expire_for_past_events!' do
     let(:notification) { double('notification', :expire! => true) }
     let(:expired_event_ids) { [1, 3, 5, 7] }
 
-    before :each do
+    before do
       Eventifier::Event.stub :expired_ids => expired_event_ids
       Eventifier::Notification.stub :for_events => [notification]
     end
@@ -29,7 +33,6 @@ describe Eventifier::Notification do
   describe ".unread_for" do
     it "should return unread notifications for a user" do
       user = notification.user
-
       Eventifier::Notification.unread_for(user).should include notification
     end
 
@@ -37,7 +40,7 @@ describe Eventifier::Notification do
       user = notification.user
 
       user.notifications_last_read_at = Time.now
-      second_notification = Eventifier::Notification.make!
+      second_notification = Fabricate(:notification)
 
       Eventifier::Notification.unread_for(user).should_not include notification
       Eventifier::Notification.unread_for(user).should_not include second_notification
@@ -47,19 +50,14 @@ describe Eventifier::Notification do
   describe "#create" do
     it "sends an email to the user" do
       ActionMailer::Base.deliveries.clear
-      notification = Eventifier::Notification.make!
+      notification = Fabricate(:notification)
       ActionMailer::Base.deliveries.count.should > 0
     end
   end
 
-  # describe "#valid?" do
-  #   it_requires_a :user
-  #   it_requires_an :event
-  # end
-
   describe "#unread_for?" do
     let(:user)  { double(User, :notifications_last_read_at => last_read) }
-    subject     { Eventifier::Notification.make(:created_at => Time.now).unread_for?(user) }
+    subject     { Fabricate.build(:notification, :created_at => Time.now).unread_for?(user) }
     context 'when the user has never read notifications' do
       let(:last_read) { nil }
       it 'should return true' do

data/spec/spec_helper.rb

@@ -1,8 +1,17 @@
 $LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
 $LOAD_PATH.unshift File.dirname(__FILE__)
 
-Dir["./spec/support/**/*.rb"].each {|f| require f}
+require 'fabrication'
+orm = ENV['ORM'] || 'active_record'
+require "./spec/test_classes/#{orm}_support.rb"
+
+Fabrication.configure do |config|
+  config.fabricator_dir = ["spec/fabricators"]
+end
+
+
+Dir["./spec/support/**/*.rb"].each { |f| require f }
 
 require 'rubygems'
 require 'rspec'
-require 'eventifier'
+require 'eventifier'

data/spec/support/database_cleaner.rb

@@ -0,0 +1,3 @@
+require 'database_cleaner'
+DatabaseCleaner.strategy = :truncation
+DatabaseCleaner.clean

data/spec/support/model_helpers.rb

@@ -0,0 +1,36 @@
+module ModelHelpers
+  def self.included(base)
+    base.instance_eval do
+      extend ModelHelpers::ClassMethods
+    end
+  end
+
+  module ClassMethods
+    def it_requires_a(attribute)
+      it "requires a #{attribute}" do
+        instance = Fabricate.build(self.class.describes.name.demodulize.downcase.to_sym, attribute => nil)
+        instance.errors[attribute].should_not be_nil
+      end
+    end
+
+    def it_requires_an(attribute)
+      it "requires an #{attribute}" do
+        instance = Fabricate.build(self.class.describes.name.demodulize.downcase.to_sym, attribute => nil)
+        instance.errors[attribute].should_not be_nil
+      end
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include ModelHelpers
+end
+
+RSpec::Matchers.define(:require_a) do |attribute|
+  description { "require the presence of a #{attribute.to_s}" }
+  match { |instance|
+    instance.send("#{attribute}=", nil)
+    instance.save
+    !instance.errors[attribute.to_sym].empty?
+  }
+end

data/spec/{support → test_classes}/active_record_support.rb

@@ -17,10 +17,19 @@ ActiveRecord::Schema.define(:version => 0) do
     t.timestamps
   end
 
+  create_table :ghosts, :force => true do |t|
+    t.string  :ghost_class
+    t.integer :ghost_id
+    t.text    :data_hash
+
+    t.timestamps
+  end
+
   create_table :notifications, :force => true do |t|
     t.integer :event_id
     t.integer :user_id
     t.integer :parent_id
+    t.string :url
 
     t.timestamps
   end

data/spec/test_classes/mongoid_support.rb

@@ -0,0 +1,34 @@
+require 'mongoid'
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new("localhost", 27017).db('eventifier')
+end
+
+class User
+  include Mongoid::Document
+
+  field :name, :type => String
+
+  has_many :subscriptions
+  validates :name, :presence => true, :uniqueness => true
+end
+
+class Subscription
+  include Mongoid::Document
+
+  belongs_to :user
+  belongs_to :post
+end
+
+class Post
+  include Mongoid::Document
+
+  belongs_to :author, :class_name => "User"
+  has_many :subscriptions
+
+  def readers
+    subscriptions.map &:user
+  end
+
+  alias_method :user, :author
+end

metadata

@@ -1,19 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: eventifier
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
 - Nathan Sampimon
+- Peter Murray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-09 00:00:00.000000000 Z
+date: 2012-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70263342002960 !ruby/object:Gem::Requirement
+  requirement: &70102747627500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +22,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70263342002960
+  version_requirements: *70102747627500
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &70102747627040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70102747627040
 - !ruby/object:Gem::Dependency
   name: actionmailer
-  requirement: &70263342002460 !ruby/object:Gem::Requirement
+  requirement: &70102747626540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +44,21 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70263342002460
+  version_requirements: *70102747626540
+- !ruby/object:Gem::Dependency
+  name: fabrication
+  requirement: &70102747626060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70102747626060
 - !ruby/object:Gem::Dependency
-  name: machinist
-  requirement: &70263342002040 !ruby/object:Gem::Requirement
+  name: database_cleaner
+  requirement: &70102747625400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70263342002040
+  version_requirements: *70102747625400
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &70263342001480 !ruby/object:Gem::Requirement
+  requirement: &70102747624340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +77,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70263342001480
+  version_requirements: *70102747624340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70263342000840 !ruby/object:Gem::Requirement
+  requirement: &70102747645620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +88,32 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70263342000840
+  version_requirements: *70102747645620
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70263342000400 !ruby/object:Gem::Requirement
+  requirement: &70102747645200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70102747645200
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  requirement: &70102747644640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70102747644640
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: &70102747644020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +121,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70263342000400
+  version_requirements: *70102747644020
 - !ruby/object:Gem::Dependency
   name: actionmailer
-  requirement: &70263342016180 !ruby/object:Gem::Requirement
+  requirement: &70102747643360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +132,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70263342016180
+  version_requirements: *70102747643360
 description: Tracks and logs events and sends notifications of events on Active Record
   models.
 email:
@@ -97,21 +142,36 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - README.textile
 - Rakefile
 - eventifier.gemspec
 - lib/eventifier.rb
-- lib/eventifier/event.rb
+- lib/eventifier/active_record/event.rb
+- lib/eventifier/active_record/event_observer.rb
+- lib/eventifier/active_record/event_tracking.rb
+- lib/eventifier/active_record/ghost.rb
+- lib/eventifier/active_record/notification.rb
+- lib/eventifier/active_record_support.rb
 - lib/eventifier/event_helper.rb
-- lib/eventifier/event_observer.rb
+- lib/eventifier/event_mixin.rb
+- lib/eventifier/event_observer_mixin.rb
 - lib/eventifier/event_tracking.rb
+- lib/eventifier/ghost_mixin.rb
 - lib/eventifier/helper_methods.rb
 - lib/eventifier/matchers.rb
-- lib/eventifier/notification.rb
+- lib/eventifier/mongoid/event.rb
+- lib/eventifier/mongoid/event_observer.rb
+- lib/eventifier/mongoid/event_tracking.rb
+- lib/eventifier/mongoid/ghost.rb
+- lib/eventifier/mongoid/notification.rb
+- lib/eventifier/mongoid/user_patch.rb
+- lib/eventifier/mongoid_support.rb
 - lib/eventifier/notification_helper.rb
 - lib/eventifier/notification_mailer.rb
+- lib/eventifier/notification_mixin.rb
 - lib/eventifier/version.rb
 - lib/generators/eventifier/install/install_generator.rb
 - lib/generators/eventifier/install/templates/event_tracking.rb
@@ -120,7 +180,10 @@ files:
 - spec/event_helper_spec.rb
 - spec/event_observer_spec.rb
 - spec/event_spec.rb
+- spec/event_tracking_spec.rb
 - spec/eventifier_spec.rb
+- spec/fabricators/fabricator.rb
+- spec/ghost_spec.rb
 - spec/helper_methods_spec.rb
 - spec/integration/eventifier_spec.rb
 - spec/notification_helper_spec.rb
@@ -128,8 +191,10 @@ files:
 - spec/notification_spec.rb
 - spec/spec_helper.rb
 - spec/support/action_mailer.rb
-- spec/support/active_record_support.rb
-- spec/support/blueprints.rb
+- spec/support/database_cleaner.rb
+- spec/support/model_helpers.rb
+- spec/test_classes/active_record_support.rb
+- spec/test_classes/mongoid_support.rb
 homepage: http://github.com/inspire9/eventifier
 licenses: []
 post_install_message: 
@@ -158,7 +223,10 @@ test_files:
 - spec/event_helper_spec.rb
 - spec/event_observer_spec.rb
 - spec/event_spec.rb
+- spec/event_tracking_spec.rb
 - spec/eventifier_spec.rb
+- spec/fabricators/fabricator.rb
+- spec/ghost_spec.rb
 - spec/helper_methods_spec.rb
 - spec/integration/eventifier_spec.rb
 - spec/notification_helper_spec.rb
@@ -166,5 +234,7 @@ test_files:
 - spec/notification_spec.rb
 - spec/spec_helper.rb
 - spec/support/action_mailer.rb
-- spec/support/active_record_support.rb
-- spec/support/blueprints.rb
+- spec/support/database_cleaner.rb
+- spec/support/model_helpers.rb
+- spec/test_classes/active_record_support.rb
+- spec/test_classes/mongoid_support.rb

data/lib/eventifier/event.rb

@@ -1,35 +0,0 @@
-module Eventifier
-  class Event < ::ActiveRecord::Base
-
-    belongs_to :user
-    belongs_to :eventable, :polymorphic => true
-    has_many :notifications
-
-    serialize :change_data
-
-    validates :user, :presence => true
-    validates :eventable, :presence => true
-    validates :verb, :presence => true
-
-    def self.add_notification(*arg)
-      observer_instances.each { |observer| observer.add_notification(*arg) }
-    end
-
-
-    def self.create_event(verb, object, options = {})
-      changed_data = object.changes.stringify_keys
-      changed_data = changed_data.reject { |attribute, value| options[:except].include?(attribute) } if options[:except]
-      changed_data = changed_data.select { |attribute, value| options[:only].include?(attribute) } if options[:only]
-      self.create(
-          :user => object.user,
-          :eventable => object,
-          :verb => verb,
-          :change_data => changed_data.symbolize_keys
-      )
-    end
-
-    def self.find_all_by_eventable object
-      where :eventable_id => object.id, :eventable_type => object.class.name
-    end
-  end
-end

data/lib/eventifier/event_observer.rb

@@ -1,35 +0,0 @@
-module Eventifier
-  class EventObserver < ActiveRecord::Observer
-    observe Eventifier::Event
-
-    def add_notification klass_name, relation, method
-      observed_classes.each do |observed_class|
-        notification_mappings[klass_name.name] ||= {}
-        notification_mappings[klass_name.name][method] = relation
-      end
-    end
-
-    def after_create event
-      Rails.logger.info "Firing #{event.eventable_type}##{event.verb} - #{notification_mappings[event.eventable_type][event.verb]}" if notification_mappings.has_key?(event.eventable_type) and notification_mappings[event.eventable_type].has_key?(event.verb) and defined?(Rails)
-      method_from_relation(event.eventable, notification_mappings[event.eventable_type][event.verb]).each do |user|
-        next if user == event.user
-        Eventifier::Notification.create :event => event, :user => user
-      end if notification_mappings.has_key?(event.eventable_type) and notification_mappings[event.eventable_type].has_key?(event.verb)
-    end
-
-    def method_from_relation object, relation
-      if relation.kind_of?(Hash)
-        method_from_relation(proc { |object, method| object.send(method) }.call(object, relation.keys.first), relation.values.first)
-      else
-        send_to = proc { |object, method| object.send(method) }.call(object, relation)
-        send_to = send_to.kind_of?(Array) ? send_to : [send_to]
-      end
-    end
-
-    private
-
-    def notification_mappings
-      @notification_mapppings ||= {}
-    end
-  end
-end

data/lib/eventifier/notification.rb

@@ -1,40 +0,0 @@
-module Eventifier
-  class Notification < ActiveRecord::Base
-    belongs_to :event
-    belongs_to :user
-
-    default_scope order("created_at DESC")
-    scope :for_events,  lambda { |ids| where(:event_id => ids) }
-    scope :for_user,    lambda { |id| where(:user_id => id) }
-    scope :latest,      order('notifications.created_at DESC').limit(5)
-
-    validates :event,     :presence => true
-    validates :user,      :presence => true
-    validates :event_id,  :uniqueness => { :scope => :user_id }
-
-    after_create :send_email
-
-    def self.expire_for_past_events!(time_limit = 1.day.ago)
-      self.for_events(Event.expired_ids(time_limit)).each &:expire!
-    end
-
-    def self.unread_for(user)
-      if user.notifications_last_read_at
-        for_user(user).
-          where("notifications.created_at > ?", user.notifications_last_read_at)
-      else
-        for_user(user)
-      end
-    end
-
-    def unread_for?(user)
-      return true if user.notifications_last_read_at.nil?
-      created_at > user.notifications_last_read_at
-    end
-
-    def send_email
-      # TODO: Are we okay to have notifier sit on the gem? How is this going to be handled?
-      Eventifier::NotificationMailer.notification_email(self).deliver
-    end
-  end
-end

data/spec/support/blueprints.rb

@@ -1,24 +0,0 @@
-require 'machinist/active_record'
-require 'eventifier'
-
-Eventifier::Event.blueprint do
-  user        { object.user || User.make! }
-  eventable   { object.eventable || Post.make! }
-  verb        { :update }
-  change_data { { :date => [ 5.days.ago, 3.days.ago ] } }
-end
-
-Eventifier::Notification.blueprint do
-  event { object.event || Eventifier::Event.make! }
-  user  { object.user || User.make! }
-end
-
-Post.blueprint do
-  title { "My amazing blog post" }
-  body  { "A deep and profound analysis of life" }
-end
-
-User.blueprint do
-  name  { "Billy #{sn}" }
-  email { "billy#{sn}@email.com" }
-end