papermill 1.1.6 → 1.2.0

data/README.rdoc

@@ -18,7 +18,7 @@
 
 * Formtastic          # use :as => :[image|asset](s)_upload
 * JGrowl              # for notifications (included)
-* FaceBox/Shadowbox   # for popups (included)
+* FaceBox             # for popups (included)
 * Stringex            # (or any String#to_url) for asset filename/url generation
 
 === Navigator minimal requirements: 
@@ -183,7 +183,7 @@ Create the option file config/initializers/papermill.rb
 
 === Translations:
 
-Papermill is fully I18n-able.
+Papermill is fully I18n-able, except for javascript error messages. (coming)
 Copy config/locales/papermill.yml to your root config/locale folder to modify any wording in a any locale.
   
 Copyright (c) 2009 Benoit Bénézech, released under the MIT license

data/TODO.txt

@@ -1,4 +1,5 @@
 Edit views :
 * use Jcrop
 * try Picnic API
-* trad errors
+* trad errors
+* migration with/whithout url_key

data/VERSION

@@ -1 +1 @@
-1.1.6
+1.2.0

data/app/controllers/papermill_controller.rb

@@ -1,12 +1,12 @@
 class PapermillController < ApplicationController
-  prepend_before_filter :load_asset, :only => [ "show", "destroy", "update", "edit", "crop" ]
-  prepend_before_filter :load_assets, :only => [ "sort", "mass_delete", "mass_edit" ]
+  prepend_before_filter :load_asset,  :only => [ "show", "destroy", "update", "edit", "crop" ]
+  prepend_before_filter :load_assets, :only => [ "sort", "mass_delete", "mass_edit", "mass_thumbnail_reset" ]
   
   def show
-    if @asset.create_thumb_file(params[:style])
+    if @asset.has_valid_url_key?(params[:url_key], params[:style]) && @asset.create_thumb_file(params[:style])
       redirect_to @asset.url(params[:style])
     else
-      render :nothing => true, :status => 500
+      render :nothing => true, :status => 404
     end
   end
 
@@ -29,6 +29,10 @@ class PapermillController < ApplicationController
   end
   
   def update
+    if params[:target]
+      @asset.create_thumb_file(params[:target], params[:papermill_asset].merge({ :geometry => "original#" }))
+    end
+    
     render :update do |page|
       if @asset.update_attributes(params[:papermill_asset])
         page << %{ notify("#{@asset.name}", "#{ escape_javascript t("papermill.updated", :resource => @asset.name)}", "notice"); close_popup(self);  }
@@ -67,6 +71,13 @@ class PapermillController < ApplicationController
     end
   end
   
+  def mass_thumbnail_reset
+    @assets.each &:destroy_thumbnails
+    render :update do |page|
+      page << %{ notify("", "#{ escape_javascript  t("papermill.updated", :resource => @assets.map(&:name).to_sentence)  }", "notice"); } unless @assets.blank? 
+    end
+  end
+  
   private
   def load_asset
     @asset = PapermillAsset.find(params[:id] || (params[:id0] + params[:id1] + params[:id2]).to_i)

data/app/views/papermill/_form.html.erb

@@ -2,7 +2,7 @@
   <input type="hidden" value="put" name="_method"/>
   <div id="error" style="display:none;"></div>
   <% fields_for :papermill_asset, @asset do |form| %>
-    <% @asset.assetable_papermill_options[:editable_fields].each do |field| %>
+    <% @asset.papermill_options[:editable_fields].each do |field| %>
     <% key = field.keys.first %>
       <p>
         <%= form.label key, field[key][:label] || t("papermill.#{key}") %><br />

data/app/views/papermill/crop.html.erb

@@ -1,6 +1,5 @@
 <%= image_tag(@asset.url, :id => "cropbox") %>
 
-<!--
 <form onsubmit="jQuery.ajax({data:jQuery.param(jQuery(this).serializeArray()), dataType:'script', type:'post', url:'/papermill/<%= @asset.id %>'}); return false;" method="post">
   <input type="hidden" value="put" name="_method"/>
   <input type="hidden" value="<%= params[:target] %>" name="target"/>
@@ -8,14 +7,14 @@
     <% for attribute in [:crop_x, :crop_y, :crop_w, :crop_h] %>
       <%= f.hidden_field attribute, :id => attribute %>
     <% end %>
-    <%= submit_tag t('papermill.save') %>
+    <%= submit_tag I18n.t('papermill.save') %>
   <% end -%>
 </form>
--->
+
 <div style="margin:6px"></div>
 <%= link_to_function I18n.t("papermill.back"), "popup('#{edit_papermill_path(@asset)}')" %>
 
-<script type="text/javascript" charset="utf-8">/*
+<script type="text/javascript" charset="utf-8">
   jQuery(function() {
     jQuery('#cropbox').Jcrop({
       onChange: update_crop,
@@ -30,5 +29,5 @@
     jQuery("#crop_y").val(coords.y);
     jQuery("#crop_w").val(coords.w);
     jQuery("#crop_h").val(coords.h);
-  }*/
+  }
 </script>

data/app/views/papermill/edit.html.erb

@@ -1,8 +1,8 @@
 <div id="papermill-box">
   <div id="left">
     <% if @asset.image? %>
-      <%= link_to image_tag(@asset.url("400x400>")), @asset.url, :popup => true %>
-      <%# image_tag(@asset.url("400x400>"), :onDblClick => "popup('#{crop_papermill_path(@asset, :target => "original")}'); return false;", :title => I18n.t("papermill.thumbnail-edit-title", :resource => @asset.name)) %>
+      <%# link_to image_tag(@asset.url("400x400>")), @asset.url, :popup => true %>
+      <%= image_tag(@asset.url("400x400>"), :onDblClick => "popup('#{crop_papermill_path(@asset, :target => "original")}'); return false;", :title => I18n.t("papermill.thumbnail-edit-title", :resource => @asset.name)) %>
       <div style="clear:both;"></div>
     <% else %>
       <%= link_to t("file_type", :type => @asset.content_type, :scope => 'papermill'), @asset.url, :popup => true %>
@@ -15,8 +15,8 @@
         <tr><td class="left-cell"><%= t("papermill.content_type") %></td><td><%= @asset.content_type %></td></tr>
         <tr><td class="left-cell"><%= t("papermill.size") %>        </td><td><%= number_to_human_size(@asset.size.to_i) %></td></tr>
         <% if @asset.image? %>
-          <tr><td class="left-cell"><%= t("papermill.width") %>       </td><td><%= @asset.width.to_i %>px</td></tr>
-          <tr><td class="left-cell"><%= t("papermill.height") %>      </td><td><%= @asset.height.to_i %>px</td></tr>
+          <tr><td class="left-cell"><%= t("papermill.width") %>     </td><td><%= @asset.width.to_i %>px</td></tr>
+          <tr><td class="left-cell"><%= t("papermill.height") %>    </td><td><%= @asset.height.to_i %>px</td></tr>
         <% end %>
         <tr><td class="left-cell"><%= t("papermill.created_at") %>  </td><td><%= I18n.l(@asset.created_at) %></td></tr>
         <tr><td class="left-cell"><%= t("papermill.updated_at") %>  </td><td><%= I18n.l(@asset.updated_at) %></td></tr>
@@ -29,7 +29,6 @@
   
   <div style="clear:both;"></div>
   <p id="footer">
-    <%= t("papermill.location") +  @asset.file.path %><br />
-    <%= t("papermill.url") +  @asset.url %>
+    <%= t("papermill.url") + link_to(@asset.url, @asset.url, :popup => true) %>
   </p>
 </div>

data/config/locales/papermill.yml

@@ -2,7 +2,7 @@ en:
   papermill: 
     not-processed: "Error/resource not processed"
     updated: "'{{resource}}' updated"
-    not-found: "Asset #{{resource}} not found"
+    not-found: "'#{{resource}}' not found"
     edit-title: "Click to edit '{{resource}}'"
     thumbnail-edit-title: "Double-click to edit '{{resource}}'"
     upload-button-wording: "Upload..."
@@ -25,16 +25,17 @@ en:
     height: "Height"
     save: "Save"
     back: "Back"
-    location: "File : "
     url: "URL : "
     modify-all: "Modify all: "
     delete-all: "Delete all"
     delete-all-confirmation: "Are you sure?"
+    mass-thumbnail-reset: "Delete all thumbnails"
+    mass-thumbnail-reset-confirmation: "Are you sure?"
 fr:
   papermill:
     not-processed: "Erreur/resource non trouvée"
-    updated: "{{resource}} modifiés(s)"
-    not-found: "Asset #{{resource}} non trouvé"
+    updated: "'{{resource}}' modifiés(s)"
+    not-found: "'{{resource}}' non trouvé"
     edit-title: "Cliquer pour éditer '{{resource}}'"
     thumbnail-edit-title: "Double-cliquer pour éditer '{{resource}}'"
     upload-button-wording: "Charger.."
@@ -57,8 +58,9 @@ fr:
     height: "Hauteur"
     save: "Modifier"
     back: "Retour"
-    location: "Fichier : "
     url: "Lien : "
     modify-all: "Modifier tout : "
     delete-all: "Supprimer tout"
     delete-all-confirmation: "Êtes-vous sûr ?"
+    mass-thumbnail-reset: "Supprimer tous les thumbnails"
+    mass-thumbnail-reset-confirmation: "Êtes-vous sûr ?"

data/config/routes.rb

@@ -1,4 +1,4 @@
 ActionController::Routing::Routes.draw do |map|
-  map.resources :papermill, :collection => { :sort => :post, :mass_edit => :post, :mass_delete => :post }, :member => { :crop => :get }
-  map.connect "#{Papermill::options[:papermill_prefix]}/#{Papermill::PAPERCLIP_INTERPOLATION_STRING.gsub(":id_partition", ":id0/:id1/:id2")}", :controller => "papermill", :action => "show"
+  map.resources :papermill, :collection => { :sort => :post, :mass_edit => :post, :mass_delete => :post, :mass_thumbnail_reset => :post }, :member => { :crop => :get }
+  map.connect "#{Papermill::options[:papermill_url_prefix]}/#{Papermill::compute_paperclip_path.gsub(":id_partition", ":id0/:id1/:id2")}", :controller => "papermill", :action => "show", :requirements => { :style => /.*/ }
 end

data/lib/{extensions.rb → papermill/extensions.rb}

@@ -55,4 +55,4 @@ module StringToUrlNotFound
   def to_url
     gsub(/[^a-zA-Z0-9]/, "-").gsub(/-+/, "-").gsub(/^-|-$/, "").downcase
   end
-end
+end

data/lib/papermill/form_builder.rb

@@ -45,7 +45,7 @@ module ActionView::Helpers::FormTagHelper
     assetable = options[:assetable] || @template.instance_variable_get("@#{@object_name}")
     assetable_id = assetable && (assetable.id || assetable.timestamp) || nil
     assetable_type = assetable && assetable.class.base_class.name || nil
-    options = PapermillAsset.assetable_papermill_options(assetable && assetable.class.name, key).deep_merge(options)
+    options = PapermillAsset.papermill_options(assetable && assetable.class.name, key).deep_merge(options)
     dom_id = "papermill_#{assetable_type}_#{assetable_id}_#{key}"
     
     if ot = options[:thumbnail]
@@ -71,6 +71,7 @@ module ActionView::Helpers::FormTagHelper
                 %{<option value="#{field.to_s}">#{I18n.t("papermill.#{field.to_s}", :default => field.to_s)}</option>}
               end.join("\n")}</select>}
       html[:dashboard][:mass_delete] = %{<a onclick="Papermill.mass_delete('#{dom_id}', '#{@template.escape_javascript I18n.t("papermill.delete-all-confirmation")}'); return false;" style="cursor:pointer">#{I18n.t("papermill.delete-all")}</a>}
+      html[:dashboard][:mass_thumbnail_reset] = %{<a onclick="Papermill.mass_thumbnail_reset('#{dom_id}', '#{@template.escape_javascript I18n.t("papermill.mass-thumbnail-reset-confirmation")}'); return false;" style="cursor:pointer">#{I18n.t("papermill.mass-thumbnail-reset")}</a>}
       html[:dashboard] = @template.content_tag(:ul, options[:dashboard].map{|action| @template.content_tag(:li, html[:dashboard][action], :class => action.to_s) }.join("\n"), :class => "dashboard")
     end
     
@@ -131,7 +132,7 @@ module ActionView::Helpers::FormTagHelper
           upload_success_handler: Papermill.upload_success,
           upload_complete_handler: Papermill.upload_complete,
           button_placeholder_id: "browse_for_#{dom_id}",
-          #{ options[:swfupload].map { |key, value| "#{key}: #{(value.is_a?(String) ? "\"#{@template.escape_javascript(value)}\"" : @template.escape_javascript(value.to_s))}" if value }.compact.join(",\n") }
+          #{ options[:swfupload].map { |key, value| "#{key}: #{value}" if value }.compact.join(",\n") }
         });
       }
     end

data/lib/papermill/papermill.rb

@@ -1,5 +1,4 @@
 module Papermill
-  PAPERCLIP_INTERPOLATION_STRING = ":id_partition/:style/:basename.:extension"
   
   def self.included(base)
     base.extend(ClassMethods)
@@ -9,6 +8,14 @@ module Papermill
     @options ||= BASE_OPTIONS.deep_merge(defined?(OPTIONS) ? OPTIONS : {})
   end
   
+  def self.compute_paperclip_path
+    path = []
+    path << (options[:use_id_partition] ? ":id_partition" : ":id")
+    path << (":url_key" if options[:use_url_key])
+    path << ":style"
+    path << ":basename.:extension"
+    path.compact.join("/")
+  end
 
   module ClassMethods
     attr_reader :papermill_associations
@@ -36,8 +43,8 @@ module Papermill
           scope
         end
       end
-      ActionController::Dispatcher.middleware.delete(FlashSessionCookieMiddleware) rescue nil
-      ActionController::Dispatcher.middleware.insert_before(ActionController::Base.session_store, FlashSessionCookieMiddleware, ActionController::Base.session_options[:key]) rescue nil
+      ActionController::Dispatcher.middleware.delete(FlashSessionCookieMiddleware) rescue true
+      ActionController::Dispatcher.middleware.insert_before(ActionController::Base.session_store, FlashSessionCookieMiddleware, ActionController::Base.session_options[:key]) rescue true
     end
     
     def inherited(subclass)

data/lib/papermill/papermill_asset.rb

@@ -5,8 +5,8 @@ class PapermillAsset < ActiveRecord::Base
   
   has_attached_file :file, 
     :processors => [:papermill_paperclip_processor],
-    :path => "#{Papermill::options[:public_root]}/#{Papermill::options[:papermill_prefix]}/#{Papermill::PAPERCLIP_INTERPOLATION_STRING}",
-    :url => "/#{Papermill::options[:papermill_prefix]}/#{Papermill::PAPERCLIP_INTERPOLATION_STRING}"
+    :url => "/#{Papermill::options[:papermill_url_prefix]}/#{Papermill::compute_paperclip_path.gsub(':style', ':escaped_style')}",
+    :path => "#{Papermill::options[:public_root]}/#{Papermill::options[:papermill_path_prefix]}/#{Papermill::compute_paperclip_path}"
   
   before_post_process :set_file_name
   
@@ -17,6 +17,14 @@ class PapermillAsset < ActiveRecord::Base
   
   named_scope :key, lambda { |assetable_key| { :conditions => ['assetable_key = ?', assetable_key.to_s] }}
   
+  Paperclip.interpolates :url_key do |attachment, style|
+    attachment.instance.compute_url_key((style || "original").to_s)
+  end
+
+  Paperclip.interpolates :escaped_style do |attachment, style|
+    CGI::escape((style || "original").to_s)
+  end
+  
   attr_accessor :crop_h, :crop_w, :crop_x, :crop_y
   
   def Filedata=(data)
@@ -27,12 +35,7 @@ class PapermillAsset < ActiveRecord::Base
   def Filename=(name)
     @real_file_name = name
   end
-  
-  def create_thumb_file(style_name)
-    FileUtils.mkdir_p File.dirname(file.path(style_name))
-    FileUtils.mv(Paperclip::PapermillPaperclipProcessor.make(file, self.class.compute_style(style_name)).path, file.path(style_name))
-  end
-  
+    
   def id_partition
     ("%09d" % self.id).scan(/\d{3}/).join("/")
   end
