OSDN Git Service

Activity refactoring.
authorJean-Philippe Lang <jp_lang@yahoo.fr>
Sun, 27 Jul 2008 17:54:09 +0000 (17:54 +0000)
committerJean-Philippe Lang <jp_lang@yahoo.fr>
Sun, 27 Jul 2008 17:54:09 +0000 (17:54 +0000)
git-svn-id: http://redmine.rubyforge.org/svn/trunk@1701 e93f8b46-1217-0410-a6f0-8f06a7374b81

17 files changed:
app/controllers/projects_controller.rb
app/models/attachment.rb
app/models/changeset.rb
app/models/document.rb
app/models/issue.rb
app/models/journal.rb
app/models/message.rb
app/models/news.rb
app/models/wiki_content.rb
app/views/projects/activity.rhtml
lib/redmine.rb
lib/redmine/activity.rb [new file with mode: 0644]
lib/redmine/activity/fetcher.rb [new file with mode: 0644]
test/functional/projects_controller_test.rb
test/unit/activity_test.rb [new file with mode: 0644]
vendor/plugins/acts_as_activity_provider/init.rb [new file with mode: 0644]
vendor/plugins/acts_as_activity_provider/lib/acts_as_activity_provider.rb [new file with mode: 0644]

index 3af77d1..ce4b24b 100644 (file)
@@ -226,94 +226,22 @@ class ProjectsController < ApplicationController
 
     @date_to ||= Date.today + 1
     @date_from = @date_to - @days
+    @with_subprojects = params[:with_subprojects].nil? ? Setting.display_subprojects_issues? : (params[:with_subprojects] == '1')
     
-    @event_types = %w(issues news files documents changesets wiki_pages messages)
-    if @project
-      @event_types.delete('wiki_pages') unless @project.wiki
-      @event_types.delete('changesets') unless @project.repository
-      @event_types.delete('messages') unless @project.boards.any?
-      # only show what the user is allowed to view
-      @event_types = @event_types.select {|o| User.current.allowed_to?("view_#{o}".to_sym, @project)}
-      @with_subprojects = params[:with_subprojects].nil? ? Setting.display_subprojects_issues? : (params[:with_subprojects] == '1')
-    end
-    @scope = @event_types.select {|t| params["show_#{t}"]}
-    # default events if none is specified in parameters
-    @scope = (@event_types - %w(wiki_pages messages))if @scope.empty?
-    
-    @events = []    
-    
-    if @scope.include?('issues')
-      cond = ARCondition.new(Project.allowed_to_condition(User.current, :view_issues, :project => @project, :with_subprojects => @with_subprojects))
-      cond.add(["#{Issue.table_name}.created_on BETWEEN ? AND ?", @date_from, @date_to])
-      @events += Issue.find(:all, :include => [:project, :author, :tracker], :conditions => cond.conditions)
-      
-      cond = ARCondition.new(Project.allowed_to_condition(User.current, :view_issues, :project => @project, :with_subprojects => @with_subprojects))
-      cond.add(["#{Journal.table_name}.journalized_type = 'Issue' AND #{Journal.table_name}.created_on BETWEEN ? AND ?", @date_from, @date_to])
-      cond.add("#{JournalDetail.table_name}.prop_key = 'status_id' OR #{Journal.table_name}.notes <> ''")
-      @events += Journal.find(:all, :include => [{:issue => :project}, :details, :user], :conditions => cond.conditions)
-    end
-    
-    if @scope.include?('news')
-      cond = ARCondition.new(Project.allowed_to_condition(User.current, :view_news, :project => @project, :with_subprojects => @with_subprojects))
-      cond.add(["#{News.table_name}.created_on BETWEEN ? AND ?", @date_from, @date_to])
-      @events += News.find(:all, :include => [:project, :author], :conditions => cond.conditions)
-    end
-    
-    if @scope.include?('files')
-      cond = ARCondition.new(Project.allowed_to_condition(User.current, :view_files, :project => @project, :with_subprojects => @with_subprojects))
-      cond.add(["#{Attachment.table_name}.created_on BETWEEN ? AND ?", @date_from, @date_to])
-      @events += Attachment.find(:all, :select => "#{Attachment.table_name}.*", 
-                                       :joins => "LEFT JOIN #{Version.table_name} ON #{Attachment.table_name}.container_type='Version' AND #{Version.table_name}.id = #{Attachment.table_name}.container_id " +
-                                                 "LEFT JOIN #{Project.table_name} ON #{Version.table_name}.project_id = #{Project.table_name}.id",
-                                       :conditions => cond.conditions)
-    end
-    
-    if @scope.include?('documents')
-      cond = ARCondition.new(Project.allowed_to_condition(User.current, :view_documents, :project => @project, :with_subprojects => @with_subprojects))
-      cond.add(["#{Document.table_name}.created_on BETWEEN ? AND ?", @date_from, @date_to])
-      @events += Document.find(:all, :include => :project, :conditions => cond.conditions)
-      
-      cond = ARCondition.new(Project.allowed_to_condition(User.current, :view_documents, :project => @project, :with_subprojects => @with_subprojects))
-      cond.add(["#{Attachment.table_name}.created_on BETWEEN ? AND ?", @date_from, @date_to])
-      @events += Attachment.find(:all, :select => "#{Attachment.table_name}.*", 
-                                       :joins => "LEFT JOIN #{Document.table_name} ON #{Attachment.table_name}.container_type='Document' AND #{Document.table_name}.id = #{Attachment.table_name}.container_id " +
-                                                 "LEFT JOIN #{Project.table_name} ON #{Document.table_name}.project_id = #{Project.table_name}.id",
-                                       :conditions => cond.conditions)
-    end
-    
-    if @scope.include?('wiki_pages')
-      select = "#{WikiContent.versioned_table_name}.updated_on, #{WikiContent.versioned_table_name}.comments, " +
-               "#{WikiContent.versioned_table_name}.#{WikiContent.version_column}, #{WikiPage.table_name}.title, " +
-               "#{WikiContent.versioned_table_name}.page_id, #{WikiContent.versioned_table_name}.author_id, " +
-               "#{WikiContent.versioned_table_name}.id"
-      joins = "LEFT JOIN #{WikiPage.table_name} ON #{WikiPage.table_name}.id = #{WikiContent.versioned_table_name}.page_id " +
-              "LEFT JOIN #{Wiki.table_name} ON #{Wiki.table_name}.id = #{WikiPage.table_name}.wiki_id " +
-              "LEFT JOIN #{Project.table_name} ON #{Project.table_name}.id = #{Wiki.table_name}.project_id"
+    @activity = Redmine::Activity::Fetcher.new(User.current, :project => @project, :with_subprojects => @with_subprojects)
+    @activity.scope_select {|t| !params["show_#{t}"].nil?}
+    @activity.default_scope! if @activity.scope.empty?
 
-      cond = ARCondition.new(Project.allowed_to_condition(User.current, :view_wiki_pages, :project => @project, :with_subprojects => @with_subprojects))
-      cond.add(["#{WikiContent.versioned_table_name}.updated_on BETWEEN ? AND ?", @date_from, @date_to])
-      @events += WikiContent.versioned_class.find(:all, :select => select, :joins => joins, :conditions => cond.conditions)
-    end
-
-    if @scope.include?('changesets')
-      cond = ARCondition.new(Project.allowed_to_condition(User.current, :view_changesets, :project => @project, :with_subprojects => @with_subprojects))
-      cond.add(["#{Changeset.table_name}.committed_on BETWEEN ? AND ?", @date_from, @date_to])
-      @events += Changeset.find(:all, :include => {:repository => :project}, :conditions => cond.conditions)
-    end
-    
-    if @scope.include?('messages')
-      cond = ARCondition.new(Project.allowed_to_condition(User.current, :view_messages, :project => @project, :with_subprojects => @with_subprojects))
-      cond.add(["#{Message.table_name}.created_on BETWEEN ? AND ?", @date_from, @date_to])
-      @events += Message.find(:all, :include => [{:board => :project}, :author], :conditions => cond.conditions)
-    end
-    
-    @events_by_day = @events.group_by(&:event_date)
+    events = @activity.events(@date_from, @date_to)
     
     respond_to do |format|
-      format.html { render :layout => false if request.xhr? }
+      format.html { 
+        @events_by_day = events.group_by(&:event_date)
+        render :layout => false if request.xhr?
+      }
       format.atom {
         title = (@scope.size == 1) ? l("label_#{@scope.first.singularize}_plural") : l(:label_activity)
-        render_feed(@events, :title => "#{@project || Setting.app_title}: #{title}")
+        render_feed(events, :title => "#{@project || Setting.app_title}: #{title}")
       }
     end
   end
index 8f3f530..95ba849 100644 (file)
@@ -28,6 +28,18 @@ class Attachment < ActiveRecord::Base
   acts_as_event :title => :filename,
                 :url => Proc.new {|o| {:controller => 'attachments', :action => 'download', :id => o.id, :filename => o.filename}}
 
+  acts_as_activity_provider :type => 'files',
+                            :permission => :view_files,
+                            :find_options => {:select => "#{Attachment.table_name}.*", 
+                                              :joins => "LEFT JOIN #{Version.table_name} ON #{Attachment.table_name}.container_type='Version' AND #{Version.table_name}.id = #{Attachment.table_name}.container_id " +
+                                                        "LEFT JOIN #{Project.table_name} ON #{Version.table_name}.project_id = #{Project.table_name}.id"}
+  
+  acts_as_activity_provider :type => 'documents',
+                            :permission => :view_documents,
+                            :find_options => {:select => "#{Attachment.table_name}.*", 
+                                              :joins => "LEFT JOIN #{Document.table_name} ON #{Attachment.table_name}.container_type='Document' AND #{Document.table_name}.id = #{Attachment.table_name}.container_id " +
+                                                        "LEFT JOIN #{Project.table_name} ON #{Document.table_name}.project_id = #{Project.table_name}.id"}
+
   cattr_accessor :storage_path
   @@storage_path = "#{RAILS_ROOT}/files"
   
index 41f5ed8..0663af3 100644 (file)
@@ -30,6 +30,9 @@ class Changeset < ActiveRecord::Base
                      :include => {:repository => :project},
                      :project_key => "#{Repository.table_name}.project_id",
                      :date_column => 'committed_on'
+                     
+  acts_as_activity_provider :timestamp => "#{table_name}.committed_on",
+                            :find_options => {:include => {:repository => :project}}
   
   validates_presence_of :repository_id, :revision, :committed_on, :commit_date
   validates_uniqueness_of :revision, :scope => :repository_id
index 9e2818f..627a241 100644 (file)
@@ -24,7 +24,8 @@ class Document < ActiveRecord::Base
   acts_as_event :title => Proc.new {|o| "#{l(:label_document)}: #{o.title}"},
                 :author => Proc.new {|o| (a = o.attachments.find(:first, :order => "#{Attachment.table_name}.created_on ASC")) ? a.author : nil },
                 :url => Proc.new {|o| {:controller => 'documents', :action => 'show', :id => o.id}}
-
+  acts_as_activity_provider :find_options => {:include => :project}
+  
   validates_presence_of :project, :title, :category
   validates_length_of :title, :maximum => 60
 end
index e2405a0..7ebe9db 100644 (file)
@@ -42,6 +42,8 @@ class Issue < ActiveRecord::Base
   acts_as_event :title => Proc.new {|o| "#{o.tracker.name} ##{o.id}: #{o.subject}"},
                 :url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.id}}                
   
+  acts_as_activity_provider :find_options => {:include => [:project, :author, :tracker]}
+  
   validates_presence_of :subject, :description, :priority, :project, :tracker, :author, :status
   validates_length_of :subject, :maximum => 255
   validates_inclusion_of :done_ratio, :in => 0..100
index a427f84..71a5129 100644 (file)
@@ -31,6 +31,12 @@ class Journal < ActiveRecord::Base
                 :type => Proc.new {|o| (s = o.new_status) ? (s.is_closed? ? 'issue-closed' : 'issue-edit') : 'issue-note' },
                 :url => Proc.new {|o| {:controller => 'issues', :action => 'show', :id => o.issue.id, :anchor => "change-#{o.id}"}}
 
+  acts_as_activity_provider :type => 'issues',
+                            :permission => :view_issues,
+                            :find_options => {:include => [{:issue => :project}, :details, :user],
+                                              :conditions => "#{Journal.table_name}.journalized_type = 'Issue' AND" +
+                                                             " (#{JournalDetail.table_name}.prop_key = 'status_id' OR #{Journal.table_name}.notes <> '')"}
+  
   def save
     # Do not save an empty journal
     (details.empty? && notes.blank?) ? false : super
index 888bffc..80df7a3 100644 (file)
@@ -31,7 +31,9 @@ class Message < ActiveRecord::Base
                 :type => Proc.new {|o| o.parent_id.nil? ? 'message' : 'reply'},
                 :url => Proc.new {|o| {:controller => 'messages', :action => 'show', :board_id => o.board_id}.merge(o.parent_id.nil? ? {:id => o.id} : 
                                                                                                                                        {:id => o.parent_id, :anchor => "message-#{o.id}"})}
-  
+
+  acts_as_activity_provider :find_options => {:include => [{:board => :project}, :author]}
+    
   attr_protected :locked, :sticky
   validates_presence_of :subject, :content
   validates_length_of :subject, :maximum => 255
index 71e2a2d..4c4943b 100644 (file)
@@ -26,7 +26,8 @@ class News < ActiveRecord::Base
 
   acts_as_searchable :columns => ['title', "#{table_name}.description"], :include => :project
   acts_as_event :url => Proc.new {|o| {:controller => 'news', :action => 'show', :id => o.id}}
-
+  acts_as_activity_provider :find_options => {:include => [:project, :author]}
+  
   # returns latest news for projects visible by user
   def self.latest(user=nil, count=5)
     find(:all, :limit => count, :conditions => Project.visible_by(user), :include => [ :author, :project ], :order => "#{News.table_name}.created_on DESC")    
index 724354a..f2ee39c 100644 (file)
@@ -35,6 +35,17 @@ class WikiContent < ActiveRecord::Base
                   :type => 'wiki-page',
                   :url => Proc.new {|o| {:controller => 'wiki', :id => o.page.wiki.project_id, :page => o.page.title, :version => o.version}}
 
+    acts_as_activity_provider :type => 'wiki_pages',
+                              :timestamp => "#{WikiContent.versioned_table_name}.updated_on",
+                              :permission => :view_wiki_pages,
+                              :find_options => {:select => "#{WikiContent.versioned_table_name}.updated_on, #{WikiContent.versioned_table_name}.comments, " +
+                                                           "#{WikiContent.versioned_table_name}.#{WikiContent.version_column}, #{WikiPage.table_name}.title, " +
+                                                           "#{WikiContent.versioned_table_name}.page_id, #{WikiContent.versioned_table_name}.author_id, " +
+                                                           "#{WikiContent.versioned_table_name}.id",
+                                                :joins => "LEFT JOIN #{WikiPage.table_name} ON #{WikiPage.table_name}.id = #{WikiContent.versioned_table_name}.page_id " +
+                                                          "LEFT JOIN #{Wiki.table_name} ON #{Wiki.table_name}.id = #{WikiPage.table_name}.wiki_id " +
+                                                          "LEFT JOIN #{Project.table_name} ON #{Project.table_name}.id = #{Wiki.table_name}.project_id"}
+
     def text=(plain)
       case Setting.wiki_compression
       when 'gzip'
index c08cd06..fa25812 100644 (file)
@@ -44,8 +44,8 @@
 <% content_for :sidebar do %>
 <% form_tag({}, :method => :get) do %>
 <h3><%= l(:label_activity) %></h3>
-<p><% @event_types.each do |t| %>
-<label><%= check_box_tag "show_#{t}", 1, @scope.include?(t) %> <%= l("label_#{t.singularize}_plural")%></label><br />
+<p><% @activity.event_types.each do |t| %>
+<label><%= check_box_tag "show_#{t}", 1, @activity.scope.include?(t) %> <%= l("label_#{t.singularize}_plural")%></label><br />
 <% end %></p>
 <% if @project && @project.active_children.any? %>
     <p><label><%= check_box_tag 'with_subprojects', 1, @with_subprojects %> <%=l(:label_subproject_plural)%></label></p>
index 22b60e9..bd413c9 100644 (file)
@@ -1,5 +1,6 @@
 require 'redmine/access_control'
 require 'redmine/menu_manager'
+require 'redmine/activity'
 require 'redmine/mime_type'
 require 'redmine/core_ext'
 require 'redmine/themes'
@@ -132,3 +133,13 @@ Redmine::MenuManager.map :project_menu do |menu|
               :if => Proc.new { |p| p.repository && !p.repository.new_record? }
   menu.push :settings, { :controller => 'projects', :action => 'settings' }, :last => true
 end
+
+Redmine::Activity.map do |activity|
+  activity.register :issues, :class_name => %w(Issue Journal)
+  activity.register :changesets
+  activity.register :news
+  activity.register :documents, :class_name => %w(Document Attachment)
+  activity.register :files, :class_name => 'Attachment'
+  activity.register :wiki_pages, :class_name => 'WikiContent::Version', :default => false
+  activity.register :messages, :default => false
+end
diff --git a/lib/redmine/activity.rb b/lib/redmine/activity.rb
new file mode 100644 (file)
index 0000000..144ce95
--- /dev/null
@@ -0,0 +1,54 @@
+# Redmine - project management software
+# Copyright (C) 2006-2008  Jean-Philippe Lang
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+module Redmine
+  module Activity
+  
+    mattr_accessor :available_event_types, :default_event_types, :providers
+    
+    @@available_event_types = []
+    @@default_event_types = []
+    @@providers = Hash.new {|h,k| h[k]=[] }
+
+    class << self
+      def map(&block)
+        yield self
+      end
+      
+      # Registers an activity provider
+      # 
+      # Options:
+      # * :class_name - one or more model(s) that provide these events (inferred from event_type by default)
+      # * :default - setting this option to false will make the events not displayed by default
+      # 
+      # Examples:
+      #   register :issues
+      #   register :myevents, :class_name => 'Meeting'
+      def register(event_type, options={})
+        options.assert_valid_keys(:class_name, :default)
+        
+        event_type = event_type.to_s
+        providers = options[:class_name] || event_type.classify
+        providers = ([] << providers) unless providers.is_a?(Array)
+        
+        @@available_event_types << event_type unless @@available_event_types.include?(event_type)
+        @@default_event_types << event_type unless options[:default] == false
+        @@providers[event_type] += providers
+      end
+    end
+  end
+end
diff --git a/lib/redmine/activity/fetcher.rb b/lib/redmine/activity/fetcher.rb
new file mode 100644 (file)
index 0000000..adaead5
--- /dev/null
@@ -0,0 +1,79 @@
+# Redmine - project management software
+# Copyright (C) 2006-2008  Jean-Philippe Lang
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+module Redmine
+  module Activity
+    # Class used to retrieve activity events
+    class Fetcher
+      attr_reader :user, :project, :scope
+      
+      # Needs to be unloaded in development mode
+      @@constantized_providers = Hash.new {|h,k| h[k] = Redmine::Activity.providers[k].collect {|t| t.constantize } }
+      
+      def initialize(user, options={})
+        options.assert_valid_keys(:project, :with_subprojects)
+        @user = user
+        @project = options[:project]
+        @options = options
+        
+        @scope = event_types
+      end
+      
+      # Returns an array of available event types
+      def event_types
+        return @event_types unless @event_types.nil?
+        
+        @event_types = Redmine::Activity.available_event_types
+        @event_types = @event_types.select {|o| @user.allowed_to?("view_#{o}".to_sym, @project)} if @project
+        @event_types
+      end
+      
+      # Yields to filter the activity scope
+      def scope_select(&block)
+        @scope = @scope.select {|t| yield t }
+      end
+      
+      # Sets the scope
+      def scope=(s)
+        @scope = s & event_types
+      end
+      
+      # Resets the scope to the default scope
+      def default_scope!
+        @scope = Redmine::Activity.default_event_types
+      end
+      
+      # Returns an array of events for the given date range
+      def events(from, to)
+        e = []
+        
+        @scope.each do |event_type|
+          constantized_providers(event_type).each do |provider|
+            e += provider.find_events(event_type, @user, from, to, @options)
+          end
+        end
+        e
+      end
+      
+      private
+      
+      def constantized_providers(event_type)
+        @@constantized_providers[event_type]
+      end
+    end
+  end
+end
index 4f0a2f1..935d5ba 100644 (file)
@@ -153,10 +153,6 @@ class ProjectsControllerTest < Test::Unit::TestCase
     assert_response :success
     assert_template 'activity'
     assert_not_nil assigns(:events_by_day)
