Makes FilePresenter to work with all noosfero tests

Aurélio A. Heckert
1 parent 37096d03
Showing 17 changed files with 145 additions and 44 deletions Show diff stats
app/controllers/application_controller.rb
app/helpers/cms_helper.rb
app/helpers/folder_helper.rb
app/models/uploaded_file.rb
app/views/cms/view.rhtml
app/views/file_presenter/_image.html.erb
lib/file_presenter.rb
lib/file_presenter/image.rb
plugins/html5_video/lib/file_presenter/video.rb
plugins/html5_video/test/functional/content_viewer_controler_test.rb
plugins/html5_video/views/file_presenter/_video.html.erb
test/functional/cms_controller_test.rb
test/functional/content_viewer_controller_test.rb
test/unit/cms_helper_test.rb
test/unit/file_presenter_test.rb
test/unit/folder_helper_test.rb
test/unit/uploaded_file_test.rb
 class ApplicationController < ActionController::Base
-  # Preload FilePresenters to allow `FilePresenter.for()` to work
-  FilePresenter::Generic
-  FilePresenter::Image
-
   before_filter :setup_multitenancy
   before_filter :detect_stuff_by_domain
   before_filter :init_noosfero_plugins
@@ -33,7 +33,7 @@ module CmsHelper
       link_to article_name, {:action => 'view', :id => article.id}, :class => icon_for_article(article)
     else
       if article.image?
-         image_tag(icon_for_article(article)) + link_to(article_name, article.url)
+        image_tag(icon_for_article(article)) + link_to(article_name, article.url)
       else
         link_to article_name, article.url, :class => icon_for_article(article)
       end
@@ -41,7 +41,10 @@ module FolderHelper
   end
   def icon_for_article(article)
-    icon = article.icon_name || article.class.icon_name(article)
+    article = FilePresenter.for article
+    icon = article.respond_to?(:icon_name) ?
+             article.icon_name :
+             article.class.icon_name(article)
     if (icon =~ /\//)
       icon
     else
@@ -60,13 +60,19 @@ class UploadedFile &lt; Article
   postgresql_attachment_fu
+  # Use this method only to get the generic icon for this kind of content.
+  # If you want the specific icon for a file type or the iconified version
+  # of an image, use FilePresenter.for(uploaded_file).icon_name
   def self.icon_name(article = nil)
-    warn = ('='*80) + "\n" +
-           'The method `UploadedFile.icon_name(obj)` is deprecated. ' +
-           'You must to encapsulate UploadedFile with `FilePresenter.for()`.' +
-           "\n" + ('='*80)
-    Rails.logger.warn warn if Rails.logger
-    puts warn
+    unless article.nil?
+      warn = ('='*80) + "\n" +
+             'The method `UploadedFile.icon_name(obj)` is deprecated. ' +
+             'You must to encapsulate UploadedFile with `FilePresenter.for()`.' +
+             "\n" + ('='*80)
+      raise NoMethodError, warn if ENV['RAILS_ENV'] == 'test'
+      Rails.logger.warn warn if Rails.logger
+      puts warn if ENV['RAILS_ENV'] == 'development'
+    end
     'upload-file'
   end
@@ -94,11 +100,12 @@ class UploadedFile &lt; Article
   def to_html(options = {})
     warn = ('='*80) + "\n" +
-           'The method `UploadedFile::to_html()` is deprecated. ' +
+           'The method `UploadedFile#to_html()` is deprecated. ' +
            'You must to encapsulate UploadedFile with `FilePresenter.for()`.' +
            "\n" + ('='*80)
+    raise NoMethodError, warn if ENV['RAILS_ENV'] == 'test'
     Rails.logger.warn warn if Rails.logger
-    puts warn
+    puts warn if ENV['RAILS_ENV'] == 'development'
     article = self
     if image?
       lambda do
@@ -40,13 +40,15 @@
     </tr>
   <% end %>
-  <% @articles.each do |article| %>
+  <% @articles.each do |article| article = FilePresenter.for article %>
     <tr>
       <td>
         <%= link_to_article(article) %>
       </td>
       <td>
-        <%= article.class.short_description %>
+        <%= article.respond_to?(:short_description) ?
+                      article.short_description :
+                      article.class.short_description %>
       </td>
       <td class="article-controls">
         <%= expirable_button article, :edit, _('Edit'), {:action => 'edit', :id => article.id} if !remove_content_button(:edit) %>
@@ -31,7 +31,6 @@
 <img src="<%=image.public_filename(:display)%>" class="<%=image.css_class_name%>">
 <div class="uploaded-file-description <%= 'empty' if image.abstract.blank? %>">
-  <%= image.class %>
   <%= image.abstract %>
 </div>
@@ -22,6 +22,15 @@ class FilePresenter
     @file
   end
+  def id
+    @file.id
+  end
+
+  def reload
+    @file.reload
+    self
+  end
+
   # This method must be overridden in subclasses.
   #
   # If the class accepts the file, return a number that represents the
@@ -33,6 +42,10 @@ class FilePresenter
     nil
   end
+  def short_description
+    _("File (%s)") % content_type
+  end
+
   # Define the css classes to style the page fragment with the file related
   # content. If you want other classes to identify this area to your
   # customized presenter, so do this:
@@ -88,3 +101,7 @@ class FilePresenter
   end
 end
+
+# Preload FilePresenters to allow `FilePresenter.for()` to work
+FilePresenter::Generic
+FilePresenter::Image
@@ -8,6 +8,10 @@ class FilePresenter::Image &lt; FilePresenter
   end
   def icon_name
-    article.public_filename :icon
+    public_filename :icon
+  end
+
+  def short_description
+    _('Image (%s)') % content_type.split('/')[1].upcase
   end
 end
@@ -7,4 +7,8 @@ class FilePresenter::Video &lt; FilePresenter
     return nil if f.content_type.nil?
     ( f.content_type[0..4] == 'video' ) ? 10 : nil
   end
+
+  def short_description
+    _('Video (%s)') % content_type.split('/')[1].upcase
+  end
 end
@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/../../../../test/test_helper'
+require 'content_viewer_controller'
+
+class ContentViewerController
+  # Re-raise errors caught by the controller.
+  def rescue_action(e) raise e end
+  append_view_path File.join(File.dirname(__FILE__) + '/../../views')
+end
+
+class ContentViewerControllerTest < ActionController::TestCase
+
+  all_fixtures
+
+  def setup
+    @controller = ContentViewerController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+
+    @profile = create_user('testinguser').person
+    @environment = @profile.environment
+  end
+  attr_reader :profile, :environment
+
+  should 'add html5 video tag to the page of file type video' do
+    file = UploadedFile.create!(:uploaded_data => fixture_file_upload('/files/test.txt', 'video/ogg'), :profile => profile)
+    get :view_page, file.url.merge(:view=>:true)
+    assert_select '#article video'
+  end
+
+end
 <video class="video-js vjs-default-skin" controls poster="video.jpg" preload="auto" data-setup="{}">
-  <source type="video/ogg" src="<%= video.public_filename %>">
+  <source type="video/ogg" src="<%= video.public_filename %>"/>
 </video>
 <div class="uploaded-file-description <%= 'empty' if video.abstract.blank? %>">
@@ -931,8 +931,8 @@ class CmsControllerTest &lt; ActionController::TestCase
                :article => {:uploaded_data => fixture_file_upload('/files/rails.png', 'image/png')}
     process_delayed_job_queue
-    file = profile.articles.find_by_name('rails.png')
-    assert File.exists?(file.class.icon_name(file))
+    file = FilePresenter.for profile.articles.find_by_name('rails.png')
+    assert File.exists?(file.icon_name)
     file.destroy
   end
@@ -942,8 +942,8 @@ class CmsControllerTest &lt; ActionController::TestCase
                :article => {:uploaded_data => fixture_file_upload('/files/rails.png', 'image/png')}
     process_delayed_job_queue
-    file = profile.articles.find_by_name('rails.png')
-    assert File.exists?(file.class.icon_name(file))
+    file = FilePresenter.for profile.articles.find_by_name('rails.png')
+    assert File.exists?(file.icon_name)
     file.destroy
   end
@@ -1502,4 +1502,12 @@ end
     assert_response 404
   end
+  should 'display link to download of non-recognized file types on its page' do
+    file = UploadedFile.create!(:uploaded_data => fixture_file_upload('/files/test.txt', 'bin/unknown'), :profile => profile)
+    get :view_page, file.url.merge(:view=>:true)
+    assert_tag :tag => 'a',
+               :content => file.filename,
+               :attributes => { :href => file.public_filename }
+  end
+
 end
@@ -41,6 +41,7 @@ class CmsHelperTest &lt; ActiveSupport::TestCase
   should 'display image and link if article is an image' do
     profile = fast_create(Profile)
     file = UploadedFile.create!(:profile => profile, :uploaded_data => fixture_file_upload('/files/rails.png', 'image/png'))
+    file = FilePresenter.for file
     icon = icon_for_article(file)
     expects(:image_tag).with(icon).returns('icon')
@@ -0,0 +1,43 @@
+require File.dirname(__FILE__) + '/../test_helper'
+
+class FilePresenterTest < ActiveSupport::TestCase
+
+  should 'notify about deprecated method UploadedFile.icon_name' do
+    profile = fast_create(Profile)
+    file = UploadedFile.create!(
+             :profile => profile,
+             :uploaded_data => fixture_file_upload('/files/rails.png', 'image/png')
+           )
+    assert_raise NoMethodError do
+      UploadedFile.icon_name file
+    end
+    ENV.stubs('[]').with('RAILS_ENV').returns('other')
+    Rails.logger.expects(:warn) # must warn on any other RAILS_ENV
+    stubs(:puts)
+    UploadedFile.icon_name file
+  end
+
+  should 'notify about deprecated method UploadedFile#to_html' do
+    profile = fast_create(Profile)
+    file = UploadedFile.create!(
+             :profile => profile,
+             :uploaded_data => fixture_file_upload('/files/rails.png', 'image/png')
+           )
+    assert_raise NoMethodError do
+      file.to_html
+    end
+    ENV.stubs('[]').with('RAILS_ENV').returns('other')
+    Rails.logger.expects(:warn) # must warn on any other RAILS_ENV
+    stubs(:puts)
+    file.to_html
+  end
+
+  should 'return a thumbnail as icon for images ' do
+    f = UploadedFile.new
+    f.stubs(:image?).returns(true)
+    p = FilePresenter.for f
+    p.expects(:public_filename).with(:icon).returns('/path/to/file.xyz')
+    assert_equal '/path/to/file.xyz', p.icon_name
+  end
+
+end
@@ -26,6 +26,7 @@ class FolderHelperTest &lt; ActiveSupport::TestCase
   should 'display icon for images' do
     profile = fast_create(Profile)
     file = UploadedFile.create!(:uploaded_data => fixture_file_upload('/files/rails.png', 'image/png'), :profile => profile)
+    file = FilePresenter.for file
     process_delayed_job_queue
     assert_match /rails_icon\.png/, icon_for_article(file.reload)
@@ -7,14 +7,10 @@ class UploadedFileTest &lt; ActiveSupport::TestCase
   end
   attr_reader :profile
-  should 'return a thumbnail as icon for images ' do
-    f = UploadedFile.new
-    f.expects(:image?).returns(true)
-    f.expects(:public_filename).with(:icon).returns('/path/to/file.xyz')
-    assert_equal '/path/to/file.xyz', UploadedFile.icon_name(f)
-  end
-
   should 'return a default icon for uploaded files' do
+    ENV.stubs('[]').with('RAILS_ENV').returns('other')
+    Rails.logger.expects(:warn) # warn about deprecatede usage of UploadedFile.icon_name
+    stubs(:puts)
     assert_equal 'upload-file', UploadedFile.icon_name
   end
@@ -113,8 +109,11 @@ class UploadedFileTest &lt; ActiveSupport::TestCase
     p = create_user('test_user').person
     file = UploadedFile.create!(:uploaded_data => fixture_file_upload('/files/test.txt', 'text/plain'), :profile => p)
+    ENV.stubs('[]').with('RAILS_ENV').returns('other')
+    Rails.logger.expects(:warn) # warn about deprecatede usage of UploadedFile#to_html
+    stubs(:puts)
     stubs(:content_tag).returns('link')
-    expects(:link_to).with(file.name, file.url, :class => file.css_class_name)
+    expects(:link_to).with(file.name, file.url)
     instance_eval(&file.to_html)
   end
@@ -206,13 +205,6 @@ class UploadedFileTest &lt; ActiveSupport::TestCase
     file.destroy
   end
-  should 'return the default thumbnail image as icon for images ' do
-    f = UploadedFile.new
-    f.expects(:image?).returns(true)
-    f.expects(:public_filename).with(:icon).returns('/path/to/file.xyz')
-    assert_equal '/path/to/file.xyz', UploadedFile.icon_name(f)
-  end
-
   should 'store width and height after processing' do
     file = UploadedFile.create!(:profile => @profile, :uploaded_data => fixture_file_upload('/files/rails.png', 'image/png'))
     file.create_thumbnails
@@ -287,12 +279,6 @@ class UploadedFileTest &lt; ActiveSupport::TestCase
     assert_equal '', f.lead
   end
-  should 'survive when try to get icon_name from a file with mime_type nil' do
-    f = UploadedFile.new
-    f.expects(:mime_type).returns(nil)
-    assert_equal 'upload-file', UploadedFile.icon_name(f)
-  end
-
   should 'upload to a folder with same name as the schema if database is postgresql' do
     uses_postgresql 'image_schema_one'
     file1 = UploadedFile.create!(:uploaded_data => fixture_file_upload('/files/rails.png', 'image/png'), :profile => @profile)
	@@ -33,7 +33,7 @@ module CmsHelper		@@ -33,7 +33,7 @@ module CmsHelper
33	link_to article_name, {:action => 'view', :id => article.id}, :class => icon_for_article(article)	33	link_to article_name, {:action => 'view', :id => article.id}, :class => icon_for_article(article)
34	else	34	else
35	if article.image?	35	if article.image?
36	- image_tag(icon_for_article(article)) + link_to(article_name, article.url)	36	+ image_tag(icon_for_article(article)) + link_to(article_name, article.url)
37	else	37	else
38	link_to article_name, article.url, :class => icon_for_article(article)	38	link_to article_name, article.url, :class => icon_for_article(article)
39	end	39	end
	@@ -31,7 +31,6 @@		@@ -31,7 +31,6 @@
31	<img src="<%=image.public_filename(:display)%>" class="<%=image.css_class_name%>">	31	<img src="<%=image.public_filename(:display)%>" class="<%=image.css_class_name%>">
32		32
33	<div class="uploaded-file-description <%= 'empty' if image.abstract.blank? %>">	33	<div class="uploaded-file-description <%= 'empty' if image.abstract.blank? %>">
34	- <%= image.class %>
35	<%= image.abstract %>	34	<%= image.abstract %>
36	</div>	35	</div>
37		36
	@@ -22,6 +22,15 @@ class FilePresenter		@@ -22,6 +22,15 @@ class FilePresenter
22	@file	22	@file
23	end	23	end
24		24
		25	+ def id
		26	+ @file.id
		27	+ end
		28	+
		29	+ def reload
		30	+ @file.reload
		31	+ self
		32	+ end
		33	+
25	# This method must be overridden in subclasses.	34	# This method must be overridden in subclasses.
26	#	35	#
27	# If the class accepts the file, return a number that represents the	36	# If the class accepts the file, return a number that represents the
	@@ -33,6 +42,10 @@ class FilePresenter		@@ -33,6 +42,10 @@ class FilePresenter
33	nil	42	nil
34	end	43	end
35		44
		45	+ def short_description
		46	+ _("File (%s)") % content_type
		47	+ end
		48	+
36	# Define the css classes to style the page fragment with the file related	49	# Define the css classes to style the page fragment with the file related
37	# content. If you want other classes to identify this area to your	50	# content. If you want other classes to identify this area to your
38	# customized presenter, so do this:	51	# customized presenter, so do this:
	@@ -88,3 +101,7 @@ class FilePresenter		@@ -88,3 +101,7 @@ class FilePresenter
88	end	101	end
89		102
90	end	103	end
		104	+
		105	+# Preload FilePresenters to allow `FilePresenter.for()` to work
		106	+FilePresenter::Generic
		107	+FilePresenter::Image
	@@ -7,4 +7,8 @@ class FilePresenter::Video < FilePresenter		@@ -7,4 +7,8 @@ class FilePresenter::Video < FilePresenter
7	return nil if f.content_type.nil?	7	return nil if f.content_type.nil?
8	( f.content_type[0..4] == 'video' ) ? 10 : nil	8	( f.content_type[0..4] == 'video' ) ? 10 : nil
9	end	9	end
		10	+
		11	+ def short_description
		12	+ _('Video (%s)') % content_type.split('/')[1].upcase
		13	+ end
10	end	14	end
@@ -0,0 +1,30 @@		@@ -0,0 +1,30 @@
	1	+require File.dirname(__FILE__) + '/../../../../test/test_helper'
	2	+require 'content_viewer_controller'
	3	+
	4	+class ContentViewerController
	5	+ # Re-raise errors caught by the controller.
	6	+ def rescue_action(e) raise e end
	7	+ append_view_path File.join(File.dirname(__FILE__) + '/../../views')
	8	+end
	9	+
	10	+class ContentViewerControllerTest < ActionController::TestCase
	11	+
	12	+ all_fixtures
	13	+
	14	+ def setup
	15	+ @controller = ContentViewerController.new
	16	+ @request = ActionController::TestRequest.new
	17	+ @response = ActionController::TestResponse.new
	18	+
	19	+ @profile = create_user('testinguser').person
	20	+ @environment = @profile.environment
	21	+ end
	22	+ attr_reader :profile, :environment
	23	+
	24	+ should 'add html5 video tag to the page of file type video' do
	25	+ file = UploadedFile.create!(:uploaded_data => fixture_file_upload('/files/test.txt', 'video/ogg'), :profile => profile)
	26	+ get :view_page, file.url.merge(:view=>:true)
	27	+ assert_select '#article video'
	28	+ end
	29	+
	30	+end
1	<video class="video-js vjs-default-skin" controls poster="video.jpg" preload="auto" data-setup="{}">	1	<video class="video-js vjs-default-skin" controls poster="video.jpg" preload="auto" data-setup="{}">
2	- <source type="video/ogg" src="<%= video.public_filename %>">	2	+ <source type="video/ogg" src="<%= video.public_filename %>"/>
3	</video>	3	</video>
4		4
5	<div class="uploaded-file-description <%= 'empty' if video.abstract.blank? %>">	5	<div class="uploaded-file-description <%= 'empty' if video.abstract.blank? %>">
	@@ -1502,4 +1502,12 @@ end		@@ -1502,4 +1502,12 @@ end
1502	assert_response 404	1502	assert_response 404
1503	end	1503	end
1504		1504
		1505	+ should 'display link to download of non-recognized file types on its page' do
		1506	+ file = UploadedFile.create!(:uploaded_data => fixture_file_upload('/files/test.txt', 'bin/unknown'), :profile => profile)
		1507	+ get :view_page, file.url.merge(:view=>:true)
		1508	+ assert_tag :tag => 'a',
		1509	+ :content => file.filename,
		1510	+ :attributes => { :href => file.public_filename }
		1511	+ end
		1512	+
1505	end	1513	end
	@@ -41,6 +41,7 @@ class CmsHelperTest < ActiveSupport::TestCase		@@ -41,6 +41,7 @@ class CmsHelperTest < ActiveSupport::TestCase
41	should 'display image and link if article is an image' do	41	should 'display image and link if article is an image' do
42	profile = fast_create(Profile)	42	profile = fast_create(Profile)
43	file = UploadedFile.create!(:profile => profile, :uploaded_data => fixture_file_upload('/files/rails.png', 'image/png'))	43	file = UploadedFile.create!(:profile => profile, :uploaded_data => fixture_file_upload('/files/rails.png', 'image/png'))
		44	+ file = FilePresenter.for file
44	icon = icon_for_article(file)	45	icon = icon_for_article(file)
45	expects(:image_tag).with(icon).returns('icon')	46	expects(:image_tag).with(icon).returns('icon')
46		47
@@ -0,0 +1,43 @@		@@ -0,0 +1,43 @@
	1	+require File.dirname(__FILE__) + '/../test_helper'
	2	+
	3	+class FilePresenterTest < ActiveSupport::TestCase
	4	+
	5	+ should 'notify about deprecated method UploadedFile.icon_name' do
	6	+ profile = fast_create(Profile)
	7	+ file = UploadedFile.create!(
	8	+ :profile => profile,
	9	+ :uploaded_data => fixture_file_upload('/files/rails.png', 'image/png')
	10	+ )
	11	+ assert_raise NoMethodError do
	12	+ UploadedFile.icon_name file
	13	+ end
	14	+ ENV.stubs('[]').with('RAILS_ENV').returns('other')
	15	+ Rails.logger.expects(:warn) # must warn on any other RAILS_ENV
	16	+ stubs(:puts)
	17	+ UploadedFile.icon_name file
	18	+ end
	19	+
	20	+ should 'notify about deprecated method UploadedFile#to_html' do
	21	+ profile = fast_create(Profile)
	22	+ file = UploadedFile.create!(
	23	+ :profile => profile,
	24	+ :uploaded_data => fixture_file_upload('/files/rails.png', 'image/png')
	25	+ )
	26	+ assert_raise NoMethodError do
	27	+ file.to_html
	28	+ end
	29	+ ENV.stubs('[]').with('RAILS_ENV').returns('other')
	30	+ Rails.logger.expects(:warn) # must warn on any other RAILS_ENV
	31	+ stubs(:puts)
	32	+ file.to_html
	33	+ end
	34	+
	35	+ should 'return a thumbnail as icon for images ' do
	36	+ f = UploadedFile.new
	37	+ f.stubs(:image?).returns(true)
	38	+ p = FilePresenter.for f
	39	+ p.expects(:public_filename).with(:icon).returns('/path/to/file.xyz')
	40	+ assert_equal '/path/to/file.xyz', p.icon_name
	41	+ end
	42	+
	43	+end
	@@ -26,6 +26,7 @@ class FolderHelperTest < ActiveSupport::TestCase		@@ -26,6 +26,7 @@ class FolderHelperTest < ActiveSupport::TestCase
26	should 'display icon for images' do	26	should 'display icon for images' do
27	profile = fast_create(Profile)	27	profile = fast_create(Profile)
28	file = UploadedFile.create!(:uploaded_data => fixture_file_upload('/files/rails.png', 'image/png'), :profile => profile)	28	file = UploadedFile.create!(:uploaded_data => fixture_file_upload('/files/rails.png', 'image/png'), :profile => profile)
		29	+ file = FilePresenter.for file
29	process_delayed_job_queue	30	process_delayed_job_queue
30		31
31	assert_match /rails_icon\.png/, icon_for_article(file.reload)	32	assert_match /rails_icon\.png/, icon_for_article(file.reload)