papermill 0.7.0 → 0.8.0

data/README.rdoc

@@ -20,7 +20,7 @@ Asset management made easy.
 
   papermill my_option_hash                              # in your papermilled assetable model
   assets_upload(:my_key, my_option_hash)          # form helper call
-  @assetable.papermill_assets(:my_key)                  # data access in your view
+  @assetable.assets(:my_key)                  # data access in your view
 
 === Association specific declaration
 
@@ -66,11 +66,11 @@ See papermill_module.rb for the complete list of options.
 === In your assetable model:
   
   # You can set a catch-all papermill association : 
-  papermill :class_name => Asset
+  papermill :class_name => MyAssetClass
   
   # or create an association for the specific :my_gallery key
-  papermill :my_gallery,
-    :class_name => GalleryAsset,
+  papermill :my_gallery_assets,
+    :class_name => MyGalleryAsset,
     :thumbnail => {
         :width => 90,
         :height => 30
@@ -80,7 +80,7 @@ See papermill_module.rb for the complete list of options.
 
   <%= papermill_stylesheet_tag %>
   <%= papermill_javascript_tag :with_jquery => "no_conflict" %>
-  # you won't need :with_jquery if you use it already, obviously.
+  # you won't need :with_jquery if you have already loaded it.
   
 === In your edit form: 
 
@@ -90,9 +90,18 @@ See papermill_module.rb for the complete list of options.
   
 === Access them with:
   
-  @assetable.my_gallery.each{ |image| image_tag image.url("100x100") }
-  @assetable.papermill_assets(:my_assets).each{ |asset| asset.url }
-  @assetable.papermill_assets(:my_other_asset).first.url
+  @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)
 
 Also see http://github.com/bbenezech/papermill/raw/master/installation-template.txt for more precises installation steps.
 Have a look at the API here http://rdoc.info/projects/BBenezech/papermill

data/TODO.txt

@@ -1,4 +1,2 @@
-* check necessity for escaped_filename
-* check necessity for  Mime::Type
-* assets without assetable
-* non-regression tests
+* non-regression tests
+* check for necessity for requires over gemspec dependencies

data/VERSION

@@ -1 +1 @@
-0.7.0
+0.8.0

data/app/controllers/papermill_controller.rb

@@ -52,14 +52,13 @@ class PapermillController < ApplicationController
   end
   
   def create
-    params[:assetable_id] = params[:assetable_id].nie
     asset_class = params[:asset_class].constantize
-    params[:assetable_type] = params[:assetable_type] && params[:assetable_type].to_s.camelize.nie
+    params[:assetable_type] = params[:assetable_type].camelize if params[:assetable_type]
     params[:swfupload_file] = params.delete(:Filedata)
     unless params[:gallery]
-      @old_asset = asset_class.find(:first, :conditions => {:assetable_key => params[:assetable_key], :assetable_type => params[:assetable_type], :assetable_id => params[:assetable_id]})
+      @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{|key, value| !(PapermillAsset.columns.map(&:name)+["swfupload_file"]).include?(key.to_s)})
+    @asset = asset_class.new(params.reject{|k, v| !(PapermillAsset.columns.map(&:name)+["swfupload_file"]).include?(k)})
     
     if @asset.save
       @old_asset.destroy if @old_asset

data/installation-template.txt

@@ -7,7 +7,7 @@ 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
+    papermill :thumbnail => {:width => 100, :height => 75} # catch-all for non-specified associations, will create assets/asset methods. You can change it: :base_association_name, with Papermill::OPTIONS in your environment.rb
     papermill :image_gallery, :class_name => ImageAsset, :images_only => true, :thumbnail => {:width => 75, :height => 100}
     # image_gallery association (set with define_method)
   end
@@ -75,24 +75,24 @@ file "app/views/articles/show.html.erb", <<-END
   <% end %>
 </p>
 <br /><br />
