avatar 0.0.5 → 0.2.0

data/test/lib/file_column/lib/file_column_helper.rb

@@ -1,150 +0,0 @@
-# This module contains helper methods for displaying and uploading files
-# for attributes created by +FileColumn+'s +file_column+ method. It will be
-# automatically included into ActionView::Base, thereby making this module's
-# methods available in all your views.
-module FileColumnHelper
-  
-  # Use this helper to create an upload field for a file_column attribute. This will generate
-  # an additional hidden field to keep uploaded files during form-redisplays. For example,
-  # when called with
-  #
-  #   <%= file_column_field("entry", "image") %>
-  #
-  # the following HTML will be generated (assuming the form is redisplayed and something has
-  # already been uploaded):
-  #
-  #   <input type="hidden" name="entry[image_temp]" value="..." />
-  #   <input type="file" name="entry[image]" />
-  #
-  # You can use the +option+ argument to pass additional options to the file-field tag.
-  #
-  # Be sure to set the enclosing form's encoding to 'multipart/form-data', by
-  # using something like this:
-  #
-  #    <%= form_tag {:action => "create", ...}, :multipart => true %>
-  def file_column_field(object, method, options={})
-    result = ActionView::Helpers::InstanceTag.new(object.dup, method.to_s+"_temp", self).to_input_field_tag("hidden", {})
-    result << ActionView::Helpers::InstanceTag.new(object.dup, method, self).to_input_field_tag("file", options)
-  end
-  
-  # Creates an URL where an uploaded file can be accessed. When called for an Entry object with
-  # id 42 (stored in <tt>@entry</tt>) like this
-  #
-  #   <%= url_for_file_column(@entry, "image")
-  #
-  # the following URL will be produced, assuming the file "test.png" has been stored in
-  # the "image"-column of an Entry object stored in <tt>@entry</tt>:
-  #
-  #  /entry/image/42/test.png
-  #
-  # This will produce a valid URL even for temporary uploaded files, e.g. files where the object
-  # they are belonging to has not been saved in the database yet.
-  #
-  # The URL produces, although starting with a slash, will be relative
-  # to your app's root. If you pass it to one rails' +image_tag+
-  # helper, rails will properly convert it to an absolute
-  # URL. However, this will not be the case, if you create a link with
-  # the +link_to+ helper. In this case, you can pass <tt>:absolute =>
-  # true</tt> to +options+, which will make sure, the generated URL is
-  # absolute on your server.  Examples:
-  #
-  #    <%= image_tag url_for_file_column(@entry, "image") %>
-  #    <%= link_to "Download", url_for_file_column(@entry, "image", :absolute => true) %>
-  #
-  # If there is currently no uploaded file stored in the object's column this method will
-  # return +nil+.
-  def url_for_file_column(object, method, options=nil)
-    case object
-    when String, Symbol
-      object = instance_variable_get("@#{object.to_s}")
-    end
-
-    # parse options
-    subdir = nil
-    absolute = false
-    if options
-      case options
-      when Hash
-        subdir = options[:subdir]
-        absolute = options[:absolute]
-      when String, Symbol
-        subdir = options
-      end
-    end
-    
-    relative_path = object.send("#{method}_relative_path", subdir)
-    return nil unless relative_path
-
-    url = ""
-    url << request.relative_url_root.to_s if absolute
-    url << "/"
-    url << object.send("#{method}_options")[:base_url] << "/"
-    url << relative_path
-  end
-
-  # Same as +url_for_file_colum+ but allows you to access different versions
-  # of the image that have been processed by RMagick.
-  #
-  # If your +options+ parameter is non-nil this will
-  # access a different version of an image that will be produced by
-  # RMagick. You can use the following types for +options+:
-  #
-  # * a <tt>:symbol</tt> will select a version defined in the model
-  #   via FileColumn::Magick's <tt>:versions</tt> feature.
-  # * a <tt>geometry_string</tt> will dynamically create an
-  #   image resized as specified by <tt>geometry_string</tt>. The image will
-  #   be stored so that it does not have to be recomputed the next time the
-  #   same version string is used.
-  # * <tt>some_hash</tt> will dynamically create an image
-  #   that is created according to the options in <tt>some_hash</tt>. This
-  #   accepts exactly the same options as Magick's version feature.
-  #
-  # The version produced by RMagick will be stored in a special sub-directory.
-  # The directory's name will be derived from the options you specified
-  # (via a hash function) but if you want
-  # to set it yourself, you can use the <tt>:name => name</tt> option.
-  #
-  # Examples:
-  #
-  #    <%= url_for_image_column @entry, "image", "640x480" %>
-  #
-  # will produce an URL like this
-  #
-  #    /entry/image/42/bdn19n/filename.jpg
-  #    # "640x480".hash.abs.to_s(36) == "bdn19n"
-  #
-  # and
-  #
-  #    <%= url_for_image_column @entry, "image", 
-  #       :size => "50x50", :crop => "1:1", :name => "thumb" %>
-  #
-  # will produce something like this:
-  #
-  #    /entry/image/42/thumb/filename.jpg
-  #
-  # Hint: If you are using the same geometry string / options hash multiple times, you should
-  # define it in a helper to stay with DRY. Another option is to define it in the model via
-  # FileColumn::Magick's <tt>:versions</tt> feature and then refer to it via a symbol.
-  #
-  # The URL produced by this method is relative to your application's root URL,
-  # although it will start with a slash.
-  # If you pass this URL to rails' +image_tag+ helper, it will be converted to an
-  # absolute URL automatically.
-  # If there is currently no image uploaded, or there is a problem while loading
-  # the image this method will return +nil+.
-  def url_for_image_column(object, method, options=nil)
-    case object
-    when String, Symbol
-      object = instance_variable_get("@#{object.to_s}")
-    end
-    subdir = nil
-    if options
-      subdir = object.send("#{method}_state").create_magick_version_if_needed(options)
-    end
-    if subdir.nil?
-      nil
-    else
-      url_for_file_column(object, method, subdir)
-    end
-  end
-end

data/test/lib/file_column/lib/file_compat.rb

@@ -1,28 +0,0 @@
-module FileColumn
-
-  # This bit of code allows you to pass regular old files to
-  # file_column.  file_column depends on a few extra methods that the
-  # CGI uploaded file class adds.  We will add the equivalent methods
-  # to file objects if necessary by extending them with this module. This
-  # avoids opening up the standard File class which might result in
-  # naming conflicts.
-
-  module FileCompat # :nodoc:
-    def original_filename
-      File.basename(path)
-    end
-    
-    def size
-      File.size(path)
-    end
-    
-    def local_path
-      path
-    end
-    
-    def content_type
-      nil
-    end
-  end
-end
-

data/test/lib/file_column/lib/magick_file_column.rb

@@ -1,260 +0,0 @@
-module FileColumn # :nodoc:
-  
-  class BaseUploadedFile # :nodoc:
-    def transform_with_magick
-      if needs_transform?
-        begin
-          img = ::Magick::Image::read(absolute_path).first
-        rescue ::Magick::ImageMagickError
-          if options[:magick][:image_required]
-            @magick_errors ||= []
-            @magick_errors << "invalid image"
-          end
-          return
-        end
-        
-        if options[:magick][:versions]
-          options[:magick][:versions].each_pair do |version, version_options|
-            next if version_options[:lazy]
-            dirname = version_options[:name]
-            FileUtils.mkdir File.join(@dir, dirname)
-            transform_image(img, version_options, absolute_path(dirname))
-          end
-        end
-        if options[:magick][:size] or options[:magick][:crop] or options[:magick][:transformation] or options[:magick][:attributes]
-          transform_image(img, options[:magick], absolute_path)
-        end
-
-        GC.start
-      end
-    end
-
-    def create_magick_version_if_needed(version)
-      # RMagick might not have been loaded so far.
-      # We do not want to require it on every call of this method
-      # as this might be fairly expensive, so we just try if ::Magick
-      # exists and require it if not.
-      begin 
-        ::Magick 
-      rescue NameError
-        require 'RMagick'
-      end
-
-      if version.is_a?(Symbol)
-        version_options = options[:magick][:versions][version]
-      else
-        version_options = MagickExtension::process_options(version)
-      end
-
-      unless File.exists?(absolute_path(version_options[:name]))
-        begin
-          img = ::Magick::Image::read(absolute_path).first
-        rescue ::Magick::ImageMagickError
-          # we might be called directly from the view here
-          # so we just return nil if we cannot load the image
-          return nil
-        end
-        dirname = version_options[:name]
-        FileUtils.mkdir File.join(@dir, dirname)
-        transform_image(img, version_options, absolute_path(dirname))
-      end
-
-      version_options[:name]
-    end
-
-    attr_reader :magick_errors
-    
-    def has_magick_errors?
-      @magick_errors and !@magick_errors.empty?
-    end
-
-    private
-    
-    def needs_transform?
-      options[:magick] and just_uploaded? and 
-        (options[:magick][:size] or options[:magick][:versions] or options[:magick][:transformation] or options[:magick][:attributes])
-    end
-
-    def transform_image(img, img_options, dest_path)
-      begin
-        if img_options[:transformation]
-          if img_options[:transformation].is_a?(Symbol)
-            img = @instance.send(img_options[:transformation], img)
-          else
-            img = img_options[:transformation].call(img)
-          end
-        end
-        if img_options[:crop]
-          dx, dy = img_options[:crop].split(':').map { |x| x.to_f }
-          w, h = (img.rows * dx / dy), (img.columns * dy / dx)
-          img = img.crop(::Magick::CenterGravity, [img.columns, w].min, 
-                         [img.rows, h].min, true)
-        end
-
-        if img_options[:size]
-          img = img.change_geometry(img_options[:size]) do |c, r, i|
-            i.resize(c, r)
-          end
-        end
-      ensure
-        img.write(dest_path) do
-          if img_options[:attributes]
-            img_options[:attributes].each_pair do |property, value| 
-              self.send "#{property}=", value
-            end
-          end
-        end
-        File.chmod options[:permissions], dest_path
-      end
-    end
-  end
-
-  # If you are using file_column to upload images, you can
-  # directly process the images with RMagick,
-  # a ruby extension
-  # for accessing the popular imagemagick libraries. You can find
-  # more information about RMagick at http://rmagick.rubyforge.org.
-  #
-  # You can control what to do by adding a <tt>:magick</tt> option
-  # to your options hash. All operations are performed immediately
-  # after a new file is assigned to the file_column attribute (i.e.,
-  # when a new file has been uploaded).
-  #
-  # == Resizing images
-  #
-  # To resize the uploaded image according to an imagemagick geometry
-  # string, just use the <tt>:size</tt> option:
-  #
-  #    file_column :image, :magick => {:size => "800x600>"}
-  #
-  # If the uploaded file cannot be loaded by RMagick, file_column will
-  # signal a validation error for the corresponding attribute. If you
-  # want to allow non-image files to be uploaded in a column that uses
-  # the <tt>:magick</tt> option, you can set the <tt>:image_required</tt>
-  # attribute to +false+:
-  #
-  #    file_column :image, :magick => {:size => "800x600>",
-  #                                    :image_required => false }
-  #
-  # == Multiple versions
-  #
-  # You can also create additional versions of your image, for example
-  # thumb-nails, like this:
-  #    file_column :image, :magick => {:versions => {
-  #         :thumb => {:size => "50x50"},
-  #         :medium => {:size => "640x480>"}
-  #       }
-  #
-  # These versions will be stored in separate sub-directories, named like the
-  # symbol you used to identify the version. So in the previous example, the
-  # image versions will be stored in "thumb", "screen" and "widescreen"
-  # directories, resp. 
-  # A name different from the symbol can be set via the <tt>:name</tt> option.
-  #
-  # These versions can be accessed via FileColumnHelper's +url_for_image_column+
-  # method like this:
-  #
-  #    <%= url_for_image_column "entry", "image", :thumb %>
-  #
-  # == Cropping images
-  #
-  # If you wish to crop your images with a size ratio before scaling
-  # them according to your version geometry, you can use the :crop directive.
-  #    file_column :image, :magick => {:versions => {
-  #         :square => {:crop => "1:1", :size => "50x50", :name => "thumb"},
-  #         :screen => {:crop => "4:3", :size => "640x480>"},
-  #         :widescreen => {:crop => "16:9", :size => "640x360!"},
-  #       }
-  #    }
-  #
-  # == Custom attributes
-  #
-  # To change some of the image properties like compression level before they
-  # are saved you can set the <tt>:attributes</tt> option.
-  # For a list of available attributes go to http://www.simplesystems.org/RMagick/doc/info.html
-  # 
-  #     file_column :image, :magick => { :attributes => { :quality => 30 } }
-  # 
-  # == Custom transformations
-  #
-  # To perform custom transformations on uploaded images, you can pass a
-  # callback to file_column:
-  #    file_column :image, :magick => 
-  #       Proc.new { |image| image.quantize(256, Magick::GRAYColorspace) }
-  #
-  # The callback you give, receives one argument, which is an instance
-  # of Magick::Image, the RMagick image class. It should return a transformed
-  # image. Instead of passing a <tt>Proc</tt> object, you can also give a
-  # <tt>Symbol</tt>, the name of an instance method of your model.
-  #
-  # Custom transformations can be combined via the standard :size and :crop
-  # features, by using the :transformation option:
-  #   file_column :image, :magick => {
-  #      :transformation => Proc.new { |image| ... },
-  #      :size => "640x480"
-  #    }
-  #
-  # In this case, the standard resizing operations will be performed after the
-  # custom transformation.
-  #
-  # Of course, custom transformations can be used in versions, as well.
-  #
-  # <b>Note:</b> You'll need the
-  # RMagick extension being installed  in order to use file_column's
-  # imagemagick integration.
-  module MagickExtension
-
-    def self.file_column(klass, attr, options) # :nodoc:
-      require 'RMagick'
-      options[:magick] = process_options(options[:magick],false) if options[:magick]
-      if options[:magick][:versions]
-        options[:magick][:versions].each_pair do |name, value|
-          options[:magick][:versions][name] = process_options(value, name.to_s)
-        end
-      end
-      state_method = "#{attr}_state".to_sym
-      after_assign_method = "#{attr}_magick_after_assign".to_sym
-      
-      klass.send(:define_method, after_assign_method) do
-        self.send(state_method).transform_with_magick
-      end
-      
-      options[:after_upload] ||= []
-      options[:after_upload] << after_assign_method
-      
-      klass.validate do |record|
-        state = record.send(state_method)
-        if state.has_magick_errors?
-          state.magick_errors.each do |error|
-            record.errors.add attr, error
-          end
-        end
-      end
-    end
-
-    
-    def self.process_options(options,create_name=true)
-      case options
-      when String then options = {:size => options}
-      when Proc, Symbol then options = {:transformation => options }
-      end
-      if options[:geometry]
-        options[:size] = options.delete(:geometry)
-      end
-      options[:image_required] = true unless options.key?(:image_required)
-      if options[:name].nil? and create_name
-        if create_name == true
-          hash = 0
-          for key in [:size, :crop]
-            hash = hash ^ options[key].hash if options[key]
-          end
-          options[:name] = hash.abs.to_s(36)
-        else
-          options[:name] = create_name
-        end
-      end
-      options
-    end
-
-  end
-end

data/test/lib/file_column/lib/rails_file_column.rb

@@ -1,19 +0,0 @@
-# require this file from your "config/environment.rb" (after rails has been loaded)
-# to integrate the file_column extension into rails.
-
-require 'file_column'
-require 'file_column_helper'
-
-
-module ActiveRecord # :nodoc:
-  class Base # :nodoc:
-    # make file_column method available in all active record decendants
-    include FileColumn
-  end
-end
-
-module ActionView # :nodoc:
-  class Base # :nodoc:
-    include FileColumnHelper
-  end
-end