papercrop 0.0.2 → 0.0.5

data/README.md

@@ -0,0 +1,56 @@
+
+## Papercrop
+An easy extension for Paperclip to crop your image uploads using jCrop.
+
+### Installation
+Include papercrop in your Gemfile or install it by hand
+
+    gem install papercrop
+
+You need to add the required files in your assets...
+
+In your application.js
+
+    //= require jquery
+    //= require jquery.jcrop
+    //= require papercrop
+
+In your application.css
+
+    *= require jquery.jcrop
+
+### Using Papercrop
+You are a few steps away to start cropping attachments. Let's start with the model, a user with avatar:
+
+    has_attached_file :avatar, :styles => {:thumb => '50x50', :medium => '100x100'}
+    crop_attached_file :avatar
+    
+By default, the crop area and the preview box will have an aspect ratio of 1:1. 
+You can modify that by passing a new aspect.
+
+    crop_attached_file :snapshot, :aspect => "16:9"
+    
+On the controller you can render a view after user creation, create a simple crop action, etc... whatever you like the most. Inside the form of a persisted user:
+
+    <%= form_for @user do |f| %>
+      <%= f.cropbox :avatar %>
+      <%= f.crop_preview :avatar %>
+      <%= f.submit 'Save' %>
+    <% end %>
+    
+Both helpers accept a :width option to customize their dimensions. The preview box has width 100 by default but the cropbox is unlimited in size (takes the original image width), so setting the cropbox width is interesting to avoid layout breaks with huge images. 
+
+    <%= form_for @user do |f| %>
+      <%= f.cropbox :avatar, :width => 500 %>
+      <%= f.crop_preview :avatar, :width => 150 %>
+      <%= f.submit 'Save' %>
+    <% end %>
+    
+Regardless of the width, the preview box and the cropping area will have the aspect ratio defined in the model (1:1 by default)
+
+That's all!
+
+#### Credits and resources
+* [Thoughtbot's Paperclip](https://github.com/thoughtbot/paperclip/)
+* [Deep Liquid's JCrop](http://deepliquid.com/content/Jcrop.html)
+* And Ryan Bates' [Railscast#182](http://railscasts.com/episodes/182-cropping-images/), which has inspired this gem

data/lib/assets/javascripts/papercrop.js

@@ -1,3 +1,5 @@
+var jcrop_api;
+
 (function() {
   $(document).ready(function() {
     $('div[id$=_cropbox]').each(function() {
@@ -35,7 +37,7 @@
         setSelect   : [0, 0, 500, 500],
         aspectRatio : aspect,
         boxWidth    : $("input[id$='_" + attachment + "_box_w']").val()
-      });
+      }, function(){ jcrop_api = this; });
     });
   });
 }).call(this); 

data/lib/papercrop/active_record_extension.rb

@@ -8,6 +8,16 @@ module Papercrop
 
     module ClassMethods
 
+      # Initializes attachment cropping in your model
+      #
+      #   crop_attached_file :avatar
+      #
+      # You can also define an aspect ratio for the crop and preview box through opts[:aspect]
+      #
+      #   crop_attached_file :avatar, :aspect => "4:3"
+      #
+      # @param attachment_name [Symbol] The name of the desired attachment to crop
+      # @param opts [Hash]
       def crop_attached_file(attachment_name, opts = {})
         [:crop_x, :crop_y, :crop_w, :crop_h, :original_w, :original_h, :box_w, :aspect].each do |a|
           attr_accessor :"#{attachment_name}_#{a}"
@@ -30,12 +40,12 @@ module Papercrop
 
         after_update :"reprocess_to_crop_#{attachment_name}_attachment"
       end
-
     end
 
 
     module InstanceMethods
 
+      # Asks if the attachment received a crop process
       def cropping?(attachment_name)
         !self.send(:"#{attachment_name}_crop_x").blank? &&
         !self.send(:"#{attachment_name}_crop_y").blank? &&
@@ -44,12 +54,18 @@ module Papercrop
       end
 
 
+      # Returns a Paperclip::Geometry object from a named attachment
+      #
+      # @param attachment_name [Symbol] 
+      # @param style [Symbol] attachment style, :original by default
+      # @return Paperclip::Geometry
       def image_geometry(attachment_name, style = :original)
         @geometry        ||= {}
         @geometry[style] ||= Paperclip::Geometry.from_file(self.send(attachment_name).path(style))
       end
 
 
