roda 2.22.0 → 2.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bf01ef06d46bc9ee153b2b737b44a19b6dc8e3f
-  data.tar.gz: 32979a928ec7cc15994b5c1a937b8601946f6451
+  metadata.gz: c091dcf6b8bb44694c2ea16a6244e3534662e2ed
+  data.tar.gz: cff4ce05dd629994658d4470bf2d3f339b6c11c7
 SHA512:
-  metadata.gz: d730f1511a4c437b8f5bc8e3df705a2286703277ab22a985e9d331de934c8c30810f657fe06510b928f731086d824fdbd2b1996833751085fef898ecd540507d
-  data.tar.gz: 39d8d2b3c9b26f610d212b00ce087973030d17a1aadc0867baf0a613a1dfb9d1f54a8bc1792dad30802dcc305b1850cfab8a67052591c5699926389ab90ca591
+  metadata.gz: 4571d9602f0a17a330110bfcb4c319ff1c36476b16f8a488c0c081c5e651ddcbd8fe2df7c6d01f667dcc30445946f91131820e48fc22340c32a3465e21d5b756
+  data.tar.gz: d7d6fc717405752f1b4eabd14fc23587f4cf2d9c25db32ab6f9425f1a67cda19ea0cb84a0c42173f07cdf722b0c8ab0b962d74fb898fc47fd5ae9382406c7995

data/CHANGELOG

@@ -1,3 +1,17 @@
+= 2.23.0 (2017-02-24)
+
+* Add :inherit_cache render plugin option, to create a copy of the cache for subclasses, instead of using an empty cache (jeremyevans)
+
+* In development mode, default to :explicit_cache=>true, :cache=>true instead of :cache=>false (jeremyevans)
+
+* Add :explicit_cache render plugin option, to only cache templates if the :cache option is given to render/view (jeremyevans)
+
+* Add error_email_content method to error_email plugin (jeremyevans)
+
+* Make error_email method in error_email plugin support non-exception arguments (jeremyevans)
+
+* Make Roda.freeze in the static_routing plugin return self (jeremyevans)
+
 = 2.22.0 (2017-01-20)
 
 * Add support for :verbatim_string_matcher option, for making all string matchers match verbatim (jeremyevans)

data/doc/conventions.rdoc

@@ -23,11 +23,11 @@ For a small application, the following directory layout is recommended:
   views/
 
 +app_name.rb+ should contain the Roda application, and should reflect the name of your application.
-So if your application is named +FooBar+, you should use +foo_bar.rb+.
+So, if your application is named +FooBar+, you should use +foo_bar.rb+.
 
 +views/+ should contain your template files.  This assumes you are using the +render+ plugin
 and server-side rendering.  If you are creating a single page application and just serving
-JSON, then you won't need a +views+ directory.  For small applications, all view files should
+JSON, then you won't need a +views+ directory.  For small applications, all view files should be
 in the +views+ directory.
 
 +public/+ should contain any static files that should be served directly by the webserver.

data/doc/release_notes/2.23.0.txt

@@ -0,0 +1,29 @@
+= New Features
+
+* An :explicit_cache option has been added to the render plugin.
+  This is similar to the :cache=>false option, but instead of
+  disabling caching completely, this disables caching by default but
+  allows for explicit caching of templates by providing the :cache
+  option to view/render.
+
+  In development mode, Roda now defaults to :explicit_cache=>true
+  instead of :cache=>false.
+
+* An :inherit_cache option has been added to the render plugin,
+  making subclasses of that class start with a dup of the template
+  cache, instead of starting with an empty template cache.  This can
+  result in less memory used.
+
+* Roda#error_email in the error_email plugin now accepts non-Exception
+  arguments (such as strings).  This can be useful in conditions that
+  are errors you may want to notify about, where an exception hasn't
+  been raised.
+
+* Roda#error_email_content has been added to the error_email plugin.
+  This can be used to create the email message, which can be delivered
+  via another mechanism, and may make testing easier.
+
+= Other Improvements
+
+* Roda.freeze in the static_routing plugin now returns self, fixing
+  code such as Roda.freeze.app.

data/lib/roda.rb

@@ -29,6 +29,16 @@ class Roda
     def []=(key, value)
       @mutex.synchronize{@hash[key] = value}
     end
+
+    private
+
+    # Create a copy of the cache with a separate mutex.
+    def initialize_copy(other)
+      @mutex = Mutex.new
+      other.instance_variable_get(:@mutex).synchronize do
+        @hash = other.instance_variable_get(:@hash).dup
+      end
+    end
   end
 
   # Base class used for Roda requests.  The instance methods for this

data/lib/roda/plugins/error_email.rb

