jcropper 0.3.3 → 0.4.0

data/README.rdoc

@@ -50,6 +50,11 @@ Add the helpers to your view:
   <%= croppable_image @user, :avatar, :thumb -%>
   <%= croppable_image_preview @user, :avatar, :thumb -%>
   
+  Optional syntax, with :user being the name for the form submit.
+  <%= croppable_image [@site.user, :user], :avatar, :thumb -%>
+  <%= croppable_image_preview [@site.user, :user], :avatar, :thumb -%>
+
+  
 Helper Options:
   :css_prefix => 'jcrop',
   :width => 100, :height => 100,
@@ -61,9 +66,10 @@ Helper Options:
 - jcropper currently only supports ONE cropped style per attachment, one cropped attachment per model
 - croppedImage.jcrop gets you the jcrop api object (see jcrop docs)
 - in helpers, :aspect_ratio defaults to the aspect ratio of the original image
-- in helpers, width and height default to the target geometry for the style
+- in helpers, width and height default to the target geometry for the style. if you override one of width/height you must override both
 - you'll have to read the jcropper.js source for function docs there
-- tried only on rails 2.3.5 and ruby 1.8.7
+- should be working on ruby 1.8/1.9 and rails 2.3/3, although it has not been thoroughly tested
+- jcrop :avatar, :thumb, :maintain_aspect_ratio => true will lock aspect_ratio to the target geometry and default to a north/center max crop
 - test/code ratio is 0
 
 Copyright (c) 2010 Symbolforce, LLC., released under the MIT license

data/Rakefile

@@ -6,7 +6,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
     gemspec.name = "jcropper"
-    gemspec.summary = "gem plugin wrapping jquery "
+    gemspec.summary = "gem plugin wrapping jquery.jcrop.js "
     gemspec.description = ""
     gemspec.email = "ryan@symbolforce.com"
     gemspec.homepage = "http://github.com/syfo/jcropper"

data/TODO

@@ -17,4 +17,5 @@
 - is it really necc to have a paperclip processor?
 - use inline css or separate css
 - reset cropping when uploading new image
-- make options[:view_size] work
+- make options[:view_size] work
+- add a crop_updated_at field

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.4.0

data/generators/jcropper/jcropper_generator.rb

@@ -1,5 +1,5 @@
 class JcropperGenerator < Rails::Generator::NamedBase
-  attr_accessor :attachment, :migration_name, :style
+  attr_accessor :attachment, :style
  
   def initialize(args, options = {})
     super
@@ -7,6 +7,10 @@ class JcropperGenerator < Rails::Generator::NamedBase
     @class_name, @attachment, @style = args[0], args[1], args[2]
   end
  
+  def migration_name
+    @migration_name.underscore
+  end
+ 
   def manifest    
     file_name = generate_file_name
     @migration_name = file_name.camelize

data/generators/jcropper/templates/jcropper_migration.rb.erb

@@ -1,4 +1,4 @@
-class <%= migration_name %> < ActiveRecord::Migration
+class <%= migration_name.camelize %> < ActiveRecord::Migration
   def self.up
     add_column :<%= class_name.underscore.camelize.tableize %>, :<%= JCropper.jattr attachment, style, :x %>, :integer, :default => 0
     add_column :<%= class_name.underscore.camelize.tableize %>, :<%= JCropper.jattr attachment, style, :y %>, :integer, :default => 0