-    assert_not_nil assigns(:events)
-
-    # subproject issue not included by default
-    assert !assigns(:events).include?(Issue.find(5))
     
     assert_tag :tag => "h3", 
                :content => /#{2.days.ago.to_date.day}/,
@@ -168,7 +164,9 @@ class ProjectsControllerTest < Test::Unit::TestCase
                    }
                  }
                }
-               
+  end
+  
+  def test_previous_project_activity
     get :activity, :id => 1, :from => 3.days.ago.to_date
     assert_response :success
     assert_template 'activity'
@@ -186,53 +184,24 @@ class ProjectsControllerTest < Test::Unit::TestCase
                }
   end
   
-  def test_activity_with_subprojects
-    get :activity, :id => 1, :with_subprojects => 1
-    assert_response :success
-    assert_template 'activity'
-    assert_not_nil assigns(:events)
-    
-    assert assigns(:events).include?(Issue.find(1))
-    assert !assigns(:events).include?(Issue.find(4))
-    # subproject issue
-    assert assigns(:events).include?(Issue.find(5))
-  end
-  
-  def test_global_activity_anonymous
-    get :activity
-    assert_response :success
-    assert_template 'activity'
-    assert_not_nil assigns(:events)
-    
-    assert assigns(:events).include?(Issue.find(1))
-    # Issue of a private project
-    assert !assigns(:events).include?(Issue.find(4))
-  end
-  
-  def test_global_activity_logged_user
-    @request.session[:user_id] = 2 # manager
+  def test_global_activity
     get :activity
     assert_response :success
     assert_template 'activity'
-    assert_not_nil assigns(:events)
+    assert_not_nil assigns(:events_by_day)
     
-    assert assigns(:events).include?(Issue.find(1))
-    # Issue of a private project the user belongs to
-    assert assigns(:events).include?(Issue.find(4))
+    assert_tag :tag => "h3", 
+               :content => /#{5.day.ago.to_date.day}/,
+               :sibling => { :tag => "dl",
+                 :child => { :tag => "dt",
+                   :attributes => { :class => /issue/ },
+                   :child => { :tag => "a",
+                     :content => /#{Issue.find(5).subject}/,
+                   }
+                 }
+               }
   end
-
   
-  def test_global_activity_with_all_types
-    get :activity, :show_issues => 1, :show_news => 1, :show_files => 1, :show_documents => 1, :show_changesets => 1, :show_wiki_pages => 1, :show_messages => 1
-    assert_response :success
-    assert_template 'activity'
-    assert_not_nil assigns(:events)
-    
-    assert assigns(:events).include?(Issue.find(1))
-    assert !assigns(:events).include?(Issue.find(4))
-    assert assigns(:events).include?(Message.find(5))
-  end
-
   def test_calendar
     get :calendar, :id => 1
     assert_response :success
diff --git a/test/unit/activity_test.rb b/test/unit/activity_test.rb
new file mode 100644 (file)
index 0000000..ccda9f1
--- /dev/null
@@ -0,0 +1,71 @@
+# redMine - project management software
+# Copyright (C) 2006-2008  Jean-Philippe Lang
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+require File.dirname(__FILE__) + '/../test_helper'
+
+class ActivityTest < Test::Unit::TestCase
+  fixtures :projects, :versions, :users, :roles, :members, :issues, :journals, :journal_details,
+           :trackers, :projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :boards, :messages
+
+  def setup
+    @project = Project.find(1)
+  end
+  
+  def test_activity_without_subprojects
+    events = find_events(User.anonymous, :project => @project)
+    assert_not_nil events
+    
+    assert events.include?(Issue.find(1))
+    assert !events.include?(Issue.find(4))
+    # subproject issue
+    assert !events.include?(Issue.find(5))
+  end
+
+  def test_activity_with_subprojects
+    events = find_events(User.anonymous, :project => @project, :with_subprojects => 1)
+    assert_not_nil events
+    
+    assert events.include?(Issue.find(1))
+    # subproject issue
+    assert events.include?(Issue.find(5))
+  end
+  
+  def test_global_activity_anonymous
+    events = find_events(User.anonymous)
+    assert_not_nil events
+    
+    assert events.include?(Issue.find(1))
+    assert events.include?(Message.find(5))
+    # Issue of a private project
+    assert !events.include?(Issue.find(4))
+  end
+  
+  def test_global_activity_logged_user
+    events = find_events(User.find(2)) # manager
+    assert_not_nil events
+    
+    assert events.include?(Issue.find(1))
+    # Issue of a private project the user belongs to
+    assert events.include?(Issue.find(4))
+  end
+  
+  private
+  
+  def find_events(user, options={})
+    Redmine::Activity::Fetcher.new(user, options).events(Date.today - 30, Date.today + 1)
+  end
+end
diff --git a/vendor/plugins/acts_as_activity_provider/init.rb b/vendor/plugins/acts_as_activity_provider/init.rb
new file mode 100644 (file)
index 0000000..5bf05da
--- /dev/null
@@ -0,0 +1,2 @@
+require File.dirname(__FILE__) + '/lib/acts_as_activity_provider'
+ActiveRecord::Base.send(:include, Redmine::Acts::ActivityProvider)
diff --git a/vendor/plugins/acts_as_activity_provider/lib/acts_as_activity_provider.rb b/vendor/plugins/acts_as_activity_provider/lib/acts_as_activity_provider.rb
new file mode 100644 (file)
index 0000000..7c4fac8
--- /dev/null
@@ -0,0 +1,68 @@
+# redMine - project management software
+# Copyright (C) 2006-2008  Jean-Philippe Lang
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+# 
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+
+module Redmine
+  module Acts
+    module ActivityProvider
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def acts_as_activity_provider(options = {})
+          unless self.included_modules.include?(Redmine::Acts::ActivityProvider::InstanceMethods)
+            cattr_accessor :activity_provider_options
+            send :include, Redmine::Acts::ActivityProvider::InstanceMethods
+          end
+
+          options.assert_valid_keys(:type, :permission, :timestamp, :find_options)
+          self.activity_provider_options ||= {}
+          
+          # One model can provide different event types
+          # We store these options in activity_provider_options hash
+          event_type = options.delete(:type) || self.name.underscore.pluralize
+          
+          options[:permission] = "view_#{self.name.underscore.pluralize}".to_sym unless options.has_key?(:permission)
+          options[:timestamp] ||= "#{table_name}.created_on"
+          options[:find_options] ||= {}
+          self.activity_provider_options[event_type] = options
+        end
+      end
+
+      module InstanceMethods
+        def self.included(base)
+          base.extend ClassMethods
+        end
+                
+        module ClassMethods
+          # Returns events of type event_type visible by user that occured between from and to
+          def find_events(event_type, user, from, to, options)
+            provider_options = activity_provider_options[event_type]
+            raise "#{self.name} can not provide #{event_type} events." if provider_options.nil?
+            
+            cond = ARCondition.new(["#{provider_options[:timestamp]} BETWEEN ? AND ?", from, to])
+            cond.add(Project.allowed_to_condition(user, provider_options[:permission], options)) if provider_options[:permission]
+            
+            with_scope(:find => { :conditions => cond.conditions }) do
+              find(:all, provider_options[:find_options])
+            end
+          end
+        end
+      end
+    end
+  end
+end