directory_listing 0.3.2 → 0.3.3

data/.gitignore

@@ -1,2 +1,5 @@
 .DS_Store
 pkg/*
+.yardoc/*
+doc/*
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,27 @@
+PATH
+  remote: .
+  specs:
+    directory_listing (0.3.2)
+      filesize (>= 0.0.2)
+      truncate (>= 0.0.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    filesize (0.0.2)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.1.0)
+    truncate (0.1.0)
+    yard (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  directory_listing!
+  rack-test (~> 0.6.2)
+  rake
+  yard (~> 0.8.7)

data/README.md

@@ -1,6 +1,18 @@
 ### directory_listing: easy, CSS-styled, Apache-like directory listings for Sinatra.
 
-### Install:
+### Description
+
+```directory_listing``` is a [Sinatra](http://sinatrarb.com) plugin that generates Apache-like directory listings. It was designed to be:
+
+1. Easy to use and configure
+2. Style-able with CSS
+3. Able to replicate all the features of Apache's directory listings including sorting
+
+```directory_listing``` also includes a number of configuration options - see the [Options](#options) section below.
+
+A short blog post / announcement exists [here](http://blog.catsanddogshavealltheluck.com/#Directory_Listings_in_Sinatra).
+
+### Install
 
 For regular use:
 
@@ -11,10 +23,11 @@ For regular use:
 Or from source:
 
 ```bash
+bundle install
 rake install
 ```
 
-### Usage:
+### Usage
 
 ```list()``` will return HTML, so the following is a complete Sinatra app that will provide a directory listing of whatever path you navigate to and let you view any file that is served directly:
 
@@ -39,7 +52,7 @@ not_found do
 end
 ```
 
-### Options:
+### Options
 
 Options are passed in a hash:
 
@@ -58,7 +71,7 @@ Available options:
 - ```last_modified_format``` - [format](http://www.ruby-doc.org/core-2.0/Time.html) for last modified date - defaults to ```%Y-%m-%d %H:%M:%S```
 - ```filename_truncate_length``` - (integer) length to truncate file names to - defaults to 40
 
-### Styling:
+### Styling
 
 It's pretty easy to figure out how to style ```directory_listing``` by looking at the source, but here are some gotchas:
 
@@ -87,10 +100,20 @@ table tr > td:first-child + td + td {
 }
 ```
 
-### Contributing:
+### Getting Help
+
+The best way to report a bug or feature request is to [open an issue on GitHub](https://github.com/movesmyers/directory_listing/issues). 
+
+Additionally, I'd love to hear your feedback about ```directory_listing``` through [Twitter](http://twitter.com/movesmyers) or [email](mailto:rick.myers@me.com).
+
+### Contributing
 
 1. Fork it
 2. Create your feature branch (```git checkout -b my-new-feature```)
 3. Commit your changes (```git commit -am 'Add some feature'```)
 4. Push to the branch (```git push origin my-new-feature```)
-5. Create new Pull Request
+5. Create new Pull Request
+
+### License
+
+```directory_listing``` is licensed under the DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE. See the LICENSE file for details.

data/Rakefile

@@ -1 +1,24 @@
-require "bundler/gem_tasks"
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'yard'
+
+##
+# Run the test application
+
+task :run do
+  `ruby test/test_directory_listing_app.rb -o 0.0.0.0`
+end
+
+##
+# Generate yard docs
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+end
+
+##
+# Run tests
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end

data/directory_listing.gemspec

@@ -11,11 +11,14 @@ Gem::Specification.new do |s|
   s.email       = 'rick.myers@me.com'
   s.license     = 'WTFPL'
   s.files       = `git ls-files`.split($/)
+  s.test_files  = s.files.grep(%r{^(test|spec|features)/})
   s.homepage    = 'https://rubygems.org/gems/directory_listing'
   
   s.add_dependency 'filesize', '>=0.0.2'
   s.add_dependency 'truncate', '>=0.0.4'
   
-  s.add_development_dependency "bundler", "~> 1.3"
   s.add_development_dependency "rake"
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rack-test", "~> 0.6.2"
+  s.add_development_dependency "yard", "~> 0.8.7"
 end

data/lib/sinatra/directory_listing/resource.rb

@@ -15,20 +15,20 @@ class Resource
   end
     
   ##
-  # Get the mtime for a file. 
+  # Set the mtime for a file. 
+  #
+  # Returns the mtime as a Time object so it can be sorted.
 
   def set_mtime(file)
     f = File.join(File.join($public_folder, URI.unescape($request_path)), file)
     html = "\t<td>#{File.mtime(f).strftime($last_modified_format)}</td>"
-    
-    ##
-    # Return the mtime as a Time object so it can be sorted. 
-    
     return [File.mtime(f), html]
   end
 
   ##
-  # Get the size for a file. 
+  # Set the size for a file. 
+  #
+  # Returns the size as number.
 
   def set_size(file)
     html = ""
@@ -42,15 +42,11 @@ class Resource
       converted = Filesize.from("#{File.stat(f).size} B").pretty
       html = "\t<td>#{converted}</td>"
     end
-    
-    ##
-    # Return the mtime as a Time object so it can be sorted.
-    
     return [size, html]
   end
 
   ##
-  # Get the name of the file and its link.
+  # Set the name of the file and its link.
 
   def set_name(file)
 
@@ -120,7 +116,7 @@ class Resource
         #{@name_html}
         #{@mtime_html}
         #{@size_html}
-        \t</tr>"
+        </tr>"
       end
     end
     html

data/lib/sinatra/directory_listing/version.rb

@@ -1,3 +1,3 @@
 module Directory_listing
-  VERSION = '0.3.2'
+  VERSION = '0.3.3'
 end

data/test/public/1234.txt

@@ -0,0 +1 @@
+1234

data/test/test_directory_listing.rb

@@ -0,0 +1,110 @@
+ENV['RACK_ENV'] = 'test'
+
+require_relative 'test_directory_listing_app'
+
+require 'test/unit'
+require 'rack/test'
+
+class DirectoryListingTest < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Sinatra::Application
+  end
+ 
+  ##
+  # test that a request to the root directory is ok.
+
+  def test_index
+    get '/'
+    assert last_response.ok?
+  end
+
+  ##
+  # test trying to list a non-existent file or directory
+
+  def test_not_found
+    get '/does_not_exist'
+    assert_equal 'Try again.', last_response.body
+  end
+
+  ##
+  # test serving a file (not directory)
+
+  def test_send_file
+    get '/1234.txt'
+    assert_equal '1234', last_response.body.chomp
+  end
+
+  ##
+  # test defining a stylesheet
+
+  def test_stylesheets
+    get '/stylesheets'
+    assert last_response.body.include?('/stylesheets/styles.css')
+  end
+
+  ##
+  # test defining a readme
+
+  def test_readme
+    get '/readme'
+    assert last_response.body.include?('this is my readme')
+  end
+
+  ##
+  # test listing invisibles
+
+  def test_should_list_invisibles
+    get '/should_list_invisibles'
+    assert (last_response.body.include?('/should_list_invisibles/.') and 
+      last_response.body.include?('/should_list_invisibles/..'))
+  end
+
+  ##
+  # test sorting
+
+  def files_array(body)
+    files = Array.new
+    body.each_line do |line|
+      files << $& if /(\d)k.dat/.match(line)
+    end
+    files
+  end
+
+  def test_sorting_name_ascending
+    get '/sorting?sortby=file&direction=ascending'
+    files = files_array(last_response.body)
+    assert_equal ["1k.dat", "2k.dat", "3k.dat"], files
+  end
+
+  def test_sorting_name_descending
+    get '/sorting?sortby=file&direction=descending'
+    files = files_array(last_response.body)
+    assert_equal ["3k.dat", "2k.dat", "1k.dat"], files
+  end
+  
+  def test_sorting_mtime_ascending
+    get '/sorting?sortby=mtime&direction=ascending'
+    files = files_array(last_response.body)
+    assert_equal ["2k.dat", "3k.dat", "1k.dat"], files
+  end
+
+  def test_sorting_mtime_descending
+    get '/sorting?sortby=mtime&direction=descending'
+    files = files_array(last_response.body)
+    assert_equal ["1k.dat", "3k.dat", "2k.dat"], files
+  end
+
+  def test_sorting_size_ascending
+    get '/sorting?sortby=size&direction=ascending'
+    files = files_array(last_response.body)
+    assert_equal ["1k.dat", "2k.dat", "3k.dat"], files
+  end
+
+  def test_sorting_size_descending
+    get '/sorting?sortby=size&direction=descending'
+    files = files_array(last_response.body)
+    assert_equal ["3k.dat", "2k.dat", "1k.dat"], files
+  end
+end

data/test/test_directory_listing_app.rb

@@ -0,0 +1,37 @@
+require 'sinatra'
+
+require_relative '../lib/sinatra/directory_listing.rb'
+
+get '/stylesheets' do 
+  list({
+    :stylesheet => "/stylesheets/styles.css"
+  })
+end
+
+get '/readme' do 
+  list({
+    :readme => "this is my readme"
+  })
+end
+
+get '/should_list_invisibles' do 
+  list({
+    :should_list_invisibles => true
+  })
+end
+
+get '*' do |path|
+  if File.exist?(File.join(settings.public_folder, path))
+    if File.directory?(File.join(settings.public_folder, path))
+      list()
+    else
+      send_file File.join(settings.public_folder, path)
+    end 
+  else
+    not_found
+  end 
+end
+
+not_found do
+  'Try again.'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: directory_listing
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-04 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: filesize
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -60,21 +76,37 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.6.2
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7
 description: A Sinatra extension for generating easy, CSS-styled, Apache-like directory
   listings.
 email: rick.myers@me.com
@@ -83,6 +115,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -91,6 +125,15 @@ files:
 - lib/sinatra/directory_listing/layout.rb
 - lib/sinatra/directory_listing/resource.rb
 - lib/sinatra/directory_listing/version.rb
+- test/public/1234.txt
+- test/public/readme/test.txt
+- test/public/should_list_invisibles/test.txt
+- test/public/sorting/1k.dat
+- test/public/sorting/2k.dat
+- test/public/sorting/3k.dat
+- test/public/stylesheets/styles.css
+- test/test_directory_listing.rb
+- test/test_directory_listing_app.rb
 homepage: https://rubygems.org/gems/directory_listing
 licenses:
 - WTFPL
@@ -112,8 +155,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Easy, CSS-styled, Apache-like directory listings for Sinatra.
-test_files: []
+test_files:
+- test/public/1234.txt
+- test/public/readme/test.txt
+- test/public/should_list_invisibles/test.txt
+- test/public/sorting/1k.dat
+- test/public/sorting/2k.dat
+- test/public/sorting/3k.dat
+- test/public/stylesheets/styles.css
+- test/test_directory_listing.rb
+- test/test_directory_listing_app.rb
+has_rdoc: