dm-paperclip 2.1.2

data/LICENSE

@@ -0,0 +1,26 @@
+
+LICENSE
+
+The MIT License
+
+Copyright (c) 2008 Jon Yurek and thoughtbot, inc.
+
+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.textile

@@ -0,0 +1,103 @@
+h1. DataMapper Paperclip
+
+DM-Paperclip is a port of Thoughtbot's Paperclip plugin to work with DataMapper 0.9.  This plugin is fully compatible with
+the original ActiveRecord-oriented Paperclip.  You could take an existing ActiveRecord database and use it with DataMapper.
+The module also includes updates validation handling and automatic including of the necessary 'property' fields into
+your model.
+
+To use it within your models, you need to ensure the three database fields are included.  They are {name}_file_name,
+{name}_content_type, and {name}_file_size.  The first two are strings, the final _file_size column is an integer. So
+if your user model has an avatar field, then you would add avatar_file_name, avatar_content_type, and avatar_file_size.
+
+As with the original Paperclip plugin, it allows processing of thumbnails at the time the record is saved though ImageMagick.
+It processes the thumbnails through the command-line applications instead of using RMagick.
+
+See the documentation for the +has_attached_file+ method for options.
+
+h2. Code
+
+The code DM-Paperclip is available at Github:
+
+  git clone git://github.com/krobertson/paperclip.git
+
+It is regularly updated to keep in sync with the latest from Thoughtbot.
+
+Releases are tagged within the repository and versioned the same as the original model.  You can also get the latest release
+packaged as a gem through Rubyforge:
+
+  sudo gem install dm-paperclip
+
+h2. Usage
+
+In your model:
+
+  class User
+    include DataMapper::Resource
+    include Paperclip::Resource
+    property :id, Integer, :serial => true
+    property :username, String
+    has_attached_file :avatar,
+                      :styles => { :medium => "300x300>",
+                                   :thumb => "100x100>" }
+  end
+
+Your database will need to add three columns, +avatar_file_name+ (varchar), +avatar_content_type+ (varchar), and
++avatar_file_size+ (integer).  You can either add these manually, auto-migrate, or use the following migration:
+
+  migration( 1, :add_user_paperclip_fields ) do
+  up do
+      modify_table :users do
+        add_column :avatar_file_name, "varchar(255)"
+        add_column :avatar_content_type, "varchar(255)"
+        add_column :avatar_file_size, "integer"
+      end
+    end
+    down do
+      modify_table :users do
+        drop_columns :avatar_file_name, :avatar_content_type, :avatar_file_size
+      end
+    end
+  end
+
+In your edit and new views:
+
+  <% form_for @user, { :action => url(:user), :multipart => true } do %>
+    <%= file_field :name => 'avatar' %>
+  <% end %>
+
+In your controller:
+
+  def create
+    ...
+    @user.avatar = params[:avatar]
+  end
+
+In your show view:
+
+  <%= image_tag @user.avatar.url %>
+  <%= image_tag @user.avatar.url(:medium) %>
+  <%= image_tag @user.avatar.url(:thumb) %>
+
+The following validations are available:
+
+  validates_attachment_presence :avatar
+  validates_attachment_content_type :avatar, :content_type => "image/png"
+  validates_attachment_size :avatar, :in => 1..10240
+  validates_attachment_thumbnails :avatar
+
+In order to use validations, you must have loaded the 'dm-validations' gem into your app
+(available as a part of dm-more).  If the gem isn't loaded before DM-Paperclip is loaded,
+the validation methods will be excluded.  You will also need to include DataMapper::Validate
+into your mode:
+
+  class User
+    include DataMapper::Resource
+    include DataMapper::Validate
+    include Paperclip::Resource
+    property :id, Integer, :serial => true
+    property :username, String
+    has_attached_file :avatar,
+                      :styles => { :medium => "300x300>",
+                                   :thumb => "100x100>" }
+    validates_attachment_size :avatar, :in => 1..5120
+  end

data/Rakefile

@@ -0,0 +1,99 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/gempackagetask'
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+require 'dm-validations'
+require 'dm-paperclip'
+
+desc 'Default: run unit tests.'
+task :default => [:clean, :test]
+
+# Test tasks
+desc 'Test the DM-Paperclip library.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'dm-paperclip'
+  t.pattern = 'test/**/test_*.rb'
+  t.verbose = true
+end
+
+# Console 
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r dm-validations -r dm-migrations -r ./lib/dm-paperclip.rb"
+end
+
+# Rdoc
+desc 'Generate documentation for the paperclip plugin.'
+Rake::RDocTask.new(:doc) do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = 'DM-Paperclip'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.textile')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+ 
+# Code coverage
+task :coverage do
+  system("rm -fr coverage")
+  system("rcov test/test_*.rb")
+  system("open coverage/index.html")
+end
+
+# Clean house
+desc 'Clean up files.'
+task :clean do |t|
+  FileUtils.rm_rf "doc"
+  FileUtils.rm_rf "coverage"
+  FileUtils.rm_rf "tmp"
+  FileUtils.rm_rf "pkg"
+  FileUtils.rm_rf "log"
+end
+
+spec = Gem::Specification.new do |s| 
+  s.name              = "dm-paperclip"
+  s.version           = Paperclip::VERSION
+  s.author            = "Ken Robertson"
+  s.email             = "ken@invalidlogic.com jyurek@thoughtbot.com"
+  s.homepage          = "http://invalidlogic.com/dm-paperclip/"
+  s.platform          = Gem::Platform::RUBY
+  s.summary           = "File attachments as attributes for DataMapper, based on the original Paperclip by Jon Yurek at Thoughtbot"
+  s.files             = FileList["README.textile",
+                                 "LICENSE",
+                                 "Rakefile",
+                                 "init.rb",
+                                 "{lib,tasks,test}/**/*"].to_a
+  s.require_path      = "lib"
+  s.test_files        = FileList["test/**/test_*.rb"].to_a
+  s.rubyforge_project = "dm-paperclip"
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = ["README.textile"]
+  s.rdoc_options << '--line-numbers' << '--inline-source'
+  s.requirements << "ImageMagick"
+  s.requirements << "data_mapper"
+end
+ 
+Rake::GemPackageTask.new(spec) do |pkg| 
+  pkg.need_tar = true 
+end
+
+WIN32 = (PLATFORM =~ /win32|cygwin/) rescue nil
+SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+desc "Install #{spec.name} #{spec.version}"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install pkg/#{spec.name}-#{spec.version} --no-update-sources", :verbose => false
+end
+
+desc "Release new version"
+task :release => [:test, :gem] do
+  require 'rubygems'
+  require 'rubyforge'
+  r = RubyForge.new
+  r.login
+  r.add_release spec.rubyforge_project,
+                spec.name,
+                spec.version,
+                File.join("pkg", "#{spec.name}-#{spec.version}.gem")
+end

data/init.rb

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__), 'lib', 'dm-paperclip')
+File.send :include, Paperclip::Upfile

data/lib/dm-paperclip.rb

@@ -0,0 +1,229 @@
+# 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 File.join(File.dirname(__FILE__), 'dm-paperclip', 'upfile')
+require File.join(File.dirname(__FILE__), 'dm-paperclip', 'iostream')
+require File.join(File.dirname(__FILE__), 'dm-paperclip', 'geometry')
+require File.join(File.dirname(__FILE__), 'dm-paperclip', 'thumbnail')
+require File.join(File.dirname(__FILE__), 'dm-paperclip', 'storage')
+require File.join(File.dirname(__FILE__), 'dm-paperclip', 'attachment')
+
+# Only include validations if dm-validations is loaded
+require File.join(File.dirname(__FILE__), 'dm-paperclip', 'validations') unless defined?(DataMapper::Validate).nil?
+
+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 Rails 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
+  end
+
+  class PaperclipError < StandardError #:nodoc:
+  end
+
+  class NotIdentifiedByImageMagickError < PaperclipError #:nodoc:
+  end
+
+  module Resource
+    def self.included(base)
+      base.extend Paperclip::ClassMethods
+    end
+  end
+
+  module ClassMethods
+    @@attachment_definitions = {}
+
+    # +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"
+    # * +path+: The location of the repository of attachments on disk. This can be coordinated
+    #   with the value of the +url+ option to allow files to be saved into a place where Apache
+    #   can serve them without hitting your app. Defaults to 
+    #   ":merb_root/public/:class/:attachment/:id/:style_:filename". 
+    #   By default this places the files in the app's public directory which can be served 
+    #   directly. If you are using capistrano for deployment, a good idea would be to 
+    #   make a symlink to the capistrano-created system directory from inside your app's 
+    #   public directory.
+    #   See Paperclip::Attachment#interpolate for more information on variable interpolaton.
+    #     :path => "/var/app/attachments/:class/:id/:style/:filename"
+    # * +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. 
+    def has_attached_file name, options = {}
+      include InstanceMethods
+
+      @@attachment_definitions = {} if @@attachment_definitions.nil?
+      @@attachment_definitions[name] = {:validations => []}.merge(options)
+      
+      property_options = options.delete_if { |k,v| ![ :public, :protected, :private, :accessor, :reader, :writer ].include?(key) }
+
+      property "#{name}_file_name".to_sym, String, property_options
+      property "#{name}_content_type".to_sym, String, property_options
+      property "#{name}_file_size".to_sym, Integer, property_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).original_filename.blank?
+      end
+
+      unless defined?(DataMapper::Validate).nil?
+        add_validator_to_context(opts_from_validator_args([name]), [name], Paperclip::Validate::CopyAttachmentErrors)
+      end
+    end
+
+    unless defined?(DataMapper::Validate).nil?
+
+    # 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(*fields)
+      opts = opts_from_validator_args(fields)
+      add_validator_to_context(opts, fields, Paperclip::Validate::SizeValidator)
+    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(*fields)
+      opts = opts_from_validator_args(fields)
+      add_validator_to_context(opts, fields, Paperclip::Validate::RequiredFieldValidator)
+    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.  Allows all by default.
+    # * +message+: The message to display when the uploaded file has an invalid content type.
+    def validates_attachment_content_type(*fields)
+      opts = opts_from_validator_args(fields)
+      add_validator_to_context(opts, fields, Paperclip::Validate::ContentTypeValidator)
+    end
+
+    end
+
+    # Returns the attachment definitions defined by each call to has_attached_file.
+    def attachment_definitions
+      @@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
+      each_attachment do |name, attachment|
+        attachment.send(:save)
+      end
+    end
+
+    def destroy_attached_files
+      each_attachment do |name, attachment|
+        attachment.queue_existing_for_delete
+        attachment.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