vienna 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0641d490c3333bf03dc99312ac8f32822255b77a
-  data.tar.gz: 755f234ad7c27ca4ff42a1563251d4cd2fe77e85
+  metadata.gz: c7f4271e15a1b4077b68429a001cc73fba108126
+  data.tar.gz: 022c9950cbea50197c164edcb715ff3a47b930bc
 SHA512:
-  metadata.gz: ae8eca143875c44fccd4a77259a51eaa68c1bc618a73dc438538e2b2b542ee651d3408ca6b2af6cc03a6127b4acda30270029d2ec2d5d0e9d0d6176f14fd5b65
-  data.tar.gz: 95f410c94e304d0cf72f1e34c00fcd2bb02e28a26f2ff359cd71ee3efc8dc687d12f6ebd01705b27a4db3414a93c5491d9603e665e55cf14449949fdbe45a323
+  metadata.gz: d7969d4e0ca2c708fdb928b3e9b5f64562619e1591d4ac3b5539d2b6c2314b80fe210d60c191241f686fa1f16ad4a70e20ded51190a2aebe707ab986337509ee
+  data.tar.gz: 6497716a18152e8da414ea8a31f914e34e7ede4bff649559b7cc7c8cd971d75c9d37b68b1c058a07280074dddf01fcdbf1b103344f54d4df896c1ec731da8ec4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Mikael Konutgan
+Copyright (c) 2013-2015 Mikael Konutgan
 
 MIT License
 

data/Rakefile

@@ -3,7 +3,7 @@ require 'yard'
 
 task :default => :test
 
-desc 'Test'
+desc 'Run tests'
 task :test do
   Dir.chdir 'spec'
   system 'ruby -I ../lib spec.rb'

data/lib/vienna.rb

@@ -3,7 +3,7 @@ require 'rack'
 
 ##
 # Zero-configuration convenience wrapper around `Vienna::Application`.
-# Add this to `config.ru`:
+# Add this to your `config.ru`:
 #
 #     require 'vienna'
 #     run Vienna
@@ -19,11 +19,54 @@ module Vienna
     end
   end
   
+  ##
+  # `Vienna::Static` is just a wrapper for `Rack::Static` with
+  # sane and opinionated options.
+  #
+  # It serves all files under the given `root` and doesn't passes on requests
+  # for files that don't exist.
+  #
+  # Examples
+  #
+  #     use Vienna::Static, 'public'
+  #
+  
+  class Static
+    def initialize(app, root)
+      @app = app
+      @root = root
+    end
+    
+    def urls
+      Dir.glob("#{root}/*").map { |f| f.sub(root, '') }
+    end
+    
+    def root
+      @root
+    end
+    
+    def index
+      'index.html'
+    end
+    
+    def header_rules
+      [[:all, {'Cache-Control' => 'public, max-age=3600'}]]
+    end
+    
+    def options
+      {urls: urls, root: root, index: index, header_rules: header_rules}
+    end
+    
+    def call(env)
+      Rack::Static.new(@app, options).call(env)
+    end
+  end
+  
   ##
   # `Vienna::NotFound` is a default endpoint not unlike `Rack::NotFound`.
-  # Initialize it with the path to a 404 page and it will get returned.
-  # The difference is that if a 404 page doesn't exist, a default
-  # response, 'Not Found' will be returned.
+  # Initialize it with the path to a 404 page and its contents will be served.
+  # The difference is that if a 404 page doesn't exist, a default response,
+  # 'Not Found' will be served.
   #
   # Examples
   #
@@ -35,23 +78,22 @@ module Vienna
   class NotFound
     def initialize(path = '')
       @path = path
-      @content = 'Not Found'
     end
     
     def call(env)
-      if ::File.exist?(@path)
-        @content = ::File.read(@path)
-      end
-      length = @content.length.to_s
-      [404, {'Content-Type' => 'text/html', 'Content-Length' => length}, [@content]]
+      content = File.exist?(@path) ? File.read(@path) : 'Not Found'
+      length = content.length.to_s
+      
+      [404, {'Content-Type' => 'text/html', 'Content-Length' => length}, [content]]
     end
   end
   
   ##
-  # `Vienna::Application` serves all files under the given `root`
-  # using `Rack::Static`. If a file/path doen't exist,
-  # `Vienna::NotFound` is run, which always returns `404`.
-  # 
+  # `Vienna::Application` serves all files under the given root directory
+  # using `Vienna::Static`. If a file/path doen't exist, `Vienna::NotFound`
+  # is run, which always returns a status of `404` and the contents of
+  # `404.html` or `'Not Found'` if one does not exist.
+  #
   # Examples
   #
   #     run Vienna::Application.new('_site')
@@ -62,12 +104,7 @@ module Vienna
   class Application
     def initialize(root = 'public')
       @app = Rack::Builder.new do
-        use Rack::Static,
-          :urls => Dir.glob("#{root}/*").map { |fn| fn.gsub(/#{root}/, '')},
-          :root => root,
-          :index => 'index.html',
-          :header_rules => [[:all, {'Cache-Control' => 'public, max-age=3600'}]]
-        
+        use Static, root
         run NotFound.new("#{root}/404.html")
       end
     end

data/lib/vienna/version.rb

@@ -1,3 +1,3 @@
 module Vienna
-  VERSION = '0.4.0'
+  VERSION = '0.4.1'
 end

data/spec/spec.rb

@@ -8,30 +8,57 @@ describe Vienna do
       use Rack::Lint
       run Vienna
     end
+    
     @request = Rack::MockRequest.new(app)
   end
   
-  it 'should serve the index when getting root' do
-    res = @request.get '/'
-    res.body.chomp.must_equal 'index'
-    [200, 304].must_include res.status
-  end
-  
-  it 'should serve all files in the public directory' do
-    @request.get('/css/style.css').body.chomp.must_equal 'style'
-    @request.get('/images/image.svg').body.chomp.must_equal 'image'
-    @request.get('/about.html').body.chomp.must_equal 'about'
+  describe 'when requesting the root directory' do
+    before do
+      @res = @request.get('/')
+    end
+    
+    it 'should serve the index path' do
+      @res.body.chomp.must_equal 'index'
+    end
+    
+    it 'should return a valid status code, that is 200: OK or 304: Not Modified' do
+      [200, 304].must_include @res.status
+    end
   end
   
-  it 'should cache all files' do
-    ['/', '/css/style.css', '/images/image.svg', 'about.html'].each do |path|
-      @request.get(path).headers['Cache-Control'].must_equal 'public, max-age=3600'
+  describe 'when requesting the path of a subdirectory of the root directory' do
+    before do
+      @paths = {
+        '/css/style.css'    => 'style',
+        '/images/image.svg' => 'image',
+        '/about.html'       => 'about'
+      }
+    end
+    
+    it 'should serve the contents of the paths' do
+      @paths.each do |path, body|
+        @request.get(path).body.chomp.must_equal body
+      end
+    end
+    
+    it 'should cache all responses for a an hour' do
+      @paths.each do |path, body|
+        @request.get(path).headers['Cache-Control'].must_equal 'public, max-age=3600'
+      end
     end
   end
   
-  it 'should serve `404-html` for pages that aren\'t found' do
-    res = @request.get '/path'
-    res.body.chomp.must_equal '404'
-    res.status.must_equal 404
+  describe 'when requesting a path that does not exist' do
+    before do
+      @res = @request.get('/path')
+    end
+    
+    it 'should serve the contents of `404.html` if the file exists' do
+      @res.body.chomp.must_equal '404'
+    end
+    
+    it 'should return the status code 404: Not Found' do
+      @res.status.must_equal 404
+    end
   end
 end

data/vienna.gemspec

@@ -1,6 +1,6 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require 'vienna/version'
 
 Gem::Specification.new do |spec|
@@ -8,19 +8,20 @@ Gem::Specification.new do |spec|
   spec.version       = Vienna::VERSION
   spec.authors       = ['Mikael Konutgan']
   spec.email         = ['me@kmikael.com']
-  spec.description   = %q{Tiny, zero-configuration static file server built on top of rack}
-  spec.summary       = %q{Tiny, zero-configuration static file server built on top of rack}
+  spec.description   = 'Tiny, zero-configuration static file server built on top of rack'
+  spec.summary       = 'Tiny, zero-configuration static file server built on top of rack'
   spec.homepage      = 'https://github.com/kmikael/vienna'
   spec.license       = 'MIT'
-
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  
+  spec.files         = `git ls-files`.split
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
   spec.require_paths = ['lib']
   
   spec.add_runtime_dependency 'rack', '~> 1.5'
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake'
+  
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'yard', '~> 0.8'
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: vienna
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Mikael Konutgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-28 00:00:00.000000000 Z
+date: 2015-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '10.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 description: Tiny, zero-configuration static file server built on top of rack
@@ -87,6 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -110,17 +111,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Tiny, zero-configuration static file server built on top of rack