@@ -25,6 +25,8 @@ class Roda
     # The subject of the error email shows the exception class and message.
     # The body of the error email shows the backtrace of the error and the
     # request environment, as well the request params and session variables (if any).
+    # You can also call error_email with a plain string instead of an exception,
+    # in which case the string is used as the subject, and no backtrace is included.
     #
     # Note that emailing on every error as shown above is only appropriate
     # for low traffic web applications.  For high traffic web applications,
@@ -38,7 +40,12 @@ class Roda
         :emailer=>lambda{|h| Net::SMTP.start(h[:host]){|s| s.send_message(h[:message], h[:from], h[:to])}},
         # :nocov:
         :default_headers=>lambda do |h, e|
-          {'From'=>h[:from], 'To'=>h[:to], 'Subject'=>"#{h[:prefix]}#{e.class}: #{e.message}"}
+          subject = if e.respond_to?(:message)
+            "#{e.class}: #{e.message}"
+          else
+            e.to_s
+          end
+          {'From'=>h[:from], 'To'=>h[:to], 'Subject'=>"#{h[:prefix]}#{subject}"}
         end,
         :body=>lambda do |s, e|
           format = lambda{|h| h.map{|k, v| "#{k.inspect} => #{v.inspect}"}.sort.join("\n")}
@@ -47,14 +54,21 @@ class Roda
           message << <<END
 Path: #{s.request.path}
 
+END
+          if e.respond_to?(:backtrace)
+            message << <<END
 Backtrace:
 
 #{e.backtrace.join("\n")}
+END
+          end
 
+          message << <<END
 ENV:
 
 #{format[s.env]}
 END
+
           unless s.request.params.empty?
             message << <<END
 
@@ -91,15 +105,24 @@ END
       end
 
       module InstanceMethods
-        # Send an email for the given error.
-        def error_email(e)
+        # Send an email for the given error.  +exception+ is usually an exception
+        # instance, but it can be a plain string which is used as the subject for
+        # the email.
+        def error_email(exception)
           email_opts = self.class.opts[:error_email].dup
-          headers = email_opts[:default_headers].call(email_opts, e)
+          email_opts[:message] = error_email_content(exception)
+          email_opts[:emailer].call(email_opts)
+        end
+
+        # The content of the email to send, include the headers and the body.
+        # Takes the same argument as #error_email.
+        def error_email_content(exception)
+          email_opts = self.class.opts[:error_email]
+          headers = email_opts[:default_headers].call(email_opts, exception)
           headers = Hash[headers].merge!(email_opts[:headers])
           headers = headers.map{|k,v| "#{k}: #{v.gsub(/\r?\n/m, "\r\n ")}"}.sort.join("\r\n")
-          body = email_opts[:body].call(self, e)
-          email_opts[:message] = "#{headers}\r\n\r\n#{body}"
-          email_opts[:emailer].call(email_opts)
+          body = email_opts[:body].call(self, exception)
+          "#{headers}\r\n\r\n#{body}"
         end
       end
     end

data/lib/roda/plugins/multi_route.rb

@@ -9,8 +9,8 @@ class Roda
     # and if the named route does handle the request, the response returned by
     # the named route will be returned.
     #
-    # In addition, this also adds the +r.multi_route+ method, which will assume
-    # check if the first segment in the path matches a named route, and dispatch
+    # In addition, this plugin adds the +r.multi_route+ method, which will check
+    # if the first segment in the path matches a named route, and dispatch
     # to that named route.
     #
     # Example:

data/lib/roda/plugins/render.rb

@@ -48,9 +48,7 @@ class Roda
     #
     # :allowed_paths :: Set the template paths to allow if +:check_paths+ is true.
     #                   Defaults to the +:views+ directory.
-    # :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 :: nil/false to disallow template caching completely.
     # :cache_class :: A class to use as the template cache instead of the default.
     # :check_paths :: Check template paths start with one of the entries in +:allowed_paths+,
     #                 and raise a RodaError if the path doesn't.
@@ -64,6 +62,11 @@ class Roda
     # :escaper :: Object used for escaping output of <tt><%= %></tt>, when :escape=>true is used,
     #             overriding the default.  If given, object should respond to +escape_xml+ with
     #             a single argument and return an output string.
+    # :explicit_cache :: Only use the template cache if the :cache option is provided when rendering
+    #                    (useful for development). Defaults to true if RACK_ENV is development, allowing explicit
+    #                    caching of specific templates, but not caching by default.
+    # :inherit_cache :: Whether to create a dup of the cache in subclasses.  The default is false, which
+    #                   starts subclasses with an empty cache.
     # :layout :: The base name of the layout file, defaults to 'layout'.  This can be provided as a hash
     #            with the :template or :inline options.
     # :layout_opts :: The options to use when rendering the layout, if different
