papermill 0.14.3 → 0.16.0

data/.gitignore

@@ -1,6 +1,8 @@
 .DS_Store
+test/*.log
 log/*.log
 tmp/**/*
 config/database.yml
 db/*.sqlite3
+test.sqlte3
 papermill.gemspec

data/README.rdoc

@@ -1,125 +1,171 @@
 = Papermill 
 
-Asset management made easy.
+Asset management made easy. Now in pre-1.0.0 release!
 
-== Install the gem
+== Install the gems
   
-  $ gem source -a http://gemcutter.org # Needed for paperclip (installed as a dependency) : Rubyforge's version is too old..
+  $ gem source -a http://gemcutter.org
   $ sudo gem install papermill
  
 == Try the demo
   
   $ sudo gem install sqlite3-ruby
   $ rails -m http://github.com/bbenezech/papermill/raw/master/installation-template.txt papermill-example
-  $ cd papermill-example
-  $ ./script/server
-  Open localhost:3000 in your browser and try to create an article with assets but without title
-  
+
+== Features
+
+Loads of them
+
+=== Ajax uploading form helpers through SWFUpload: 
+
+* image_upload => unique image upload field, with preview
+* images_upload => sortable image gallery upload field
+* asset_upload => simple one asset field
+* assets_upload => sortable asset list field
+
+=== Choose thumbnail size for images previews : 
+
+* {:thumbnail => {:width => 100, :height => 100}}
+* {:thumbnail => {:style => "100x100>"}}
+* {:thumbnail => {:width => 100, :aspect_ratio => 4.0/3.0 }}
+
+=== Asset edit form: 
+
+* double-click on any asset in any helper to access&edit his properties
+* with pop-up/shadowbox/facebox, out of the box (or use your own pop-up system, dead-easy)
+
+=== Lazy created thumbnails
+
+* thumbnails are generated the first time they are asked-for, and only in the requested size. 
+* no need to register thumbnail size anywhere: my_asset.url("100x100>")
+
+=== Alias handling, declaration application-wide
+
+* :big_alias => {:geometry => "1000x>"}
+* :other_alias => "100x>"
+* :third_alias => {:geometry => '100:122', :my_other_keys => 'blblabla'}  # if you have a customed Paperclip::Thumbnail processor, you can pass any values you need.
+* and use them when you need them : my_asset.url(:big_alias)
+
 == Papermill comes in 2 flavors:
 
 === Generic catch-all declaration
 
-  papermill my_option_hash                                # in your papermilled assetable model
-  assets_upload(:my_key, my_option_hash)                  # form helper call
-  f.input :my_key, :as => :assets_upload, my_option_hash  # if you are using formtastic
-  @assetable.assets(:my_key)                              # data access in your view
+  papermill {options}                                     # in your papermilled assetable model
+  @article.assets(:any_key, options_hash)               # data access
 
 === Association specific declaration
 
-  papermill :my_association, my_option_hash               # in your papermilled assetable model
-  assets_upload(:my_association, my_option_hash)          # form helper call
-  @assetable.my_association                               # data access in your view
+  papermill :my_association, options_hash                 # in your papermilled assetable model
+  @article.my_association                               # data access
+
+== Usage:
 
+=== Model declaration
 
-In both case, you can specify a PapermillAsset subclass to use with :class_name => MyPapermillAssetSubclass in the option hash.
+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..
+  end
+
+entry.rb
+  class Entry < ActiveRecord::Base
+    papermill :mug_shot, other_options.. # default class_name is built-in PapermillAsset
+    papermill :diaporama, :class_name => ColorAsset, other_options..
+  end
 
-You can have a catch-all declaration and as many specific association as you want in your model (as long as they use different keys).
+color_asset.rb  # You should add columns to papermill_assets and use STI on PapermillAsset to extend defaults capabilities (or re-open PapermillAsset and monkey-patch it..)
+  class ColorAsset < PapermillAsset
+    named_scope :red, :conditions => {:color => 'red'}
+  end
 
-It's up to you. You can use the first one only, the second only or both.
+=== Form helpers
 
-See papermill_module.rb for the complete list of options.
+FormHelpers
+  form_for @article do 
+    f.image_upload  :cover_image, options_hash
+    f.images_upload :illustrations, options_hash
+    f.asset_upload  :pdf, options_hash
+    f.image_upload  :other_ressources, options_hash
+  end
+  
+Or with formtastic :
+  semantic_form_for @article do |f|
+    f.input @article, :cover_image, options_hash, :as => :image_upload
+    f.input @article, :illustrations, options_hash, :as => :images_upload
+    f.input @article, :pdf, options_hash, :as => :asset_upload
+    f.input @article, :other_ressources, options_hash, :as => :image_upload
+  end
 
+FormTagHelpers
+  image_upload_tag  @article, :cover_image, options_hash
+  images_upload_tag @article, :illustrations, options_hash
+  asset_upload_tag  @article, :pdf, options_hash
+  image_upload_tag  @article, :other_ressources, options_hash
+  # For resources not linked to any assetable model :
+  image_upload_tag #{current_organization.name}_logo
+  
+=== Resources access
+
+With generic papermill association, Papermill generates an #assets(:key, *args) named_scope
+  @article.assets(:illustrations)
+  @article.assets(:illustrations, :order => "created_at DESC")
+  @article.illustrations.red.first
+  @article.assets(:illustrations, :order => "created_at DESC").red.first
+  # etc.
+  
+With declarative papermill associations, Papermill 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"}) 
+  # etc.
+
+Or for non-assetable resources : 
+  PapermillAsset.all(:conditions => { :assetable_key => "#{current_organization.name}_logo" }).first
+  ColorAsset.all.red
+
+=== Using PapermillAsset
+  
+  @asset = @entry.mug_shot.first
+  image_tag @asset.url              # original
+  image_tag @asset.url("100x>")
+  image_tag @asset.url(:big)        # assuming you have a :big alias in your environment.rb
+  @asset.name
+  @asset.content_type
+  @asset.path                       # original
+  @asset.path("100x>")
+  # etc.
+  
 == Installation
 
-=== Once you've installed the gem, generate a migration and copy a couple of static assets:
+=== Once gem is installed :
 
-  # Generate  the migration and migrate:
+  # Generate migration :
   $ ./script/generate papermill_table PapermillMigration
   $ rake db:migrate
-  # copy some needed static assets to your public directory:
+  # copy static assets to your public directory:
   $ ./script/generate papermill_assets
+  # create the option hash in config/initializers/papermill.rb
+  $ ./script/generate papermill_initializer
   
 === Then in environment.rb:
   
   ...
-  
   Rails::Initializer.run do |config|
     ...
     config.gem papermill
-    
-    # You can set application-wide options inside or before Rails::Initializer :
-    module Papermill
-      OPTIONS = {
-        :thumbnail => {
-          :width => 150,
-          :height => 100
-        },
-        :aliases => {
-          :big => "500x500>",
-          :small => "100x100>"
-        },
-        :public_root => ":rails_root/public",         # already a default
-        :papermill_prefix => "system/papermill"       # already a default
-      }
-    end
-    # see lib/papermill/papermill_module.rb
-    
-    # You can use stringex's String#to_url (papermill will use its own String#to_url if none exists)
-    config.gem 'stringex'
-    ...
-    # You can use Mime-Type to get the correct mime type from upload - flash garbles it.. (default is a UNIX call to "file --mime")
-    # needed for Windows OS
+    # Needed for Windows OS (mime type from file extension): 
     config.gem "mime-types", :lib => "mime/types"
   end
-    
-=== In your assetable model:
-  
-  # You can set a catch-all papermill association : 
-  papermill :class_name => MyAssetClass
-  
-  # or create an association for the specific :my_gallery key
-  papermill :my_gallery_assets, :class_name => MyGalleryAsset
 
 === In your layout:
 
   <%= papermill_stylesheet_tag %>
   <%= papermill_javascript_tag :with_jquery => "no_conflict" %>
-  # you won't need :with_jquery if you have it already.
-  
-=== In your edit form: 
-
-  f.images_upload(:my_gallery)     # use specific papermill :my_gallery declaration
-  f.assets_upload(:my_assets)      # use catch-all
-  f.asset_upload(:my_other_asset)  # use catch-all
-  
-=== Access them with:
-  
-  @assetable.my_gallery_assets.each{ |image| image_tag image.url("100x100") }
-  # equivalent to:
-  @assetable.assets(:my_gallery_assets).each{ |image| image_tag image.url("100x100") }
-  # also equivalent to:
-  @assetable.assets(:conditions => {:assetable_key => 'my_gallery_assets'}).each{ |image| image_tag image.url("100x100") }
-  
-  @assetable.assets(:my_assets).each{ |asset| asset.url }
-  # if your association name is singularizable, you can do smtg like : 
-  @assetable.asset(:my_other_asset).try(:url)
-  # equivalent to:
-  @assetable.assets(:my_other_asset).first.try(:url)
-
-  # You can change assets/asset with :base_association_name in Papermill::OPTIONS (choose a plural word and you'll get singular association for free)
-
-Also see http://github.com/bbenezech/papermill/raw/master/installation-template.txt
-Have a look at the API here http://rdoc.info/projects/bbenezech/papermill
+  # you don't need :with_jquery if you already had it loaded.
 
 === Translations:
 

data/TODO.txt

@@ -1,5 +1,3 @@
-* non-regression tests
-* write rake task to delete all forgotten images.
 Edit views :
 * use Jcrop
 * try Picnic API

data/VERSION

@@ -1 +1 @@
-0.14.3
+0.16.0

data/app/controllers/papermill_controller.rb

@@ -4,72 +4,48 @@ class PapermillController < ApplicationController
   skip_before_filter :verify_authenticity_token, :only => [:create]
   
   def show
-    begin
-      complete_id = (params[:id0] + params[:id1] + params[:id2]).to_i
-      asset = PapermillAsset.find(complete_id)
-      raise if asset.nil? || params[:style] == "original"
-      style = Papermill::PAPERMILL_DEFAULTS[:aliases][params[:style]] || !Papermill::PAPERMILL_DEFAULTS[:alias_only] && params[:style]
-      raise unless style
-      style = {:geometry => style} unless style.is_a? Hash
-    
-      if asset.image?
-        temp_thumbnail = Paperclip::Thumbnail.make(asset_file = asset.file, style)
-        new_parent_folder_path = File.dirname(new_image_path = asset_file.path(params[:style]))
-        FileUtils.mkdir_p new_parent_folder_path unless File.exists? new_parent_folder_path
-        FileUtils.cp temp_thumbnail.path, new_image_path
-        redirect_to asset.url(params[:style])
-      else
-        redirect_to asset.url
-      end
-    rescue
-      render :text => t('papermill.not-found'), :status => "404"
+    @asset = PapermillAsset.find_by_id_partition params
+    if @asset.create_thumb_file(params[:style])
+      redirect_to @asset.url(params[:style])
+    else
+      render :nothing => true, :status => 500
     end
   end
 
   def destroy
-    @asset = PapermillAsset.find_by_id(params[:id])
+    @asset = PapermillAsset.find params[:id]
     render :update do |page|
-      if @asset && @asset.destroy
+      if @asset.destroy
         page << "jQuery('#papermill_asset_#{params[:id]}').remove()"
       else
         page << "jQuery('#papermill_asset_#{params[:id]}').show()"
-        page << %{ notify("#{t((@asset && "papermill.not-deleted" || "papermill.not-found"), :ressource => @asset.name)}", "error") }
+        page << %{ notify("#{ escape_javascript t("papermill.not-deleted", :ressource => @asset.name) }", "error") }
       end
     end
   end
   
   def update
-    @asset = PapermillAsset.find_by_id(params[:id])
+    @asset = PapermillAsset.find params[:id]
     render :update do |page|
-      if @asset && @asset.update_attributes(params[:papermill_asset])
-        page << %{ notify("#{t("papermill.updated", :ressource => @asset.name)}", "notice") }
+      if @asset.update_attributes(params[:papermill_asset])
+        page << %{ notify("#{ escape_javascript t("papermill.updated", :ressource => @asset.name)}", "notice") }
       else
-        page << %{ notify("#{@asset && @asset.errors.full_messages.to_sentence || t("papermill.not-found", :ressource => params[:id].to_s)}", "warning") }
+        page << %{ notify("#{ escape_javascript @asset.errors.full_messages.to_sentence }", "warning") }
       end
     end
   end
   
   def edit
     @asset = PapermillAsset.find params[:id]
+    render :action => "edit", :layout => (params[:layout] || "none")
   end
   
   def create
-    asset_class = params[:asset_class].constantize
-    params[:assetable_id]   = params[:assetable_id].try :to_i
-    params[:assetable_type] = params[:assetable_type].try :camelize
-    params[:assetable_key]  = params[:assetable_key].try :to_s
-    params[:swfupload_file] = params.delete(:Filedata)
-    unless params[:gallery]
-      @old_asset = asset_class.find(:first, :conditions => params.reject{|k, v| !["assetable_key", "assetable_type", "assetable_id"].include?(k)})
-    end
-    @asset = asset_class.new(params.reject{|k, v| !(PapermillAsset.columns.map(&:name)+["swfupload_file"]).include?(k)})
-    @asset.position = asset_class.find(:first, :conditions => params.reject{|k, v| !["assetable_key", "assetable_type", "assetable_id"].include?(k)}, :order => "position DESC" ).try(:position).to_i + 1
-    
-    if @asset.save
-      @old_asset.destroy if @old_asset
+    @asset = params[:asset_class].constantize.new(params.reject{|k, v| !(PapermillAsset.columns.map(&:name)+["Filedata", "Filename"]).include?(k)})
+    if @asset.save(:unique => !params[:gallery])
       render :partial => "papermill/asset", :object => @asset, :locals => {:gallery => params[:gallery], :thumbnail_style => params[:thumbnail_style]}
     else
-      render :text => @asset.errors.full_messages.join('<br />'), :status => "500"
+      render :text => @asset.errors.full_messages.join('<br />'), :status => 500
     end
   end
   
@@ -79,4 +55,29 @@ class PapermillController < ApplicationController
     end
     render :nothing => true
   end
+  
+  def mass_delete
+    render :update do |page|
+      (params[:papermill_asset] || []).each do |id|
+        @asset = PapermillAsset.find(id)
+        if @asset.destroy
+          page << "jQuery('#papermill_asset_#{id}').remove()"
+        else
+          page << %{ notify('#{ escape_javascript t("papermill.not-deleted", :ressource => @asset.name)}', 'error') }
+        end
+      end
+    end
+  end
+  
+  def mass_edit
+    message = []
+    (params[:papermill_asset] || []).each do |id|
+      @asset = PapermillAsset.find(id) 
+      @asset.update_attribute(params[:attribute], params[:value])
+      message << t("papermill.updated", :ressource => @asset.name)
+    end
+    render :update do |page|
+      page << %{ notify('#{ escape_javascript message.join("<br />")}', "notice") } unless message.empty?
+    end
+  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)}')){ $.ajax({async:true, beforeSend:function(request){$('##{dom_id}').hide();}, dataType:'script', error:function(request){$('##{dom_id}').show();}, type:'delete', url:'#{papermill_url(asset)}'})}; return false;" href="#" class="delete"><img title="#{escape_javascript t("papermill.delete", :ressource => asset.name)}" src="/papermill/images/delete.png" alt="delete"/></a>} %>
+<%- delete_link = %{<a onclick="if(confirm('#{escape_javascript t("papermill.delete-confirmation", :resource => asset.name)}')){ jQuery.ajax({async:true, beforeSend:function(request){jQuery('##{dom_id}').hide();}, dataType:'script', error:function(request){jQuery('##{dom_id}').show();}, type:'delete', url:'#{papermill_url(asset)}'})}; return false;" href="#" class="delete"><img title="#{escape_javascript t("papermill.delete", :ressource => asset.name)}" src="/papermill/images/delete.png" alt="delete"/></a>} %>
 
 <li id="<%= dom_id %>" title="<%= t("papermill.#{thumbnail_style ? "thumbnail-" : ""}edit-title", :ressource => asset.name) %>" onDblClick="popup(jQuery(this).attr('rel')); return false;" rel="<%= edit_papermill_url(asset) %>">
 	<%= delete_link %>

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

@@ -1,13 +1,20 @@
-<p>
-  <%= form.label :title, t("papermill.title") %><br />
-  <%= form.text_field :title, :class => "text_field" %>
-</p>
-<p>
-  <%= form.label :copyright, t("papermill.copyright") %><br />
-  <%= form.text_field :copyright, :class => "text_field" %>
-</p>
-<p>
-  <%= form.label :description, t("papermill.description") %><br />
-  <%= form.text_area :description %>
-</p>
-<%= submit_tag t('papermill.save') %>
+<form onsubmit="jQuery.ajax({data:jQuery.param(jQuery(this).serializeArray()), dataType:'script', type:'post', url:'/papermill/<%= @asset.id %>'}); try {jQuery(document).trigger('close.facebox');} catch (e) {}; try{Shadowbox.close();} catch (e) {};  try{self.close();} catch (e) {}; return false;" method="post" action="/papermill/<%= @asset.id %>">
+  <input type="hidden" value="put" name="_method"/>
+  
+  <% fields_for :papermill_asset, @asset do |form| %>
+    <p>
+      <%= form.label :title, t("papermill.title") %><br />
+      <%= form.text_field :title, :class => "text_field" %>
+    </p>
+    <p>
+      <%= form.label :copyright, t("papermill.copyright") %><br />
+      <%= form.text_field :copyright, :class => "text_field" %>
+    </p>
+    <p>
+      <%= form.label :description, t("papermill.description") %><br />
+      <%= form.text_area :description %>
+    </p>
+    <%= submit_tag t('papermill.save') %>
+  <% end %>
+</form>
+<%= javascript_include_tag("http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js") if params[:with_jquery] %>

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

@@ -1,6 +1,6 @@
 <div id="papermill-box">
   <div id="left">
-    <%= link_to(@asset.image? ? image_tag(@asset.url("400x#{Papermill::PAPERMILL_DEFAULTS[:max_height]}>")) : t("file_type", :type => @asset.content_type, :scope => 'papermill'), @asset.url, :popup => true) %>
+    <%= link_to(@asset.image? ? image_tag(@asset.url("400x>")) : t("file_type", :type => @asset.content_type, :scope => 'papermill'), @asset.url, :popup => true) %>
   </div>
   <div id="right">
     <div id="read-only">
@@ -17,12 +17,7 @@
       </table>
     </div>
     <div id="read-write">
-      <form onsubmit="jQuery.ajax({data:jQuery.param(jQuery(this).serializeArray()), dataType:'script', type:'post', url:'/papermill/<%= @asset.id %>'}); return false;" method="post" action="/papermill/<%= @asset.id %>">
-        <input type="hidden" value="put" name="_method"/>
-        <% fields_for :papermill_asset, @asset do |form| %>
-          <%= render :partial => 'form', :object => form %>
-        <% end %>
-      </form>
+      <%= render :partial => 'form' %>
     </div>
   </div>
   <div style="clear:both;"></div>