bcms_thumbnail 1.0.0

data/README

@@ -0,0 +1,67 @@
+== browser_cms thumbnail extension
+
+This extension adds a "thumbnail" view helper that takes a content_block with an attachment (an ImageBlock or a custom content_block) and creates a thumbnail according to the ImageMagick geometry you specify.
+
+* Supports png, jpg, gif, and bmp formats. Thumbnails are output in jpg format.
+* The default geometry is "100x100" - so no side larger than 100 pixels.  
+* It caches these thumbnails in the directory RAILS_ROOT/public/bcms_thumbnail_cache/. We'll create this directory automatically if needed.
+* Use the "bcms_thumbnail:clear" rake task to clear the thumbnail cache.
+* Thumbnails are public. They are served directly off the filesystem.
+
+== Examples
+
+It's pretty simple. The code below demonstrates creating a thumbnail from an image block, which (naturally) has a browser_cms attachment. This code overrides the default 100x100 geometry and creates images of no larger than 125 pixels on any side. 
+
+Add a dynamic portlet and the add this to the template:
+  <% image = ImageBlock.find(:first) %>
+  <%= image_tag(thumbnail(image,'125x125')) %>
+
+A stupidly simple image gallery? It's easier than you think! Again, in a dynamic portlet:
+
+ <div class="gallery">
+   <% ImageBlock.find(:all).each do |image| %>
+     <div class="image"><%= link_to(image_tag(thumbnail(image,'100x100'), :alt => image.name),image.attachment.file_path) %></div>
+   <% end %>
+ </div>
+
+The above, but only for images with a certain tag? Oh, hell yes:
+
+ <div class="gallery">
+   <% Tag.find_by_name('lol').taggings.find(:all, :conditions => ['taggable_type = ?', 'AbstractFileBlock']).collect{|img| img.taggable}.each do |image| %>
+     <div class="image"><%= link_to(image_tag(thumbnail(image,'100x100'), :alt => image.name),image.attachment.file_path) %></div>
+   <% end %>
+ </div>
+
+Note: The code above is yucky. But cool.
+
+== Example geometries
+
+ImageMagick will preserve aspect ratio with all the geometries below: 
+
+* "125" will ensure the width is no more than 125px.
+* "x125" will ensure the height is no more than 125px.
+* "125x125" will ensure neither side is more than 125px.
+* "50%" will scale the image to half its size.
+
+More info on ImageMagick geometry here: http://www.imagemagick.org/www/command-line-processing.html#geometry
+
+== Todo
+
+* Decache thumbnails when image attachments change via a monkey-patch on the bcms core attachment features.
+* Hook image de-caching into the page de-caching control built into the bcms backend.
+* Beef up the thumbnail helper to expose more mini_magick features.
+* Better error reporting and sanity checking. 
+
+== Requires
+
+* The mini_magick gem, version >= 1.2.5
+* ImageMagick, to satisfy the above.
+
+== Author
+
+Dan Collis-Puro, http://collispuro.com, http://github.com/djcp/
+
+== License
+
+This extension is licensed under the Gnu LGPL: http://www.gnu.org/licenses/lgpl.html
+

data/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/lib/bcms_thumbnail/bcms_thumbnail.rb

@@ -0,0 +1,27 @@
+require 'mini_magick'
+require 'uri'
+module ActionView
+  module Helpers
+    module_function
+
+    def thumbnail(attachment_obj,geometry = '100x100')
+      if ! attachment_obj.blank? && attachment_obj.respond_to?('attachment') && ['jpg','png','gif','bmp'].include?(attachment_obj.attachment.file_extension.downcase)
+        thumbnail_location = "/bcms_thumbnail_cache/#{attachment_obj.attachment.file_location.gsub(/[\\\/]/,'-')}-#{geometry}.jpg"
+        if ! File.exists?("#{RAILS_ROOT}/public#{thumbnail_location}")
+          if ! File.exists?("#{RAILS_ROOT}/public/bcms_thumbnail_cache/")
+            FileUtils.mkdir_p("#{RAILS_ROOT}/public/bcms_thumbnail_cache/")
+          end
+          image = MiniMagick::Image.from_file("#{RAILS_ROOT}/tmp/uploads/#{attachment_obj.attachment.file_location}")
+          image.resize geometry
+          image.write("#{RAILS_ROOT}/public#{thumbnail_location}")
+          URI::escape(thumbnail_location)
+        else
+          URI::escape(thumbnail_location)
+        end
+      else
+        logger.warn("bcms_thumbnail: Either the attachment object doesn't accept attachments, you passed us a blank object, or the attachment type can't be thumbnailed.")
+        '/image-not-found'
+      end
+    end
+  end
+end

data/lib/bcms_thumbnail/routes.rb

@@ -0,0 +1,7 @@
+module Cms::Routes
+  def routes_for_bcms_thumbnail
+    namespace(:cms) do |cms|
+      #nothing, just here to make the default install process happy.
+    end  
+  end
+end

data/lib/bcms_thumbnail.rb

@@ -0,0 +1,2 @@
+require 'bcms_thumbnail/routes'
+require 'bcms_thumbnail/bcms_thumbnail'

data/lib/tasks/bcms_thumbnail.rake

@@ -0,0 +1,7 @@
+namespace :bcms_thumbnail do
+  desc 'Clear cached thumbnails'
+  task(:clear => :environment) do
+    FileUtils.rm_rf("#{RAILS_ROOT}/public/bcms_thumbnail_cache/")
+    puts 'Thumbnail cache cleared. You should clear the page cache now as well, to ensure the thumbnails are regenerated properly'
+  end
+end

data/public/bcms/thumbnail/README

@@ -0,0 +1 @@
+Use this directory to add public files that should copied from the gem into the project.

data/rails/init.rb

@@ -0,0 +1,5 @@
+gem_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Cms.add_to_rails_paths gem_root
+Cms.add_generator_paths gem_root, "db/migrate/[0-9]*_*.rb"
+Cms.add_generator_paths gem_root, "public/bcms/thumbnail/**/*"
+Cms.add_generator_paths gem_root, "lib/tasks/*.rake"

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: bcms_thumbnail
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Dan Collis-Puro
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mini_magick
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 5
+        version: 1.2.5
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: dan@collispuro.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- app/helpers/application_helper.rb
+- app/controllers/application_controller.rb
+- lib/bcms_thumbnail.rb
+- lib/bcms_thumbnail/routes.rb
+- lib/bcms_thumbnail/bcms_thumbnail.rb
+- rails/init.rb
+- lib/tasks/bcms_thumbnail.rake
+- public/bcms/thumbnail/README
+- README
+has_rdoc: true
+homepage: http://collispuro.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: bcms_thumbnail
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A thumbnailing view helper module for BrowserCMS
+test_files: []
+