papermill 1.1.0 → 1.1.1

data/README.rdoc

@@ -1,39 +1,47 @@
 = Papermill 
 
-Asset management made easy, 10 minutes integration.
-All-you-can-eat glue around Polymorphic Paperclip table, SWFUpload & JQuery. 
-Associate any image or list of images with any model and any key. 
+
+
+* Asset management made easy, 10 minutes integration.
+* All-you-can-eat glue around Polymorphic Paperclip table, SWFUpload & JQuery. 
+* Associate any image or list of images with any model and any key. 
+
+== Install the gem
+  
+  sudo gem install papermill
+ 
+== Try the demo
+  
+  rails -m http://github.com/bbenezech/papermill/raw/master/demo.txt papermill-example
 
 === Out-of-the-box OPTIONAL compatibility with : 
 
-Formtastic          # use :as => :[image|asset](s)_upload
-JGrowl              # instead of alert for notifications
-FaceBox/Shadowbox   # instead of a pop_up for edit form
-Stringex            # (or any String#to_url) for asset filename/url generation
+* Formtastic          # use :as => :[image|asset](s)_upload
+* JGrowl              # instead of alert for notifications
+* FaceBox/Shadowbox   # instead of a pop_up for edit form
+* Stringex            # (or any String#to_url) for asset filename/url generation
 
 === Navigator minimal requirements: 
 
-IE6+, Flash 9+, Javascript ON. Check your audience.
+* IE6+
+* Flash 9+
+* Javascript ON. 
+
+Check your audience.
 
 === Server requirements:
 
-makes internal use of JQuery (but loaded in compatibility mode by default, compatible with Prototype/whatever... JRails not needed.)
-Rails 2.3 (rail's I18n, engine)
-Paperclip 2.3 branch (installed by default as a gem dependency, will be loaded internally if needed)
-Windows environnement :
+* Makes internal use of JQuery (but loaded in compatibility mode by default, compatible with Prototype/whatever... JRails not needed.)
+* Rails 2.3 (rail's I18n, engine)
+* Paperclip 2.3 branch (installed by default as a gem dependency, will be loaded internally if needed => You can require your own version of Paperclip)
+* Front web server serving static assets if present, and forwarding demand to rails if not. (Usually a no-brainer on any classic installation. Works with Webrick)
+
+
+=== Windows environnement :
+
   # Mime/Types library. Ex:
   config.gem "mime-types", :lib => "mime/types"
  
-Front web server serving static assets if present, and forwarding demand to rails if not. (Usually a no-brainer on any classic installation. Works with Webrick)
-
-== Install the gem
-  
-  $ sudo gem install papermill
- 
-== Try the demo
-  
-  $ rails -m http://github.com/bbenezech/papermill/raw/master/demo.txt papermill-example
-
 == Features
 
 Loads of them
@@ -68,36 +76,25 @@ Loads of them
 * :third_alias => {:geometry => '100:122', :my_other_keys => 'blblabla'}  # if you have a customed Paperclip::Thumbnail processor, you can pass any values you need.
 * Use them when you need them : my_asset.url(:big_alias)
 
-== Papermill comes in 2 flavors:
-
-=== Generic catch-all declaration
-
-  papermill options_hash                                # in your papermilled assetable model
-  @article.assets(:any_key, options_hash)               # data access
-
-=== Association specific declaration
-
-  papermill :my_association, options_hash               # in your papermilled assetable model
-  @article.my_association                               # data access
-
-== Usage:
-
 === Model declaration
 
 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 :mug_shot, other_options..
     papermill :diaporama, :class_name => ColorAsset, other_options..
   end
 
 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
@@ -105,6 +102,7 @@ color_asset.rb  # You should add columns to papermill_assets and use STI on Pape
 === Form helpers
 
 FormHelpers
+
   form_for @article do 
     f.image_upload  :cover_image, options_hash
     f.images_upload :illustrations, options_hash
@@ -113,6 +111,7 @@ FormHelpers
   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
@@ -121,13 +120,15 @@ Or with formtastic :
   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
-  
+
+For resources not linked to any assetable model :
+  image_upload_tag "#{current_organization.name}_logo"
+
 === Resource access
 
 With generic papermill association, Papermill generates an #assets(:key, *args) named_scope
@@ -135,13 +136,14 @@ With generic papermill association, Papermill generates an #assets(:key, *args)
   @article.assets(:illustrations, :order => "created_at DESC")
   @article.assets(:illustrations).red.first
   # etc.
-  
-With declarative papermill associations, Papermill generates an #<association_key>(*args) named_scope
+
+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"})
   # etc.
 
 Or for non-assetable resources : 
@@ -149,7 +151,7 @@ Or for non-assetable resources :
   ColorAsset.all.red
 
 === Using PapermillAsset
-  
+
   @asset = @entry.mug_shot.first
   image_tag @asset.url              # original
   image_tag @asset.url("100x>")
@@ -159,26 +161,32 @@ Or for non-assetable resources :
   @asset.path                       # original
   @asset.path("100x>")
   # etc.
-  
+
 == Installation
 
 === Once gem is installed :
 
-  # Generate migration :
-  $ ./script/generate papermill_table PapermillMigration
-  $ rake db:migrate
-  # 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:
+Generate the migration :
+  ./script/generate papermill_table PapermillMigration
+
+Edit its fields and migrate :
+  rake db:migrate
+
+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 see config/initializers/papermill.rb for the option hash.
+
+=== environment.rb:
+
   ...
   Rails::Initializer.run do |config|
     ...
     config.gem papermill
-    config.gem "mime-types", :lib => "mime/types"  # required for windows only
+    config.gem "mime-types", :lib => "mime/types"  # required for windows OS
   end
 
 === In your layout:
@@ -191,7 +199,7 @@ Or for non-assetable resources :
 
 Papermill is fully I18n-able.
 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
-
+  
 http://rubyonrails.org/images/rails.png

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.1.1

data/app/controllers/papermill_controller.rb

@@ -1,8 +1,4 @@
 class PapermillController < ApplicationController
-  # Create is protected because of the Ajax same origin policy. 
-  # Yet SwfUpload doesn't send the right header for request.xhr? to be true and thus fails to disable verify_authenticity_token automatically.
-  skip_before_filter :verify_authenticity_token, :only => [:create]
-  
   prepend_before_filter :load_asset, :only => [ "show", "destroy", "update", "edit" ]
   prepend_before_filter :load_assets, :only => [ "sort", "mass_delete", "mass_edit" ]
   

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

@@ -9,18 +9,23 @@ class <%= migration_name %> < ActiveRecord::Migration
       
       # Papermill fields (required)
       t.integer  :position          # sets are ordered by position
-      t.integer  :assetable_id      # Assetable
-      t.string   :assetable_type    # Assetable
-      t.string   :assetable_key     # Assetable sets
+      
+      t.belongs_to :assetable, :polymorphic => true
+      
+      t.string   :assetable_key
       t.string   :type              # STI
-      t.string   :title             # raw filename, without file extension, for your own use
+      t.string   :title             # filename not transformed, without file extension, for your own use
       
-      # Custom fields (optionnals)
+      # Example additionals fields (configure :mass_editable_fields/:editable_fields accordingly)
       t.string   :alt
       t.string   :copyright
       t.text     :description
       t.timestamps
-      
+    end
+    
+    change_table :papermill_assets do |t|
+      t.index [:assetable_type, :assetable_id, :assetable_key, :position]  
+      t.index [:assetable_key, :position]  # for non assetable assets
     end
   end
   

data/lib/papermill.rb

@@ -1,5 +1,7 @@
 I18n.load_path = [File.join(File.dirname(__FILE__), "../config/locales/papermill.yml")] + I18n.load_path
 require 'extensions'
+require 'papermill/flash_session_cookie_middleware.rb'
+
 Object.send :include, PapermillObjectExtensions
 Hash.send :include, PapermillHashExtensions
 File.send :include, PapermillFileExtensions
@@ -13,6 +15,7 @@ rescue LoadError
 end
 
 require 'paperclip' unless defined?(Paperclip)
+require 'papermill/papermill_paperclip_processor'
 require 'papermill/papermill'
 require 'papermill/papermill_asset'
 require 'papermill/form_builder'

data/lib/papermill/flash_session_cookie_middleware.rb

@@ -0,0 +1,16 @@
+require 'rack/utils'
+ 
+class FlashSessionCookieMiddleware
+  def initialize(app, session_key = '_session_id')
+    @app = app
+    @session_key = session_key
+  end
+ 
+  def call(env)
+    if env['HTTP_USER_AGENT'] =~ /^(Adobe|Shockwave) Flash/
+      params = ::Rack::Request.new(env).params
+      env['HTTP_COOKIE'] = [ @session_key, params[@session_key] ].join('=').freeze unless params[@session_key].nil?
+    end
+    @app.call(env)
+  end
+end

data/lib/papermill/form_builder.rb

@@ -109,7 +109,7 @@ module ActionView::Helpers::FormTagHelper
     html[:upload_button] = %{<div id="#{id}-button-wrapper" class="papermill-button-wrapper" style="height: #{options[:swfupload][:button_height]}px;"><span id="browse_for_#{id}" class="swf_button"></span></div>}
     html[:container] = @template.content_tag(:div, :id => id, :class => "#{(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] }
-    } 
+    }
     
     if options[:gallery]
       html[:dashboard] = {}
@@ -136,6 +136,10 @@ module ActionView::Helpers::FormTagHelper
     
     @template.content_for :papermill_inline_js do %{
         new SWFUpload({
+          post_params: {
+            "#{ActionController::Base.session_options[:key]}": "#{@template.cookies[ActionController::Base.session_options[:key]]}",
+            "authenticity_token": "#{@template.form_authenticity_token}"
+          },
           upload_id: "#{id}",
           upload_url: "#{@template.escape_javascript create_url}",
           file_types: "#{options[:images_only] ? '*.jpg;*.jpeg;*.png;*.gif' : ''}",
@@ -153,6 +157,7 @@ module ActionView::Helpers::FormTagHelper
         });
       }
   	end
+    
 	  %{<div class="papermill">#{@timestamp_field.to_s + options[:form_helper_elements].map{|element| html[element] || ""}.join("\n")}</div>}
   end
 end

data/lib/papermill/papermill.rb

@@ -24,16 +24,20 @@ module Papermill
       after_create :rebase_assets
       has_many :papermill_assets, :as => "Assetable", :dependent => :destroy
 
-      define_method assoc_name do |*options|
-        scope = PapermillAsset.scoped(:conditions => {:assetable_id => self.id, :assetable_type => self.class.base_class.name})
-        if assoc_name != Papermill::options[:base_association_name]
-          scope = scope.scoped(:conditions => { :assetable_key => assoc_name.to_s })
-        elsif options.first && !options.first.is_a?(Hash)
-          scope = scope.scoped(:conditions => { :assetable_key => options.shift.to_s.nie })
+      [assoc_name, Papermill::options[:base_association_name].to_sym].uniq.each do |assoc|
+        define_method assoc do |*options|
+          scope = PapermillAsset.scoped(:conditions => {:assetable_id => self.id, :assetable_type => self.class.base_class.name})
+          if assoc != Papermill::options[:base_association_name]
+            scope = scope.scoped(:conditions => { :assetable_key => assoc.to_s })
+          elsif options.first && !options.first.is_a?(Hash)
+            scope = scope.scoped(:conditions => { :assetable_key => options.shift.to_s.nie })
+          end
+          scope = scope.scoped(options.shift) if options.first
+          scope
         end
-        scope = scope.scoped(options.shift) if options.first
-        scope
       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
     end
     
     def inherited(subclass)

data/lib/papermill/papermill_asset.rb

@@ -1,9 +1,10 @@
 class PapermillAsset < ActiveRecord::Base
   
   before_destroy :destroy_files
-  before_create :set_position  
+  before_create :set_position
   
   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}"
   
@@ -12,9 +13,9 @@ class PapermillAsset < ActiveRecord::Base
   validates_attachment_presence :file
   
   belongs_to :assetable, :polymorphic => true
-  default_scope :order => 'assetable_key ASC, position ASC'
+  default_scope :order => 'assetable_type, assetable_id, assetable_key, position'
   
-  named_scope :key, lambda { |assetable_key| { :conditions => ['assetable_key = ?', assetable_key] }}
+  named_scope :key, lambda { |assetable_key| { :conditions => ['assetable_key = ?', assetable_key.to_s] }}
   
   def Filedata=(data)
     data.content_type = data.get_content_type # SWFUpload content-type fix
@@ -27,7 +28,7 @@ class PapermillAsset < ActiveRecord::Base
   
   def create_thumb_file(style_name)
     FileUtils.mkdir_p File.dirname(file.path(style_name))
-    FileUtils.mv(Paperclip::Thumbnail.make(file, self.class.compute_style(style_name)).path, 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
@@ -100,7 +101,7 @@ class PapermillAsset < ActiveRecord::Base
   end
   
   def set_position
-    self.position ||= PapermillAsset.last(:conditions => { :assetable_key => assetable_key, :assetable_type => assetable_type, :assetable_id => assetable_id } ).try(:position).to_i + 1
+    self.position ||= PapermillAsset.maximum(:position, :conditions => { :assetable_type => assetable_type, :assetable_id => assetable_id, :assetable_key => assetable_key } ).to_i + 1
   end
   
   def destroy_files

data/lib/papermill/papermill_helper.rb

@@ -9,10 +9,10 @@ module PapermillHelper
   # If you loaded jQuery and need to load only jQueryUI, call papermill_javascript_tag(:with_jqueryui_only => true)
   def papermill_javascript_tag(options = {})
     html = []
-    if options[:with_jquery] || options[:with_jqueryui]
+    if options[:with_jquery] || options[:with_jqueryui_only]
       html << %{<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js" type="text/javascript"></script>} if options[:with_jquery]
       html << %{<script src="http://ajax.googleapis.com/ajax/libs/jqueryui/1.7.2/jquery-ui.min.js" type="text/javascript"></script>} if options[:with_jquery] || options[:with_jqueryui_only]
-      html << %{<script type="text/javascript">jQuery.noConflict();</script>} if options[:with_jquery] == "no_conflict"
+      html << %{<script type="text/javascript">jQuery.noConflict();</script>} if options[:with_jquery].to_s == "no_conflict"
     end
     html << %{<script type="text/javascript">}
     ["SWFUPLOAD_PENDING", "SWFUPLOAD_LOADING"].each do |js_constant|

data/lib/papermill/papermill_paperclip_processor.rb

@@ -0,0 +1,58 @@
+module Paperclip
+
+  # Handles thumbnailing images that are uploaded.
+  class PapermillPaperclipProcessor < Thumbnail
+    
+    attr_reader :crop_h, :crop_w, :crop_x, :crop_y, :copyright
+    
+    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
+      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>
+        
+        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
+          @target_geometry = Geometry.parse(options[:geometry]) 
+          @crop_w ||= @target_geometry.try(:width).to_i
+          @crop_h ||= @target_geometry.try(:height).to_i
+        end
+      end
+      super
+    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
+    end
+    
+    def crop_command
+      if @crop_h || @crop_x
+        " -crop '%dx%d+%d+%d'" % [ @crop_w, @crop_h, @crop_x, @crop_y ].map(&:to_i)
+      end
+    end
+  end
+  
+  
+end

data/test/papermill_test.rb

@@ -76,12 +76,24 @@ class PapermillTest < Test::Unit::TestCase
     assert_equal @article.my_assets.map(&:id), [3,4]
     assert_equal @article.my_assets(:order => "position DESC").map(&:id), [4,3]
     assert_equal @article.my_assets(:order => "position DESC", :limit => 1).map(&:id), [4]
+    
+    assert_equal @article.assets(:my_assets).map(&:id), [3,4]
+    assert_equal @article.assets(:my_assets, :order => "position DESC").map(&:id), [4,3]
+    assert_equal @article.assets(:my_assets, :order => "position DESC", :limit => 1).map(&:id), [4]
+    
+    assert_equal @article.papermill_assets.key(:my_assets).map(&:id), [3,4]
+    assert_equal @article.papermill_assets.key(:my_assets).all(:order => "position DESC").map(&:id), [4,3]
+    assert_equal @article.papermill_assets.key(:my_assets).all(:order => "position DESC", :limit => 1).map(&:id), [4]
   end
   
-  def test_namedscope_for_global_associations_and_default_order
+  def test_namedscope_for_global_associations
     assert_equal @article.assets(:asset1).map(&:id), [2,1]
     assert_equal @article.assets(:asset1, :order => "position DESC").map(&:id), [1,2]
     assert_equal @article.assets(:asset1, :order => "position DESC", :limit => 1).map(&:id), [1]
+    
+    assert_equal @article.papermill_assets.key(:asset1).map(&:id), [2,1]
+    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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: papermill
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - "Benoit B\xC3\xA9n\xC3\xA9zech"
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-19 00:00:00 +01:00
+date: 2009-11-25 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,11 +57,13 @@ files:
 - install.rb
 - lib/extensions.rb
 - lib/papermill.rb
+- lib/papermill/flash_session_cookie_middleware.rb
 - lib/papermill/form_builder.rb
 - lib/papermill/papermill.rb
 - lib/papermill/papermill_asset.rb
 - lib/papermill/papermill_helper.rb
 - lib/papermill/papermill_options.rb
+- lib/papermill/papermill_paperclip_processor.rb
 - public/.DS_Store
 - public/papermill/README
 - public/papermill/images/background.png
@@ -110,7 +112,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.4
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Paperclip Swfupload UploadHelper wrapper