bulldog 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+/pkg
+/tmp

data/DESCRIPTION.txt

@@ -0,0 +1,3 @@
+= Bulldog
+
+Flexible file attachments for active record.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 George Ogata
+
+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.rdoc

@@ -0,0 +1,18 @@
+= Bulldog
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 George Ogata. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,64 @@
+require 'rake'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+PLUGIN_ROOT = File.dirname(__FILE__)
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bulldog"
+    gem.summary = "A heavy-duty paperclip.  File attachments for ActiveRecord."
+    gem.description = File.read("#{PLUGIN_ROOT}/DESCRIPTION.txt")
+    gem.email = "george.ogata@gmail.com"
+    gem.homepage = "http://github.com/oggy/bulldog"
+    gem.authors = ["George Ogata"]
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "rspec_outlines"
+    gem.add_development_dependency "mocha"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Bulldog #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Run all specs."
+task :spec => ['check_dependencies', 'spec:unit', 'spec:integration']
+
+namespace :spec do
+  Spec::Rake::SpecTask.new(:unit) do |t|
+    t.pattern = 'spec/unit/**/*_spec.rb'
+    t.libs << 'lib' << 'spec'
+    t.spec_opts = ['--options', "\"#{PLUGIN_ROOT}/spec/spec.opts\""]
+  end
+
+  Spec::Rake::SpecTask.new(:integration) do |t|
+    t.pattern = 'spec/integration/**/*_spec.rb'
+    t.libs << 'lib' << 'spec'
+    t.spec_opts = ['--options', "\"#{PLUGIN_ROOT}/spec/spec.opts\""]
+  end
+end
+
+desc "Run all specs in spec directory with RCov"
+Spec::Rake::SpecTask.new(:rcov) do |t|
+  t.spec_opts = ['--options', "\"#{PLUGIN_ROOT}/spec/spec.opts\""]
+  t.rcov = true
+  t.rcov_opts = lambda do
+    IO.readlines(File.dirname(__FILE__) + "/spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+  end
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bulldog.gemspec

@@ -0,0 +1,157 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bulldog}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["George Ogata"]
+  s.date = %q{2009-11-15}
+  s.description = %q{= Bulldog
+
+Flexible file attachments for active record.
+}
+  s.email = %q{george.ogata@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "DESCRIPTION.txt",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bulldog.gemspec",
+     "lib/bulldog.rb",
+     "lib/bulldog/attachment.rb",
+     "lib/bulldog/attachment/base.rb",
+     "lib/bulldog/attachment/has_dimensions.rb",
+     "lib/bulldog/attachment/image.rb",
+     "lib/bulldog/attachment/maybe.rb",
+     "lib/bulldog/attachment/none.rb",
+     "lib/bulldog/attachment/pdf.rb",
+     "lib/bulldog/attachment/unknown.rb",
+     "lib/bulldog/attachment/video.rb",
+     "lib/bulldog/error.rb",
+     "lib/bulldog/has_attachment.rb",
+     "lib/bulldog/interpolation.rb",
+     "lib/bulldog/missing_file.rb",
+     "lib/bulldog/processor.rb",
+     "lib/bulldog/processor/argument_tree.rb",
+     "lib/bulldog/processor/base.rb",
+     "lib/bulldog/processor/ffmpeg.rb",
+     "lib/bulldog/processor/image_magick.rb",
+     "lib/bulldog/processor/one_shot.rb",
+     "lib/bulldog/reflection.rb",
+     "lib/bulldog/saved_file.rb",
+     "lib/bulldog/stream.rb",
+     "lib/bulldog/style.rb",
+     "lib/bulldog/style_set.rb",
+     "lib/bulldog/tempfile.rb",
+     "lib/bulldog/util.rb",
+     "lib/bulldog/validations.rb",
+     "lib/bulldog/vector2.rb",
+     "rails/init.rb",
+     "script/console",
+     "spec/data/empty.txt",
+     "spec/data/test.jpg",
+     "spec/data/test.mov",
+     "spec/data/test.pdf",
+     "spec/data/test.png",
+     "spec/data/test2.jpg",
+     "spec/helpers/image_creation.rb",
+     "spec/helpers/temporary_directory.rb",
+     "spec/helpers/temporary_models.rb",
+     "spec/helpers/temporary_values.rb",
+     "spec/helpers/test_upload_files.rb",
+     "spec/helpers/time_travel.rb",
+     "spec/integration/data/test.jpg",
+     "spec/integration/lifecycle_hooks_spec.rb",
+     "spec/integration/processing_image_attachments.rb",
+     "spec/integration/processing_video_attachments_spec.rb",
+     "spec/integration/saving_an_attachment_spec.rb",
+     "spec/matchers/file_operations.rb",
+     "spec/spec_helper.rb",
+     "spec/unit/attachment/base_spec.rb",
+     "spec/unit/attachment/image_spec.rb",
+     "spec/unit/attachment/maybe_spec.rb",
+     "spec/unit/attachment/pdf_spec.rb",
+     "spec/unit/attachment/video_spec.rb",
+     "spec/unit/attachment_spec.rb",
+     "spec/unit/has_attachment_spec.rb",
+     "spec/unit/interpolation_spec.rb",
+     "spec/unit/processor/argument_tree_spec.rb",
+     "spec/unit/processor/ffmpeg_spec.rb",
+     "spec/unit/processor/image_magick_spec.rb",
+     "spec/unit/processor/one_shot_spec.rb",
+     "spec/unit/reflection_spec.rb",
+     "spec/unit/stream_spec.rb",
+     "spec/unit/style_set_spec.rb",
+     "spec/unit/style_spec.rb",
+     "spec/unit/validations_spec.rb",
+     "spec/unit/vector2_spec.rb",
+     "tasks/bulldog_tasks.rake"
+  ]
+  s.homepage = %q{http://github.com/oggy/bulldog}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{A heavy-duty paperclip.  File attachments for ActiveRecord.}
+  s.test_files = [
+    "spec/helpers/image_creation.rb",
+     "spec/helpers/temporary_directory.rb",
+     "spec/helpers/temporary_models.rb",
+     "spec/helpers/temporary_values.rb",
+     "spec/helpers/test_upload_files.rb",
+     "spec/helpers/time_travel.rb",
+     "spec/integration/lifecycle_hooks_spec.rb",
+     "spec/integration/processing_image_attachments.rb",
+     "spec/integration/processing_video_attachments_spec.rb",
+     "spec/integration/saving_an_attachment_spec.rb",
+     "spec/matchers/file_operations.rb",
+     "spec/spec_helper.rb",
+     "spec/unit/attachment/base_spec.rb",
+     "spec/unit/attachment/image_spec.rb",
+     "spec/unit/attachment/maybe_spec.rb",
+     "spec/unit/attachment/pdf_spec.rb",
+     "spec/unit/attachment/video_spec.rb",
+     "spec/unit/attachment_spec.rb",
+     "spec/unit/has_attachment_spec.rb",
+     "spec/unit/interpolation_spec.rb",
+     "spec/unit/processor/argument_tree_spec.rb",
+     "spec/unit/processor/ffmpeg_spec.rb",
+     "spec/unit/processor/image_magick_spec.rb",
+     "spec/unit/processor/one_shot_spec.rb",
+     "spec/unit/reflection_spec.rb",
+     "spec/unit/stream_spec.rb",
+     "spec/unit/style_set_spec.rb",
+     "spec/unit/style_spec.rb",
+     "spec/unit/validations_spec.rb",
+     "spec/unit/vector2_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<rspec_outlines>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<rspec_outlines>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<rspec_outlines>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/lib/bulldog.rb

@@ -0,0 +1,95 @@
+require 'bulldog/util'
+module Bulldog
+  extend Util
+end
+
+require 'bulldog/error'
+require 'bulldog/has_attachment'
+require 'bulldog/validations'
+require 'bulldog/reflection'
+require 'bulldog/attachment'
+require 'bulldog/style'
+require 'bulldog/style_set'
+require 'bulldog/interpolation'
+require 'bulldog/saved_file'
+require 'bulldog/missing_file'
+require 'bulldog/processor'
+require 'bulldog/tempfile'
+require 'bulldog/stream'
+require 'bulldog/vector2'
+
+module Bulldog
+  class << self
+    #
+    # Logger object to log to.  Set to nil to omit logging.
+    #
+    attr_accessor :logger
+
+    #
+    # The default path template to use.  See the #path configuration
+    # option for #has_attachment.
+    #
+    attr_accessor :default_path_template
+
+    #
+    # The default url template to use.  See the #url configuration
+    # option for #has_attachment.
+    #
+    attr_accessor :default_url_template
+
+    #
+    # Define an interpolation token.
+    #
+    # If :<token> appears in a path or URL template, the block will be
+    # called to get the value to substitute in.  The block will be
+    # called with 3 arguments: the record, the attachment name, and
+    # the style.
+    #
+    # Example:
+    #
+    #     Bulldog.to_interpolate :datestamp do |record, name, style|
+    #       Date.today.strftime("%Y%m%d")
+    #     end
+    #
+    def to_interpolate(token, &block)
+      Interpolation.to_interpolate(token, &block)
+    end
+
+    #
+    # Register a custom type detector.
+    #
+    # When instantiating an attachment, Bulldog will use the
+    # configured type detector to work out which type of attachment to
+    # use.  This method registers a custom type detector which may be
+    # selected in your attachment configuration by just using the
+    # name.
+    #
+    # The given block is passed the record, the attribute name, and
+    # the value as a Bulldog::Stream.  The block should return a
+    # symbol representing the attachment type.
+    #
+    # Example:
+    #
+    #     Bulldog.to_detect_type_by :file_extension do |record, name, stream|
+    #       case File.extname(stream.file_name).sub(/\A\./)
+    #       when 'jpg', 'png', 'gif', 'tiff'
+    #         :image
+    #       when 'mpg', 'avi', 'ogv'
+    #         :video
+    #       when 'pdf'
+    #         :pdf
+    #       end
+    #     end
+    #
+    def to_detect_type_by(name, &block)
+      Reflection.to_detect_type_by(name, &block)
+    end
+  end
+
+  self.logger = nil
+  self.default_path_template = nil
+  self.default_url_template = "/assets/:class/:id.:style.:extension"
+end
+
+ActiveRecord::Base.send :include, Bulldog::HasAttachment
+ActiveRecord::Base.send :include, Bulldog::Validations

data/lib/bulldog/attachment.rb

@@ -0,0 +1,49 @@
+module Bulldog
+  module Attachment
+    def self.types_to_classes  #:nodoc:
+      @types_to_classes ||= {}
+    end
+  end
+end
+
+require 'bulldog/attachment/maybe'
+require 'bulldog/attachment/has_dimensions'
+require 'bulldog/attachment/base'
+require 'bulldog/attachment/none'
+require 'bulldog/attachment/image'
+require 'bulldog/attachment/video'
+require 'bulldog/attachment/pdf'
+require 'bulldog/attachment/unknown'
+
+module Bulldog
+  module Attachment
+    #
+    # Return a new attachment of the specified type.
+    #
+    # If +type+ is nil, then the returned attachment will be None if
+    # the stream is nil, or Unknown otherwise.
+    #
+    def self.of_type(type, record, name, stream)
+      if type.nil?
+        klass = stream ? Unknown : None
+      else
+        klass = class_from_type(type)
+      end
+      klass.new(record, name, stream)
+    end
+
+    #
+    # Return a None attachment for the given record and name.
+    #
+    def self.none(record, name)
+      None.new(record, name, nil)
+    end
+
+    #
+    # Return the class corresponding to the given type.
+    #
+    def self.class_from_type(type)
+      types_to_classes[type]
+    end
+  end
+end

data/lib/bulldog/attachment/base.rb

@@ -0,0 +1,167 @@
+module Bulldog
+  module Attachment
+    class Base < Maybe
+      #
+      # Return an instance of the record if the stream is valid, nil
+      # otherwise.
+      #
+      def self.try(record, name, stream)
+        attachment = new(record, name, stream)
+        attachment.send(:examine) ? attachment : nil
+      end
+
+      def initialize(record, name, stream)
+        @record = record
+        @name = name
+        @stream = stream
+        @value = stream && stream.target
+        @examination_result = nil
+      end
+
+      #
+      # Run the processors for the named event.
+      #
+      def process(event_name, *args)
+        reflection.events[event_name].each do |event|
+          if (types = event.attachment_types)
+            next unless types.include?(type)
+          end
+          processor_type = event.processor_type || default_processor_type
+          processor_class = Processor.const_get(processor_type.to_s.camelize)
+          processor = processor_class.new(self, styles_for_event(event), stream.path)
+          processor.process(*args, &event.callback)
+        end
+      end
+
+      #
+      # Return the path on the file system where the given style's
+      # image is to be stored.
+      #
+      def path(style_name = reflection.default_style)
+        interpolate_path(style_name)
+      end
+
+      #
+      # Return the URL where the given style's image is to be found.
+      #
+      def url(style_name = reflection.default_style)
+        interpolate_url(style_name)
+      end
+
+      #
+      # Return the size of the attached file.
+      #
+      def file_size
+        stream.size
+      end
+
+      #
+      # Return the original file name of the attached file.
+      #
+      def file_name
+        @file_name ||= stream.file_name
+      end
+
+      #
+      # Return the content type of the data.
+      #
+      def content_type
+        @content_type ||= stream.content_type
+      end
+
+      #
+      # Called when the attachment is saved.
+      #
+      def save
+        return if saved?
+        self.saved = true
+        original_path = interpolate_path(:original)
+        stream.write_to(original_path)
+      end
+
+      #
+      # Called when the attachment is destroyed, or just before
+      # another attachment is saved in its place.
+      #
+      def destroy
+        delete_files_and_empty_parent_directories
+      end
+
+      #
+      # Set any attributes that the attachment is configured to store.
+      #
+      storable_attribute :file_name
+      storable_attribute :file_size
+      storable_attribute :content_type
+
+      #
+      # Ensure the file examination has been run, and return the
+      # result.
+      #
+      def examine
+        if @examination_result.nil?
+          @examination_result = run_examination
+        else
+          @examination_result
+        end
+      end
+
+      protected  # ---------------------------------------------------
+
+      #
+      # Return the default processor class to use for this attachment.
+      #
+      def default_processor_type
+        :base
+      end
+
+      #
+      # Examine the stream.
+      #
+      # Return true if the stream looks like a valid instance of this
+      # attachment type, false otherwise.
+      #
+      def run_examination
+        true
+      end
+
+      private  # -------------------------------------------------------
+
+      def styles_for_event(event)
+        if event.styles
+          styles = reflection.styles.slice(*event.styles)
+        else
+          styles = reflection.styles
+        end
+      end
+
+      #
+      # Remove the files for this attachment, along with any parent
+      # directories.
+      #
+      def delete_files_and_empty_parent_directories
+        style_names = reflection.styles.map{|style| style.name} << :original
+        # If the attachment was set to nil, we need the original value
+        # to work out what to delete.
+        if column_name = reflection.column_name_for_stored_attribute(:file_name)
+          interpolation_params = {:basename => record.send("#{column_name}_was")}
+        else
+          interpolation_params = {}
+        end
+        style_names.each do |style_name|
+          path = interpolate_path(style_name, interpolation_params) or
+            next
+          FileUtils.rm_f(path)
+          begin
+            loop do
+              path = File.dirname(path)
+              FileUtils.rmdir(path)
+            end
+          rescue Errno::EEXIST, Errno::ENOTEMPTY, Errno::ENOENT, Errno::EINVAL, Errno::ENOTDIR
+            # Can't delete any further.
+          end
+        end
+      end
+    end
+  end
+end