+      # Uses method missing to reprocess the attachment callback
       def method_missing(method, *args)
         if method.to_s =~ /(reprocess_to_crop_)(\S{1,})(_attachment)/
           reprocess_cropped_attachment(
@@ -62,8 +78,9 @@ module Papercrop
 
       private
 
+        # Reprocess the attachment after cropping
         def reprocess_cropped_attachment(attachment_name)
-          self.send(attachment_name.to_sym).reprocess! if cropping? attachment_name
+          self.send(attachment_name.to_sym).reprocess! if cropping?(attachment_name)
         end
 
     end

data/lib/papercrop/helpers.rb

@@ -1,6 +1,15 @@
 module Papercrop
   module Helpers
     
+    # Form helper to render the cropping preview box of an attachment.
+    # Box width can be handled by setting the :width option. 
+    # Width is 100 by default. Height is calculated by the aspect ratio.
+    # 
+    #   crop_preview :avatar
+    #   crop_preview :avatar, :width => 150
+    #
+    # @param attachment [Symbol] attachment name
+    # @param opts [Hash]
     def crop_preview(attachment, opts = {})
       attachment = attachment.to_sym
       width      = opts[:width] || 100
@@ -19,6 +28,14 @@ module Papercrop
     end
 
 
+    # Form helper to render the main cropping box of an attachment.
+    # Loads the original image. Initially the cropbox has no limits on dimensions, showing the image at full size.
+    # You can restrict it by setting the :width option to the width you want.
+    #
+    #   cropbox :avatar, :width => 650
+    #
+    # @param attachment [Symbol] attachment name
+    # @param opts [Hash]
     def cropbox(attachment, opts = {})
       attachment      = attachment.to_sym
       original_width  = self.object.image_geometry(attachment, :original).width

data/spec/integration/papercrop_js_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+describe "Image crop with JS", :js => true do
+
+  after do
+    Landscape.destroy_all
+  end
+
+
+  it "crops an image with javascript" do
+    visit landscapes_path
+
+    click_link "New Landscape"
+
+    fill_in "Name", :with => "Mountains"
+    find("#landscape_picture").native.send_keys(File.expand_path("../../../test_app/test/fixtures/matterhorn.jpg", __FILE__))
+    click_button "Create Landscape"
+
+    sleep 2
+    page.execute_script("jcrop_api.setSelect([300, 200, 700, 500])")
+    page.execute_script('if ($("#picture_crop_y").val() == "199"){$("#picture_crop_y").val("200")}')
+    page.execute_script('if ($("#picture_crop_w").val() == "399"){$("#picture_crop_w").val("400")}')
+
+    click_button "Crop image"
+
+    sleep 1
+    compare_images(CROPPED_IMG_PATH, Landscape.last.picture.path(:medium)).should eq(0.0)
+  end
+end

data/spec/integration/papercrop_spec.rb

@@ -0,0 +1,39 @@
+require "spec_helper"
+
+describe "Image crop" do
+  
+  after do
+    Landscape.destroy_all
+  end
+
+
+  it "crops an image" do
+    visit landscapes_path
+
+    click_link "New Landscape"
+
+    fill_in      "Name", :with => "Mountains"
+    attach_file  "Picture", "test_app/test/fixtures/matterhorn.jpg"
+    click_button "Create Landscape"
+
+    page.should have_css("#picture_crop_preview_wrapper")
+    page.should have_css("#picture_crop_preview")
+    page.should have_css("#picture_cropbox")
+
+    page.should have_css("#landscape_picture_original_w")
+
+    find("#landscape_picture_original_w").value.should eq("1024.0")
+    find("#landscape_picture_original_h").value.should eq("768.0")
+    find("#landscape_picture_box_w").value.should      eq("600")
+    find("#picture_aspect").value.should               eq((4.0 / 3.0).to_s)
+
+    find("#picture_crop_x").set "300.0"
+    find("#picture_crop_y").set "200.0"
+    find("#picture_crop_w").set "400"
+    find("#picture_crop_h").set "300"
+
+    click_button "Crop image"
+    
+    compare_images(CROPPED_IMG_PATH, Landscape.last.picture.path(:medium)).should eq(0.0)
+  end
+end

data/spec/model_extensions/active_record_spec.rb

@@ -0,0 +1,64 @@
+require "spec_helper"
+
+describe "Active Record Extension" do
+
+  before do
+    @landscape         = Landscape.new(:name => "Mountains")
+    @landscape.picture = open("test_app/test/fixtures/matterhorn.jpg")
+    @landscape.save
+  end
+
+
+  after do
+    @landscape.destroy
+  end
+
+
+  it "includes accessors to the model" do
+    %w{crop_x crop_y crop_w crop_h original_w original_h box_w aspect}.each do |m|
+      @landscape.should respond_to(:"picture_#{m}")
+      @landscape.should respond_to(:"picture_#{m}=")
+    end
+  end
+
+
+  it "registers the post processor" do
+    @landscape.attachment_definitions[:picture][:processors].should eq([:cropper])
+  end
+
+
+  it "defines an after update callback" do
+    @landscape._update_callbacks.map do |e|
+      e.instance_values['filter'].should eq(:reprocess_to_crop_picture_attachment) 
+    end
+  end
+
+
+  it "returns image properties" do
+    @landscape.picture_aspect.should eq(4.0 / 3.0)
+
+    @landscape.image_geometry(:picture).width.should  eq(1024.0)
+    @landscape.image_geometry(:picture).height.should eq(768.0)
+  end
+
+
+  it "knows when to crop" do
+    @landscape.cropping?(:picture).should be(false)
+    @landscape.picture_crop_x = 0.0
+    @landscape.picture_crop_y = 0.0
+    @landscape.picture_crop_w = 400
+    @landscape.picture_crop_h = 300
+    @landscape.cropping?(:picture).should be(true)
+  end
+
+
+  it "crops images" do
+    @landscape.picture_crop_x = 300.0
+    @landscape.picture_crop_y = 200.0
+    @landscape.picture_crop_w = 400
+    @landscape.picture_crop_h = 300
+    @landscape.save
+
+    compare_images(CROPPED_IMG_PATH, @landscape.picture.path(:medium)).should eq(0.0)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] = 'test'
+require File.expand_path("../../test_app/config/environment", __FILE__)
+require 'rspec/rails'
+require 'rspec/autorun'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+# Previously cropped image. Used for comparing test cropped images with RMagick
+CROPPED_IMG_PATH = "test_app/test/fixtures/test_img.jpg"
+
+RSpec.configure do |config|
+  # ## Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # If true, the base class of anonymous controllers will be inferred
+  # automatically. This will be the default behavior in future versions of
+  # rspec-rails.
+  config.infer_base_class_for_anonymous_controllers = false
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

data/spec/support/compare_images.rb

@@ -0,0 +1,8 @@
+require "RMagick"
+
+def compare_images(test_image_path, cropped_image_path)
+  test_img   = Magick::Image::read(test_image_path).first
+  target_img = Magick::Image::read(cropped_image_path).first
+  
+  test_img.compare_channel(target_img, Magick::MeanAbsoluteErrorMetric).second
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: papercrop
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -13,18 +13,18 @@ date: 2012-08-12 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &10547380 !ruby/object:Gem::Requirement
+  requirement: &22349340 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *10547380
+  version_requirements: *22349340
 - !ruby/object:Gem::Dependency
   name: jquery-rails
-  requirement: &10546980 !ruby/object:Gem::Requirement
+  requirement: &22348940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,19 +32,74 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *10546980
+  version_requirements: *22348940
 - !ruby/object:Gem::Dependency
   name: paperclip
-  requirement: &10546440 !ruby/object:Gem::Requirement
+  requirement: &22348380 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :runtime
   prerelease: false
-  version_requirements: *10546440
-description: Paperclip extension for cropping images
+  version_requirements: *22348380
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &22337440 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *22337440
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &22336980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: *22336980
+- !ruby/object:Gem::Dependency
+  name: rmagick
+  requirement: &22336580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22336580
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: &22336120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22336120
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &22335680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *22335680
+description: An easy extension for Paperclip to crop your image uploads using jCrop
 email: rsantamaria.dev@gmail.com
 executables: []
 extensions: []
@@ -56,7 +111,6 @@ files:
 - lib/assets/stylesheets/jquery.jcrop.css
 - lib/paperclip_processors/cropper.rb
 - lib/papercrop/active_record_extension.rb
-- lib/papercrop/controller_extension.rb
 - lib/papercrop/engine.rb
 - lib/papercrop/helpers.rb
 - lib/papercrop.rb
@@ -65,7 +119,12 @@ files:
 - vendor/jcrop-v0.9.10/js/jquery.Jcrop.js
 - vendor/jcrop-v0.9.10/MIT-LICENSE.txt
 - README.md
-homepage: http://rubygems.org/gems/papercrop
+- spec/integration/papercrop_js_spec.rb
+- spec/integration/papercrop_spec.rb
+- spec/model_extensions/active_record_spec.rb
+- spec/spec_helper.rb
+- spec/support/compare_images.rb
+homepage: https://github.com/rsantamaria/papercrop
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -89,4 +148,9 @@ rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Paperclip extension for cropping images
-test_files: []
+test_files:
+- spec/integration/papercrop_js_spec.rb
+- spec/integration/papercrop_spec.rb
+- spec/model_extensions/active_record_spec.rb
+- spec/spec_helper.rb
+- spec/support/compare_images.rb

data/lib/papercrop/controller_extension.rb

@@ -1,29 +0,0 @@
-module Papercrop
-  module ControllerExtension
-    
-    def self.included(klass)
-      klass.extend ClassMethods
-    end
-
-
-    module ClassMethods
-
-      def crop_image(field_name, opts)
-        opts[:after] ||= [:create, :update]
-        opts[:class] ||= self.class.name.gsub("Controller", "").singularize.constantize 
-      end
-
-    end
-
-
-    module InstanceMethods
-    end
-  end
-end
-
-
-# if defined? ActionController::Base
-#   ActionController::Base.class_eval do
-#     include Papercrop::ControllerExtension
-#   end
-# end