@@ -165,7 +168,7 @@ class Roda
         opts[:allowed_paths] ||= [opts[:views]].freeze
         opts[:allowed_paths] = opts[:allowed_paths].map{|f| ::File.expand_path(f)}.uniq.freeze
 
-        if opts.fetch(:cache, ENV['RACK_ENV'] != 'development')
+        if opts.fetch(:cache, true)
           if cache_class = opts[:cache_class]
             opts[:cache] = cache_class.new
           else
@@ -173,6 +176,8 @@ class Roda
           end
         end
 
+        opts[:explicit_cache] = ENV['RACK_ENV'] == 'development' unless opts.has_key?(:explicit_cache)
+
         opts[:layout_opts] = (opts[:layout_opts] || {}).dup
         opts[:layout_opts][:_is_layout] = true
 
@@ -231,7 +236,9 @@ class Roda
           opts = subclass.opts[:render] = subclass.opts[:render].dup
 
           if opts[:cache]
-            if cache_class = opts[:cache_class]
+            opts[:cache] = if opts[:inherit_cache]
+              opts[:cache] = opts[:cache].dup
+            elsif cache_class = opts[:cache_class]
               opts[:cache] = cache_class.new
             else
               opts[:cache] = thread_safe_cache
@@ -285,7 +292,7 @@ class Roda
         # If caching templates, attempt to retrieve the template from the cache.  Otherwise, just yield
         # to get the template.
         def cached_template(opts, &block)
-          if (cache = render_opts[:cache]) && (key = opts[:cache_key])
+          if (!render_opts[:explicit_cache] || opts[:cache]) && (cache = render_opts[:cache]) && (key = opts[:cache_key])
             unless template = cache[key]
               template = cache[key] = yield
             end

data/lib/roda/plugins/static_routing.rb

@@ -56,9 +56,9 @@ class Roda
       module ClassMethods
         # Freeze the static route metadata when freezing the app.
         def freeze
-          super
           opts[:static_routes].freeze
           opts[:static_routes].each_value(&:freeze)
+          super
         end
 
         # Duplicate static route metadata in subclass.

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

data/spec/plugin/error_email_spec.rb

@@ -7,7 +7,8 @@ describe "error_email plugin" do
       plugin :error_email, {:to=>'t', :from=>'f', :emailer=>lambda{|h| emails << h}}.merge(opts)
 
       route do |r|
-        raise ArgumentError rescue error_email($!)
+        r.get('noerror'){error_email("Problem"); 'g'}
+        raise ArgumentError, 'bad foo' rescue error_email($!)
         'e'
       end
     end
@@ -23,10 +24,30 @@ describe "error_email plugin" do
     email[:to].must_equal 't'
     email[:from].must_equal 'f'
     email[:host].must_equal 'localhost'
-    email[:message].must_match(/^Subject: ArgumentError/)
+    email[:message].must_match(/^Subject: ArgumentError: bad foo/)
     email[:message].must_match(/^Backtrace:$.+^ENV:$.+^"rack\.input" => .+^Params:$\s+^"b" => "c"$\s+^Session:$\s+^"d" => "e"$/m)
   end
 
+  it "have error_email method support string arguments" do
+    app
+    body('/noerror', 'rack.input'=>StringIO.new, 'QUERY_STRING'=>'b=c', 'rack.session'=>{'d'=>'e'}).must_equal 'g'
+    email[:to].must_equal 't'
+    email[:from].must_equal 'f'
+    email[:host].must_equal 'localhost'
+    email[:message].must_match(/^Subject: Problem/)
+    email[:message].must_match(/^ENV:$.+^"rack\.input" => .+^Params:$\s+^"b" => "c"$\s+^Session:$\s+^"d" => "e"$/m)
+    email[:message].wont_include('Backtrace')
+  end
+
+  it "supports error_email_content for the content of the email" do
+    app.route do |r|
+      raise ArgumentError, 'bad foo' rescue error_email_content($!)
+    end
+    b = body('rack.input'=>StringIO.new, 'QUERY_STRING'=>'b=c', 'rack.session'=>{'d'=>'e'})
+    b.must_match(/^Subject: ArgumentError: bad foo/)
+    b.must_match(/^Backtrace:$.+^ENV:$.+^"rack\.input" => .+^Params:$\s+^"b" => "c"$\s+^Session:$\s+^"d" => "e"$/m)
+  end
+
   it "uses :host option" do
     app(:host=>'foo.bar.com')
     body('rack.input'=>StringIO.new).must_equal 'e'

data/spec/plugin/render_spec.rb

@@ -353,13 +353,13 @@ describe "render plugin" do
     body('/c').must_equal "3"
   end
 