-<b>@article.papermill_assets(:my_other_image).first :</b>
+<b>@article.assets(:my_other_image).first :</b>
 <p>
-  <% image = @article.papermill_assets(:my_other_image).first %>
+  <% image = @article.asset(:my_other_image) %>
   <%= link_to(image_tag(image.url("100x100#")), image.url) if image %>
 </p>
 <br /><br />
-<b>@article.papermill_assets(:my_assets).each :</b>
+<b>@article.assets(:my_assets).each :</b>
 <p>
   <ul>
-    <% @article.papermill_assets(:my_assets).each do |asset| %>
+    <% @article.assets(:my_assets).each do |asset| %>
       <li><%= link_to asset.name, asset.url %></li>
     <% end %>
   </ul>
 </p>
 <br /><br />
-<b>@article.papermill_assets(:my_other_asset).first :</b>
+<b>@article.asset(:my_other_asset) :</b>
 <p>
-  <% asset = @article.papermill_assets(:my_other_asset).first %>
+  <% asset = @article.asset(:my_other_asset) %>
   <%= link_to(asset.name, asset.url) if asset %>
 </p>
 

data/lib/core_extensions.rb

@@ -1,3 +1,5 @@
+class PapermillException < Exception; end
+
 module HashExtensions
   def deep_merge(hash)
     target = dup

data/lib/papermill/form_builder.rb

@@ -1,32 +1,39 @@
 module ActionView::Helpers::FormTagHelper
   
   def assets_upload_tag(assetable, key = nil, options = {})
-    papermill_upload_field_tag key, { :thumbnail => false, :assetable => assetable }.update(options)
+    papermill_upload_tag key, { :thumbnail => false, :assetable => assetable }.update(options)
   end
+  
   def asset_upload_tag(assetable, key = nil, options = {})
-    papermill_upload_field_tag key, { :gallery => false, :thumbnail => false, :assetable => assetable }.update(options)
+    papermill_upload_tag key, { :gallery => false, :thumbnail => false, :assetable => assetable }.update(options)
   end
+  
   def images_upload_tag(assetable, key = nil, options = {})
-    papermill_upload_field_tag key, { :assetable => assetable }.update(options)
+    papermill_upload_tag key, { :assetable => assetable }.update(options)
   end
+  
   def image_upload_tag(assetable, key = nil, options = {})
-    papermill_upload_field_tag key, { :gallery => false, :assetable => assetable }.update(options)
+    papermill_upload_tag key, { :gallery => false, :assetable => assetable }.update(options)
   end
   
   private
-  def papermill_upload_field_tag(key, options)
-    if key.is_a? Hash
-      options = key
-      key = nil
+  def papermill_upload_tag(key, options)
+    # asset_upload_tag(:my_key)
+    if key.nil? && (options[:assetable].is_a?(Symbol) || options[:assetable].is_a?(String))
+      key = options[:assetable]
+      options[:assetable] = nil
     end
+ 
     assetable = options[:assetable] || @template.instance_variable_get("@#{@object_name}")
     options = if assetable && (association = (assetable.class.papermill_associations[key] || assetable.class.papermill_associations[:papermill_assets]))
       association[:options].deep_merge(options)
+    elsif assetable.nil?
+      Papermill::PAPERMILL_DEFAULTS.deep_merge(options)
     else
-      raise Exception.new("Papermill: can't find #{key.to_s} association for #{assetable.class.to_s}.\n\n##{assetable.class.to_s.underscore}.rb\n#set either a catchall papermill association: \npapermill {your_option_hash}\n#or this specific association: \npapermill :#{key.to_s}, {your_option_hash}")
+      raise PapermillException.new("Can't find '#{key.to_s}' association for '#{assetable.class.to_s}'.\n\n##{assetable.class.to_s.underscore}.rb\nYou can take on of these actions: \n1. set either a catchall papermill association: 'papermill {your_option_hash}'\n2. or a specific association: 'papermill :#{key.to_s}, {your_option_hash}'")
     end
     assetable_id = assetable && (assetable.id || assetable.timestamp) || nil
