libramaze-ruby1.9.1 2010.06.18-2 / usr / lib / ruby / 1.9.1 / ramaze / contrib / sequel / image.rb

#          Copyright (c) 2008 Michael Fellinger m.fellinger@gmail.com
# All files in this distribution are subject to the terms of the Ruby license.

# Scaffold image models utilizing thumbnailing and Ramaze integration.
# Resizing is done by ImageScience.
#
# Usage:
#   class Avatar < Sequel::Model
#     IMAGE = {
#       # specifies many_to_one, will create relation and foreign key
#
#       :owner => :User,
#
#
#       # Remove original and thumbnails on Avatar#destroy
#
#       :cleanup => true,
#
#
#       # Algorithm to use in ImageScience
#       #
#       # * resize(width, height)
#       #     Resizes the image to +width+ and +height+ using a cubic-bspline
#       #     filter.
#       #
#       # * thumbnail(size)
#       #     Creates a proportional thumbnail of the image scaled so its
#       #     longest edge is resized to +size+.
#       #
#       # * cropped_thumbnail(size)
#       #     Creates a square thumbnail of the image cropping the longest edge
#       #     to match the shortest edge, resizes to +size+.
#
#       :algorithm => :thumbnail,
#
#
#       # Key specifies the filename and accessors, value are arguments to the
#       # algorithm
#
#       :sizes => {
#         :small => 150,
#         :medium => 300,
#         :large => 600
#       }
#     }
#
#     # Perform the scaffold
#     include SequelImage
#   end

module SequelImage
  def self.included(model)
    args = model::IMAGE
    set_foreign_key = args[:foreign_key]  || "#{args[:owner]}_id".downcase.to_sym
    set_many_to_one  = args[:many_to_one] ||    args[:owner].to_s.downcase.to_sym

    # Define schema
    model.set_schema do
      primary_key :id

      varchar :original # path to the original image
      varchar :mime, :size => 22 # average of /etc/mime.types

      time :created_at
      time :updated_at

      foreign_key set_foreign_key
    end

    # Define Relations
    model.many_to_one set_many_to_one

    # Define Hooks
    model.before_create :generate_thumbnails do
      generate_thumbnails
      self.created_at = Time.now
    end

    model.before_save :update_time do
      self.updated_at = Time.now
    end

    model.before_destroy :cleanup do
      cleanup if conf[:cleanup]
    end

    # Define singleton methods
    model.extend(SingletonMethods)

    # Define instance methods
    model.send(:include,
               InstanceMethods,
               Ramaze::Helper::CGI,
               Ramaze::Helper::Link)

    args[:sizes].each do |size, *args|
      model.send(:define_method, size){ public_file(size) }
      model.send(:define_method, "#{size}_url"){ file(size) }
    end
  end

  module SingletonMethods
    def store(file, uid, hash = {})
      image = new(hash)

      type     = file[:type]
      filename = file[:filename]
      tempfile = file[:tempfile]
      raise ArgumentError, 'Empty tempfile' if tempfile.size == 0

      ext         = Rack::Mime::MIME_TYPES.invert[type]
      image.mime  = type
      target_name = image.next_name(File.basename(filename, File.extname(filename)), ext)
      target_path = File.join(image.public_root, image.path, target_name)

      FileUtils.mkdir_p(File.dirname(target_path))
      FileUtils.cp(tempfile.path, target_path)

      image.original = target_path
      image.save
    end
  end

  module InstanceMethods
    def file(size = nil)
      File.join('/', path, filename(size))
    end

    def public_file(size)
      File.join(public_path, filename(size))
    end

    def public_path
      File.join(public_root, path)
    end

    def path
      conf[:path] || conf[:owner].to_s.downcase
    end

    def next_name(uid, ext)
      uid = uid.to_s.scan(%r![^\\/'".:?&;\s]+!).join('-')
      "#{uid}#{ext}"
    end

    def basename
      File.basename(original, File.extname(original))
    end

    def public_root
      Ramaze.options.roots.first
    end

    def filename(size)
      if size
        "#{basename}_#{size}.png"
      else
        "#{basename}.png"
      end
    end

    def conf
      self.class::IMAGE
    end

    def cleanup
      conf[:sizes].each do |name, args|
        out = public_file(name)
        Ramaze::Log.debug "Remove Thumbnail: #{out}"
        FileUtils.rm_f(out)
      end

      Ramaze::Log.debug "Remove original: #{original}"
      FileUtils.rm_f(original)
    end

    def generate_thumbnails
      FileUtils.mkdir_p(public_path)

      sizes, algorithm = conf.values_at(:sizes, :algorithm)

      ImageScience.with_image(original) do |img|
        Ramaze::Log.debug "Process original: #{original}"

        sizes.each do |name, args|
          out = public_file(name)
          Ramaze::Log.debug "Generate Thumbnail: #{out}"

          img.send(algorithm, *args) do |thumb|
            thumb.save(out)
          end
        end
      end
    end
  end
end