directory_listing 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9692a7377e281b36851d6caf01896f1980307217
-  data.tar.gz: abd645f08b3adf7bbd2d22c24cebec1650166388
+  metadata.gz: 241d7e83370def28838e157f7a2f2649b7b8148d
+  data.tar.gz: f856b6f389aff56ec50e61544116f1fb2913765a
 SHA512:
-  metadata.gz: 6154b4696475e4a01c0e6c12e9901b3e2d46b784c9aa167f9b7c82358c14788909d05f473de298862ad6a6ff96d3f0816228d2eb2c20332129d5d2c5c21cfdf8
-  data.tar.gz: 61e7353073d51b3a2ddfe36a195f190324344f1e5e8e4eaa27df44648fde8051064a20933613946f174a28f1c40b47e399fd86f8c1c6c2510c37fe1ccdc3ef12
+  metadata.gz: 18d7c48f75f5d69d93d977ae1825c03546a2a9a0b6a47877021609f17bdac30b4e8dbb95a1f1b22ddd967692c7ddc427269e3e590681ecd4b3c924b21b5304f0
+  data.tar.gz: 174a66908985f434a410344315a5cb57bb225c9d428227456608f7b56e0dc48a9ab1be660875fe5cb3dee90075476de4eae8e1fe5d53a837cefd568f21c5d1b7

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    directory_listing (0.6.0)
+    directory_listing (0.6.2)
       filesize (>= 0.0.2)
-      sinatra
+      sinatra (>= 1.4.5)
       truncate (>= 0.0.4)
 
 GEM
@@ -16,13 +16,14 @@ GEM
     rack-test (0.6.2)
       rack (>= 1.0)
     rake (10.1.0)
+    shotgun (0.9)
+      rack (>= 1.0)
     sinatra (1.4.5)
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
     tilt (1.4.1)
     truncate (0.1.0)
-    yard (0.8.7)
 
 PLATFORMS
   ruby
@@ -31,5 +32,5 @@ DEPENDENCIES
   bundler (~> 1.3)
   directory_listing!
   rack-test (~> 0.6.2)
-  rake
-  yard (~> 0.8.7)
+  rake (~> 10.1.0)
+  shotgun (~> 0.9)

data/README.md

@@ -6,7 +6,8 @@
 
 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
+3. Embeddable 
+4. 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.
 
