thumbnail_on_demand 0.0.0 → 0.1.0

data/Gemfile

@@ -11,3 +11,8 @@ group :development do
   gem "jeweler", "~> 1.6.4"
   gem "rcov", ">= 0"
 end
+
+group :test do
+  gem "activerecord", "~> 3.0"
+  gem "paperclip", "~> 2.4.4"
+end

data/Gemfile.lock

@@ -1,12 +1,34 @@
 GEM
   remote: http://rubygems.org/
   specs:
+    activemodel (3.1.1)
+      activesupport (= 3.1.1)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.1)
+      activemodel (= 3.1.1)
+      activesupport (= 3.1.1)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activesupport (3.1.1)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    builder (3.0.0)
+    cocaine (0.2.0)
     diff-lcs (1.1.3)
     git (1.2.5)
+    i18n (0.6.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
+    mime-types (1.16)
+    multi_json (1.0.3)
+    paperclip (2.4.5)
+      activerecord (>= 2.3.0)
+      activesupport (>= 2.3.2)
+      cocaine (>= 0.0.2)
+      mime-types
     rake (0.9.2)
     rcov (0.9.11)
     rspec (2.3.0)
@@ -17,12 +39,15 @@ GEM
     rspec-expectations (2.3.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.3.0)
+    tzinfo (0.3.30)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord (~> 3.0)
   bundler (~> 1.0.0)
   jeweler (~> 1.6.4)
+  paperclip (~> 2.4.4)
   rcov
   rspec (~> 2.3.0)

data/VERSION

@@ -1 +1 @@
-0.0.0
+0.1.0

data/lib/thumbnail_on_demand.rb

@@ -0,0 +1,81 @@
+Paperclip::Attachment.class_eval do
+
+  IMAGE_EXTENSIONS = [".jpg", ".jpeg", ".jpe", ".png", ".gif", ".bmp"]
+
+  # Creates a thumbnail if it doesn't already exist and not if it does. Either way, it returns the URL to the thumbnail
+  #
+  # @param [Symbol] style A symbol telling which style to use (from the :on_demand_styles option)
+  # @param [Symbol] from_style A symbol telling which paperclip style to create the thumbnail from.
+  #   If either nil or :original it will use the originally uploaded image (default_style)
+  # @param [Object] options An object of url options, same as the second param in paperclip's url method
+  # @return [String] The URL to the thumbnail
+  # TODO check to be sure the attachment is an image (thumbnailable)?
+  # TODO S3/other storage support
+  # TODO should remove thumbnails when removing the orginal paperclip attachment
+  # TODO would be nice to have the ability to crop default_url according to the requested style
+  def thumbnail(style_name, from_style = nil, options = {})
+    options = handle_url_options(options)
+    thumbnail_url = interpolate(most_appropriate_url, style_name)
+    thumbnail_path = original_filename.nil? ? nil : interpolate(@options.path, style_name)
+    # Since this add-on only supports images, make sure thumbnail_path is going to save with an image file extension.
+    # Otherwise it will save an image with the extension of the original file, which will be wrong if the original isn't an image.
+    # We do this to support thumbnailing of other attachment types, such as video (see README.rdoc for an example).
+    # TODO we shouldn't just assume jpg format when picking an image extension to add
+    unless IMAGE_EXTENSIONS.include? File.extname(thumbnail_path)
+      thumbnail_path = "#{thumbnail_path}#{IMAGE_EXTENSIONS.first}"
+      thumbnail_url = "#{thumbnail_url}#{IMAGE_EXTENSIONS.first}"
+    end
+    # Initalize original_path using the default_style (original attachment)
+    original_path = original_filename.nil? ? nil : interpolate(@options.path, default_style)
+    # We can optionally create the thumbnail from another (non on-demand) style and set original_path to that instead
+    # TODO test to be sure from_style is in @options.styles
+    # TODO if from_style isn't found in @options.styles also check @options.raw_options[:on_demand_styles] and attempt to use it from there
+    unless from_style.nil? || from_style == :original
+      # get the path to the thumbnail
+      from_style_path = original_filename.nil? ? nil : interpolate(@options.path, from_style)
+      # only try to use it if that file exists
+      if File.exists? from_style_path
+        original_path = from_style_path
+      end
+    end
+
+    # If thumbnail_path or original_filename is nil then we have no image so we'll let it return the default_url
+    unless thumbnail_path.nil? || original_filename.nil? || !File.exists?(original_path)
+      # If the file doesn't exist we need to make it first
+      unless File.exists?(thumbnail_path)
+        begin
+          # TODO should create this on init of paperclip somehow and not here?
+          style = Paperclip::Style.new(style_name, @options.raw_options[:on_demand_styles][:"#{style_name}"], self)
+          original_file = File.new(original_path)
+          if original_file && original_file.size > 0
+            temp_thumbnail = Paperclip.processor(:thumbnail).make(original_file, style.processor_options, self)
+            original_file.close
+            if temp_thumbnail && temp_thumbnail.size > 0
+              # If the folder doesn't exist, make it
+              FileUtils.mkdir_p(File.dirname(thumbnail_path))
+              # Save the thumnail to thumbnail_path
+              FileUtils.cp(temp_thumbnail.path, thumbnail_path)
+              # Close and unlink the tempfile
+              temp_thumbnail.close!
+            else
+              thumbnail_url = interpolate(default_url, style_name)
+            end
+          else
+            thumbnail_url = interpolate(default_url, style_name)
+          end
+        rescue
+          thumbnail_url = interpolate(default_url, style_name)
+        end
+      end
+    else
+      thumbnail_url = interpolate(default_url, style_name)
+    end
+
+    thumbnail_url = url_timestamp(thumbnail_url) if options[:timestamp]
+    thumbnail_url = escape_url(thumbnail_url)    if options[:escape]
+    thumbnail_url
+  end
+
+end
+
+class ThumbnailOnDemandError < StandardError; end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
+require 'active_record'
+require 'paperclip'
 require 'thumbnail_on_demand'
 
 # Requires supporting files with custom matchers and macros, etc,

data/spec/thumbnail_on_demand_spec.rb

@@ -1,7 +1,17 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
-describe "ThumbnailOnDemand" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
+class TestModel < ActiveRecord::Base
+  include Paperclip
+  has_attached_file   :attachment,
+                      :styles => { :large => '1000x1000>'},
+                      :on_demand_styles => { :small => "600x600>" }
+end
+
+describe ThumbnailOnDemand do
+  before(:each) do
+
+  end
+  describe "#thumbnail" do
+    it "should return a string"
   end
 end

data/thumbnail_on_demand.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{thumbnail_on_demand}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Jonathan Dean}]
+  s.date = %q{2011-10-27}
+  s.description = %q{An add-on to paperclip that allows for on-demand, cached thumbnail creation}
+  s.email = %q{jon@jonathandean.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/thumbnail_on_demand.rb",
+    "spec/spec_helper.rb",
+    "spec/thumbnail_on_demand_spec.rb",
+    "thumbnail_on_demand.gemspec"
+  ]
+  s.homepage = %q{http://github.com/jonathandean/thumbnail_on_demand}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.6}
+  s.summary = %q{An add-on to paperclip that allows for on-demand, cached thumbnail creation}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thumbnail_on_demand
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-20 00:00:00.000000000Z
+date: 2011-10-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70187281868740 !ruby/object:Gem::Requirement
+  requirement: &70355859360900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.0
   type: :development
   prerelease: false
-  version_requirements: *70187281868740
+  version_requirements: *70355859360900
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70187281868260 !ruby/object:Gem::Requirement
+  requirement: &70355859360420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70187281868260
+  version_requirements: *70355859360420
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70187281867780 !ruby/object:Gem::Requirement
+  requirement: &70355859322820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70187281867780
+  version_requirements: *70355859322820
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70187281863200 !ruby/object:Gem::Requirement
+  requirement: &70355859322340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70187281863200
+  version_requirements: *70355859322340
 description: An add-on to paperclip that allows for on-demand, cached thumbnail creation
 email: jon@jonathandean.com
 executables: []
@@ -74,6 +74,7 @@ files:
 - lib/thumbnail_on_demand.rb
 - spec/spec_helper.rb
 - spec/thumbnail_on_demand_spec.rb
+- thumbnail_on_demand.gemspec
 homepage: http://github.com/jonathandean/thumbnail_on_demand
 licenses:
 - MIT
@@ -89,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1674008596836906761
+      hash: 1666669109934222201
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: