user_notification 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e1c901c8b0055869556adb983350a2269ca0e3f6
-  data.tar.gz: ad1401b517003379e34d48742132287cee17de93
+  metadata.gz: 09b3f9590fbbd4271b1d11dd03ad86ab3da3d12c
+  data.tar.gz: d4c0b7fef0be3148aa15ac838eb1302016073b37
 SHA512:
-  metadata.gz: 30f2acc2a7562ad950d7336fa5046ccd932c4908668d0c8715d4f6fc851c00d97015db08e352e464beb1ba07eddf56f585c1e6b2c45735036df7b15602230fbf
-  data.tar.gz: f3a169119d6080443fb38ccfc69f161c76561c38ef46b19bc861db2e193d5b8092bb4eacb809bd5a6337c711c73c6d9f142ca85c6210a141ae457c2e408bd9a1
+  metadata.gz: f4d6e59a0f871eb942c783499100804c5c05f5a322b2dd24668668a0235a536e87128cea6225125324f1305f819f49e97f07e3b3a780fecabed064017817b7f3
+  data.tar.gz: 6233c4819bc17b4947c28929c7b14ae1d7a9dfce05ade9cd7354b7cfda67af7030b33f30eb13c10ab767a38ea1d5991616dbade951beefc952b9fefd5ecda918

data/lib/generators/user_notification/migration/templates/migration.rb

@@ -3,17 +3,17 @@ class CreateNotifications < ActiveRecord::Migration
   # Create table
   def self.up
     create_table :notifications do |t|
-      t.belongs_to :trackable, :polymorphic => true
+      t.belongs_to :notifiable, :polymorphic => true
       t.belongs_to :owner, :polymorphic => true
       t.string  :key
       t.text    :parameters
       t.belongs_to :recipient, :polymorphic => true
-      t.boolwan :read, default: false
+      t.boolean :read, default: false
 
       t.timestamps
     end
 
-    add_index :notifications, [:trackable_id, :trackable_type]
+    add_index :notifications, [:notifiable_id, :notifiable_type]
     add_index :notifications, [:owner_id, :owner_type]
     add_index :notifications, [:recipient_id, :recipient_type]
   end

data/lib/user_notification.rb

@@ -3,7 +3,7 @@ require 'action_view'
 # +user_notification+ keeps track of changes made to models
 # and allows you to display them to the users.
 #
-# Check {UserNotification::Tracked::ClassMethods#tracked} for more details about customizing and specifying
+# Check {UserNotification::Notifiable::ClassMethods#notifiable} for more details about customizing and specifying
 # ownership to users.
 module UserNotification
   extend ActiveSupport::Concern
@@ -12,14 +12,14 @@ module UserNotification
   autoload :Notification,     'user_notification/models/notification'
   autoload :Activist,     'user_notification/models/activist'
   autoload :Adapter,      'user_notification/models/adapter'
-  autoload :Trackable,    'user_notification/models/trackable'
+  autoload :Notifiable,    'user_notification/models/notifiable'
   autoload :Common
   autoload :Config
   autoload :Creation,     'user_notification/actions/creation.rb'
   autoload :Deactivatable,'user_notification/roles/deactivatable.rb'
   autoload :Destruction,  'user_notification/actions/destruction.rb'
   autoload :Renderable
-  autoload :Tracked,      'user_notification/roles/tracked.rb'
+  autoload :ActsAsNotifiable,      'user_notification/roles/acts_as_notifiable.rb'
   autoload :Update,       'user_notification/actions/update.rb'
   autoload :VERSION
 
@@ -58,7 +58,7 @@ module UserNotification
     included do
       include Common
       include Deactivatable
-      include Tracked
+      include ActsAsNotifiable
       include Activist  # optional associations by recipient|owner
     end
   end

data/lib/user_notification/actions/creation.rb

@@ -1,5 +1,5 @@
 module UserNotification
-  # Handles creation of Activities upon destruction and update of tracked model.
+  # Handles creation of Activities upon destruction and update of notifiable model.
   module Creation
     extend ActiveSupport::Concern
 
@@ -7,7 +7,7 @@ module UserNotification
       after_create :notification_on_create
     end
     private
-      # Creates notification upon creation of the tracked model
+      # Creates notification upon creation of the notifiable model
       def notification_on_create
         create_notification(:create)
       end

