papermill 1.4.3 → 2.0.0.pre

data/README.rdoc

@@ -108,15 +108,6 @@ Maybe you don't want users to use your application as a thumbnailing farm for th
 * Brute solution: pass :use_url_key to true in the options (config/initializers/papermill.rb). A crypted hash unique to your application and to each asset and to the requested style will be added to the URL. No more happy-guessing of anything. Do that first before going live, or you'll have to migrate all assets...
 * pass :alias_only to true. This will disable the possibility to generate thumbnails with a papermill string in the url, but won't do anything for the member area thing. Plus you will have to use aliases only, form helpers included (pass :thumbnail => { :style => :some_alias })
 
-=== Restricted-area/back-office
-
-Go to the options and look for : 
-  :authorize_create => true, 
-  :authorize_update_and_destroy => true, 
-  :authorize_multiple_modification => true,
-
-You will find a quick & dirty solution to pass your authorizations rules in before_filters, before any asset gets hurt.
-
 == Usage
 
 Assetable is the class that has_many papermill_assets (i.e. the class with the papermill declaration)
@@ -125,23 +116,11 @@ Assetable is the class that has_many papermill_assets (i.e. the class with the p
 
 You can have a generic association and as many declarative associations as you want in your model. Papermill will always use specific if found.
 
-article.rb
-
-  class Article < ActiveRecord::Base
-    papermill :class_name => ColorAsset, other_options..              # generic, will use ColorAsset instead of PapermillAsset (ColorAsset must be an STIed PapermillAsset)
-  end
-
-entry.rb
-
-  class Entry < ActiveRecord::Base
-    papermill :mug_shot, other_options..                              # specific association on :mug_shot
-    papermill :diaporama, :class_name => ColorAsset, other_options..  # specific association on :diaporama will use ColorAssets
-  end
-
-color_asset.rb  # You can add columns to papermill_assets and use STI on PapermillAsset to extend defaults abilities (or re-open PapermillAsset/monkey-patch it/use a polymorphic association on PapermillAsset to extend it with behaviors..)
-
-  class ColorAsset < PapermillAsset
-    named_scope :red, :conditions => {:color => 'red'}
+  class Article
+    papermill :images
+    papermill :pdf_version
+    papermill :cover_image
+    papermill :illustrations
   end
 
 === Form helpers
@@ -154,8 +133,8 @@ Example form:
     
     # Now I need to be able to upload as many documents as I need, and sort them at will
     # no document should be bigger than 1MB (respect the quoting!)
-    # and I don't want any dashboard mass_edit feature, just mass_delete (delete all)
-    f.assets_upload :documentation, :swfupload => { :file_size_limit => "'1 MB'" }, :dashboard => [:mass_delete]
+    # and I don't want the mass_edit feature
+    f.assets_upload :documentation, :swfupload => { :file_size_limit => "'1 MB'" }, :mass_edit => false
  
     # I need to display *one* cover *image*, format will be 200x200
     # targetted_size will give the uploader hints when cropping the image after upload : desired display size and wanted aspect-ratio.
@@ -195,10 +174,6 @@ With FormTagHelpers, use (image_upload_tag | images_upload_tag | asset_upload_ta
 
   image_upload_tag  @article, :cover_image, :targetted_size => "200x200"
 
-For resources not linked to any assetable model, you can use upload_tags without any Assetable
-
-  image_upload_tag "#{current_organization.name}_logo", :targetted_size => "200x200"
-
 === Asset editing 
 
 * double-click on any uploaded asset in any form-helper to access & edit his properties
@@ -292,28 +267,15 @@ Example:
 
 === Resource access
 
-Papermill generates an #assets(:key, *args) named_scope
-  @article.assets(:illustrations)
-  @article.assets(:illustrations, :order => "created_at DESC")
-  @article.assets(:illustrations).red.first
-  # etc.
+Papermill generates an #<association_key> association
 
-With declarative papermill associations, Papermill also generates an #<association_key>(*args) named_scope
-  @entry.mug_shot.first
-  @entry.diaporama
-  @entry.diaporama(:order => "created_at DESC")
-  @entry.diaporama.red
-  # === @entry.diaporama(:conditions => {:color => "red"}) 
-  # === @entry.assets(:diaporama, :conditions => {:color => "red"})
+  @entry.mug_shots.first
+  @entry.diaporamas.each do |image| ..
   # etc.
-
-Or for non-assetable resources : 
-  PapermillAsset.key("#{current_organization.name}_logo").first
-  ColorAsset.all.red
-
+  
 === Using PapermillAsset
 
-  @asset = @entry.mug_shot.first
+  @asset = @entry.mug_shots.first
   image_tag @asset.url              # original
   image_tag @asset.url("100x>")     # assuming asset is an image
   image_tag @asset.url(:big)        # assuming you have a :big alias

data/TODO.txt

@@ -0,0 +1,7 @@
+# default papermill association with method_missing/define_method chain
+# extend watermark/copyright possibilities
+# refresh images when cropped
+# authorize images before edit/crop
+# documentation for papermill_associations
+# file search helper for papermill_associations
+# tests, loads of them

data/VERSION

@@ -1 +1 @@
-1.4.3
+2.0.0.pre

data/app/controllers/papermill_controller.rb

@@ -1,27 +1,8 @@
 class PapermillController < ApplicationController
   unloadable
   prepend_before_filter :load_asset,  :only => [ "show", "destroy", "update", "edit", "crop" ]
-  prepend_before_filter :load_old_asset_and_assetable, :only => ["create"]
-  prepend_before_filter :load_assets, :only => [ "sort", "mass_delete", "mass_edit", "mass_thumbnail_reset" ]
   skip_before_filter :verify_authenticity_token, :only => [:create] # not needed (Flash same origin policy)
   
-  before_filter :authorize_create, :only => [:create]
-  before_filter :authorize_update_and_destroy, :only => [:update, :destroy]
-  before_filter :authorize_multiple_modification, :only => [:sort, :mass_delete, :mass_edit, :mass_thumbnail_reset]
-  
-  def authorize_create
-    eval(Papermill::options[:authorize_create])
-  end
-  
-  def authorize_update_and_destroy
-    eval(Papermill::options[:authorize_update_and_destroy])
-  end
-
-  def authorize_multiple_modification
-    eval(Papermill::options[:authorize_multiple_modification])
-  end
-  
-  
   def show
     # first escaping is done by rails prior to route recognition, need to do a second one on MSWIN systems to get original one.
     params[:style] = CGI::unescape(params[:style]) if Papermill::MSWIN
@@ -35,17 +16,16 @@ class PapermillController < ApplicationController
   def create
     @asset = params[:asset_class].constantize.new(params.reject{|k, v| !(PapermillAsset.columns.map(&:name)+["Filedata", "Filename"]).include?(k)})
     if @asset.save
-      @old_asset.destroy if @old_asset
-      output = render_to_string(:partial => "papermill/asset", :object => @asset, :locals => { :gallery => params[:gallery], :thumbnail_style => params[:thumbnail_style], :targetted_size => params[:targetted_size] })
+      output = render_to_string(:partial => "papermill/asset", :object => @asset, :locals => { :gallery => params[:gallery], :thumbnail_style => params[:thumbnail_style], :targetted_size => params[:targetted_size], :field_name => params[:field_name], :field_id => params[:field_id] })
       render :update do |page|
-        page << %{ jQuery('##{params[:Fileid]}').replaceWith('#{escape_javascript output}'); }
-        page << %{ jQuery('#papermill_asset_#{@old_asset.id}').remove() } if @old_asset 
+        page << %{ jQuery('##{params[:Fileid]}').replaceWith('#{escape_javascript output}') }
+        page << %{ jQuery('##{params[:Oldfileid]}').remove() } if params[:Oldfileid]
       end
     else
       render :update do |page|
-        page << %{ notify('#{@asset.name}', '#{escape_javascript @asset.errors.full_messages.join("<br />")}', 'error'); }
-        page << %{ jQuery('##{params[:Fileid]}').remove(); }
-        page << %{ jQuery('#papermill_asset_#{@old_asset.id}').show(); } if @old_asset
+        page << %{ notify('#{@asset.name}', '#{escape_javascript @asset.errors.full_messages.join("<br />")}', 'error') }
+        page << %{ jQuery('##{params[:Fileid]}').remove() }
+        page << %{ jQuery('##{params[:Oldfileid]}').show() } if params[:Oldfileid]
       end
     end
   end
@@ -68,58 +48,33 @@ class PapermillController < ApplicationController
       end
     end
   end
-
-  def destroy
-    @asset.destroy
-    render :update do |page|
-      page << %{ jQuery("#papermill_asset_#{params[:id]}").remove(); }
-    end
-  end
   
-  def sort
-    @assets.each_with_index do |asset, index|
-      asset.update_attribute(:position, index + 1)
-    end
-    render :nothing => true
-  end
-  
-  def mass_delete
+  def add_list
+    @assets = PapermillAsset.find(params[:ids]).sort_by{|asset|params[:ids].index(asset.id.to_s)} unless params[:ids].blank?
+    output = render_to_string(:partial => "papermill/asset", :collection => (@assets || []), :locals => { :gallery => params[:gallery], :thumbnail_style => params[:thumbnail_style], :targetted_size => params[:targetted_size], :field_name => params[:field_name], :field_id => params[:field_id] })
     render :update do |page|
-      @assets.each do |asset|
-        page << %{ jQuery("#papermill_asset_#{asset.id}").remove(); } if asset.destroy
-      end
+      page << %{ close_popup(); jQuery('##{params[:field_id]}').html('#{escape_javascript output}'); }
     end
   end
   
+  def browser
+    ids_list = params[params[:field_id] + "_papermill_asset"]
+    @selected_assets = ids_list.blank? ? [] : params[:asset_class].constantize.find(ids_list).sort_by{|asset| ids_list.index(asset.id.to_s)}
+    @other_assets = params[:asset_class].constantize.all - @selected_assets
+    render :action => "browser", :layout => false
+  end
+    
   def mass_edit
+    @assets = (params[(params[:list_id] + "_papermill_asset").to_sym] || []).map{ |id| PapermillAsset.find(id, :include => "assetable") }
     @assets.each { |asset| asset.update_attribute(params[:attribute], params[:value]) }
     render :update do |page|
       page << %{ notify("", "#{ escape_javascript  t("papermill.updated", :resource => @assets.map(&:name).to_sentence)  }", "notice"); } unless @assets.blank? 
     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_old_asset_and_assetable
-    unless params[:gallery]
-      @old_asset = PapermillAsset.find(:first, :conditions => {:assetable_type => params[:assetable_type], :assetable_id => params[:assetable_id], :assetable_key => params[:assetable_key]})
-    end
-    @assetable = params[:assetable_type].constantize.find_by_id(params[:assetable_id])
-  end
-  
   def load_asset
-    @asset = PapermillAsset.find(params[:id] || (params[:id0] + params[:id1] + params[:id2]).to_i, :include => "assetable")
-    @assetable = @asset.assetable
-  end
-  
-  def load_assets
-    @assets = (params[:papermill_asset] || []).map{ |id| PapermillAsset.find(id, :include => "assetable") }
+    @asset = PapermillAsset.find(params[:id] || (params[:id0] + params[:id1] + params[:id2]).to_i)
   end
 end

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

@@ -1,5 +1,5 @@
-<%- dom_id = "papermill_asset_#{asset.id}" -%>
-<%- delete_link = %{<a onclick="if(confirm('#{escape_javascript t("papermill.delete-confirmation", :resource => asset.name)}')){ jQuery.ajax({async:true,  dataType:'script', type:'delete', url:'#{papermill_url(asset)}'})}; return false;" href="#" class="delete"><img title="#{escape_javascript t("papermill.delete", :resource => asset.name)}" src="/papermill/images/delete.png" alt="delete"/></a>} %>
+<%- dom_id = "#{field_id}_papermill_asset_#{asset.id}" -%>
+<%- delete_link = %{<a onclick="$('##{dom_id}').remove(); return false;" href="#" class="delete"><img title="#{escape_javascript t("papermill.delete", :resource => asset.name)}" src="/papermill/images/delete.png" alt="delete"/></a>} %>
 
 <div id="<%= dom_id %>" class="asset" title="<%= t("papermill.#{(thumbnail_style) ? "thumbnail-" : ""}edit-title", :resource => asset.name) %>" onDblClick="popup(jQuery(this).attr('rel')); return false;" rel="<%= edit_papermill_url(asset, :targetted_size => targetted_size) %>">
 	<%= delete_link %>
@@ -8,4 +8,5 @@
 	<%- else -%>
 	  <%= render :partial => "papermill/raw_asset", :object => asset %>
 	<%- end -%>
+  <%= hidden_field_tag field_name, asset.id.to_s, :id => nil %>
 </div>

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

@@ -0,0 +1,21 @@
+<% params.delete(:action) %>
+<form onsubmit="jQuery.ajax({data:jQuery.param(jQuery(this).serializeArray()), dataType:'script', type:'post', url:'<%= add_list_papermill_path(params) %>'}); close(); return false;" method="post">
+  <ul style="width:800px;display:block">
+    <% @selected_assets.each do |asset| %>
+      <li style="display:block; float:left">
+        <input type=checkbox id="papermill_asset_<%= asset.id %>" name="ids[]" value="<%= asset.id %>" checked='checked' />
+        <label for="papermill_asset_<%= asset.id %>"><%= image_tag asset.url("50x") %></label>
+      </li>
+    <% end -%>
+    <hr style="clear:both;margin:10px;"></hr>
+    
+    <% @other_assets.each do |asset| %>
+      <li style="display:block; float:left">
+        <input type=checkbox id="papermill_asset_<%= asset.id %>" name="ids[]" value="<%= asset.id %>" />
+        <label for="papermill_asset_<%= asset.id %>"><%= image_tag asset.url("50x") %></label>
+      </li>
+    <% end -%>
+  </ul>
+  <div style="clear:both;padding:10px;"></div>
+  <%= submit_tag "Valider" %>
+</form>

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, :mass_thumbnail_reset => :post }, :member => { :crop => :get, :receive_from_pixlr => :post }
+  map.resources :papermill, :collection => { :mass_edit => :post, :add_list => :post, :browser => :get }, :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/demo.txt

@@ -9,9 +9,10 @@ rake "db:migrate"
 file "app/models/article.rb", <<-END
   class Article < ActiveRecord::Base
     validates_presence_of :title
-    papermill :thumbnail => {:width => 100, :height => 75} # catch-all for non-specified associations, will create assets/asset methods. 
     papermill :image_gallery, :class_name => ImageAsset, :images_only => true, :thumbnail => {:width => 75, :height => 100}
-    # image_gallery association (set with define_method)
+    papermill :thumbnail, :class_name => ImageAsset, :images_only => true
+    papermill :my_assets
+    papermill :my_other_asset
   end
 END
 
@@ -41,8 +42,8 @@ file "app/views/articles/_form.html.erb", <<-END
   <%= f.text_field :title %><br /><br />
   <%= f.label :image_gallery %><br />
   <%= f.images_upload(:image_gallery) %><br /><br />
-  <%= f.label :my_other_image %><br />
-  <%= f.image_upload(:my_other_image) %> <br /><br />
+  <%= f.label :thumbnail %><br />
+  <%= f.image_upload(:thumbnail) %><br /><br />
   <%= f.label :my_assets %><br />
   <%= f.assets_upload(:my_assets) %><br /><br />
   <%= f.label :my_other_asset %><br />
@@ -64,24 +65,24 @@ file "app/views/articles/show.html.erb", <<-END
   <% end %>
 </p>
 <br /><br />
-<b>@article.assets(:my_other_image).first :</b>
+<b>@article.thumbnail.first :</b>
 <p>
-  <% image = @article.assets(:my_other_image).first %>
+  <% image = @article.thumbnail.first %>
   <%= link_to(image_tag(image.url("100x100#")), image.url) if image %>
 </p>
 <br /><br />
-<b>@article.assets(:my_assets).each :</b>
+<b>@article.my_assets.each :</b>
 <p>
   <ul>
-    <% @article.assets(:my_assets).each do |asset| %>
+    <% @article.my_assets.each do |asset| %>
       <li><%= link_to asset.name, asset.url %></li>
     <% end %>
   </ul>
 </p>
 <br /><br />
-<b>@article.assets(:my_other_asset).first :</b>
+<b>@article.my_other_asset.first :</b>
 <p>
-  <% asset = @article.assets(:my_other_asset).first %>
+  <% asset = @article.my_other_asset.first %>
   <%= link_to(asset.name, asset.url) if asset %>
 </p>
 

data/generators/papermill_initializer/papermill_initializer.rb

@@ -17,7 +17,8 @@ module Papermill
       # Associated PapermillAsset subclass (must be an STI subclass of PapermillAsset)
       # :class_name => "PapermillAsset",
       
-      
+      # You can use the included join table if you need your assets to be associated to more than one assetable
+      # :through => false,
       
       
       #@@@@@@@@@@@@@@@@@@@ form-helper parameters @@@@@@@@@@@@@@@@@@@@@@@
@@ -34,14 +35,12 @@ module Papermill
     
       # Dashboard is only for galleries
       # You can remove/change order of HTML elements.
-      # See below for dashboard
       
-      # :form_helper_elements => [:upload_button, :container, :dashboard],
-    
-      # Dashboard elements
-      # You can remove/change order of HTML elements. You can add :mass_thumbnail_reset to add a link to reset all thumbnails, although you shouldn't need it.
+      # :form_helper_elements => [:upload_button, :container, :mass_edit],
       
-      # :dashboard => [:mass_edit, :mass_delete ],
+      # Batch edit a single field of all the assets in a form field
+      
+      # :mass_edit => true,
     
       # Attributes editable at once for all assets in a gallery
       
@@ -177,14 +176,6 @@ module Papermill
       
       #@@@@@@@@@@@@@@@@@ Application-wide parameters @@@@@@@@@@@@@@@@@@@@
 
-      # Default named_scope name for catch-all :papermill declaration
-      
-      #  :base_association_name => :assets,
-      
-      # Do you want papermill_assets to touch your assetable when CRUDed? (true|false|updated_at_field_name)
-      
-      #  :touch => false,
-    
       # Set to true to require aliases in all url/path, disabling the 
       # Don't forget to give an alias value to options[:thumbnail][:style] if true!
       
@@ -222,46 +213,6 @@ module Papermill
       
       # 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
-      
-      # You can add authorization support. The code is eval'ed directly in the controller (don't ask why, the answer is full of 'unloadable', 'ApplicationController has been removed from the module tree but is still active', etc.)
-      
-      # :authorize_create => "true",
-      # :authorize_multiple_modification => "true",
-      # :authorize_update_and_destroy => "true",
-      
-      # For example, this is my own setup.
-      # adapt the authorization part (can_edit(Assetable)) to your own authorization solution
-      
-      # :authorize_create => %{
-      #   unless @assetable.nil? || current_user.can_edit?(@assetable)
-      #     render :update do |page|
-      #       page << %{notify("Wrong credentials", "You can't create an asset here", "error");}
-      #       page.remove params[:Fileid]
-      #       page.show "papermill_asset_" + @old_asset.id.to_s if @old_asset
-      #     end
-      #     false
-      #   end
-      # }, 
-      # :authorize_update_and_destroy => %{
-      #   unless @asset.try(:assetable).nil? || current_user.can_edit?(@asset.assetable)
-      #     render :update do |page|
-      #       page << %{notify("Wrong credentials", "You can't edit or destroy assets here", "error");}
-      #     end
-      #     false
-      #   end
-      # }, 
-      # :authorize_multiple_modification => %{
-      #   authorized = true
-      #   @assets && @assets.each do |asset| 
-      #     authorized = authorized && current_user.can_edit?(asset.assetable)
-      #   end
-      #   unless authorized
-      #     render :update do |page|
-      #       page << %{notify("Wrong credentials", "You can't do edit or destroy assets here", "error");}
-      #     end
-      #     false
-      #   end
-      # }
     }
   end
 end

data/generators/papermill_table/templates/migrate/papermill_migration.rb.erb

@@ -3,33 +3,57 @@ class <%= migration_name %> < ActiveRecord::Migration
     create_table :papermill_assets do |t|
     
       # Paperclip fields (required)
-      t.string   :file_file_name
-      t.string   :file_content_type
-      t.integer  :file_file_size
+      t.string      :file_file_name
+      t.string      :file_content_type
+      t.integer     :file_file_size
       
       # Papermill fields (required)
-      t.integer  :position          # sets are ordered by position
+      t.integer     :position          # sets are ordered by position
       
-      t.belongs_to :assetable, :polymorphic => true
+      t.belongs_to  :assetable, :polymorphic => true
+      t.string      :assetable_key
+      t.string      :type              # PapermillAsset STI
+      t.string      :title             # filename not transformed, without file extension, for your own use
       
-      t.string   :assetable_key
-      t.string   :type              # STI
-      t.string   :title             # filename not transformed, without file extension, for your own use
+      # Papermill magical fields (You'll need to configure :mass_editable_fields/:editable_fields accordingly to be able to modify them with Papermill helpers)
       
-      # Example additionals fields (configure :mass_editable_fields/:editable_fields accordingly)
-      t.string   :alt
-      t.string   :copyright         # Content can be used to add copyright on thumbnails
-      t.text     :description
+      t.string      :copyright              # copyright content
+      t.string      :copyright_im_command   # copyright ImageMagick command
+      t.string      :watermark              # watermark URI
+      t.string      :watermark_im_command   # watermark ImageMagick content
+
+      # Example additionals fields (configure :mass_editable_fields/:editable_fields accordingly to be able to modify them with Papermill helpers)
+
+      t.string      :alt
+      t.text        :description
       t.timestamps
     end
     
     change_table :papermill_assets do |t|
-      t.index [:assetable_id, :assetable_type, :assetable_key, :position], { :name => "papermill_index" }
+      t.index [:assetable_id, :assetable_type, :assetable_key, :position], { :name => "papermill_assets_index" }
       t.index [:assetable_key, :position]  # for non assetable assets
     end
+    
+    # If you want to associate an asset to more than one assetable, use the (:through => true) option to use the join-table and get an assetable with smtg like
+    # has_many :assets, :through => :papermill_associations
+    
+    create_table :papermill_associations, :force => true do |t|
+      t.belongs_to  :assetable, :polymorphic => true
+      t.string      :assetable_key
+      t.integer     :position
+      t.belongs_to  :papermill_asset
+      t.timestamps
+    end
+    
+    change_table :papermill_associations do |t|
+      t.index [:assetable_id, :assetable_type, :assetable_key, :position], { :name => "papermill_associations_index" }
+      t.index :papermill_asset_id
+    end
+    
   end
   
   def self.down
     drop_table :papermill_assets
+    drop_table :papermill_associations
   end
 end

data/lib/papermill/extensions.rb

@@ -21,6 +21,16 @@ module PapermillObjectExtensions
   end
 end
 
+module PapermillArrayExtensions
+  def map_with_index!
+    each_with_index do |e, idx| self[idx] = yield(e, idx); end
+  end
+
+  def map_with_index(&block)
+    dup.map_with_index!(&block)
+  end
+end
+
 module PapermillFormtasticExtensions
   def image_upload_input(method, options)
     self.label(method, options_for_label(options)) +