cropped_paperclip 0.1.0

data/lib/cropped_paperclip/version.rb

@@ -0,0 +1,3 @@
+module CroppedPaperclip
+  VERSION = "0.1.0"
+end

data/lib/paperclip/geometry_transformation.rb

@@ -0,0 +1,80 @@
+module Paperclip
+
+  class TransformationError < RuntimeError; end
+  class StyleError < RuntimeError; end
+  
+  class Geometry
+    
+    # Returns a new Geometry object with the the same dimensions as this but with no modifier.
+    def without_modifier
+      Geometry.new(self.width, self.height)
+    end
+    
+    # Returns the dimensions that would result if a thumbnail was created by transforming this geometry into that geometry.
+    # Its purpose is to mimic imagemagick conversions. Used like so:
+    #    file_geometry.transformed_by(style_geometry)
+    # it returns the size of the thumbnail image you would get by applying that rule.
+    # This saves us having to go back to the file, which is expensive with S3.
+    # We understand all the Imagemagick geometry arguments described at http://www.imagemagick.org/script/command-line-processing.php#geometry
+    # including both '^' and paperclip's own '#' modifier.
+    #
+    def transformed_by (other)
+      other = Geometry.parse(other) unless other.is_a? Geometry
+      # if the two geometries are similar, or the destination geometry is a fixed size, the resulting dimensions are fixed
+      return other.without_modifier if self =~ other || ['#', '!', '^'].include?(other.modifier)
+      # otherwise, we apply the transformation
+      raise TransformationError, "geometry is not transformable without both width and height" if self.height == 0 or self.width == 0
+      case other.modifier
+      when '>'
+        (other.width < self.width || other.height < self.height) ? scaled_to_fit(other) : self
+      when '<'
+        (other.width > self.width && other.height > self.height) ? scaled_to_fit(other) : self
+      when '%'
+        scaled_by(other)
+      when '@'
+        scaled_by(other.width * 100 / (self.width * self.height))
+      else
+        scaled_to_fit(other)
+      end
+    end
+    alias :* :transformed_by
+    
+    # Tests whether two geometries are identical in dimensions and modifier. 
+    def == (other)
+      self.to_s == other.to_s
+    end
+    
+    # Tests whether two geometries have the same dimensions, ignoring modifier.
+    def =~ (other)
+      self.height.to_i == other.height.to_i && self.width.to_i == other.width.to_i
+    end
+    
+    # Scales this geometry to fit within that geometry.
+    def scaled_to_fit(other)
+      if (other.width > 0 && other.height == 0)
+        Geometry.new(other.width, self.height * other.width / self.width)
+      elsif (other.width == 0 && other.height > 0)
+        Geometry.new(self.width * other.height / self.height, other.height)
+      else
+        ratio = Geometry.new( other.width / self.width, other.height / self.height )
+        if ratio.square?
+          other.without_modifier
+        elsif ratio.horizontal?
+          Geometry.new(ratio.height * self.width, other.height)
+        else
+          Geometry.new(other.width, ratio.width * self.height)
+        end
+      end
+    end
+    
+    # Scales this geometry by the percentage(s) specified in that geometry.
+    def scaled_by(other)
+      other = Geometry.new("#{other}%") unless other.is_a? Geometry
+      if other.height > 0
+        Geometry.new(self.width * other.width / 100, self.height * other.height / 100)
+      else
+        Geometry.new(self.width * other.width / 100, self.height * other.width / 100)
+      end
+    end
+  end
+end

data/lib/paperclip/validators/attachment_height_validator.rb

