roda 2.14.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cde8be71334a4d1be45b77656f9314fbac254bd1
-  data.tar.gz: 6c100351e8af6103d141f64967971c3e56dec13d
+  metadata.gz: 625daaffa474b5553308633c41d20b76fa3096d8
+  data.tar.gz: 4bcfc8c8c1258f6860e8ac430ba59679b2c62c69
 SHA512:
-  metadata.gz: 9084568d409627ac84c60d16049a6d2c545bdd9ac6cd6ba4dc312720474ccebc4e859dcc559d7e82390b66e04f31b06ee63ba32a288df57a832ea36ed18fd2ef
-  data.tar.gz: 74b8305898e306b49179ccb05349d4cf25a8fd4f7d481baec071728626a6c1eec99f40fd04faa6d85321e256154db6bf9a74717dbee50a50edad22f552152086
+  metadata.gz: 2331dd19bd5efb8c3187df90917c4a23f814d52ec205b553ac1131fb39a787fffc83930ce697011cda5ac6926ab7cf31a209033dfc5589342b9410ff09b6a743
+  data.tar.gz: 0abd741f20b87dbe497eba823357ce323aa1d82f7a8048895afe4d5b47eefeb340e50fdf9c71daa8c9cb2c064a5e4f30cda800aa751a345f84f57d2424a6a617

data/CHANGELOG

