scorched 0.5.2 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0950b3928b9921a50ec7af0cb01869412172f09
-  data.tar.gz: b698623e4b6e40a64cf56ac47b7d20be50df4c2f
+  metadata.gz: 9e4ea3f73fb031a956003067b827230358bb5f0e
+  data.tar.gz: e8e9ff7012cd3cfaf471b855daab89f915ce285d
 SHA512:
-  metadata.gz: e528fe6a63bfdd08127ff405e83541a5a6032fa6db1746be18c50a0e9488de6eba591b720fb218fda4378e42b244eba4246be71fb4bc8c384921cdd9c2c2bca8
-  data.tar.gz: 00f71b40921a073e043a985e693e8a2924c93f16a4221a2f5efcf72588d90515846c67151302cd931d1af7fe112884c17f2424c068bbd82e83170de954f1ce12
+  metadata.gz: 2d0da75971382d0108cf9585a55c95a13ce918d9f10ead66eac0c6cd182e710e821456a633830a16728b7d2d37ea3e81f37132dc1a9f5a6ae94ac3466a4eaaf7
+  data.tar.gz: d78bcf8bf3ee287f2fc880da0c6e4d956f2e1b1bb1a34f121127dfe8402eb0f2ebd66f14922e47d3cbd0f5407330fa5a5a4e33f7f4c029b2524cfff28f54d4d8

data/Milestones.md

@@ -3,7 +3,12 @@ Milestones
 
 Changelog
 ---------
+<<<<<<< HEAD
+### v0.6
+* ``view_config`` options hash renamed to ``render_defaults`` which better reflects its function.
+
 ### v0.5.2
+* Minor modification to routing to make it behave as a documented regarding matching at the directly before or on a path.
 * Response content-type now defaults to "text/html;charset=utf-8", rather than empty.
 
 ### v0.5.1
@@ -44,24 +49,24 @@ Changelog
 
 
 
-Remaining
----------
+To Do
+-----
 Some of these remaining features may be broken out into a separate contributor library to keep the core lean and focused.
 
 * Make specs for Collection and Options classes more thorough, e.g. test all non-reading modifiers such as clear, delete, etc.
 * Add view helpers
   * Add helper to easily read and build HTTP query strings. Takes care of "?" and "&" logic, escaping, etc. This is
     intended to make link building easier.
-  * Form populator
-* Provide a default error page somewhat similar to what Sinatra has.
-* Add debug logging to show each routing hop and the current environment (variables, mode, etc)
+  * Form populator implemented with Nokogiri. This would have to be added to a contrib library.
+* Add Verbose logging, including debug logging to show each routing hop and the current environment (variables, mode, etc)
 * Environment optimised defaults
   * Production
-    * Rack::Protection
-    * Disable static file serving
+    * use Rack::Protection
+    * Disable static file serving. Sub-controllers can obviously override this. This will just change the default.
   * Development
-    * Verbose logging to STDOUT
+    * Log to STDOUT
     * use Rack::ShowExceptions
+    * Add developer-friendly 404 error page.
     
 Unlikely
 --------

data/README.md

@@ -28,6 +28,7 @@ And light the flame...
 
     rackup hello_world.ru
 
+_**Note**: Scorched requires Ruby 2.0 as it makes use of a couple of new features. By the time Scorched hits v1.0, there should be little reason not to be running Ruby 2.0._
 
 The Errors of Our Past
 ----------------------

data/docs/02_fundamentals/02_configuration.md

@@ -19,11 +19,18 @@ Each configuration is listed below, with the default value of each included.
     The directory Scorched should serve static files from. Should be set to false if the web server or some other middleware is serving static files.
 * ``config[:logger] = Logger.new(STDOUT)`` - Currently does nothing until logging is added to Scorched.
 
-The follow view configuration options can all be overriden when calling ``render``.
-
-* ``view_config[:dir] = 'views'``  
-    The directory containing all the view templates, relative to the current working directory.
-* ``view_config[:layout] = false``  
-    The default layout to use when rendering views. 
-* ``view_config[:engine] = :erb``  
-    The default rendering engine. This is used when ``render`` is given a filename with no extension, or a string.
+You can also configure the default options when rendering views by setting them on the ``render_defaults`` hash. The options specified here are merged with those provided when calling the ``render`` method, with the explicit options obviously taking precedence over the defaults.
+
+Refer to the _views_ page for more information.
+
+Here is an example of the configuration options in action. A couple of different ways to set the options are shown. Refer to the API documentation for the ``Scorched::Options`` for more information.
+
+    # ruby
+    class MyApp < Scorched::Controller
+      config[:static_dir] = '../public'
+      render_defaults.merge!(
+        dir: 'templates',
+        layout: :main_layout
+        engine: :haml
+      )
+    end

data/docs/02_fundamentals/08_views.md

@@ -1,4 +1,14 @@
 Views
 =====
 
