racket-mvc 0.4.0 → 0.5.0

data/lib/racket/current.rb

@@ -1,5 +1,5 @@
 # Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+# Copyright (C) 2015-2016  Lars Olsson <lasso@lassoweb.se>
 #
 # This file is part of Racket.
 #

data/lib/racket/helpers/file.rb

@@ -1,5 +1,5 @@
 # Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+# Copyright (C) 2015-2016  Lars Olsson <lasso@lassoweb.se>
 #
 # This file is part of Racket.
 #
@@ -23,8 +23,9 @@ module Racket
     module File
       # Class for sending files.
       class Response
-        def initialize(file, options)
-          @file = Utils.build_path(file)
+        def initialize(utils, file, options)
+          @utils = utils
+          @file = @utils.build_path(file)
           @options = options
           @response = Racket::Response.new
           build
@@ -40,7 +41,7 @@ module Racket
         private
 
         def build
-          if Utils.file_readable?(@file) then build_success
+          if Racket::Utils::FileSystem.file_readable?(@file) then build_success
           else build_failure
           end
         end
@@ -82,7 +83,8 @@ module Racket
       # @param [Hash] options
       # @return [Array]
       def send_file(file, options = {})
-        respond!(*(Response.new(file, options).to_a))
+        response = Response.new(Controller.context.utils, file, options).to_a
+        respond!(*response)
       end
     end
   end

data/lib/racket/helpers/routing.rb

@@ -1,5 +1,5 @@
 # Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+# Copyright (C) 2015-2016  Lars Olsson <lasso@lassoweb.se>
 #
 # This file is part of Racket.
 #
@@ -28,10 +28,10 @@ module Racket
       # @param [Array] params
       # @return [String]
       def route(controller, action = nil, *params)
-        Application.get_route(controller, action, params)
+        controller.get_route(action, params)
       end
 
-      alias_method(:r, :route)
+      alias r route
 
       # Returns a route to an action within the current controller.
       #
@@ -39,10 +39,10 @@ module Racket
       # @param [Array] params
       # @return [String]
       def route_self(action = nil, *params)
-        Application.get_route(self.class, action, params)
+        self.class.get_route(action, params)
       end
 
-      alias_method(:rs, :route_self)
+      alias rs route_self
     end
   end
 end

data/lib/racket/helpers/sass.rb

@@ -1,5 +1,5 @@
 # Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+# Copyright (C) 2015-2016  Lars Olsson <lasso@lassoweb.se>
 #
 # This file is part of Racket.
 #
@@ -26,24 +26,24 @@ module Racket
       # @param [Symbol] sym
       # @return [String]
       def css(sym)
-        route = Application.get_route(self.class)
+        route = self.class.get_route
         route = '' if route == '/' # Special case for root controller
         "/css#{route}/#{sym}.css"
       end
 
-      def self.add_template_location(route)
-        root_dir = Application.settings.root_dir
-        sass_dir = Utils.build_path(root_dir, 'sass', route).to_s
-        css_dir = Utils.build_path(root_dir, 'public', 'css', route).to_s
+      def self.add_template_location(klass, route)
+        utils = klass.context.utils
+        sass_dir = utils.build_path('sass', route).to_s
+        css_dir = utils.build_path('public', 'css', route).to_s
         ::Sass::Plugin.add_template_location(sass_dir, css_dir)
         sass_dir
       end
 
-      def self.add_warmup_urls(sass_dir, route)
+      def self.add_warmup_urls(klass, sass_dir, route)
         Dir.chdir(sass_dir) do
           basedir = route.empty? ? '/css' : "/css/#{route}"
           Dir.glob('*.s[ac]ss').each do |file|
-            Application.settings.warmup_urls << "#{basedir}/#{::File.basename(file, '.*')}.css"
+            klass.settings.fetch(:warmup_urls) << "#{basedir}/#{::File.basename(file, '.*')}.css"
           end
         end
       end
