Paperclip-Autosizer 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 [name of plugin creator]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,94 @@
+=Paperclip Autosizer
+
+Paperclip Autosizer is a simple system to save "WxH" information to the database.
+The system works entirely in concert with the Paperclip API and makes no additional calls
+to imagemagick. This allows the programmer to use a stock paperclip gem or plugin
+and take advantage of upgrades to the most current version. It also runs without
+significant changes to performance or memory footprint. Compatibility problems
+should therefore be low and I hope this will be a useful safe solution for forward
+looking projects.  These were at least my specific concerns with other well written
+but forked solutions and what drove me to write this.
+
+The system operates by sending the original image dimensions from a slight subclass of
+the standard thumbnail processor to the model. Final images sizes are obtained
+through pure calculation. It sounds strange to calculate and resize an image in
+IM and then calculate that again in the model, but it's actually the best solution
+I found to this problem.  Using a few lines of already preloaded code to allocate
+space for a few integers and floats, do two or three multiplications and divisions
+and retain a single non-destroyed variable to save to the database is not high overhead.
+This is much faster than calling out to identify, more compatible across server
+environments and easy. Furthermore thanks to the elegant and little used paperclip
+api options, the autosizer only runs after a post_processing event has succeeded 
+and the sizes are written to the database during the normal rails model save method.
+Columns are auto-detected allowing for optional autosizing of each attached_file or
+specific style of attachment completely at the programmers discretion.
+
+This is my first public software so please feel free to criticize.  I know the syntax
+is pretty fast and I will make it human friendly when I get the chance.
+
+Author:: Andrew Eisberg
+Copyright:: Copyright (c) 2009 Andrew Eisberg
+License:: MIT License (http://www.opensource.org/licenses/mit-license.php)
+
+==Limitations
+
+Currently only the '>' geometry flag is written as that's what I use 99% of the time
+when I also want a size.  It would be quite easy to write in additional methods to
+support other IM geometries.  These things are really just a few lines and not the
+rocket science part of IM.
+
+==Usage
+
+To use Autosizer, simply copy the paperclip_autosizer.rb file to the models folder
+and the paperclip_processors folder to the lib folder.  Make the model you wish to
+autosize a subclass of the PaperclipAutosizer class. Tell paperclip to use the
+autosize processor (a 100% compatible subclass of the default thumbnail processor)
+and add the line +after_post_process :autosize_attached_files+ after the 
+has_attached_file declarations:
+
+  class User < PaperclipAutosizer
+    has_attached_file :avatar, :styles => { :thumb => "100x100>" },
+                               :processors => [:autosize]
+    has_attached_file :center, :styles => { :large => "500x500>" },
+                               :processors => [:autosize]
+    after_post_process :autosize_attached_files
+  end
+
+This is sufficient to handle multiple attached_files.  If only one attachment of
+many is being autosized, the stricter callback +after_<attachment>_post_process+
+can be used instead for greater efficiency.
+
+In the migration for the model, simply add columns for each attached_file/style
+combination you wish to retain sizes for. PaperclipAutosizer will see them and
+ignore any saved attachments it doesn't see columns for.  Columns must conform
+to the format +t.string :(attachment)_(style)_size+ to be recognized by the model.
+
+  t.string   :avatar_thumb_size
+  t.string   :center_large_size
+
+The sizes can then be easily called in the view.
+
+  image_tag(@user.avatar.url(:thumb), :size => @user.avatar_thumb_size)
+  image_tag(@user.center.url(:large), :size => @user.center_large_size)
+
+
+==TextMate
+
+Here is a textmate snippet you can use if you want.  If you're not used to hacking
+stuff into your TM, here's how to do it.  Make a new bundle with your name. Then a new
+snippet and paste this in.  Give it a tab trigger of 'autosizer' or what you want and
+a scope selector of 'source.ruby.rails'.  Then just type autosizer and tab in a model.
+
+	# Paperclip Method for ${1/[[:alpha:]]+|(_)/(?1::\u$0)/g} Attachment with Autosizing
+	has_attached_file :${1:attachment_name}, :styles => { :${2:large} => "${3:750}x${4:750}>",
+	                                       	:${5:thumb} => "${6:150}x${7:150}>" },
+										:processors => [:autosize],
+	                  :url  => "/system/auto_load/${1}s/:id/:style/:basename.:extension",
+	                  :path => ":rails_root/public/system/auto_load/:attachment/:id/:style/:basename.:extension",
+	                  :default_url => "/system/auto_load/defaults/default_:style.png"
+                  
+	validates_attachment_size :${1}, :less_than => 1.megabytes
+	validates_attachment_content_type :${1}, :content_type => ['image/jpeg', 'image/png']
+	after_${1}_post_process :autosize_attached_files
+
+	$0

data/Rakefile

@@ -0,0 +1,37 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'PaperclipAutosizer'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/paperclip_autosizer.rb

@@ -0,0 +1,40 @@
+class PaperclipAutosizer < ActiveRecord::Base
+  self.abstract_class = true
+
+  attr_writer :autosizer_attachment_name, :autosizer_original_file_geometry
+
+private
+  def autosizer_attachment
+    send(@autosizer_attachment_name)
+  end
+
+  def autosize_attached_files
+    styles_to_autosize.each_pair do |style, column_for_style|
+      send(:"#{column_for_style}=", calculate_size_of_reduced_image(style))
+    end
+  end
+
+  def styles_to_autosize
+    autosizer_attachment.styles.keys.inject({}) do |accumulator, style|
+      column_for_style = [@autosizer_attachment_name, style.to_s, "size"].join("_")
+      if self.class.column_names.include?(column_for_style)
+        accumulator[style] = column_for_style
+      end
+      accumulator
+    end
+  end
+
+  def calculate_size_of_reduced_image(style)
+    target_width, target_height = autosizer_attachment.styles[style][:geometry].split("x").collect{|x| x.to_f}
+    width, height = @autosizer_original_file_geometry.width, @autosizer_original_file_geometry.height
+    original_ratio = width.to_f / height.to_f
+    if (original_ratio <= 1 && target_height < height)
+      width  = original_ratio * target_height
+      height = target_height
+    elsif (target_width < width)
+      width  = target_width
+      height = (1 / original_ratio) * target_width
+    end
+    [width.round, height.round].join("x")
+  end
+end

data/lib/paperclip_processors/autosize.rb

@@ -0,0 +1,9 @@
+module Paperclip
+  class Autosize < Thumbnail
+    def initialize file, options = {}, attachment = nil
+      super
+      attachment.instance.send(:autosizer_attachment_name=, attachment.name.to_s)
+      attachment.instance.send(:autosizer_original_file_geometry=, @current_geometry)
+    end
+  end
+end

data/lib/photo.rb

@@ -0,0 +1,29 @@
+class Photo < PaperclipAutosizer
+
+  # Paperclip Method for Photograph Attachment
+  has_attached_file :photograph, :styles => { :large => "750x750>",
+                                              :thumb => "150x150>" },
+                    :processors => [:autosize],
+                    :url  => "/images/auto_load/photographs/:id/:style/:basename.:extension",
+                    :path => ":rails_root/public/images/auto_load/:attachment/:id/:style/:basename.:extension",
+                    :default_url => "/images/auto_load/defaults/default_:style.png"
+                    
+  validates_attachment_size :photograph, :less_than => 1.megabytes
+  validates_attachment_content_type :photograph, :content_type => ['image/jpeg', 'image/png']
+  after_photograph_post_process :autosize_attached_files
+
+  
+
+  # Paperclip Method for Micrograph Attachment
+  has_attached_file :micrograph, :styles => { :large => "750x750>",
+                                              :thumb => "150x150>" },
+                    :processors => [:autosize],
+                    :url  => "/images/auto_load/micrographs/:id/:style/:basename.:extension",
+                    :path => ":rails_root/public/images/auto_load/:attachment/:id/:style/:basename.:extension",
+                    :default_url => "/images/auto_load/defaults/default_:style.png"
+                    
+  validates_attachment_size :micrograph, :less_than => 1.megabytes
+  validates_attachment_content_type :micrograph, :content_type => ['image/jpeg', 'image/png']
+  after_micrograph_post_process :autosize_attached_files
+
+end

data/lib/tasks/paperclip_autosizer.rake

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

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'

data/test/test_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class TestTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: Paperclip-Autosizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Eisberg
+- Ben Woosley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-11 00:00:00.000000000Z
+dependencies: []
+description: Insert PaperclipAutosizer description.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/paperclip_autosizer.rb
+- lib/paperclip_processors/autosize.rb
+- lib/photo.rb
+- lib/tasks/paperclip_autosizer.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- test/test_helper.rb
+- test/test_test.rb
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -1675942464531920957
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Insert PaperclipAutosizer summary.
+test_files:
+- test/test_helper.rb
+- test/test_test.rb