railscart 0.0.3 → 0.0.4

data/starter_app/vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu.rb

@@ -0,0 +1,410 @@
+module Technoweenie # :nodoc:
+  module AttachmentFu # :nodoc:
+    @@default_processors = %w(ImageScience Rmagick MiniMagick)
+    @@tempfile_path      = File.join(RAILS_ROOT, 'tmp', 'attachment_fu')
+    @@content_types      = ['image/jpeg', 'image/pjpeg', 'image/gif', 'image/png', 'image/x-png', 'image/jpg']
+    mattr_reader :content_types, :tempfile_path, :default_processors
+    mattr_writer :tempfile_path
+
+    class ThumbnailError < StandardError;  end
+    class AttachmentError < StandardError; end
+
+    module ActMethods
+      # Options: 
+      # *  <tt>:content_type</tt> - Allowed content types.  Allows all by default.  Use :image to allow all standard image types.
+      # *  <tt>:min_size</tt> - Minimum size allowed.  1 byte is the default.
+      # *  <tt>:max_size</tt> - Maximum size allowed.  1.megabyte is the default.
+      # *  <tt>:size</tt> - Range of sizes allowed.  (1..1.megabyte) is the default.  This overrides the :min_size and :max_size options.
+      # *  <tt>:resize_to</tt> - Used by RMagick to resize images.  Pass either an array of width/height, or a geometry string.
+      # *  <tt>:thumbnails</tt> - Specifies a set of thumbnails to generate.  This accepts a hash of filename suffixes and RMagick resizing options.
+      # *  <tt>:thumbnail_class</tt> - Set what class to use for thumbnails.  This attachment class is used by default.
+      # *  <tt>:path_prefix</tt> - path to store the uploaded files.  Uses public/#{table_name} by default for the filesystem, and just #{table_name}
+      #      for the S3 backend.  Setting this sets the :storage to :file_system.
+      # *  <tt>:storage</tt> - Use :file_system to specify the attachment data is stored with the file system.  Defaults to :db_system.
+      #
+      # Examples:
+      #   has_attachment :max_size => 1.kilobyte
+      #   has_attachment :size => 1.megabyte..2.megabytes
+      #   has_attachment :content_type => 'application/pdf'
+      #   has_attachment :content_type => ['application/pdf', 'application/msword', 'text/plain']
+      #   has_attachment :content_type => :image, :resize_to => [50,50]
+      #   has_attachment :content_type => ['application/pdf', :image], :resize_to => 'x50'
+      #   has_attachment :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
+      #   has_attachment :storage => :file_system, :path_prefix => 'public/files'
+      #   has_attachment :storage => :file_system, :path_prefix => 'public/files', 
+      #     :content_type => :image, :resize_to => [50,50]
+      #   has_attachment :storage => :file_system, :path_prefix => 'public/files',
+      #     :thumbnails => { :thumb => [50, 50], :geometry => 'x50' }
+      #   has_attachment :storage => :s3
+      def has_attachment(options = {})
+        # this allows you to redefine the acts' options for each subclass, however
+        options[:min_size]         ||= 1
+        options[:max_size]         ||= 1.megabyte
+        options[:size]             ||= (options[:min_size]..options[:max_size])
+        options[:thumbnails]       ||= {}
+        options[:thumbnail_class]  ||= self
+        options[:s3_access]        ||= :public_read
+        options[:content_type] = [options[:content_type]].flatten.collect! { |t| t == :image ? Technoweenie::AttachmentFu.content_types : t }.flatten unless options[:content_type].nil?
+        
+        unless options[:thumbnails].is_a?(Hash)
+          raise ArgumentError, ":thumbnails option should be a hash: e.g. :thumbnails => { :foo => '50x50' }"
+        end
+        
+        # doing these shenanigans so that #attachment_options is available to processors and backends
+        class_inheritable_accessor :attachment_options
+        self.attachment_options = options
+
+        # only need to define these once on a class
+        unless included_modules.include?(InstanceMethods)
+          attr_accessor :thumbnail_resize_options
+
+          attachment_options[:storage]     ||= (attachment_options[:file_system_path] || attachment_options[:path_prefix]) ? :file_system : :db_file
+          attachment_options[:path_prefix] ||= attachment_options[:file_system_path]
+          if attachment_options[:path_prefix].nil?
+            attachment_options[:path_prefix] = attachment_options[:storage] == :s3 ? table_name : File.join("public", table_name)
+          end
+          attachment_options[:path_prefix]   = attachment_options[:path_prefix][1..-1] if options[:path_prefix].first == '/'
+
+          with_options :foreign_key => 'parent_id' do |m|
+            m.has_many   :thumbnails, :class_name => attachment_options[:thumbnail_class].to_s
+            m.belongs_to :parent, :class_name => base_class.to_s
+          end
+          before_destroy :destroy_thumbnails
+
+          before_validation :set_size_from_temp_path
+          after_save :after_process_attachment
+          after_destroy :destroy_file
+          extend  ClassMethods
+          include InstanceMethods
+          include Technoweenie::AttachmentFu::Backends.const_get("#{options[:storage].to_s.classify}Backend")
+          case attachment_options[:processor]
+            when :none
+            when nil
+              processors = Technoweenie::AttachmentFu.default_processors.dup
+              begin
+                if processors.any?
+                  attachment_options[:processor] = "#{processors.first}Processor"
+                  include Technoweenie::AttachmentFu::Processors.const_get(attachment_options[:processor])
+                end
+              rescue LoadError, MissingSourceFile
+                processors.shift
+                retry
+              end
+            else
+              begin
+                include Technoweenie::AttachmentFu::Processors.const_get("#{options[:processor].to_s.classify}Processor")
+              rescue LoadError, MissingSourceFile
+                puts "Problems loading #{options[:processor]}Processor: #{$!}"
+              end
+          end
+          after_validation :process_attachment
+        end
+      end
+    end
+
+    module ClassMethods
+      delegate :content_types, :to => Technoweenie::AttachmentFu
+
+      # Performs common validations for attachment models.
+      def validates_as_attachment
+        validates_presence_of :size, :content_type, :filename
+        validate              :attachment_attributes_valid?
+      end
+
+      # Returns true or false if the given content type is recognized as an image.
+      def image?(content_type)
+        content_types.include?(content_type)
+      end
+
+      # Callback after an image has been resized.
+      #
+      #   class Foo < ActiveRecord::Base
+      #     acts_as_attachment
+      #     after_resize do |record, img| 
+      #       record.aspect_ratio = img.columns.to_f / img.rows.to_f
+      #     end
+      #   end
+      def after_resize(&block)
+        write_inheritable_array(:after_resize, [block])
+      end
+
+      # Callback after an attachment has been saved either to the file system or the DB.
+      # Only called if the file has been changed, not necessarily if the record is updated.
+      #
+      #   class Foo < ActiveRecord::Base
+      #     acts_as_attachment
+      #     after_attachment_saved do |record|
+      #       ...
+      #     end
+      #   end
+      def after_attachment_saved(&block)
+        write_inheritable_array(:after_attachment_saved, [block])
+      end
+
+      # Callback before a thumbnail is saved.  Use this to pass any necessary extra attributes that may be required.
+      #
+      #   class Foo < ActiveRecord::Base
+      #     acts_as_attachment
+      #     before_thumbnail_saved do |record, thumbnail|
+      #       ...
+      #     end
+      #   end
+      def before_thumbnail_saved(&block)
+        write_inheritable_array(:before_thumbnail_saved, [block])
+      end
+
+      # Get the thumbnail class, which is the current attachment class by default.
+      # Configure this with the :thumbnail_class option.
+      def thumbnail_class
+        attachment_options[:thumbnail_class] = attachment_options[:thumbnail_class].constantize unless attachment_options[:thumbnail_class].is_a?(Class)
+        attachment_options[:thumbnail_class]
+      end
+
+      # Copies the given file path to a new tempfile, returning the closed tempfile.
+      def copy_to_temp_file(file, temp_base_name)
+        returning Tempfile.new(temp_base_name, Technoweenie::AttachmentFu.tempfile_path) do |tmp|
+          tmp.close
+          FileUtils.cp file, tmp.path
+        end
+      end
+      
+      # Writes the given data to a new tempfile, returning the closed tempfile.
+      def write_to_temp_file(data, temp_base_name)
+        returning Tempfile.new(temp_base_name, Technoweenie::AttachmentFu.tempfile_path) do |tmp|
+          tmp.binmode
+          tmp.write data
+          tmp.close
+        end
+      end
+    end
+
+    module InstanceMethods
+      # Checks whether the attachment's content type is an image content type
+      def image?
+        self.class.image?(content_type)
+      end
+      
+      # Returns true/false if an attachment is thumbnailable.  A thumbnailable attachment has an image content type and the parent_id attribute.
+      def thumbnailable?
+        image? && respond_to?(:parent_id) && parent_id.nil?
+      end
+
+      # Returns the class used to create new thumbnails for this attachment.
+      def thumbnail_class
+        self.class.thumbnail_class
+      end
+
+      # Gets the thumbnail name for a filename.  'foo.jpg' becomes 'foo_thumbnail.jpg'
+      def thumbnail_name_for(thumbnail = nil)
+        return filename if thumbnail.blank?
+        ext = nil
+        basename = filename.gsub /\.\w+$/ do |s|
+          ext = s; ''
+        end
+        # ImageScience doesn't create gif thumbnails, only pngs
+        ext.sub!(/gif$/, 'png') if attachment_options[:processor] == "ImageScienceProcessor"
+        "#{basename}_#{thumbnail}#{ext}"
+      end
+
+      # Creates or updates the thumbnail for the current attachment.
+      def create_or_update_thumbnail(temp_file, file_name_suffix, *size)
+        thumbnailable? || raise(ThumbnailError.new("Can't create a thumbnail if the content type is not an image or there is no parent_id column"))
+        returning find_or_initialize_thumbnail(file_name_suffix) do |thumb|
+          thumb.attributes = {
+            :content_type             => content_type, 
+            :filename                 => thumbnail_name_for(file_name_suffix), 
+            :temp_path                => temp_file,
+            :thumbnail_resize_options => size
+          }
+          callback_with_args :before_thumbnail_saved, thumb
+          thumb.save!
+        end
+      end
+
+      # Sets the content type.
+      def content_type=(new_type)
+        write_attribute :content_type, new_type.to_s.strip
+      end
+      
+      # Sanitizes a filename.
+      def filename=(new_name)
+        write_attribute :filename, sanitize_filename(new_name)
+      end
+
+      # Returns the width/height in a suitable format for the image_tag helper: (100x100)
+      def image_size
+        [width.to_s, height.to_s] * 'x'
+      end
+
+      # Returns true if the attachment data will be written to the storage system on the next save
+      def save_attachment?
+        File.file?(temp_path.to_s)
+      end
+
+      # nil placeholder in case this field is used in a form.
+      def uploaded_data() nil; end
+
+      # This method handles the uploaded file object.  If you set the field name to uploaded_data, you don't need
+      # any special code in your controller.
+      #
+      #   <% form_for :attachment, :html => { :multipart => true } do |f| -%>
+      #     <p><%= f.file_field :uploaded_data %></p>
+      #     <p><%= submit_tag :Save %>
+      #   <% end -%>
+      #
+      #   @attachment = Attachment.create! params[:attachment]
+      #
+      # TODO: Allow it to work with Merb tempfiles too.
+      def uploaded_data=(file_data)
+        return nil if file_data.nil? || file_data.size == 0 
+        self.content_type = file_data.content_type
+        self.filename     = file_data.original_filename if respond_to?(:filename)
+        if file_data.is_a?(StringIO)
+          file_data.rewind
+          self.temp_data = file_data.read
+        else
+          self.temp_path = file_data.path
+        end
+      end
+
+      # Gets the latest temp path from the collection of temp paths.  While working with an attachment,
+      # multiple Tempfile objects may be created for various processing purposes (resizing, for example).
+      # An array of all the tempfile objects is stored so that the Tempfile instance is held on to until
+      # it's not needed anymore.  The collection is cleared after saving the attachment.
+      def temp_path
+        p = temp_paths.first
+        p.respond_to?(:path) ? p.path : p.to_s
+      end
+      
+      # Gets an array of the currently used temp paths.  Defaults to a copy of #full_filename.
+      def temp_paths
+        @temp_paths ||= (new_record? || !File.exist?(full_filename)) ? [] : [copy_to_temp_file(full_filename)]
+      end
+      
+      # Adds a new temp_path to the array.  This should take a string or a Tempfile.  This class makes no 
+      # attempt to remove the files, so Tempfiles should be used.  Tempfiles remove themselves when they go out of scope.
+      # You can also use string paths for temporary files, such as those used for uploaded files in a web server.
+      def temp_path=(value)
+        temp_paths.unshift value
+        temp_path
+      end
+
+      # Gets the data from the latest temp file.  This will read the file into memory.
+      def temp_data
+        save_attachment? ? File.read(temp_path) : nil
+      end
+      
+      # Writes the given data to a Tempfile and adds it to the collection of temp files.
+      def temp_data=(data)
+        self.temp_path = write_to_temp_file data unless data.nil?
+      end
+      
+      # Copies the given file to a randomly named Tempfile.
+      def copy_to_temp_file(file)
+        self.class.copy_to_temp_file file, random_tempfile_filename
+      end
+      
+      # Writes the given file to a randomly named Tempfile.
+      def write_to_temp_file(data)
+        self.class.write_to_temp_file data, random_tempfile_filename
+      end
+      
+      # Stub for creating a temp file from the attachment data.  This should be defined in the backend module.
+      def create_temp_file() end
+
+      # Allows you to work with a processed representation (RMagick, ImageScience, etc) of the attachment in a block.
+      #
+      #   @attachment.with_image do |img|
+      #     self.data = img.thumbnail(100, 100).to_blob
+      #   end
+      #
+      def with_image(&block)
+        self.class.with_image(temp_path, &block)
+      end
+
+      protected
+        # Generates a unique filename for a Tempfile. 
+        def random_tempfile_filename
+          "#{rand Time.now.to_i}#{filename || 'attachment'}"
+        end
+
+        def sanitize_filename(filename)
+          returning filename.strip do |name|
+            # NOTE: File.basename doesn't work right with Windows paths on Unix
+            # get only the filename, not the whole path
+            name.gsub! /^.*(\\|\/)/, ''
+            
+            # Finally, replace all non alphanumeric, underscore or periods with underscore
+            name.gsub! /[^\w\.\-]/, '_'
+          end
+        end
+
+        # before_validation callback.
+        def set_size_from_temp_path
+          self.size = File.size(temp_path) if save_attachment?
+        end
+
+        # validates the size and content_type attributes according to the current model's options
+        def attachment_attributes_valid?
+          [:size, :content_type].each do |attr_name|
+            enum = attachment_options[attr_name]
+            errors.add attr_name, ActiveRecord::Errors.default_error_messages[:inclusion] unless enum.nil? || enum.include?(send(attr_name))
+          end
+        end
+
+        # Initializes a new thumbnail with the given suffix.
+        def find_or_initialize_thumbnail(file_name_suffix)
+          respond_to?(:parent_id) ?
+            thumbnail_class.find_or_initialize_by_thumbnail_and_parent_id(file_name_suffix.to_s, id) :
+            thumbnail_class.find_or_initialize_by_thumbnail(file_name_suffix.to_s)
+        end
+
+        # Stub for a #process_attachment method in a processor
+        def process_attachment
+          @saved_attachment = save_attachment?
+        end
+
+        # Cleans up after processing.  Thumbnails are created, the attachment is stored to the backend, and the temp_paths are cleared.
+        def after_process_attachment
+          if @saved_attachment
+            if respond_to?(:process_attachment_with_processing) && thumbnailable? && !attachment_options[:thumbnails].blank? && parent_id.nil?
+              temp_file = temp_path || create_temp_file
+              attachment_options[:thumbnails].each { |suffix, size| create_or_update_thumbnail(temp_file, suffix, *size) }
+            end
+            save_to_storage
+            @temp_paths.clear
+            @saved_attachment = nil
+            callback :after_attachment_saved
+          end
+        end
+
+        # Resizes the given processed img object with either the attachment resize options or the thumbnail resize options.
+        def resize_image_or_thumbnail!(img)
+          if (!respond_to?(:parent_id) || parent_id.nil?) && attachment_options[:resize_to] # parent image
+            resize_image(img, attachment_options[:resize_to])
+          elsif thumbnail_resize_options # thumbnail
+            resize_image(img, thumbnail_resize_options) 
+          end
+        end
+
+        # Yanked from ActiveRecord::Callbacks, modified so I can pass args to the callbacks besides self.
+        # Only accept blocks, however
+        def callback_with_args(method, arg = self)
+          notify(method)
+
+          result = nil
+          callbacks_for(method).each do |callback|
+            result = callback.call(self, arg)
+            return false if result == false
+          end
+
+          return result
+        end
+        
+        # Removes the thumbnails for the attachment, if it has any
+        def destroy_thumbnails
+          self.thumbnails.each { |thumbnail| thumbnail.destroy } if thumbnailable?
+        end
+    end
+  end
+end

data/starter_app/vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/backends/db_file_backend.rb

@@ -0,0 +1,39 @@
+module Technoweenie # :nodoc:
+  module AttachmentFu # :nodoc:
+    module Backends
+      # Methods for DB backed attachments
+      module DbFileBackend
+        def self.included(base) #:nodoc:
+          Object.const_set(:DbFile, Class.new(ActiveRecord::Base)) unless Object.const_defined?(:DbFile)
+          base.belongs_to  :db_file, :class_name => '::DbFile', :foreign_key => 'db_file_id'
+        end
+
+        # Creates a temp file with the current db data.
+        def create_temp_file
+          write_to_temp_file current_data
+        end
+        
+        # Gets the current data from the database
+        def current_data
+          db_file.data
+        end
+        
+        protected
+          # Destroys the file.  Called in the after_destroy callback
+          def destroy_file
+            db_file.destroy if db_file
+          end
+          
+          # Saves the data to the DbFile model
+          def save_to_storage
+            if save_attachment?
+              (db_file || build_db_file).data = temp_data
+              db_file.save!
+              self.class.update_all ['db_file_id = ?', self.db_file_id = db_file.id], ['id = ?', id]
+            end
+            true
+          end
+      end
+    end
+  end
+end

data/starter_app/vendor/plugins/attachment_fu/lib/technoweenie/attachment_fu/backends/file_system_backend.rb

