roda 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7717dcab195a4aa608a95fe1b957a4e70e46eb1
-  data.tar.gz: a183e023f32c278e5ddce68390775ef396472d44
+  metadata.gz: d0f2116bac0848dc9f1f4563daab14474e62a79b
+  data.tar.gz: 5f564ae0dc012ae84af1a9d5d64c1b4bb214b7b0
 SHA512:
-  metadata.gz: 0aded27e4b6f521e554f49d14e805fe3bdf03265f3cb4b4437145bc8767ef4b07ced8e267caaee331dc8fba84cb706c166776dd507e5ff254238c9b39984a94a
-  data.tar.gz: 79cc0eeea440e916f31b5312c0005e06a543f29204b6ec4b3a34340a221708fb5779b85b38d1242bca29d9b86e789803336e502621bec68034e08e583e1df2b1
+  metadata.gz: 31621a2f3576447f261cad0d53ec12b24d407b3f929fbe51be8c102ca279492cc3f19bf80ded152e4b4018fc4f02836b70a5800cbbe39f2fc196e001307e4f6d
+  data.tar.gz: b9ede292a9c37c68532b0068fcd79a5d942da3f9b31e751f9ba360df8bcc4959eb35908bcbb06a6389fd93f593b60a80f48537a00e92d76938241799e5e1426a

data/CHANGELOG

@@ -1,3 +1,13 @@
+= 3.1.0 (2017-10-13)
+
+* Make set_layout_locals and set_view_locals in branch_locals plugin work when the other is not called (jeremyevans)
+
+* Add :timestamp_paths option to assets plugin to include timestamps in paths in non-compiled mode (jeremyevans)
+
+* Handle ExecJS::RuntimeUnavailable when testing for javascript compression support using uglifier (jeremyevans)
+
+* Remove deprecated Roda.thread_safe_cache and RodaRequest#placeholder_string_matcher? methods (jeremyevans)
+
 = 3.0.0 (2017-09-15)
 
 * Make defined symbol_matcher and hash_matcher match methods private (jeremyevans)

data/README.rdoc

@@ -443,7 +443,7 @@ treat it as one route with an optional segment.  One simple way to do that is to
 use a parameter instead of an optional segment (e.g. +/items/123?opt=456+).
 
   r.is "items", Integer do |item_id|
-    optional_data = r['opt']
+    optional_data = r.params['opt']
   end
 
 However, if you really do want to use a optional segment, there are a couple different

data/doc/release_notes/3.1.0.txt

@@ -0,0 +1,24 @@
+= New Features
+
+* A :timestamp_paths option has been added to the assets plugin to
+  include timestamps in paths in non-compiled mode.  This can fix
+  asset staleness issues when using a caching proxy.  This is
+  not needed in compiled mode, as the asset file names include the
+  hash of the asset.  It is not the default in non-compiled mode,
+  as few people would use a caching proxy in non-compiled mode.
+
+= Other Improvements
+
+* Make set_layout_locals and set_view_locals in branch_locals
+  plugin work when the other is not called.
+
+* When testing support for uglifier usability as a JS asset
+  compressor, handle case where uglifier is installed but there is
+  no available javascript runtime.
+
+= Backwards Compatibility
+
+* The deprecated Roda.thread_safe_cache method has been removed.
+
+* The deprecated private RodaRequest#placeholder_string_matcher?
+  method has been removed.

data/lib/roda.rb

@@ -225,13 +225,6 @@ class Roda
           build_rack_app
         end
 
-        def thread_safe_cache
-          # :nocov:
-          RodaPlugins.warn "Roda.thread_safe_cache is deprecated and will be removed from Roda 3.1."
-          RodaCache.new
-          # :nocov:
-        end
-
         # Add a middleware to use for the rack application.  Must be
         # called before calling #route to have an effect. Example:
         #
@@ -897,15 +890,6 @@ class Roda
           end
         end
 
-        # Whether string matchers are used verbatim, without handling
-        # placeholders via colons.
-        def placeholder_string_matcher?
-          # :nocov:
-          RodaPlugins.warn "Roda::RodaRequest.placeholder_string_matcher? is deprecated and will be removed from Roda 3.1."
-          false
-          # :nocov:
-        end
-
         # Handle an unsupported matcher.
         def unsupported_matcher(matcher)
           raise RodaError, "unsupported matcher: #{matcher.inspect}"

data/lib/roda/plugins/assets.rb

@@ -294,6 +294,10 @@ class Roda
     #         :sha256, :sha384, or :sha512 depending on which hash algorithm you want to use.  This changes the
     #         hash algorithm that Roda will use when naming compiled asset files. The default is :sha256, you
     #         can use nil to disable subresource integrity.
+    # :timestamp_paths :: Include the timestamp of assets in asset paths in non-compiled mode. Doing this can
+    #                     slow down development requests due to additional requests to get last modified times,
+    #                     put it will make sure the paths change in development when there are modifications,
+    #                     which can fix issues when using a caching proxy in non-compiled mode.
     module Assets
       DEFAULTS = {
         :compiled_name    => 'app'.freeze,
@@ -303,6 +307,7 @@ class Roda
         :concat_only      => false,
         :compiled         => false,
         :add_suffix       => false,
+        :timestamp_paths  => false,
         :group_subdirs    => true,
         :compiled_css_dir => nil,
         :compiled_js_dir  => nil,
@@ -556,7 +561,12 @@ class Roda
 
         # Compress the JS using Uglifier, requires javascript runtime
         def compress_js_uglifier(content)
-          require 'uglifier'
+          begin
+            require 'uglifier'
+          rescue => e
+            raise CompressorNotFound, "#{e.class}: #{e.message}", e.backtrace
+          end
+
           Uglifier.compile(content)
         end
 
@@ -610,7 +620,7 @@ class Roda
               dirs.each{|f| asset_dir = asset_dir[f]}
               prefix = "#{dirs.join('/')}/" if o[:group_subdirs]
             end
-            Array(asset_dir).map{|f| "#{url_prefix}/#{o[:"#{stype}_prefix"]}#{prefix}#{f}#{o[:"#{stype}_suffix"]}"}
+            Array(asset_dir).map{|f| "#{url_prefix}/#{o[:"#{stype}_prefix"]}#{"#{asset_last_modified(File.join(o[:"#{stype}_path"], *[prefix, f].compact)).to_i}/" if o[:timestamp_paths]}#{prefix}#{f}#{o[:"#{stype}_suffix"]}"}
           end
         end
 
@@ -755,7 +765,7 @@ class Roda
             /#{o[:"compiled_#{type}_prefix"]}(#{Regexp.union(assets)})/
           else
             assets = unnest_assets_hash(o[type])
-            /#{o[:"#{type}_prefix"]}(#{Regexp.union(assets.uniq)})#{o[:"#{type}_suffix"]}/
+            /#{o[:"#{type}_prefix"]}#{"\\d+\/" if o[:timestamp_paths]}(#{Regexp.union(assets.uniq)})#{o[:"#{type}_suffix"]}/
           end
         end
 

data/lib/roda/plugins/branch_locals.rb

@@ -60,7 +60,7 @@ class Roda
         # Make branch specific layout locals override render_locals plugin defaults.
         def layout_locals
           locals = super
-          if @_view_locals
+          if @_layout_locals
             locals = Hash[locals].merge!(@_layout_locals)
           end
           locals

data/lib/roda/plugins/middleware.rb

@@ -35,7 +35,9 @@ class Roda
     #
     # It is possible to use the Roda app as a regular app even when using
     # the middleware plugin.  Using an app as middleware automatically creates
-    # a subclass of the app for the middleware.
+    # a subclass of the app for the middleware.  Because a subclass is automatically
+    # created when the app is used as middleware, any configuration of the app
+    # should be done before using it as middleware instead of after.
     #
     # You can support configurable middleware by passing a block when loading
     # the plugin:

data/lib/roda/plugins/public.rb

@@ -11,15 +11,29 @@ class Roda
     # 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 +public+ folder in the working
-    # directory.  Additionally, if a relative path is provided as the :root
+    # 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'
+    #   # Use public folder as location of files
     #   plugin :public
+    #
+    #   # Use /path/to/app/static as location of files
+    #   opts[:root] = '/path/to/app'
     #   plugin :public, root: 'static'
+    #
+    #   # Assuming public is the location of files
+    #   r.route do
+    #     # Make GET /images/foo.png look for public/images/foo.png 
+    #     r.public
+    #
+    #     # Make GET /static/images/foo.png look for public/images/foo.png
+    #     r.on(:static) do
+    #       r.public
+    #     end
+    #   end
     module Public
       SPLIT = Regexp.union(*[File::SEPARATOR, File::ALT_SEPARATOR].compact)
       PARSER = URI::DEFAULT_PARSER

data/lib/roda/plugins/type_routing.rb

@@ -27,7 +27,7 @@ class Roda
     # /a :: HTML, JSON, or XML response, depending on the Accept header
     #
     # The response +Content-Type+ header will be set to a suitable value when
-    # the block is matched.
+    # the +r.html+, +r.json+, or +r.xml+ block is matched.
     #
     # Note that if no match is found, code will continue to execute, which can
     # result in unexpected behaviour.  This should only happen if you do not
@@ -44,7 +44,11 @@ class Roda
     #     end
     #   end
     #
-    # This works correctly because Roda assumes the html type by default.
+    # This works correctly because Roda's default Content-Type is text/html. Note that
+    # if you use this approach, the type_routing plugin's :html content type will not be
+    # used for html responses, since you aren't using an +r.html+ block.  Instead, the
+    # Content-Type header will be set to Roda's default (which you can override via
+    # the default_headers plugin).
     #
     # To match custom extensions, use the :types option:
     #

data/lib/roda/version.rb

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

data/spec/plugin/assets_spec.rb

@@ -180,7 +180,23 @@ if run_tests
       js.must_include('console.log')
     end
 
-    it 'should handle rendering assets, linking to them, and accepting requests for them  when :add_script_name app option is used' do
+    it 'should handle rendering assets, linking to them, and accepting requests for them when :timestamp_paths plugin option is used' do
+      app.plugin :assets, :timestamp_paths=>true
+      html = body('/test')
+      html.scan(/<link/).length.must_equal 2
+      html =~ %r{href="(/assets/css/\d+/app\.scss)"}
+      css = body($1)
+      html =~ %r{href="(/assets/css/\d+/raw\.css)"}
+      css2 = body($1)
+      html.scan(/<script/).length.must_equal 1
+      html =~ %r{src="(/assets/js/\d+/head/app\.js)"}
+      js = body($1)
+      css.must_match(/color: red;/)
+      css2.must_match(/color: blue;/)
+      js.must_include('console.log')
+    end
+
+    it 'should handle rendering assets, linking to them, and accepting requests for them when :add_script_name app option is used' do
       app.opts[:add_script_name] = true
       app.plugin :assets
       html = body('/test', 'SCRIPT_NAME'=>'/foo')

data/spec/plugin/branch_locals_spec.rb

@@ -17,6 +17,24 @@ describe "branch_locals plugin" do
     body.strip.must_equal "<title>Alternative Layout: Home</title>\n<h1>About Roda</h1>"
   end
 
+  it "should have set_view_locals work without set_layout_locals" do
+    app(:branch_locals) do
+      set_view_locals :title=>'About Roda'
+      view(:inline=>'<h1><%= title %></h1>', :layout=>{:inline=>"<title>Alternative Layout: <%= title %></title>\n<%= yield %>", :locals=>{:title=>'Home'}})
+    end
+
+    body.strip.must_equal "<title>Alternative Layout: Home</title>\n<h1>About Roda</h1>"
+  end
+
+  it "should have set_layout_locals work without set_view_locals" do
+    app(:branch_locals) do
+      set_layout_locals :title=>'Home'
+      view(:inline=>'<h1><%= title %></h1>', :locals=>{:title=>'About Roda'}, :layout=>{:inline=>"<title>Alternative Layout: <%= title %></title>\n<%= yield %>"})
+    end
+
+    body.strip.must_equal "<title>Alternative Layout: Home</title>\n<h1>About Roda</h1>"
+  end
+
   it "should merge multiple calls to set view and layout locals" do
     app(:branch_locals) do
       set_layout_locals :title=>'About Roda'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2017-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -196,6 +196,7 @@ extra_rdoc_files:
 - doc/release_notes/2.28.0.txt
 - doc/release_notes/2.29.0.txt
 - doc/release_notes/3.0.0.txt
+- doc/release_notes/3.1.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -238,6 +239,7 @@ files:
 - doc/release_notes/2.8.0.txt
 - doc/release_notes/2.9.0.txt
 - doc/release_notes/3.0.0.txt
+- doc/release_notes/3.1.0.txt
 - lib/roda.rb
 - lib/roda/plugins/_symbol_regexp_matchers.rb
 - lib/roda/plugins/all_verbs.rb