upload_cache 1.0.0

data/README

@@ -0,0 +1,42 @@
+NAME
+  upload_cache.rb
+
+DESCRIPTION
+  a small utility library to facility caching http file uploads between
+  form validation failures.  designed for rails, but usable anywhere.
+
+USAGE
+  in the controller
+
+    def upload
+      @upload_cache = UploadCache.for(params, :upload)
+
+      @record = Model.new(params)
+
+      if request.get?
+        render and return
+      end
+
+      if request.post?
+        @record.save!
+        @upload_cache.clear!
+      end
+    end
+
+
+  in the view
+
+    <input type='file' name='upload />
+
+    <%= @upload_cache.hidden %>
+
+    <!-- optionally, you can show any uploaded upload -->
+
+    <% if url = @upload_cache.url %>
+      you already uploaded: <img src='<%= raw url %>' />
+    <% end %>
+
+
+  in a rake task
+
+    UploadCache.clear!  ### nuke old files once per day

data/Rakefile

@@ -0,0 +1,365 @@
+This.rubyforge_project = 'codeforpeople'
+This.author = "Ara T. Howard"
+This.email = "ara.t.howard@gmail.com"
+This.homepage = "http://github.com/ahoward/#{ This.lib }"
+
+
+task :default do
+  puts((Rake::Task.tasks.map{|task| task.name.gsub(/::/,':')} - ['default']).sort)
+end
+
+task :test do
+  run_tests!
+end
+
+namespace :test do
+  task(:unit){ run_tests!(:unit) }
+  task(:functional){ run_tests!(:functional) }
+  task(:integration){ run_tests!(:integration) }
+end
+
+def run_tests!(which = nil)
+  which ||= '**'
+  test_dir = File.join(This.dir, "test")
+  test_glob ||= File.join(test_dir, "#{ which }/**_test.rb")
+  test_rbs = Dir.glob(test_glob).sort
+        
+  div = ('=' * 119)
+  line = ('-' * 119)
+  helper = "-r ./test/helper.rb" if test(?e, "./test/helper.rb")
+
+  test_rbs.each_with_index do |test_rb, index|
+    testno = index + 1
+    command = "#{ This.ruby } -I ./lib -I ./test/lib #{ helper } #{ test_rb }"
+
+    puts
+    say(div, :color => :cyan, :bold => true)
+    say("@#{ testno } => ", :bold => true, :method => :print)
+    say(command, :color => :cyan, :bold => true)
+    say(line, :color => :cyan, :bold => true)
+
+    system(command)
+
+    say(line, :color => :cyan, :bold => true)
+
+    status = $?.exitstatus
+
+    if status.zero? 
+      say("@#{ testno } <= ", :bold => true, :color => :white, :method => :print)
+      say("SUCCESS", :color => :green, :bold => true)
+    else
+      say("@#{ testno } <= ", :bold => true, :color => :white, :method => :print)
+      say("FAILURE", :color => :red, :bold => true)
+    end
+    say(line, :color => :cyan, :bold => true)
+
+    exit(status) unless status.zero?
+  end
+end
+
+
+task :gemspec do
+  ignore_extensions = 'git', 'svn', 'tmp', /sw./, 'bak', 'gem'
+  ignore_directories = %w[ pkg ]
+  ignore_files = %w[ test/log ]
+
+  shiteless = 
+    lambda do |list|
+      list.delete_if do |entry|
+        next unless test(?e, entry)
+        extension = File.basename(entry).split(%r/[.]/).last
+        ignore_extensions.any?{|ext| ext === extension}
+      end
+      list.delete_if do |entry|
+        next unless test(?d, entry)
+        dirname = File.expand_path(entry)
+        ignore_directories.any?{|dir| File.expand_path(dir) == dirname}
+      end
+      list.delete_if do |entry|
+        next unless test(?f, entry)
+        filename = File.expand_path(entry)
+        ignore_files.any?{|file| File.expand_path(file) == filename}
+      end
+    end
+
+  lib         = This.lib
+  object      = This.object
+  version     = This.version
+  files       = shiteless[Dir::glob("**/**")]
+  executables = shiteless[Dir::glob("bin/*")].map{|exe| File.basename(exe)}
+  has_rdoc    = true #File.exist?('doc')
+  test_files  = "test/#{ lib }.rb" if File.file?("test/#{ lib }.rb")
+  summary     = object.respond_to?(:summary) ? object.summary : "summary: #{ lib } kicks the ass"
+  description = object.respond_to?(:description) ? object.description : "description: #{ lib } kicks the ass"
+
+  if This.extensions.nil?
+    This.extensions = []
+    extensions = This.extensions
+    %w( Makefile configure extconf.rb ).each do |ext|
+      extensions << ext if File.exists?(ext)
+    end
+  end
+  extensions = [extensions].flatten.compact
+
+  template = 
+    if test(?e, 'gemspec.erb')
+      Template{ IO.read('gemspec.erb') }
+    else
+      Template {
+        <<-__
+          ## #{ lib }.gemspec
+          #
+
+          Gem::Specification::new do |spec|
+            spec.name = #{ lib.inspect }
+            spec.version = #{ version.inspect }
+            spec.platform = Gem::Platform::RUBY
+            spec.summary = #{ lib.inspect }
+            spec.description = #{ description.inspect }
+
+            spec.files = #{ files.inspect }
+            spec.executables = #{ executables.inspect }
+            
+            spec.require_path = "lib"
+
+            spec.has_rdoc = #{ has_rdoc.inspect }
+            spec.test_files = #{ test_files.inspect }
+
+          # spec.add_dependency 'lib', '>= version'
+            spec.add_dependency 'uuidtools'
+
+            spec.extensions.push(*#{ extensions.inspect })
+
+            spec.rubyforge_project = #{ This.rubyforge_project.inspect }
+            spec.author = #{ This.author.inspect }
+            spec.email = #{ This.email.inspect }
+            spec.homepage = #{ This.homepage.inspect }
+          end
+        __
+      }
+    end
+
+  Fu.mkdir_p(This.pkgdir)
+  This.gemspec = File.join(This.dir, "#{ This.lib }.gemspec") #File.join(This.pkgdir, "gemspec.rb")
+  open("#{ This.gemspec }", "w"){|fd| fd.puts(template)}
+end
+
+task :gem => [:clean, :gemspec] do
+  Fu.mkdir_p(This.pkgdir)
+  before = Dir['*.gem']
+  cmd = "gem build #{ This.gemspec }"
+  `#{ cmd }`
+  after = Dir['*.gem']
+  gem = ((after - before).first || after.first) or abort('no gem!')
+  Fu.mv gem, This.pkgdir
+  This.gem = File.basename(gem)
+end
+
+task :readme do
+  samples = ''
+  prompt = '~ > '
+  lib = This.lib
+  version = This.version
+
+  Dir['sample*/*'].sort.each do |sample|
+    samples << "\n" << "  <========< #{ sample } >========>" << "\n\n"
+
+    cmd = "cat #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+    samples << Util.indent(`#{ cmd }`, 4) << "\n"
+
+    cmd = "ruby #{ sample }"
+    samples << Util.indent(prompt + cmd, 2) << "\n\n"
+
+    cmd = "ruby -e'STDOUT.sync=true; exec %(ruby -I ./lib #{ sample })'"
+    samples << Util.indent(`#{ cmd } 2>&1`, 4) << "\n"
+  end
+
+  template = 
+    if test(?e, 'readme.erb')
+      Template{ IO.read('readme.erb') }
+    else
+      Template {
+        <<-__
+          NAME
+            #{ lib }
+
+          DESCRIPTION
+
+          INSTALL
+            gem install #{ lib }
+
+          SAMPLES
+            #{ samples }
+        __
+      }
+    end
+
+  open("README", "w"){|fd| fd.puts template}
+end
+
+
+task :clean do
+  Dir[File.join(This.pkgdir, '**/**')].each{|entry| Fu.rm_rf(entry)}
+end
+
+
+task :release => [:clean, :gemspec, :gem] do
+  gems = Dir[File.join(This.pkgdir, '*.gem')].flatten
+  raise "which one? : #{ gems.inspect }" if gems.size > 1
+  raise "no gems?" if gems.size < 1
+  cmd = "rubyforge login && rubyforge add_release #{ This.rubyforge_project } #{ This.lib } #{ This.version } #{ This.pkgdir }/#{ This.gem }"
+  puts cmd
+  system cmd
+  cmd = "gem push #{ This.pkgdir }/#{ This.gem }"
+  puts cmd
+  system cmd
+end
+
+
+
+
+
+BEGIN {
+# support for this rakefile
+#
+  $VERBOSE = nil
+
+  require 'ostruct'
+  require 'erb'
+  require 'fileutils'
+  require 'rbconfig'
+
+# fu shortcut
+#
+  Fu = FileUtils
+
+# cache a bunch of stuff about this rakefile/environment
+#
+  This = OpenStruct.new
+
+  This.file = File.expand_path(__FILE__)
+  This.dir = File.dirname(This.file)
+  This.pkgdir = File.join(This.dir, 'pkg')
+
+# grok lib
+#
+  lib = ENV['LIB']
+  unless lib
+    lib = File.basename(Dir.pwd).sub(/[-].*$/, '')
+  end
+  This.lib = lib
+
+# grok version
+#
+  version = ENV['VERSION']
+  unless version
+    require "./lib/#{ This.lib }"
+    This.name = lib.capitalize
+    This.object = eval(This.name)
+    version = This.object.send(:version)
+  end
+  This.version = version
+
+# we need to know the name of the lib an it's version
+#
+  abort('no lib') unless This.lib
+  abort('no version') unless This.version
+
+# discover full path to this ruby executable
+#
+  c = Config::CONFIG
+  bindir = c["bindir"] || c['BINDIR']
+  ruby_install_name = c['ruby_install_name'] || c['RUBY_INSTALL_NAME'] || 'ruby'
+  ruby_ext = c['EXEEXT'] || ''
+  ruby = File.join(bindir, (ruby_install_name + ruby_ext))
+  This.ruby = ruby
+
+# some utils
+#
+  module Util
+    def indent(s, n = 2)
+      s = unindent(s)
+      ws = ' ' * n
+      s.gsub(%r/^/, ws)
+    end
+
+    def unindent(s)
+      indent = nil
+      s.each_line do |line|
+        next if line =~ %r/^\s*$/
+        indent = line[%r/^\s*/] and break
+      end
+      indent ? s.gsub(%r/^#{ indent }/, "") : s
+    end
+    extend self
+  end
+
+# template support
+#
+  class Template
+    def initialize(&block)
+      @block = block.binding
+      @template = block.call.to_s
+    end
+    def expand(b=nil)
+      ERB.new(Util.unindent(@template)).result(b||@block)
+    end
+    alias_method 'to_s', 'expand'
+  end
+  def Template(*args, &block) Template.new(*args, &block) end
+
+# colored console output support
+#
+  This.ansi = {
+    :clear      => "\e[0m",
+    :reset      => "\e[0m",
+    :erase_line => "\e[K",
+    :erase_char => "\e[P",
+    :bold       => "\e[1m",
+    :dark       => "\e[2m",
+    :underline  => "\e[4m",
+    :underscore => "\e[4m",
+    :blink      => "\e[5m",
+    :reverse    => "\e[7m",
+    :concealed  => "\e[8m",
+    :black      => "\e[30m",
+    :red        => "\e[31m",
+    :green      => "\e[32m",
+    :yellow     => "\e[33m",
+    :blue       => "\e[34m",
+    :magenta    => "\e[35m",
+    :cyan       => "\e[36m",
+    :white      => "\e[37m",
+    :on_black   => "\e[40m",
+    :on_red     => "\e[41m",
+    :on_green   => "\e[42m",
+    :on_yellow  => "\e[43m",
+    :on_blue    => "\e[44m",
+    :on_magenta => "\e[45m",
+    :on_cyan    => "\e[46m",
+    :on_white   => "\e[47m"
+  }
+  def say(phrase, *args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    options[:color] = args.shift.to_s.to_sym unless args.empty?
+    keys = options.keys
+    keys.each{|key| options[key.to_s.to_sym] = options.delete(key)}
+
+    color = options[:color]
+    bold = options.has_key?(:bold)
+
+    parts = [phrase]
+    parts.unshift(This.ansi[color]) if color
+    parts.unshift(This.ansi[:bold]) if bold
+    parts.push(This.ansi[:clear]) if parts.size > 1
+
+    method = options[:method] || :puts
+
+    Kernel.send(method, parts.join)
+  end
+
+# always run out of the project dir
+#
+  Dir.chdir(This.dir)
+}

data/lib/upload_cache.rb

@@ -0,0 +1,240 @@
+require 'uuidtools'
+require 'fileutils'
+require 'cgi'
+
+class UploadCache
+  Version = '1.0.0'
+
+  README = <<-__
+    NAME
+      upload_cache.rb
+
+    DESCRIPTION
+      a small utility library to facility caching http file uploads between
+      form validation failures.  designed for rails, but usable anywhere.
+
+    USAGE
+      in the controller
+
+        def upload
+          @upload_cache = UploadCache.for(params, :upload)
+
+          @record = Model.new(params)
+
+          if request.get?
+            render and return
+          end
+
+          if request.post?
+            @record.save!
+            @upload_cache.clear!
+          end
+        end
+
+
+      in the view
+
+        <input type='file' name='upload />
+
+        <%= @upload_cache.hidden %>
+
+        <!-- optionally, you can show any uploaded upload -->
+
+        <% if url = @upload_cache.url %>
+          you already uploaded: <img src='<%= raw url %>' />
+        <% end %>
+
+
+      in a rake task
+
+        UploadCache.clear!  ### nuke old files once per day
+
+  __
+
+  class << UploadCache
+    def version
+      UploadCache::Version
+    end
+
+    def base
+      @base ||= 'system/uploads/cache'
+    end
+
+    def base=(base)
+      @base = base.to_s.sub(%r|^/+|, '')
+    end
+
+    def url
+      '/' + base
+    end
+
+    def root
+      @root ||= File.join(Rails.root, 'public', base)
+    end
+
+    def uuid(*args)
+      UUIDTools::UUID.timestamp_create.to_s
+    end
+
+    def tmpdir(&block)
+      tmpdir = File.join(root, uuid)
+
+      if block
+        FileUtils.mkdir_p(tmpdir)
+        block.call(tmpdir)
+      else
+        tmpdir
+      end
+    end
+
+    def cleanname(path)
+      basename = File.basename(path.to_s)
+      CGI.unescape(basename).gsub(%r/[^0-9a-zA-Z_@)(~.-]/, '_').gsub(%r/_+/,'_')
+    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
+      end
+
+      return new(key, path=nil)
+    end
+
+    def finalizer(object_id)
+      if fd = IOs[object_id]
+        IO.for_fd(fd).close
+        IOs.delete(object_id)
+      end
+    end
+
+    UUIDPattern = %r/^[a-zA-Z0-9-]+$/io
+    Age = 60 * 60 * 24
+
+    def clear!(options = {})
+      glob = File.join(root, '*')
+      age = Integer(options[:age] || options['age'] || Age)
+      since = options[:since] || options['since'] || Time.now
+
+      Dir.glob(glob) do |entry|
+        begin
+          next unless test(?d, entry)
+          next unless File.basename(entry) =~ UUIDPattern
+
+          files = Dir.glob(File.join(entry, '**/**'))
+
+          all_files_are_old =
+            files.all? do |file|
+              begin
+                stat = File.stat(file)
+                age = since - stat.atime
+                age >= Age
+              rescue
+                false
+              end
+            end
+
+          FileUtils.rm_rf(entry) if all_files_are_old
+        rescue
+          next
+        end
+      end
+    end
+  end
+
+  attr_accessor :key
+  attr_accessor :cache_key
+  attr_accessor :path
+  attr_accessor :dirname
+  attr_accessor :basename
+  attr_accessor :value
+  attr_accessor :io
+
+  IOs = {}
+
+  def initialize(key, path)
+    @key = key.to_s
+    @cache_key = UploadCache.cache_key_for(key)
+
+    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
+  end
+
+  def hidden
+    raw("<input type='hidden' name='#{ @cache_key }' value='#{ @value }' />") 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
+  end
+
+  def raw(*args)
+    string = args.join
+    unless string.respond_to?(:html_safe)
+      string.extend(HtmlSafe)
+    end
+    string.html_safe
+  end
+
+  def clear!
+    FileUtils.rm_rf(@dirname) if test(?d, @dirname)
+  rescue
+    nil
+  ensure
+    @io.close
+    IOs.delete(object_id)
+    Thread.new{ UploadCache.clear! }
+  end
+end
+
+Upload_cache = UploadCache unless defined?(Upload_cache)
+
+if defined?(Rails.env)
+  unless Rails.env.production?
+    if defined?(unloadable)
+      unloadable(UploadCache)
+      unloadable(Upload_cache)
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: upload_cache
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+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 
+  name: uuidtools
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: "description: upload_cache kicks the ass"
+email: ara.t.howard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/upload_cache.rb
+- Rakefile
+- README
+has_rdoc: true
+homepage: http://github.com/ahoward/upload_cache
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: codeforpeople
+rubygems_version: 1.4.2
+signing_key: 
+specification_version: 3
+summary: upload_cache
+test_files: []
+