@@ -0,0 +1,89 @@
+require 'active_model/validations/numericality'
+
+module Paperclip
+  module Validators
+    class AttachmentHeightValidator < ActiveModel::Validations::NumericalityValidator
+      AVAILABLE_CHECKS = [:less_than, :less_than_or_equal_to, :greater_than, :greater_than_or_equal_to]
+
+      def initialize(options)
+        extract_options(options)
+        super
+      end
+
+      def validate_each(record, attr_name, value)
+        attachment = record.send(attr_name)
+        dimensions = Paperclip::Geometry.from_file(attachment.queued_for_write[:original])
+        value = dimensions.height.to_i
+        options.slice(*AVAILABLE_CHECKS).each do |option, option_value|
+          option_value = extract_option_value(option, option_value)
+          unless value.send(CHECKS[option], option_value)
+            error_message_key = options[:in] ? :in_between : option
+            record.errors.add(attr_name, error_message_key, filtered_options(value).merge(
+              :min => min_value,
+              :max => max_value
+            ))
+          end
+        end
+      end
+
+      def check_validity!
+        unless (AVAILABLE_CHECKS + [:in]).any? { |argument| options.has_key?(argument) }
+          raise ArgumentError, "You must pass either :less_than, :greater_than, or :in to the validator"
+        end
+      end
+
+    private
+
+      def extract_options(options)
+        if range = options[:in]
+          if !options[:in].respond_to?(:call)
+            options[:less_than_or_equal_to] = range.max
+            options[:greater_than_or_equal_to] = range.min
+          else
+            options[:less_than_or_equal_to] = range
+            options[:greater_than_or_equal_to] = range
+          end
+        end
+      end
+
+      def extract_option_value(option, option_value)
+        if option_value.is_a?(Range)
+          if [:less_than, :less_than_or_equal_to].include?(option)
+            option_value.max
+          else
+            option_value.min
+          end
+        else
+          option_value
+        end
+      end
+
+      def min_value
+        value = options[:greater_than_or_equal_to] || options[:greater_than]
+        value = value.min if value.respond_to?(:min)
+        value
+      end
+
+      def max_value
+        value = options[:less_than_or_equal_to] || options[:less_than]
+        value = value.max if value.respond_to?(:max)
+        value
+      end
+    end
+
+    module HelperMethods
+      # Places ActiveRecord-style validations on the pixel height 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
+      # * +if+: A lambda or name of an instance method. Validation will only
+      #   be run if this lambda or method returns true.
+      # * +unless+: Same as +if+ but validates if lambda or method returns false.
+      def validates_attachment_height(*attr_names)
+        validates_with AttachmentHeightValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/paperclip/validators/attachment_width_validator.rb

@@ -0,0 +1,89 @@
+require 'active_model/validations/numericality'
+
+module Paperclip
+  module Validators
+    class AttachmentWidthValidator < ActiveModel::Validations::NumericalityValidator
+      AVAILABLE_CHECKS = [:less_than, :less_than_or_equal_to, :greater_than, :greater_than_or_equal_to]
+
+      def initialize(options)
+        extract_options(options)
+        super
+      end
+
+      def validate_each(record, attr_name, value)
+        attachment = record.send(attr_name)
+        dimensions = Paperclip::Geometry.from_file(attachment.queued_for_write[:original])
+        value = dimensions.width.to_i
+        options.slice(*AVAILABLE_CHECKS).each do |option, option_value|
+          option_value = extract_option_value(option, option_value)
+          unless value.send(CHECKS[option], option_value)
+            error_message_key = options[:in] ? :in_between : option
+            record.errors.add(attr_name, error_message_key, filtered_options(value).merge(
+              :min => min_value,
+              :max => max_value
+            ))
+          end
+        end
+      end
+
+      def check_validity!
+        unless (AVAILABLE_CHECKS + [:in]).any? { |argument| options.has_key?(argument) }
+          raise ArgumentError, "You must pass either :less_than, :greater_than, or :in to the validator"
+        end
+      end
+
+    private
+
+      def extract_options(options)
+        if range = options[:in]
+          if !options[:in].respond_to?(:call)
+            options[:less_than_or_equal_to] = range.max
+            options[:greater_than_or_equal_to] = range.min
+          else
+            options[:less_than_or_equal_to] = range
+            options[:greater_than_or_equal_to] = range
+          end
+        end
+      end
+
+      def extract_option_value(option, option_value)
+        if option_value.is_a?(Range)
+          if [:less_than, :less_than_or_equal_to].include?(option)
+            option_value.max
+          else
+            option_value.min
+          end
+        else
+          option_value
+        end
+      end
+
+      def min_value
+        value = options[:greater_than_or_equal_to] || options[:greater_than]
+        value = value.min if value.respond_to?(:min)
+        value
+      end
+
+      def max_value
+        value = options[:less_than_or_equal_to] || options[:less_than]
+        value = value.max if value.respond_to?(:max)
+        value
+      end
+    end
+
+    module HelperMethods
+      # Places ActiveRecord-style validations on the pixel width 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
+      # * +if+: A lambda or name of an instance method. Validation will only
+      #   be run if this lambda or method returns true.
+      # * +unless+: Same as +if+ but validates if lambda or method returns false.
+      def validates_attachment_width(*attr_names)
+        validates_with AttachmentWidthValidator, _merge_attributes(attr_names)
+      end
+    end
+  end
+end

data/lib/paperclip_processors/offset_thumbnail.rb