@@ -50,11 +53,11 @@ class PapermillAsset < ActiveRecord::Base
   end
   
   def width
-    Paperclip::Geometry.from_file(file).width
+    @width ||= Paperclip::Geometry.from_file(file).width
   end
   
   def height
-    Paperclip::Geometry.from_file(file).height
+    @height ||= Paperclip::Geometry.from_file(file).height
   end
   
   def size
@@ -62,18 +65,34 @@ class PapermillAsset < ActiveRecord::Base
   end
 
   def url(style = nil)
-    file.url(style && CGI::escape(style.to_s))
+    return url!(style) if style.is_a?(Hash)
+    file.url(style)
   end
   
   def path(style = nil)
+    return path!(style) if style.is_a?(Hash)
     file.path(style)
   end
   
+  def url!(style = nil)
+    create_thumb_file(style_name = style_name(style), style) unless File.exists?(self.path(style_name))
+    file.url(style_name)
+  end
+
+  def path!(style = nil)
+    create_thumb_file(style_name = style_name(style), style) unless File.exists?(self.path(style_name))
+    file.path(style_name)
+  end
+  
   def content_type
     file_content_type
   end
   
-  def self.assetable_papermill_options(assetable_class, assetable_key)
+  def style_name(style)
+    style.is_a?(Hash) ? (style[:name] || style.hash).to_s : (style || "original").to_s
+  end
+  
+  def self.papermill_options(assetable_class, assetable_key)
     if assetable_class
       assoc = assetable_class.constantize.papermill_associations
       assoc[assetable_key.try(:to_sym)] || assoc[Papermill::options[:base_association_name]]
@@ -82,19 +101,50 @@ class PapermillAsset < ActiveRecord::Base
     end
   end
   
-  def assetable_papermill_options
-    self.class.assetable_papermill_options(assetable_type, assetable_key)
+  def papermill_options
+    self.class.papermill_options(assetable_type, assetable_key)
   end
   
   def image?
     content_type.split("/")[0] == "image"
   end
   
-  def self.cleanup
+  def create_thumb_file(style_name, style = nil)
+    destroy_thumbnails if style_name.to_s == "original"
+    style = self.class.compute_style(style_name) unless style.is_a?(Hash)
+    FileUtils.mkdir_p File.dirname(file.path(style_name))
+    FileUtils.mv(Paperclip::PapermillPaperclipProcessor.make(file, style).path, file.path(style_name))
+  end
+  
+  def destroy_thumbnails
+    thumbnail_folder_mask = Papermill::options[:use_url_key] ? "*/*/" : "*/"
+    original_folder = "#{File.dirname(file.path)}/"
+    Dir.glob("#{root_directory}/#{thumbnail_folder_mask}").each do |f| 
+      FileUtils.rm_r(f) unless f == original_folder
+    end
+    Dir.glob("#{root_directory}/*/").each do |f|
+      FileUtils.rm_r(f) if Dir.entries(f) == [".", ".."]
+    end
+  end
+  
+  def self.destroy_orphans
     self.all(:conditions => ["id < 0 AND created_at < ?", DateTime.now.yesterday]).each &:destroy
   end
   
+  def compute_url_key(style)
+    Papermill::options[:url_key_generator].call(style, self)
+  end
+  
+  def has_valid_url_key?(key, style)
+    !Papermill::options[:use_url_key] || compute_url_key(style) == key
+  end
+  
   private
+    
+  def root_directory
+    deepness_to_root = Papermill::options[:use_url_key] ? -3 : -2
+    @root_directory ||= File.dirname(path).split('/')[0..deepness_to_root].join('/')
+  end
   
   def set_file_name
     return if @real_file_name.blank?
@@ -107,7 +157,7 @@ class PapermillAsset < ActiveRecord::Base
   end
   
   def destroy_files
-    FileUtils.rm_r(File.dirname(path).chomp("original")) rescue true
+    FileUtils.rm_r(root_directory) rescue true
   end
   
   def self.compute_style(style)

data/lib/papermill/papermill_initializer.rb

@@ -1,39 +1,29 @@
-# DO NOT MOVE OR RENAME THIS FILE. 
-# It must stand in your RAILS_ROOT/config/initializer folder and be named papermill.rb, because it is explicitely early-loaded by Papermill.
+# DO NOT MOVE OR RENAME THIS FILE
+# It must stand in your RAILS_ROOT/config/initializer folder and be named papermill.rb, because it is explicitely early-loaded by Papermill
+
 module Papermill
 
