RubyGems - directory_listing - Versions diffs - 0.2.2 → 0.3.0 - Mend

directory_listing 0.2.2 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (11) hide show

data/.gitignore +4 -0
data/LICENSE +13 -0
data/README.md +89 -0
data/Rakefile +1 -0
data/directory_listing.gemspec +22 -0
data/lib/sinatra/directory_listing/layout.rb +32 -0
data/lib/sinatra/directory_listing/resource.rb +140 -0
data/lib/sinatra/directory_listing/version.rb +3 -0
data/lib/sinatra/directory_listing.rb +112 -126
metadata +87 -58
checksums.yaml +0 -7

data/.gitignore ADDED Viewed

@@ -0,0 +1,4 @@
+.DS_Store
+pkg/*
+test_app.rb
+public/*

data/LICENSE ADDED Viewed

@@ -0,0 +1,13 @@
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                   Version 2, December 2004
+Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+ 0. You just DO WHAT THE FUCK YOU WANT TO.

data/README.md ADDED Viewed

@@ -0,0 +1,89 @@
+### directory_listing: easy, CSS-styled, Apache-like directory listings for Sinatra.
+### Build from source:
+```bash
+gem build directory_listing.gemspec
+sudo gem install ./directory_listing-x.x.x.gem
+```
+### 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:
+```ruby
+require 'sinatra'
+require 'sinatra/directory_listing'
+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
+```
+### Options:
+Options are passed in a hash:
+```ruby
+list({
+  :stylesheet => "stylesheets/styles.css",
+  :readme => "<a>Welcome!</a>"
+})
+```
+Available options:
+- ```stylesheet``` - a stylesheet that will be added to the <head> of the generated directory listing
+- ```readme``` - an HTML string that will be appended at the footer of the generated directory listing
+- ```should_list_invisibles``` - whether the directory listing should include invisibles (dotfiles) - true or false, defaults to false
+- ```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:
+It's pretty easy to figure out how to style ```directory_listing``` by looking at the source, but here are some gotchas:
+- Every item listed is a ```<td>``` element in a table. Directories will have a class of ```dir``` and regular files will have a class of ```file```.
+- You can style the "File" column with this CSS:
+```css
+table tr > td:first-child {
+  text-align: left;
+}
+```
+- "Last modified" column:
+```css
+table tr > td:first-child + td {
+  text-align: left;
+}
+```
+- "Size" column:
+```css
+table tr > td:first-child + td + td {
+  text-align: left;
+}
+```
+### 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

data/Rakefile ADDED Viewed

	@@ -0,0 +1 @@
1	+ require "bundler/gem_tasks"

data/directory_listing.gemspec ADDED Viewed

@@ -0,0 +1,22 @@
+require File.join(Dir.pwd, 'lib/sinatra/directory_listing.rb')
+require File.join(Dir.pwd, 'lib/sinatra/directory_listing/version.rb')
+Gem::Specification.new do |s|
+  s.name        = 'directory_listing'
+  s.version     = Directory_listing::VERSION
+  s.date        = Time.now.strftime("%Y-%m-%d")
+  s.summary     = "Easy, CSS-styled, Apache-like directory listings for Sinatra."
+  s.description = "A Sinatra extension for generating easy, CSS-styled, Apache-like directory listings."
+  s.authors     = ["Richard Myers"]
+  s.email       = 'rick.myers@me.com'
+  s.license     = 'WTFPL'
+  s.files       = `git ls-files`.split($/)
+  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"
+end

data/lib/sinatra/directory_listing/layout.rb ADDED Viewed

@@ -0,0 +1,32 @@
+module Sinatra
+  module Directory_listing
+    LAYOUT = <<-EOF
+<html>
+<head>
+  <title>Index of <%= $current_page %>, sorted <%= $sort_item_display %> <%= $sort_direction_display %></title>
+  <meta http-equiv='Content-Type' content='text/html; charset=UTF-8'>
+  <%= $stylesheet %>
+</head>
+<body>
+  <h1>Index of <%= $current_page %></h1>
+  <%= $back_to_link %>
+  <br><br>
+  <table>
+    <tr>
+      <th><a href='<%= $file_sort_link %>'>File</a></th>
+      <th><a href='<%= $mtime_sort_link %>'>Last modified</a></th>
+      <th><a href='<%= $size_sort_link %>'>Size</a></th>
+    </tr>
+    <%= $files_html %>
+  </table>
+  <br>
+  <a><%= $readme if $readme %></a>
+</body>
+</html>
+    EOF
+  end
+end

data/lib/sinatra/directory_listing/resource.rb ADDED Viewed

@@ -0,0 +1,140 @@
+class Resource
+  ##
+  # Class definition for a single resource to be listed.
+  # Each resource object has accessors for its file name, regular name,
+  # size and mtime, as well as those components wrapped in html.
+  attr_accessor :file, :name_html, :mtime, :mtime_html, :size, :size_html
+  def initialize(file)
+    @file = file
+    @name_html = set_name(file)
+    @mtime, @mtime_html = set_mtime(file)
+    @size, @size_html = set_size(file)
+  end
+  ##
+  # Get the mtime for a file.
+  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.
+  def set_size(file)
+    html = ""
+    size = ''
+    f = File.join(File.join($public_folder, URI.unescape($request_path)), file)
+    if File.directory?(f)
+      size = 0
+      html = "\t<td>-</td>"
+    else
+      size = File.stat(f).size
+      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.
+  def set_name(file)
+    ##
+    # Make sure we're working with an unescaped file name and truncate it.
+    # URI.unescape seems to work best to decode uris.
+    file = URI.unescape(file)
+    file_truncated = file.truncate($filename_truncate_length, '...')
+    ##
+    # If the requested resource is in the root public directory, the link is
+    # just the resource itself without the public directory path as well.
+    requested = Pathname.new(URI.unescape($request_path)).cleanpath
+    pub_folder = Pathname.new($public_folder).cleanpath
+    if requested.eql?(pub_folder)
+      link = file
+    else
+      link = File.join($request_path, file)
+    end
+    ##
+    # Add a class of "dir" to directories and "file" to files.
+    html = ""
+    if File.directory?(File.join($public_folder, link))
+      html << "\t<td class='dir'>"
+      ##
+      # Append the sorting information if the current directory is sorted
+      if $request_params["sortby"] && $request_params["direction"]
+        link << "?sortby=" + $request_params["sortby"] + "&direction=" + $request_params["direction"]
+      end
+    else
+      html << "\t<td class='file'>"
+    end
+    ##
+    # Append the rest of the html.
+    #
+    # I haven't found a URI escaping library that will handle this
+    # gracefully, so for now, we're going to just take care of spaces and
+    # apostrophes ourselves.
+    link = link.gsub(" ", "%20").gsub("'", "%27")
+    html << "<a href='#{link}'>#{file_truncated}</a></td>"
+    return html
+  end
+  ##
+  # Generate html for a resource.
+  def wrap
+    html = ""
+    if $should_list_invisibles == true
+      html << "\n\t<tr>
+      #{@name_html}
+      #{@mtime_html}
+      #{@size_html}
+      \t</tr>"
+    else
+      if @file[0] != "."
+        html << "\n\t<tr>
+        #{@name_html}
+        #{@mtime_html}
+        #{@size_html}
+        \t</tr>"
+      end
+    end
+    html
+  end
+  ##
+  # Sort an array of resources by name, mtime, or size.
+  # Direction should be "ascending" or "descending"
+  def self.sort(resource_array, sortby, direction)
+    new_array = resource_array.sort_by {|a| a.send(sortby)}
+    new_array.reverse! if direction == "descending"
+    new_array
+  end
+end

data/lib/sinatra/directory_listing/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Directory_listing
+  VERSION = '0.3.0'
+end

data/lib/sinatra/directory_listing.rb CHANGED Viewed

@@ -90,130 +90,18 @@ require 'erb'
 module Sinatra
   module Directory_listing
-    VERSION = '0.2.2'
-    ##
-    # erb template for page
-    def template
-      "<html>
-      <head>
-        <title>Index of <%= $current_page %></title>
-        <meta http-equiv='Content-Type' content='text/html; charset=UTF-8'>
-        <%= $stylesheet %>
-      </head>
-      <body>
-        <h1>Index of <%= $current_page %></h1>
-        <%= $back_to_link %>
-        <br><br>
-        <table>
-          <tr>
-            <th>File</th>
-            <th>Last modified</th>
-            <th>Size</th>
-          </tr>
-          <%= $files_html %>
-        </table>
-        <br>
-        <a><%= $readme if $readme %></a>
-      </body>
-      </html>"
-    end
-    ##
-    # Get the mtime for a file.
-    def m_time(file)
-      f = File.join(File.join(settings.public_folder, URI.unescape(request.fullpath)), file)
-      "\t<td>#{File.mtime(f).strftime($last_modified_format)}</td>"
-    end
-    ##
-    # Get the size for a file.
-    def size(file)
-      f = File.join(File.join(settings.public_folder, URI.unescape(request.fullpath)), file)
-      if File.directory?(f)
-        "\t<td>-</td>"
-      else
-        size = Filesize.from("#{File.stat(f).size} B").pretty
-        "\t<td>#{size}</td>"
-      end
-    end
+    require_relative 'directory_listing/version.rb'
+    require_relative 'directory_listing/layout.rb'
+    require_relative 'directory_listing/resource.rb'
     ##
-    # Get the name of the file and its link.
-    def name(file)
-      ##
-      # Make sure we're working with an unescaped file name and truncate it.
-      # URI.unescape seems to work best to decode uris.
-      file = URI.unescape(file)
-      file_truncated = file.truncate($filename_truncate_length, '...')
-      ##
-      # If the requested resource is in the root public directory, the link is
-      # just the resource itself without the public directory path as well.
-      requested = Pathname.new(URI.unescape(request.path)).cleanpath
-      public_folder = Pathname.new(settings.public_folder).cleanpath
-      if requested.eql?(public_folder)
-        link = file
-      else
-        link = File.join(request.fullpath, file)
-      end
-      ##
-      # Add a class of "dir" to directories and "file" to files.
+    # Generate the page.
-      html = ""
-      if File.directory?(File.join(settings.public_folder, link))
-        html << "\t<td class='dir'>"
-      else
-        html << "\t<td class='file'>"
-      end
+    def list(o={})
       ##
-      # Append the rest of the html.
-      #
-      # I haven't found a URI escaping library that will handle this
-      # gracefully, so for now, we're going to just take care of spaces and
-      # apostrophes ourselves.
+      # Set default options.
-      link = link.gsub(" ", "%20").gsub("'", "%27")
-      html << "<a href='#{link}'>#{file_truncated}</a></td>"
-      html
-    end
-    ##
-    # Generate a single row of data for a file.
-    def wrap(file)
-      html = ""
-      if $should_list_invisibles == true
-        html << "\n\t<tr>
-        #{self.name(file)}
-        #{self.m_time(file)}
-        #{self.size(file)}\n\t</tr>"
-      else
-        if file[0] != "."
-          html << "\n\t<tr>
-          #{self.name(file)}
-          #{self.m_time(file)}
-          #{self.size(file)}\n\t</tr>"
-        end
-      end
-      html
-    end
-    ##
-    # Generate the page.
-    def list(o={})
       options = {
         :should_list_invisibles => false,
         :last_modified_format => "%Y-%m-%d %H:%M:%S",
@@ -226,22 +114,49 @@ module Sinatra
       $last_modified_format = options[:last_modified_format]
       $filename_truncate_length = options[:filename_truncate_length]
+      ##
+      # Get the public folder, request path, and parameters and
+      # store in globals to be used by the Resource class.
+      $public_folder = settings.public_folder
+      $request_path = request.path
+      $request_params = request.params
       ##
       # Start generating strings to be injected into the erb template
       $current_page = URI.unescape(request.path)
       $readme = options[:readme] if options[:readme]
-      $stylesheet = "<link rel='stylesheet' type='text/css' href='/#{options[:stylesheet].sub(/^[\/]*/,"")}'>" if options[:stylesheet]
+      if options[:stylesheet]
+        $stylesheet = "<link rel='stylesheet' type='text/css' href='/#{options[:stylesheet].sub(/^[\/]*/,"")}'>"
+      end
+      ##
+      # Generate the "back to" link
+      # Append the sorting information if the current directory is sorted.
       if URI.unescape(request.path) != "/"
-        $back_to_link = "<a href='#{Pathname.new(URI.unescape(request.path)).parent}'>&larr; Parent directory</a>"
+        back_link = Pathname.new(URI.unescape(request.path)).parent
+        if $request_params["sortby"] && $request_params["direction"]
+          back_link = back_link.to_s + "?sortby=" + $request_params["sortby"] + "&direction=" + $request_params["direction"]
+        end
+        $back_to_link = "<a href='#{back_link}'>&larr; Parent directory</a>"
       else
         $back_to_link = "<a>Root directory</a>"
       end
-      $files_html = ""
+      ##
+      # Get an array of files to be listed.
       files = Array.new
-      Dir.foreach(File.join(settings.public_folder, URI.unescape(request.path)), &files.method(:push))
+      Dir.foreach(File.join(settings.public_folder, URI.unescape(request.path))) do |file|
+        files.push(file)
+      end
+      ##
+      # If the only thing in the array are invisible files, display a "No files" listing.
+      $files_html = ""
       if files == [".", ".."]
         $files_html << "
           <tr>
@@ -250,15 +165,86 @@ module Sinatra
             <th>-</th>
           </tr>"
       else
-        files.sort.each do |file|
-          $files_html << self.wrap(file)
+        ##
+        # Otherwise, create an array of Resources:
+        resources = Array.new
+        Dir.foreach(File.join(settings.public_folder, URI.unescape(request.path))) do |resource|
+          resources.push(Resource.new(resource))
+        end
+        ##
+        # Get the sortby and direction parameters ("file" and "ascending", by
+        # default).
+        $sort_item = "file"
+        $sort_direction = "ascending"
+        $sort_item = $request_params["sortby"] if $request_params["sortby"]
+        $sort_direction = $request_params["direction"] if $request_params["direction"]
+        ##
+        # Sort the resources.
+        # The second and third arguments are what to sort by ("file", "mtime",
+        # or "size"), and whether to sort in order ("ascending") or reverse
+        # ("descending").
+        sorted_resources = Resource.sort(resources, $sort_item, $sort_direction)
+        ##
+        # Set display variables and sort links based on sorting variables
+        file_link_dir = mtime_link_dir = sortby_link_dir = "ascending"
+        case $sort_item
+        when "file"
+          $sort_item_display = "alphabetically"
+          case $sort_direction
+          when "ascending"
+            $sort_direction_display = ""
+            file_link_dir = "descending"
+          when "descending"
+            $sort_direction_display = "reversed"
+            file_link_dir = "ascending"
+          end
+        when "mtime"
+          $sort_item_display = "by modification date"
+          case $sort_direction
+          when "ascending"
+            $sort_direction_display = "oldest to newest"
+            mtime_link_dir = "descending"
+          when "descending"
+            $sort_direction_display = "newest to oldest"
+            mtime_link_dir = "ascending"
+          end
+        when "size"
+          $sort_item_display = "by size"
+          case $sort_direction
+          when "ascending"
+            $sort_direction_display = "smallest to largest"
+            sortby_link_dir = "descending"
+          when "descending"
+            $sort_direction_display = "largest to smallest"
+            sortby_link_dir = "ascending"
+          end
+        end
+        $file_sort_link = "?sortby=file&direction=#{file_link_dir}"
+        $mtime_sort_link = "?sortby=mtime&direction=#{mtime_link_dir}"
+        $size_sort_link = "?sortby=size&direction=#{sortby_link_dir}"
+        ##
+        # Finally, generate the html from the array of Resources.
+        sorted_resources.each do |resource|
+          $files_html << resource.wrap
         end
       end
       ##
       # Generate and return the complete page from the erb template.
