racket-mvc 0.4.0 → 0.5.0

data/lib/racket/utils/application/logger.rb

@@ -0,0 +1,72 @@
+# Racket - The noisy Rack MVC framework
+# Copyright (C) 2015-2016  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/>.
+
+module Racket
+  module Utils
+    # Namespace for application utilities
+    module Application
+      # Class for logging messages in the application.
+      class Logger
+        # Returns a service proc that can be used by the registry.
+        #
+        # @param  [Hash] _options (unused)
+        # @return [Proc]
+        def self.service(_options = {})
+          lambda do |reg|
+            settings = reg.application_settings
+            new(settings.logger, settings.mode)
+          end
+        end
+
+        def initialize(logger, mode)
+          @logger = logger
+          @in_dev_mode = (mode == :dev)
+        end
+
+        # Sends a message to the logger.
+        #
+        # @param [String] message
+        # @param [Symbol] level
+        # @return nil
+        def inform_all(message, level = :info)
+          inform(message, level)
+        end
+
+        # Sends a message to the logger, but only if we are running in dev mode.
+        #
+        # @param [String] message
+        # @param [Symbol] level
+        # @return nil
+        def inform_dev(message, level = :debug)
+          (inform(message, level) if @in_dev_mode) && nil
+        end
+
+        private
+
+        # Writes a message to the logger if there is one present.
+        #
+        # @param [String] message
+        # @param [Symbol] level
+        # @return nil
+        def inform(message, level)
+          (@logger.send(level, message) if @logger) && nil
+        end
+      end
+    end
+  end
+end

data/lib/racket/utils/application/registry_builder.rb

@@ -0,0 +1,88 @@
+# Racket - The noisy Rack MVC framework
+# Copyright (C) 2015-2016  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 'racket/registry'
+
+require_relative 'stateless_services.rb'
+
+module Racket
+  module Utils
+    module Application
+      # Class for easily building a Racket::Registry.
+      class RegistryBuilder
+        attr_reader :registry
+
+        def initialize(settings = {})
+          @settings = settings
+          @registry = Racket::Registry.singleton_map(service_map)
+        end
+
+        # Sets up a static server with the specified directory and logger.
+        #
+        # @param [Pathname|nil] static_dir
+        # @param [Logger] logger
+        # @return [Proc|nil]
+        def self.static_server(static_dir, logger)
+          unless static_dir
+            logger.inform_dev('Static server disabled.')
+            return nil
+          end
+          logger.inform_dev("Setting up static server to serve files from #{static_dir}.")
+          handler = Rack::File.new(static_dir)
+          ->(env) { handler.call(env) }
+        end
+
+        private
+
+        def controller_context
+          lambda do |reg|
+            Module.new do
+              define_singleton_method(:application_settings) { reg.application_settings }
+              define_singleton_method(:helper_cache) { reg.helper_cache }
+              define_singleton_method(:logger) { reg.application_logger }
+              define_singleton_method(:get_route) do |klass, action, params|
+                reg.router.get_route(klass, action, params)
+              end
+              define_singleton_method(:utils) { reg.utils }
+              define_singleton_method(:view_manager) { reg.view_manager }
+            end
+          end
+        end
+
+        def service_map
+          {
+            application_settings: Racket::Settings::Application.service(@settings),
+            controller_context: controller_context,
+            static_server: static_server,
+            utils: Racket::Utils::ToolBelt.service(root_dir: @settings.fetch(:root_dir, Dir.pwd))
+          }.merge!(StatelessServices.services)
+        end
+
+        def static_server
+          klass = self.class
+          lambda do |reg|
+            klass.static_server(
+              Racket::Utils::FileSystem.dir_or_nil(reg.application_settings.public_dir),
+              reg.application_logger
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/racket/utils/application/stateless_services.rb

@@ -0,0 +1,73 @@
+# Racket - The noisy Rack MVC framework
+# Copyright (C) 2015-2016  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/>.
+
+module Racket
+  module Utils
+    module Application
+      # Collects stateless services across the Racket
+      module StatelessServices
+        # Returns a list of stateless services (in the form of procs)
+        # that Racket uses. This is merely as conveniance method for getting
+        # all services from one place, the actual services are spread out over
+        # a large number of classes.
+        #
+        # @return [Hash]
+        def self.services
+          basic_services
+            .merge!(layout_services)
+            .merge!(template_services)
+            .merge!(view_services)
+        end
+
+        def self.basic_services
+          {
+            action_cache: Racket::Utils::Routing::ActionCache.service,
+            application_logger: Racket::Utils::Application::Logger.service,
+            handler_stack: Racket::Utils::Application::HandlerStack.service,
+            helper_cache: Racket::Utils::Helpers::HelperCache.service,
+            router: Racket::Router.service
+          }
+        end
+
+        def self.layout_services
+          {
+            layout_cache: Racket::Utils::Views::TemplateCache.service,
+            layout_resolver: Racket::Utils::Views::TemplateResolver.service(type: :layout)
+          }
+        end
+
+        def self.template_services
+          {
+            template_locator: Racket::Utils::Views::TemplateLocator.service,
+            template_renderer: Racket::Utils::Views::Renderer.service
+          }
+        end
+
+        def self.view_services
+          {
+            view_cache: Racket::Utils::Views::TemplateCache.service,
+            view_manager: Racket::ViewManager.service,
+            view_resolver: Racket::Utils::Views::TemplateResolver.service(type: :view)
+          }
+        end
+
+        private_class_method :basic_services, :layout_services, :template_services, :view_services
+      end
+    end
+  end
+end

data/lib/racket/utils/exceptions.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.
 #
@@ -31,7 +31,7 @@ module Racket
         # @param [Array] errors
         # @return [true|flase]
         def self.run_block(errors)
-          fail 'Need a block' unless block_given?
+          raise 'Need a block' unless block_given?
           begin
             true.tap { yield }
           rescue boolean_module(errors)
@@ -60,7 +60,7 @@ module Racket
       #
       # @param [Array] errors
       # @return [true|flase]
-      def self.run_block(*errors, &block)
+      def run_block(*errors, &block)
         ExceptionHandler.run_block(errors, &block)
       end
     end

data/lib/racket/utils/file_system.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.
 #
@@ -47,15 +47,16 @@ module Racket
         #
         # @param [Array] args
         # @return [Pathname]
-        def self.to_pathname(*args)
-          new(args).path
+        def self.to_pathname(root_dir, *args)
+          new(root_dir, args).path
         end
 
         attr_reader :path
 
         private
 
-        def initialize(args)
+        def initialize(root_dir, args)
+          @root_dir = root_dir
           extract_base_path(args.dup)
           build_path
           clean_path
@@ -72,30 +73,19 @@ module Racket
           end
           @args.map!(&:to_s)
           @path = Pathname.new(@args.shift)
-          @path = Pathname.new(::Racket::Application.settings.root_dir).join(@path) if
-            @path.relative?
+          @path = Pathname.new(@root_dir).join(@path) if @path.relative?
         end
 
         def build_path
           @args.each do |arg|
             path_part = Pathname.new(arg)
-            fail ArgumentError, arg unless path_part.relative?
+            raise ArgumentError, arg unless path_part.relative?
             @path = @path.join(path_part)
           end
           remove_instance_variable :@args
         end
       end
 
-      # Builds and returns a path in the file system from the provided arguments. The first element
-      # in the argument list can be either absolute or relative, all other arguments must be
-      # relative, otherwise they will be removed from the final path.
-      #
-      # @param [Array] args
-      # @return [Pathname]
-      def self.build_path(*args)
-        PathBuilder.to_pathname(*args)
-      end
-
       # Returns whether a directory is readable or not. In order to be readable, the directory must
       # a) exist
       # b) be a directory
@@ -107,6 +97,16 @@ module Racket
         path.exist? && path.directory? && path.readable?
       end
 
+      # Return a Pathname for a directory if the directory is readable, otherwise returns nil.
+      #
+      # @param [String] path
+      # @return [Pathname|nil]
+      def self.dir_or_nil(path)
+        return nil unless path
+        path = Pathname.new(path)
+        dir_readable?(path) ? path : nil
+      end
+
       # Extracts the correct directory and glob for a given base path/path combination.
       #
       # @param [Pathname] path
@@ -119,17 +119,6 @@ module Racket
         ]
       end
 
-      # Given a base pathname and a url path string, returns a pathname.
-      #
-      # @param [Pathname] base_pathname
-      # @param [String] url_path
-      # @return [Pathname]
-      def self.fs_path(base_pathname, url_path)
-        parts = url_path.split('/').reject(&:empty?)
-        parts.each { |part| base_pathname = base_pathname.join(part) }
-        base_pathname
-      end
-
       # Returns whether a file is readable or not. In order to be readable, the file must
       # a) exist
       # b) be a file
@@ -144,16 +133,6 @@ module Racket
         path.exist? && path.file? && path.readable?
       end
 
-      # Returns all paths under +base_path+ that matches +glob+.
-      #
-      # @param [Pathname] base_path
-      # @param [Pathname] glob
-      # @return [Array]
-      def self.matching_paths(base_path, glob)
-        return [] unless Utils.dir_readable?(base_path)
-        Dir.chdir(base_path) { Pathname.glob(glob) }.map { |path| base_path.join(path) }
-      end
-
       # Returns the first matching path under +base_path+ matching +glob+. If no matching path can
       # be found, +nil+ is returned.
       #
@@ -165,14 +144,63 @@ module Racket
         paths.empty? ? nil : paths.first
       end
 
-      # Returns a list of relative file paths, sorted by path (longest first).
+      # Given a base pathname and a url path string, returns a pathname.
       #
-      # @param [String] base_dir
-      # @param [String] glob
-      # return [Array]
-      def self.paths_by_longest_path(base_dir, glob)
-        paths = matching_paths(base_dir, glob).map { |path| SizedPath.new(path) }.sort
-        paths.map(&:path)
+      # @param [Pathname] base_pathname
+      # @param [String] url_path
+      # @return [Pathname]
+      def self.fs_path(base_pathname, url_path)
+        parts = url_path.split('/').reject(&:empty?)
+        parts.each { |part| base_pathname = base_pathname.join(part) }
+        base_pathname
+      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 [Pathname] path
+      # @return [Pathname|nil]
+      def self.resolve_path(path)
+        first_matching_path(*extract_dir_and_glob(path))
+      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 and +default+ is a
+      # String or a Symbol, another lookup will be performed using +default+. If
+      # +default+ is a Proc or nil, +default+ will be used as is instead.
+      #
+      # @param [Pathname] path
+      # @param [String|Symbol|Proc|nil] default
+      # @return [String|Proc|nil]
+      def self.resolve_path_with_default(path, default)
+        # Return template if it can be found in the file system
+        template = resolve_path(path)
+        return template if template
+        # No template found for path. Try the default template instead.
+        # If default template is a string or a symbol, look it up in the file system
+        return resolve_path(fs_path(path.dirname, default)) if
+          default.is_a?(String) || default.is_a?(Symbol)
+        # If default template is a proc or nil, just return it
+        default
+      end
+
+      # Returns all paths under +base_path+ that matches +glob+.
+      #
+      # @param [Pathname] base_path
+      # @param [Pathname] glob
+      # @return [Array]
+      def self.matching_paths(base_path, glob)
+        return [] unless dir_readable?(base_path)
+        Dir.chdir(base_path) { Pathname.glob(glob) }.map { |path| base_path.join(path) }
+      end
+
+      # Builds and returns a path in the file system from the provided arguments. The first element
+      # in the argument list can be either absolute or relative, all other arguments must be
+      # relative, otherwise they will be removed from the final path.
+      #
+      # @param [Array] args
+      # @return [Pathname]
+      def build_path(*args)
+        PathBuilder.to_pathname(@root_dir, *args)
       end
 
       # Safely requires a file. This method will catch load errors and return true (if the file
@@ -180,8 +208,8 @@ module Racket
       #
       # @param [String] resource
       # @return [true|false]
-      def self.safe_require(resource)
-        Utils.run_block(LoadError) { require resource }
+      def safe_require(resource)
+        run_block(LoadError) { require resource }
       end
     end
   end