data/lib/user_notification/actions/destruction.rb

@@ -1,5 +1,5 @@
 module UserNotification
-  # Handles creation of Activities upon destruction of tracked model.
+  # Handles creation of Activities upon destruction of notifiable model.
   module Destruction
     extend ActiveSupport::Concern
 
@@ -7,7 +7,7 @@ module UserNotification
       before_destroy :notification_on_destroy
     end
     private
-      # Records an notification upon destruction of the tracked model
+      # Records an notification upon destruction of the notifiable model
       def notification_on_destroy
         create_notification(:destroy)
       end

data/lib/user_notification/actions/update.rb

@@ -1,5 +1,5 @@
 module UserNotification
-  # Handles creation of Activities upon destruction and update of tracked model.
+  # Handles creation of Activities upon destruction and update of notifiable model.
   module Update
     extend ActiveSupport::Concern
 
@@ -7,7 +7,7 @@ module UserNotification
       after_update :notification_on_update
     end
     private
-      # Creates notification upon modification of the tracked model
+      # Creates notification upon modification of the notifiable model
       def notification_on_update
         create_notification(:update)
       end

data/lib/user_notification/common.rb

@@ -22,7 +22,7 @@ module UserNotification
     extend ActiveSupport::Concern
 
     included do
-      include Trackable
+      include Notifiable
       class_attribute :notification_owner_global, :notification_recipient_global,
                       :notification_params_global, :notification_hooks, :notification_custom_fields_global
       set_user_notification_class_defaults
@@ -134,11 +134,11 @@ module UserNotification
       end
 
       # Extracts a hook from the _:on_ option provided in
-      # {Tracked::ClassMethods#tracked}. Returns nil when no hook exists for
+      # {Notifiable::ClassMethods#notifiable}. Returns nil when no hook exists for
       # given action
       # {Common#get_hook}
       #
-      # @see Tracked#get_hook
+      # @see Notifiable#get_hook
       # @param key [String, Symbol] action to retrieve a hook for
       # @return [Proc, nil] callable hook or nil
       # @since 0.4.0
@@ -196,7 +196,7 @@ module UserNotification
     #   current_user.create_notification(:avatar_changed)
     #
     # It will still gather data from any procs or symbols you passed as params
-    # to {Tracked::ClassMethods#tracked}. It will ask the hooks you defined
+    # to {Notifiable::ClassMethods#notifiable}. It will ask the hooks you defined
     # whether to really save this notification.
     #
     # But you can also overwrite instance and global settings with your options:
@@ -221,9 +221,9 @@ module UserNotification
     #     @article.create_notification :commented_on
     #     @article.notifications.last.key # => "article.commented_on"
     #
-    # For other parameters, see {Tracked#notification}, and "Instance options"
-    # accessors at {Tracked}, information on hooks is available at
-    # {Tracked::ClassMethods#tracked}.
+    # For other parameters, see {Notifiable#notification}, and "Instance options"
+    # accessors at {Notifiable}, information on hooks is available at
+    # {Notifiable::ClassMethods#notifiable}.
     # @see #prepare_settings
     # @return [Model, nil] If created successfully, new notification
     # @since 0.4.0
@@ -231,14 +231,14 @@ module UserNotification
     # @overload create_notification(action, options = {})
     #   @param [Symbol,String] action Name of the action
     #   @param [Hash] options Options with quality higher than instance options
-    #     set in {Tracked#notification}
+    #     set in {Notifiable#notification}
     #   @option options [Activist] :owner Owner
     #   @option options [Activist] :recipient Recipient
     #   @option options [Hash] :params Parameters, see
     #     {UserNotification.resolve_value}
     # @overload create_notification(options = {})
     #   @param [Hash] options Options with quality higher than instance options
-    #     set in {Tracked#notification}
+    #     set in {Notifiable#notification}
     #   @option options [Symbol,String] :action Name of the action
     #   @option options [String] :key Full key
     #   @option options [Activist] :owner Owner
@@ -258,8 +258,8 @@ module UserNotification
     end
 
     # Prepares settings used during creation of Notification record.
-    # params passed directly to tracked model have priority over
-    # settings specified in tracked() method
+    # params passed directly to notifiable model have priority over
+    # settings specified in notifiable() method
     #
     # @see #create_notification
     # @return [Hash] Settings with preserved options that were passed