-    assetable_type = assetable && assetable.class.to_s.underscore || nil
+    assetable_type = assetable && assetable.class.to_s || nil
     id = "papermill_#{assetable_type}_#{assetable_id}_#{key ? key.to_s : 'nil'}"
     if options[:thumbnail]
       w = options[:thumbnail][:width]  || options[:thumbnail][:height] && options[:thumbnail][:aspect_ratio] && (options[:thumbnail][:height] * options[:thumbnail][:aspect_ratio]).to_i || nil
@@ -59,14 +66,28 @@ module ActionView::Helpers::FormTagHelper
     end
     html = []
     
-    conditions = {:assetable_type => assetable.class.sti_name, :assetable_id => assetable_id}
-    conditions.merge!({:assetable_key => key.to_s}) if key
     asset_class = options[:class_name] && options[:class_name].to_s.constantize || association && association[:class] || PapermillAsset
-    create_url = @template.url_for(:controller => "/papermill", :action => "create", :escape => false, :asset_class => asset_class.to_s, :assetable_key => key, :assetable_id => assetable_id, :assetable_type => assetable_type, :gallery => (options[:gallery] != false), :thumbnail_style => (options[:thumbnail] && options[:thumbnail][:style]))
+    url_options = {
+      :controller => "/papermill", 
+      :action => "create", 
+      :escape => false, 
+      :asset_class => asset_class.to_s,
+      :assetable_key => key, 
+      :gallery => (options[:gallery] != false), 
+      :thumbnail_style => (options[:thumbnail] && options[:thumbnail][:style])
+    }
+    url_options.merge!({
+      :assetable_id => assetable_id, 
+      :assetable_type => assetable_type.underscore, 
+    }) if assetable
+    create_url = @template.url_for(url_options)
     if assetable && assetable.new_record? && !@timestamped
       html << @template.hidden_field(assetable.class.to_s.underscore, :timestamp, :value => assetable.timestamp)
       @timestamped = true
     end
+    
+    conditions = {:assetable_type => assetable_type, :assetable_id => assetable_id}
+    conditions.merge!({:assetable_key => key.to_s}) if key
     collection = asset_class.find(:all, :conditions => conditions, :order => "position")
     
     html << %{<div style="height: #{options[:swfupload][:button_height]}px;"><span id="browse_for_#{id}" class="swf_button"></span></div>}
@@ -105,15 +126,15 @@ class ActionView::Helpers::FormBuilder
   include ActionView::Helpers::FormTagHelper
   
   def assets_upload(key = nil, options = {})
-    papermill_upload_field_tag key, { :thumbnail => false }.update(options)
+    papermill_upload_tag key, { :thumbnail => false }.update(options)
   end
   def asset_upload(key = nil, options = {})
-    papermill_upload_field_tag key, { :gallery => false, :thumbnail => false }.update(options)
+    papermill_upload_tag key, { :gallery => false, :thumbnail => false }.update(options)
   end
   def images_upload(key = nil, options = {})
-    papermill_upload_field_tag key, options
+    papermill_upload_tag key, options
   end
   def image_upload(key = nil, options = {})
-    papermill_upload_field_tag key, { :gallery => false }.update(options)
+    papermill_upload_tag key, { :gallery => false }.update(options)
   end
 end

data/lib/papermill/papermill_asset.rb

@@ -4,7 +4,7 @@ require 'mime/types'
 require 'acts_as_list'
 
 class PapermillAsset < ActiveRecord::Base
-  acts_as_list :scope => 'assetable_key=\'#{assetable_key.to_s.simple_sql_sanitizer}\' AND assetable_id=#{assetable_id} AND assetable_type=\'#{assetable_type}\''
+  acts_as_list :scope => 'assetable_key'
   
   belongs_to :assetable, :polymorphic => true
   before_destroy :destroy_files

