papermill 0.5.7

data/.gitignore

@@ -0,0 +1,5 @@
+.DS_Store
+log/*.log
+tmp/**/*
+config/database.yml
+db/*.sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 [Benoit Bénézech]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,94 @@
+= Papermill
+
+Asset management made easy.
+
+== Install the gem!
+
+  $ gem sources -a http://gems.github.com
+  $ sudo gem install BBenezech-papermill
+
+== Try the demo!
+  
+  $ sudo gem install sqlite3-ruby
+  $ rails -m http://gist.github.com/177714.txt papermill-example
+  $ cd papermill-example
+  $ ./script/server
+  $ GoTo localhost:3000 and try to create an article with assets but without title
+  
+== 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
+  @assetable.papermill_assets(:my_key)                  # data access in your view
+
+=== 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
+
+
+In both case, you can specify a PapermillAsset subclass to use with :class_name => MyPapermillAssetSubclass in the option hash
+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)
+It's up to you. You can use the first one only, the second only or both.
+
+See papermill_module.rb for the complete list of options.
+
+== Installation
+
+=== Once you've installed the gem, generate a migration and copy a couple of static assets:
+
+  # copy static assets and generate a migration
+  $ ./script/generate papermill PapermillMigration
+  $ rake db:migrate
+  
+=== In your assetable model:
+  
+  # You can set a catch-all papermill association : 
+  papermill :class_name => Asset
+  
+  # or create an association for the specific :my_gallery key
+  papermill :my_gallery,
+    :class_name => GalleryAsset,
+    :thumbnail => {
+        :width => 90,
+        :height => 30
+    }
+
+=== In your layout:
+
+  <%= papermill_stylesheet_tag %>
+  <%= papermill_javascript_tag :with_jquery => "no_conflict" %>
+  # you won't need :with_jquery if you use it already, obviously.
+  
+=== 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.each{ |image| image_tag image.url("100x100") }
+  @assetable.papermill_assets(:my_assets).each{ |asset| asset.url }
+  @assetable.papermill_assets(:my_other_asset).first.url
+
+Also see http://gist.github.com/177714.txt for more precises installation steps.
+Have a look at the API here http://rdoc.info/projects/BBenezech/papermill
+
+=== Translations:
+
+Papermill is fully I18n-able.
+Copy config/locales/papermill.yml to your root config/locale folder to modify any wording in a any locale.
+
+
+== Word of caution:
+
+Beta. Wait for gem 1.0.0 for the production ready thing.
+This is xNIX only (system("rm ...")).
+Rails 2.3
+
+
+Copyright (c) 2009 Benoit Bénézech, released under the MIT license

data/Rakefile

@@ -0,0 +1,69 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the papermill plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the papermill plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Papermill'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "papermill"
+    gemspec.summary = "Paperclip Swfupload UploadHelper wrapper"
+    gemspec.description = "Paperclip Swfupload UploadHelper wrapper"
+    gemspec.email = "benoit.benezech@gmail.com"
+    gemspec.homepage = "http://github.com/BBenezech/papermill"
+    gemspec.authors = ["Benoit Bénézech"]
+    gemspec.add_dependency('paperclip', '>= 2.1.2')
+    gemspec.add_dependency('mime-types', '>= 1.16')
+    gemspec.add_dependency('rsl-stringex', '>= 1.0.0')
+    gemspec.add_dependency('ryanb-acts-as-list', '>= 0.1.2')
+    gemspec.rubyforge_project = 'papermill' # This line would be new
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+# These are new tasks
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/the-perfect-gem/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.7

data/app/controllers/papermill_controller.rb

@@ -0,0 +1,78 @@
+class PapermillController < ApplicationController
+  
+  skip_before_filter :verify_authenticity_token
+
+  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
+
+      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("not-processed", :scope => "papermill"), :status => "500"
+    end
+  end
+
+  def destroy
+    @asset = PapermillAsset.find_by_id(params[:id])
+    render :update do |page|
+      if @asset && @asset.destroy
+        page << "jQuery('#papermill_asset_#{params[:id]}').remove()"
+      else
+        page << "jQuery('#papermill_asset_#{params[:id]}').show()"
+        page << %{ notify("#{t((@asset && "not-deleted" || "not-found"), :ressource => @asset.name, :scope => "papermill")}", error) }
+      end
+    end
+  end
+  
+  def update
+    @asset = PapermillAsset.find_by_id(params[:id])
+    render :update do |page|
+      if @asset && @asset.update(params)
+        page << %{ notify("#{t("updated", :ressource => @asset.name, :scope => "papermill")}", "notice") }
+      else
+        page << %{ notify("#{@asset && @asset.errors.full_messages.to_sentence || t("not-found", :ressource => params[:id].to_s, :scope => "papermill")}", "warning") }
+      end
+    end
+  end
+  
+  def edit
+    @asset = PapermillAsset.find params[:id]
+  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[: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]})
+    end
+    @asset = asset_class.new(params.reject{|key, value| !(PapermillAsset.columns.map(&:name)+["swfupload_file"]).include?(key.to_s)})
+    
+    if @asset.save
+      @old_asset.destroy if @old_asset
+      render :partial => "papermill/asset", :object => @asset, :locals => {:gallery => params[:gallery], :thumbnail_style => params[:thumbnail_style]}
+    else
+      render :text => message, :status => "500"
+    end
+  end
+  
+  def sort
+    params[:papermill_asset].each_with_index do |id, index|
+      PapermillAsset.find(id).update_attribute(:position, index + 1)
+    end
+    render :nothing => true
+  end
+end

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

@@ -0,0 +1,11 @@
+<%- dom_id = "papermill_asset_#{asset.id}" -%>
+<%- delete_link = %{<a onclick="if(confirm('#{escape_javascript I18n.t("delete-confirmation", :scope => :papermill, :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("delete", :scope => "papermill", :ressource => asset.name)}" src="/images/papermill/delete.png" alt="delete"/></a>} %>
+
+<li id="<%= dom_id %>" onDblClick="popup(jQuery(this).attr('rel')); return false;" rel="<%= edit_papermill_url(asset) %>" title="<%= t("#{thumbnail_style ? "thumbnail-" : ""}edit-title", :scope => "papermill", :ressource => asset.name) %>">
+	<%= delete_link %>
+	<%- if thumbnail_style -%>
+	  <%= render :partial => "papermill/thumbnail_asset", :object => asset, :locals => {:thumbnail_style => thumbnail_style} %>
+	<%- else -%>
+	  <%= render :partial => "papermill/raw_asset", :object => asset %>
+	<%- end -%>
+</li>

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

@@ -0,0 +1 @@
+<%= link_to(raw_asset.name, raw_asset.url, :class => "name") -%>

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

@@ -0,0 +1,6 @@
+<% if thumbnail_asset.image? %>
+  <span class="image"><%= image_tag(thumbnail_asset.url(thumbnail_style)) %></span>
+<% else %>
+  <span class="name" title="<%= thumbnail_asset.name %>"><%= truncate(thumbnail_asset.name, :length => 15) %></span>
+  <span class="infos"><%= thumbnail_asset.content_type[1] %></span>
+<% end %>

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

@@ -0,0 +1,5 @@
+<% if @asset.image? %>
+  <%= image_tag @asset.url %>
+<% else %>
+  <%= @asset.url %>
+<% end %>

data/config/locales/papermill.yml

@@ -0,0 +1,28 @@
+en:
+  papermill: 
+    not-processed: "Error/ressource not processed"
+    updated: "{{ressource}} updated"
+    not-deleted: "{{ressource}} could not be deleted"
+    not-found: "Asset #{{ressource}} not found"
+    edit-title: "" # You can use {{ressource}}
+    thumbnail-edit-title: ""
+    upload-button-wording: "Upload..."
+    delete: "Remove {{ressource}}"
+    delete-confirmation: "Delete '{{resource}}'?"
+    SWFUPLOAD_PENDING: "Pending..."
+    SWFUPLOAD_LOADING: "Loading..."
+    SWFUPLOAD_ERROR: "Something happened while loading" # + " <file_name> (<swfupload error message> [<error code>])"
+fr:
+  papermill:
+    not-processed: "Erreur/ressource non trouvée"
+    updated: "{{ressource}} mise à jour"
+    not-deleted: "{{ressource}} n'a pas pu être supprimée"
+    not-found: "Asset #{{ressource}} non trouvé"
+    edit-title: ""
+    thumbnail-edit-title: ""
+    upload-button-wording: "Charger.."
+    delete: "Supprimer {{ressource}}"
+    delete-confirmation: "Êtes-vous sûr de vouloir supprimer '{{resource}}' ?"
+    SWFUPLOAD_PENDING: "En attente..."
+    SWFUPLOAD_LOADING: "Chargement..."
+    SWFUPLOAD_ERROR: "Une erreur est survenue pendant le chargement de"

data/config/routes.rb

@@ -0,0 +1,4 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :papermill, :collection => { :sort => :post }
+  map.connect "#{Papermill::PAPERMILL_DEFAULTS[:papermill_prefix]}/#{Papermill::PAPERCLIP_INTERPOLATION_STRING.gsub(":id_partition", ":id0/:id1/:id2")}", :controller => "papermill", :action => "show"
+end

data/generators/papermill/USAGE

@@ -0,0 +1,3 @@
+script/generate papermill MyTableName
+  
+This will create the migration table.

data/generators/papermill/papermill_generator.rb

@@ -0,0 +1,22 @@
+class PapermillGenerator < Rails::Generator::NamedBase
+  attr_accessor :class_name, :migration_name
+  
+  def initialize(args, options = {})
+    super
+    @class_name = args[0]
+  end
+  
+  def manifest
+    @migration_name = file_name.camelize
+    FileUtils.cp_r(
+      Dir[File.join(File.dirname(__FILE__), '../../public')],
+      File.join(RAILS_ROOT),
+      :verbose => true
+    )
+
+    record do |m|
+      # Migration creation
+      m.migration_template "migrate/papermill_migration.rb.erb", "db/migrate", :migration_file_name => migration_name.underscore
+    end
+  end 
+end

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

@@ -0,0 +1,22 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :papermill_assets do |t|
+      t.string   :file_file_name
+      t.string   :file_content_type
+      t.integer  :file_file_size
+      t.integer  :position
+      t.text     :description
+      t.string   :copyright
+      t.string   :title
+      t.integer  :assetable_id
+      t.string   :assetable_type
+      t.string   :assetable_key
+      t.string   :type
+      t.timestamps
+    end
+  end
+  
+  def self.down
+    drop_table :papermill_assets
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init.rb"

data/installation-template.txt

@@ -0,0 +1,124 @@
+gem 'BBenezech-papermill', :lib => 'papermill'
+
+generate :papermill, "PapermillMigration"
+generate :scaffold, "article title:string"
+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 :image_gallery, :class_name => ImageAsset, :images_only => true, :thumbnail => {:width => 75, :height => 100}
+    # image_gallery association (set with define_method)
+  end
+END
+
+file "app/models/image_asset.rb", <<-END
+  class ImageAsset < PapermillAsset
+    validates_attachment_content_type :file, :content_type => ['image/jpeg', 'image/pjpeg', 'image/jpg', 'image/png', 'image/gif']
+  end
+END
+
+file "app/views/articles/edit.html.erb", <<-END
+<h1>Editing article</h1>
+<%= render :partial => "form" %>
+<%= link_to 'Show', @article %> |
+<%= link_to 'Back', articles_path %>
+END
+
+file "app/views/articles/new.html.erb", <<-END
+<h1>New article</h1>
+<%= render :partial => "form" %>
+<%= link_to 'Back', articles_path %>
+END
+
+file "app/views/articles/_form.html.erb", <<-END
+<% form_for(@article) do |f| %>
+  <%= f.error_messages %>
+  <p>
+    <%= f.label :title %><br />
+    <%= f.text_field :title %>
+  </p>
+  <p>
+    <%= f.label :image_gallery %><br />
+    <%= f.images_upload(:image_gallery) %>
+  </p>
+  <p>
+    <%= f.label :my_other_image %><br />
+    <%= f.image_upload(:my_other_image) %> 
+  </p>
+  <p>
+    <%= f.label :my_assets %><br />
+    <%= f.assets_upload(:my_assets) %>
+  </p>
+  <p>
+    <%= f.label :my_other_asset %><br />
+    <%= f.asset_upload(:my_other_asset) %>
+  </p>
+  <p>
+    <%= f.submit 'Send' %>
+  </p>
+<% end %>
+END
+
+
+file "app/views/articles/show.html.erb", <<-END
+<p>
+  <b>Title:</b>
+  <%=h @article.title %>
+</p>
+<br /><br />
+<b>@article.image_gallery.each :</b>
+<p>
+  <% @article.image_gallery.each do |image| %>
+    <%= link_to(image_tag(image.url("100x100#")), image.url) %>
+  <% end %>
+</p>
+<br /><br />
+<b>@article.papermill_assets(:my_other_image).first :</b>
+<p>
+  <% image = @article.papermill_assets(:my_other_image).first %>
+  <%= link_to(image_tag(image.url("100x100#")), image.url) if image %>
+</p>
+<br /><br />
+<b>@article.papermill_assets(:my_assets).each :</b>
+<p>
+  <ul>
+    <% @article.papermill_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>
+<p>
+  <% asset = @article.papermill_assets(:my_other_asset).first %>
+  <%= link_to(asset.name, asset.url) if asset %>
+</p>
+
+<%= link_to 'Edit', edit_article_path(@article) %> |
+<%= link_to 'Back', articles_path %>
+END
+
+
+file "app/views/layouts/application.html.erb", <<-END
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+    <title>Papermill Demo</title>
+    <%= stylesheet_link_tag 'scaffold' %>
+    <%= papermill_stylesheet_tag %>
+  </head>
+  <body>
+  <%= yield %>
+  </body>
+  <%= papermill_javascript_tag :with_jquery => true %>
+</html>
+END
+
+run "rm app/views/layouts/articles.html.erb"
+run "rm public/index.html"
+route "map.root :controller => 'articles'"