data/jcropper.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jcropper}
-  s.version = "0.3.3"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Ziegler"]
-  s.date = %q{2010-06-11}
+  s.date = %q{2011-05-09}
   s.description = %q{}
   s.email = %q{ryan@symbolforce.com}
   s.extra_rdoc_files = [
@@ -28,18 +28,20 @@ Gem::Specification.new do |s|
      "generators/jcropper/templates/jcropper_migration.rb.erb",
      "install.rb",
      "jcropper.gemspec",
+     "lib/generators/jcropper/jcropper_generator.rb",
      "lib/jcropper.rb",
      "lib/jcropper/cropped_image.rb",
      "lib/jcropper/helpers.rb",
      "lib/jcropper/jcropper.rb",
      "lib/jcropper/tasks.rb",
      "lib/paperclip_processors/jcropper.rb",
+     "lib/railtie.rb",
+     "lib/tasks/jcropper.rake",
      "public/images/Jcrop.gif",
      "public/javascripts/jcropper.js",
      "public/javascripts/jquery.Jcrop.min.js",
      "public/stylesheets/jquery.Jcrop.css",
      "rails/init.rb",
-     "tasks/jcropper.rake",
      "test/jcropper_test.rb",
      "test/test_helper.rb",
      "uninstall.rb"
@@ -48,7 +50,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{gem plugin wrapping jquery}
+  s.summary = %q{gem plugin wrapping jquery.jcrop.js}
   s.test_files = [
     "test/jcropper_test.rb",
      "test/test_helper.rb"

data/lib/generators/jcropper/jcropper_generator.rb

@@ -0,0 +1,35 @@
+require 'rails/generators/active_record'
+
+class JcropperGenerator < ActiveRecord::Generators::Base
+  desc "Create a migration to add jcropper-specific fields to your model."
+ 
+#  argument :model, :required => true, :type => :string, :desc => "The name of the ActiveRecord model", :banner => "<Model>"
+  argument :attachment, :required => true, :type => :string, :desc => "The name of the paperclip attachment", :banner => "<attachment>"
+  argument :style, :required => true, :type => :string, :desc => "", :banner => "<style>"
+
+  def self.source_root
+    @source_root ||= File.expand_path('../../../../generators/jcropper/templates', __FILE__)
+  end
+
+  def generate_migration
+    migration_template "jcropper_migration.rb.erb", "db/migrate/#{migration_file_name}"
+  end
+
+  protected
+
+  def banner
+    "<Model>"
+  end
+
+  def migration_name
+    "add_crop_variables_for_#{attachment}_#{style}_to_#{name.underscore}"
+  end
+
+  def migration_file_name
+    "#{migration_name}.rb"
+  end
+
+  def migration_class_name
+    migration_name.camelize
+  end
+end

data/lib/jcropper.rb

@@ -1,5 +1,8 @@
-ROOT = File.join(File.dirname(__FILE__), 'jcropper')
-require File.join(ROOT, 'jcropper')
-require File.join(ROOT, 'helpers')
-require File.join(ROOT, 'cropped_image')
-Paperclip.autoload 'Jcropper', File.join(ROOT, '../paperclip_processors/jcropper.rb')
+require 'railtie' if defined?(Rails) and Rails.version.split('.').first.to_i > 2
+root = File.join(File.dirname(__FILE__), 'jcropper')
+require File.join(root, 'jcropper')
+require File.join(root, 'helpers')
+require File.join(root, 'cropped_image')
+
+#Paperclip.autoload 'Jcropper', File.join(root, '../paperclip_processors/jcropper.rb')
+require File.join(root, '../paperclip_processors/jcropper.rb')

data/lib/jcropper/cropped_image.rb

@@ -1,9 +1,10 @@
 module JCropper
   class CroppedImage
-    attr_reader :original_geometry, :cropped_geometry, :attachment_name, :style_name, :coord_names, :starting_crop, :attachment
+    attr_reader :original_geometry, :cropped_geometry, :attachment_name, :style_name, :coord_names, :starting_crop, :attachment, :options
     
-    def initialize(object)
+    def initialize(object, options)
       @object = object
+      @options = options
       @attachment_name = object.class.jcropper_defs[:attachment]
       @style_name = object.jcropper_defs[:style]
       @attachment = object.send(attachment_name)  
@@ -25,9 +26,19 @@ module JCropper
     def target_geometry
       @target_geometry ||= Paperclip::Geometry.parse(@object.send(attachment_name).styles[style_name.to_sym][:geometry])
     end
-    
+        
     def max_crop
-      [0, 0, original_geometry.width, original_geometry.height]
+      if options[:maintain_aspect_ratio]
+        north_center_gravity_max_crop
+      else
+        [0, 0, original_geometry.width, original_geometry.height]
+      end
+    end
+    
+    def north_center_gravity_max_crop
+      scale = JCropper.find_bounding_scale([original_geometry.width, original_geometry.height], [target_geometry.width, target_geometry.height])
+      final_size = {:width => scale*target_geometry.width, :height => scale*target_geometry.height}
+      [(original_geometry.width - final_size[:width]) / 2, 0, final_size[:width], final_size[:height]].map &:to_i
     end
   end
 end

data/lib/jcropper/helpers.rb

@@ -1,23 +1,23 @@
 module JCropper 
   module Helpers
-    def croppable_image(object_name, attachment, style, options = {})
-      object = eval("@#{object_name.to_s}") unless object_name.is_a? ActiveRecord::Base
-      options[:view_size] = {:width => options.delete(:width), :height => options.delete(:height)}
+    def croppable_image(object_and_name, attachment, style, options = {})
+      object, name = split_object_and_name(object_and_name)
+      options[:view_size] = {:width => options.delete(:width), :height => options.delete(:height)} if options[:width] and options[:height]
       return unless options = parse_options(object, options)
 
       ###CRZ - duplicated in JS!
-      view_scale = find_bounding_scale([options[:view_size][:width], options[:view_size][:height]],
+      view_scale = JCropper.find_bounding_scale([options[:view_size][:width], options[:view_size][:height]],
                     [options[:original_geometry][:width], options[:original_geometry][:height]])
 
       scaled_img_dims = {:width => options[:original_geometry][:width]*view_scale, :height => options[:original_geometry][:height]*view_scale}
       s = "<div class='#{options[:css_prefix]}'>#{image_tag(object.send(attachment).url, scaled_img_dims.merge(:id => options[:id]))}</div>" + "\n"
-      s += hidden_field_tag("#{object_name}[#{@js_cropper_c_i.coord_names[:x]}]", @js_cropper_c_i.starting_crop[:x], :id => @js_cropper_c_i.coord_names[:x]) + "\n"
-      s += hidden_field_tag("#{object_name}[#{@js_cropper_c_i.coord_names[:y]}]", @js_cropper_c_i.starting_crop[:y], :id => @js_cropper_c_i.coord_names[:y]) + "\n"
-      s += hidden_field_tag("#{object_name}[#{@js_cropper_c_i.coord_names[:w]}]", @js_cropper_c_i.starting_crop[:w], :id => @js_cropper_c_i.coord_names[:w]) + "\n"
-      s += hidden_field_tag("#{object_name}[#{@js_cropper_c_i.coord_names[:h]}]", @js_cropper_c_i.starting_crop[:h], :id => @js_cropper_c_i.coord_names[:h]) + "\n"
+      s += hidden_field_tag("#{name}[#{@js_cropper_c_i.coord_names[:x]}]", @js_cropper_c_i.starting_crop[:x], :id => @js_cropper_c_i.coord_names[:x]) + "\n"
+      s += hidden_field_tag("#{name}[#{@js_cropper_c_i.coord_names[:y]}]", @js_cropper_c_i.starting_crop[:y], :id => @js_cropper_c_i.coord_names[:y]) + "\n"
+      s += hidden_field_tag("#{name}[#{@js_cropper_c_i.coord_names[:w]}]", @js_cropper_c_i.starting_crop[:w], :id => @js_cropper_c_i.coord_names[:w]) + "\n"
+      s += hidden_field_tag("#{name}[#{@js_cropper_c_i.coord_names[:h]}]", @js_cropper_c_i.starting_crop[:h], :id => @js_cropper_c_i.coord_names[:h]) + "\n"
       s += <<-JS
         <script type="text/javascript">
-          #{options[:js_object]} = new CroppedImage(jQuery('.#{options[:css_prefix]} img'),
+          #{options[:js_object]} = new CroppedImage('.#{options[:css_prefix]} img',
             $.extend(
               #{camelize_keys(options).to_json},
               {
@@ -28,12 +28,13 @@ module JCropper
           );
         </script>
       JS
-      s
+      
+      respond_to?(:raw) ? raw(s) : s
     end
     
-    def croppable_image_preview(object_name, attachment, style, options = {})
-      object = eval("@#{object_name.to_s}") unless object_name.is_a? ActiveRecord::Base      
-      options[:preview_size] = {:width => options.delete(:width), :height => options.delete(:height)}
+    def croppable_image_preview(object_and_name, attachment, style, options = {})
+      object, name = split_object_and_name(object_and_name)
+      options[:preview_size] = {:width => options.delete(:width), :height => options.delete(:height)} if options[:width] and options[:height]
       return unless options = parse_options(object, options)
       
       s = <<-HTML
@@ -41,7 +42,7 @@ module JCropper
         #{image_tag(@js_cropper_c_i.attachment.url(:original), :class => "#{options[:css_prefix]}-preview")}
       </div>
       HTML
-      s
+      respond_to?(:raw) ? raw(s) : s
     end
     
     private
@@ -50,19 +51,15 @@ module JCropper
         h.merge(pair[0].to_s.camelize(:lower) => pair[1])
       end
     end
-    
-    def find_bounding_scale(container, to_contain)
-      to_contain_aspect = to_contain[0].to_f / to_contain[1]
-      container_aspect = container[0].to_f / container[1]
-
-      if to_contain_aspect > container_aspect
-        return (container[0].to_f / to_contain[0]);
+        
+    def split_object_and_name(object_and_name)
+      if object_and_name.is_a? Array
+        object_and_name
       else
-        return (container[1].to_f / to_contain[1]);
+        [eval("@#{object_and_name.to_s}"), object_and_name]
       end
     end
     
-    
     def parse_options(object, options = {})
       @js_cropper_c_i ||= object.cropped_image
       
@@ -76,7 +73,8 @@ module JCropper
         :aspect_ratio => @js_cropper_c_i.target_geometry.width / @js_cropper_c_i.target_geometry.height,
         :original_geometry => {:width => @js_cropper_c_i.original_geometry.width, :height => @js_cropper_c_i.original_geometry.height},
         :starting_crop => @js_cropper_c_i.starting_crop,
-        :js_object => 'croppedImage'
+        :js_object => 'croppedImage' + SecureRandom.hex(10),
+        :jcrop_options => @js_cropper_c_i.options[:maintain_aspect_ratio] ? {:aspectRatio => @js_cropper_c_i.target_geometry.width / @js_cropper_c_i.target_geometry.height} : {}
       }.merge(@js_cropper_options.merge(options))
     end
   end

data/lib/jcropper/jcropper.rb

@@ -1,6 +1,17 @@
 module JCropper
+  def self.find_bounding_scale(container, to_contain)
+    to_contain_aspect = to_contain[0].to_f / to_contain[1]
+    container_aspect = container[0].to_f / container[1]
+
+    if to_contain_aspect > container_aspect
+      return (container[0].to_f / to_contain[0]);
+    else
+      return (container[1].to_f / to_contain[1]);
+    end
+  end
+  
   module ClassMethods
-    def jcrop(attachment, style)
+    def jcrop(attachment, style, options = {})
       raise "jcropper requires attachment to be of type Paperclip::Attachment" if self.attachment_definitions[attachment.to_sym].nil?
       
       attr_reader :cropped_image
@@ -11,12 +22,23 @@ module JCropper
       after_save :jcropper_reprocess
 
       x, y, w, h = [:x, :y, :w, :h].map{|coord| JCropper.jattr(attachment, style, coord) }
-      to_eval = <<-TO_EVAL
-        ###CRZ - alias chain this
-        def after_initialize
-          @cropped_image = CroppedImage.new(self)
-        end
-        
+      if defined?(Rails) and Rails.version.split('.').first.to_i > 2
+        to_eval = <<-TO_EVAL
+          after_initialize :jcropper_initialize
+          def jcropper_initialize
+            @cropped_image = CroppedImage.new(self, #{options.to_hash})
+          end
+        TO_EVAL
+      else
+        to_eval = <<-TO_EVAL
+          ###CRZ - alias chain this
+          def after_initialize
+            @cropped_image = CroppedImage.new(self, #{options.to_hash})
+          end
+        TO_EVAL
+      end        
+
+      to_eval += <<-TO_EVAL
         def jcropper_reprocess
           cropped_image.attachment.reprocess! if @jcropper_should_reprocess
         end

data/lib/railtie.rb

@@ -0,0 +1,10 @@
+require 'jcropper'
+require 'rails'
+
+module Jcropper
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/jcropper.rake"
+    end
+  end
+end

data/{tasks → lib/tasks}/jcropper.rake

@@ -1,7 +1,7 @@
 namespace :jcropper do
   desc "Install .CSS and .js files required for view helpers to function. Will not overwrite"
   task :install => :environment do
-    root = File.join(File.dirname(__FILE__), '..')
+    root = File.join(File.dirname(__FILE__), '../../')
     install_file(File.join(root, 'public/images/Jcrop.gif'), File.join(Rails.root, 'public/images/Jcrop.gif'))
     install_file(File.join(root, 'public/javascripts/jquery.Jcrop.min.js'), File.join(Rails.root, 'public/javascripts/jquery.Jcrop.min.js'))
     install_file(File.join(root, 'public/javascripts/jcropper.js'), File.join(Rails.root, 'public/javascripts/jcropper.js'))

data/public/javascripts/jcropper.js

@@ -30,7 +30,7 @@ CroppedImage = function(image, properties) {
   t.log = function() {
     try {
       if(typeof console == 'object' && typeof console.log == 'function') {
-        console.log.apply(this, arguments);
+        console.log.apply(console, arguments);
       }
     } catch(e) {;}
   }

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jcropper
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 3
-  version: 0.3.3
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Ryan Ziegler
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-11 00:00:00 -04:00
+date: 2011-05-09 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -40,18 +40,20 @@ files:
 - generators/jcropper/templates/jcropper_migration.rb.erb
 - install.rb
 - jcropper.gemspec
+- lib/generators/jcropper/jcropper_generator.rb
 - lib/jcropper.rb
 - lib/jcropper/cropped_image.rb
 - lib/jcropper/helpers.rb
 - lib/jcropper/jcropper.rb
 - lib/jcropper/tasks.rb
 - lib/paperclip_processors/jcropper.rb
+- lib/railtie.rb
+- lib/tasks/jcropper.rake
 - public/images/Jcrop.gif
 - public/javascripts/jcropper.js
 - public/javascripts/jquery.Jcrop.min.js
 - public/stylesheets/jquery.Jcrop.css
 - rails/init.rb
-- tasks/jcropper.rake
 - test/jcropper_test.rb
 - test/test_helper.rb
 - uninstall.rb
@@ -88,7 +90,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: gem plugin wrapping jquery
+summary: gem plugin wrapping jquery.jcrop.js
 test_files: 
 - test/jcropper_test.rb
 - test/test_helper.rb