carrierwave-crop 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ae81ffc8c861ab9d763fa3e2a2facbff306aca8
-  data.tar.gz: 72339d27bc8338a56a8d4c2203368a518b721310
+  metadata.gz: 3ffd4701225ed31cd44ecc10ca63ba345edca3f8
+  data.tar.gz: d03384b62cf0efe5fdf4269d968f1ddfe9ae30be
 SHA512:
-  metadata.gz: 95445f57cc37b15bc9e4ba07536cd8e26005b22bf2f63482be95d1725a33ccb512f1a1ce217c8084f624b6ed19208cbf52bd4df7a3a2408c70f290522cdf327b
-  data.tar.gz: c1fb5c9edf9b382d86b847cc242df0c28e3d8d49b2c9f48b281143fac98abdad8f2f1d3dbaf4a9f11588b3311989cdbcb770d06572f47b233087154cba103a48
+  metadata.gz: 6a2f655debcdba1371c813da797463e25b6597b8dc9f61a1b7f2c9940774490d683ccd706798f87b9461eb81dded61a8bc1cf3b1e7b5fa0c3686abd49e55b9c7
+  data.tar.gz: 245afb4af8f922cfe24854742e4aca04072fee87f462d1712a8ccd3c42c6532c2ba60574e9e57946726a6c7160270c6e5650c6c059b44c21d9eb36bfe6ceb4fb

data/.gitignore

@@ -16,4 +16,3 @@ test/tmp
 test/version_tmp
 tmp
 .DS_Store
-.keep

data/CHANGELOG.md

@@ -0,0 +1,43 @@
+## CarrierWave-Crop v0.1.0 
+   * Initial commit
+   * Supports processors `rmagick`.  
+   * `process crop: :avatar` resizes the original image to `600x600` and performs cropping on it.
+   
+## CarrierWave-Crop v0.1.1 
+   * Supports processors `rmagick` and `mini-magick`. 
+   * Changed module name `Carrierwave` to `CarrierWave` in sync with `CarrierWave` gem.
+   * Deprecated `cropped_preview` form helper. Replaced it with `previewbox`.
+   * Supports cropping of ONE attachment per model. Can be directly applied on original attachment if no versions exists.
+   
+         process crop: :avatar
+   * Supports cropping of MULTIPLE versions of one attachment per model.
+   * Updated the cropping coffeescript (created by rails generator) to incorporate the changes in form helpers.  
+   * Added `version`, `width` and `height` options to form helpers `cropbox` and `previewbox`.
+         ##To render a specific version for cropping pass `version` option.
+         <%= f.cropbox :avatar , version: :medium %>   
+         <%= f.peviewbox :avatar , version: :medium %>  ## Pass the same version as specified in cropbox
+
+         ## If you override ONE of width/height you MUST override both, otherwise passed option would be ignored.
+         <%= f.cropbox :avatar, width: 550, height: 600 %>
+         <%= f.previewbox :avatar, width: 200, height: 200 %>
+   * Added `width` and `height` arguments to proccessor method `crop`. 
+         ## If ONLY "thumb" version is to be cropped
+         version :jumbo do
+           resize_to_limit(600,600)
+         end
+         version :thumb do
+           process crop: :avatar  ## Crops this version based on original image
+           resize_to_limit(100,100)
+         end  
+         
+         ## With width and height
+         ## If ONLY "thumb" version is to be cropped
+         version :jumbo do
+           resize_to_limit(600,600)
+         end
+         version :thumb do
+           ## To crop this version based on `jumbo` version, pass width = 600 and height = 600
+           ## Specify both width and height values otherwise they would be ignored
+           process crop: [:avatar, 600, 600]  
+           resize_to_limit(100,100)
+         end 

data/README.md

@@ -1,14 +1,14 @@
-# Carrierwave-Crop
+# CarrierWave-Crop
 
 [![Build Status](https://travis-ci.org/kirtithorat/carrierwave-crop.svg?branch=master)](https://travis-ci.org/kirtithorat/carrierwave-crop)
 
-Carrierwave extension to crop uploaded images using Jcrop plugin with preview.
+CarrierWave extension to crop uploaded images using Jcrop plugin with preview.
 
 ## Installation
 
 Install the latest stable release:
 
-    $[sudo] gem install carrierwave
+    $[sudo] gem install carrierwave-crop
 
 In Rails, add it to your Gemfile:
 
@@ -84,7 +84,7 @@ In the view, say `crop.html.erb`:
 
     <%= form_for @user do |f| %>
       <%= f.cropbox :avatar %>
-      <%= f.cropped_preview :avatar %>
+      <%= f.previewbox :avatar %>
       <%= f.submit 'Crop' %>
     <% end %>
 
@@ -93,16 +93,75 @@ In the carrierwave uploader, say `AvatarUploader`:
 Call process on the version you would like to be cropped:
 
      ## If ONLY "thumb" version is to be cropped
-     version :jumbo do
-        resize_to_limit(600,600)
-     end
+    version :jumbo do
+      resize_to_limit(600,600)
+    end
+
+    version :thumb do
+      process crop: :avatar  ## Crops this version based on original image
+      resize_to_limit(100,100)
+    end      
+
+If there are no versions, and original file is to be cropped directly then call the process directly within `AvatarUploader`,
+
+    process crop: :avatar
+
+##NOTES
+
+1. Current Documentation is for **CarrierWave-Crop v0.1.1**
+2. Supports processors `rmagick` and `mini-magick`. 
+   
+   **To use `rmagick`, add it in your `Gemfile` as:**
+
+       gem 'rmagick', :require => 'RMagick'  ## Specify appropriate version, if needed
+
+   Run `bundle`    
+
+   Include it in your CarrierWave Uploader. For example:
+
+       class AvatarUploader < CarrierWave::Uploader::Base
+          include CarrierWave::RMagick  
+           ...
+        end 
+
+    **To use `mini_magick`, add it in your `Gemfile` as:**    
+    
+       gem 'mini_magick'  ## Specify appropriate version, if needed
+
+   Run `bundle`    
+
+   Include it in your CarrierWave Uploader. For example:
+
+        class AvatarUploader < CarrierWave::Uploader::Base
+          include CarrierWave::MiniMagick  
+          ...
+        end 
+
+3. Supports cropping of ONE attachment per model. Can be directly applied on original attachment if no versions exists.
+        process crop: :avatar
+4. Supports cropping of MULTIPLE versions of one attachment per model.
+5. In form helpers, by default *original image* is rendered. To render a specific version for cropping pass `version` option. For example:
+       <%= f.cropbox :avatar , version: :medium %>   
+       <%= f.peviewbox :avatar , version: :medium %>  ## Pass the same version as specified in cropbox     
+6. By default `previewbox` has `100x100` dimensions and `cropbox` defaults to the target geometry for the version.
+   `width` and `height` can be specified for these form helpers. BUT If you override ONE of width/height you MUST override both, otherwise passed option would be ignored.
+       <%= f.cropbox :avatar, width: 550, height: 600 %>
+       <%= f.previewbox :avatar, width: 200, height: 200 %>
+7. By default, `process crop: :avatar` will create the cropped version based on original image. 
+   To resize the image to a particular dimension before cropping, pass two more arguments `width` and `height`.
+       ## If ONLY "thumb" version is to be cropped
+       version :jumbo do
+         resize_to_limit(600,600)
+       end
 
-     version :thumb do
-        process crop: :avatar  ## Add this
-        resize_to_limit(100,100)
-     end      
+       version :thumb do
+         ## To crop this version based on `jumbo` version, pass width = 600 and height = 600
+         ## Specify both width and height values otherwise they would be ignored
+         process crop: [:avatar, 600, 600]  
+         resize_to_limit(100,100)
+       end    
 
 ### Credits and resources
-* [Carrierwave](https://github.com/carrierwaveuploader/carrierwave)
+* [CarrierWave](https://github.com/carrierwaveuploader/carrierwave)
 * [Deep Liquid's JCrop](http://deepliquid.com/content/Jcrop.html)
 * And Ryan Bates [Railscast#182](http://railscasts.com/episodes/182-cropping-images/)

data/carrierwave-crop.gemspec

@@ -5,11 +5,11 @@ require 'carrierwave/crop/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "carrierwave-crop"
-  spec.version       = Carrierwave::Crop::VERSION
+  spec.version       = CarrierWave::Crop::VERSION
   spec.authors       = ["kirtithorat"]
   spec.email         = ["kirti.brenz@gmail.com"]
-  spec.summary       = %q{Carrierwave extension for cropping images with preview.}
-  spec.description   = %q{Carrierwave extension to crop uploaded images using Jcrop plugin.}
+  spec.summary       = %q{CarrierWave extension for cropping images with preview.}
+  spec.description   = %q{CarrierWave extension to crop uploaded images using Jcrop plugin.}
   spec.homepage      = "https://github.com/kirtithorat/carrierwave-crop"
   spec.license       = "MIT"
 
@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rails", ">= 3.1"
+  spec.add_dependency "rails", ">= 3.2"
   spec.add_dependency "jquery-rails"
   spec.add_dependency "carrierwave", [">= 0.8.0", "< 0.11.0"]
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"  
+  spec.add_development_dependency "rspec" 
 end

data/lib/carrierwave/crop.rb

@@ -1,8 +1,3 @@
-require "carrierwave"
-require "carrierwave/crop/version"
-require "carrierwave/crop/model_additions"
-if defined? Rails
-  require 'carrierwave/crop/engine'
-  require "carrierwave/crop/railtie"
-  require 'carrierwave/crop/helpers'
-end
+# encoding: utf-8
+
+require 'carrierwave/crop/all'

data/lib/carrierwave/crop/all.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+require "carrierwave/crop/version"
+require "carrierwave/crop/error"
+
+if defined? Rails
+  require "carrierwave/crop/engine"
+  require 'carrierwave/crop/helpers'
+  require "carrierwave/crop/model_additions"
+  require "carrierwave/crop/railtie"
+end

data/lib/carrierwave/crop/engine.rb

@@ -1,4 +1,6 @@
-module Carrierwave
+# encoding: utf-8
+
+module CarrierWave
   module Crop
     class Engine < ::Rails::Engine
     end

data/lib/carrierwave/crop/error.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+
+module CarrierWave
+  module Crop
+    class MissingProcessorError < StandardError; end
+    class ProcessingError < StandardError; end
+  end
+end

data/lib/carrierwave/crop/helpers.rb

@@ -1,38 +1,78 @@
-module Carrierwave
+# encoding: utf-8
+
+module CarrierWave
   module Crop
     module Helpers
 
-      def cropped_preview(attachment, opts = {})
+      # Form helper to render the preview of a cropped attachment.
+      # Loads the actual image. Previewbox has no constraints on dimensions, image is renedred at full size.
+      # By default box size is 100x100. Size can be customized by setting the :width and :height option.
+      # If you override one of width/height you must override both.
+      # By default original image is rendered. Specific version can be specified by passing version option
+      #
+      #   previewbox :avatar
+      #   previewbox :avatar, width: 200, height: 200
+      #   previewbox :avatar, version: :medium
+      #
+      # @param attachment [Symbol] attachment name
+      # @param opts [Hash] specify version or width and height options
+      def previewbox(attachment, opts = {})
         attachment = attachment.to_sym
-        width      = opts[:width] || 100
-        height     = (width / 1).round
 
         if(self.object.send(attachment).class.ancestors.include? CarrierWave::Uploader::Base )
-          wrapper_options = {
-            :id    => "#{attachment}_crop_preview_wrapper",
-            :style => "width:#{width}px; height:#{height}px; overflow:hidden"
-          }
-
-          preview_image = @template.image_tag(self.object.send(attachment).url, :id => "#{attachment}_crop_preview")
-
-          @template.content_tag(:div, preview_image, wrapper_options)
+          model_name = self.object.class.name.downcase
+          width, height = 100, 100
+          if(opts[:width] && opts[:height])
+            width, height = opts[:width].round, opts[:height].round
+          end
+          wrapper_attributes = {id: "#{model_name}_#{attachment}_previewbox_wrapper", style: "width:#{width}px; height:#{height}px; overflow:hidden"}
+          if opts[:version]
+            img = self.object.send(attachment).url(opts[:version])
+          else
+            img = self.object.send(attachment).url
+          end
+          preview_image = @template.image_tag(img, id: "#{model_name}_#{attachment}_previewbox")
+          @template.content_tag(:div, preview_image, wrapper_attributes)
         end
       end
 
-
+      # Form helper to render the actual cropping box of an attachment.
+      # Loads the actual image. Cropbox has no constraints on dimensions, image is renedred at full size.
+      # Box size can be restricted by setting the :width and :height option. If you override one of width/height you must override both.
+      # By default original image is rendered. Specific version can be specified by passing version option
+      #
+      #   cropbox :avatar
+      #   cropbox :avatar, width: 550, height: 600
+      #   cropbox :avatar, version: :medium
+      #
+      # @param attachment [Symbol] attachment name
+      # @param opts [Hash] specify version or width and height options
       def cropbox(attachment, opts={})
         attachment = attachment.to_sym
+        attachment_instance = self.object.send(attachment)
 
-        if(self.object.send(attachment).class.ancestors.include? CarrierWave::Uploader::Base )
-          box  = self.hidden_field(:"#{attachment}_crop_x", id: "#{self.object.class.name.downcase}_#{attachment}_crop_x")
+        if(attachment_instance.class.ancestors.include? CarrierWave::Uploader::Base )
+
+          model_name = self.object.class.name.downcase
+          hidden_elements  = self.hidden_field(:"#{attachment}_crop_x", id: "#{model_name}_#{attachment}_crop_x")
           [:crop_y, :crop_w, :crop_h].each do |attribute|
-            box << self.hidden_field(:"#{attachment}_#{attribute}", id: "#{self.object.class.name.downcase}_#{attachment}_#{attribute}")
+            hidden_elements << self.hidden_field(:"#{attachment}_#{attribute}", id: "#{model_name}_#{attachment}_#{attribute}")
           end
 
-          crop_image = @template.image_tag(self.object.send(attachment).url, :id => "#{self.object.class.name.downcase}_#{attachment}_cropbox")
+          box =  @template.content_tag(:div, hidden_elements, style: "display:none")
 
-          box << @template.content_tag(:div, crop_image)
+          wrapper_attributes = {id: "#{model_name}_#{attachment}_cropbox_wrapper"}
+          if(opts[:width] && opts[:height])
+            wrapper_attributes.merge!(style: "width:#{opts[:width].round}px; height:#{opts[:height].round}px; overflow:hidden")
+          end
 
+          if opts[:version]
+            img = self.object.send(attachment).url(opts[:version])
+          else
+            img = self.object.send(attachment).url
+          end
+          crop_image = @template.image_tag(img, :id => "#{model_name}_#{attachment}_cropbox")
+          box << @template.content_tag(:div, crop_image, wrapper_attributes)
         end
       end
     end
@@ -41,6 +81,6 @@ end
 
 if defined? ActionView::Helpers::FormBuilder
   ActionView::Helpers::FormBuilder.class_eval do
-    include Carrierwave::Crop::Helpers
+    include CarrierWave::Crop::Helpers
   end
 end

data/lib/carrierwave/crop/model_additions.rb

@@ -1,21 +1,32 @@
-module Carrierwave
+# encoding: utf-8
+
+module CarrierWave
   module Crop
     module ModelAdditions
-
       module ClassMethods
 
-        ## Adding dynamic attribute accessors
+        # Adds cropping feature on a specific attribute of your model
+        #
+        #   crop_uploaded :avatar
+        #
+        # @param attachment [Symbol] Name of the attachment attribute to be cropped
         def crop_uploaded(attachment)
 
           [:crop_x, :crop_y, :crop_w, :crop_h].each do |a|
             attr_accessor :"#{attachment}_#{a}"
           end
           after_update :"recreate_#{attachment}_versions"
+
         end
-      end
+
+      end ## End of ClassMethods
 
       module InstanceMethods
 
+        # Checks if the attachment received cropping attributes
+        # @param  attachment [Symbol] Name of the attribute to be croppedv
+        #
+        # @return [Boolean]
         def cropping?(attachment)
           !self.send(:"#{attachment}_crop_x").blank? &&
             !self.send(:"#{attachment}_crop_y").blank? &&
@@ -23,6 +34,7 @@ module Carrierwave
             !self.send(:"#{attachment}_crop_h").blank?
         end
 
+        # method_missing is used to respond to the model callback
         def method_missing(method, *args)
           if method.to_s =~ /recreate_(\S{1,})_versions/
             crop_image(method.to_s.scan(/recreate_(\S{1,})_versions/).flatten.first.to_sym)
@@ -31,6 +43,8 @@ module Carrierwave
           end
         end
 
+        # Saves the attachment if the crop attributes are present
+        # @param  attachment [Symbol] Name of the attribute to be cropped
         def crop_image(attachment)
           if cropping?(attachment)
             attachment_instance = send(attachment)
@@ -38,30 +52,61 @@ module Carrierwave
           end
         end
 
-      end
-    end
+      end  ## End of InstanceMethods
+
+    end  ## End of ModelAdditions
 
     module Uploader
 
-      def crop(attachment)
+      # Perfoems cropping.
+      #  
+      #  On original version of attachment
+      #  process crop: :avatar  
+      #
+      #  Resizes the original image to 600x600 and then performs cropping 
+      #  process crop: [:avatar, 600, 600]  
+      #
+      # @param attachment [Symbol] Name of the attachment attribute to be cropped
+      def crop(attachment, width = nil, height = nil)
         if model.cropping?(attachment)
-          resize_to_limit(600, 600)
-          manipulate! do |img|
-            x = model.send("#{attachment}_crop_x").to_i
-            y = model.send("#{attachment}_crop_y").to_i
-            w = model.send("#{attachment}_crop_w").to_i
-            h = model.send("#{attachment}_crop_h").to_i
-            img.crop!(x, y, w, h)
+          x = model.send("#{attachment}_crop_x").to_i
+          y = model.send("#{attachment}_crop_y").to_i
+          w = model.send("#{attachment}_crop_w").to_i
+          h = model.send("#{attachment}_crop_h").to_i
+          attachment_instance = model.send(attachment)
+
+          if self.respond_to? "resize_to_limit"
+
+            begin
+              if width && height
+                resize_to_limit(width, height)
+              end
+              manipulate! do |img|
+                if attachment_instance.kind_of? CarrierWave::RMagick
+                  img.crop!(x, y, w, h)
+                elsif attachment_instance.kind_of? CarrierWave::MiniMagick
+                  img.crop("#{w}x#{h}+#{x}+#{y}")
+                  img
+                end
+              end
+
+            rescue Exception => e
+              raise CarrierWave::Crop::ProcessingError, "Failed to crop - #{e.message}"
+            end
+
+          else
+            raise CarrierWave::Crop::MissingProcessorError, "Failed to crop #{attachment}. Add rmagick or mini_magick."
           end
         end
       end
-    end
-  end
-end
+
+    end ## End of Uploader
+  end ## End of Crop
+end ## End of CarrierWave
 
 
 if defined? CarrierWave::Uploader::Base
   CarrierWave::Uploader::Base.class_eval do
-    include Carrierwave::Crop::Uploader
+    include CarrierWave::Crop::Uploader
   end
 end

data/lib/carrierwave/crop/railtie.rb

@@ -1,4 +1,6 @@
-module Carrierwave
+# encoding: utf-8
+
+module CarrierWave
   module Crop
     class Railtie < Rails::Railtie
       initializer 'carrierwave.crop' do

data/lib/carrierwave/crop/version.rb

@@ -1,5 +1,5 @@
-module Carrierwave
+module CarrierWave
   module Crop
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/generators/templates/carrierwave_cropper.js.coffee

@@ -1,7 +1,7 @@
 jQuery ->
-  new CarrierwaveCropper()
+  new CarrierWaveCropper()
 
-class CarrierwaveCropper
+class CarrierWaveCropper
   constructor: ->
     $('#<%= file_name %>_<%= attachment_name %>_cropbox').Jcrop
       aspectRatio: 1
@@ -17,7 +17,7 @@ class CarrierwaveCropper
     @updatePreview(coords)
 
   updatePreview: (coords) =>
-    $('#avatar_crop_preview').css
+    $('#<%= file_name %>_<%= attachment_name %>_previewbox').css
       width: Math.round(100/coords.w * $('#<%= file_name %>_<%= attachment_name %>_cropbox').width()) + 'px'
       height: Math.round(100/coords.h * $('#<%= file_name %>_<%= attachment_name %>_cropbox').height()) + 'px'
       marginLeft: '-' + Math.round(100/coords.w * coords.x) + 'px'

data/spec/crop/model_additions_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Carrierwave::Crop::ModelAdditions do
+describe CarrierWave::Crop::ModelAdditions do
 
 
   describe ".crop_uploaded" do

data/spec/spec_helper.rb

@@ -1,2 +1,2 @@
 require 'carrierwave/crop'
-
+require 'carrierwave/crop/model_additions'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carrierwave-crop
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - kirtithorat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-13 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +100,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Carrierwave extension to crop uploaded images using Jcrop plugin.
+description: CarrierWave extension to crop uploaded images using Jcrop plugin.
 email:
 - kirti.brenz@gmail.com
 executables: []
@@ -110,13 +110,16 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - carrierwave-crop.gemspec
 - lib/carrierwave/crop.rb
+- lib/carrierwave/crop/all.rb
 - lib/carrierwave/crop/engine.rb
+- lib/carrierwave/crop/error.rb
 - lib/carrierwave/crop/helpers.rb
 - lib/carrierwave/crop/model_additions.rb
 - lib/carrierwave/crop/railtie.rb
@@ -154,7 +157,7 @@ rubyforge_project:
 rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
-summary: Carrierwave extension for cropping images with preview.
+summary: CarrierWave extension for cropping images with preview.
 test_files:
 - spec/crop/model_additions_spec.rb
 - spec/crop_spec.rb