rscale 0.1 → 0.1.2

data/README.rdoc

@@ -0,0 +1,80 @@
+= RScale -- ImageMagick-based image processing for Ruby
+
+This is a simple image processing library for ruby scripts based on ImageMagick terminal tool.
+Allows you to define a set of image formats and its dimensions and generate thumbnails just with one call.
+It does not have any other features than making thumbnails, neither it keeps the original source.
+Rails 2/3 compatible.
+
+* Main page: http://github.com/sosedoff/rscale
+* ImageMagick: http://www.imagemagick.org
+
+== Installation
+
+You have to install ImageMagick in order to use this library.
+To check installation run this command in terminal:
+  
+  identify --version
+  
+Install via gem:
+
+  gem install rscale
+
+== Configuration
+
+  require 'rscale'
+  
+  # Initial configuration
+  # This 'public' path has to be writable
+  RScale.configure do |c|
+    c.public = "PATH_TO_YOUR_OUTPUT_DIR"
+  end
+  
+  # Lets add avatar format with 3 different sizes
+  RScale.format :avatar do |f|
+    f.url = '/static/:format/:style/:uuid_dir/:uuid.jpg' # optional
+    f.style :small,   :size => '64x64'
+    f.style :medium,  :size => '128x128'
+    f.style :large,   :size => '256x256'
+  end
+  
+  # Another format, generates 100x100 PNG thumbnails
+  RScale.format :profile do |f|
+    f.url = '/:format/:style/:uuid_dir/:uuid.png' # optional
+    f.style :default, :size => '100x200'
+  end
+  
+URL parameter is just a path to store generated thumbnails, relative to public path defined in configuration block.
+Available URL parameters:
+
+* :uuid         32-byte UUID string 
+* :uuid_dir     /xx/xx directory structure generated from uuid string
+* :md5          32-byte source image MD5 checksum
+* :time         Unix timestamp
+* :extension    Original extension of source image
+* :filename     Original filename of source image
+* :format       Name of user-defined format
+* :style        Name of user-defined format style (ex. :small, :medium, :large)
+
+== Usage
+
+  path = '/tmp/.....' # path to the source image
+  result = RScale.image_for :avatar, path
+  
+  # If source file cannot be processed result will always be null
+  unless result.nil?
+    # result will contain processed thumbnails with path relative to public path
+    result[:small]    # 64x64
+    result[:medium]   # 128x128
+    result[:large]    # 256x256
+  end
+  
+== Limitation
+
+* No support for AmazonS3/CloudFiles
+* No support for keeping source images
+* Only specific image dimensions (no relative Ax? sizes)
+
+== Authors
+
+Dan Sosedoff, 2010
+

data/lib/rscale.rb

@@ -1,7 +1,11 @@
-require 'rscale/rscale'
+require 'ftools'
+require 'digest'
+
 require 'rscale/errors'
+require 'rscale/uuid'
 require 'rscale/configuration'
 require 'rscale/format'
 require 'rscale/helpers'
 require 'rscale/processor'
-require 'rscale/geometry'
+require 'rscale/geometry'
+require 'rscale/rscale'

data/lib/rscale/configuration.rb

@@ -2,10 +2,12 @@ module RScale
   class Configuration
     attr_accessor :root
     attr_accessor :public
+    attr_accessor :uuid_system
     
     def initialize(root=nil, public=nil)
       @root = root || File.dirname(__FILE__)
       @public = public || @root + '/public'
+      @uuid_system = !`which uuid-gen`.to_s.strip.empty?
     end
   end
 end

data/lib/rscale/format.rb

@@ -6,9 +6,10 @@ module RScale
     def initialize(name)
       @name = name.to_s
       @styles = {}
-      @url = '/:format/:style/:filename.:extension'
+      @url = '/:format/:style/:uuid_dir/:uuid.:extension'
     end
     
+    # Add a new style
     def style(name, opts={})
       raise FormatError, 'Options required!' if opts.empty?
       raise FormatError, 'Options must be a Hash!' unless opts.kind_of?(Hash)

data/lib/rscale/rscale.rb

@@ -1,12 +1,21 @@
 module RScale
+  extend RScale::UUID
+  
   @@config = nil
   @@formats = {}
   
+  # Configure RScale
   def self.configure
     @@config = Configuration.new if @@config.nil?
     yield @@config
   end
   
+  # Get current RScale configuration
+  def self.config
+    @@config
+  end
+  
+  # Add new format
   def self.format(name)
     unless @@formats.key?(name)
       @@formats[name] = Format.new(name)
@@ -16,10 +25,12 @@ module RScale
     end
   end
   
+  # Get list of formats
   def self.formats
     @@formats
   end
   
+  # Generate thumbnails for the image format
   def self.image_for(format, file)
     if @@formats.key?(format.to_sym)
       fmt = @@formats[format.to_sym]
@@ -32,7 +43,7 @@ module RScale
       options[:time] = Time.now.to_i unless url[':time'].nil?
       options[:md5] = Digest::MD5.filedigest(file) unless url[':md5'].nil?
       unless url[':uuid'].nil?
-        options[:uuid] = `uuidgen`.strip.gsub(/-/,'')
+        options[:uuid] = uuid
         options[:uuid_dir] = "#{options[:uuid][0,2]}/#{options[:uuid][2,2]}"
       end
       

data/lib/rscale/uuid.rb

@@ -0,0 +1,24 @@
+module RScale
+  module UUID
+    # Generate uuid based on current configuration
+    def uuid
+      RScale.config.uuid_system ? uuid_system : uuid_local
+    end
+    
+    # Generate pseudo-unique string if local system does not have uuid binary installed
+    def uuid_local
+      values = [
+        rand(0x0010000), rand(0x0010000),
+        rand(0x0010000), rand(0x0010000),
+        rand(0x0010000), rand(0x1000000),
+        rand(0x1000000),
+      ]
+      "%04x%04x%04x%04x%04x%06x%06x" % values
+    end
+    
+    # Generate uuid using system binary
+    def uuid_system
+      `uuidgen`.strip.gsub(/-/,'')
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rscale
 version: !ruby/object:Gem::Version 
-  hash: 9
-  prerelease: false
+  hash: 31
+  prerelease: 
   segments: 
   - 0
   - 1
-  version: "0.1"
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Dan Sosedoff
@@ -14,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-02 00:00:00 -05:00
+date: 2011-01-06 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -30,11 +31,13 @@ files:
 - lib/rscale.rb
 - lib/rscale/rscale.rb
 - lib/rscale/errors.rb
+- lib/rscale/uuid.rb
 - lib/rscale/configuration.rb
 - lib/rscale/format.rb
 - lib/rscale/helpers.rb
 - lib/rscale/processor.rb
 - lib/rscale/geometry.rb
+- README.rdoc
 has_rdoc: true
 homepage: http://github.com/sosedoff/rscale
 licenses: []
@@ -65,7 +68,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.4.1
 signing_key: 
 specification_version: 3
 summary: Image scaling wrapper based on ImageMagick console utils