snap 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Nick Stielau
+
+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,37 @@
+= snap
+
+Directory listings faster than you can say 'onomatopoeia'.
+
+Snap helps you quickly browse through directories and examine files in your browser.
+
+Install the gem with:
+
+  $: sudo gem install snap  
+  
+Run Snap, chrooted to the current directory
+View at: http://localhost:4567
+
+  $: snap
+  
+Run Snap, chrooted to your home directory  
+View at: http://localhost:4567
+
+  $: snap -r ~
+  
+Run Snap with a different port
+View at: http://localhost:3000  
+
+  $: snap -p 3000
+  
+View other Snap options:
+
+  $: snap -h
+  Usage: snap [options]
+      -e env
+      -s server
+      -p port
+      -r root
+
+== Copyright
+
+Copyright (c) 2009 Nick Stielau. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "snap"
+    gem.summary = %Q{Directory listings faster than you can say 'onomatopoeia'.}
+    gem.description = %Q{A Sinatra app to make directory listings a snap!}
+    gem.email = "nick.stielau@gmail.com"
+    gem.homepage = "http://nstielau.github.com/snap"
+    gem.authors = ["Nick Stielau"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "mocha", ">= 0.9.8"
+    gem.add_development_dependency "rack-test", ">= 0.5.1"
+    gem.add_runtime_dependency 'sinatra', '>= 0.9.4'
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "snap #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/TODO

@@ -0,0 +1,23 @@
+##########
+## TODO ##
+##########
+
+# Add '..' directory to go back
+# Pretty print size
+# Pretty up template, w CSS
+# Line up columns/headers
+# Serve images, html, and text different (Mime Types!)
+# Add type field
+# Move icon code from snap_file into helper
+# Syntax highlight code?
+# Truncate long file names
+# Add gh-pages branch
+  # Make submodule or whatever
+# Canonicalize trailing '/' with redirect
+# BDD: Define tests
+# Test +  Mock + Shoulda
+# Breadcumberize path
+# Deal with symlinks
+# Deal with files with spaces for 'type'
+# Favicon
+# SnapFileType class

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/snap

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'sinatra'
+require 'snap'
+
+require 'optparse'
+
+options = {}
+if ARGV.any?
+  OptionParser.new { |op|
+    op.banner = "Usage: snap [options]"
+    op.on('-e env') { |val| options[:environment] = val.to_sym }
+    op.on('-s server') { |val| options[:server] = val }
+    op.on('-p port') { |val| options[:port] = val.to_i }
+    op.on('-r root') { |val| options[:root] = val }
+  }.parse!(ARGV.dup)
+end
+
+# run!
+Snap::Server.run!(options)

data/lib/snap.rb

@@ -0,0 +1,2 @@
+require 'snap/server'
+require 'snap/snap_file'

data/lib/snap/assets/styles.css

@@ -0,0 +1,17 @@
+body {
+ background-color: #eee;
+}
+
+div#wrapper {
+ width: 800px;
+ padding: 20px;  
+}
+
+div#content {
+  width: 600px;
+  background-color: #ccc;
+  -moz-border-radius: 5px;
+  -webkit-border-radius: 5px;
+  border: 2px solid #777;
+  padding: 10px;
+}

data/lib/snap/server.rb

@@ -0,0 +1,95 @@
+require 'rubygems'
+require 'sinatra'
+require 'erb'
+require 'digest/md5'
+
+module Snap
+  class Server < Sinatra::Base
+    set :views, File.dirname(__FILE__) + '/views'
+
+    #require 'logger'
+    #use Rack::CommonLogger, Logger.new(STDOUT)
+    # Add Rack::Cache
+    
+    def self.run!(options={})
+      @@root_dir = options[:root]
+      super.run! if super.respond_to?("run!")
+    end
+
+    def get_root_dir
+      @@root_dir ||= Dir.pwd
+    end
+    
+    # TODO: Cattr?    
+    def get_current_dir
+      @dir
+    end
+  
+    def set_current_dir(newdir)
+      @dir = newdir
+    end
+  
+    #############
+    # Snap Assets    
+    get '/__snap__*/:file.:format' do
+      filename = File.dirname(__FILE__) + "/assets#{params[:splat]}/#{params[:file]}.#{params[:format]}"
+      headers({"Cache-Control" => "max-age=3600, public"})
+      content_type params[:format]
+      send_file filename
+    end  
+  
+    ######
+    # 404    
+    not_found do
+      status 404
+      erb :not_found
+    end
+  
+    ####################
+    # Main splat handler
+    get '/*' do
+      relative_location = params[:splat]
+      full_location = File.join(get_root_dir, relative_location)
+      if File.exist?(full_location)
+        if File.directory?(full_location)
+          set_current_dir(full_location)
+          erb :index
+        elsif File.file?(full_location)
+          if params[:format] && params[:format].to_sym == :code
+            @full_location = full_location
+            erb :code
+          else
+            send_file full_location, :type => params[:format] || File.extname(full_location)
+          end
+        end
+      else
+        raise Sinatra::NotFound
+      end
+    end
+  
+  
+    def get_snap_files
+      files = Dir.glob("#{get_current_dir}/**").map{|f| SnapFile.new(f)}
+      files.insert(0,SnapFile.new(File.join(get_current_dir, '..'))) unless at_root?      
+      files
+    end
+    
+    def at_root?
+      File.expand_path(get_current_dir) == File.expand_path(get_root_dir)
+    end
+    
+    # def breadcrumberize_path
+    #   relative_path = get_current_dir.sub(get_root_dir, "")
+    #   puts "Relative path is #{relative_path}"
+    #   relative_parts = relative_path.split("/")
+    #   relative_parts.pop
+    #   puts "relative_parts are #{relative_parts.inspect}"
+    #   b_root = get_current_dir
+    #   relative_parts.each do |p|
+    #     b_root = b_root.sub(p, "<a href=\"/#{p}\">#{p}</a>")
+    #     puts "Bboot is now #{b_root}"
+    #   end
+    #   b_root
+    # end
+  end
+end

data/lib/snap/snap_file.rb

@@ -0,0 +1,57 @@
+module Snap
+  class SnapFile
+    def initialize(file_name)
+      @path = file_name.sub("//", "/")
+    end
+  
+    def name
+      if @path && @path.match("/")
+        @path.split("/").last
+      else
+        @path
+      end
+    end
+    
+    def path
+      @path
+    end
+    
+    def relative_to(dir)
+      rel = @path.sub(dir, "")
+    end
+
+    def size
+      File.size(@path)
+    end
+
+    def mtime
+      return if File.symlink?(@path)
+      mtime = File.mtime(@path)
+      if (mtime.to_i > Time.now.to_i - 24*60*60)
+        mtime.strftime("%I:%M:%S %p")
+      else
+        mtime.strftime("%Y-%m-%d")      
+      end
+    end
+    
+    def type
+      escaped_path = @path.gsub(" ", "\\ ")
+      type = `file #{escaped_path}`.strip.sub(/.*:\s*/, "")
+      type = "text"       if type.match("text")
+      type = "jpeg"       if type.match("JPEG image data")
+      type = "png"        if type.match("PNG image")
+      type = "executable" if type.match("executable")
+      type[0..11]
+    end
+    
+    # TODO: Get this HTML outta here
+    def icon
+      return "<img src=\"/__snap__/icons/dir.png\"/>" if directory?
+      return "<img src=\"/__snap__/icons/text.png\"/>"
+    end
+    
+    def directory?
+      type.match("directory")
+    end
+  end
+end

data/lib/snap/views/code.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+   "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <title>Snap! <%=get_current_dir %></title>
+  <link rel="stylesheet" type="text/css" href="/__snap__/styles.css" media="screen, print" />
+</head>
+<body>
+  <div>
+        <h3>Looking at <%= @full_location %></h3>
+<pre>
+<%= File.read(@full_location) %>
+</pre>
+  </div>
+</body>
+</html>

data/lib/snap/views/index.erb

@@ -0,0 +1,37 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+   "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <title>Snap! <%= get_current_dir %></title>
+  <link rel="stylesheet" type="text/css" href="/__snap__/styles.css" media="screen, print" />
+</head>
+<body>
+  <img src='/__snap__/snap.jpg' style="position:absolute;">
+  <div align="center">
+    <div id="wrapper">
+      <div id="content">
+        <h3>Listing <%= get_current_dir %> </h3>
+        <table>
+          <tr>
+            <th></th>
+            <th>File</th>
+            <th>Last Modified</th>
+            <th>Size</th>
+            <th>Type</th>
+          </tr>
+          <% get_snap_files.each do |f| %>
+          <tr>
+            <td><%= f.icon %></td>
+            <td><a href="<%= f.relative_to(get_root_dir) %>"><%= f.name %></a></td>
+            <td><%= f.mtime %></td>
+            <td><%= f.size %> bytes</a></td>
+            <td><%= f.type %></td>
+          </tr>
+          <% end %>
+        </table>
+      </div>
+    </div>
+  </div>
+</body>
+</html>

data/lib/snap/views/not_found.erb

@@ -0,0 +1,18 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
+   "http://www.w3.org/TR/html4/loose.dtd">
+<html lang="en">
+<head>
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+  <title>Snap! <%= get_current_dir %></title>
+  <link rel="stylesheet" type="text/css" href="/__snap__/styles.css" media="screen, print" />
+</head>
+<body>
+  <img src='/__snap__/snap.jpg'/ style="position:absolute;">
+  <div align="center">
+    <div id="content">
+      <h3>404izzle</h3>
+      Go back to <a href="/"><%= get_root_dir %></a>.
+    </div>
+  </div>
+</body>
+</html>

data/snap.gemspec

@@ -0,0 +1,80 @@
+# 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{snap}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nick Stielau"]
+  s.date = %q{2009-11-29}
+  s.default_executable = %q{snap}
+  s.description = %q{A Sinatra app to make directory listings a snap!}
+  s.email = %q{nick.stielau@gmail.com}
+  s.executables = ["snap"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION",
+     "bin/snap",
+     "lib/snap.rb",
+     "lib/snap/assets/icons/back.png",
+     "lib/snap/assets/icons/dir.png",
+     "lib/snap/assets/icons/forward.png",
+     "lib/snap/assets/icons/text.png",
+     "lib/snap/assets/snap.jpg",
+     "lib/snap/assets/styles.css",
+     "lib/snap/server.rb",
+     "lib/snap/snap_file.rb",
+     "lib/snap/views/code.erb",
+     "lib/snap/views/index.erb",
+     "lib/snap/views/not_found.erb",
+     "snap.gemspec",
+     "test/helper.rb",
+     "test/test_snap.rb",
+     "test/test_snap_file.rb"
+  ]
+  s.homepage = %q{http://nstielau.github.com/snap}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Directory listings faster than you can say 'onomatopoeia'.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_snap.rb",
+     "test/test_snap_file.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<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0.9.8"])
+      s.add_development_dependency(%q<rack-test>, [">= 0.5.1"])
+      s.add_runtime_dependency(%q<sinatra>, [">= 0.9.4"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0.9.8"])
+      s.add_dependency(%q<rack-test>, [">= 0.5.1"])
+      s.add_dependency(%q<sinatra>, [">= 0.9.4"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0.9.8"])
+    s.add_dependency(%q<rack-test>, [">= 0.5.1"])
+    s.add_dependency(%q<sinatra>, [">= 0.9.4"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'snap'
+
+class Test::Unit::TestCase
+end

data/test/test_snap.rb

@@ -0,0 +1,31 @@
+#require 'helper'
+require 'snap'
+require 'rubygems'
+require 'rack/test'
+require 'test/unit'
+
+class SnapAppTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+  
+  def app
+   Snap::Server
+  end
+
+  def test_title
+   get '/'
+   assert last_response.body.match(/.<title>Snap! \/.*<\/title>/)
+  end
+  
+  def test_title_with_path
+    get '/'
+    string = "<title>Snap! #{Dir.pwd}/<\/title>"    
+    assert last_response.body.match(string), "Body doesn't contain #{string}:\n#{last_response.body}"
+  end
+  
+  def test_404
+    get '/couldnt/possibly/exist'
+    assert_equal(last_response.status, 404)
+    assert(last_response.body.match("404"))
+  end
+  
+end

data/test/test_snap_file.rb

@@ -0,0 +1,57 @@
+require 'test/unit'
+require 'snap/snap_file'
+
+class SnapFileTest < Test::Unit::TestCase
+  def test_file_name
+    a = Snap::SnapFile.new('/path/to/some_file')
+    assert_equal(a.name, "some_file")
+  end
+  
+  def test_file_name_with_space
+    a = Snap::SnapFile.new('/path/to/some file')
+    assert_equal(a.name, "some file")
+  end
+  
+  def test_file_type
+    a = Snap::SnapFile.new(__FILE__)    
+    assert_equal(a.type, "text")
+  end
+  
+  def test_file_type_with_space
+    Tempfile.open("snap test temp") do |f|
+      a = Snap::SnapFile.new(f.path)    
+      assert_equal(a.type, "empty")
+    end
+  end
+  
+  def test_file_size
+    a = Snap::SnapFile.new(__FILE__)    
+    assert(a.size > 0)
+    assert_equal(a.size.class, Fixnum)
+  end
+
+  def test_empty_file_size
+    Tempfile.open("snap_test_temp") do |f|
+      a = Snap::SnapFile.new(f.path)    
+      assert_equal(a.size, 0, "Tempfile should be of size 0")
+    end
+  end
+  
+  def test_mtime
+    Tempfile.open("snap_test_temp") do |f|
+      a = Snap::SnapFile.new(f.path)    
+      assert(a.mtime.match(/\d\d:\d\d:\d\d??/), "Mtime is #{a.mtime}")
+    end
+  end
+  
+  def test_relative_path
+    a = Snap::SnapFile.new(__FILE__)
+    assert_equal(a.relative_to(File.dirname(__FILE__)), "/#{File.basename(__FILE__)}")
+  end
+  
+  def test_path
+    a = Snap::SnapFile.new(__FILE__)
+    assert_equal(a.path, __FILE__)
+  end
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification 
+name: snap
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Nick Stielau
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-29 00:00:00 -08:00
+default_executable: snap
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.4
+    version: 
+description: A Sinatra app to make directory listings a snap!
+email: nick.stielau@gmail.com
+executables: 
+- snap
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- TODO
+- VERSION
+- bin/snap
+- lib/snap.rb
+- lib/snap/assets/icons/back.png
+- lib/snap/assets/icons/dir.png
+- lib/snap/assets/icons/forward.png
+- lib/snap/assets/icons/text.png
+- lib/snap/assets/snap.jpg
+- lib/snap/assets/styles.css
+- lib/snap/server.rb
+- lib/snap/snap_file.rb
+- lib/snap/views/code.erb
+- lib/snap/views/index.erb
+- lib/snap/views/not_found.erb
+- snap.gemspec
+- test/helper.rb
+- test/test_snap.rb
+- test/test_snap_file.rb
+has_rdoc: true
+homepage: http://nstielau.github.com/snap
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Directory listings faster than you can say 'onomatopoeia'.
+test_files: 
+- test/helper.rb
+- test/test_snap.rb
+- test/test_snap_file.rb