-_More documentation coming soon. Until then, as a tip, the whole view infrastructure of Scorched is implemented as the ``render`` method._
+Scorched uses Tilt to render templates in various supported formats. Because of this, views have been implemented as a single method, ``render``.
+
+``render`` can take a file path or a string as the template. If a symbol is given, it assumes it's a file path, were as a string is assumed to be the template markup. ``render`` can also takes a set of options.
+
+* ``:dir`` - The directory containing the views. This can be absolute or relative to the current working directory.
+* ``:layout`` - The template to render _around_ the view. This results in a subsequent call to ``render``, where this value is sent as the first argument. Layout's inherit the settings of the main template being rendered.
+* ``:engine`` - The template engine to use if it can't be derived from the file name. This is always required for string templates. Can be any string or symbol that Tilt recognises, e.g :erb, :haml, :sass, etc.
+
+Any unrecognised options are passed through to Tilt and the corresponding rendering engine.
+
+Finally, ``render`` takes an optional block to be _yielded_ within the view being rendered, if supported by the rendering engine.

data/lib/scorched/controller.rb

@@ -1,7 +1,7 @@
 module Scorched
   class Controller
     include Scorched::Options('config')
-    include Scorched::Options('view_config')
+    include Scorched::Options('render_defaults')
     include Scorched::Options('conditions')
     include Scorched::Collection('middleware')
     include Scorched::Collection('before_filters')
@@ -14,7 +14,7 @@ module Scorched
       :logger => Logger.new(STDOUT)
     }
     
-    view_config << {
+    render_defaults << {
       :dir => 'views', # The directory containing all the view templates, relative to the current working directory.
       :layout => false, # The default layout template to use, relative to the view directory. Set to false for no default layout.
       :engine => :erb
@@ -118,25 +118,25 @@ module Scorched
       end
       
       # Generates and returns a new route proc from the given block, and optionally maps said proc using the given args.
-      def route(pattern = nil, priority = nil, **conditions, &block)
+      def route(pattern = nil, priority = nil, **conds, &block)
         target = lambda do |env|
           env['scorched.response'].body = instance_exec(*env['scorched.request'].captures, &block)
           env['scorched.response']
         end
-        self << {pattern: compile(pattern, true), priority: priority, conditions: conditions, target: target} if pattern
+        self << {pattern: compile(pattern, true), priority: priority, conditions: conds, target: target} if pattern
         target
       end
 
       ['get', 'post', 'put', 'delete', 'head', 'options', 'patch'].each do |method|
         methods = (method == 'get') ? ['GET', 'HEAD'] : [method.upcase]
-        define_method(method) do |*args, **conditions, &block|
-          conditions.merge!(methods: methods)
-          route(*args, **conditions, &block)
+        define_method(method) do |*args, **conds, &block|
+          conds.merge!(methods: methods)
+          route(*args, **conds, &block)
         end
       end
       
-      def filter(type, *args, **conditions, &block)
-        filters[type.to_sym] << {args: args, conditions: conditions, proc: block}
+      def filter(type, *args, **conds, &block)
+        filters[type.to_sym] << {args: args, conditions: conds, proc: block}
       end
       
       # A bit of syntactic sugar for #filter.
@@ -328,13 +328,13 @@ module Scorched
     end
     
     # Renders the given string or file path using the Tilt templating library.
-    # Options hash is merged with the controllers _view_config_. Tilt template options are passed through. 
-    # The template engine is derived from file name, or otherwise as specified by the _:engine_ option. If String is
-    # given, _:engine_ option must be set.
+    # The options hash is merged with the controllers _render_defaults_. Unrecognised options are passed through to Tilt. 
+    # The template engine is derived from file name, or otherwise as specified by the _:engine_ option. If a string is
+    # given, the _:engine_ option must be set.
     #
     # Refer to Tilt documentation for a list of valid template engines.
     def render(string_or_file, options = {}, &block)
-      options = view_config.merge(explicit_options = options)
+      options = render_defaults.merge(explicit_options = options)
       engine = (derived_engine = Tilt[string_or_file.to_s]) || Tilt[options[:engine]]
       raise Error, "Invalid or undefined template engine: #{options[:engine].inspect}" unless engine
       if Symbol === string_or_file

data/lib/scorched/version.rb

@@ -1,3 +1,3 @@
 module Scorched
-  VERSION = '0.5.2'
+  VERSION = '0.6'
 end

data/spec/controller_spec.rb

@@ -585,7 +585,7 @@ module Scorched
       
       describe "rendering" do
         before(:each) do
-          app.view_config.each { |k,v| app.view_config[k] = nil }
+          app.render_defaults.each { |k,v| app.render_defaults[k] = nil }
         end
 
         it "can render a file, relative to the application root" do
@@ -630,14 +630,14 @@ module Scorched
           app.get('/full_path') do
             render(:'views/main.erb', {layout: :'views/layout.erb', dir: nil}).should == "(3 for me)"
           end
-          app.view_config[:dir] = 'views'
+          app.render_defaults[:dir] = 'views'
           rt.get('/')
           rt.get('/full_path')
         end
 
         it "derived template engine overrides specified engine" do
-          app.view_config[:dir] = 'views'
-          app.view_config[:engine] = :erb
+          app.render_defaults[:dir] = 'views'
+          app.render_defaults[:engine] = :erb
           app.get('/str') do
             render(:'other.str').should == "hello hello"
           end
@@ -653,7 +653,7 @@ module Scorched
         end
 
         it "ignores default layout when called within a view" do
-          app.view_config << {:dir => 'views', :layout => :layout, :engine => :erb}
+          app.render_defaults << {:dir => 'views', :layout => :layout, :engine => :erb}
           app.get('/') do
             render :composer
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scorched
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: '0.6'
 platform: ruby
 authors:
 - Tom Wardrop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000 Z
+date: 2013-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack