upload_cache 1.0.0 → 1.2.0

data/lib/upload_cache.rb

@@ -1,11 +1,13 @@
-require 'uuidtools'
 require 'fileutils'
 require 'cgi'
+require 'tmpdir'
+
+require 'map'
 
 class UploadCache
-  Version = '1.0.0'
+  Version = '1.2.0'
 
-  README = <<-__
+  Readme = <<-__
     NAME
       upload_cache.rb
 
@@ -49,6 +51,9 @@ class UploadCache
 
         UploadCache.clear!  ### nuke old files once per day
 
+      upload_caches ***does this automatically*** at_exit{}, but you can still
+      run it manually if you like.
+
   __
 
   class << UploadCache
@@ -56,25 +61,36 @@ class UploadCache
       UploadCache::Version
     end
 
-    def base
-      @base ||= 'system/uploads/cache'
+    def url
+      @url ||= "file:/#{ root }"
     end
 
-    def base=(base)
-      @base = base.to_s.sub(%r|^/+|, '')
+    def url=(url)
+      @url = '/' + Array(url).join('/').squeeze('/').sub(%r|^/+|, '').sub(%r|/+$|, '')
     end
 
-    def url
-      '/' + base
+    def root
+      @root ||= Dir.tmpdir
     end
 
-    def root
-      @root ||= File.join(Rails.root, 'public', base)
+    def root=(root)
+      @root = File.expand_path(root)
     end
 
-    def uuid(*args)
-      UUIDTools::UUID.timestamp_create.to_s
+    {
+      'ffi-uuid'  => proc{|*args| FFI::UUID.generate_time.to_s},
+      'uuid'      => proc{|*args| UUID.generate.to_s},
+      'uuidtools' => proc{|*args| UUIDTools::UUID.timestamp_create.to_s}
+    }.each do |lib, implementation|
+      begin
+        require(lib)
+        define_method(:uuid, &implementation)
+        break
+      rescue LoadError
+        nil
+      end
     end
+    abort 'no suitable uuid generation library detected' unless method_defined?(:uuid)
 
     def tmpdir(&block)
       tmpdir = File.join(root, uuid)
@@ -93,35 +109,9 @@ class UploadCache
     end
 
     def cache_key_for(key)
-      "#{ key }__cache"
-    end
-
-    def for(params, key = :upload)
-      upload = params[key]
-      if upload.respond_to?(:read)
-        tmpdir do |tmp|
-          original_basename = upload.respond_to?(:original_path) ? upload.original_path : upload.original_filename
-          basename = cleanname(original_basename)
-
-          path = File.join(tmp, basename)
-          open(path, 'w'){|fd| fd.write(upload.read)}
-          upload_cache = new(key, path)
-          params[key] = upload_cache.io
-          return upload_cache
-        end
-      end
-
-      cache_key = cache_key_for(key)
-      upload_cache = params[cache_key]
-      if upload_cache
-        dirname, basename = File.split(upload_cache)
-        path = root + '/' + File.join(File.basename(dirname), basename)
-        upload_cache = new(key, path)
-        params[key] = upload_cache.io
-        return upload_cache
+      key.clone.tap do |cache_key|
+        cache_key[-1] = "#{ cache_key[-1] }_upload_cache"
       end
-
-      return new(key, path=nil)
     end
 
     def finalizer(object_id)
@@ -135,6 +125,8 @@ class UploadCache
     Age = 60 * 60 * 24
 
     def clear!(options = {})
+      return if UploadCache.turd?
+
       glob = File.join(root, '*')
       age = Integer(options[:age] || options['age'] || Age)
       since = options[:since] || options['since'] || Time.now
@@ -163,47 +155,136 @@ class UploadCache
         end
       end
     end
+
+    at_exit{ UploadCache.clear! }
+
+    def turd?
+      @turd ||= !!ENV['UPLOAD_CACHE_TURD']
+    end
+
+    def name_for(key, &block)
+      if block
+        @name_for = block
+      else
+        defined?(@name_for) ? @name_for[key] : [prefix, *Array(key)].compact.join('.')
+      end
+    end
+
+    def prefix(*value)
+      @prefix = value.shift if value
+      @prefix
+    end
+
+    def prefix=(value)
+      @prefix = value
+    end
+
+    def default
+      @default ||= Map[:url, nil, :path, nil]
+    end
+
+    def for(params, *args)
+      params = Map.for(params)
+      options = Map.options_for!(args)
+
+      key = Array(options[:key] || args).flatten.compact
+      key = [:upload] if key.empty?
+
+      upload = params.get(key)
+
+      if upload.respond_to?(:read)
+        tmpdir do |tmp|
+          original_basename =
+            [:path, :filename, :original_path, :original_filename].
+            map{|msg| upload.send(msg) if upload.respond_to?(msg)}.compact.first
+          basename = cleanname(original_basename)
+
+          path = File.join(tmp, basename)
+          open(path, 'wb'){|fd| fd.write(upload.read)}
+          upload_cache = UploadCache.new(key, path, options)
+          params.set(key, upload_cache.io)
+          return upload_cache
+        end
+      end
+
+      cache_key = cache_key_for(key)
+      upload_cache = params.get(cache_key)
+
+      if upload_cache
+        dirname, basename = File.split(upload_cache)
+        relative_dirname = File.expand_path(File.dirname(dirname))
+        relative_basename = File.join(relative_dirname, basename)
+        path = root + '/' + relative_basename
+        upload_cache = UploadCache.new(key, path, options)
+        params.set(key, upload_cache.io)
+        return upload_cache
+      end
+
+      upload_cache = UploadCache.new(key, options)
+      params.set(key, upload_cache.io) if upload_cache.io
+      return upload_cache
+    end
   end
 
   attr_accessor :key
   attr_accessor :cache_key
+  attr_accessor :name
   attr_accessor :path
   attr_accessor :dirname
   attr_accessor :basename
   attr_accessor :value
   attr_accessor :io
+  attr_accessor :default_url
+  attr_accessor :default_path
 
   IOs = {}
 
-  def initialize(key, path)
-    @key = key.to_s
-    @cache_key = UploadCache.cache_key_for(key)
+  def initialize(key, *args)
+    options = Map.options_for!(args)
+
+    @key = key
+    @cache_key = UploadCache.cache_key_for(@key)
+    @name = UploadCache.name_for(@cache_key)
+
+    path = args.shift || options[:path]
+
+    default = Map.for(options[:default])
+
+    @default_url = default[:url] || options[:default_url] || UploadCache.default.url
+    @default_path = default[:path] || options[:default_path] || UploadCache.default.path
 
     if path
       @path = path
       @dirname, @basename = File.split(@path)
       @value = File.join(File.basename(@dirname), @basename).strip
-      @io = open(@path)
-      IOs[object_id] = @io.fileno
-      ObjectSpace.define_finalizer(self, UploadCache.method(:finalizer).to_proc)
     else
       @path = nil
       @value = nil
     end
+
+    if @path or @default_path
+      @io = open(@path || @default_path, 'rb')
+      IOs[object_id] = @io.fileno
+      ObjectSpace.define_finalizer(self, UploadCache.method(:finalizer).to_proc)
+    end
+  end
+
+  def url
+    if @value
+      File.join(UploadCache.url, @value)
+    else
+      @default_url ? @default_url : nil
+    end
   end
 
   def hidden
-    raw("<input type='hidden' name='#{ @cache_key }' value='#{ @value }' />") if @value
+    raw("<input type='hidden' name='#{ @name }' value='#{ @value }' class='upload_cache' />") if @value
   end
 
   def to_s
     hidden.to_s
   end
 
-  def url
-    File.join(UploadCache.url, @value) if @value
-  end
-
   module HtmlSafe
     def html_safe() self end
     def html_safe?() self end
@@ -218,23 +299,34 @@ class UploadCache
   end
 
   def clear!
-    FileUtils.rm_rf(@dirname) if test(?d, @dirname)
-  rescue
-    nil
-  ensure
-    @io.close
-    IOs.delete(object_id)
-    Thread.new{ UploadCache.clear! }
+    return if UploadCache.turd?
+
+    begin
+      FileUtils.rm_rf(@dirname) if test(?d, @dirname)
+    rescue
+      nil
+    ensure
+      @io.close rescue nil
+      IOs.delete(object_id)
+      Thread.new{ UploadCache.clear! }
+    end
   end
 end
 
 Upload_cache = UploadCache unless defined?(Upload_cache)
 
+
+
 if defined?(Rails.env)
+
+  if defined?(Rails.root) and Rails.root
+    UploadCache.url = '/system/uploads/cache'
+    UploadCache.root = File.join(Rails.root, 'public', UploadCache.url)
+  end
+
   unless Rails.env.production?
     if defined?(unloadable)
       unloadable(UploadCache)
-      unloadable(Upload_cache)
     end
   end
 end

data/upload_cache.gemspec

@@ -0,0 +1,28 @@
+## upload_cache.gemspec
+#
+
+Gem::Specification::new do |spec|
+  spec.name = "upload_cache"
+  spec.version = "1.2.0"
+  spec.platform = Gem::Platform::RUBY
+  spec.summary = "upload_cache"
+  spec.description = "description: upload_cache kicks the ass"
+
+  spec.files = ["lib", "lib/upload_cache.rb", "Rakefile", "README", "upload_cache.gemspec"]
+  spec.executables = []
+  
+  spec.require_path = "lib"
+
+  spec.has_rdoc = true
+  spec.test_files = nil
+
+# spec.add_dependency 'lib', '>= version'
+  spec.add_dependency 'uuidtools'
+
+  spec.extensions.push(*[])
+
+  spec.rubyforge_project = "codeforpeople"
+  spec.author = "Ara T. Howard"
+  spec.email = "ara.t.howard@gmail.com"
+  spec.homepage = "http://github.com/ahoward/upload_cache"
+end

metadata

@@ -1,82 +1,59 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: upload_cache
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.2.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
 platform: ruby
-authors: 
+authors:
 - Ara T. Howard
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-03-16 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: uuidtools
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70226716783500 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-description: "description: upload_cache kicks the ass"
+  prerelease: false
+  version_requirements: *70226716783500
+description: ! 'description: upload_cache kicks the ass'
 email: ara.t.howard@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - lib/upload_cache.rb
 - Rakefile
 - README
-has_rdoc: true
+- upload_cache.gemspec
 homepage: http://github.com/ahoward/upload_cache
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: codeforpeople
-rubygems_version: 1.4.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: upload_cache
 test_files: []
-