data/lib/papermill/papermill_module.rb

@@ -55,11 +55,12 @@ module Papermill
     	:prevent_swf_caching => "false"
       # See swfupload.js for details.
     },
-    :images_only => false,                    # set to true to forbid upload of anything else than images
-    :file_size_limit_mb => 10,                # file max size
-    :button_after_container => false,         # set to true to move the upload button below the container
-    
-    # DO NOT CHANGE THESE IN YOUR CLASSES. Only application wide (routes depend on it..)
+    :images_only => false,                          # set to true to forbid upload of anything else than images
+    :file_size_limit_mb => 10,                      # file max size
+    :button_after_container => false,               # set to true to move the upload button below the container
+
+    # DO NOT CHANGE THESE IN YOUR CLASSES. Only application wide (routes or associations may depend on it)
+    :base_association_name => 'assets',
     :alias_only => false,        # set to true so that only aliases are authorized in url/path
     :aliases => {
       # "example" => "100x100#",
@@ -90,7 +91,7 @@ module Papermill
     # 1. generic declaration =>
     #   declare associations with =>  papermill {my_option_hash}
     #   create assets with        =>  assets_upload(:my_key, {optional_option_hash})
-    #   access assets with        =>  assetable.papermill_assets(:key => :my_key)
+    #   access assets with        =>  assetable.assets(:my_key)
     #
     # 2. association declaration =>
     #   declare associations with =>  papermill :my_association, {my_option_hash}
@@ -103,40 +104,79 @@ module Papermill
         options = assoc_name
         assoc_name = :papermill_assets
       end
-      
+      base_association_name = PAPERMILL_DEFAULTS[:base_association_name]
+      if [base_association_name.to_s.singularize, base_association_name.to_s].include?(assoc_name.to_s)
+        raise PapermillException.new(
+        "':#{assoc_name.to_s}' and ':#{assoc_name.to_s.singularize}' are the default papermill associations name.\n" + 
+        "You can take one of these actions: \n" +
+        "1. use another association name instead of ':#{assoc_name.to_s}'. Eg: 'papermill :my_lovely_assets {my_options}'\n" + 
+        "2. change :base_association_name to something else than '#{base_association_name.to_s}' in the application-wide papermill option hash (change 'Papermill::OPTIONS[:base_association_name]' in your environment.rb)\n" + 
+        "3. use a catch-all 'papermill {your_options}' declaration instead of 'papermill :#{assoc_name.to_s} {your_options}'\n\n" + 
+        "If you want to take advantage of pluralized/singularized associations, always specify a singularizable name. Eg: 'my_assets' is ok, 'my_assix' is not ;). \n" + 
+        "(Anyway you can add exceptions in your config/initializer/inflections.rb)\n\n\n")
+      end
       @papermill_associations ||= {}
       begin
         class_name = options.delete(:class_name)
         asset_class = class_name && class_name.to_s.constantize || PapermillAsset
-      rescue
-        raise Exception.new("Papermill: can't find class #{class_name.to_s}.\n#{class_name.to_s} should be a subclass of PapermillAsset")
+      rescue NameError
+        raise PapermillException.new("'#{class_name.to_s}' class doesn't exist.\n'#{class_name.to_s}' should be a subclass of PapermillAsset")
       end
 
-      @papermill_associations.merge!({assoc_name => {:class => asset_class, :options => Papermill::PAPERMILL_DEFAULTS.deep_merge(options)}})
+      @papermill_associations.merge!({assoc_name.to_sym => {:class => asset_class, :options => Papermill::PAPERMILL_DEFAULTS.deep_merge(options)}})
+
       before_destroy :destroy_assets
       after_create :rebase_assets
-
-      define_method assoc_name do |*options|
-        klass = self.class.papermill_associations[assoc_name.to_sym][:class]
-        options = options.first || {}
-        if (options.is_a?(Symbol) || options.is_a?(String))
-          key = options
-          options = {}
-        else
-          key = nil
+      
+      # Defines for catch-all association :
+      # Assetable#assets(*options)
+      # Assetable#asset(*options)
+      unless self.respond_to?(base_association_name)
+        [base_association_name.to_s.singularize, base_association_name].each_with_index do |association, index|
+          define_method association do |*options|
+            # case Assetable#asset<s>(:key)
+            if (options.is_a?(Symbol) || options.is_a?(String))
+              key = options
+              options = {}
+            # case Assetable#asset<s>(:key, options = {})
+            elsif (options.first.is_a?(Symbol) || options.first.is_a?(String))
+              key = options.first
+              options = options[1..-1]
+            end
+            options = options.first || {}
+            conditions = {
+              :assetable_type => self.class.sti_name,
+              :assetable_id => self.id
+            }.merge(options.delete(:conditions) || {})
+            conditions.merge!({:assetable_key => key.to_s}) if key
+            hash = {
+              :conditions => conditions, 
+              :order => options.delete(:order) || "position ASC"
+            }.merge(options)
+            PapermillAsset.find((index == 0 ? :first : :all), hash)
+          end
+        end
+      end
+      
+      # Defines for declared association : 
+      # Assetable#assoc.singularize(*options)
+      # Assetable#assoc(*options)
+      unless assoc_name.to_sym == :papermill_assets
+        [assoc_name.to_s.singularize, assoc_name.to_s].each_with_index do |association, index|
+          define_method assoc_name do |*options|
+            options = options.first || {}
+            conditions = {
+              :assetable_type => self.class.sti_name,
+              :assetable_id => self.id,
+              :assetable_key => assoc_name.to_s
+            }.merge(options.delete(:conditions) || {})
+            hash = {
+              :conditions => conditions, 
+              :order => options.delete(:order) || "position ASC"
+            }.merge(options)
+            asset_class.find((index == 0 ? :first : :all), hash)
+          end
         end
-        conditions = {
-          :assetable_type => self.class.sti_name,
-          :assetable_id => self.id
-        }.merge(options.delete(:conditions) || {})
-        key ||= (assoc_name != :papermill_assets) && assoc_name.to_s
-        conditions.merge!({:assetable_key => key.to_s}) if key
-        
-        hash = {
-          :conditions => conditions, 
-          :order => options.delete(:order) || "position ASC"
-        }.merge(options)
-        asset_class.find(:all, hash)
       end
       
       class_eval <<-EOV

data/papermill.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{papermill}
-  s.version = "0.7.0"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Benoit B\303\251n\303\251zech"]
-  s.date = %q{2009-09-17}
+  s.date = %q{2009-09-23}
   s.description = %q{Paperclip Swfupload UploadHelper wrapper}
   s.email = %q{benoit.benezech@gmail.com}
   s.extra_rdoc_files = [

data/public/stylesheets/papermill.css

@@ -22,7 +22,7 @@
 .papermill-asset-container .progress { float:left; margin-top:6px; margin-left:5px; width:100px; }
 .papermill-asset-container .delete { float:left; margin-top:2px; margin-right:5px; }
 
-.papermill-asset-container.papermill-multiple-items { padding-left:10px; border-left:5px solid #EEE; min-height:40px; }
+.papermill-asset-container.papermill-multiple-items { padding-left:10px; border-left:5px solid #EEE; min-height:44px; }
 .papermill-asset-container.papermill-multiple-items li { cursor:row-resize; }
 .papermill-thumb-container.papermill-multiple-items li { cursor:move; }
 .papermill-asset-container.papermill-unique-item { padding-left:5px; min-height:22px; }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: papermill
 version: !ruby/object:Gem::Version 
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - "Benoit B\xC3\xA9n\xC3\xA9zech"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-17 00:00:00 +02:00
+date: 2009-09-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency