lib/watchable.rb

   1 # encoding: utf-8
   2 #--
   3 #   Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies)
   4 #
   5 #   This program is free software: you can redistribute it and/or modify
   6 #   it under the terms of the GNU Affero General Public License as published by
   7 #   the Free Software Foundation, either version 3 of the License, or
   8 #   (at your option) any later version.
   9 #
  10 #   This program is distributed in the hope that it will be useful,
  11 #   but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 #   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 #   GNU Affero General Public License for more details.
  14 #
  15 #   You should have received a copy of the GNU Affero General Public License
  16 #   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  17 #++
  18
  19 # By including this module in an AR::Base descendant, this class becomes watchable:
  20 # - has_many :favorites
  21 # - receives instance methods
  22 module Watchable
  23
  24   def self.included(base)
  25     base.has_many :favorites, :as => :watchable, :dependent => :destroy
  26     base.has_many :watchers, :through => :favorites, :source => :user
  27   end
  28
  29   def watched_by?(user)
  30     watchers.include?(user)
  31   end
  32
  33   def list_as_favorite?
  34     true
  35   end
  36
  37   def watched_by!(a_user)
  38     a_user.favorites.create!(:watchable => self, :notify_by_email => a_user.default_favorite_notifications)
  39   end
  40 end