@@ -64,6 +65,7 @@ list({
 Available options:
 
 - ```stylesheet``` - a stylesheet to style the generated directory listing with, relative to your ```public_folder```
+- ```embed_in``` - an ```erb``` template in which to embed the directory listing, relative to your ```public_folder``` [(see below)](#embedding).
 - ```readme``` - an HTML string that will be appended at the footer of the generated directory listing
 - ```favicon``` - URL to a favicon
 - ```should_list_invisibles``` - whether the directory listing should include invisibles (dotfiles) - true or false, defaults to false
@@ -72,6 +74,39 @@ 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``` - length to truncate file names to - integer, defaults to 40
 
+### Embedding
+
+By default, ```directory_listing``` will generate a complete HTML page. However, you can use the ```embed_in``` option to pass in your own ```erb``` template. 
+You should look at the [default template](lib/sinatra/directory_listing/layout.rb) to get an idea of the layout, but you should include the following:
+
+- ```<%= page.current_page %>``` - the name of the current page
+- ```<%= page.sort_item_display %>``` - how the page is currently sorted
+- ```<%= page.sort_direction_display %>``` - the direction the items are sorted in 
+- ```<%= page.favicon %>``` - the favicon
+- ```<%= page.stylesheet %>``` - the stylesheet
+- ```<%= page.nav_bar %>``` - the page's navigation bar
+- ```<%= page.file_sort_link %>``` - link to sort by filename
+- ```<%= page.mtime_sort_link %>``` - link to sort by mtime
+- ```<%= page.size_sort_link %>``` - link to sort by size
+- ```<%= page.files_html %>``` - the file listing
+- ```<%= page.readme %>``` - the readme
+
+If you want to embed the default file listing (but are passing a custom template to modify other attributes), you can use the following table:
+
+```html
+<table>
+  <tr>
+    <th><a href='<%= page.file_sort_link %>'>File</a></th>
+    <th><a href='<%= page.mtime_sort_link %>'>Last modified</a></th>
+    <th><a href='<%= page.size_sort_link %>'>Size</a></th>
+  </tr>
+  <%= page.files_html %>
+</table>
+<hr><hr>
+```
+
+NOTE: You should not put your ```erb``` template in a method as the gem does - you should be passing an actual ```.erb``` file to the ```embed_in``` option.
+
 ### Styling
 
 It's pretty easy to figure out how to style ```directory_listing``` by looking at the source, but here are some gotchas:

data/Rakefile

@@ -1,25 +1,12 @@
 require "bundler/gem_tasks"
 require 'rake/testtask'
-require 'yard'
-
-##
-# Run the test application
 
 desc "Run the test application on port 4567"
 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']
+  `shotgun test/test_directory_listing_app.rb -o 0.0.0.0`
 end
 
-##
-# Run tests
-
+desc "Run tests"
 Rake::TestTask.new do |t|
   t.libs << 'test'
 end
@@ -27,4 +14,4 @@ end
 ##
 # Default -> run tests
 
-task :default => 'test'
+task :default => [:test]

data/directory_listing.gemspec

@@ -14,12 +14,12 @@ Gem::Specification.new do |s|
   s.test_files  = s.files.grep(%r{^(test|spec|features)/})
   s.homepage    = 'https://rubygems.org/gems/directory_listing'
   
-  s.add_dependency 'sinatra'
+  s.add_dependency 'sinatra', '>=1.4.5'
   s.add_dependency 'filesize', '>=0.0.2'
   s.add_dependency 'truncate', '>=0.0.4'
   
-  s.add_development_dependency "rake"
+  s.add_development_dependency "rake", "~> 10.1.0"
   s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "shotgun", "~> 0.9"
   s.add_development_dependency "rack-test", "~> 0.6.2"
-  s.add_development_dependency "yard", "~> 0.8.7"
 end

data/lib/sinatra/directory_listing.rb

@@ -28,6 +28,7 @@ module Sinatra
         :last_modified_format => "%Y-%m-%d %H:%M:%S",
         :filename_truncate_length => 40,
         :stylesheet => "",
+        :embed_in => "",
         :favicon => "",
         :readme => ""
       }.merge(o)
@@ -40,17 +41,20 @@ module Sinatra
       page.should_show_file_exts = options[:should_show_file_exts]
       page.smart_sort = options[:smart_sort]
       page.last_modified_format = options[:last_modified_format]
-      page.filename_truncate_length = options[:filename_truncate_length]      
+      page.filename_truncate_length = options[:filename_truncate_length]
       page.public_folder = settings.public_folder
       page.request_path = request.path
       page.request_params = request.params
       page.current_page = URI.unescape(request.path)
       
       ##
-      # Set the readme, stylesheet, and favicon
-      
+      # Set the erb template to embed in, the readme, stylesheet, and favicon
+     
       page.readme = options[:readme] if options[:readme]
       page.favicon = options[:favicon] if options[:favicon]
+      if options[:embed_in]
+        page.embed_in = options[:embed_in]
+      end
       if options[:stylesheet]
         page.stylesheet = "<link rel='stylesheet' type='text/css' href='/#{options[:stylesheet].sub(/^[\/]*/,"")}'>"
       end
@@ -123,7 +127,16 @@ module Sinatra
       ##
       # Generate and return the complete page from the erb template.  
       
-      erb = ERB.new(LAYOUT)
+      if !page.embed_in.empty?
+        path = File.join(settings.public_folder, page.embed_in)
+        if File.exists?(path)
+          erb = ERB.new(IO.read(path))
+        else
+          erb = ERB.new(LAYOUT)
+        end
+      else
+        erb = ERB.new(LAYOUT)
+      end
       erb.result(binding)
     end
       

data/lib/sinatra/directory_listing/page.rb

@@ -11,6 +11,7 @@ class Page
                 :stylesheet,
                 :favicon,
                 :readme,
+                :embed_in,
                 :public_folder,
                 :request_path,
                 :request_params,

data/lib/sinatra/directory_listing/version.rb

@@ -1,3 +1,3 @@
 module Directory_listing
-  VERSION = '0.6.2'
+  VERSION = '0.6.3'
 end

data/test/public/embed_in/layout.erb

@@ -0,0 +1,29 @@
+<html>
+<head>
+  <title>using custom erb template</title>
+  <%= page.stylesheet %>
+</head>
+<body>
+
+  <b><a><%= page.nav_bar %></a></b>
+  <br><br>
+  
+  <a>page.sort_item_display: <%= page.sort_item_display %></a><br>
+  <a>page.sort_direction_display: <%= page.sort_direction_display %></a><br>
+  <br><br>
+
+  <hr>
+  <table>
+    <tr>
+      <th><a href='<%= page.file_sort_link %>'>File</a></th>
+      <th><a href='<%= page.mtime_sort_link %>'>Last modified</a></th>
+      <th><a href='<%= page.size_sort_link %>'>Size</a></th>
+    </tr>
+    <%= page.files_html %>
+  </table>
+  <hr>
+  <br><br>
+
+  <a>here's a readme: <%= page.readme %></a>
+</body>
+</html>

data/test/test_directory_listing.rb

@@ -1,11 +1,10 @@
 ENV['RACK_ENV'] = 'test'
-
-require_relative 'test_directory_listing_app'
-
-require 'test/unit'
+require 'minitest/autorun'
 require 'rack/test'
 
-class DirectoryListingTest < Test::Unit::TestCase
+require File.expand_path '../test_directory_listing_app.rb', __FILE__
+
+class DirectoryListingTest < MiniTest::Unit::TestCase 
   include Rack::Test::Methods
 
   def app
@@ -43,6 +42,14 @@ class DirectoryListingTest < Test::Unit::TestCase
     get '/stylesheets'
     assert last_response.body.include?('/stylesheets/styles.css')
   end
+  
+  ##
+  # test embedding a custom erb template
+
+  def embed_in
+    get '/embed_in'
+    assert last_response.body.include?('using custom erb template')
+  end
 
   ##
   # test defining a readme

data/test/test_directory_listing_app.rb

@@ -14,6 +14,13 @@ get '/readme' do
   })
 end
 
+get '/embed_in' do 
+  list({
+    :embed_in => "/embed_in/layout.erb",
+    :readme => "this is my readme"
+  })
+end
+
 get '/favicon' do 
   list({
     :favicon => "/favicon/favicon.ico"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: directory_listing
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Richard Myers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-03 00:00:00.000000000 Z
+date: 2015-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.5
 - !ruby/object:Gem::Dependency
   name: filesize
   requirement: !ruby/object:Gem::Requirement
@@ -56,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 10.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -81,33 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: shotgun
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: '0.9'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.7
+        version: 0.6.2
 description: A Sinatra extension for generating easy, CSS-styled, Apache-like directory
   listings.
 email: rick.myers@me.com
@@ -128,6 +128,7 @@ files:
 - lib/sinatra/directory_listing/resource.rb
 - lib/sinatra/directory_listing/version.rb
 - test/public/1234.txt
+- test/public/embed_in/layout.erb
 - test/public/favicon/favicon.ico
 - test/public/level1/level2/level3/level 4/test
 - test/public/level1/level2/level3/test
@@ -168,6 +169,7 @@ specification_version: 4
 summary: Easy, CSS-styled, Apache-like directory listings for Sinatra.
 test_files:
 - test/public/1234.txt
+- test/public/embed_in/layout.erb
 - test/public/favicon/favicon.ico
 - test/public/level1/level2/level3/level 4/test
 - test/public/level1/level2/level3/test