@@ -54,9 +54,9 @@ module Racket
       # @param [Class] klass
       # @return [nil]
       def self.included(klass)
-        route = Application.get_route(klass)[1..-1] # Remove leading slash
-        sass_dir = add_template_location(route)
-        add_warmup_urls(sass_dir, route)
+        route = klass.get_route.slice(1..-1) # Remove leading slash
+        sass_dir = add_template_location(klass, route)
+        add_warmup_urls(klass, sass_dir, route)
         nil
       end
 

data/lib/racket/helpers/view.rb

@@ -1,5 +1,5 @@
 # Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+# Copyright (C) 2015-2016  Lars Olsson <lasso@lassoweb.se>
 #
 # This file is part of Racket.
 #
@@ -26,10 +26,13 @@ module Racket
       # @param [String] template
       # @param [Object] context
       # @return [String|nil]
-      def render_template(template, context = self)
-        template = Utils.build_path(template)
-        return nil unless Utils.file_readable?(template)
-        Tilt.new(template).render(context)
+      # @todo Allow user to specify template options
+      def render_template(template, context = self, template_settings = nil)
+        utils = Controller.context.utils
+        template = utils.build_path(template)
+        return nil unless Racket::Utils::FileSystem.file_readable?(template)
+        settings = ::Racket::Utils::Views.extract_template_settings(context, template_settings)
+        Tilt.new(template, nil, settings).render(context)
       end
     end
   end

data/lib/racket/plugins/base.rb

@@ -1,5 +1,5 @@
 # Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+# Copyright (C) 2015-2016  Lars Olsson <lasso@lassoweb.se>
 #
 # This file is part of Racket.
 #

data/lib/racket/plugins/sass.rb

@@ -1,5 +1,5 @@
 # Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+# Copyright (C) 2015-2016  Lars Olsson <lasso@lassoweb.se>
 #
 # This file is part of Racket.
 #

data/lib/racket/request.rb

@@ -1,5 +1,5 @@
 # Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+# Copyright (C) 2015-2016  Lars Olsson <lasso@lassoweb.se>
 #
 # This file is part of Racket.
 #
@@ -27,7 +27,7 @@ module Racket
     undef_method :session, :session_options
 
     # Redefine methods for handling GET parameters
-    alias_method(:get_params, :GET)
+    alias get_params GET
     undef_method :GET
 
     # Returns a value from the GET parameter hash.
@@ -40,7 +40,7 @@ module Racket
     end
 
     # Redefine methods for handling POST parameters
-    alias_method(:post_params, :POST)
+    alias post_params POST
     undef_method :POST
 
     # Returns a value from the POST parameter hash.

data/lib/racket/response.rb

@@ -1,5 +1,5 @@
 # Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+# Copyright (C) 2015-2016  Lars Olsson <lasso@lassoweb.se>
 #
 # This file is part of Racket.
 #

data/lib/racket/router.rb

@@ -1,5 +1,5 @@
 # Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+# Copyright (C) 2015-2016  Lars Olsson <lasso@lassoweb.se>
 #
 # This file is part of Racket.
 #
@@ -16,6 +16,7 @@
 # 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 'ostruct'
 require 'set'
 
 require 'http_router'
@@ -34,13 +35,31 @@ module Racket
       end
     end
 
-    attr_reader :action_cache
     attr_reader :routes
 
-    def initialize
+    # Returns a service proc that can be used by the registry.
+    #
+    # @param  [Hash] _options (unused)
+    # @return [Proc]
+    def self.service(_options = {})
+      lambda do |reg|
+        new(
+          action_cache: reg.action_cache,
+          dev_mode: reg.application_settings.mode == :dev,
+          logger: reg.application_logger
+        )
+      end
+    end
+
+    # @return [Racket::Utils::Routing::ActionCache]
+    def action_cache
+      @options.action_cache
+    end
+
+    def initialize(options)
+      @options = OpenStruct.new(options)
       @router = HttpRouter.new
       @routes = {}
-      @action_cache = Utils::Routing::ActionCache.new
     end
 
     # Returns a route to the specified controller/action/parameter combination.
@@ -50,7 +69,7 @@ module Racket
     # @param [Array] params
     # @return [String]
     def get_route(controller_class, action, params)
-      fail "Cannot find controller #{controller_class}" unless @routes.key?(controller_class)
+      raise "Cannot find controller #{controller_class}" unless @routes.key?(controller_class)
       params.flatten!
       Route.new(@routes[controller_class], action, params).to_s
     end
@@ -63,13 +82,13 @@ module Racket
     def map(path, controller_class)
       map_controller(path.empty? ? '/' : path, controller_class)
       @router.add("#{path}(/*params)").to(controller_class)
-      @action_cache.add(controller_class)
+      action_cache.add(controller_class)
     end
 
     # @todo: Allow the user to set custom handlers for different errors
     def render_error(status, error = nil)
       # If running in dev mode, let Rack::ShowExceptions handle the error.
-      fail(error) if error && Application.dev_mode?
+      raise error if error && @options.dev_mode
 
       # Not running in dev mode, let us handle the error ourselves.
       Response.generate_error_response(status)
@@ -83,7 +102,7 @@ module Racket
       catch :response do # Catches early exits from Controller.respond.
         # Ensure that that a controller will respond to the request. If not, send a 404.
         return render_error(404) unless (target_info = target_info(env))
-        Utils.render_controller(env, target_info)
+        Racket::Utils::Routing::Dispatcher.new(env, target_info).dispatch
       end
     rescue => err
       render_error(500, err)
@@ -92,7 +111,7 @@ module Racket
     private
 
     def map_controller(base_path, controller_class)
-      Application.inform_dev("Mapping #{controller_class} to #{base_path}.")
+      @options.logger.inform_dev("Mapping #{controller_class} to #{base_path}.")
       @routes[controller_class] = base_path
     end
 
@@ -105,10 +124,10 @@ module Racket
       matching_route = @router.recognize(env).first
       # Exit early if no controller is responsible for the route
       return nil unless matching_route
-      # Some controller is claiming to be responsible for the route
-      result = Utils.extract_target(matching_route.first)
+      # Some controller is claiming to be responsible for the route, find out which one.
+      result = Racket::Utils::Routing::Dispatcher.extract_target(matching_route.first)
       # Exit early if action is not available on target
-      return nil unless @action_cache.present?(result.first, result.last)
+      return nil unless action_cache.present?(result.first, result.last)
       result
     end
   end

data/lib/racket/session.rb

@@ -1,5 +1,5 @@
 # Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+# Copyright (C) 2015-2016  Lars Olsson <lasso@lassoweb.se>
 #
 # This file is part of Racket.
 #
@@ -29,7 +29,7 @@ module Racket
     def inspect
       "#<#{self.class}:#{object_id}>"
     end
-    alias_method(:to_s, :inspect)
-    alias_method(:to_str, :inspect)
+    alias to_s inspect
+    alias to_str inspect
   end
 end

data/lib/racket/settings/application.rb

@@ -1,5 +1,5 @@
 # Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+# Copyright (C) 2015-2016  Lars Olsson <lasso@lassoweb.se>
 #
 # This file is part of Racket.
 #
@@ -16,39 +16,31 @@
 # 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 'logger'
-
 require_relative 'base.rb'
+require_relative 'defaults.rb'
 
 module Racket
   module Settings
     # Class for storing application settings.
     class Application < Base
-      setting(:default_action, :index)
-      setting(:default_content_type, 'text/html')
-      setting(:default_controller_helpers, [:routing, :view])
-      setting(:default_layout, nil)
-      setting(:default_view, nil)
-      setting(:logger, Logger.new($stdout))
-      setting(:middleware, [])
-      setting(:mode, :live)
-      setting(:plugins, [])
-      setting(
-        :session_handler,
-        [
-          Rack::Session::Cookie,
-          {
-            key: 'racket.session',
-            old_secret: SecureRandom.hex(16),
-            secret: SecureRandom.hex(16)
-          }
-        ]
-      )
-      setting(:root_dir, nil) # Will be set automatically by constructor.
-      setting(:warmup_urls, Set.new)
+      @defaults = Defaults.application_defaults
+
+      [
+        :default_action, :default_content_type, :default_controller_helpers,
+        :default_layout, :default_view, :logger, :middleware, :mode, :plugins,
+        :session_handler, :root_dir, :template_settings, :warmup_urls
+      ].each { |key| setting(key) }
+
+      # Returns a service proc that can be used by the registry.
+      #
+      # @param  [Hash] options
+      # @return [Proc]
+      def self.service(options = {})
+        ->(reg) { new(reg.utils, options) }
+      end
 
-      def initialize(defaults = {})
-        defaults[:root_dir] = Dir.pwd unless defaults.key?(:root_dir)
+      def initialize(utils, defaults = {})
+        @utils = utils
         super(defaults)
       end
 
@@ -66,15 +58,17 @@ module Racket
         define_method symbol do
           instance_variable_set(ivar, directory) unless instance_variables.include?(ivar)
           return nil unless (value = instance_variable_get(ivar))
-          Utils.build_path(value)
+          @utils.build_path(value)
         end
       end
 
-      directory_setting(:controller_dir, 'controllers')
-      directory_setting(:helper_dir, 'helpers')
-      directory_setting(:layout_dir, 'layouts')
-      directory_setting(:public_dir, 'public')
-      directory_setting(:view_dir, 'views')
+      {
+        controller_dir: 'controllers',
+        helper_dir: 'helpers',
+        layout_dir: 'layouts',
+        public_dir: 'public',
+        view_dir: 'views'
+      }.each_pair { |key, value| directory_setting(key, value) }
 
       private_class_method :define_directory_method
     end

data/lib/racket/settings/base.rb

@@ -1,5 +1,5 @@
 # Racket - The noisy Rack MVC framework
-# Copyright (C) 2015  Lars Olsson <lasso@lassoweb.se>
+# Copyright (C) 2015-2016  Lars Olsson <lasso@lassoweb.se>
 #
 # This file is part of Racket.
 #
@@ -36,8 +36,8 @@ module Racket
       # @param [Symbol] key
       # @return [nil]
       def delete(key)
-        fail ArgumentErrpr,
-             "Cannot delete standard setting #{key}" if respond_to?(key.to_sym)
+        raise ArgumentErrpr,
+              "Cannot delete standard setting #{key}" if respond_to?(key.to_sym)
         @custom.delete(key) && nil
       end
 
@@ -68,20 +68,31 @@ module Racket
       # @param [Object] value
       # @return [nil]
       def store(key, value)
-        fail ArgumentError,
-             "Cannot overwrite standard setting #{key}" if respond_to?("#{key}=".to_sym)
+        raise ArgumentError,
+              "Cannot overwrite standard setting #{key}" if respond_to?("#{key}=".to_sym)
         (@custom[key] = value) && nil
       end
 
+      # Returns a default value for a key. Default values are stored in @defaults, which is a
+      # Racket::Registry object.
+      #
+      # @param [Symbol] symbol
+      # @return [Object]
+      def self.default_value(symbol)
+        return nil unless defined?(@defaults) && @defaults.respond_to?(symbol)
+        @defaults.send(symbol)
+      end
+
       # Creates a setting with a default value.
       #
       # @param [Symbol] symbol
-      # @param [Object] default
       # @return [nil]
-      def self.setting(symbol, default = nil)
+      def self.setting(symbol)
+        klass = self
         ivar = "@#{symbol}".to_sym
         define_method symbol do
-          instance_variable_set(ivar, default) unless instance_variables.include?(ivar)
+          instance_variable_set(ivar, klass.default_value(symbol)) unless
+            instance_variables.include?(ivar)
           instance_variable_get(ivar)
         end
         attr_writer(symbol) && nil