racket-mvc 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63921b5e05aa5980041e8817c71bcd43b015834d
-  data.tar.gz: 1f98ea84f965aa6c36707dd515c16b9d7ff7ae29
+  metadata.gz: 63dc217836153cda7cd00f43dfe894a519c4de5d
+  data.tar.gz: 22bca87d176624f95ff10c8007526c0d2b2f4ca0
 SHA512:
-  metadata.gz: 306ae0910122403e2adff6a1cab12d01bea39e17d7142e7b07a2ef0aa1a48e1b61c38e1debf2f2ffff3f38bebc1d9d12cd3f2770dd0509ac44e0bdb2e95c92c2
-  data.tar.gz: 3fdeac0f87e45d5cefda65f18ebc61d831028a09ce75ffe371f2024838e6b5f06087fe655f64fb8d405fc1e0515167d27b42f74c5c8bcf472c0371ebf05bd11a
+  metadata.gz: 332598c7ab0f25fceb9a21356d13d96700f3bb1ba592a71a46b048f365ff7066078230348e7a6432430015f7c6293531b75c3ed560c4a1ad02f0c315363a5046
+  data.tar.gz: 33a1208769de0e009036df394fea74a5fa6630b035f35bb7f952f0887873514050a6739dcd126446b2bf1ac2cab1f0eff64d83abd62c38a52c019593fc9e613b

data/lib/racket/application.rb

@@ -33,6 +33,12 @@ module Racket
       @application ||= Utils.build_application(self)
     end
 
+    # Applies settings.
+    def self.apply_settings(settings)
+      fail 'Application has already been initialized!' if @settings
+      @settings = Settings::Application.new(settings)
+    end
+
     def self.calculate_url_path(file)
       url_path = "/#{file.relative_path_from(@settings.controller_dir).dirname}"
       url_path = '' if url_path == '/.'
@@ -104,8 +110,8 @@ module Racket
     # @param [Hash] settings
     # @return [Class]
     def self.init(settings = {})
-      fail 'Application has already been initialized!' if @settings
-      @settings = Settings::Application.new(settings)
+      apply_settings(settings)
+      application # This will make sure all plugins and helpers are loaded before any controllers
       setup_static_server
       reload
       self
@@ -129,8 +135,9 @@ module Racket
     def self.load_controller_file(file)
       ::Kernel.require file
       klass = @settings.fetch(:last_added_controller).pop
-      Utils.apply_helpers(klass)
-      @router.map(calculate_url_path(file), klass) && nil
+      # Helpers may do stuff based on route, make sure it is available before applying helpers.
+      @router.map(calculate_url_path(file), klass)
+      Utils.apply_helpers(klass) && nil
     end
 
     def self.load_controller_files
@@ -156,13 +163,6 @@ module Racket
       (::Kernel.require Utils.build_path(*args)) && nil
     end
 
-    # Resets Racket::Application, making it possible to run run a new application with new settings.
-    # This is a workaround for Racket::Application being a singleton, making tests harder to write,
-    # @todo Remove this when Racket::Application stops beeing a singleton (if ever).
-    def self.reset!
-      instance_variables.each { |ivar| instance_variable_set(ivar, nil) }
-    end
-
     # Serves a static file (if Racket is configured to serve static files).
     #
     # @param [Hash] env Rack environment

data/lib/racket/helpers/sass.rb