@@ -0,0 +1,86 @@
+module Paperclip
+  # Handles thumbnailing images that are uploaded.
+  class OffsetThumbnail < Processor
+
+    attr_accessor :current_geometry, :target_geometry, :format, :whiny, :animated, :scale, :crop_and_offset
+
+    # List of formats that we need to preserve animation
+    ANIMATED_FORMATS = %w(gif)
+
+    # Creates a Thumbnail object set to work on the +file+ given. It
+    # will attempt to transform the image into one defined by +target_geometry+
+    # which is a "WxH"-style string. +format+ will be inferred from the +file+
+    # unless specified. Thumbnail creation will raise no errors unless
+    # +whiny+ is true (which it is, by default. If +convert_options+ is
+    # set, the options will be appended to the convert command upon image conversion
+    #
+    # Options include:
+    #
+    #   +geometry+ - the desired width and height of the thumbnail (required)
+    #   +file_geometry_parser+ - an object with a method named +from_file+ that takes an image file and produces its geometry and a +transformation_to+. Defaults to Paperclip::Geometry
+    #   +string_geometry_parser+ - an object with a method named +parse+ that takes a string and produces an object with +width+, +height+, and +to_s+ accessors. Defaults to Paperclip::Geometry
+    #   +source_file_options+ - flags passed to the +convert+ command that influence how the source file is read
+    #   +convert_options+ - flags passed to the +convert+ command that influence how the image is processed
+    #   +whiny+ - whether to raise an error when processing fails. Defaults to true
+    #   +format+ - the desired filename extension
+    #   +animated+ - whether to merge all the layers in the image. Defaults to true
+    def initialize(file, options = {}, attachment = nil)
+      super
+
+      geometry             = options[:geometry] # this is not an option
+      @file                = file
+      @crop                = geometry[-1,1] == '#'
+      @target_geometry     = (options[:string_geometry_parser] || Geometry).parse(geometry)
+      @current_geometry    = (options[:file_geometry_parser] || Geometry).from_file(@file)
+      @whiny               = options[:whiny].nil? ? true : options[:whiny]
+      @format              = options[:format]
+      @animated            = options[:animated].nil? ? true : options[:animated]
+      @scale               = options[:scale]
+      @crop_and_offset     = options[:crop_and_offset]
+      @current_format      = File.extname(@file.path)
+      @basename            = File.basename(@file.path, @current_format)
+    end
+
+    # Performs the conversion of the +file+ into a thumbnail. Returns the Tempfile
+    # that contains the new image.
+    def make
+      src = @file
+      dst = Tempfile.new([@basename, @format ? ".#{@format}" : ''])
+      dst.binmode
+
+      begin
+        parameters = []
+        parameters << ":source"
+        parameters << transformation_command
+        parameters << ":dest"
+
+        parameters = parameters.flatten.compact.join(" ").strip.squeeze(" ")
+
+        success = Paperclip.run("convert", parameters, :source => "#{File.expand_path(src.path)}#{'[0]' unless animated?}", :dest => File.expand_path(dst.path))
+      rescue Cocaine::ExitStatusError => e
+        raise Paperclip::Error, "There was an error processing the thumbnail for #{@basename}: #{e}" if @whiny
+      rescue Cocaine::CommandNotFoundError => e
+        raise Paperclip::CommandNotFoundError.new("Could not run the `convert` command. Please install ImageMagick.")
+      end
+
+      dst
+    end
+
+    # Returns the command ImageMagick's +convert+ needs to transform the image
+    # into the thumbnail.
+    def transformation_command
+      trans = []
+      trans << "-coalesce" if animated?
+      trans << "-resize" << %["#{scale}"] unless scale.nil? || scale.empty?
+      trans << "-crop" << %["#{crop_and_offset}"] << "+repage"
+      trans
+    end
+
+    protected
+
+    # Return true if the format is animated
+    def animated?
+      @animated && ANIMATED_FORMATS.include?(@current_format[1..-1]) && (ANIMATED_FORMATS.include?(@format.to_s) || @format.blank?)
+    end
+  end
+end

data/lib/tasks/cropped_paperclip_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :cropped_paperclip do
+#   # Task goes here
+# end

data/script/rails

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/cropped_paperclip/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/acceptance/acceptance_helper.rb

@@ -0,0 +1,2 @@
+require 'spec_helper.rb'
+require 'capybara/rspec'

data/spec/controllers/uploads_controller_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe CroppedPaperclip::UploadsController do
+
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.