citrusbyte-milton 0.2.4 → 0.3.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: citrusbyte-milton
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors: 
 - Ben Alavi
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-16 00:00:00 -08:00
+date: 2008-04-25 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -21,31 +21,10 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: 
-- INSTALL
-- MIT-LICENSE
-- README
-- CHANGELOG.rdoc
-- init.rb
-- lib/milton.rb
-- lib/milton/attachment.rb
-- lib/milton/is_image.rb
-- lib/milton/is_resizeable.rb
-- lib/milton/is_uploadable.rb
-- spec/schema.rb
-- spec/spec.opts
-- spec/spec_helper.rb
-- spec/fixtures/big-milton.jpg
-- spec/fixtures/milton.jpg
-- spec/fixtures/mini-milton.jpg
-- spec/fixtures/unsanitary .milton.jpg
-- spec/milton/attachment_spec.rb
-- spec/milton/is_image_spec.rb
-- spec/milton/is_resizeable_spec.rb
-- spec/milton/is_uploadable_spec.rb
-- spec/milton/milton_spec.rb
+files: []
+
 has_rdoc: true
-homepage: http://labs.citrusbyte.com/milton
+homepage: http://labs.citrusbyte.com/projects/milton
 post_install_message: 
 rdoc_options: []
 
@@ -69,6 +48,6 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Asset handling Rails plugin that makes few assumptions and is highly extensible.
+summary: Rails file and upload handling plugin built for extensibility. Supports Amazon S3 and resizes images.
 test_files: []
 

data/CHANGELOG.rdoc

@@ -1,22 +0,0 @@
-== 0.2.4, released 2009-02-16
-
-* Got rid of symlink_aware_mkdir_p as it wasn't actually needed, problem was
-  caused by invalid symlinks in the first place, oops. Left specs as they are
-  still valid.
-
-== 0.2.3, released 2009-02-16
-
-* Added a symlink_aware_mkdir_p to FileUtils to actually fix problem w/ root
-  attachments path being a symlink.
-* Added specs to reproduce error and fix in attachment_spec.rb
-
-== 0.2.2, released 2009-02-16
-
-* Made recreate directories aware of symlinks to avoid trying to recreate the
-  folder attachments are stored in if it's a symlink
-
-== 0.2.1, released 2009-01-16
-  
-* Fixed init.rb to work as a gem
-* Altered gemspec a tad
-* Started CHANGELOG

data/INSTALL

@@ -1,26 +0,0 @@
-== Installing Milton
-
-GemPlugin (Rails 2.1+)
--------------------------------------------------------------------------------
- 
-Add to your environment.rb:
-  
-  config.gem "citrusbyte-milton", :source => "http://gems.github.com", :lib => "milton"
-  
-Then run "rake gems:install" to install the gem.
-
-Plugin
--------------------------------------------------------------------------------
-  
-  script/plugin install git://github.com/citrusbyte/milton.git
-  
-Gem
--------------------------------------------------------------------------------
-
-  gem install citrusbyte-milton --source http://gems.github.com
-  
-== Installing ImageMagick (for image resizing)
-
-== Installing a FileSystem
-
-...j/k j/k

data/MIT-LICENSE

@@ -1,20 +0,0 @@
-Copyright (c) 2008 Citrusbyte, LLC
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -1,18 +0,0 @@
-== Milton
-
-Milton is an extensible attachment handling plugin that makes few assumptions
-but provides a lot of power.
-
-== More Info
-
-http://labs.citrusbyte.com/milton
-
-http://github.com/citrusbyte/milton/wikis/home
-
-== Dependencies
-* ActiveRecord
-* Rails (for now?)
-* A filesystem (more storage solutions coming soon...)
-
-=== For Image manipulation (not required!)
-* ImageMagick (more processors coming soon)

data/init.rb

@@ -1 +0,0 @@
-require 'milton'

data/lib/milton.rb

@@ -1,78 +0,0 @@
-require 'milton/attachment'
-require 'milton/is_image'
-require 'milton/is_resizeable'
-require 'milton/is_uploadable'
-
-module Citrusbyte
-  module Milton
-    # Raised when a file which was expected to exist appears not to exist
-    class MissingFileError < StandardError;end;
-
-    # Some definitions for file semantics used throughout Milton, understanding
-    # this will make understanding the code a bit easier and avoid ambiguity:
-    #
-    # path:
-    #   the full path to a file or directory in the filesystem
-    #     /var/log/apache2 or /var/log/apache2/access.log
-    #   can also be defined as:
-    #     path == dirname + filename
-    #     path == dirname + basename + extension
-    #
-    # dirname:
-    #   the directory portion of the path to a file or directory, all the chars
-    #   up to the final /
-    #     /var/log/apache2            => /var/log
-    #     /var/log/apache2/           => /var/log/apache2
-    #     /var/log/apache2/access.log => /var/log/apache2
-    #
-    # basename:
-    #   the portion of a filename *with no extension* (ruby's "basename" may or
-    #   may not have an extension), all the chars after the last / and before
-    #   the last .
-    #     /var/log/apache2                 => apache2
-    #     /var/log/apache2/                => nil
-    #     /var/log/apache2/access.log      => access
-    #     /var/log/apache2/access.2008.log => access.2008
-    #
-    # extension:
-    #   the extension portion of a filename w/ no preceding ., all the chars
-    #   after the final .
-    #     /var/log/apache2                 => nil
-    #     /var/log/apache2/                => nil
-    #     /var/log/apache2/access.log      => log
-    #     /var/log/apache2/access.2008.log => log
-    # 
-    # filename:
-    #   the filename portion of a path w/ extension, all the chars after the
-    #   final /
-    #     /var/log/apache2                 => apache2
-    #     /var/log/apache2/                => nil
-    #     /var/log/apache2/access.log      => access.log
-    #     /var/log/apache2/access.2008.log => access.2008.log
-    #   can also be defined as:
-    #     filename == basename + (extension ? '.' + extension : '')
-    #
-    
-    def self.included(base)
-      base.extend Citrusbyte::Milton::BaseMethods
-      base.extend Citrusbyte::Milton::IsUploadable::IsMethods
-      base.extend Citrusbyte::Milton::IsResizeable::IsMethods
-      base.extend Citrusbyte::Milton::IsImage::IsMethods
-    end
-    
-    module BaseMethods
-      protected
-        # The attachment methods give the core of Milton's file-handling, so
-        # various extensions can use this when they're included to make sure
-        # that the core attachment methods are available
-        def ensure_attachment_methods(options={})
-          unless included_modules.include?(Citrusbyte::Milton::Attachment)
-            include Citrusbyte::Milton::Attachment
-            has_attachment_methods(options)
-          end
-        end
-    end
-  end
-end
-
-ActiveRecord::Base.send(:include, Citrusbyte::Milton)

data/lib/milton/attachment.rb

