peterpunk-merb_paperclip 0.9.3

data/README

@@ -0,0 +1,47 @@
+=Paperclip
+
+Paperclip is intended as an easy file attachment library for ActiveRecord. The intent behind it was to keep setup as easy as possible and to treat files as much like other attributes as possible. This means they aren't saved to their final locations on disk, nor are they deleted if set to nil, until ActiveRecord::Base#save is called. It manages validations based on size and presence, if required. It can transform its assigned image into thumbnails if needed, and the prerequisites are as simple as installing ImageMagick (which, for most modern Unix-based systems, is as easy as installing the right packages). Attached files are saved to the filesystem and referenced in the browser by an easily understandable specification, which has sensible and useful defaults.
+
+See the documentation for the +has_attached_file+ method for options.
+
+==Usage
+
+In your model:
+
+  class User < ActiveRecord::Base
+    has_attached_file :avatar, :styles => { :medium => "300x300>", :thumb => "100x100>" }
+  end
+
+In your migrations:
+
+  class AddAvatarColumnsToUser < ActiveRecord::Migration
+    def self.up
+      add_column :users, :avatar_file_name, :string
+      add_column :users, :avatar_content_type, :string
+      add_column :users, :avatar_file_size, :integer
+    end
+
+    def self.down
+      remove_column :users, :avatar_file_name
+      remove_column :users, :avatar_content_type
+      remove_column :users, :avatar_file_size
+    end
+  end
+
+In your edit and new views:
+
+  <% form_for :user, @user, :url => user_path, :html => { :multipart => true } do |form| %>
+    <%= form.file_field :avatar %>
+  <% end %>
+
+In your controller:
+
+  def create
+    @user = User.create( params[:user] )
+  end
+
+In your show view:
+
+  <%= image_tag @user.avatar.url %>
+  <%= image_tag @user.avatar.url(:medium) %>
+  <%= image_tag @user.avatar.url(:thumb) %>

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'merb-core/version'
+require 'merb-core/tasks/merb_rake_helper'
+
+NAME = "merb_paperclip"
+GEM_VERSION = "0.9.4"
+AUTHOR = "Jeremy Durham"
+EMAIL = "jeremydurham@gmail.com"
+HOMEPAGE = "http://rubyforge.org/projects/merb_paperclip/"
+SUMMARY = "A Merb plugin that is essentially a port of Jon Yurek's paperclip"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb', '>= 0.9.4')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,spec}/**/*")
+  
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the plugin locally"
+task :install => [:package] do
+  sh %{#{sudo} gem install #{install_home} pkg/#{NAME}-#{GEM_VERSION} --no-update-sources}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("#{NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end
+
+namespace :jruby do
+
+  desc "Run :package and install the resulting .gem with jruby"
+  task :install => :package do
+    sh %{#{sudo} jruby -S gem install #{install_home} pkg/#{NAME}-#{GEM_VERSION}.gem --no-rdoc --no-ri}
+  end
+
+end

data/lib/generators/paperclip_generator.rb

@@ -0,0 +1,53 @@
+module Merb::Generators
+
+  class PaperclipGenerator < NamespacedGenerator
+    
+    def self.source_root
+      File.dirname(__FILE__) / 'templates'
+    end
+    
+    desc <<-DESC
+      Generators a paperclip migration
+    DESC
+    
+    first_argument  :name, :required => true, :desc => "model name"
+    second_argument :attachments, :required => true, :as => :array, :default => [], :desc => "space separated list of fields"
+
+    template :paperclip do
+      source(File.dirname(__FILE__) / 'templates' / 'file_name.rb')
+      destination("schema/migrations/#{migration_file_name}.rb")
+    end
+    
+    def version
+      format("%03d", current_migration_nr + 1)
+    end
+    
+    def migration_file_name
+      names = migration_attachments
+      "#{version}_add_attachments_#{names.join("_")}_to_#{class_name.underscore}"
+    end
+    
+    def migration_name
+      names = migration_attachments
+      "add_attachments_#{names.join("_")}_to_#{class_name.underscore}".classify
+    end
+
+    protected
+    
+    def migration_attachments      
+      names = attachments.map(&:underscore)
+      attachments.length == 1 ? names : names[0..-2] + ["and", names[-1]]
+    end
+    
+    def destination_directory
+      File.join(destination_root, 'schema', 'migrations')
+    end
+
+    def current_migration_nr
+      Dir["#{destination_directory}/*"].map{|f| File.basename(f).match(/^(\d+)/)[0].to_i  }.max.to_i
+    end
+    
+  end
+
+  add :paperclip, PaperclipGenerator
+end

data/lib/generators/templates/file_name.rb

@@ -0,0 +1,17 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+<% attachments.each do |attachment| -%>
+    add_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_file_name, :string
+    add_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_content_type, :string
+    add_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_file_size, :integer
+<% end -%>
+  end
+
+  def self.down
+<% attachments.each do |attachment| -%>
+    remove_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_file_name
+    remove_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_content_type
+    remove_column :<%= class_name.underscore.camelize.tableize %>, :<%= attachment %>_file_size
+<% end -%>
+  end
+end

data/lib/merb_paperclip.rb

@@ -0,0 +1,19 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+  dependency "activerecord"
+
+  # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
+  Merb::Plugins.config[:merb_paperclip] = {
+    :chickens => false
+  }
+  
+  Merb::BootLoader.before_app_loads do    
+    require File.join(File.dirname(__FILE__), "paperclip")  
+    Merb.add_generators(File.join(File.dirname(__FILE__), 'generators', 'paperclip_generator'))
+  end
+  
+  Merb::BootLoader.after_app_loads do
+  end
+  
+  Merb::Plugins.add_rakefiles "merb_paperclip/merbtasks"
+end

data/lib/merb_paperclip/merbtasks.rb

@@ -0,0 +1,38 @@
+def obtain_class
+  class_name = ENV['CLASS'] || ENV['class']
+  raise "Must specify CLASS" unless class_name
+  @klass = Object.const_get(class_name)
+end
+
+def obtain_attachments
+  name = ENV['ATTACHMENT'] || ENV['attachment']
+  raise "Class #{@klass.name} has no attachments specified" unless @klass.respond_to?(:attachment_definitions)
+  if !name.blank? && @klass.attachment_definitions.keys.include?(name)
+    [ name ]
+  else
+    @klass.attachment_definitions.keys
+  end
+end
+
+namespace :paperclip do
+  desc "Regenerates thumbnails for a given CLASS (and optional ATTACHMENT)"
+  task :refresh => :environment do
+    klass     = obtain_class
+    names     = obtain_attachments
+    instances = klass.find(:all)
+    
+    puts "Regenerating thumbnails for #{instances.length} instances of #{klass.name}:"
+    instances.each do |instance|
+      names.each do |name|
+        result = if instance.send("#{ name }?")
+          instance.send(name).reprocess!
+          instance.send(name).save
+        else
+          true
+        end
+        print result ? "." : "x"; $stdout.flush
+      end
+    end
+    puts " Done."
+  end
+end

data/lib/paperclip.rb

@@ -0,0 +1,246 @@
+# Paperclip allows file attachments that are stored in the filesystem. All graphical
+# transformations are done using the Graphics/ImageMagick command line utilities and
+# are stored in Tempfiles until the record is saved. Paperclip does not require a
+# separate model for storing the attachment's information, instead adding a few simple
+# columns to your table.
+#
+# Author:: Jon Yurek
+# Copyright:: Copyright (c) 2008 thoughtbot, inc.
+# License:: MIT License (http://www.opensource.org/licenses/mit-license.php)
+#
+# Paperclip defines an attachment as any file, though it makes special considerations
+# for image files. You can declare that a model has an attached file with the
+# +has_attached_file+ method:
+#
+#   class User < ActiveRecord::Base
+#     has_attached_file :avatar, :styles => { :thumb => "100x100" }
+#   end
+#
+#   user = User.new
+#   user.avatar = params[:user][:avatar]
+#   user.avatar.url
+#   # => "/users/avatars/4/original_me.jpg"
+#   user.avatar.url(:thumb)
+#   # => "/users/avatars/4/thumb_me.jpg"
+#
+# See the +has_attached_file+ documentation for more details.
+
+require 'tempfile'
+require 'paperclip/upfile'
+require 'paperclip/iostream'
+require 'paperclip/geometry'
+require 'paperclip/thumbnail'
+require 'paperclip/storage'
+require 'paperclip/attachment'
+
+# The base module that gets included in ActiveRecord::Base. See the
+# documentation for Paperclip::ClassMethods for more useful information.
+module Paperclip
+
+  VERSION = "2.1.2"
+
+  class << self
+    # Provides configurability to Paperclip. There are a number of options available, such as:
+    # * whiny_thumbnails: Will raise an error if Paperclip cannot process thumbnails of 
+    #   an uploaded image. Defaults to true.
+    # * image_magick_path: Defines the path at which to find the +convert+ and +identify+ 
+    #   programs if they are not visible to Merb the system's search path. Defaults to 
+    #   nil, which uses the first executable found in the search path.
+    def options
+      @options ||= {
+        :whiny_thumbnails  => true,
+        :image_magick_path => nil
+      }
+    end
+
+    def path_for_command command #:nodoc:
+      path = [options[:image_magick_path], command].compact
+      File.join(*path)
+    end
+
+    def included base #:nodoc:
+      base.extend ClassMethods
+    end
+  end
+
+  class PaperclipError < StandardError #:nodoc:
+  end
+
+  class NotIdentifiedByImageMagickError < PaperclipError #:nodoc:
+  end
+
+  module ClassMethods
+    # +has_attached_file+ gives the class it is called on an attribute that maps to a file. This
+    # is typically a file stored somewhere on the filesystem and has been uploaded by a user. 
+    # The attribute returns a Paperclip::Attachment object which handles the management of
+    # that file. The intent is to make the attachment as much like a normal attribute. The 
+    # thumbnails will be created when the new file is assigned, but they will *not* be saved 
+    # until +save+ is called on the record. Likewise, if the attribute is set to +nil+ is 
+    # called on it, the attachment will *not* be deleted until +save+ is called. See the 
+    # Paperclip::Attachment documentation for more specifics. There are a number of options 
+    # you can set to change the behavior of a Paperclip attachment:
+    # * +url+: The full URL of where the attachment is publically accessible. This can just
+    #   as easily point to a directory served directly through Apache as it can to an action
+    #   that can control permissions. You can specify the full domain and path, but usually
+    #   just an absolute path is sufficient. The leading slash must be included manually for 
+    #   absolute paths. The default value is "/:class/:attachment/:id/:style_:filename". See
+    #   Paperclip::Attachment#interpolate for more information on variable interpolaton.
+    #     :url => "/:attachment/:id/:style_:basename:extension"
+    #     :url => "http://some.other.host/stuff/:class/:id_:extension"
+    # * +default_url+: The URL that will be returned if there is no attachment assigned. 
+    #   This field is interpolated just as the url is. The default value is 
+    #   "/:class/:attachment/missing_:style.png"
+    #     has_attached_file :avatar, :default_url => "/images/default_:style_avatar.png"
+    #     User.new.avatar_url(:small) # => "/images/default_small_avatar.png"
+    # * +styles+: A hash of thumbnail styles and their geometries. You can find more about 
+    #   geometry strings at the ImageMagick website 
+    #   (http://www.imagemagick.org/script/command-line-options.php#resize). Paperclip
+    #   also adds the "#" option (e.g. "50x50#"), which will resize the image to fit maximally 
+    #   inside the dimensions and then crop the rest off (weighted at the center). The 
+    #   default value is to generate no thumbnails.
+    # * +default_style+: The thumbnail style that will be used by default URLs. 
+    #   Defaults to +original+.
+    #     has_attached_file :avatar, :styles => { :normal => "100x100#" },
+    #                       :default_style => :normal
+    #     user.avatar.url # => "/avatars/23/normal_me.png"
+    # * +whiny_thumbnails+: Will raise an error if Paperclip cannot process thumbnails of an
+    #   uploaded image. This will ovrride the global setting for this attachment. 
+    #   Defaults to true. 
+    # * +storage+: Chooses the storage backend where the files will be stored. The current
+    #   choices are :filesystem and :s3. The default is :filesystem. Make sure you read the
+    #   documentation for Paperclip::Storage::Filesystem and Paperclip::Storage::S3
+    #   for backend-specific options.
+    def has_attached_file name, options = {}
+      include InstanceMethods
+
+      write_inheritable_attribute(:attachment_definitions, {}) if attachment_definitions.nil?
+      attachment_definitions[name] = {:validations => []}.merge(options)
+
+      after_save :save_attached_files
+      before_destroy :destroy_attached_files
+
+      define_method name do |*args|
+        a = attachment_for(name)
+        (args.length > 0) ? a.to_s(args.first) : a
+      end
+
+      define_method "#{name}=" do |file|
+        attachment_for(name).assign(file)
+      end
+
+      define_method "#{name}?" do
+        attachment_for(name).file?
+      end
+
+      validates_each(name) do |record, attr, value|
+        value.send(:flush_errors) unless value.valid?
+      end
+    end
+
+    # Places ActiveRecord-style validations on the size of the file assigned. The
+    # possible options are:
+    # * +in+: a Range of bytes (i.e. +1..1.megabyte+),
+    # * +less_than+: equivalent to :in => 0..options[:less_than]
+    # * +greater_than+: equivalent to :in => options[:greater_than]..Infinity
+    # * +message+: error message to display, use :min and :max as replacements
+    def validates_attachment_size name, options = {}
+      attachment_definitions[name][:validations] << lambda do |attachment, instance|
+        unless options[:greater_than].nil?
+          options[:in] = (options[:greater_than]..(1/0)) # 1/0 => Infinity
+        end
+        unless options[:less_than].nil?
+          options[:in] = (0..options[:less_than])
+        end
+        
+        if attachment.file? && !options[:in].include?(instance[:"#{name}_file_size"].to_i)
+          min = options[:in].first
+          max = options[:in].last
+          
+          if options[:message]
+            options[:message].gsub(/:min/, min.to_s).gsub(/:max/, max.to_s)
+          else
+            "file size is not between #{min} and #{max} bytes."
+          end
+        end
+      end
+    end
+
+    # Adds errors if thumbnail creation fails. The same as specifying :whiny_thumbnails => true.
+    def validates_attachment_thumbnails name, options = {}
+      attachment_definitions[name][:whiny_thumbnails] = true
+    end
+
+    # Places ActiveRecord-style validations on the presence of a file.
+    def validates_attachment_presence name, options = {}
+      attachment_definitions[name][:validations] << lambda do |attachment, instance|
+        unless attachment.file?
+          options[:message] || "must be set."
+        end
+      end
+    end
+    
+    # Places ActiveRecord-style validations on the content type of the file assigned. The
+    # possible options are:
+    # * +content_type+: Allowed content types.  Can be a single content type or an array.
+    #   Each type can be a String or a Regexp. It should be noted that Internet Explorer uploads
+    #   files with content_types that you may not expect. For example, JPEG images are given
+    #   image/pjpeg and PNGs are image/x-png, so keep that in mind when determining how you match.
+    #   Allows all by default.
+    # * +message+: The message to display when the uploaded file has an invalid content type.
+    def validates_attachment_content_type name, options = {}
+      attachment_definitions[name][:validations] << lambda do |attachment, instance|
+        valid_types = [options[:content_type]].flatten
+        
+        unless attachment.original_filename.nil?
+          unless options[:content_type].blank?
+            content_type = instance[:"#{name}_content_type"]
+            unless valid_types.any?{|t| t === content_type }
+              options[:message] || "is not one of the allowed file types."
+            end
+          end
+        end
+      end
+    end
+
+    # Returns the attachment definitions defined by each call to has_attached_file.
+    def attachment_definitions
+      read_inheritable_attribute(:attachment_definitions)
+    end
+
+  end
+
+  module InstanceMethods #:nodoc:
+    def attachment_for name
+      @attachments ||= {}
+      @attachments[name] ||= Attachment.new(name, self, self.class.attachment_definitions[name])
+    end
+    
+    def each_attachment
+      self.class.attachment_definitions.each do |name, definition|
+        yield(name, attachment_for(name))
+      end
+    end
+
+    def save_attached_files
+      logger.info("[paperclip] Saving attachments.")
+      each_attachment do |name, attachment|
+        attachment.send(:save)
+      end
+    end
+
+    def destroy_attached_files
+      logger.info("[paperclip] Deleting attachments.")
+      each_attachment do |name, attachment|
+        attachment.send(:queue_existing_for_delete)
+        attachment.send(:flush_deletes)
+      end
+    end
+  end
+
+end
+
+# Set it all up.
+if Object.const_defined?("ActiveRecord")
+  ActiveRecord::Base.send(:include, Paperclip)
+  File.send(:include, Paperclip::Upfile)
+end