racket-mvc 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d06a12ceb8db8f9e2cafd0d649048e03da1e7644
-  data.tar.gz: 7534148f29e1c2c00b65800c4b1fa41ea3705a08
+  metadata.gz: 29d1cf6f2b573f99dc79d38f46c61bbc877b81c6
+  data.tar.gz: 114fceb1c2ff59e31a94b1300c1efbad34fc78cc
 SHA512:
-  metadata.gz: a929335cdea51bbabbc0f0531de67cacf63177ec042f33dfd373454c2284e06603da7ee50b188584d76db7de02572bb99de0cbfdeb57259e903b2feb4d4470c0
-  data.tar.gz: bb0f3f128237c989d4937d612d5c0b6dc9d248f72e7233fc5900672526d9c72760816ba2fa53ed50c784bcb1dbf2e602b00237e9bca07a7a06d0e89afe2cbb18
+  metadata.gz: fb0558de22c5ed965ea8955caa8aac5309cadaa4ed80f01d08cce38666575f3715bd3a84dd1d6e005d94aa191cc433cd5a123cf73169cfba005b9497094f7aff
+  data.tar.gz: b1b51dc4dcf51d057d472f1897b0e9cd92be66dad8abe06fe9eb7127bedc8e0122d3a58787acc2aee77027831abb0bbcab82bbff1bb85e64191675908062da0e

data/README.md

@@ -26,9 +26,9 @@ whenever I am finished porting most of my old apps from Ramaze.
 Have a look in the `spec` directory. The code base have tests covering 100 per cent of the code and I am planning on keeping it that way. At the moment the code is tested on the following platforms (using [Travis CI](https://travis-ci.org/)):
 
 - ruby 1.9.3
-- ruby 2.0
-- ruby 2.1.6
-- ruby 2.2.2
+- ruby 2.0.0
+- ruby 2.1.7
+- ruby 2.2.3
 - jruby 1.7 (1.9 mode only)
 - jruby 9.0.0.0
 - rbx-2 (latest version)

data/Rakefile

@@ -1,20 +1,30 @@
 require 'rubygems'
 require 'bundler/setup'
 
-task default: %w[test]
+desc "Run bacon tests"
+task default: [:test]
 
+desc "Build racket-mvc gem"
 task :build_gem do
   exec 'gem build racket.gemspec'
 end
 
+desc "Build yard docs"
 task :doc do
   exec 'yard'
 end
 
+desc "Show list of undocumented modules/classes/methods"
 task :nodoc do
   exec 'yard stats --list-undoc'
 end
 
+desc "Publish racket-mvc gem"
+task publish_gem: [:build_gem] do
+  exec 'gem push racket-mvc.gem'
+end
+
+desc "Run bacon tests"
 task :test do
   exec 'bacon spec/racket.rb'
 end

data/lib/racket.rb

@@ -26,7 +26,7 @@ require_relative 'racket/request.rb'
 require_relative 'racket/response.rb'
 require_relative 'racket/router.rb'
 require_relative 'racket/session.rb'
-require_relative 'racket/view_cache.rb'
+require_relative 'racket/view_manager.rb'
 require_relative 'racket/utils.rb'
 
 # Racket main namespace

data/lib/racket/application.rb

@@ -66,7 +66,7 @@ module Racket
         default_action: :index,
         default_content_type: 'text/html',
         default_controller_helpers: [:routing, :view],
-        default_layout: '_default.*',
+        default_layout: nil,
         default_view: nil,
         helper_dir: Utils.build_path(root_dir, 'helpers'),
         layout_dir: Utils.build_path(root_dir, 'layouts'),
@@ -202,7 +202,7 @@ module Racket
     # @return [nil]
     def self.reload
       setup_routes
-      @view_cache = nil
+      @view_manager = nil
     end
 
     # Requires a file using the current application directory as a base path.
@@ -258,9 +258,9 @@ module Racket
 
     # Returns the view cache of the currently running application.
     #
-    # @return [ViewCache]
-    def self.view_cache
-      @view_cache ||= ViewCache.new(@options[:layout_dir], @options[:view_dir])
+    # @return [Racket::ViewManager]
+    def self.view_manager
+      @view_manager ||= ViewManager.new(@options[:layout_dir], @options[:view_dir])
     end
 
     private_class_method :application, :default_options, :expand_paths, :inform, :init,

data/lib/racket/controller.rb

@@ -191,7 +191,7 @@ module Racket
       __run_hook(:before)
       __run_action
       __run_hook(:after)
-      Application.view_cache.render(self)
+      Application.view_manager.render(self)
     end
 
     private

data/lib/racket/version.rb

@@ -25,7 +25,7 @@ module Racket
     # Minor version
     MINOR = 2
     # Teeny version
-    TEENY = 0
+    TEENY = 1
     # Is it a prerelease?
     PRERELEASE = false
 

data/lib/racket/view_manager.rb

@@ -0,0 +1,166 @@
+# Racket - The noisy Rack MVC framework
+# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+#
+# This file is part of Racket.
+#
+# Racket is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Racket is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+#
+# You should have received a copy of the GNU Affero General Public License
+# along with Racket.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'tilt'
+
+module Racket
+  # Handles rendering in Racket applications.
+  class ViewManager
+
+    attr_reader :layout_cache
+    attr_reader :view_cache
+
+    def initialize(layout_base_dir, view_base_dir)
+      @layout_base_dir = layout_base_dir
+      @view_base_dir = view_base_dir
+      @layout_cache = {}
+      @view_cache = {}
+    end
+
+    # Renders a controller based on the request path and the variables set in the
+    # controller instance.
+    #
+    # @param [Controller] controller
+    # @return [Hash]
+    def render(controller)
+      template_path = get_template_path(controller)
+      view = get_view(template_path, controller)
+      if view
+        output = Tilt.new(view).render(controller)
+        layout = get_layout(template_path, controller)
+        output = Tilt.new(layout).render(controller) { output } if layout
+      else
+        output = controller.racket.action_result
+      end
+      controller.response.write(output)
+      controller.response.finish
+    end
+
+    private
+
+    def get_template_path(controller)
+      template_path = [Application.get_route(controller.class), controller.racket.action].join('/')
+      template_path = template_path[1..-1] if template_path.start_with?('//')
+      template_path
+    end
+
+    # Calls a template proc. Depending on how many parameters the template proc takes, different
+    # types of information will be passed to the proc.
+    # If the proc takes zero parameters, no information will be passed.
+    # If the proc takes one parameter, it will contain the current action.
+    # If the proc takes two parameters, they will contain the current action and the current params.
+    # If the proc takes three parameters, they will contain the current action, the current params
+    #  and the current request.
+    #
+    # @param [Proc] proc
+    # @param [Racket::Controller] controller
+    # @return [String]
+    def call_template_proc(proc, controller)
+      possible_proc_args = [controller.racket.action, controller.racket.params, controller.request]
+      proc_args = []
+      1.upto(proc.arity) { proc_args.push(possible_proc_args.shift) }
+      proc.call(*proc_args).to_s
+    end
+
+    # Tries to locate a layout matching +path+ in the file system and returns the path if a
+    # matching file is found. If no matching file is found, +nil+ is returned. The result is cached,
+    # meaning that the filesystem lookup for a specific path will only happen once.
+    #
+    # @param [String] path
+    # @param [Racket::Controller] controller
+    # @return [String|nil]
+    def get_layout(path, controller)
+      unless @layout_cache.key?(path)
+        layout = lookup_template(@layout_base_dir, path)
+        layout =
+          lookup_default_template(
+            @layout_base_dir, File.dirname(path), controller.controller_option(:default_layout)
+          ) unless layout
+        Application.inform_dev(
+          "Using layout #{layout.inspect} for #{controller.class}.#{controller.racket.action}."
+        )
+        @layout_cache[path] = layout
+      end
+      layout = @layout_cache[path]
+      if layout.is_a?(Proc)
+        layout =
+          lookup_template(
+            @layout_base_dir,
+            [File.dirname(path), call_template_proc(layout, controller)].join('/')
+          )
+      end
+      layout
+    end
+
+    # Tries to locate a view matching +path+ in the file system and returns the path if a
+    # matching file is found. If no matching file is found, +nil+ is returned. The result is cached,
+    # meaning that the filesystem lookup for a specific path will only happen once.
+    #
+    # @param [String] path
+    # @param [Racket::Controller] controller
+    # @return [String|nil]
+    def get_view(path, controller)
+      unless @view_cache.key?(path)
+        view = lookup_template(@view_base_dir, path)
+        view =
+          lookup_default_template(
+            @view_base_dir, File.dirname(path), controller.controller_option(:default_view)
+          ) unless view
+        Application.inform_dev(
+          "Using view #{view.inspect} for #{controller.class}.#{controller.racket.action}."
+        )
+        @view_cache[path] = view
+      end
+      view = @view_cache[path]
+      if view.is_a?(Proc)
+        view =
+          lookup_template(
+            @view_base_dir,
+            [File.dirname(path), call_template_proc(view, controller)].join('/')
+          )
+      end
+      view
+    end
+
+    def lookup_default_template(base_path, path, default)
+      return lookup_template(base_path, File.join(path, default.to_s)) if
+        default.is_a?(String) || default.is_a?(Symbol)
+      default
+    end
+
+    # Locates a file in the filesystem matching an URL path. If there exists a matching file, the
+    # path to it is returned. If there is no matching file, +nil+ is returned.
+    #
+    # @param [String] base_path
+    # @param [String] path
+    # @return [String|nil]
+    def lookup_template(base_path, path)
+      file_path = File.join(base_path, path)
+      action = File.basename(file_path)
+      file_path = File.dirname(file_path)
+      return nil unless Utils.dir_readable?(file_path)
+      matcher = File.extname(action).empty? ? "#{action}.*" : action
+      Dir.chdir(file_path) do
+        files = Pathname.glob(matcher)
+        return nil if files.empty?
+        final_path = File.join(file_path, files.first.to_s)
+        Utils.file_readable?(final_path) ? final_path : nil
+      end
+    end
+  end
+end

data/spec/_custom.rb

@@ -106,4 +106,16 @@ describe 'A custom Racket test Application' do
     last_response.headers.key?('Content-Disposition').should.equal(false)
     last_response.body.should.equal("Not Found")
   end
+
+  it 'should be able to handle dynamic layouts and views' do
+    get '/sub4/foo'
+    last_response.status.should.equal(200)
+    last_response.body.should.equal("LAYOUT: myfoo: FOO\n\n")
+    get '/sub4/bar'
+    last_response.status.should.equal(200)
+    last_response.body.should.equal("LAYOUT: mybar: BAR\n\n")
+    get '/sub4/baz'
+    last_response.status.should.equal(200)
+    last_response.body.should.equal("LAYOUT: default: BAZ\n\n")
+  end
 end

data/spec/test_custom_app/controllers/sub4/default_sub_controller_4.rb

@@ -0,0 +1,26 @@
+class CustomSubController4 < Racket::Controller
+
+  set_option  :default_layout, lambda { 'layout.erb' }
+
+  set_option  :default_view,
+              lambda { |action|
+                case action
+                when :foo then 'myfoo.erb'
+                when :bar then 'mybar.erb'
+                else 'default.erb'
+                end
+              }
+
+  def foo
+    @data = 'FOO'
+  end
+
+  def bar
+    @data = 'BAR'
+  end
+
+  def baz
+    @data = 'BAZ'
+  end
+
+end

data/spec/test_custom_app/layouts/sub4/layout.erb

@@ -0,0 +1 @@
+LAYOUT: <%=yield%>

data/spec/test_custom_app/templates/sub4/default.erb

@@ -0,0 +1 @@
+default: <%=@data%>

data/spec/test_custom_app/templates/sub4/mybar.erb

@@ -0,0 +1 @@
+mybar: <%=@data%>

data/spec/test_custom_app/templates/sub4/myfoo.erb

@@ -0,0 +1 @@
+myfoo: <%=@data%>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: racket-mvc
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Lars Olsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-21 00:00:00.000000000 Z
+date: 2015-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_router
@@ -158,7 +158,7 @@ files:
 - lib/racket/session.rb
 - lib/racket/utils.rb
 - lib/racket/version.rb
-- lib/racket/view_cache.rb
+- lib/racket/view_manager.rb
 - spec/_custom.rb
 - spec/_default.rb
 - spec/_invalid.rb
@@ -168,12 +168,17 @@ files:
 - spec/test_custom_app/controllers/sub2/custom_sub_controller_2.rb
 - spec/test_custom_app/controllers/sub3/custom_sub_controller_3.rb
 - spec/test_custom_app/controllers/sub3/inherited/custom_inherited_controller.rb
+- spec/test_custom_app/controllers/sub4/default_sub_controller_4.rb
 - spec/test_custom_app/extra/blob.rb
 - spec/test_custom_app/extra/blob/inner_blob.rb
 - spec/test_custom_app/files/plain_text.txt
 - spec/test_custom_app/files/secret.erb
 - spec/test_custom_app/layouts/sub2/zebra.erb
+- spec/test_custom_app/layouts/sub4/layout.erb
 - spec/test_custom_app/templates/sub2/template.erb
+- spec/test_custom_app/templates/sub4/default.erb
+- spec/test_custom_app/templates/sub4/mybar.erb
+- spec/test_custom_app/templates/sub4/myfoo.erb
 - spec/test_default_app/controllers/default_root_controller.rb
 - spec/test_default_app/controllers/sub1/default_sub_controller_1.rb
 - spec/test_default_app/controllers/sub2/default_sub_controller_2.rb
@@ -200,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Racket - The noisy Rack MVC framework

data/lib/racket/view_cache.rb

@@ -1,107 +0,0 @@
-# Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
-#
-# This file is part of Racket.
-#
-# Racket is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Affero General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# Racket is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Affero General Public License for more details.
-#
-# You should have received a copy of the GNU Affero General Public License
-# along with Racket.  If not, see <http://www.gnu.org/licenses/>.
-
-require 'tilt'
-
-module Racket
-  # Handles rendering in Racket applications.
-  class ViewCache
-    def initialize(layout_base_dir, template_base_dir)
-      @layout_base_dir = layout_base_dir
-      @template_base_dir = template_base_dir
-      @layouts_by_path = {}
-      @templates_by_path = {}
-    end
-
-    # Renders a controller based on the request path and the variables set in the
-    # controller instance.
-    #
-    # @param [Controller] controller
-    # @return [Hash]
-    def render(controller)
-      template_path = [Application.get_route(controller.class), controller.racket.action].join('/')
-      template_path = template_path[1..-1] if template_path.start_with?('//')
-      template =
-        find_template(template_path, controller.controller_option(:default_view))
-      if template
-        output = Tilt.new(template).render(controller)
-        layout =
-          find_layout(template_path, controller.controller_option(:default_layout))
-        output = Tilt.new(layout).render(controller) { output } if layout
-      else
-        output = controller.racket.action_result
-      end
-      controller.response.write(output)
-      controller.response.finish
-    end
-
-    private
-
-    # Tries to locate a layout matching +url_path+ in the file system and returns the path if a
-    # matching file is found. If no matching file is found, +nil+ is returned. The result is
-    # cached, meaning that the filesystem lookup for a specific url_path will only happen once.
-    #
-    # @param [String] url_path
-    # @param [String|nil] default_layout
-    # @return [String|nil]
-    def find_layout(url_path, default_layout)
-      return @layouts_by_path[url_path] if @layouts_by_path.key?(url_path)
-      @layouts_by_path[url_path] = find_matching_file(@layout_base_dir, url_path, default_layout)
-    end
-
-    # Tries to locate a template matching +url_path+ in the file system and returns the path if a
-    # matching file is found. If no matching file is found, +nil+ is returned. The result is
-    # cached, meaning that the filesystem lookup for a specific url_path will only happen once.
-    #
-    # @param [String] url_path
-    # @param [String|nil] default_view
-    # @return [String|nil]
-    def find_template(url_path, default_view)
-      return @templates_by_path[url_path] if @templates_by_path.key?(url_path)
-      @templates_by_path[url_path] = find_matching_file(@template_base_dir, url_path, default_view)
-    end
-
-    # Locates a file in the filesystem matching an URL path. If there exists a matching file, the
-    # path to it is returned. If there is no matching file, +nil+ is returned.
-    #
-    # @param [String] base_file_path
-    # @param [String] url_path
-    # @param [String|nil] default_file
-    # @return [String|nil]
-    def find_matching_file(base_file_path, url_path, default_file)
-      file_path = File.join(base_file_path, url_path)
-      action = File.basename(file_path)
-      file_path = File.dirname(file_path)
-      return nil unless Utils.dir_readable?(file_path)
-      Dir.chdir(file_path) do
-        files = Pathname.glob("#{action}.*")
-        if files.empty?
-          if default_file
-            files = Pathname.glob(default_file)
-            return nil if files.empty? # No default file found
-            final_path = File.join(file_path, files.first.to_s)
-            return Utils.file_readable?(final_path) ? final_path : nil
-          end
-          return nil # Neither default file or specified file found
-        end
-        final_path = File.join(file_path, files.first.to_s)
-        return Utils.file_readable?(final_path) ? final_path : nil
-      end
-    end
-  end
-end