enhance 0.0.10 → 0.1.0

data/README.md

@@ -14,11 +14,15 @@ Rails
 
 In your Gemfile
 
-    gem 'enhance', '~> 0.0.8'
+    gem 'enhance', '~> 0.1.0'
 
 In your application.rb file
 
-    config.middleware.use "Enhance::Enhancer", Rails.root, :routes => [:attachments, :images]
+    config.middleware.use "Enhance::Enhancer" do |config|
+      config.match "images", "app/assets/images"
+      config.match "attachments", "app/public/attachments"
+      config.quality = 80
+    end
     
 In your views:
 
@@ -44,26 +48,18 @@ Example of matched URI:
 Config Options
 --------------
 
-    Enhance::Enhancer.new next_in_chain, root, options
+    Enhance::Enhancer.new next_in_chain do |config|
+      # ...
+    end
     
 * next_in_chain: Next Rack Application to use
-* root: Where the paths are constructed from
-* options: described next
 
-Options
+Config methods
 -------
 
-* extensions: list of supported extensions | [jpg, png, jpeg, gif]
-* routes: list of matched routes | images
-* quality: quality of output images | 100
-* folders: list of folders to look in | ["public"]
-* command_path: path for imagemagick if not in PATH | Paperclip config if available
-* cache: folder in which to cache enhanced images | "#{root}/tmp/enhanced"
-* max_side: maximum size of the enhanced image | 1024
-* file_root: root of the server if not the same as root | root
-
-
-Future changes
---------------
-
-* I'll probably redo the config to use a block instead of a hash.
+* match(route, path): Match the route and look in path for the images | "", "./"
+* extensions=: list of supported extensions | [jpg, png, jpeg, gif]
+* quality=: quality of output images | 100
+* command_path=: path for imagemagick if not in PATH | Paperclip config if available
+* cache=: folder in which to cache enhanced images | "./tmp/enhanced"
+* max_side=: maximum size of the enhanced image | 1024

data/lib/enhance.rb

@@ -1,10 +1,9 @@
 require 'utilities'
 require 'fileutils'
+require 'cgi'
 
-require File.join(File.dirname(__FILE__), 'enhance/urlhelper')
+module Enhance; end
 
-module Enhance
-  %w( Enhancer ).each do |class_name|
-    autoload class_name.to_sym, File.join(File.dirname(__FILE__), "enhance/#{class_name.downcase}")
-  end
+%w( urlhelper enhancer config ).each do |file|
+  require File.join(File.dirname(__FILE__), "enhance/#{file}")
 end

data/lib/enhance/config.rb

@@ -0,0 +1,42 @@
+class Enhance::Config
+  
+  attr_reader :cache, :quality, :max_side, :command_path, :extensions, :routes, :server
+  
+  def initialize
+    @routes       = {}
+    @quality      = 100
+    @max_side     = 1024
+    @command_path = "#{Paperclip.options[:command_path] if defined?(Paperclip)}"
+    @extensions   = %w( jpg png jpeg gif )
+    
+    self.cache    = File.join('tmp', 'enhance')
+  end
+  
+  def match(route, path)
+    @routes[route] = path
+  end
+  
+  def cache=(path)
+    FileUtils.mkdir_p(path)
+    path = File.realpath(path)
+    @cache = path
+    @server = Rack::File.new(@cache)
+  end
+  
+  def quality=(q)
+    @quality = q
+  end
+  
+  def max_side=(m)
+    @max_side = m
+  end
+  
+  def command_path=(path)
+    @command_path = path
+    @command_path += "/" unless @command_path.empty?
+  end
+  
+  def extensions=(*extensions)
+    @extensions = extensions
+  end
+end

data/lib/enhance/enhancer.rb

@@ -1,56 +1,60 @@
-require 'cgi'
 class Enhance::Enhancer
   
   Geometry =  /^(?<geometry>(?<width>\d+)?x?(?<height>\d+)?([\>\<\@\%^!])?)(?<filter>sample)?$/
   
-  ## Options
-  # extensions : list of supported extensions
-  # routes : list of matched routes
-  # folders : list of folders to look in
-  # quality : quality of output images
-  # command_path : path for imagemagick if not in PATH
-  # cache : folder in which to cache enhanced images
-  # max_side : maximum size of the enhanced image
-  # file_root : root of the server if not the same as root
-  def initialize app, root, options = {}
-    root = root.call if root.respond_to? :call
+  def initialize app = nil
     @app = app
-    @extensions = [options[:extensions] || %w( jpg png jpeg gif )].flatten
-    @routes = options[:routes] || %w( images )
-    folders = options[:folders].respond_to?(:call) ? options[:folders].call : options[:folders]
-    @folders = [folders || File.join(root, "public")].flatten.compact
-    @quality = options[:quality] || 100
-    @command_path = options[:convert_path] || "#{Paperclip.options[:command_path] if defined?(Paperclip)}"
-    @command_path += "/" unless @command_path.empty?
-    @cache = options[:cache] || File.join(root, "tmp", "enhanced")
-    @max_side = options[:max_side] || 1024
-    @file_root = (options[:file_root] || root).to_s
-    @server = Rack::File.new(@file_root)
+    @config = Enhance::Config.new
+    yield @config if block_given?
   end
   
   def call env
-    matches = env['PATH_INFO'].match /(?<filename>(#{@routes.join("|")}).*(#{@extensions.join("|")}))\/(?<geometry>.*)/i
+    matches = path_info(env).match regex
     if matches && !matches['filename'].include?("..")
       dup._call env, matches
     else
-      @app.call env
+      _next env
     end
   end
   
   def _call env, matches
-    request = @folders.collect_first do |f| 
-      f = File.join(f, matches['filename'])
-      File.exists?(f) ? f : nil
-    end
+    folder = @config.routes[matches[:folder]] || Dir.pwd
+    
+    request   = File.join(folder, matches['filename'])
+    destname  = File.join(*[matches['folder'], matches['filename']].reject{|s| s.nil? || s.empty?}.compact)
     
-    if request && (filename = convert(request, matches['filename'], CGI.unescape(matches['geometry']))) && filename.gsub!(/^#{@file_root}/, '')
+    if request && File.exists?(request) && (filename = convert(request, destname, CGI.unescape(matches['geometry'])))
+      filename.gsub!(@config.cache, '')
       env["PATH_INFO"] = filename
-      @server.call env
+      @config.server.call env
     else
+      _next env
+    end
+  end
+  
+  def _next(env)
+    if @app
       @app.call env
+    else
+      content = "Not Found"
+      [404, {'Content-Type' => 'text/html', 'Content-Length' => content.length.to_s}, [content]]
+    end
+  end
+  
+  def path_info(env)
+    # Matches for Rails using no config
+    if @config.routes.empty? && (info = env["action_dispatch.request.path_parameters"])
+      [info[:path], info[:format]].compact.join(".")
+    else
+      env['PATH_INFO']
     end
   end
   
+  def regex
+    folders = @config.routes.keys
+    /^\/?(?<folder>#{folders.join('|')})\/?(?<filename>.*\.(#{@config.extensions.join('|')}))\/(?<geometry>.*)/i
+  end
+  
   # Finds the image and resizes it if needs be
   def convert path, filename, geometry
     # Extract the width and height
@@ -59,37 +63,31 @@ class Enhance::Enhancer
       ow, oh = original_size path
       
       # Resize if needed
-      if (w.nil? || w.to_i <= @max_side) && (h.nil? || h.to_i <= @max_side) && (ow != w || oh != h)
-        new_name = File.join(@cache, filename, geometry) + File.extname(filename)
+      if (w.nil? || w.to_i <= @config.max_side) && (h.nil? || h.to_i <= @config.max_side) && (ow != w || oh != h)
+        new_name = File.join(@config.cache, filename, geometry) + File.extname(filename)
         resize path, new_name, geometry
-      else
-        path
       end
-    else
-      nil
     end
   end
   
   # Creates the path and resizes the images
-  def resize source, destination, geometry  
+  def resize source, destination, geometry
     FileUtils.mkdir_p File.dirname(destination)
     
     match = geometry.match Geometry
-    
+
     method = match['filter'] || 'resize'
-    
     unless File.exists?(destination) && File.mtime(destination) > File.mtime(source)
-      command = "#{@command_path}convert \"#{source}\" -#{method} \"#{match['geometry']}\" -quality #{@quality} \"#{destination}\""
+      command = "#{@config.command_path}convert \"#{source}\" -#{method} \"#{match['geometry']}\" -quality #{@config.quality} \"#{destination}\""
       puts command
       `#{command}`
     end
-    
     destination
   end
   
   # Finds the size of the original image
   def original_size filename
-    `#{@command_path}identify -format '%w %h' #{filename}`.split(/\s/)
+    `#{@config.command_path}identify -format '%w %h' #{filename}`.split(/\s/)
   end
 
 end

data/lib/enhance/version.rb

@@ -1,3 +1,3 @@
 module Enhance
-  VERSION = '0.0.10'
+  VERSION = '0.1.0'
 end

data/test/test.rb

@@ -15,10 +15,8 @@ class EnhanceTest < Test::Unit::TestCase
   include Rack::Test::Methods
   
   def app
-    Enhance::Enhancer.new( FourOhFourApp.new, File.dirname(__FILE__), 
-      :cache => File.join(File.dirname(__FILE__), "tmp"),
-      :folders => File.dirname(__FILE__)
-    )
+    Enhance::Enhancer.new FourOhFourApp.new do |config|
+    end
   end
   
   def test_404
@@ -53,7 +51,7 @@ class EnhanceTest < Test::Unit::TestCase
   
   def test_image_oversize
     get "/images/test.jpg/2000"
-    assert_size 2000, nil, :<
+    assert last_response.not_found?
   end
   
   def assert_size width, height, comparator = :==
@@ -62,7 +60,6 @@ class EnhanceTest < Test::Unit::TestCase
       f.write last_response.body
     end
     identify = `identify #{dump}`.match /\s(?<width>[0-9]+)x(?<height>[0-9]+)/
-    
     assert identify[:width].to_i.send(comparator, width) if width
     assert identify[:height].to_i.send(comparator, height) if height
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enhance
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70278122273260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70278122273260
 - !ruby/object:Gem::Dependency
   name: utilities
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70278122271760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,15 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70278122271760
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70278122271120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,12 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70278122271120
 description: Middleware to "enhance" and resize images on the fly.
 email: gmalette@gmail.com
 executables: []
@@ -68,6 +53,7 @@ files:
 - README.md
 - enhance.gemspec
 - lib/enhance.rb
+- lib/enhance/config.rb
 - lib/enhance/enhancer.rb
 - lib/enhance/urlhelper.rb
 - lib/enhance/version.rb
@@ -94,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Image resizing on the fly