roda 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4196dbdea5add49bdf94cb6c59d5f10f3d2d6464
-  data.tar.gz: 23b683d38973ae9c47d99033e35f71be7ae89e68
+  metadata.gz: 325e660f0581837d20d346159eea1be6a7363c9c
+  data.tar.gz: eb99e9f1843f9959ae80a7b44900476b749f734f
 SHA512:
-  metadata.gz: 79a29e4ad2df5b81307e3db2bd768c10937f9a704f93d5702b97779ee1f6821b223e60b5011ce3c482220bf56d993d3aa67473e1bd6a8b68869135123ee29897
-  data.tar.gz: 7ffc00c161bf098279cf9b5e61bd02aa5e99531e9c4bd1072ab7b97a191ff77e1c417a037e8f1c7b2d8d2dc757fc15d667d57d622aa001a3e568c467700ce8be
+  metadata.gz: 5bb3a46ed33cf4086c2d911be08817d60ba7ae522c23ad773824d6938fb6b2ab5bca7c15ce3dfa47a14d6364b37a65b96e29e23fc24b312b8c17d070e39241ac
+  data.tar.gz: 705cbd16aeae28277012f7597f926156b8c825988d167c1cfaf36f2f8c263f6f81c2fe644587dede273cf5e4b9197897eb58a12b6027fadf832198f46b18d083

data/CHANGELOG

@@ -1,3 +1,13 @@
+= 2.5.0 (2015-07-14)
+
+* Make :by_name option to path plugin default to true in development (jeremyevans)
+
+* Add :cache_class option to render plugin, for customized template cache behavior (celsworth) (#34)
+
+* Add :compiled_asset_host option to assets plugin, to use a host for compiled assets (jeremyevans)
+
+* Allow r.multi_run to take a block that is called with the prefix before dispatching to the rack app (mikz) (#32)
+
 = 2.4.0 (2015-06-15)
 
 * Add websockets plugin, for integration with faye-websocket (jeremyevans)

data/doc/release_notes/2.4.0.txt

@@ -4,7 +4,7 @@
   faye-websocket.  Here's an example of a simple echo service using
   websockets:
 
-    plugin :websocket
+    plugin :websockets
 
     route do |r|
       r.get "echo" do

data/doc/release_notes/2.5.0.txt

@@ -0,0 +1,23 @@
+= New Features
+
+* The assets plugin now supports a :compiled_asset_host option, which
+  specifies a hostname used to serve compiled assets.
+
+* The render plugin now supports a :cache_class option, which
+  specificies a class to use for the thread-safe template cache.
+  This can be used to setup LRU caching or caching that checks
+  modify times on the underlying template files.
+
+* r.multi_run in the multi_run plugin now accepts a block, and calls
+  the block before dispatching to the related rack application.  This
+  can be used to modify the environment before dispatching.  Example:
+
+    r.multi_run do |prefix|
+      env['authenticated'] = true
+    end
+
+= Backwards Compatibility
+
+* The :by_name option to the path plugin now defaults to true in
+  development mode.  This should only negatively affect applications
+  that register anonymous classes with the path plugin.

data/lib/roda/plugins/assets.rb

@@ -189,6 +189,8 @@ class Roda
     #
     # :add_suffix :: Whether to append a .css or .js extension to asset routes in non-compiled mode
     #                (default: false)
+    # :compiled_asset_host :: The asset host to use for compiled assets.  Should include the protocol
+    #                         as well as the host (e.g. "https://cdn.example.com", "//cdn.example.com")
     # :compiled_css_dir :: Directory name in which to store the compiled css file,
     #                      inside :compiled_path (default: nil)
     # :compiled_css_route :: Route under :prefix for compiled css assets (default: :compiled_css_dir)
@@ -562,14 +564,19 @@ class Roda
 
           # Create a tag for each individual file
           if compiled = o[:compiled]
+            asset_host = o[:compiled_asset_host]
             if dirs && !dirs.empty?
               key = dirs.join(DOT)
               ckey = "#{stype}.#{key}"
               if ukey = compiled[ckey]
-                "#{tag_start}#{url_prefix}/#{o[:"compiled_#{stype}_prefix"]}.#{key}.#{ukey}.#{stype}#{tag_end}"
+                ukey = "#{key}.#{ukey}"
               end
-            elsif ukey = compiled[stype]
-              "#{tag_start}#{url_prefix}/#{o[:"compiled_#{stype}_prefix"]}.#{ukey}.#{stype}#{tag_end}"
+            else
+              ukey = compiled[stype]
+            end
+
+            if ukey
+              "#{tag_start}#{asset_host}#{url_prefix}/#{o[:"compiled_#{stype}_prefix"]}.#{ukey}.#{stype}#{tag_end}"
             end
           else
             asset_dir = o[type]

data/lib/roda/plugins/multi_run.rb

@@ -25,6 +25,17 @@ class Roda
     # starting with +/ro+ to +OtherRodaApp+, and routes starting with +/si+ to
     # SinatraApp.
     #
+    # You can pass a block to +multi_run+ that will be called with the prefix,
+    # before dispatching to the rack app:
+    #
+    #   App.route do |r|
+    #     r.multi_run do |prefix|
+    #       # do something based on prefix before the request is passed further
+    #     end
+    #   end
+    #
+    # This is useful for modifying the environment before passing it to the rack app.
+    #
     # The multi_run plugin is similar to the multi_route plugin, with the difference
     # being the multi_route plugin keeps all routing subtrees in the same Roda app/class,
     # while multi_run dispatches to other rack apps.  If you want to isolate your routing
@@ -76,6 +87,7 @@ class Roda
         # dispatch the request to the stored rack application.
         def multi_run
           on self.class.multi_run_regexp do |prefix|
+            yield prefix if block_given?
             run scope.class.multi_run_apps[prefix]
           end
         end

data/lib/roda/plugins/path.rb

@@ -62,12 +62,11 @@ class Roda
       OPTS = {}.freeze
 
       # Initialize the path classes when loading the plugin. Options:
-      # :by_name :: Register classes by name, which is friendlier when reloading code.
+      # :by_name :: Register classes by name, which is friendlier when reloading code (defaults to
+      #             true in development mode)
       def self.configure(app, opts=OPTS)
         app.instance_eval do
-          if opts.has_key?(:by_name)
-            self.opts[:path_class_by_name] = opts[:by_name]
-          end
+          self.opts[:path_class_by_name] = opts.fetch(:by_name, ENV['RACK_ENV'] == 'development')
           self.opts[:path_classes] ||= {}
           unless path_block(String)
             path(String){|str| str}

data/lib/roda/plugins/render.rb

@@ -29,6 +29,7 @@ class Roda
     # :cache :: nil/false to not cache templates (useful for development), defaults
     #           to true unless RACK_ENV is development to automatically use the
     #           default template cache.
+    # :cache_class :: A class to use as the template cache instead of the default.
     # :engine :: The tilt engine to use for rendering, also the default file extension for
     #            templates, defaults to 'erb'.
     # :escape :: Use Roda's Erubis escaping support, which makes <tt><%= %></tt> escape output,
@@ -132,7 +133,14 @@ class Roda
         opts = app.opts[:render]
         opts[:engine] = (opts[:engine] || opts[:ext] || "erb").dup.freeze
         opts[:views] = File.expand_path(opts[:views]||"views", app.opts[:root]).freeze
-        opts[:cache] = app.thread_safe_cache if opts.fetch(:cache, ENV['RACK_ENV'] != 'development')
+
+        if opts.fetch(:cache, ENV['RACK_ENV'] != 'development')
+          if cache_class = opts[:cache_class]
+            opts[:cache] = cache_class.new
+          else
+            opts[:cache] = app.thread_safe_cache
+          end
+        end
 
         opts[:layout_opts] = (opts[:layout_opts] || {}).dup
         opts[:layout_opts][:_is_layout] = true
@@ -182,7 +190,15 @@ class Roda
         def inherited(subclass)
           super
           opts = subclass.opts[:render] = subclass.opts[:render].dup
-          opts[:cache] = thread_safe_cache if opts[:cache]
+
+          if opts[:cache]
+            if cache_class = opts[:cache_class]
+              opts[:cache] = cache_class.new
+            else
+              opts[:cache] = thread_safe_cache
+            end
+          end
+
           opts.freeze
         end
 

data/lib/roda/plugins/websockets.rb

@@ -15,7 +15,7 @@ class Roda
     # is sent to all other users in the same room, using a websocket
     # per room:
     #
-    #   plugin :websockets, :adapter=>:thin, :opts=>{:ping=>45}
+    #   plugin :websockets, :adapter=>:thin, :ping=>45
     #
     #   MUTEX = Mutex.new
     #   ROOMS = {}

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 = 4
+  RodaMinorVersion = 5
 
   # The patch version of Roda, updated only for bug fixes from the last
   # feature release.

data/spec/plugin/assets_spec.rb

@@ -1,16 +1,19 @@
 require File.expand_path("spec_helper", File.dirname(File.dirname(__FILE__)))
 require 'fileutils'
 
+run_tests = true
 begin
   begin
-  require 'tilt/sass'
+    require 'tilt/sass'
   rescue LoadError
-    for lib in %w'tilt sass'
-      require lib
+    begin
+      for lib in %w'tilt sass'
+        require lib
+      end
+    rescue LoadError
+      warn "#{lib} not installed, skipping assets plugin test"
+      run_tests = false
     end
-    run_tests = true
-  rescue LoadError
-    warn "#{lib} not installed, skipping assets plugin test"
   end
 end
 
@@ -263,6 +266,16 @@ if run_tests
       js.must_include('console.log')
     end
 
+    it 'should handle linking to compiled assets when a compiled asset host is used' do
+      app.plugin :assets, :compiled_asset_host=>'https://cdn.example.com'
+      app.compile_assets
+      html = body('/test')
+      html.scan(/<link/).length.must_equal 1
+      html.must_match %r{href="https://cdn\.example\.com/assets/app\.[a-f0-9]{40}\.css"}
+      html.scan(/<script/).length.must_equal 1
+      html.must_match %r{src="https://cdn\.example\.com/assets/app\.head\.[a-f0-9]{40}\.js"}
+    end
+
     it 'should handle compiling assets, linking to them, and accepting requests for them when :gzip is set' do
       app.plugin :assets, :gzip=>true
       app.compile_assets

data/spec/plugin/environments_spec.rb

@@ -28,4 +28,15 @@ describe "environments plugin" do
     app.configure(:test, :production){a << 2}
     a.must_equal [1, app]
   end
+
+  it "defaults environment to RACK_ENV" do
+    with_rack_env('test') do
+      app(:environments){}
+    end
+    app.test?.must_equal true
+    app.development?.must_equal false
+    app(:environments){}
+    app.test?.must_equal false
+    app.development?.must_equal true
+  end
 end

data/spec/plugin/multi_run_spec.rb

@@ -69,4 +69,19 @@ describe "multi_run plugin" do
     @app = a
     body("/b").must_equal 'b2'
   end
+
+  it "yields prefix" do
+    yielded = false
+
+    app(:multi_run) do |r|
+      r.multi_run do |prefix|
+        yielded = prefix
+      end
+    end
+
+    app.run "a", Class.new(Roda).class_eval{route{"a1"}; app}
+
+    body("/a").must_equal "a1"
+    yielded.must_equal "a"
+  end
 end

data/spec/plugin/path_spec.rb

@@ -188,6 +188,15 @@ describe "path plugin" do
     body('c'=>c2.new).must_equal '/c'
   end
 
+  it ":by_name defaults to true in development" do
+    with_rack_env('development') do
+      app(:path){}
+    end
+    app.opts[:path_class_by_name].must_equal true
+    app(:path){}
+    app.opts[:path_class_by_name].must_equal false
+  end
+
   it "Roda.path_block returns the block used" do
     c = Class.new
     b = proc{|x| x.to_s}

data/spec/plugin/render_spec.rb

@@ -324,6 +324,15 @@ describe "render plugin" do
     body('/c').must_equal "3"
   end
 
+  it "Default to :cache=>false in development mode" do
+    with_rack_env('development') do
+      app(:render){}
+    end
+    app.render_opts[:cache].must_equal nil
+    app(:render){}
+    app.render_opts[:cache].wont_equal nil
+  end
+
   it "Support :cache=>false option to disable template caching" do
     app(:bare) do
       plugin :render, :views=>"./spec/views"
@@ -416,5 +425,30 @@ describe "render plugin" do
 
     Class.new(app).render_opts[:cache].must_equal false
   end
+  it "with a cache_class set" do
+    app(:bare) do
+      test_cache = Class.new(Roda::RodaCache) do
+        def [](key)
+          super
+        end
+        def []=(key, value)
+          super
+        end
+        def test_method
+        end
+      end
+
+      plugin :render, :views=>"./spec/views", :cache=>true, :cache_class=>test_cache
+
+      route do |r|
+        view(:inline=>"foo", :layout=>nil)
+      end
+    end
+
+    body("/inline").strip.must_equal "foo"
+
+    Class.new(app).render_opts[:cache].must_respond_to :test_method
+  end
+
 end
 end

data/spec/spec_helper.rb

@@ -75,4 +75,11 @@ class Minitest::Spec
     c.class_eval(&block)
     c
   end
+
+  def with_rack_env(env)
+    ENV['RACK_ENV'] = env
+    yield
+  ensure
+    ENV.delete('RACK_ENV')
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-15 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -141,6 +141,7 @@ extra_rdoc_files:
 - doc/release_notes/2.2.0.txt
 - doc/release_notes/2.3.0.txt
 - doc/release_notes/2.4.0.txt
+- doc/release_notes/2.5.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -156,6 +157,7 @@ files:
 - doc/release_notes/2.2.0.txt
 - doc/release_notes/2.3.0.txt
 - doc/release_notes/2.4.0.txt
+- doc/release_notes/2.5.0.txt
 - lib/roda.rb
 - lib/roda/plugins/_erubis_escaping.rb
 - lib/roda/plugins/all_verbs.rb