-  # All the options here already are papermill defaults. You can set them : 
-  #
-  # * here
-  #
-  # * in your association. Ex :
-  #   class Article < ActiveRecord::Base
-  #     papermill :diaporama, {
-  #       :class_name => "MyAssetClass",
-  #       :inline_css => false,
-  #       :thumbnail => {:width => 150},
-  #       ...
-  #     }
-  #   end
-  #
-  # * in your form helper call. Ex : 
-  #   form.image_upload :diaporama, :class_name => "MyAssetClass", :thumbnail => {:width => 150}, :inline_css => false
-  #
-  #
-  # FormHelper options-hash merges with model papermill declaration option-hash, that merges with this Papermill::OPTIONS, that merge with Papermill::DEFAULT_OPTIONS hash.
-  # Don't freak-out, there's a 99% chance that it is exactly what you expect it to do.
-  # Merges are recursive (for :gallery, :thumbnail and :swfupload sub-hashs)
-  
+  # All options here already are defaults.
+    
   unless defined?(OPTIONS)
   
     OPTIONS = {
-      # Associated PapermillAsset subclass
+      
+      #@@@@@@@@@@@@@@@@@@@ papermill association parameters @@@@@@@@@@@@@@@@@@@@@@@
+      
+      # You can override these parameters here, or in your papermill associations definition.
+      
+      # Associated PapermillAsset subclass (must be STI subclass of PapermillAsset)
       # :class_name => "PapermillAsset",
-    
-      # Helper will generates some inline css styling. You can use it to scaffold, then copy the lines you need in your application css and set it to false.
+      
+      #@@@@@@@@@@@@@@@@@@@ form-helper parameters @@@@@@@@@@@@@@@@@@@@@@@
+      
+      # You can override all these parameters here, or in your papermill associations definition, or in form-helper calls.
+      
+      # Helper can generates inline css styling that adapt to your gallery/images placeholder. You can use it to scaffold, then copy the lines you need in your application css and set it to false.
       # :inline_css => true,
     
-      # SwfUpload will only let the user upload images.
+      # SwfUpload will only let the user upload images. 
       # :images_only => false,
     
       # Dashboard is only for galleries
@@ -43,12 +33,13 @@ module Papermill
     
       # Dashboard elements
       # You can remove/change order of HTML elements.
-      # :dashboard => [:mass_edit, :mass_delete],
+      # :dashboard => [:mass_edit, :mass_thumbnail_reset, :mass_delete ],
     
       # Attributes editable at once for all assets in a gallery
       # :mass_editable_fields => ["title", "copyright", "description"],
       
-      # Attributes you can edit in the form. You can use :type and :label
+      # Attributes you can edit in the form. You can use :type (string or text) and :label (any string)
+      # if you have more complex needs, you should override app/views/papermill/_form.html.erb in your application.
       # :editable_fields => [
       #   {:title =>       {:type => "string"}}, 
       #   {:alt =>         {:type => "string"}}, 
@@ -61,19 +52,19 @@ module Papermill
       # Great for quick admin scaffolding.
     
       :gallery => { 
-        # override calculated gallery width. Ex: "auto"
+      # override calculated gallery width. Ex: "auto"
       #  :width => nil,
-        # override calculated gallery height
+      # override calculated gallery height
       #  :height => nil,
-        # Number of columns and lines in a gallery
+      # Number of columns and lines in a gallery
       #  :columns => 8,
       #  :lines => 2,
-        # vertical/horizontal padding/margin around each thumbnails
+      # vertical/horizontal padding/margin around each thumbnails
       #  :vpadding => 0,
       #  :hpadding => 0,
       #  :vmargin => 1,
       #  :hmargin => 1,
-        # border around thumbnails
+      # border around thumbnails
       #  :border_thickness => 2
       },
     
@@ -93,40 +84,101 @@ module Papermill
       # To remove an option when overriding, set it to nil.
     
       :swfupload => { 
-      #  :flash_url => '/papermill/swfupload.swf',
-      #  :button_image_url => '/papermill/images/upload-blank.png',
+      #  :flash_url => "'/papermill/swfupload.swf'",
+      #  :button_image_url => "'/papermill/images/upload-blank.png'",
       #  :button_width     => 61,
       #  :button_height    => 22,
-      #  :button_text => %{<span class="button-text">#{I18n.t("papermill.upload-button-wording")}</span>},
-      #	 :button_text_style => %{.button-text { font-size: 12pt; font-weight: bold; }},
+      #  :button_text => %{'<span class="button-text">#{I18n.t("papermill.upload-button-wording")}</span>'},
+      #	 :button_text_style => %{'.button-text { font-size: 12pt; font-weight: bold; }'},
       #  :button_text_top_padding => 4,
       #	 :button_text_left_padding => 4,
       #	 :debug => false,
       #  :prevent_swf_caching => true,
-      #  :file_size_limit => "10 MB"
+      #  :file_size_limit => "'10 MB'"
       },
     
-      # APPLICATION WIDE PARAMETERS
-      # Do not change these in your model declaration or form helper call.
+      #@@@@@@@@@@@@@@@@@@@ thumbnails style parameters @@@@@@@@@@@@@@@@@@@@@@@
+      
+      # You can override all these parameters here, or in your papermill associations definition, or in thumbnail styling hashes.
+      
+      # 1. COPYRIGHT WATERMARKING
+      
+      # Activate with '©' at the end of your geometry string or pass :copyright => "my_copyright" in alias definition
+      # Papermill will use, in that order of priority : 
+      #  * copyright found in geometry string AFTER the @ 
+      #  * alternatively :copyright in alias/inline definition hash
+      #  * asset's copyright column (if found)
+      #  * associated :copyright definition in your Assetable association definition
+      #  * below :copyright definition
+      
+      # Set this definition to nil if you don't want a global copyright string (likely)
+      #  :copyright => "Example Copyright",
+      
+      # Textilize, truncate, transform... your copyright before integration
+      #  :copyright_text_transform => Proc.new {|c| c },
+      
+      # Watermark ImageMagick command string.
+      #  * %s gets interpolated with above transformed copyright string
+      #  * DO NOT change the background color!, change the bordercolor instead. (because background color adds to bordercolor I set it to totally transparent)
+      #  * for both fill (=foreground color) and bordercolor (=background color), the last two octals control alpha (transparency). FF is opaque, 00 is transparent.
+      #  * remove -bordercolor if you don't want any background
+      #  * +antialias to REMOVE antialiasing
+      #  * font-size is pointsize
+      #  * type 'identify -list font' to get a list of the fonts you can use (ImageMagick will default to Arial/Times if it can't find it) 
+      #  * use -gravity and -geometry for positionning, -geometry +x+y is relative to -gravity's corner/zone
+      #  * parenthesis are there to isolate the label creation from the compositing (blending) part.
+      #  * don't touch things you don't understand, you'll save yourself some time
+      
+      #  :copyright_im_command => %{ \\( -font Arial-Bold -pointsize 9 -fill '#FFFFFFE0' -border 3 -bordercolor '#50550080' -background '#00000000' label:' %s ' \\) -gravity South-West -geometry +0+0 -composite },
+      
+      # 2. IMAGE WATERMARKING
+      
+      # Activate with "-wm" at the end of your geometry string BEFORE copyright ('©'), or alternatively with :watermark => <image_path|true> in your alias/inline hash
+      # If you pass an image_path to :watermark, it will override below :
+      
+      # you can use a relative path from your public directory (see :public_root), a complete path, or an URI
+      #  :watermark => "/images/rails.png",
+      
+      # default :watermarking command for image_magick.  %s gets interpolated with above image path.
+      #  :watermark_im_command => %{- | composite \\( %s -resize 100% \\) - -dissolve 20% -gravity center -geometry +0+0 },
+      
+      #@@@@@@@@@@@@@@@@@@@@ Application-wide parameters @@@@@@@@@@@@@@@@@@@@@@@@@
     
       # Default named_scope name for catch-all :papermill declaration
-      # :base_association_name => :assets,
+      #  :base_association_name => :assets,
     
       # Set to true to require aliases in all url/path
       # Don't forget to give an alias value to options[:thumbnail][:style] if true!
-      # :alias_only => false,
+      #  :alias_only => false,
     
       # Needed if :alias_only
       :aliases => {
-        # 'example' => "100x100#",
-        # 'example2' => {:geometry => "100x100#"}
+      #  :mini_crop => "100x100#",
+      #  :cant_touch_this => {
+      #    :geometry => "400x>",
+      #    :copyright => "You sire, can't touch this",
+      #    :watermark => "http://westsidewill.com/newblog/wp-content/uploads/2009/09/MC-Hammer.jpg"
+      #  }
       },
-    
-      # path to the root of your public directory (from NGINX/Apache pov)
-      # :public_root => ":rails_root/public",
+      
+      # To prevent generation of thumbnails and guessing of assets location through URL hacking
+      #  e.g. if you want to protect access to non-copyrighted original files, 
+      #  or don't want users to browse images by guessing the sequence of ids,
+      #  an encrypted hash can be generated for each geometry string/alias and added to path/url.
+      # Please note that all previous assets paths will be lost if you add/remove or change the :url_key generation.
+      #  :use_url_key => false,
+      #  :url_key_salt => "change-me-to-your-favorite-pet-name",
+      #  :url_key_generator => Proc.new { |style, asset| Digest::SHA512.hexdigest("#{style}#{asset.id}#{Papermill::options[:url_key_salt]}")[0..10] },
 
-      # added to :public_root as the root folder for all papermill assets
-      # :papermill_prefix => "system/papermill"
+      # added to :public_root as the root folder for all papermill assets (system is a default for static assets with capistrano)
+      #  :papermill_url_prefix => "system/papermill",
+      #  :papermill_path_prefix => ":rails_root/public/system/papermill",
+      
+      # you can set it to false if you don't plan to have too many assets. (dangerous)
+      #  :use_id_partition => true,
+      
+      # If you use those defaults, the first asset will end-up in RAILS_ROOT/public/system/papermill/000/000/001/original/my_first_asset_name.ext
+      # You'll access it with my_domain.com/system/papermill/000/000/001/original/my_first_asset_name.ext
     }
   end
 end

data/lib/papermill/papermill_options.rb

@@ -2,8 +2,9 @@ module Papermill
   BASE_OPTIONS = {
     :class_name => "PapermillAsset",
     :inline_css => true,
+    :images_only => false,
     :form_helper_elements => [:upload_button, :container, :dashboard],
-    :dashboard => [:mass_edit, :mass_delete],
+    :dashboard => [:mass_edit, :mass_thumbnail_reset, :mass_delete],
     :mass_editable_fields => ["title", "copyright", "description"],
     :editable_fields => [
       {:title =>       {:type => "string"}}, 
@@ -29,23 +30,31 @@ module Papermill
       :style => nil
     },
     :swfupload => { 
-      :flash_url => '/papermill/swfupload.swf',
-      :button_image_url => '/papermill/images/upload-blank.png',
+      :flash_url => "'/papermill/swfupload.swf'",
+      :button_image_url => "'/papermill/images/upload-blank.png'",
       :button_width     => 61,
       :button_height    => 22,
-      :button_text => %{<span class="button-text">#{I18n.t("papermill.upload-button-wording")}</span>},
-    	:button_text_style => %{.button-text { font-size: 12pt; font-weight: bold; }},
+      :button_text => %{'<span class="button-text">#{I18n.t("papermill.upload-button-wording")}</span>'},
+      :button_text_style => %{'.button-text { font-size: 12pt; font-weight: bold; }'},
       :button_text_top_padding => 4,
-    	:button_text_left_padding => 4,
-    	:debug => false,
-    	:prevent_swf_caching => true,
-      :file_size_limit => "10 MB"
+      :button_text_left_padding => 4,
+      :debug => false,
+      :prevent_swf_caching => true,
+      :file_size_limit => "'10 MB'"
     },
-    :images_only => false,
+    :copyright => "Example Copyright",
+    :copyright_text_transform => Proc.new {|c| c },
+    :copyright_im_command => %{\\( -font Arial-Bold -pointsize 9 -fill '#FFFFFFE0' -border 3 -bordercolor '#50550080' -background '#00000000' label:' %s ' \\) -gravity South-West -geometry +0+0 -composite},
+    :watermark => "/images/rails.png",
+    :watermark_im_command => %{- | composite \\( %s -resize 100% \\) - -dissolve 20% -gravity center -geometry +0+0 },
     :base_association_name => :assets,
     :alias_only => false,
     :aliases => {},
-    :public_root => ":rails_root/public",
-    :papermill_prefix => "system/papermill"
+    :use_url_key => false,
+    :url_key_salt => "change-me-please",
+    :url_key_generator => Proc.new { |style, asset| Digest::SHA512.hexdigest("#{style}#{asset.id}#{Papermill::options[:url_key_salt]}")[0..10] },
+    :use_id_partition => true,
+    :papermill_url_prefix => "system/papermill",
+    :papermill_path_prefix => ":rails_root/public/system/papermill",
   }
 end

data/lib/papermill/papermill_paperclip_processor.rb

@@ -3,33 +3,41 @@ module Paperclip
   # Handles thumbnailing images that are uploaded.
   class PapermillPaperclipProcessor < Thumbnail
     
-    attr_accessor :crop_h, :crop_w, :crop_x, :crop_y, :copyright
+    attr_accessor :crop_h, :crop_w, :crop_x, :crop_y, :copyright, :watermark_path
     
     def initialize(file, options = {}, attachment = nil)
       @crop_h, @crop_w, @crop_x, @crop_y = options[:crop_h], options[:crop_w], options[:crop_x], options[:crop_y]
       
-      if options[:geometry] =~ /©/
-        options[:geometry], *@copyright = options[:geometry].split("©")
-        @copyright = @copyright.join("©").nie || options[:copyright] || @attachment.instance.respond_to?(:copyright) && @attachment.instance.copyright
+      # copyright extraction
+      if options[:geometry] =~ /©/ || options[:copyright]
+        options[:geometry], *@copyright = options[:geometry].split("©", -1)
+        @copyright = options[:copyright] || @copyright.join("©").nie || file.instance.respond_to?(:copyright) && file.instance.copyright.nie || file.instance.papermill_options[:copyright].nie
+        @copyright = (options[:copyright_text_transform] || file.instance.papermill_options[:copyright_text_transform]).try(:call, @copyright) || @copyright if @copyright
       end
       
+      # watermark extraction
+      if options[:watermark] || options[:geometry] =~ /\-wm/
+        options[:geometry] = options[:geometry].chomp("-wm")
+        @watermark_path = options[:watermark].is_a?(String) && options[:watermark] || file.instance.papermill_options[:watermark]
+        @watermark_path = file.instance.papermill_options[:public_root].sub(":rails_root", RAILS_ROOT) + @watermark_path if @watermark_path.starts_with?("/")
+      end
+      
+      
       if options[:geometry] =~ /#.+/
-        
-        # <@target_geometry.width>x<@target_geometry.height>#<@crop_w>x<@crop_h>:<@crop_x>:<@crop_y>
-        # <@target_geometry.width>x<@target_geometry.height>#<@crop_w>x<@crop_h>
-        # <@target_geometry.width>x<@target_geometry.height>#<@crop_x>:<@crop_y>
+        # let's parse :
+        # <width>x<height>#<crop_w>x<crop_h>:<crop_x>:<crop_y>
+        # <width>x<height>#<crop_w>x<crop_h>
+        # <width>x<height>#<crop_x>:<crop_y>
         
         options[:geometry], manual_crop = options[:geometry].split("#")
-        
         crop_dimensions, @crop_x, @crop_y = manual_crop.split("+")
-              
+        
         if crop_dimensions =~ /x/
           @crop_w, @crop_h = crop_dimensions.split("x")
         else
           @crop_x, @crop_y = crop_dimensions, @crop_x
         end
-        
-        
+
         options[:geometry] = (options[:geometry].nie || "#{@crop_x}x#{@crop_y}") + "#"
         
         unless @crop_w && @crop_h
@@ -42,9 +50,15 @@ module Paperclip
     end
     
     def transformation_command
-      #puts "crop_command= #{crop_command ? super.sub(/ -crop \S+/, crop_command) : super}"
-      
-      crop_command ? super.sub(/ -crop \S+/, crop_command) : super
+      "#{(crop_command ? super.sub(/ -crop \S+/, crop_command) : super)} #{copyright_command} #{watermark_command}".sub(%{-resize "0x" }, "")
+    end
+    
+    def copyright_command
+      (options[:copyright_im_command] || @file.instance.papermill_options[:copyright_im_command]).gsub(/%s/, @copyright.gsub(/'/, %{'"'"'}).sub("-slash-", "/").sub("-backslash-", %{\\\\\\})) if @copyright
+    end
+    
+    def watermark_command
+      (options[:watermark_im_command] || @file.instance.papermill_options[:watermark_im_command]).gsub(/%s/, @watermark_path) if @watermark_path
     end
     
     def crop_command

data/lib/papermill.rb

@@ -1,5 +1,6 @@
+#require "digest/sha2"
 I18n.load_path = [File.join(File.dirname(__FILE__), "../config/locales/papermill.yml")] + I18n.load_path
-require 'extensions'
+require 'papermill/extensions'
 require 'papermill/flash_session_cookie_middleware.rb'
 
 Object.send :include, PapermillObjectExtensions

data/public/papermill/jquery.Jcrop.css

@@ -5,7 +5,7 @@
 {
 	font-size: 0;
 	position: absolute;
-	background: white url('Jcrop.gif') top left repeat;
+	background: white url('images/Jcrop.gif') top left repeat;
 }
 .jcrop-vline { height: 100%; width: 1px !important; }
 .jcrop-hline { width: 100%; height: 1px !important; }

data/public/papermill/papermill.css

@@ -32,9 +32,10 @@ background: red;
 .papermill .progress { display:block; border:1px solid #C2E3EF; text-align:left; height:6px; }
 .papermill .progress span { background:#7BB963; height:6px; width:0; display:block; }
 
-.papermill .dashboard li a { display:inline; padding-left:20px; }
+.papermill .dashboard li a { display:inline; padding-left:20px }
 .papermill .dashboard li.mass_edit a { background:transparent url(/papermill/images/mass-edit.png) no-repeat top left; }
 .papermill .dashboard li.mass_delete a { background:transparent url(/papermill/images/mass-delete.png) no-repeat top left; }
+.papermill .dashboard li.mass_thumbnail_reset a { background:transparent url(/papermill/images/mass-thumbnail-reset.png) no-repeat top left; }
 
 .papermill-thumb-container { position:relative; border:5px solid #EEE; padding:4px; overflow:hidden; }	
 .papermill-thumb-container .asset { border:0px solid transparent; min-height:25px; min-width:25px; display:block; float:left; position:relative; }

data/public/papermill/papermill.js

@@ -138,6 +138,12 @@ var Papermill = {
 		if(confirm(wording)){ 
 	    jQuery.ajax({async:true, data:jQuery('#' + papermill_id).sortable('serialize'), dataType:'script', type:'post', url:'/papermill/mass_delete'})
 	  }
+	},
+	
+	mass_thumbnail_reset: function(papermill_id, wording) {
+		if(confirm(wording)){ 
+	    jQuery.ajax({async:true, data:jQuery('#' + papermill_id).sortable('serialize'), dataType:'script', type:'post', url:'/papermill/mass_thumbnail_reset'})
+	  }
 	}
 }
 

data/test/papermill_test.rb

@@ -91,7 +91,7 @@ class PapermillTest < Test::Unit::TestCase
     assert_equal @article.papermill_assets.key(:asset1).all(:order => "position DESC").map(&:id), [1,2]
     assert_equal @article.papermill_assets.key(:asset1).all(:order => "position DESC", :limit => 1).map(&:id), [1]
   end
-  
+
   def test_id_partition
     assert_equal @asset1.id_partition, "000/000/001"
   end
@@ -111,17 +111,7 @@ class PapermillTest < Test::Unit::TestCase
   def test_size
     assert_equal @asset1.size, 4456
   end
-  
-  def test_url
-    assert_equal @asset1.url, "/system/papermill/000/000/001/original/5k.png"
-    assert_equal @asset1.url("400x300#"), "/system/papermill/000/000/001/400x300%23/5k.png"
-  end
-  
-  def test_path
-    assert_equal @asset1.path, "./test/../../../../public/system/papermill/000/000/001/original/5k.png"
-    assert_equal @asset1.path("400x300#"), "./test/../../../../public/system/papermill/000/000/001/400x300#/5k.png"
-  end
-  
+    
   def test_content_type
     assert_equal @file.get_content_type, "image/png"
     assert_equal @asset1.content_type, "image/png"
@@ -142,4 +132,22 @@ class PapermillTest < Test::Unit::TestCase
     Papermill::options[:alias_only] = true
     assert_equal PapermillAsset.compute_style("100x100"), false
   end
-end
+end
+
+#  Filedata=(data)
+#  Filename=(name)
+#  create_thumb_file(style_name)
+#  basename
+#  extension
+#  url(style = nil)
+#  path(style = nil)
+#  self.papermill_options(assetable_class, assetable_key)
+#  papermill_options
+#  destroy_thumbnails
+#  self.destroy_orphans
+#  compute_url_key(style)
+#  has_valid_url_key?(key, style)
+#  root_directory
+#  set_file_name
+#  set_position
+#  destroy_files

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: papermill
 version: !ruby/object:Gem::Version 
-  version: 1.1.6
+  version: 1.2.0
 platform: ruby
 authors: 
 - "Benoit B\xC3\xA9n\xC3\xA9zech"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-01 00:00:00 +01:00
+date: 2009-12-08 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,8 +56,8 @@ files:
 - generators/papermill_table/templates/migrate/papermill_migration.rb.erb
 - init.rb
 - install.rb
-- lib/extensions.rb
 - lib/papermill.rb
+- lib/papermill/extensions.rb
 - lib/papermill/flash_session_cookie_middleware.rb
 - lib/papermill/form_builder.rb
 - lib/papermill/papermill.rb
@@ -74,20 +74,19 @@ files:
 - public/facebox/closelabel.gif
 - public/facebox/facebox.css
 - public/facebox/facebox.js
-- public/facebox/fbx-border-sprite.png
 - public/facebox/loading.gif
-- public/facebox/logo.png
-- public/facebox/shadow.gif
 - public/facebox/tl.png
 - public/facebox/tr.png
 - public/jgrowl/jquery.jgrowl.css
 - public/jgrowl/jquery.jgrowl_minimized.js
 - public/papermill/README
+- public/papermill/images/Jcrop.gif
 - public/papermill/images/background.png
 - public/papermill/images/container-background.jpg
 - public/papermill/images/delete.png
 - public/papermill/images/mass-delete.png
 - public/papermill/images/mass-edit.png
+- public/papermill/images/mass-thumbnail-reset.png
 - public/papermill/images/upload-blank.png
 - public/papermill/images/upload.png
 - public/papermill/jquery-1.3.2.min.js