rails_admin_jcrop 0.1.1 → 0.2.0

data/README.markdown

@@ -16,13 +16,12 @@
           # Below is optional
           edit do
             field :avatar do
-              # use jcrop_options to pass any options you like to .Jcrop call in javascript
               jcrop_options aspectRatio: 500.0/320.0
             end
           end
         end
 
-3. Call :rails_admin_crop in your uploader:
+3. If you use Paperclip, you need to do nothing here, rails_admin_jcrop will append RailsAdminJcropper processor to your attachment automatically. If CarrierWave is used, please invoke  :rails_admin_crop in your uploader:
 
         class AvatarUploader < CarrierWave::Uploader::Base
 
@@ -34,7 +33,37 @@
         end
 
 4. Done! Click the image on your RailsAdmin model edit page and enjoy cropping!
-![Cropping Screenshot](https://github.com/janx/rails_admin_jcrop/raw/master/screenshot.png)
+![Cropping Screenshot](https://github.com/janx/rails_admin_jcrop/raw/master/screenshots/example.png)
+
+## Field Options ##
+
+### jcrop_options ###
+
+You can pass any Jcrop plugin allowed options here, for example, use `aspectRatio` to fix the ratio of selection box:
+
+            field :avatar do
+              jcrop_options aspectRatio: 500.0/320.0
+            end
+
+Please check [Jcrop document](http://deepliquid.com/content/Jcrop_Manual.html#Setting_Options) for more available options.
+
+### fit_image ###
+
+By default, image is scaled properly to make cropping more easy, but sometimes the image is still too large to fit in the modal window, you may need to scroll image up/down to crop. If you set `fit_image` to true, image will always be resized to fit in modal window.
+
+            field :avatar do
+              fit_image true
+            end
+
+Check screenshots below to see the difference:
+
+When `fit_image` is false (default)
+
+![fit_image false](https://github.com/janx/rails_admin_jcrop/raw/master/screenshots/fit_image_false.png)
+
+When `fit_image` is true
+
+![fit_image true](https://github.com/janx/rails_admin_jcrop/raw/master/screenshots/fit_image_true.png)
 
 ## Localization ##
 
@@ -51,31 +80,40 @@ Localize the crop form by adding these entries:
 
 * MRI 1.9.3 (All above 1.8.6 should work, I only tested on 1.9.3)
 * Rails 3.x
-* ORM
-    - ActiveRecord
-* Upload plugin
-    - CarrierWave
-* Image processor
-    - MiniMagick
+* MiniMagick
+
+## Supported ORM ##
+
+* ActiveRecord
+* Mongoid
+
+## Supported Asset Plugin ##
+
+* CarrierWave
+* Paperclip
 
 ## TODO ##
 
-* MongoDB support
-* Paperclip support
-* RMagick support
+* automate :rails_admin_crop for CarrierWave uploader
+
 
 ## Contributing ##
 
 Any help is encouraged. Here are some ways you can contribute:
 
 * by using it
-* by telling people this plugin
+* by telling people
 * by reporting bugs or suggesting new features on github issue tracker
 * by fixing bugs or implementing features
-* by giving author a hug (especially if you're girl)
 
 ## Thanks ##
 
+### Contributors ###
+
+* [Alan Rosin Sikora](https://github.com/alansikora) ([alansikora](https://github.com/alansikora))
+
+### And ... ###
+
 Life is easier with you.
 
 * [RailsAdmin](https://github.com/sferik/rails_admin/)

data/app/controllers/rails_admin/jcrop_controller.rb

@@ -1,12 +1,33 @@
+require 'mini_magick'
+
 module RailsAdmin
 
   class JcropController < RailsAdmin::ApplicationController
     skip_before_filter :get_model
-    before_filter :get_model, :get_object, :get_field
+    before_filter :get_model, :get_object, :get_field, :get_fit_image
 
     helper_method :abstract_model, :geometry
 
     def edit
+      @form_options = {}
+      @form_options[:method] = :put
+      @form_options[:'data-title'] = "#{I18n.t("admin.actions.crop.menu").capitalize} #{abstract_model.model.human_attribute_name @field}"
+
+      @image_tag_options = {}
+      @image_tag_options[:class] = "jcrop-subject"
+      @image_tag_options[:'data-geometry'] = geometry(@object.send(@field).path).join(",")
+
+      if @fit_image
+        fit_image_geometry = fit_image_geometry(@object.send(@field).path)
+
+        @form_options[:'style'] = "margin-left: #{375 - (fit_image_geometry[0]/2) - 15}px;"
+
+        @image_tag_options[:style] = ""
+        @image_tag_options[:style] << "width: #{fit_image_geometry[0]}px !important;"
+        @image_tag_options[:style] << "height: #{fit_image_geometry[1]}px !important;"
+        @image_tag_options[:style] << "border: 1px solid #AAA !important;"
+      end
+
       respond_to do |format|
         format.html
         format.js   { render :edit, :layout => false }
@@ -21,7 +42,7 @@ module RailsAdmin
         format.js do
           asset = @object.send @field
           urls = {:original => asset.url}
-          @object.class.uploaders[@field.to_sym].versions.each {|name, _| urls[name] = asset.url(name)}
+          thumbnail_names.each {|name| urls[name] = asset.url(name)}
 
           render :json => {
             :id    => @object.id,
@@ -35,6 +56,14 @@ module RailsAdmin
 
     private
 
+    def thumbnail_names
+      RailsAdminJcrop::AssetEngine.thumbnail_names(@object, @field)
+    end
+
+    def get_fit_image
+      @fit_image = params[:fit_image] == "true" ? true : false
+    end
+
     def get_field
       @field = params[:field]
     end
@@ -44,6 +73,13 @@ module RailsAdmin
       [image[:width], image[:height]]
     end
 
+    def fit_image_geometry(image_path)
+      image = MiniMagick::Image.open(image_path)
+      # Magic number origin: https://github.com/janx/rails_admin_jcrop/pull/2
+      image.resize "720x400"
+      [image[:width], image[:height]]
+    end
+
     def cropping?
       [:crop_x, :crop_y, :crop_w, :crop_h].all? {|c| params[c].present?}
     end

data/app/views/rails_admin/jcrop/edit.html.haml

@@ -1,5 +1,5 @@
-= form_tag nil, :method => :put, 'data-title' => "#{I18n.t('admin.actions.crop.menu').capitalize} #{abstract_model.model.human_attribute_name @field}" do
-  = image_tag @object.send(@field).url, :class => 'jcrop-subject', 'data-geometry' => geometry(@object.send(@field).path).join(',')
+= form_tag nil, @form_options do
+  = image_tag @object.send(@field).url, @image_tag_options
   = hidden_field_tag :crop_x
   = hidden_field_tag :crop_y
   = hidden_field_tag :crop_w

data/app/views/rails_admin/main/_form_jcrop.html.haml

@@ -11,7 +11,7 @@
   - if value = field.pretty_value
     = value
   = form.file_field(field.name, field.html_attributes.reverse_merge({ :data => { :fileupload => true } }))
-  = link_to 'Edit Image', '#', :data => {:link => jcrop_path(:model_name => form.object.class.to_param, :modal => true, :id => form.object.id, :field => field.name), :thumb => field.thumb_method}, :style => 'display:none', :class => "jcrop_handle"
+  = link_to 'Edit Image', '#', :data => {:link => jcrop_path(:model_name => form.object.class.to_param, :modal => true, :id => form.object.id, :field => field.name, :fit_image => field.fit_image), :thumb => field.thumb_method}, :style => 'display:none', :class => "jcrop_handle"
 - if field.optional? && field.errors.blank? && file && field.delete_method
   %a.btn.btn-info{:href => '#', :'data-toggle' => 'button', :onclick => "$(this).siblings('[type=checkbox]').click(); $(this).siblings('.toggle').toggle('slow'); jQuery(this).toggleClass('btn-danger btn-info'); return false"}
     %i.icon-white.icon-trash

data/lib/rails_admin_jcrop.rb

@@ -1,10 +1,4 @@
 require "rails_admin_jcrop/engine"
-
-module RailsAdminJcrop
-  module Orm
-    autoload :ActiveRecord, 'rails_admin_jcrop/orm/active_record'
-  end
-end
-
-require 'rails_admin_jcrop/extensions/carrierwave'
-require 'rails_admin_jcrop/extensions/rails_admin'
+require 'rails_admin_jcrop/orm'
+require 'rails_admin_jcrop/asset_engine'
+require 'rails_admin_jcrop/rails_admin'

data/lib/rails_admin_jcrop/asset_engine.rb

@@ -0,0 +1,2 @@
+require 'rails_admin_jcrop/asset_engine/carrier_wave' if defined?(::CarrierWave)
+require 'rails_admin_jcrop/asset_engine/paperclip' if defined?(::Paperclip)

data/lib/rails_admin_jcrop/asset_engine/carrier_wave.rb

@@ -0,0 +1,67 @@
+module RailsAdminJcrop
+  module AssetEngine
+    class <<self
+      def thumbnail_names(obj, field)
+        obj.class.uploaders[field.to_sym].versions.keys
+      end
+
+      def crop!(obj, field)
+        obj.send(field).recreate_versions!
+      end
+    end
+
+    module CarrierWave
+      def rails_admin_crop
+        return unless model.rails_admin_cropping?
+        manipulate! do |img|
+          geometry = "#{model.crop_w}x#{model.crop_h}+#{model.crop_x}+#{model.crop_y}"
+          img.crop geometry
+          img
+        end
+      end
+    end
+  end
+end
+
+module CarrierWave
+  module Mount
+    module Extension
+      def self.included(base)
+        base.uploaders.each do |name, klass|
+          klass.send :include, RailsAdminJcrop::AssetEngine::CarrierWave
+        end
+      end
+    end
+  end
+end
+
+module RailsAdmin
+  module Config
+    module Fields
+      module Types
+        module UploaderMethods
+
+          def self.included(base)
+            base.register_instance_option(:cache_method) do
+              "#{name}_cache"
+            end
+
+            base.register_instance_option(:thumb_method) do
+              @thumb_method ||= ((versions = bindings[:object].send(name).versions.keys).find{|k| k.in?([:thumb, :thumbnail, 'thumb', 'thumbnail'])} || versions.first.to_s)
+            end
+
+            base.register_instance_option(:delete_method) do
+              "remove_#{name}"
+            end
+          end
+
+          def resource_url(thumb = false)
+            return nil unless (uploader = bindings[:object].send(name)).present?
+            thumb.present? ? uploader.send(thumb).url : uploader.url
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_jcrop/asset_engine/paperclip.rb

@@ -0,0 +1,86 @@
+module RailsAdminJcrop
+  module AssetEngine
+    class <<self
+      def thumbnail_names(obj, field)
+        obj.send(field).styles.keys
+      end
+
+      def crop!(obj, field)
+        obj.send(field).reprocess!
+      end
+    end
+  end
+end
+
+module Paperclip
+
+  module NewClassMethods
+    def has_attached_file(*args)
+      super
+
+      self.attachment_definitions.each do |name, options|
+        options[:processors] ||= []
+        options[:processors] << :rails_admin_jcropper
+      end
+    end
+  end
+
+  module ClassMethods
+    def self.extended(base)
+      super
+      base.send :extend, ::Paperclip::NewClassMethods
+    end
+  end
+
+  class RailsAdminJcropper < Thumbnail
+    def transformation_command
+      if @attachment.instance.rails_admin_cropping?
+        ary = super
+        if i = ary.index('-crop')
+          ary.delete_at i
+          ary.delete_at i+1
+        end
+        ['-crop', crop_params] + ary
+      else
+        super
+      end
+    end
+
+    def crop_params
+      target = @attachment.instance
+      "'#{target.crop_w.to_i}x#{target.crop_h.to_i}+#{target.crop_x.to_i}+#{target.crop_y.to_i}'"
+    end
+  end
+
+end
+
+module RailsAdmin
+  module Config
+    module Fields
+      module Types
+        module UploaderMethods
+
+          def self.included(base)
+            base.register_instance_option(:cache_method) do
+              nil
+            end
+
+            base.register_instance_option(:thumb_method) do
+              @thumb_method ||= ((styles = bindings[:object].send(name).styles.keys).find{|k| k.in?([:thumb, :thumbnail, 'thumb', 'thumbnail'])} || styles.first.to_s)
+            end
+
+            base.register_instance_option(:delete_method) do
+              nil
+            end
+          end
+
+          def resource_url(thumb = false)
+            return nil unless (attachment = bindings[:object].send(name)).present?
+            thumb.present? ? attachment.url(thumb) : attachment.url
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/rails_admin_jcrop/orm.rb

@@ -0,0 +1,41 @@
+module RailsAdminJcrop
+  module Orm
+    module Extension
+
+      CropFields = [:crop_x, :crop_y, :crop_w, :crop_h, :crop_field]
+
+      def self.included(base)
+        base.send :attr_accessor, *CropFields
+        base.after_update :rails_admin_crop_callback, :if => :rails_admin_cropping?
+      end
+
+      def rails_admin_crop_callback
+        ::RailsAdminJcrop::AssetEngine.crop!(self, self.crop_field)
+      end
+
+      def rails_admin_cropping?
+        CropFields.all? {|f| send(f).present?}
+      end
+
+      def rails_admin_crop!(params)
+        CropFields.each {|f| self.send "#{f}=", params[f] }
+        save!
+      end
+
+    end
+  end
+end
+
+if defined?(::ActiveRecord)
+  ::ActiveRecord::Base.send(:include, ::RailsAdminJcrop::Orm::Extension)
+end
+
+if defined?(::Mongoid)
+  module Mongoid
+    module Document
+      def self.included(base)
+        base.send(:include, ::RailsAdminJcrop::Orm::Extension)
+      end
+    end
+  end
+end

data/lib/rails_admin_jcrop/orm/active_record.rb

@@ -1,42 +0,0 @@
-module RailsAdminJcrop
-  module Orm
-    module ActiveRecord
-
-      CropFields = [:crop_x, :crop_y, :crop_w, :crop_h, :crop_field]
-
-      def self.included(base)
-        base.send :attr_accessor, *CropFields
-        base.after_update :rails_admin_crop_callback, :if => :rails_admin_cropping?
-
-        base.uploaders.each do |name, klass|
-          klass.send :include, CarrierWaveUploaderMixin
-        end
-      end
-
-      def rails_admin_crop_callback
-        self.send(self.crop_field).recreate_versions!
-      end
-
-      def rails_admin_cropping?
-        CropFields.all? {|f| send(f).present?}
-      end
-
-      def rails_admin_crop!(params)
-        CropFields.each {|f| self.send "#{f}=", params[f] }
-        save!
-      end
-
-      module CarrierWaveUploaderMixin
-        def rails_admin_crop
-          return unless model.rails_admin_cropping?
-          manipulate! do |img|
-            geometry = "#{model.crop_w}x#{model.crop_h}+#{model.crop_x}+#{model.crop_y}"
-            img.crop geometry
-            img
-          end
-        end
-      end
-
-    end
-  end
-end

data/lib/rails_admin_jcrop/{extensions/rails_admin.rb → rails_admin.rb}

@@ -14,26 +14,15 @@ module RailsAdmin
             :form_jcrop
           end
 
-          register_instance_option(:thumb_method) do
-            @thumb_method ||= ((versions = bindings[:object].send(name).versions.keys).find{|k| k.in?([:thumb, :thumbnail, 'thumb', 'thumbnail'])} || versions.first.to_s)
-          end
-
-          register_instance_option(:delete_method) do
-            "remove_#{name}"
-          end
-
-          register_instance_option(:cache_method) do
-            "#{name}_cache"
-          end
-
           register_instance_option(:jcrop_options) do
             {}
           end
 
-          def resource_url(thumb = false)
-            return nil unless (uploader = bindings[:object].send(name)).present?
-            thumb.present? ? uploader.send(thumb).url : uploader.url
+          register_instance_option(:fit_image) do
+            @fit_image ||= false
           end
+
+          include ::RailsAdmin::Config::Fields::Types::UploaderMethods
         end
       end
     end

data/lib/rails_admin_jcrop/version.rb

@@ -1,3 +1,3 @@
 module RailsAdminJcrop
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_admin_jcrop
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-30 00:00:00.000000000 Z
+date: 2012-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,14 +44,14 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: mini_magick
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
@@ -73,10 +73,14 @@ files:
 - config/locales/en.yml
 - config/routes.rb
 - lib/rails_admin_jcrop/version.rb
+- lib/rails_admin_jcrop/asset_engine.rb
+- lib/rails_admin_jcrop/asset_engine/paperclip.rb
+- lib/rails_admin_jcrop/asset_engine/carrier_wave.rb
 - lib/rails_admin_jcrop/engine.rb
+- lib/rails_admin_jcrop/rails_admin.rb
+- lib/rails_admin_jcrop/orm.rb
 - lib/rails_admin_jcrop/orm/active_record.rb
-- lib/rails_admin_jcrop/extensions/carrierwave.rb
-- lib/rails_admin_jcrop/extensions/rails_admin.rb
+- lib/rails_admin_jcrop/orm/mongoid.rb
 - lib/rails_admin_jcrop.rb
 - vendor/assets/images/rails_admin/Jcrop.gif
 - vendor/assets/javascripts/rails_admin/jquery.Jcrop.js

data/lib/rails_admin_jcrop/extensions/carrierwave.rb

@@ -1,9 +0,0 @@
-module CarrierWave
-  module Mount
-    module Extension
-      def self.included(base)
-        base.send :include, RailsAdminJcrop::Orm::ActiveRecord
-      end
-    end
-  end
-end