-      erb = ERB.new(template)
+      erb = ERB.new(LAYOUT)
       erb.result
     end

metadata CHANGED Viewed

@@ -1,90 +1,119 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification
 name: directory_listing
-version: !ruby/object:Gem::Version
-  version: 0.2.2
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+  prerelease:
 platform: ruby
-authors:
+authors:
 - Richard Myers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2013-08-23 00:00:00 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+date: 2013-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: filesize
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.0.2
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency
-  name: truncate
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+- !ruby/object:Gem::Dependency
+  name: truncate
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 0.0.4
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency
-  name: bundler
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement
-    requirements:
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version
-        version: "1.3"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency
-  name: rake
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement
-    requirements:
-    - &id005
-      - ">="
-      - !ruby/object:Gem::Version
-        version: "0"
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-description: A Sinatra extension for generating easy, CSS-styled, Apache-like directory listings.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Sinatra extension for generating easy, CSS-styled, Apache-like directory
+  listings.
 email: rick.myers@me.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files:
+files:
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- directory_listing.gemspec
 - lib/sinatra/directory_listing.rb
+- lib/sinatra/directory_listing/layout.rb
+- lib/sinatra/directory_listing/resource.rb
+- lib/sinatra/directory_listing/version.rb
 homepage: https://rubygems.org/gems/directory_listing
-licenses:
+licenses:
 - WTFPL
-metadata: {}
 post_install_message:
 rdoc_options: []
-require_paths:
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - *id005
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - *id005
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.0.7
+rubygems_version: 1.8.24
 signing_key:
-specification_version: 4
+specification_version: 3
 summary: Easy, CSS-styled, Apache-like directory listings for Sinatra.
 test_files: []
-has_rdoc:

checksums.yaml DELETED Viewed

@@ -1,7 +0,0 @@
----
-SHA1:
-  metadata.gz: fc6e8b90276b6880d8cc5eefca368b999056d6d7
-  data.tar.gz: 27e126e7c527ac9e756dc9b2d620b3614ebf9880
-SHA512:
-  metadata.gz: d2232198ba1bd9c8f62d2af86c23b2581e6bbaffc448fd9c8fd98805601cad2b536e3db4c82c7f7143d3c177e03a43d84cffa9cfecdcef4880b672a7f952a962
-  data.tar.gz: 62cbfe05a591976fe342694fd9664de8efa2f8bf16a8d872dd05fba2f42fe4fef060ead3234b690b0bf84529c1b122ae8669ff784a5ae8fbb0bf5f9bebf82012