File: app/models/news.rb

Overview
Module Structure
Class Hierarchy
Code

Overview

Module Structure

  module: <Toplevel Module>
  class: News#18
includes
  SafeAttributes ( Redmine )
inherits from
  Base ( ActiveRecord )
has properties
method: visible? / 1 #44
method: commentable? / 1 #49
class method: latest / 2 #54
method: add_author_as_watcher #63

Class Hierarchy

Object ( Builtin-Module )
Base ( ActiveRecord )
  News    #18

Code

   1  # Redmine - project management software
   2  # Copyright (C) 2006-2011  Jean-Philippe Lang
   3  #
   4  # This program is free software; you can redistribute it and/or
   5  # modify it under the terms of the GNU General Public License
   6  # as published by the Free Software Foundation; either version 2
   7  # of the License, or (at your option) any later version.
   8  #
   9  # This program is distributed in the hope that it will be useful,
  10  # but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  # GNU General Public License for more details.
  13  #
  14  # You should have received a copy of the GNU General Public License
  15  # along with this program; if not, write to the Free Software
  16  # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  17 
  18  class News < ActiveRecord::Base
  19    include Redmine::SafeAttributes
  20    belongs_to :project
  21    belongs_to :author, :class_name => 'User', :foreign_key => 'author_id'
  22    has_many :comments, :as => :commented, :dependent => :delete_all, :order => "created_on"
  23 
  24    validates_presence_of :title, :description
  25    validates_length_of :title, :maximum => 60
  26    validates_length_of :summary, :maximum => 255
  27 
  28    acts_as_attachable :delete_permission => :manage_news
  29    acts_as_searchable :columns => ['title', 'summary', "#{table_name}.description"], :include => :project
  30    acts_as_event :url => Proc.new {|o| {:controller => 'news', :action => 'show', :id => o.id}}
  31    acts_as_activity_provider :find_options => {:include => [:project, :author]},
  32                              :author_key => :author_id
  33    acts_as_watchable
  34 
  35    after_create :add_author_as_watcher
  36 
  37    named_scope :visible, lambda {|*args| {
  38      :include => :project,
  39      :conditions => Project.allowed_to_condition(args.shift || User.current, :view_news, *args)
  40    }}
  41 
  42    safe_attributes 'title', 'summary', 'description'
  43 
  44    def visible?(user=User.current)
  45      !user.nil? && user.allowed_to?(:view_news, project)
  46    end
  47 
  48    # Returns true if the news can be commented by user
  49    def commentable?(user=User.current)
  50      user.allowed_to?(:comment_news, project)
  51    end
  52 
  53    # returns latest news for projects visible by user
  54    def self.latest(user = User.current, count = 5)
  55      find(:all, :limit => count,
  56           :conditions => Project.allowed_to_condition(user, :view_news),
  57           :include => [ :author, :project ],
  58           :order => "#{News.table_name}.created_on DESC")
  59    end
  60 
  61    private
  62 
  63    def add_author_as_watcher
  64      Watcher.create(:watchable => self, :user => author)
  65    end
  66  end