-  it "Default to :cache=>false in development mode" do
+  it "Default to :explicit_cache=>true in development mode" do
     with_rack_env('development') do
       app(:render){}
     end
-    app.render_opts[:cache].must_be_nil
+    app.render_opts[:explicit_cache].must_equal true
     app(:render){}
-    app.render_opts[:cache].wont_equal nil
+    app.render_opts[:explicit_cache].must_equal false
   end
 
   it "Support :cache=>false option to disable template caching" do
@@ -379,6 +379,57 @@ describe "render plugin" do
     app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].wont_equal nil
   end
 
+  it "Support :cache=>false option to disable template caching even when :cache_key is given" do
+    app(:bare) do
+      plugin :render, :views=>"./spec/views"
+
+      route do |r|
+        @a = 'a'
+        r.is('a'){render('iv', :cache=>false, :cache_key=>:foo)}
+        render('iv', :cache_key=>:foo)
+      end
+    end
+
+    body('/a').strip.must_equal "a"
+    app.render_opts[:cache][:foo].must_be_nil
+    body('/b').strip.must_equal "a"
+    app.render_opts[:cache][:foo].wont_equal nil
+  end
+
+  it "Support :explicit_cache option to disable caching by default, but still allow caching on a per-call basis" do
+    app(:bare) do
+      plugin :render, :views=>"./spec/views", :explicit_cache=>true
+
+      route do |r|
+        @a = 'a'
+        r.is('a'){render('iv')}
+        render('iv', :cache=>true)
+      end
+    end
+
+    body('/a').strip.must_equal "a"
+    app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].must_be_nil
+    body('/b').strip.must_equal "a"
+    app.render_opts[:cache][File.expand_path('spec/views/iv.erb')].wont_equal nil
+  end
+
+  it "Support :explicit_cache plugin option with :cache_key render option" do
+    app(:bare) do
+      plugin :render, :views=>"./spec/views", :explicit_cache=>true
+
+      route do |r|
+        @a = 'a'
+        r.is('a'){render('iv', :cache_key=>:foo)}
+        render('iv', :cache=>true, :cache_key=>:foo)
+      end
+    end
+
+    body('/a').strip.must_equal "a"
+    app.render_opts[:cache][:foo].must_be_nil
+    body('/b').strip.must_equal "a"
+    app.render_opts[:cache][:foo].wont_equal nil
+  end
+
   it "Support :cache=>true option to enable template caching when :template_block is used" do
     c = Class.new do 
       def initialize(path, *, &block)
@@ -437,23 +488,36 @@ describe "render plugin" do
     body.must_equal "1-2"
   end
 
-  it "render_opts inheritance" do
+  it "should dup render_opts when subclasses, including an empty cache" do
     c = Class.new(Roda)
     c.plugin :render
+    c.render_opts[:cache][:foo] = 1
+    sc = Class.new(c)
+
+    c.render_opts.wont_be_same_as(sc.render_opts)
+    c.render_opts[:cache].wont_be_same_as(sc.render_opts[:cache])
+    sc.render_opts[:cache][:foo].must_be_nil
+  end
+
+  it "should use same render_opts as superclass when inheriting if :inherit_cache option is used" do
+    c = Class.new(Roda)
+    c.plugin :render, :inherit_cache=>true
+    c.render_opts[:cache][:foo] = 1
     sc = Class.new(c)
 
     c.render_opts.wont_be_same_as(sc.render_opts)
     c.render_opts[:cache].wont_be_same_as(sc.render_opts[:cache])
+    sc.render_opts[:cache][:foo].must_equal 1
   end
 
-  it "render plugin call should not override options" do
+  it "render plugin call should not override existing options" do
     c = Class.new(Roda)
     c.plugin :render, :layout=>:foo
     c.plugin :render
     c.render_opts[:layout].must_equal :foo
   end
 
-  it "with caching disabled" do
+  it "should not use cache in subclass if caching disabled in superclass" do
     app(:bare) do
       plugin :render, :views=>"./spec/views", :cache=>false
       

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roda
 version: !ruby/object:Gem::Version
-  version: 2.22.0
+  version: 2.23.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-20 00:00:00.000000000 Z
+date: 2017-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -202,6 +202,7 @@ extra_rdoc_files:
 - doc/release_notes/2.20.0.txt
 - doc/release_notes/2.21.0.txt
 - doc/release_notes/2.22.0.txt
+- doc/release_notes/2.23.0.txt
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -228,6 +229,7 @@ files:
 - doc/release_notes/2.20.0.txt
 - doc/release_notes/2.21.0.txt
 - doc/release_notes/2.22.0.txt
+- doc/release_notes/2.23.0.txt
 - doc/release_notes/2.3.0.txt
 - doc/release_notes/2.4.0.txt
 - doc/release_notes/2.5.0.txt