@@ -0,0 +1,66 @@
+# 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/>.
+
+module Racket
+  # Helpers module
+  module Helpers
+    # Helper module that allows CSS files to be loaded dynamically using SASS.
+    module Sass
+      # Get route to CSS, which will use SASS in the background to deliver the CSS.
+      #
+      # @param [Symbol] sym
+      # @return [String]
+      def css(sym)
+        route = Application.get_route(self.class)
+        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
+        ::Sass::Plugin.add_template_location(sass_dir, css_dir)
+        sass_dir
+      end
+
+      def self.add_warmup_urls(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"
+          end
+        end
+      end
+
+      # Whenever this helper is included in a controller it will setup a link between
+      # a SASS directory and a CSS directory.
+      #
+      # @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)
+        nil
+      end
+
+      private_class_method :add_template_location, :add_warmup_urls
+    end
+  end
+end

data/lib/racket/plugins/base.rb

@@ -0,0 +1,54 @@
+# 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/>.
+
+module Racket
+  # Namespace for plugins.
+  module Plugins
+    # Plugin base class. All plugins should inherit from this class.
+    class Base
+      attr_reader :settings
+
+      def initialize(settings = {})
+        @settings = {}
+        @settings.merge!(settings) if settings.is_a?(Hash)
+      end
+
+      # This method should return an array of helpers (symbols) that the plugin wants to load
+      # automatically in every controller. If you do not want your controller to load any helpers
+      # automatically you do not need to override this method. You can still add your helpers to
+      # individual controllers by using Controller#helper.
+      #
+      # @return [Array] An array of symbols representing helpers that should be loaded automatically
+      def default_controller_helpers
+        []
+      end
+
+      # This method should return an array of [Module, Hash] arrays where each module represenents
+      # a Rack-compatible middleware module and the hash the settings that should be applied to
+      # that middleware. Each pair that the plugin provides will be automatically added to the
+      # middleware of the application. This is just for conveniance, a user could still add The same
+      # middleware using the global settings.
+      #
+      # @return [Array] An array of [Module, Hash] pairs that represenents middleware that will be
+      #   loaded automatically by the plugin
+      def middleware
+        []
+      end
+    end
+  end
+end

data/lib/racket/plugins/sass.rb

@@ -0,0 +1,50 @@
+# 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_relative 'base'
+
+module Racket
+  # Namespace for plugins.
+  module Plugins
+    # Sass plugin.
+    class Sass < Base
+      # Called on plugin initialization.
+      def initialize(settings = nil)
+        super
+        begin
+          require 'sass/plugin/rack'
+        rescue LoadError
+          raise 'Failed to load sass rack plugin!'
+        end
+        apply_sass_settings
+      end
+
+      # Middleware that should be automatically added.
+      def middleware
+        [[::Sass::Plugin::Rack, nil]]
+      end
+
+      private
+
+      # Apply each setting to the Sass plugin.
+      def apply_sass_settings
+        settings.each_pair { |key, value| ::Sass::Plugin.options[key] = value }
+      end
+    end
+  end
+end

data/lib/racket/settings/application.rb

@@ -32,6 +32,7 @@ module Racket
       setting(:logger, Logger.new($stdout))
       setting(:middleware, [])
       setting(:mode, :live)
+      setting(:plugins, [])
       setting(
         :session_handler,
         [
@@ -44,6 +45,7 @@ module Racket
         ]
       )
       setting(:root_dir, nil) # Will be set automatically by constructor.
+      setting(:warmup_urls, Set.new)
 
       def initialize(defaults = {})
         defaults[:root_dir] = Dir.pwd unless defaults.key?(:root_dir)

data/lib/racket/utils/application.rb

@@ -34,7 +34,8 @@ module Racket
         #
         # @return [Proc]
         def build
-          expand_middleware_list
+          init_plugins
+          add_warmup_hook
           add_middleware
           @builder.run(application_proc)
           @builder
@@ -44,6 +45,7 @@ module Racket
 
         # Add middleware to the builder.
         def add_middleware
+          expand_middleware_list
           @middleware.each do |ware|
             klass, opts = ware
             @application.inform_dev("Loading middleware #{klass} with settings #{opts.inspect}.")
@@ -51,6 +53,16 @@ module Racket
           end
         end
 
+        # Add a list of urls to visit on startup
+        def add_warmup_hook
+          warmup_urls = Racket::Application.settings.warmup_urls
+          return if warmup_urls.empty?
+          @builder.warmup do |app|
+            client = Rack::MockRequest.new(app)
+            visit_warmup_urls(client, warmup_urls)
+          end
+        end
+
         # Returns a lambda that represenents that application flow.
         def application_proc
           application = @application
@@ -69,6 +81,42 @@ module Racket
           @middleware.unshift([Rack::ContentType, default_content_type]) if default_content_type
           @middleware.unshift([Rack::ShowExceptions]) if @application.dev_mode?
         end
+
+        # Initializes plugins.
+        def init_plugins
+          @settings.plugins.each do |plugin_info|
+            plugin_instance = self.class.get_plugin_instance(*plugin_info)
+            run_plugin_hooks(plugin_instance)
+            # TODO: Store plugin instance somewhere in application settings
+          end
+        end
+
+        # Runs plugin hooks.
+        def run_plugin_hooks(plugin_obj)
+          @middleware.concat(plugin_obj.middleware)
+          @settings.default_controller_helpers.concat(plugin_obj.default_controller_helpers)
+        end
+
+        # Visits a list of warmup URLs.
+        def visit_warmup_urls(client, urls)
+          urls.each do |url|
+            @application.inform_dev("Visiting warmup url #{url}.")
+            client.get(url)
+          end
+        end
+
+        # Returns an instance of a specific plugin.
+        #
+        # @param [Symbol] plugin
+        # @param [Hash|nil] settings
+        # @return [Object] An instance of the requested plugin class
+        def self.get_plugin_instance(plugin, settings)
+          Utils.safe_require("racket/plugins/#{plugin}.rb")
+          # TODO: Allow custom plugins dir as well
+          klass =
+            Racket::Plugins.const_get(plugin.to_s.split('_').collect(&:capitalize).join.to_sym)
+          klass.new(settings)
+        end
       end
 
       # Builds and returns a Rack::Builder using the provided Racket::Application

data/lib/racket/utils/views.rb

@@ -153,10 +153,16 @@ module Racket
         # @return [String|Proc|nil]
         def self.lookup_template_with_default(path, default_template)
           template = lookup_template(path)
-          if !template && (default_template.is_a?(String) || default_template.is_a?(Symbol))
-            template = lookup_template(Utils.fs_path(path.dirname, default_template))
+          unless template
+            if default_template.is_a?(String) || default_template.is_a?(Symbol)
+              # Strings and symbols can be lookup up in the file system...
+              template = lookup_template(Utils.fs_path(path.dirname, default_template))
+            else
+              # ...but not nils/procs!
+              template = default_template
+            end
           end
-          template || default_template
+          template
         end
       end
 

data/lib/racket/version.rb

@@ -23,9 +23,9 @@ module Racket
     # Major version
     MAJOR = 0
     # Minor version
-    MINOR = 3
+    MINOR = 4
     # Teeny version
-    TEENY = 3
+    TEENY = 0
     # Is it a prerelease?
     PRERELEASE = false
 

data/spec/_custom.rb

@@ -1,4 +1,4 @@
-describe 'A custom Racket test Application' do
+describe 'A custom Racket test application' do
   extend Rack::Test::Methods
   def app
     @app ||= Racket::Application.using(
@@ -15,6 +15,20 @@ describe 'A custom Racket test Application' do
     app.settings.view_dir.should.equal(Racket::Utils.build_path('templates'))
   end
 
+  it 'should get the correct middleware' do
+    middleware = app.settings.middleware
+    middleware.length.should.equal(3)
+    middleware[0].class.should.equal(Array)
+    middleware[0].length.should.equal(1)
+    middleware[0].first.should.equal(Rack::ShowExceptions)
+    middleware[1].class.should.equal(Array)
+    middleware[1].length.should.equal(2)
+    middleware[1].first.should.equal(Rack::ContentType)
+    middleware[2].class.should.equal(Array)
+    middleware[2].length.should.equal(2)
+    middleware[2].first.should.equal(Rack::Session::Cookie)
+  end
+
   it 'should be able to get/set settings on controller' do
     get '/sub3/a_secret_place'
     last_response.status.should.equal(302)

data/spec/_default.rb

@@ -1,4 +1,4 @@
-describe 'A default Racket test Application' do
+describe 'A default Racket test application' do
   extend Rack::Test::Methods
 
   def app
@@ -47,6 +47,18 @@ describe 'A default Racket test Application' do
     JSON.parse(last_response.body).should.equal(%w(foo bar baz))
   end
 
+  it 'should get the correct middleware' do
+    middleware = app.settings.middleware
+    middleware.length.should.equal(2)
+    middleware[0].class.should.equal(Array)
+    middleware[0].length.should.equal(2)
+    middleware[0].first.should.equal(Rack::ContentType)
+    middleware[1].class.should.equal(Array)
+    middleware[1].length.should.equal(2)
+    middleware[1].first.should.equal(Rack::Session::Cookie)
+    true.should.equal(true)
+  end
+
   it 'returns the correct respnse when calling index action' do
     # RootController
     get '/'

data/spec/_plugin.rb

@@ -0,0 +1,44 @@
+describe 'A Racket application with plugins' do
+  extend Rack::Test::Methods
+  def app
+    @app ||= Racket::Application.using(
+      logger: nil,
+      plugins: [[:sass, { style: :compressed, sourcemap: :none }]]
+    )
+  end
+
+  it 'should get correct defaults from base plugin' do
+    require 'racket/plugins/base'
+    plugin = Racket::Plugins::Base.new
+    plugin.default_controller_helpers.should.equal([])
+    plugin.middleware.should.equal([])
+  end
+
+  it 'should return correct CSS paths when querying default controller' do
+    get '/css_path'
+    last_response.status.should.equal(200)
+    last_response.body.should.equal('/css/foo.css')
+  end
+
+  it 'should return correct CSS paths when querying a subcontroller' do
+    get '/sub/css_path'
+    last_response.status.should.equal(200)
+    last_response.body.should.equal('/css/sub/bar.css')
+  end
+
+=begin
+  it 'should render a SASS based stylesheet for the default controller' do
+    get '/css/test.css'
+    last_response.status.should.equal(200)
+    last_response.headers['Content-Type'].should.equal('text/css')
+    last_response.body.should.equal("body{background-color:snow;color:black}\n")
+  end
+
+  it 'should render a SASS based stylesheet for a subcontroller' do
+    get '/css/sub/test.css'
+    last_response.status.should.equal(200)
+    last_response.headers['Content-Type'].should.equal('text/css')
+    last_response.body.should.equal("body{background-color:steelblue;color:gray}\n")
+  end
+=end
+end

data/spec/racket.rb

@@ -14,6 +14,7 @@ end
 TEST_DIR = File.absolute_path(File.dirname(__FILE__))
 TEST_DEFAULT_APP_DIR = File.join(TEST_DIR, 'test_default_app')
 TEST_CUSTOM_APP_DIR = File.join(TEST_DIR, 'test_custom_app')
+TEST_PLUGIN_APP_DIR = File.join(TEST_DIR, 'test_plugin_app')
 
 require 'racket'
 
@@ -29,7 +30,8 @@ require File.join(TEST_DIR, '_request.rb')
 # Application tests.
 suites = [
   -> { Dir.chdir(TEST_DEFAULT_APP_DIR) { require File.join(TEST_DIR, '_default.rb') } },
-  -> { Dir.chdir(TEST_CUSTOM_APP_DIR) { require File.join(TEST_DIR, '_custom.rb') } }
+  -> { Dir.chdir(TEST_CUSTOM_APP_DIR) { require File.join(TEST_DIR, '_custom.rb') } },
+  -> { Dir.chdir(TEST_PLUGIN_APP_DIR) { require File.join(TEST_DIR, '_plugin.rb') } }
 ]
 
 # Leave off randomization for now. Sessions does not seem to be reset correctly between suites!
@@ -37,7 +39,14 @@ suites = [
 
 # Run application tests.
 suites.each do |suite|
-  Racket::Application.reset!
+  # Make sure Racket::Application and Racket::Settings::Application is reset between the suites.
+  # Racket::Application@application and Racket::Settings::Application must be pristine on each run!
+  Racket.class_eval { remove_const(:Application) }
+  Racket::Settings.class_eval { remove_const(:Application) }
+  load('lib/racket/application.rb')
+  load('lib/racket/settings/application.rb')
+
+  # Run suite
   suite.call
 end
 

data/spec/test_plugin_app/controllers/main.rb

@@ -0,0 +1,8 @@
+# Main controller
+class MainController < Racket::Controller
+  helper :sass
+
+  def css_path
+    css(:foo)
+  end
+end

data/spec/test_plugin_app/controllers/sub/sub.rb

@@ -0,0 +1,8 @@
+# Sub controller
+class SubController < Racket::Controller
+  helper :sass
+
+  def css_path
+    css(:bar)
+  end
+end

data/spec/test_plugin_app/sass/sub/test.scss

@@ -0,0 +1,4 @@
+body {
+  background-color: steelblue;
+  color: gray;
+}

data/spec/test_plugin_app/sass/test.scss

@@ -0,0 +1,4 @@
+body {
+  background-color: snow;
+  color: black;
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: racket-mvc
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Lars Olsson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-29 00:00:00.000000000 Z
+date: 2016-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_router
@@ -108,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
+- !ruby/object:Gem::Dependency
+  name: sass
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +165,10 @@ files:
 - lib/racket/current.rb
 - lib/racket/helpers/file.rb
 - lib/racket/helpers/routing.rb
+- lib/racket/helpers/sass.rb
 - lib/racket/helpers/view.rb
+- lib/racket/plugins/base.rb
+- lib/racket/plugins/sass.rb
 - lib/racket/request.rb
 - lib/racket/response.rb
 - lib/racket/router.rb
@@ -172,6 +189,7 @@ files:
 - spec/_custom.rb
 - spec/_default.rb
 - spec/_invalid.rb
+- spec/_plugin.rb
 - spec/_request.rb
 - spec/racket.rb
 - spec/test_custom_app/controllers/sub1/custom_sub_controller_1.rb
@@ -195,6 +213,10 @@ files:
 - spec/test_default_app/controllers/sub3/default_sub_controller_3.rb
 - spec/test_default_app/controllers/sub3/inherited/default_inherited_controller.rb
 - spec/test_default_app/public/hello.txt
+- spec/test_plugin_app/controllers/main.rb
+- spec/test_plugin_app/controllers/sub/sub.rb
+- spec/test_plugin_app/sass/sub/test.scss
+- spec/test_plugin_app/sass/test.scss
 homepage: https://github.com/lasso/racket
 licenses:
 - GNU AFFERO GENERAL PUBLIC LICENSE, version 3