@@ -0,0 +1,97 @@
+require 'ftools'
+module Technoweenie # :nodoc:
+  module AttachmentFu # :nodoc:
+    module Backends
+      # Methods for file system backed attachments
+      module FileSystemBackend
+        def self.included(base) #:nodoc:
+          base.before_update :rename_file
+        end
+      
+        # Gets the full path to the filename in this format:
+        #
+        #   # This assumes a model name like MyModel
+        #   # public/#{table_name} is the default filesystem path 
+        #   RAILS_ROOT/public/my_models/5/blah.jpg
+        #
+        # Overwrite this method in your model to customize the filename.
+        # The optional thumbnail argument will output the thumbnail's filename.
+        def full_filename(thumbnail = nil)
+          file_system_path = (thumbnail ? thumbnail_class : self).attachment_options[:path_prefix].to_s
+          File.join(RAILS_ROOT, file_system_path, *partitioned_path(thumbnail_name_for(thumbnail)))
+        end
+      
+        # Used as the base path that #public_filename strips off full_filename to create the public path
+        def base_path
+          @base_path ||= File.join(RAILS_ROOT, 'public')
+        end
+      
+        # The attachment ID used in the full path of a file
+        def attachment_path_id
+          ((respond_to?(:parent_id) && parent_id) || id).to_i
+        end
+      
+        # overrwrite this to do your own app-specific partitioning. 
+        # you can thank Jamis Buck for this: http://www.37signals.com/svn/archives2/id_partitioning.php
+        def partitioned_path(*args)
+          ("%08d" % attachment_path_id).scan(/..../) + args
+        end
+      
+        # Gets the public path to the file
+        # The optional thumbnail argument will output the thumbnail's filename.
+        def public_filename(thumbnail = nil)
+          full_filename(thumbnail).gsub %r(^#{Regexp.escape(base_path)}), ''
+        end
+      
+        def filename=(value)
+          @old_filename = full_filename unless filename.nil? || @old_filename
+          write_attribute :filename, sanitize_filename(value)
+        end
+
+        # Creates a temp file from the currently saved file.
+        def create_temp_file
+          copy_to_temp_file full_filename
+        end
+
+        protected
+          # Destroys the file.  Called in the after_destroy callback
+          def destroy_file
+            FileUtils.rm full_filename
+            # remove directory also if it is now empty
+            Dir.rmdir(File.dirname(full_filename)) if (Dir.entries(File.dirname(full_filename))-['.','..']).empty?
+          rescue
+            logger.info "Exception destroying  #{full_filename.inspect}: [#{$!.class.name}] #{$1.to_s}"
+            logger.warn $!.backtrace.collect { |b| " > #{b}" }.join("\n")
+          end
+
+          # Renames the given file before saving
+          def rename_file
+            return unless @old_filename && @old_filename != full_filename
+            if save_attachment? && File.exists?(@old_filename)
+              FileUtils.rm @old_filename
+            elsif File.exists?(@old_filename)
+              FileUtils.mv @old_filename, full_filename
+            end
+            @old_filename =  nil
+            true
+          end
+          
+          # Saves the file to the file system
+          def save_to_storage
+            if save_attachment?
+              # TODO: This overwrites the file if it exists, maybe have an allow_overwrite option?
+              FileUtils.mkdir_p(File.dirname(full_filename))
+              File.cp(temp_path, full_filename)
+              File.chmod(attachment_options[:chmod] || 0644, full_filename)
+            end
+            @old_filename = nil
+            true
+          end
+          
+          def current_data
+            File.file?(full_filename) ? File.read(full_filename) : nil
+          end
+      end
+    end
+  end
+end