@@ -1,3 +1,13 @@
+= 2.15.0 (2016-06-13)
+
+* Add public plugin for r.public method for serving all files in the public directory (jeremyevans)
+
+* Make send_file in sinatra_helpers plugin work with Rack 2 (jeremyevans)
+
+* Make :header matcher prefixes the env key with HTTP_ if application :header_matcher_prefix option is set (timothypage, jeremyevans) (#69)
+
+* Add content_for plugin :append option to support appending to the existing content (evanleck, jeremyevans) (#66)
+
 = 2.14.0 (2016-05-13)
 
 * Add symbol_status plugin for using symbols as status codes (Papierkorb) (#65)

data/Rakefile

@@ -68,7 +68,7 @@ end
 
 spec = proc do |env|
   env.each{|k,v| ENV[k] = v}
-  sh "#{FileUtils::RUBY} -rubygems -I lib -e 'ARGV.each{|f| require f}' ./spec/*_spec.rb ./spec/plugin/*_spec.rb"
+  sh "#{FileUtils::RUBY} spec/all.rb"
   env.each{|k,v| ENV.delete(k)}
 end
 

data/doc/release_notes/2.15.0.txt

@@ -0,0 +1,53 @@
+= New Features
+
+* A public plugin has been added.  This adds an r.public method
+  for serving all files in the public directory.  The public
+  plugin can replace usage of the static plugin, and is more
+  flexible.  You can place r.public at any point in the routing
+  tree, and it will use the remaining path to lookup the file
+  in the public directory.  You can also pass the :gzip option
+  when loading the plugin, and it will serve already gzipped
+  files to the client if the client supports gzipped transfer
+  encoding and the file exists with a .gz extension.  Example:
+
+    plugin :public
+    route do |r|
+      # Serve public files before routing
+      r.public
+
+      # ...
+    end
+
+* The :header matcher added by the header_matchers plugin now
+  automatically prefixes the key with HTTP_ when looking it up in
+  the environment, if the :header_matcher_prefix application
+  option is set.  This behavior will probably be the default in
+  Roda 3.
+
+    # Before
+    r.on :header => 'http_accept'
+
+    # Now, with :header_matcher_prefix=>true application option
+    r.on :header => 'accept'
+
+* The content_for plugin now accepts an :append=>true option to
+  support appending to the existing content instead of overwriting
+  the existing content if called multiple times.  This behavior
+  will probably be the default in Roda 3.
+
+    # Before
+    content_for(:form, 'a')
+    content_for(:form, 'b')
+    content_for(:form) # => 'b'
+
+    # Now, with :append=>true option
+    content_for(:form, 'a')
+    content_for(:form, 'b')
+    content_for(:form) # => 'ab'
+
+= Other Improvements
+
+* The r.send_file method in the sinatra_helpers plugin now works
+  correctly when using rack 2.
+
+* The specs now run correctly on Windows.

data/lib/roda/plugins/assets.rb

@@ -10,7 +10,7 @@ class Roda
     # This uses the render plugin for rendering the assets, and the render
     # plugin uses tilt internally, so you can use any template engine
     # supported by tilt for your assets.  Tilt ships with support for
-    # the following asset template engines, assuming the necessary libaries
+    # the following asset template engines, assuming the necessary libraries
     # are installed:
     #
     # css :: Less, Sass, Scss
@@ -77,7 +77,7 @@ class Roda
     #   assets/css/frontend/some_frontend_file.scss
     #   assets/css/backend/some_backend_file.scss
     #
-    # If you want do not want to force that directory structure when using
+    # If you do not want to force that directory structure when using
     # asset groups, you can use the <tt>:group_subdirs => false</tt> option.
     #
     # In your view code use an array argument in your call to assets:
@@ -86,7 +86,7 @@ class Roda
     #
     # === Nesting
     #
-    # Asset groups also supporting nesting, though that should only be needed
+    # Asset groups also support nesting, though that should only be needed
     # in fairly large applications.  You can use a nested hash when loading
     # the plugin:
     #
@@ -221,7 +221,7 @@ class Roda
     # :compiled_js_route :: Route under :prefix for compiled javscript assets (default: :compiled_js_dir)
     # :compiled_name :: Compiled file name prefix (default: 'app')
     # :compiled_path:: Path inside public folder in which compiled files are stored (default: :prefix)
-    # :concat_only :: Whether to just concatenate instead of concatentating
+    # :concat_only :: Whether to just concatenate instead of concatenating
     #                 and compressing files (default: false)
     # :css_compressor :: Compressor to use for compressing CSS, either :yui, :none, or nil (the default, which will try
     #                    :yui if available, but not fail if it is not available)

data/lib/roda/plugins/content_for.rb

@@ -26,34 +26,59 @@ class Roda
     # call content_for without the block:
     #
     #   <%= content_for :foo %>
+    #
+    # If content_for is used multiple times with the same key,
+    # by default, the last call will override previous calls.
+    # If you want to append to the content, pass the :append
+    # option when loading the plugin:
+    #
+    #   plugin :content_for, :append=>true
     module ContentFor
       # Depend on the render plugin, since this plugin only makes
       # sense when the render plugin is used.
-      def self.load_dependencies(app)
+      def self.load_dependencies(app, _opts = {})
         app.plugin :render
       end
 
+      # Configure whether to append or overwrite if content_for
+      # is called multiple times to set data. Overwrite is default, use
+      # the :append option to append.
+      def self.configure(app, opts = {})
+        app.opts[:append_content_for] = opts.fetch(:append, false)
+      end
+
       module InstanceMethods
         # If called with a block, store content enclosed by block
         # under the given key.  If called without a block, retrieve
         # stored content with the given key, or return nil if there
         # is no content stored with that key.
         def content_for(key, value=nil, &block)
-          if block
-            outvar = render_opts[:template_opts][:outvar]
-            buf_was = instance_variable_get(outvar)
-            # clean the output buffer for ERB-based rendering systems
-            instance_variable_set(outvar, String.new)
+          append = opts[:append_content_for]
 
-            @_content_for ||= {}
-            @_content_for[key] = Tilt[render_opts[:engine]].new(&block).render
+          if block || value
+            if block
+              outvar = render_opts[:template_opts][:outvar]
+              buf_was = instance_variable_get(outvar)
+
+              # Use temporary output buffer for ERB-based rendering systems
+              instance_variable_set(outvar, String.new)
+              value = Tilt[render_opts[:engine]].new(&block).render
+              instance_variable_set(outvar, buf_was)
+            end
 
-            instance_variable_set(outvar, buf_was)
-          elsif value
             @_content_for ||= {}
-            @_content_for[key] = value
-          elsif @_content_for
-            @_content_for[key]
+
+            if append
+              (@_content_for[key] ||= []) << value
+            else
+              @_content_for[key] = value
+            end
+          elsif @_content_for && (value = @_content_for[key])
+            if append
+              value = value.join
+            end
+
+            value
           end
         end
       end

data/lib/roda/plugins/header_matchers.rb

@@ -11,7 +11,16 @@ class Roda
     # It adds a +:header+ matcher for matching on arbitrary headers, which matches
     # if the header is present:
     #
+    #   r.on :header=>'HTTP-X-App-Token' do |header_value|
+    #     # Looks for env['HTTP_X_APP_TOKEN']
+    #   end
+    #
+    # For backwards compatibility, the header value is not automatically prefixed
+    # with HTTP_.  You can set the +:header_matcher_prefix+ option for the application,
+    # which will automatically prefix the header with HTTP_:
+    #
     #   r.on :header=>'X-App-Token' do |header_value|
+    #     # Looks for env['HTTP_X_APP_TOKEN'] 
     #   end
     #
     # It adds a +:host+ matcher for matching by the host of the request:
@@ -54,7 +63,13 @@ class Roda
 
         # Match if the given uppercase key is present inside the environment.
         def match_header(key)
-          if v = @env[key.upcase.tr("-","_")]
+          key = key.upcase.tr("-","_")
+
+          if roda_class.opts[:header_matcher_prefix]
+            key = "HTTP_#{key}"
+          end
+
+          if v = @env[key]
             @captures << v
           end
         end

data/lib/roda/plugins/public.rb

@@ -0,0 +1,114 @@
+# frozen-string-literal: true
+
+require 'uri'
+
+#
+class Roda
+  module RodaPlugins
+    # The public plugin adds a +r.public+ routing method to serve static files
+    # from a directory.
+    #
+    # The public plugin recognizes the application's :root option, and defaults to
+    # using the +public+ subfolder of the application's +:root+ option.  If the application's
+    # :root option is not set, it defaults to the the +public+ folder in the working
+    # directory.  Additionally, if a relative path is provided as the :root
+    # option to the plugin, it will be considered relative to the application's
+    # +:root+ option.
+    #
+    # Examples:
+    #
+    #   opts[:root] = '/path/to/app'
+    #   plugin :public
+    #   plugin :public, :root=>'static'
+    module Public
+      NULL_BYTE = "\0".freeze
+      SPLIT = Regexp.union(*[File::SEPARATOR, File::ALT_SEPARATOR].compact)
+      PARSER = RUBY_VERSION >= '1.9' ? URI::DEFAULT_PARSER : URI
+
+      # Use options given to setup a Rack::File instance for serving files. Options:
+      # :default_mime :: The default mime type to use if the mime type is not recognized.
+      # :gzip :: Whether to serve already gzipped files with a .gz extension for clients
+      #          supporting gzipped transfer encoding.
+      # :headers :: A hash of headers to use for statically served files
+      # :root :: Use this option for the root of the public directory (default: "public")
+      def self.configure(app, opts={})
+        root =  File.expand_path(opts[:root]||"public", app.opts[:root])
+        app.opts[:public_server] = ::Rack::File.new(root, opts[:headers]||{}, opts[:default_mime] || 'text/plain')
+        app.opts[:public_gzip] = opts[:gzip]
+      end
+
+      module RequestMethods
+        # Serve files from the public directory if the file exists and this is a GET request.
+        def public
+          if is_get?
+            path = PARSER.unescape(remaining_path)
+            return if path.include?(NULL_BYTE)
+
+            roda_opts = roda_class.opts
+            server = roda_opts[:public_server]
+            path = ::File.join(server.root, *public_path_segments(path))
+
+            if roda_opts[:public_gzip] && env['HTTP_ACCEPT_ENCODING'] =~ /\bgzip\b/
+              gzip_path = path + '.gz'
+
+              if public_file_readable?(gzip_path)
+                res = public_serve(server, gzip_path)
+                headers = res[1]
+
+                if mime_type = ::Rack::Mime.mime_type(::File.extname(path), 'text/plain')
+                  headers['Content-Type'] = mime_type
+                end
+                headers['Content-Encoding'] = 'gzip'
+
+                halt res
+              end
+            end
+
+            if public_file_readable?(path)
+              halt public_serve(server, path)
+            end
+          end
+        end
+
+        private
+
+        # Return an array of segments for the given path, handling ..
+        # and . components
+        def public_path_segments(path)
+          segments = []
+            
+          path.split(SPLIT).each do |seg|
+            next if seg.empty? || seg == '.'
+            seg == '..' ? segments.pop : segments << seg
+          end
+            
+          segments
+        end
+
+        # Return whether the given path is a readable regular file.
+        def public_file_readable?(path)
+          ::File.file?(path) && ::File.readable?(path)
+        rescue SystemCallError
+          false
+        end
+
+        if ::Rack.release > '2'
+          # :nocov:
+          def public_serve(server, path)
+            server.serving(self, path)
+          end
+          # :nocov:
+        else
+          # Serve the given path using the given Rack::File server.
+          def public_serve(server, path)
+            server = server.dup
+            server.path = path
+            server.serving(env)
+          end
+        end
+      end
+    end
+
+    register_plugin(:public, Public)
+  end
+end

data/lib/roda/plugins/sinatra_helpers.rb

@@ -339,9 +339,15 @@ class Roda
             last_modified(lm)
           end
 
-          file      = ::Rack::File.new nil
-          file.path = path
-          s, h, b   = file.serving(@env)
+          file = ::Rack::File.new nil
+          s, h, b = if Rack.release > '2'
+            # :nocov:
+            file.serving(self, path)
+            # :nocov:
+          else
+            file.path = path
+            file.serving(@env)
+          end
 
           res.status = opts[:status] || s
           headers.delete(CONTENT_LENGTH)

data/lib/roda/plugins/static.rb

@@ -15,6 +15,8 @@ class Roda
     #
     # Since the :urls option for Rack::Static is always required, the static plugin
     # uses a separate option for it.
+    #
+    # Users of this plugin may want to consider using the public plugin instead.
     # 
     # Examples:
     #

data/lib/roda/version.rb

@@ -4,7 +4,7 @@ class Roda
   RodaMajorVersion = 2
 
   # The minor version of Roda, updated for new feature releases of Roda.
-  RodaMinorVersion = 14
+  RodaMinorVersion = 15
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/all.rb

@@ -0,0 +1,3 @@
+$:.unshift(File.expand_path("../lib", File.dirname(__FILE__)))
+require 'rubygems'
+(Dir['./spec/*_spec.rb'] + Dir['./spec/plugin/*_spec.rb']).each{|f| require f}

data/spec/plugin/_erubis_escaping_spec.rb

@@ -2,12 +2,18 @@ require File.expand_path("spec_helper", File.dirname(File.dirname(__FILE__)))
 
 begin
   require 'erubis'
+  require 'tilt'
   require 'tilt/erb'
   begin
     require 'tilt/erubis'
   rescue LoadError
     # Tilt 1 support
   end
+
+  if defined?(Tilt::ErubisTemplate) && ::Tilt['erb'] != Tilt::ErubisTemplate
+    # Work around error where erubis isn't set as erb template handler
+    Tilt.register(Tilt::ErubisTemplate, 'erb')
+  end
 rescue LoadError
   warn "tilt or erubis not installed, skipping _erubis_escaping plugin test"  
 else

data/spec/plugin/assets_spec.rb

@@ -564,15 +564,16 @@ if run_tests
 
       app.opts[:root] = '/foo'
       app.plugin :assets
-      app.assets_opts[:path].must_equal '/foo/assets'
-      app.assets_opts[:js_path].must_equal '/foo/assets/js/'
-      app.assets_opts[:css_path].must_equal '/foo/assets/css/'
+      # Work around for Windows
+      app.assets_opts[:path].sub(/\A\w:/, '').must_equal '/foo/assets'
+      app.assets_opts[:js_path].sub(/\A\w:/, '').must_equal '/foo/assets/js/'
+      app.assets_opts[:css_path].sub(/\A\w:/, '').must_equal '/foo/assets/css/'
 
       app.opts[:root] = '/foo/bar'
       app.plugin :assets
-      app.assets_opts[:path].must_equal '/foo/bar/assets'
-      app.assets_opts[:js_path].must_equal '/foo/bar/assets/js/'
-      app.assets_opts[:css_path].must_equal '/foo/bar/assets/css/'
+      app.assets_opts[:path].sub(/\A\w:/, '').must_equal '/foo/bar/assets'
+      app.assets_opts[:js_path].sub(/\A\w:/, '').must_equal '/foo/bar/assets/js/'
+      app.assets_opts[:css_path].sub(/\A\w:/, '').must_equal '/foo/bar/assets/css/'
 
       app.opts[:root] = nil
       app.plugin :assets

data/spec/plugin/content_for_spec.rb

@@ -107,4 +107,28 @@ describe "content_for plugin when overriding :engine" do
     body('/a').strip.must_equal "bar\nfoo"
   end
 end
+
+describe "content_for plugin with multiple calls to the same key" do
+  before do
+    app(:bare) do
+      plugin :render, :views => './spec/views'
+      plugin :content_for
+
+      route do |r|
+        r.root do
+          view(:inline => "<% content_for :foo do %>foo<% end %><% content_for :foo do %>baz<% end %>bar", :layout => { :inline => '<%= yield %> <%= content_for(:foo) %>' })
+        end
+      end
+    end
+  end
+
+  it "should replace with multiple calls to the same key by default" do
+    body.strip.must_equal "bar baz"
+  end
+
+  it "should append with multiple calls to the same key if :append plugin option is used" do
+    app.plugin :content_for, :append => true
+    body.strip.must_equal "bar foobaz"
+  end
+end
 end

data/spec/plugin/header_matchers_spec.rb

@@ -22,22 +22,34 @@ describe "header matcher" do
     end
 
     body("HTTP_ACCEPT" => "application/xml").must_equal  "bar"
+    status("HTTP_HTTP_ACCEPT" => "application/xml").must_equal 404
     status.must_equal 404
   end
 
-  it "should yield the header value if :match_header_yield option is present" do
+  it "should yield the header value" do
+    app(:header_matchers) do |r|
+      r.on :header=>"http-accept" do |v|
+        "bar-#{v}"
+      end
+    end
+
+    body("HTTP_ACCEPT" => "application/xml").must_equal  "bar-application/xml"
+    status.must_equal 404
+  end
+
+  it "should automatically use HTTP prefix for headers if :header_matcher_prefix is set" do
     app(:bare) do
       plugin :header_matchers
-      opts[:match_header_yield] = true
+      opts[:header_matcher_prefix] = true
       route do |r|
-        r.on :header=>"http-accept" do |v|
+        r.on :header=>"accept" do |v|
           "bar-#{v}"
         end
       end
     end
 
     body("HTTP_ACCEPT" => "application/xml").must_equal  "bar-application/xml"
-    status.must_equal 404
+    status("ACCEPT"=>"application/xml").must_equal 404
   end
 end
 

data/spec/plugin/public_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path("spec_helper", File.dirname(File.dirname(__FILE__)))
+
+describe "public plugin" do 
+  it "adds r.public for serving static files from public folder" do
+    app(:bare) do
+      plugin :public, :root=>'spec/views'
+
+      route do |r|
+        r.public
+
+        r.on 'static' do
+          r.public
+        end
+      end
+    end
+
+    status("/about/_test.erb\0").must_equal 404
+    body('/about/_test.erb').must_equal File.read('spec/views/about/_test.erb')
+    body('/static/about/_test.erb').must_equal File.read('spec/views/about/_test.erb')
+    body('/foo/.././/about/_test.erb').must_equal File.read('spec/views/about/_test.erb')
+  end
+
+  it "respects the application's :root option" do
+    app(:bare) do
+      opts[:root] = File.expand_path('../../', __FILE__)
+      plugin :public, :root=>'views'
+
+      route do |r|
+        r.public
+      end
+    end
+
+    body('/about/_test.erb').must_equal File.read('spec/views/about/_test.erb')
+  end
+
+  it "handles serving gzip files in gzip mode if client supports gzip" do
+    app(:bare) do
+      plugin :public, :root=>'spec/views', :gzip=>true
+
+      route do |r|
+        r.public
+      end
+    end
+
+    body('/about/_test.erb').must_equal File.read('spec/views/about/_test.erb')
+    header('Content-Encoding', '/about/_test.erb').must_equal nil
+
+    body('/about.erb').must_equal File.read('spec/views/about.erb')
+    header('Content-Encoding', '/about.erb').must_equal nil
+
+    meth = RUBY_VERSION >= '1.9' ? :binread : :read
+    body('/about/_test.erb', 'HTTP_ACCEPT_ENCODING'=>'deflate, gzip').must_equal File.send(meth, 'spec/views/about/_test.erb.gz')
+    h = req('/about/_test.erb', 'HTTP_ACCEPT_ENCODING'=>'deflate, gzip')[1]
+    h['Content-Encoding'].must_equal 'gzip'
+    h['Content-Type'].must_equal 'text/plain'
+
+    body('/about/_test.css', 'HTTP_ACCEPT_ENCODING'=>'deflate, gzip').must_equal File.send(meth, 'spec/views/about/_test.css.gz')
+    h = req('/about/_test.css', 'HTTP_ACCEPT_ENCODING'=>'deflate, gzip')[1]
+    h['Content-Encoding'].must_equal 'gzip'
+    h['Content-Type'].must_equal 'text/css'
+  end
+end

data/spec/plugin/render_spec.rb

@@ -189,11 +189,12 @@ describe "render plugin" do
 
     app.opts[:root] = '/foo'
     app.plugin :render
-    app.render_opts[:views].must_equal '/foo/views'
+    # Work around for Windows
+    app.render_opts[:views].sub(/\A\w:/, '').must_equal '/foo/views'
 
     app.opts[:root] = '/foo/bar'
     app.plugin :render
-    app.render_opts[:views].must_equal '/foo/bar/views'
+    app.render_opts[:views].sub(/\A\w:/, '').must_equal '/foo/bar/views'
 
     app.opts[:root] = nil
     app.plugin :render

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.15.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2016-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -180,6 +180,7 @@ extra_rdoc_files:
 - doc/release_notes/2.12.0.txt
 - doc/release_notes/2.13.0.txt
 - doc/release_notes/2.14.0.txt
+- doc/release_notes/2.15.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -197,6 +198,7 @@ files:
 - doc/release_notes/2.12.0.txt
 - doc/release_notes/2.13.0.txt
 - doc/release_notes/2.14.0.txt
+- doc/release_notes/2.15.0.txt
 - doc/release_notes/2.2.0.txt
 - doc/release_notes/2.3.0.txt
 - doc/release_notes/2.4.0.txt
@@ -259,6 +261,7 @@ files:
 - lib/roda/plugins/path_rewriter.rb
 - lib/roda/plugins/per_thread_caching.rb
 - lib/roda/plugins/precompile_templates.rb
+- lib/roda/plugins/public.rb
 - lib/roda/plugins/render.rb
 - lib/roda/plugins/render_each.rb
 - lib/roda/plugins/response_request.rb
@@ -277,6 +280,7 @@ files:
 - lib/roda/plugins/view_subdirs.rb
 - lib/roda/plugins/websockets.rb
 - lib/roda/version.rb
+- spec/all.rb
 - spec/assets/css/app.scss
 - spec/assets/css/no_access.css
 - spec/assets/css/raw.css
@@ -339,6 +343,7 @@ files:
 - spec/plugin/path_spec.rb
 - spec/plugin/per_thread_caching_spec.rb
 - spec/plugin/precompile_templates_spec.rb
+- spec/plugin/public_spec.rb
 - spec/plugin/render_each_spec.rb
 - spec/plugin/render_spec.rb
 - spec/plugin/response_request_spec.rb