@@ -1,278 +0,0 @@
-require 'ftools'
-require 'fileutils'
-
-module Citrusbyte
-  module Milton
-    module Attachment      
-      def self.included(base)
-        base.class_inheritable_accessor :milton_options
-        base.milton_options = {}
-        base.extend Citrusbyte::Milton::Attachment::AttachmentMethods
-      end
-      
-      module AttachmentMethods
-        def require_column(column, message)
-          begin
-            raise message unless column_names.include?(column)
-          rescue ActiveRecord::StatementInvalid => i
-            # table doesn't exist yet, i.e. hasn't been migrated in...
-          end
-        end
-        
-        def has_attachment_methods(options={})
-          require_column 'filename', "Milton requires a filename column on #{class_name} table"
-          
-          # character used to seperate a filename from its derivative options, this
-          # character will be stripped from all incoming filenames and replaced by
-          # replacement
-          options[:separator]        ||= '.'
-          options[:replacement]      ||= '-'
-          
-          # root of where the underlying files are stored (or will be stored)
-          # on the file system
-          options[:file_system_path] ||= File.join(RAILS_ROOT, "public", table_name)
-          
-          # mode to set on stored files and created directories
-          options[:chmod]            ||= 0755
-          
-          self.milton_options.merge!(options)
-          
-          validates_presence_of :filename
-          
-          before_destroy :destroy_attached_file
-          
-          include Citrusbyte::Milton::Attachment::InstanceMethods
-        end
-      end
-      
-      # These get mixed in to your model when you use Milton
-      module InstanceMethods
-        # Sets the filename to the given filename (sanitizes the given filename
-        # as well)
-        #
-        # TODO: change the filename on the underlying file system on save so as
-        # not to orphan the file
-        def filename=(name)
-          write_attribute :filename, AttachableFile.sanitize_filename(name, self.milton_options)
-        end
-
-        # Simple helper, same as path except returns the directory from
-        # .../public/ on, i.e. for showing images in your views.
-        #
-        #   @asset.path        => /var/www/site/public/assets/000/000/001/313/milton.jpg
-        #   @asset.public_path => /assets/000/000/001/313/milton.jpg
-        #
-        # Can send a different base path than public if you want to give the
-        # path from that base on, useful if you change your root path to
-        # somewhere else.
-        def public_path(options={}, base='public')
-          path(options).gsub(/.*?\/#{base}/, '')
-        end
-        
-        # The path to the file, takes an optional hash of options which can be
-        # used to determine a particular derivative of the file desired
-        def path(options={})
-          attached_file.path(options)
-        end
-                
-        protected
-          # A reference to the attached file, this is probably what you want to
-          # overwrite to introduce a new behavior
-          #
-          # i.e. 
-          #   have attached_file return a ResizeableFile, or a TranscodableFile
-          def attached_file
-            @attached_file ||= AttachableFile.new(self, filename)
-          end
-          
-          # Clean the file from the filesystem
-          def destroy_attached_file
-            attached_file.destroy
-          end
-      end
-    end
-
-    # AttachableFile is what Milton uses to interface between your model and
-    # the underlying file. Rather than just pushing a whole bunch of methods
-    # into your model, you get a reference to an AttachableFile (or something
-    # that extends AttachableFile).
-    class AttachableFile
-      class << self
-      # Sanitizes the given filename, removes pathnames and the special chars
-      # needed for options seperation for derivatives
-      def sanitize_filename(filename, options)
-        File.basename(filename, File.extname(filename)).gsub(/^.*(\\|\/)/, '').
-          gsub(/[^\w]|#{Regexp.escape(options[:separator])}/, options[:replacement]).
-          strip + File.extname(filename)
-      end
-
-      # Creates the given directory and sets it to the mode given in
-      # options[:chmod]
-      def recreate_directory(directory, options)
-        return true if File.exists?(directory)
-        FileUtils.mkdir_p(directory)
-        File.chmod(options[:chmod], directory)
-      end
-        
-        # Partitioner that takes an id, pads it up to 12 digits then splits
-        # that into 4 folders deep, each 3 digits long.
-        # 
-        # i.e.
-        #   000/000/012/139
-        # 
-        # Scheme allows for 1000 billion files while never storing more than
-        # 1000 files in a single folder.
-        #
-        # Can overwrite this method to provide your own partitioning scheme.
-        def partition(id)
-          # TODO: there's probably some fancy 1-line way to do this...
-          padded = ("0"*(12-id.to_s.size)+id.to_s).split('')
-          File.join(*[0, 3, 6, 9].collect{ |i| padded.slice(i, 3).join })
-        end
-      end
-      
-      attr_accessor :filename
-      attr_accessor :attachment
-      
-      # TODO: can probably fanagle a way to only pass a reference to the model
-      # and not need the filename (or better yet just the filename and 
-      # decouple)
-      def initialize(attachment, filename)
-        @attachment = attachment
-        @filename   = filename
-      end
-      
-      # Returns the milton options on the associated attachment.
-      def milton_options
-        self.attachment.class.milton_options
-      end
-
-      # Returns the full path and filename to the file with the given options.
-      # If no options are given then returns the path and filename to the
-      # original file.
-      def path(options={})
-        options.empty? ? File.join(dirname, filename) : Derivative.new(filename, options).path
-      end
-            
-      # Returns the full directory path up to the file, w/o the filename.
-      def dirname
-        File.join(root_path, partitioned_path)
-      end
-      
-      # Returns true if the file exists on the underlying file system.
-      def exists?
-        File.exist?(path)
-      end
-      
-      # Removes the file from the underlying file system and any derivatives of
-      # the file.
-      def destroy
-        destroy_file
-      end
-      
-      protected
-        # Returns the file as a File object opened for reading.
-        def file_reference
-          File.new(path)
-        end
-        
-        # Returns the partitioned path segment based on the id of the model
-        # this file is attached to.
-        def partitioned_path
-          self.class.partition(self.attachment.id)
-        end
-
-        # The full path to the root of where files will be stored on disk.
-        def root_path
-          milton_options[:file_system_path]
-        end
-
-        # Creates the directory this file will be stored in.
-        # Also creates the root path where all attachments are stored if it
-        # doesn't exist yet.
-        def recreate_directory
-          self.class.recreate_directory(dirname, milton_options)
-        end
-        
-        # Removes the containing directory from the filesystem (and hence the
-        # file and any derivatives)
-        def destroy_file
-          FileUtils.rm_rf dirname if File.exists?(dirname)
-        end
-        
-        # Returns an array of Derivatives of this AttachableFile.
-        def derivatives
-          Dir.glob(dirname + '/*').reject{ |filename| filename == self.filename }.collect do |filename|
-            Derivative.from_filename(filename)
-          end
-        end
-    end
-
-    # Represents a file created on the file system that is a derivative of the
-    # one referenced by the model, i.e. a thumbnail of an image, or a transcode
-    # of a video.
-    # 
-    # Provides a container for options and a uniform API to dealing with
-    # passing options for the creation of derivatives.
-    # 
-    # Files created as derivatives have their creation options appended into
-    # their filenames so it can be checked later if a file w/ the given
-    # options already exists (so as not to create it again).
-    #
-    class Derivative
-      attr_reader :options
-      
-      class << self
-        # Given a string of attachment options, splits them out into a hash,
-        # useful for things that take options on the query string or from
-        # filenames
-        def options_from(string)
-          Hash[*(string.split('_').collect { |option| 
-            key, value = option.split('=')
-            [ key.to_sym, value ]
-          }).flatten]
-        end
-
-        # Given a filename (presumably with options embedded in it) parses out
-        # the options and returns them as a hash.
-        def extract_options_from(filename)
-          File.basename(filename, File.extname(filename))[(filename.rindex(AttachableFile.options[:separator]) + 1)..-1]
-        end
-        
-        # Creates a new Derivative from the given filename by extracting the
-        # options.
-        def from_filename(filename)
-          Derivative.new(filename, options_from(extract_options_from(filename)))
-        end
-      end
-      
-      # Instantiate a new Derivative, takes a reference to the AttachableFile
-      # (or specialization class) that this will be a derivative of, and a hash
-      # of the options defining the derivative.
-      def initialize(file, options)
-        @file    = file
-        @options = options
-      end
-      
-      # The resulting filename of this Derivative with embedded options.
-      def filename
-        filename = @file.path
-        append   = options.collect{ |k, v| "#{k}=#{v}" }.sort.join('_')
-        
-        File.basename(filename, File.extname(filename)) + 
-        (append.blank? ? '' : "#{@file.milton_options[:separator]}#{append}") + 
-        File.extname(filename)
-      end
-      
-      # The full path and filename to this Derivative.
-      def path
-        File.join(@file.dirname, filename)
-      end
-      
-      # Returns true if the file resulting from this Derivative exists.
-      def exists?
-        File.exists?(path)
-      end
-    end
-  end
-end