servel 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cdd4343b043f0e31a6f28099e1f2b30853361e57
-  data.tar.gz: a530e4b6f5430f339b0599c8186d9da21d9d918b
+  metadata.gz: 117d9e0db92881231808a7525938dff72a12e3a3
+  data.tar.gz: 75a69275c182a29ec34edcb53f75b95dea805fa6
 SHA512:
-  metadata.gz: 20bf86b2fd1a0189296a42797514f31720e386742c8123edd7006f82fd86c86406cd948f72bdb4946a3ac6a98cde365846a6d16561526124d301a4793cd0f6b0
-  data.tar.gz: 94b29d8b4d557bc28a0b5ab1762678474196ba72c6a4b9979b1fa2198bd235e5362a0159b2b93a22d2c29712f82488ed55abb3253284037e3d4852efa28c3a90
+  metadata.gz: 224b28d1b3254a7adcfdaa517daf5c1c18511b06fafe1d43b7c6987fb4672d8d330d7dd3cbfd907cc1d1377bb7e0247b6f068db946791d80f76670f53c784cbb
+  data.tar.gz: 3250aee872e9305c7fe415b3bbaa34954da1e062ff7fc2401294846b2e082c957fb0e7b3cad8248c3dc8370b49cfb9d66f808c56186a1b51a378f8888882e441

data/.gitignore

@@ -1,9 +1,9 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
 /Gemfile.lock

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in servel.gemspec
-gemspec
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in servel.gemspec
+gemspec

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2017 Brenton "B-Train" Fletcher
-
-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.
+The MIT License (MIT)
+
+Copyright (c) 2017 Brenton "B-Train" Fletcher
+
+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.md

@@ -1,39 +1,39 @@
-# Servel
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/servel`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'servel'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install servel
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/servel.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# Servel
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/servel`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'servel'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install servel
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/servel.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "servel"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "servel"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +1,8 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/servel/app.rb

@@ -1,20 +1,27 @@
 class Servel::App
+  UTF_8 = Encoding::UTF_8
+  SCRIPT_NAME = Rack::SCRIPT_NAME
+  PATH_INFO = Rack::PATH_INFO
+
   def initialize(root)
     @root = Pathname.new(root)
     @file_server = Rack::File.new(root.to_s)
   end
 
   def call(env)
-    url_root = env["SCRIPT_NAME"]
-    url_path = clean_url_path(env["PATH_INFO"])
+    env[SCRIPT_NAME] = try_encode(env[SCRIPT_NAME])
+    env[PATH_INFO] = try_encode(env[PATH_INFO])
+
+    url_root = env[SCRIPT_NAME]
+    url_path = clean_url_path(env[PATH_INFO])
 
-    return redirect("#{url_root}/") if env["PATH_INFO"] == ""
+    return redirect("#{url_root}/") if env[PATH_INFO] == ""
 
     fs_path = @root + url_path[1..-1]
 
     return @file_server.call(env) if fs_path.file?
 
-    return redirect("#{url_root}#{url_path}/") unless env["PATH_INFO"].end_with?("/")
+    return redirect("#{url_root}#{url_path}/") unless env[PATH_INFO].end_with?("/")
 
     return [404, {}, []] unless fs_path.exist?
 
@@ -23,7 +30,7 @@ class Servel::App
   end
 
   def redirect(location)
-    [302, { "Location" => location }, []]
+    [302, { "Location" => Rack::Utils.escape_path(location) }, []]
   end
 
   def clean_url_path(path)
@@ -31,4 +38,11 @@ class Servel::App
     raise unless Rack::Utils.valid_path?(url_path)
     Rack::Utils.clean_path_info(url_path)
   end
+
+  def try_encode(string)
+    return string if string.encoding == UTF_8
+    string.encode(UTF_8)
+  rescue Encoding::UndefinedConversionError, Encoding::InvalidByteSequenceError
+    string
+  end
 end

data/lib/servel/cli.rb

@@ -1,18 +1,18 @@
-class Servel::CLI
-  def initialize(argv)
-    @argv = argv
-  end
-
-  def start
-    Rack::Handler::Puma.run(Servel.build_app(path_map))
-  end
-
-  def path_map
-    @argv.map do |arg|
-      root, url_root = arg.split(":" , 2)
-      root = Pathname.new(root).realpath
-
-      [root, url_root || "/"]
-    end.to_h
-  end
+class Servel::CLI
+  def initialize(argv)
+    @argv = argv
+  end
+
+  def start
+    Rack::Handler::Puma.run(Servel.build_app(path_map))
+  end
+
+  def path_map
+    @argv.map do |arg|
+      root, url_root = arg.split(":" , 2)
+      root = Pathname.new(root).realpath
+
+      [root, url_root || "/"]
+    end.to_h
+  end
 end

data/lib/servel/entry.rb

@@ -1,27 +1,27 @@
-class Servel::Entry
-  attr_reader :ftype, :type, :media_type, :listing_classes, :icon, :href, :name, :size, :mtime
-
-  def initialize(ftype:, type:, media_type: nil, listing_classes:, icon:, href:, name:, size: nil, mtime: nil)
-    @ftype = ftype
-    @type = type
-    @media_type = media_type
-    @listing_classes = listing_classes
-    @icon = icon
-    @href = href
-    @name = name
-    @size = size
-    @mtime = mtime
-  end
-
-  def directory?
-    @ftype == :directory
-  end
-
-  def file?
-    @ftype == :file
-  end
-
-  def media?
-    !@media_type.nil?
-  end
+class Servel::Entry
+  attr_reader :ftype, :type, :media_type, :listing_classes, :icon, :href, :name, :size, :mtime
+
+  def initialize(ftype:, type:, media_type: nil, listing_classes:, icon:, href:, name:, size: nil, mtime: nil)
+    @ftype = ftype
+    @type = type
+    @media_type = media_type
+    @listing_classes = listing_classes
+    @icon = icon
+    @href = href
+    @name = name
+    @size = size
+    @mtime = mtime
+  end
+
+  def directory?
+    @ftype == :directory
+  end
+
+  def file?
+    @ftype == :file
+  end
+
+  def media?
+    !@media_type.nil?
+  end
 end

data/lib/servel/haml_context.rb

@@ -1,54 +1,54 @@
-class Servel::HamlContext
-  extend Servel::Instrumentation
-  include ActiveSupport::NumberHelper
-
-  LOCK = Mutex.new
-
-  def self.render(template, locals)
-    [200, {}, [new.render(template, locals)]]
-  end
-
-  def initialize
-    @build_path = Pathname.new(__FILE__).dirname.realpath + 'templates'
-  end
-
-  def render(template, locals = {})
-    haml_engine(template).render(self, locals)
-  end
-
-  def partial(name, locals = {})
-    render("_#{name}.haml", locals)
-  end
-
-  def include(path)
-    (@build_path + path).read
-  end
-
-  def sort_attrs(sort, current_method)
-    data = { sort_method: current_method, sort_direction: "asc" }
-    classes = ["sortable"]
-    if sort[:method] == current_method
-      data[:sort_active] = true
-      data[:sort_direction] = sort[:direction]
-      classes << "sort-active"
-      classes << "sort-#{sort[:direction]}"
-    end
-
-    {
-      data: data,
-      class: classes
-    }
-  end
-
-  def haml_engine(path)
-    LOCK.synchronize do
-      @@haml_engine_cache ||= {}
-      unless @@haml_engine_cache.key?(path)
-        @@haml_engine_cache[path] = Hamlit::Template.new(filename: path) { include(path) }
-      end
-      @@haml_engine_cache[path]
-    end
-  end
-
-  instrument :render, :partial, :include
+class Servel::HamlContext
+  extend Servel::Instrumentation
+  include ActiveSupport::NumberHelper
+
+  LOCK = Mutex.new
+
+  def self.render(template, locals)
+    [200, {}, [new.render(template, locals)]]
+  end
+
+  def initialize
+    @build_path = Pathname.new(__FILE__).dirname.realpath + 'templates'
+  end
+
+  def render(template, locals = {})
+    haml_engine(template).render(self, locals)
+  end
+
+  def partial(name, locals = {})
+    render("_#{name}.haml", locals)
+  end
+
+  def include(path)
+    (@build_path + path).read
+  end
+
+  def sort_attrs(sort, current_method)
+    data = { sort_method: current_method, sort_direction: "asc" }
+    classes = ["sortable"]
+    if sort[:method] == current_method
+      data[:sort_active] = true
+      data[:sort_direction] = sort[:direction]
+      classes << "sort-active"
+      classes << "sort-#{sort[:direction]}"
+    end
+
+    {
+      data: data,
+      class: classes
+    }
+  end
+
+  def haml_engine(path)
+    LOCK.synchronize do
+      @@haml_engine_cache ||= {}
+      unless @@haml_engine_cache.key?(path)
+        @@haml_engine_cache[path] = Hamlit::Template.new(filename: path) { include(path) }
+      end
+      @@haml_engine_cache[path]
+    end
+  end
+
+  instrument :render, :partial, :include
 end

data/lib/servel/instrumentation.rb

@@ -1,26 +1,26 @@
-module Servel::Instrumentation
-  def instrument(*method_names)
-    return unless ENV["DEBUG"] == "1"
-
-    Array(method_names).each do |method_name|
-      original_method_name = "#{method_name}_without_instrumentation"
-
-      alias_method original_method_name, method_name
-
-      cumulative_time_spent = 0
-
-      define_method(method_name) do |*args|
-        start = Time.now
-
-        return_value = __send__(original_method_name, *args)
-
-        finish = Time.now
-        time_spent = ((finish - start) * 1000.0)
-        cumulative_time_spent += time_spent
-        puts "Running #{self.class.name}<#{object_id}>##{method_name}: #{time_spent.round(3)}ms (cumulative: #{cumulative_time_spent.round(3)}ms)"
-
-        return_value
-      end
-    end
-  end
-end
+module Servel::Instrumentation
+  def instrument(*method_names)
+    return unless ENV["DEBUG"] == "1"
+
+    Array(method_names).each do |method_name|
+      original_method_name = "#{method_name}_without_instrumentation"
+
+      alias_method original_method_name, method_name
+
+      cumulative_time_spent = 0
+
+      define_method(method_name) do |*args|
+        start = Time.now
+
+        return_value = __send__(original_method_name, *args)
+
+        finish = Time.now
+        time_spent = ((finish - start) * 1000.0)
+        cumulative_time_spent += time_spent
+        puts "Running #{self.class.name}<#{object_id}>##{method_name}: #{time_spent.round(3)}ms (cumulative: #{cumulative_time_spent.round(3)}ms)"
+
+        return_value
+      end
+    end
+  end
+end

data/lib/servel/templates/_listing.haml

@@ -17,9 +17,9 @@
         %tr
           %td
             %span.icon= file.icon
-            %a.default{href: file.href, class: file.listing_classes, data: { type: file.media_type }}= file.name
+            %a.default{href: Rack::Utils.escape_path(file.href), class: file.listing_classes, data: { type: file.media_type }}= file.name
           %td
-            %a.new-tab{href: file.href, class: file.listing_classes, target: "_blank"} (New tab)
+            %a.new-tab{href: Rack::Utils.escape_path(file.href), class: file.listing_classes, target: "_blank"} (New tab)
           %td= file.type
           %td= file.size.nil? ? "-" : number_to_human_size(file.size)
           %td= file.mtime.nil? ? "-" : file.mtime.strftime("%e %b %Y %l:%M %p")

data/lib/servel/templates/js/listing.js

@@ -1,26 +1,26 @@
-function initListing() {
-  $ = document.querySelector.bind(document);
-
-  function applySort(sortable) {
-    var params = new URLSearchParams(location.search.slice(1));
-    params.set("_servel_sort_method", sortable.dataset.sortMethod);
-    params.set("_servel_sort_direction", sortable.dataset.sortDirection);
-
-    if('sortActive' in sortable.dataset) {
-      params.set("_servel_sort_direction", sortable.dataset.sortDirection == "asc" ? "desc" : "asc");
-    }
-
-    location.href = location.pathname + "?" + params.toString();
-  }
-
-  document.body.addEventListener("click", function(e) {
-    if(!e.target) return;
-
-    if(e.target.closest("th.sortable")) {
-      e.preventDefault();
-      applySort(e.target.closest("th.sortable"));
-    }
-  });
-}
-
+function initListing() {
+  $ = document.querySelector.bind(document);
+
+  function applySort(sortable) {
+    var params = new URLSearchParams(location.search.slice(1));
+    params.set("_servel_sort_method", sortable.dataset.sortMethod);
+    params.set("_servel_sort_direction", sortable.dataset.sortDirection);
+
+    if('sortActive' in sortable.dataset) {
+      params.set("_servel_sort_direction", sortable.dataset.sortDirection == "asc" ? "desc" : "asc");
+    }
+
+    location.href = location.pathname + "?" + params.toString();
+  }
+
+  document.body.addEventListener("click", function(e) {
+    if(!e.target) return;
+
+    if(e.target.closest("th.sortable")) {
+      e.preventDefault();
+      applySort(e.target.closest("th.sortable"));
+    }
+  });
+}
+
 window.addEventListener("DOMContentLoaded", initListing);

data/lib/servel/version.rb

@@ -1,3 +1,3 @@
 module Servel
-  VERSION = "0.14.0"
+  VERSION = "0.15.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: servel
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Brenton "B-Train" Fletcher
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: Serves files and directories over HTTP.