dragonfly 0.9.15 → 1.0

data/lib/dragonfly/shell.rb

@@ -1,40 +1,29 @@
 require 'shellwords'
+require 'open3'
+require 'dragonfly'
 
 module Dragonfly
-  module Shell
-    
-    include Configurable
-    configurable_attr :log_commands, false
+  class Shell
 
     # Exceptions
     class CommandFailed < RuntimeError; end
 
-    def run(command, args="")
-      full_command = "#{command} #{escape_args(args)}"
-      log.debug("Running command: #{full_command}") if log_commands
-      begin
-        result = `#{full_command}`
-      rescue Errno::ENOENT
-        raise_shell_command_failed(full_command)
+    def run(command, opts={})
+      command = escape_args(command) unless opts[:escape] == false
+      Dragonfly.debug("shell command: #{command}")
+      Open3.popen3 command do |stdin, stdout, stderr, wait_thread|
+        status = wait_thread.value
+        raise CommandFailed, "Command failed (#{command}) with exit status #{status.exitstatus} and stderr #{stderr.read}" unless status.success?
+        stdout.read
       end
-      if $?.exitstatus == 1
-        throw :unable_to_handle
-      elsif !$?.success?
-        raise_shell_command_failed(full_command)
-      end
-      result
-    end
-  
-    def raise_shell_command_failed(command)
-      raise CommandFailed, "Command failed (#{command}) with exit status #{$?.exitstatus}"
     end
-    
+
     def escape_args(args)
       args.shellsplit.map do |arg|
         quote arg.gsub(/\\?'/, %q('\\\\''))
       end.join(' ')
     end
-    
+
     def quote(string)
       q = Dragonfly.running_on_windows? ? '"' : "'"
       q + string + q

data/lib/dragonfly/spec/data_store_examples.rb

@@ -0,0 +1,64 @@
+require 'dragonfly/content'
+
+shared_examples_for "data_store" do
+
+  # Using these shared spec requires you to set the inst var @data_store
+  let (:app) { Dragonfly.app }
+  let (:content) { Dragonfly::Content.new(app, "gollum") }
+  let (:content2) { Dragonfly::Content.new(app, "gollum") }
+
+
+  describe "write" do
+    it "returns a unique identifier for each storage" do
+      @data_store.write(content).should_not == @data_store.write(content2)
+    end
+    it "should return a unique identifier for each storage even when the first is deleted" do
+      uid1 = @data_store.write(content)
+      @data_store.destroy(uid1)
+      uid2 = @data_store.write(content)
+      uid1.should_not == uid2
+    end
+    it "should allow for passing in options as a second argument" do
+      @data_store.write(content, :some => :option)
+    end
+  end
+
+  describe "read" do
+    before(:each) do
+      content.add_meta('bitrate' => 35, 'name' => 'danny.boy')
+      uid = @data_store.write(content)
+      stuff, meta = @data_store.read(uid)
+      @retrieved_content = Dragonfly::Content.new(app, stuff, meta)
+    end
+
+    it "should read the stored data" do
+      @retrieved_content.data.should == "gollum"
+    end
+
+    it "should return the stored meta" do
+      @retrieved_content.meta['bitrate'].should == 35
+      @retrieved_content.meta['name'].should == 'danny.boy'
+    end
+
+    it "should return nil if the data doesn't exist" do
+      @data_store.read('gooble').should be_nil
+    end
+  end
+
+  describe "destroy" do
+
+    it "should destroy the stored data" do
+      uid = @data_store.write(content)
+      @data_store.destroy(uid)
+      @data_store.read(uid).should be_nil
+    end
+
+    it "should do nothing if the data doesn't exist on destroy" do
+      uid = @data_store.write(content)
+      @data_store.destroy(uid)
+      @data_store.destroy(uid)
+    end
+
+  end
+
+end

data/lib/dragonfly/temp_object.rb

@@ -1,11 +1,12 @@
 require 'stringio'
 require 'tempfile'
 require 'pathname'
+require 'fileutils'
 
 module Dragonfly
 
   # A TempObject is used for HOLDING DATA.
-  # It's the thing that is passed between the datastore, the processor and the encoder, and is useful
+  # It's the thing that is passed between the datastore and the processor, and is useful
   # for separating how the data was created and how it is later accessed.
   #
   # You can initialize it various ways:
@@ -32,14 +33,12 @@ module Dragonfly
   #
   class TempObject
 
-    include HasFilename
-
     # Exceptions
     class Closed < RuntimeError; end
 
     # Instance Methods
 
-    def initialize(obj, meta={})
+    def initialize(obj)
       if obj.is_a? TempObject
         @data = obj.get_data
         @tempfile = obj.get_tempfile
@@ -57,9 +56,9 @@ module Dragonfly
       elsif obj.respond_to?(:path) # e.g. Rack::Test::UploadedFile
         @pathname = Pathname.new(obj.path)
       else
-        raise ArgumentError, "#{self.class.name} must be initialized with a String, a Pathname, a File, a Tempfile, another TempObject, something that responds to .tempfile, or something that responds to .path"
+        raise ArgumentError, "#{self.class.name} must be initialized with a String, a Pathname, a File, a Tempfile, another TempObject, something that responds to .tempfile, or something that responds to .path - you gave #{obj.inspect}"
       end
-      
+
       @tempfile.close if @tempfile
 
       # Original filename
@@ -68,21 +67,13 @@ module Dragonfly
       elsif @pathname
         @pathname.basename.to_s
       end
-      
-      # Meta
-      @meta = meta
-      @meta[:name] ||= @original_filename if @original_filename
     end
-    
+
     attr_reader :original_filename
-    attr_accessor :meta
-    
-    def name
-      meta[:name]
-    end
-    
-    def name=(name)
-      meta[:name] = name
+
+    def ext
+      name = original_filename
+      name.split('.').last if name
     end
 
     def data
@@ -90,19 +81,6 @@ module Dragonfly
       @data ||= file{|f| f.read }
     end
 
-    def tempfile
-      raise Closed, "can't read from tempfile as TempObject has been closed" if closed?
-      @tempfile ||= begin
-        case
-        when @data
-          @tempfile = new_tempfile(@data)
-        when @pathname
-          @tempfile = copy_to_tempfile(@pathname.expand_path)
-        end
-        @tempfile
-      end
-    end
-
     def file(&block)
       f = tempfile.open
       tempfile.binmode
@@ -143,6 +121,12 @@ module Dragonfly
       File.new(path, 'rb')
     end
 
+    def to_tempfile
+      tempfile = copy_to_tempfile(path)
+      tempfile.open
+      tempfile
+    end
+
     def to_io(&block)
       @data ? StringIO.open(@data, 'rb', &block) : file(&block)
     end
@@ -168,45 +152,46 @@ module Dragonfly
       "<#{self.class.name} #{content_string} >"
     end
 
-    def unique_id
-      @unique_id ||= "#{object_id}#{rand(1000000)}"
-    end
-
     protected
 
     # We don't use normal accessors here because #data etc. do more than just return the instance var
     def get_data
       @data
     end
-    
+
     def get_pathname
       @pathname
     end
-    
+
     def get_tempfile
       @tempfile
     end
 
     private
 
+    def tempfile
+      raise Closed, "can't read from tempfile as TempObject has been closed" if closed?
+      @tempfile ||= begin
+        case
+        when @data
+          @tempfile = Utils.new_tempfile(ext, @data)
+        when @pathname
+          @tempfile = copy_to_tempfile(@pathname.expand_path)
+        end
+        @tempfile
+      end
+    end
+
     def block_size
       8192
     end
 
     def copy_to_tempfile(path)
-      tempfile = new_tempfile
+      tempfile = Utils.new_tempfile(ext)
       FileUtils.cp path, tempfile.path
       tempfile
     end
 
-    def new_tempfile(content=nil)
-      tempfile = ext ? Tempfile.new(['dragonfly', ".#{ext}"]) : Tempfile.new('dragonfly')
-      tempfile.binmode
-      tempfile.write(content) if content
-      tempfile.close
-      tempfile
-    end
-
     def prepare_path(path)
       dir = File.dirname(path)
       FileUtils.mkdir_p(dir) unless File.exist?(dir)

data/lib/dragonfly/url_attributes.rb

@@ -1,30 +1,27 @@
-module Dragonfly
-  
-  # UrlAttributes is like a normal hash, but treats
-  # :name, :ext and :basename specially -
-  # updating ext/basename also updates the name
-  class UrlAttributes < Hash
-
-    SPECIAL_KEYS = [:name, :basename, :ext]
+require 'ostruct'
+require 'dragonfly/has_filename'
+require 'dragonfly/utils'
 
-    include HasFilename
+module Dragonfly
+  class UrlAttributes < OpenStruct
+    include HasFilename # Updating ext / basename also updates the name
 
-    def name
-      self[:name]
+    def empty?
+      @table.reject{|k, v| v.nil? }.empty?
     end
-    
-    def name=(name)
-      self[:name] = name
+
+    # Hack so we can use .send('format') and it not call the private Kernel method
+    def format
+      @table[:format]
     end
-    
-    def slice(*keys)
-      keys.inject({}) do |hash, key|
-        key = key.to_sym
-        hash[key] = SPECIAL_KEYS.include?(key) ? send(key) : self[key]
-        hash
+
+    def extract(keys)
+      keys.inject({}) do |attrs, key|
+        value = send(key)
+        attrs[key] = value unless Utils.blank?(value)
+        attrs
       end
     end
-    
   end
-
 end
+

data/lib/dragonfly/url_mapper.rb

@@ -1,3 +1,6 @@
+require 'rack'
+require 'dragonfly/utils'
+
 module Dragonfly
   class UrlMapper
 

data/lib/dragonfly/utils.rb

@@ -1,11 +1,16 @@
 require 'tempfile'
 require 'uri'
+require 'rack'
 
 module Dragonfly
   module Utils
 
     module_function
 
+    def blank?(obj)
+      obj.respond_to?(:empty?) ? obj.empty? : !obj
+    end
+
     def new_tempfile(ext=nil, content=nil)
       tempfile = ext ? Tempfile.new(['dragonfly', ".#{ext}"]) : Tempfile.new('dragonfly')
       tempfile.binmode
@@ -21,6 +26,13 @@ module Dragonfly
       end
     end
 
+    def stringify_keys(hash)
+      hash.inject({}) do |new_hash, (key, value)|
+        new_hash[key.to_s] = value
+        new_hash
+      end
+    end
+
     def uri_escape_segment(string)
       Rack::Utils.escape_path(string)
     end

data/lib/dragonfly/version.rb

@@ -1,3 +1,3 @@
 module Dragonfly
-  VERSION = '0.9.15'
+  VERSION = '1.0'
 end

data/lib/dragonfly/whitelist.rb

@@ -0,0 +1,19 @@
+require 'forwardable'
+
+module Dragonfly
+  class Whitelist
+    extend Forwardable
+    def_delegators :patterns, :push
+
+    def initialize(patterns=[])
+      @patterns = patterns
+    end
+
+    attr_reader :patterns
+
+    def include?(string)
+      patterns.any?{|pattern| pattern === string }
+    end
+  end
+end
+

data/lib/rails/generators/dragonfly/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Initialize and configure a dragonfly 'app', ready for serving images and other content!
+
+Example:
+    rails generate dragonfly
+
+    This will create:
+        config/initializers/dragonfly.rb

data/lib/rails/generators/dragonfly/dragonfly_generator.rb

@@ -0,0 +1,24 @@
+class DragonflyGenerator < Rails::Generators::Base
+  source_root File.expand_path('../templates', __FILE__)
+
+  def create_initializer
+    template "initializer.rb.erb", "config/initializers/dragonfly.rb"
+  end
+
+  private
+
+  def generate_secret
+    rand(1e32).to_s(36)
+  end
+
+  if RUBY_VERSION > "1.9"
+    def hash_key(key)
+      "#{key}:"
+    end
+  else
+    def hash_key(key)
+      ":#{key} =>"
+    end
+  end
+end
+

data/lib/rails/generators/dragonfly/templates/initializer.rb.erb

@@ -0,0 +1,27 @@
+require 'dragonfly'
+
+# Configure
+Dragonfly.app.configure do
+  plugin :imagemagick
+
+  protect_from_dos_attacks true
+  secret "<%= generate_secret %>"
+
+  url_format "/media/:job/:name"
+
+  datastore :file,
+    <%= hash_key(:root_path) %> Rails.root.join('public/system/dragonfly', Rails.env),
+    <%= hash_key(:server_root) %> Rails.root.join('public')
+end
+
+# Logger
+Dragonfly.logger = Rails.logger
+
+# Mount as middleware
+Rails.application.middleware.use Dragonfly::Middleware
+
+# Add model functionality
+if defined?(ActiveRecord::Base)
+  ActiveRecord::Base.extend Dragonfly::Model
+  ActiveRecord::Base.extend Dragonfly::Model::Validations
+end