papermill 0.5.7

data/lib/core_extensions.rb

@@ -0,0 +1,25 @@
+module HashExtensions
+  def deep_merge(hash)
+    target = dup
+    hash.keys.each do |key|
+      if hash[key].is_a? Hash and self[key].is_a? Hash
+        target[key] = target[key].deep_merge(hash[key])
+        next
+      end
+      target[key] = hash[key]
+    end
+    target
+  end
+end
+module StringExtensions
+  def simple_sql_sanitizer
+    gsub(/\\/, '\&\&').gsub(/'/, "''")
+  end
+end
+
+module ObjectExtensions
+  # Nil if empty.
+  def nie
+    self.blank? ? nil : self
+  end
+end

data/lib/papermill/form_builder.rb

@@ -0,0 +1,101 @@
+class ActionView::Helpers::FormBuilder
+  
+  def assets_upload(key = nil, options = {})
+    papermill_upload_field key, { :thumbnail => false }.update(options)
+  end
+  def asset_upload(key = nil, options = {})
+    papermill_upload_field key, { :gallery => false, :thumbnail => false }.update(options)
+  end
+  def images_upload(key = nil, options = {})
+    papermill_upload_field key, options
+  end
+  def image_upload(key = nil, options = {})
+    papermill_upload_field key, { :gallery => false }.update(options)
+  end
+
+  private
+  def papermill_upload_field(key, options = {})
+    if key.is_a? Hash
+      options = key
+      key = nil
+    end
+    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)
+    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}")
+    end
+    assetable_id = assetable && (assetable.id || assetable.timestamp) || nil
+    assetable_type = assetable && assetable.class.to_s.underscore || 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
+      h = options[:thumbnail][:height] || options[:thumbnail][:width]  && options[:thumbnail][:aspect_ratio] && (options[:thumbnail][:width]  / options[:thumbnail][:aspect_ratio]).to_i || nil
+      options[:thumbnail][:style] ||= (w || h) && "#{w || options[:thumbnail][:max_width]}x#{h || options[:thumbnail][:max_height]}>" || "original"
+      if options[:thumbnail][:inline_css]
+        size = []
+        size << "width:#{w}px" if w
+        size << "height:#{h}px" if h
+        size = size.join("; ")
+        @template.content_for :papermill_inline_css do
+          inline_css = ["\n"]
+          if options[:gallery]
+            vp = options[:gallery][:vpadding].to_i
+            hp = options[:gallery][:hpadding].to_i
+            vm = options[:gallery][:vmargin].to_i
+            hm = options[:gallery][:hmargin].to_i
+            b  = options[:gallery][:border_thickness].to_i
+            gallery_width = (options[:gallery][:width] || w) && "width:#{options[:gallery][:width] || options[:gallery][:columns]*(w+(hp+hm+b)*2)}px;" || ""
+            gallery_height = (options[:gallery][:height] || h) && "#{options[:gallery][:autogrow] ? "" : "min-"}height:#{options[:gallery][:height] || options[:gallery][:lines]*(h+(vp+vm+b)*2)}px;" || ""
+            inline_css << %{##{id} { #{gallery_width} #{gallery_height} }}
+            inline_css << %{##{id} li { margin:#{vm}px #{hm}px; border-width:#{b}px; padding:#{vp}px #{hp}px; #{size}; }}
+          else
+            inline_css << %{##{id}, ##{id} li { #{size} }}
+          end
+          inline_css << %{##{id} .name { width:#{w || "100"}px; }}
+          inline_css.join("\n")
+        end
+      end
+    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]))
+    if assetable && assetable.new_record? && !@timestamped
+      html << self.hidden_field(:timestamp, :value => assetable.timestamp)
+      @timestamped = true
+    end
+    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>}
+    html << @template.content_tag(:ul, :id => id, :class => "papermill #{(options[:thumbnail] ? "papermill-thumb-container" : "papermill-asset-container")} #{(options[:gallery] ? "papermill-multiple-items" : "papermill-unique-item")}") {
+      @template.render :partial => "papermill/asset", :collection => collection, :locals => { :thumbnail_style => (options[:thumbnail] && options[:thumbnail][:style]) }
+    }
+    @template.content_for :papermill_inline_js do
+      %{
+        #{%{$("##{id}").sortable({update:function(){jQuery.ajax({async:true, data:jQuery(this).sortable('serialize'), dataType:'script', type:'post', url:'#{@template.controller.send("sort_papermill_url")}'})}})} if options[:gallery]}
+        new SWFUpload({
+          upload_id: "#{id}",
+          upload_url: "#{@template.escape_javascript create_url}",
+          file_size_limit: "#{options[:file_size_limit_mb].megabytes}",
+          file_types: "#{options[:images_only] ? '*.jpg;*.jpeg;*.png;*.gif' : ''}",
+          file_types_description: "#{options[:thumbnail] ? 'Images' : 'Files'}",
+          file_queue_limit: "#{!options[:gallery] ? '1' : '0'}",
+          file_queued_handler: Upload.file_queued,
+          file_dialog_complete_handler: Upload.file_dialog_complete,
+          upload_start_handler: Upload.upload_start,
+          upload_progress_handler: Upload.upload_progress,
+          upload_error_handler: Upload.upload_error,
+          upload_success_handler: Upload.upload_success,
+          upload_complete_handler: Upload.upload_complete,
+          button_placeholder_id : "browse_for_#{id}",
+          #{options[:swfupload].map{ |key, value| ["false", "true"].include?(value.to_s) ? "#{key.to_s}: #{value.to_s}" : "#{key.to_s}: '#{value.to_s}'"  }.compact.join(", ")}
+        });
+      }
+  	end
+  	html.reverse! if options[:button_after_container]
+	  html.join("\n")
+  end
+end

data/lib/papermill/papermill_asset.rb

@@ -0,0 +1,54 @@
+require 'stringex'
+require 'paperclip'
+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}\''
+  
+  belongs_to :assetable, :polymorphic => true
+  before_destroy :destroy_files
+
+  Paperclip::Attachment.interpolations[:escaped_basename] = proc do |attachment, style|
+    Paperclip::Attachment.interpolations[:basename].call(attachment, style).to_url
+  end
+  
+  has_attached_file :file,
+    :path => "#{Papermill::PAPERMILL_DEFAULTS[:public_root]}/#{Papermill::PAPERMILL_DEFAULTS[:papermill_prefix]}/#{Papermill::PAPERCLIP_INTERPOLATION_STRING}",
+    :url => "/#{Papermill::PAPERMILL_DEFAULTS[:papermill_prefix]}/#{Papermill::PAPERCLIP_INTERPOLATION_STRING}"
+  validates_attachment_presence :file
+
+  def swfupload_file=(data)
+    data.content_type = MIME::Types.type_for(data.original_filename).to_s
+    self.file = data
+  end
+  
+  def id_partition
+    ("%09d" % self.id).scan(/\d{3}/).join("/")
+  end
+  
+  def name
+    file_file_name
+  end
+  
+  def size
+    file_file_size
+  end
+
+  def url(style = nil)
+    file.url(style && CGI::escape(style.to_s))
+  end
+  
+  def content_type
+    file_content_type && file_content_type.split("/")
+  end
+  
+  def image?
+    content_type && content_type.first == "image" && content_type[1]
+  end
+  
+  def destroy_files
+    system "rm -rf #{Papermill::papermill_interpolated_path({":id_partition" => self.id_partition}, ':id_partition')}/"
+    true
+  end
+end

data/lib/papermill/papermill_helper.rb

@@ -0,0 +1,48 @@
+module PapermillHelper
+  
+  # Sets all the javascript needed for papermill.
+  # If you already loaded jQuery and JQueryUI, call papermill_javascript_tag
+  # If you don't use jQuery or use some other library, call papermill_javascript_tag(:with_jquery => "no_conflict")
+  # If you want to rely on this helper to load jQuery/jQueryUI and use it, call papermill_javascript_tag(:with_jquery => true)
+  # If you loaded jQuery and need to load only jQueryUI, call papermill_javascript_tag(:with_jqueryui_only => true)
+  # If you changed the location of papermill.js, you'll need to set :root_folder (defaults to "javascripts")
+  def papermill_javascript_tag(options = {})
+    html = []
+    root_folder = options[:path] || "javascripts"
+    if options[:with_jquery] || options[:with_jqueryui]
+      html << %{<script src="http://www.google.com/jsapi"></script>}
+      html << %{<script type="text/javascript">}
+      html << %{google.load("jquery", "1");} if options[:with_jquery]
+      html << %{google.load("jqueryui", "1");} if options[:with_jquery] || options[:with_jqueryui_only]
+      html << %{jQuery.noConflict();} if options[:with_jquery] == "no_conflict"
+      html << %{</script>}
+    end
+    html << %{<script src="http://swfupload.googlecode.com/svn/swfupload/tags/swfupload_v2.2.0_core/swfupload.js"></script>}
+    html << %{<script type="text/javascript">\n//<![CDATA[}
+    ["SWFUPLOAD_PENDING", "SWFUPLOAD_LOADING", "SWFUPLOAD_ERROR"].each do |js_constant|
+      html << %{var #{js_constant} = "#{I18n.t(js_constant, :scope => "papermill")}";}
+    end
+    html << %{//]]>\n</script>}
+    html << javascript_include_tag("/#{root_folder}/papermill", :cache => "swfupload-papermill")
+    unless @content_for_papermill_inline_js.blank?
+      html << '<script type="text/javascript">jQuery(document).ready(function() {'
+      html << @content_for_papermill_inline_js
+      html << '});</script>'
+    end
+    html.join("\n")
+  end
+  
+  # Sets the css tags needed for papermill.
+  # If you changed the location of papermill.css, you'll need to set :root_folder (defaults to "stylesheets")
+  def papermill_stylesheet_tag(options = {})
+    html = []
+    root_folder = options[:path] || "stylesheets"
+    html << stylesheet_link_tag("/#{root_folder}/papermill")
+    unless @content_for_papermill_inline_css.blank?
+      html << %{<style type="text/css">}
+      html << @content_for_papermill_inline_css
+      html << %{</style>}
+    end
+    html.join("\n")
+  end
+end

data/lib/papermill/papermill_module.rb

@@ -0,0 +1,177 @@
+module Papermill
+  
+  # Override these defaults : 
+  #  - in your application (environment.rb, ..) => in your [environment, development, production].rb file with Papermill::OPTIONS = {thumbnails => {..}, :gallery => {..}, etc. }
+  #  - in your class                            => papermill <assoc_name>, :class_name => MySTIedPapermillAssetSubClass, thumbnails => {<my_thumbnail_parameters>}, :gallery => {<my_gallery_parameters>}, etc.
+  #  - in your helper call                      => images_upload :my_gallery, {thumbnails => {..}, :gallery => {..}, etc. }
+  # Options will cascade as you expect them to.
+
+  # sizes (widths, paddings, etc..) are CSS pixel values.
+  PAPERMILL_DEFAULTS = {
+    :thumbnail => {
+      # you clearly want to override these two values in your templates. 
+      # the rest is very optionnal and will "cascade" nicely
+      :width => 100,              # Recommended if :gallery[:width] is nil
+      :height => 100,             # Recommended if :gallery[:height] is nil
+      # set :width OR :height to nil to use aspect_ratio value. Remember that 4/3 == 1 => Use : 4.0/3
+      :aspect_ratio => nil,
+      :max_width  => 1000,
+      :max_height => 1000,
+      # You can override computed ImageMagick transformation strings that defaults to "#{:width}x#{:height}>"
+      # Note that this is required if PAPERMILL_DEFAULTS[:alias_only] is true
+      :style => nil,
+      # set to false if you don't want inline CSS
+      :inline_css => true
+    },
+    # gallery
+    :gallery => {
+      # if thumbnail.inline_css is true, css will be generated automagically with these values. Great for quick scaffolding, and complete enough for real use. 
+      :width => nil,               # overrides calculated width. Recommended if :thumbnail[:width] is nil.
+      :height => nil,              # overrides calculated height. Recommended if :thumbnail[:height] is nil.
+      :columns => 8,               # number of columns. If thumbnail.width has a value, sets a width for the gallery, calculated from thumbnails width multiplied by :columns.
+      :lines => 2,                 # number of default lines. (height will autogrow) If thumbnail.height has a value, sets a min-height for the gallery, calculated from thumbnails height multiplied by :lines
+      :vpadding => 0,              # vertical padding around thumbnails
+      :hpadding => 0,              # horizontal padding around thumbnails
+      :vmargin => 1,               # vertical margin around thumbnails
+      :hmargin => 1,               # horizontal margin around thumbnails
+      :border_thickness => 2,      # border around thumbnails
+      :autogrow => false           # sets a min-height instead of height for the gallery
+    },
+    # options passed on to SWFUpload. To remove an option when overriding, set it to nil.
+    :swfupload => {
+      # !!! Will only work if the swf file comes from the server to where the files are sent. (Flash same origin security policy)
+      :flash_url => '/flashs/swfupload.swf',
+      # You can use upload-blank.png with your own wording or upload.png with default "upload" wording (looks nicer)
+      :button_image_url => '/images/papermill/upload-blank.png',
+      :button_width     => 61,
+      :button_height    => 22,
+      # Wording and CSS processed through an Adobe Flash styler. Result is terrible. Feel free to put a CSS button overlayed directly on the SWF button. See swfupload website.
+      :button_text => %{<span class="button-text">#{I18n.t("upload-button-wording", :scope => :papermill)}</span>},
+    	:button_text_style => %{.button-text { color: red; font-size: 12pt; font-weight: bold; }},
+    	:button_disabled => "false",
+      :button_text_top_padding => 4,
+    	:button_text_left_padding => 4,
+    	:debug => "false",
+    	: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..)
+    :alias_only => false,        # set to true so that only aliases are authorized in url/path
+    :aliases => {
+      # "example" => "100x100#",
+    },
+    # path to the root of your public directory
+    :public_root => ":rails_root/public",
+    # added to :public_root as the root folder for all papermill items
+    :papermill_prefix => "system/papermill"
+  }.deep_merge( Papermill.const_defined?("OPTIONS") ? Papermill::OPTIONS : {} )
+  
+  PAPERCLIP_INTERPOLATION_STRING = ":id_partition/:style/:escaped_basename.:extension"
+  
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  def self.papermill_interpolated_path(replacements_pairs, up_to)
+    replacements_pairs = {"other" => "*", ":rails_root" => RAILS_ROOT}.merge(replacements_pairs)
+    a = "#{PAPERMILL_DEFAULTS[:public_root]}/#{PAPERMILL_DEFAULTS[:papermill_prefix]}/#{PAPERCLIP_INTERPOLATION_STRING}".split("/")
+    "#{a[0..(up_to && a.index(up_to) || -1)].map{ |s| s.starts_with?(':') ? (replacements_pairs[s] || replacements_pairs['other'] || s) : s }.join('/')}"
+  end
+  
+  module ClassMethods
+    attr_reader :papermill_associations
+    
+    # papermill comes in 2 flavors:
+    #
+    # 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)
+    #
+    # 2. association declaration =>
+    #   declare associations with =>  papermill :my_association, {my_option_hash}
+    #   create assets with        =>  assets_upload(my_association, {optional_option_hash})
+    #   access assets with        =>  assetable.my_association
+    #
+    # In both case, you can specify a PapermillAsset subclass to use with :class_name => MyPapermillAssetSubclass in the option hash
+    def papermill(assoc_name = :papermill_assets, options = {})
+      if assoc_name.is_a? Hash
+        options = assoc_name
+        assoc_name = :papermill_assets
+      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")
+      end
+
+      @papermill_associations.merge!({assoc_name => {: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
+        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
+        include Papermill::InstanceMethods
+      EOV
+    end
+    
+    def inherited(subclass)
+      subclass.instance_variable_set("@papermill_associations", @papermill_associations)
+      super
+    end
+  end
+
+  module InstanceMethods
+    attr_writer :timestamp
+    def timestamp
+      @timestamp ||= "-#{(Time.now.to_f * 1000).to_i.to_s[4..-1]}"
+    end
+  
+    private
+    
+    def destroy_assets
+      PapermillAsset.find(:all, :conditions => {:assetable_id => self.id, :assetable_type => self.class.sti_name}).each do |asset|
+        asset.destroy
+      end
+    end
+    
+    def rebase_assets
+      PapermillAsset.find(:all, :conditions => {:assetable_id => self.timestamp, :assetable_type => self.class.sti_name}).each do |asset|
+        if asset.created_at < 2.hours.ago
+          asset.destroy
+        else
+          asset.update_attribute(:assetable_id, self.id)
+        end
+      end
+    end
+  end
+end

data/papermill.gemspec

@@ -0,0 +1,93 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{papermill}
+  s.version = "0.5.7"
+
+  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-08}
+  s.description = %q{Paperclip Swfupload UploadHelper wrapper}
+  s.email = %q{benoit.benezech@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "app/controllers/papermill_controller.rb",
+     "app/views/papermill/_asset.html.erb",
+     "app/views/papermill/_raw_asset.html.erb",
+     "app/views/papermill/_thumbnail_asset.html.erb",
+     "app/views/papermill/edit.html.erb",
+     "config/locales/papermill.yml",
+     "config/routes.rb",
+     "generators/papermill/USAGE",
+     "generators/papermill/papermill_generator.rb",
+     "generators/papermill/templates/migrate/papermill_migration.rb.erb",
+     "init.rb",
+     "install.rb",
+     "installation-template.txt",
+     "lib/core_extensions.rb",
+     "lib/papermill.rb",
+     "lib/papermill/form_builder.rb",
+     "lib/papermill/papermill_asset.rb",
+     "lib/papermill/papermill_helper.rb",
+     "lib/papermill/papermill_module.rb",
+     "papermill.gemspec",
+     "public/.DS_Store",
+     "public/flashs/swfupload.swf",
+     "public/images/.DS_Store",
+     "public/images/papermill/.DS_Store",
+     "public/images/papermill/background.png",
+     "public/images/papermill/container-background.jpg",
+     "public/images/papermill/delete.png",
+     "public/images/papermill/upload-blank.png",
+     "public/images/papermill/upload.png",
+     "public/javascripts/papermill.js",
+     "public/stylesheets/papermill.css",
+     "rails/init.rb",
+     "tasks/papermill_tasks.rake",
+     "test/papermill_test.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/BBenezech/papermill}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{papermill}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Paperclip Swfupload UploadHelper wrapper}
+  s.test_files = [
+    "test/papermill_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<paperclip>, [">= 2.1.2"])
+      s.add_runtime_dependency(%q<mime-types>, [">= 1.16"])
+      s.add_runtime_dependency(%q<rsl-stringex>, [">= 1.0.0"])
+      s.add_runtime_dependency(%q<ryanb-acts-as-list>, [">= 0.1.2"])
+    else
+      s.add_dependency(%q<paperclip>, [">= 2.1.2"])
+      s.add_dependency(%q<mime-types>, [">= 1.16"])
+      s.add_dependency(%q<rsl-stringex>, [">= 1.0.0"])
+      s.add_dependency(%q<ryanb-acts-as-list>, [">= 0.1.2"])
+    end
+  else
+    s.add_dependency(%q<paperclip>, [">= 2.1.2"])
+    s.add_dependency(%q<mime-types>, [">= 1.16"])
+    s.add_dependency(%q<rsl-stringex>, [">= 1.0.0"])
+    s.add_dependency(%q<ryanb-acts-as-list>, [">= 0.1.2"])
+  end
+end