data/lib/user_notification/models/{trackable.rb → notifiable.rb}

@@ -1,9 +1,9 @@
 module UserNotification
-  # Provides association for notifications bound to this object by *trackable*.
-  module Trackable
+  # Provides association for notifications bound to this object by *notifiable*.
+  module Notifiable
     # Delegates to ORM.
     def self.included(base)
-      base.extend UserNotification::inherit_orm("Trackable")
+      base.extend UserNotification::inherit_orm("Notifiable")
     end
   end
 end

data/lib/user_notification/orm/active_record.rb

@@ -2,4 +2,4 @@ require 'active_record'
 require_relative 'active_record/notification.rb'
 require_relative 'active_record/adapter.rb'
 require_relative 'active_record/activist.rb'
-require_relative 'active_record/trackable.rb'
+require_relative 'active_record/notifiable.rb'

data/lib/user_notification/orm/active_record/activist.rb

@@ -5,8 +5,8 @@ module UserNotification
       module Activist
         extend ActiveSupport::Concern
 
-        # Loads the {ClassMethods#activist} method for declaring the class
-        # as an activist.
+        # Loads the {ClassMethods#acts_as_activist} method for declaring the class
+        # as an acts_as_activist.
         def self.extended(base)
           base.extend(ClassMethods)
         end
@@ -17,20 +17,20 @@ module UserNotification
           # Adds ActiveRecord associations to model to simplify fetching
           # so you can list notifications performed by the owner.
           # It is completely optional. Any model can be an owner to an notification
-          # even without being an explicit activist.
+          # even without being an explicit acts_as_activist.
           #
           # == Usage:
           # In model:
           #
           #   class User < ActiveRecord::Base
           #     include UserNotification::Model
-          #     activist
+          #     acts_as_activist
           #   end
           #
           # In controller:
           #   User.first.notifications
           #
-          def activist
+          def acts_as_activist
             # Association of notifications as their owner.
             # @!method notifications_as_owner
             # @return [Array<Notification>] Activities which self is the owner of.
@@ -39,7 +39,11 @@ module UserNotification
             # Association of notifications as their recipient.
             # @!method notifications_as_recipient
             # @return [Array<Notification>] Activities which self is the recipient of.
-            has_many :notifications_as_recipient, :class_name => "::UserNotification::Notification", :as => :recipient
+            has_many :notifications_as_recipient, :class_name => "::UserNotification::Notification", :as => :recipient do
+              def unread
+                where(read: false)
+              end
+            end
           end
         end
       end

data/lib/user_notification/orm/active_record/adapter.rb

@@ -6,9 +6,9 @@ module UserNotification
       # Provides ActiveRecord specific, database-related routines for use by
       # UserNotification.
       class Adapter
-        # Creates the notification on `trackable` with `options`
-        def self.create_notification(trackable, options)
-          trackable.notifications.create options
+        # Creates the notification on `notifiable` with `options`
+        def self.create_notification(notifiable, options)
+          notifiable.notifications.create options
         end
       end
     end

data/lib/user_notification/orm/active_record/{trackable.rb → notifiable.rb}

@@ -1,13 +1,13 @@
 module UserNotification
   module ORM
     module ActiveRecord
-      # Implements {UserNotification::Trackable} for ActiveRecord
-      # @see UserNotification::Trackable
-      module Trackable
-        # Creates an association for notifications where self is the *trackable*
+      # Implements {UserNotification::Notifiable} for ActiveRecord
+      # @see UserNotification::Notifiable
+      module Notifiable
+        # Creates an association for notifications where self is the *notifiable*
         # object.
         def self.extended(base)
-          base.has_many :notifications, :class_name => "::UserNotification::Notification", :as => :trackable
+          base.has_many :notifications, :class_name => "::UserNotification::Notification", :as => :notifiable
         end
       end
     end

data/lib/user_notification/orm/active_record/notification.rb

@@ -7,7 +7,7 @@ module UserNotification
         include Renderable
 
         # Define polymorphic association to the parent
-        belongs_to :trackable, :polymorphic => true
+        belongs_to :notifiable, :polymorphic => true
         # Define ownership to a resource responsible for this notification
         belongs_to :owner, :polymorphic => true
         # Define ownership to a resource targeted by this notification
@@ -16,7 +16,7 @@ module UserNotification
         serialize :parameters, Hash
 
         if ::ActiveRecord::VERSION::MAJOR < 4
-          attr_accessible :key, :owner, :parameters, :recipient, :trackable
+          attr_accessible :key, :owner, :parameters, :recipient, :notifiable
         end
       end
     end

data/lib/user_notification/orm/mongo_mapper.rb

@@ -1,4 +1,4 @@
 require_relative "mongo_mapper/notification.rb"
 require_relative "mongo_mapper/adapter.rb"
 require_relative "mongo_mapper/activist.rb"
-require_relative "mongo_mapper/trackable.rb"
+require_relative "mongo_mapper/notifiable.rb"

data/lib/user_notification/orm/mongo_mapper/activist.rb

@@ -21,7 +21,7 @@ module UserNotification
           # Adds MongoMapper associations to model to simplify fetching
           # so you can list notifications performed by the owner.
           # It is completely optional. Any model can be an owner to an notification
-          # even without being an explicit activist.
+          # even without being an explicit acts_as_activist.
           #
           # == Usage:
           # In model:
@@ -29,15 +29,19 @@ module UserNotification
           #   class User
           #     include MongoMapper::Document
           #     include UserNotification::Model
-          #     activist
+          #     acts_as_activist
           #   end
           #
           # In controller:
           #   User.first.notifications
           #
-          def activist
+          def acts_as_activist
             many :notifications_as_owner,      :class_name => "::UserNotification::Notification", :as => :owner
-            many :notifications_as_recipient,  :class_name => "::UserNotification::Notification", :as => :recipient
+            many :notifications_as_recipient,  :class_name => "::UserNotification::Notification", :as => :recipient do
+              def unread
+                where(read: false)
+              end
+            end
           end
         end
       end

data/lib/user_notification/orm/mongo_mapper/adapter.rb

@@ -2,9 +2,9 @@ module UserNotification
   module ORM
     module MongoMapper
       class Adapter
-        # Creates the notification on `trackable` with `options`
-        def self.create_notification(trackable, options)
-          trackable.notifications.create options
+        # Creates the notification on `notifiable` with `options`
+        def self.create_notification(notifiable, options)
+          notifiable.notifications.create options
         end
       end
     end

data/lib/user_notification/orm/mongo_mapper/{trackable.rb → notifiable.rb}

@@ -1,9 +1,9 @@
 module UserNotification
   module ORM
     module MongoMapper
-      module Trackable
+      module Notifiable
         def self.extended(base)
-          base.many :notifications, :class_name => "::UserNotification::Notification", order: :created_at.asc, :as => :trackable
+          base.many :notifications, :class_name => "::UserNotification::Notification", order: :created_at.asc, :as => :notifiable
         end
       end
     end

data/lib/user_notification/orm/mongo_mapper/notification.rb

@@ -17,7 +17,7 @@ module UserNotification
         end
 
         # Define polymorphic association to the parent
-        belongs_to :trackable,  polymorphic: true
+        belongs_to :notifiable,  polymorphic: true
         # Define ownership to a resource responsible for this notification
         belongs_to :owner,      polymorphic: true
         # Define ownership to a resource targeted by this notification

data/lib/user_notification/orm/mongoid.rb

@@ -1,4 +1,4 @@
 require_relative "mongoid/notification.rb"
 require_relative "mongoid/adapter.rb"
 require_relative "mongoid/activist.rb"
-require_relative "mongoid/trackable.rb"
+require_relative "mongoid/notifiable.rb"

data/lib/user_notification/orm/mongoid/activist.rb

@@ -21,22 +21,26 @@ module UserNotification
           # Adds ActiveRecord associations to model to simplify fetching
           # so you can list notifications performed by the owner.
           # It is completely optional. Any model can be an owner to an notification
-          # even without being an explicit activist.
+          # even without being an explicit acts_as_activist.
           #
           # == Usage:
           # In model:
           #
           #   class User < ActiveRecord::Base
           #     include UserNotification::Model
-          #     activist
+          #     acts_as_activist
           #   end
           #
           # In controller:
           #   User.first.notifications
           #
-          def activist
+          def acts_as_activist
             has_many :notifications_as_owner,      :class_name => "::UserNotification::Notification", :inverse_of => :owner
-            has_many :notifications_as_recipient,  :class_name => "::UserNotification::Notification", :inverse_of => :recipient
+            has_many :notifications_as_recipient,  :class_name => "::UserNotification::Notification", :inverse_of => :recipient do
+              def unread
+                where(read: false)
+              end
+            end
           end
         end
       end

data/lib/user_notification/orm/mongoid/adapter.rb

@@ -2,9 +2,9 @@ module UserNotification
   module ORM
     module Mongoid
       class Adapter
-        # Creates the notification on `trackable` with `options`
-        def self.create_notification(trackable, options)
-          trackable.notifications.create options
+        # Creates the notification on `notifiable` with `options`
+        def self.create_notification(notifiable, options)
+          notifiable.notifications.create options
         end
       end
     end

data/lib/user_notification/orm/mongoid/{trackable.rb → notifiable.rb}

@@ -1,9 +1,9 @@
 module UserNotification
   module ORM
     module Mongoid
-      module Trackable
+      module Notifiable
         def self.extended(base)
-          base.has_many :notifications, :class_name => "::UserNotification::Notification", :as => :trackable
+          base.has_many :notifications, :class_name => "::UserNotification::Notification", :as => :notifiable
         end
       end
     end

data/lib/user_notification/orm/mongoid/notification.rb

@@ -12,7 +12,7 @@ module UserNotification
         include Renderable
 
         # Define polymorphic association to the parent
-        belongs_to :trackable,  polymorphic: true
+        belongs_to :notifiable,  polymorphic: true
         # Define ownership to a resource responsible for this notification
         belongs_to :owner,      polymorphic: true
         # Define ownership to a resource targeted by this notification

data/lib/user_notification/roles/{tracked.rb → acts_as_notifiable.rb}

@@ -1,6 +1,6 @@
 module UserNotification
   # Main module extending classes we want to keep track of.
-  module Tracked
+  module ActsAsNotifiable
     extend ActiveSupport::Concern
     # A shortcut method for setting custom key, owner and parameters of {Notification}
     # in one line. Accepts a hash with 3 keys:
@@ -25,7 +25,7 @@ module UserNotification
     #   @article.notifications.last.key #=> "my.custom.article.key"
     #   @article.notifications.last.parameters #=> {:title => "New article"}
     #
-    # @param options [Hash] instance options to set on the tracked model
+    # @param options [Hash] instance options to set on the notifiable model
     # @return [nil]
     def notification(options = {})
       rest = options.clone
@@ -37,10 +37,10 @@ module UserNotification
       nil
     end
 
-    # Module with basic +tracked+ method that enables tracking models.
+    # Module with basic +acts_as_notifiable+ method that enables tracking models.
     module ClassMethods
       # Adds required callbacks for creating and updating
-      # tracked models and adds +notifications+ relation for listing
+      # acts_as_notifiable models and adds +notifications+ relation for listing
       # associated notifications.
       #
       # == Parameters:
@@ -49,8 +49,8 @@ module UserNotification
       #   It can be a Proc, Symbol or an ActiveRecord object:
       #   == Examples:
       #
-      #    tracked :owner => :author
-      #    tracked :owner => proc {|o| o.author}
+      #    acts_as_notifiable :owner => :author
+      #    acts_as_notifiable :owner => proc {|o| o.author}
       #
       #   Keep in mind that owner relation is polymorphic, so you can't just
       #   provide id number of the owner object.
@@ -59,8 +59,8 @@ module UserNotification
       #   It can be a Proc, Symbol, or an ActiveRecord object
       #   == Examples:
       #
-      #    tracked :recipient => :author
-      #    tracked :recipient => proc {|o| o.author}
+      #    acts_as_notifiable :recipient => :author
+      #    acts_as_notifiable :recipient => proc {|o| o.author}
       #
       #   Keep in mind that recipient relation is polymorphic, so you can't just
       #   provide id number of the owner object.
@@ -70,7 +70,7 @@ module UserNotification
       #   == Example:
       #    class Article < ActiveRecord::Base
       #      include UserNotification::Model
-      #      tracked :params => {
+      #      acts_as_notifiable :params => {
       #          :title => :title,
       #          :author_name => "Michael",
       #          :category_name => proc {|controller, model_instance| model_instance.category.name},
@@ -79,7 +79,7 @@ module UserNotification
       #    end
       #
       #   Values in the :params hash can either be an *exact* *value*, a *Proc/Lambda* executed before saving the notification or a *Symbol*
-      #   which is a an attribute or a method name executed on the tracked model's instance.
+      #   which is a an attribute or a method name executed on the acts_as_notifiable model's instance.
       #
       #   Everything specified here has a lower priority than parameters
       #   specified directly in {#notification} method.
@@ -95,7 +95,7 @@ module UserNotification
       #   * _:update_
       #   * _:destroy_
       #   Selecting one or more of these will make UserNotification create notifications
-      #   automatically for the tracked model on selected actions.
+      #   automatically for the acts_as_notifiable model on selected actions.
       #
       #   Resulting notifications will have have keys assigned to, respectively:
       #   * _article.create_
@@ -123,14 +123,14 @@ module UserNotification
       #
       #   == Example:
       #     # app/models/article.rb
-      #     tracked :on => {:update => proc {|model, controller| model.published? }}
+      #     acts_as_notifiable :on => {:update => proc {|model, controller| model.published? }}
       #
       #   In the example above, given a model Article with boolean column _published_.
       #   The notifications with key _article.update_ will only be created
       #   if the published status is set to true on that article.
       # @param opts [Hash] options
       # @return [nil] options
-      def tracked(opts = {})
+      def acts_as_notifiable(opts = {})
         options = opts.clone
 
         all_options = [:create, :update, :destroy]

data/lib/user_notification/version.rb

@@ -1,4 +1,4 @@
 module UserNotification
   # A constant with gem's version
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/test/migrations/001_create_notifications.rb

@@ -3,17 +3,17 @@ class CreateNotifications < ActiveRecord::Migration
   # Create table
   def self.up
     create_table :notifications do |t|
-      t.belongs_to :trackable, :polymorphic => true
+      t.belongs_to :notifiable, :polymorphic => true
       t.belongs_to :owner, :polymorphic => true
       t.string  :key
       t.text    :parameters
       t.belongs_to :recipient, :polymorphic => true
-      t.boolwan :read, default: false
+      t.boolean :read, default: false
 
       t.timestamps
     end
 
-    add_index :notifications, [:trackable_id, :trackable_type]
+    add_index :notifications, [:notifiable_id, :notifiable_type]
     add_index :notifications, [:owner_id, :owner_type]
     add_index :notifications, [:recipient_id, :recipient_type]
   end

data/test/test_activist.rb

@@ -3,8 +3,8 @@ require 'test_helper'
 describe UserNotification::Activist do
   it 'adds owner association' do
     klass = article
-    klass.must_respond_to :activist
-    klass.activist
+    klass.must_respond_to :acts_as_activist
+    klass.acts_as_activist
     klass.new.must_respond_to :notifications
     case ENV["PA_ORM"]
       when "active_record"
@@ -28,13 +28,13 @@ describe UserNotification::Activist do
         class ActivistUser < ActiveRecord::Base
           include UserNotification::Model
           self.table_name = 'users'
-          activist
+          acts_as_activist
         end
       when :mongoid
         class ActivistUser
           include Mongoid::Document
           include UserNotification::Model
-          activist
+          acts_as_activist
 
           field :name, type: String
         end
@@ -42,7 +42,7 @@ describe UserNotification::Activist do
         class ActivistUser
           include MongoMapper::Document
           include UserNotification::Model
-          activist
+          acts_as_activist
 
           key :name, String
         end

data/test/{test_tracking.rb → test_acts_as_notifiable.rb}

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-describe UserNotification::Tracked do
+describe UserNotification::ActsAsNotifiable do
   describe 'defining instance options' do
     subject { article.new }
     let :options do
@@ -25,10 +25,10 @@ describe UserNotification::Tracked do
     specify { notification.recipient.must_equal              options[:recipient] }
   end
 
-  it 'can be tracked and be an activist at the same time' do
+  it 'can be acts_as_notifiable and be an activist at the same time' do
     case UserNotification.config.orm
       when :mongoid
-        class ActivistAndTrackedArticle
+        class ActivistAndNotifiableArticle
           include Mongoid::Document
           include Mongoid::Timestamps
           include UserNotification::Model
@@ -37,11 +37,11 @@ describe UserNotification::Tracked do
 
           field :name, type: String
           field :published, type: Boolean
-          tracked
-          activist
+          acts_as_notifiable
+          acts_as_activist
         end
       when :mongo_mapper
-        class ActivistAndTrackedArticle
+        class ActivistAndNotifiableArticle
           include MongoMapper::Document
           include UserNotification::Model
 
@@ -49,16 +49,16 @@ describe UserNotification::Tracked do
 
           key :name, String
           key :published, Boolean
-          tracked
-          activist
+          acts_as_notifiable
+          acts_as_activist
           timestamps!
         end
       when :active_record
-        class ActivistAndTrackedArticle < ActiveRecord::Base
+        class ActivistAndNotifiableArticle < ActiveRecord::Base
           self.table_name = 'articles'
           include UserNotification::Model
-          tracked
-          activist
+          acts_as_notifiable
+          acts_as_activist
 
           if ::ActiveRecord::VERSION::MAJOR < 4
             attr_accessible :name, :published, :user
@@ -67,9 +67,9 @@ describe UserNotification::Tracked do
         end
     end
 
-    art = ActivistAndTrackedArticle.new
+    art = ActivistAndNotifiableArticle.new
     art.save
-    art.notifications.last.trackable_id.must_equal art.id
+    art.notifications.last.notifiable_id.must_equal art.id
     art.notifications.last.owner_id.must_equal nil
   end
 
@@ -159,7 +159,7 @@ describe UserNotification::Tracked do
     end
   end
 
-  describe '#tracked' do
+  describe '#acts_as_notifiable' do
     subject { article(options) }
     let(:options) { {} }
 
@@ -175,7 +175,7 @@ describe UserNotification::Tracked do
 
             field :name, type: String
             field :published, type: Boolean
-            tracked :skip_defaults => true
+            acts_as_notifiable :skip_defaults => true
           end
         when :mongo_mapper
           art = Class.new do
@@ -186,7 +186,7 @@ describe UserNotification::Tracked do
 
             key :name, String
             key :published, Boolean
-            tracked :skip_defaults => true
+            acts_as_notifiable :skip_defaults => true
 
             timestamps!
           end
@@ -232,7 +232,7 @@ describe UserNotification::Tracked do
 
             field :name, type: String
             field :published, type: Boolean
-            tracked :except => [:create]
+            acts_as_notifiable :except => [:create]
           end
         when :mongo_mapper
           art = Class.new do
@@ -243,7 +243,7 @@ describe UserNotification::Tracked do
 
             key :name, String
             key :published, Boolean
-            tracked :except => [:create]
+            acts_as_notifiable :except => [:create]
 
             timestamps!
           end
@@ -269,7 +269,7 @@ describe UserNotification::Tracked do
             field :name, type: String
             field :published, type: Boolean
 
-            tracked :only => [:create, :update]
+            acts_as_notifiable :only => [:create, :update]
           end
         when :mongo_mapper
           art = Class.new do
@@ -281,7 +281,7 @@ describe UserNotification::Tracked do
             key :name, String
             key :published, Boolean
 
-            tracked :only => [:create, :update]
+            acts_as_notifiable :only => [:create, :update]
           end
         when :active_record
           art = article({:only => [:create, :update]})
@@ -294,31 +294,31 @@ describe UserNotification::Tracked do
 
     it 'accepts :owner option' do
       owner = mock('owner')
-      subject.tracked(:owner => owner)
+      subject.acts_as_notifiable(:owner => owner)
       subject.notification_owner_global.must_equal owner
     end
 
     it 'accepts :params option' do
       params = {:a => 1}
-      subject.tracked(:params => params)
+      subject.acts_as_notifiable(:params => params)
       subject.notification_params_global.must_equal params
     end
 
     it 'accepts :on option' do
       on = {:a => lambda{}, :b => proc {}}
-      subject.tracked(:on => on)
+      subject.acts_as_notifiable(:on => on)
       subject.notification_hooks.must_equal on
     end
 
     it 'accepts :on option with string keys' do
       on = {'a' => lambda {}}
-      subject.tracked(:on => on)
+      subject.acts_as_notifiable(:on => on)
       subject.notification_hooks.must_equal on.symbolize_keys
     end
 
     it 'accepts :on values that are procs' do
       on = {:unpassable => 1, :proper => lambda {}, :proper_proc => proc {}}
-      subject.tracked(:on => on)
+      subject.acts_as_notifiable(:on => on)
       subject.notification_hooks.must_include :proper
       subject.notification_hooks.must_include :proper_proc
       subject.notification_hooks.wont_include :unpassable
@@ -350,7 +350,7 @@ describe UserNotification::Tracked do
     end
 
     it 'allows hooks to decide if notification should be created' do
-      subject.tracked
+      subject.acts_as_notifiable
       @article = subject.new(:name => 'Some Name')
       UserNotification.set_controller(mock('controller'))
       pf = proc { |model, controller|

data/test/test_helper.rb

@@ -30,7 +30,7 @@ when :active_record
     klass = Class.new(ActiveRecord::Base) do
       self.table_name = 'articles'
       include UserNotification::Model
-      tracked options
+      acts_as_notifiable options
       belongs_to :user
 
       def self.name
@@ -78,7 +78,7 @@ when :mongoid
   def article(options = {})
     Article.class_eval do
       set_user_notification_class_defaults
-      tracked options
+      acts_as_notifiable options
     end
     Article
   end
@@ -111,7 +111,7 @@ when :mongo_mapper
   def article(options = {})
     Article.class_eval do
       set_user_notification_class_defaults
-      tracked options
+      acts_as_notifiable options
     end
     Article
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: user_notification
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Wei Zhu
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-25 00:00:00.000000000 Z
+date: 2013-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -174,26 +174,26 @@ files:
 - lib/user_notification/config.rb
 - lib/user_notification/models/activist.rb
 - lib/user_notification/models/adapter.rb
+- lib/user_notification/models/notifiable.rb
 - lib/user_notification/models/notification.rb
-- lib/user_notification/models/trackable.rb
 - lib/user_notification/orm/active_record.rb
 - lib/user_notification/orm/active_record/activist.rb
 - lib/user_notification/orm/active_record/adapter.rb
+- lib/user_notification/orm/active_record/notifiable.rb
 - lib/user_notification/orm/active_record/notification.rb
-- lib/user_notification/orm/active_record/trackable.rb
 - lib/user_notification/orm/mongo_mapper.rb
 - lib/user_notification/orm/mongo_mapper/activist.rb
 - lib/user_notification/orm/mongo_mapper/adapter.rb
+- lib/user_notification/orm/mongo_mapper/notifiable.rb
 - lib/user_notification/orm/mongo_mapper/notification.rb
-- lib/user_notification/orm/mongo_mapper/trackable.rb
 - lib/user_notification/orm/mongoid.rb
 - lib/user_notification/orm/mongoid/activist.rb
 - lib/user_notification/orm/mongoid/adapter.rb
+- lib/user_notification/orm/mongoid/notifiable.rb
 - lib/user_notification/orm/mongoid/notification.rb
-- lib/user_notification/orm/mongoid/trackable.rb
 - lib/user_notification/renderable.rb
+- lib/user_notification/roles/acts_as_notifiable.rb
 - lib/user_notification/roles/deactivatable.rb
-- lib/user_notification/roles/tracked.rb
 - lib/user_notification/utility/store_controller.rb
 - lib/user_notification/utility/view_helpers.rb
 - lib/user_notification/version.rb
@@ -208,12 +208,12 @@ files:
 - test/mongo_mapper.yml
 - test/mongoid.yml
 - test/test_activist.rb
+- test/test_acts_as_notifiable.rb
 - test/test_common.rb
 - test/test_controller_integration.rb
 - test/test_generators.rb
 - test/test_helper.rb
 - test/test_notification.rb
-- test/test_tracking.rb
 - test/test_view_helpers.rb
 - test/views/layouts/_notification.erb
 - test/views/user_notification/_test.erb
@@ -248,12 +248,12 @@ test_files:
 - test/mongo_mapper.yml
 - test/mongoid.yml
 - test/test_activist.rb
+- test/test_acts_as_notifiable.rb
 - test/test_common.rb
 - test/test_controller_integration.rb
 - test/test_generators.rb
 - test/test_helper.rb
 - test/test_notification.rb
-- test/test_tracking.rb
 - test/test_view_helpers.rb
 - test/views/layouts/_notification.erb
 - test/views/user_notification/_test.erb