roger 1.7.2 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90bed681641cf5722ab1358fb98eb699beeec2db
-  data.tar.gz: f96a2a9b467568731dd0e3dcb3d60729bde47ad2
+  metadata.gz: 16132ae1857a2fc40e046c297848b5f3683dd249
+  data.tar.gz: b82228479d276c41069da98f8bf473a0f5478a85
 SHA512:
-  metadata.gz: 86c610fe97e1e7f8a2080676c1d87731750b20faf9294e75205b2638e72da37fa38bf4af536f7c564270b3ca17655263768914e4efd94ba5989102ea1c6ad26d
-  data.tar.gz: c7234601296a0d70c2b5c1ead72008399e922b1ae2daad1f291741978717d4f0d93ebb6afd397b4e65bf74f5feb7a7381a927839a857f39dc60122b57fa08faf
+  metadata.gz: d5f59c20f09f5cbab909ceaa865c1f6b1d6bdac61c863bf9e3e3df6c549c4d0effd212d379a9e215d09a41d32e5e83f8269ece9f423194b6e95f83c0db57a81c
+  data.tar.gz: 54ddecc3563773870ee17ae3c0e712e180f0f6b4969a83ff8fa5afd17055e7fd00fb1598f2723317a58291cc1a09ab3b47cde23947d7e797d3e13a479f886769

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## Version 1.8.0
+* Roger Rack application now adheres to match/skip options. Pass them in the rogerfile as follows:
+    ```
+    roger.server do |s|
+      s.application_options = { match: [], skip: [] }
+    end
+    ```
+
 ## Version 1.7.2
 * Return from partials instead of rendering partial content as string. This allows us to have code in ruby blocks instead of just more ERB.
 
@@ -42,7 +50,7 @@
 
 ## Version 1.5.0
 * Roger won't be tested on Ruby 1.9.x anymore
-* The way we render templates has been revamped. It is now possible to have multi-pass templates so you can do `.md.erb` which will first be processed by `erb` and then by the `md` tilt template handler. 
+* The way we render templates has been revamped. It is now possible to have multi-pass templates so you can do `.md.erb` which will first be processed by `erb` and then by the `md` tilt template handler.
 * The way templates are searched has changed to be more predictable. You may notice the change when you have the same filenames with different extensions.
 * You can now use local partials by just using an underscore as prefix. So `<%= partial('bla') %>` will look for `_bla.*` relative to the current template first and `bla.*` in the partials directory second (current behaviour).
 * Template recursion will be detected and prevented instead of giving a stack overflow.
@@ -102,11 +110,11 @@ This is a dud. It's identical to 1.3.1. Don't use.
 * Fix missing variables in release
 
 ## Version 1.2.1
-* Fix missing env (https://github.com/DigitPaint/roger/issues/24) 
+* Fix missing env (https://github.com/DigitPaint/roger/issues/24)
 
 ## Version 1.2.0
 * `roger.project` is now always in `env` when running as a project or as a release. Use this in favor of `env["MOCKUP_PROJECT"]`
-* All Roger code now is linted by Rubocop. More tests have been added and more documentation as well. Still not everything may have been covered by the tests. 
+* All Roger code now is linted by Rubocop. More tests have been added and more documentation as well. Still not everything may have been covered by the tests.
 
 
 ## Version 1.1.3

data/doc/rogerfile.md

@@ -21,6 +21,8 @@ Sass::Plugin.options[:css_location] = "./html/stylesheets"
 # Server is a regular Rack interface.
 roger.serve do |server|
   server.use :sass
+
+  server.application_options = {match: ["**/*.html.erb"]} # Config for Rack application (call is optional)
 end
 
 # Define tests

data/lib/roger/helpers/get_files.rb

@@ -2,20 +2,36 @@ module Roger
   module Helpers
     # Helper to include the get_files method
     module GetFiles
+      GLOB_OPTIONS = File::FNM_PATHNAME | File::FNM_EXTGLOB | File::FNM_DOTMATCH
+
       # Get files from a path, skipping excludes.
       #
       # @param [Array] globs an array of file path globs that will be globbed
       #                against the project path
       # @param [Array] excludes an array of regexps[!] that will be excluded
       #                from the result.
-      # @param [String, Pathname] Path to search files in
-      def get_files(globs, excludes = [], path = nil)
+      def get_files(globs, excludes = [])
         path = Pathname.new(get_files_default_path)
-        files = globs.map { |g| Dir.glob(path + g) }.flatten
+        files = globs.map { |g| Dir.glob(path + g, GLOB_OPTIONS) }.flatten
         files.reject! { |file| excludes.detect { |e| file.match(e) } } if excludes.any?
         files.select { |file| File.file?(file) }
       end
 
+      # See if a file matches globs/excludes
+      #
+      # @param [.to_s] path the path to match
+      # @param [Array] globs an array of file path globs that will be matched against path
+      # @param [Array] exclude an array of regexps[!] that will be matched negatively against path
+      #
+      # @return [Boolean] Did the passed path match against the globs and excludes?
+      def match_path(path, globs, excludes = [])
+        path = path.to_s
+        match = globs.detect { |glob| File.fnmatch?(glob, path, GLOB_OPTIONS) }
+        return false unless match # No need to check excludes if we don't match anyway
+
+        !excludes.find { |e| path.match(e) }
+      end
+
       protected
 
       # The default path to use when calling get_files

data/lib/roger/rack/roger.rb

@@ -9,10 +9,24 @@ module Roger
   module Rack
     # Roger middleware that processe roger templates
     class Roger
-      attr_reader :project
+      include ::Roger::Helpers::GetFiles
+      attr_reader :project, :options
 
-      def initialize(project)
+      def default_options
+        {
+          match: ["**/*.{html,md,html.erb}"],
+          skip: []
+        }
+      end
+
+      # Initialize the Rack app
+      #
+      # @param [Hash] options Options to use
+      #
+      # @option options
+      def initialize(project, options = {})
         @project = project
+        @options = default_options.update(options)
         @docroot = project.html_path
 
         @resolver = Resolver.new(@docroot)
@@ -23,7 +37,8 @@ module Roger
         url = env["PATH_INFO"]
         env["MOCKUP_PROJECT"] = env["roger.project"] || @project
 
-        if template_path = @resolver.url_to_path(url)
+        template_path = @resolver.url_to_path(url)
+        if process_path_by_roger?(template_path)
           env["rack.errors"].puts "Rendering template #{template_path.inspect} (#{url.inspect})"
           build_response(template_path, env).finish
         else
@@ -34,6 +49,16 @@ module Roger
 
       protected
 
+      # Wether or not we should process this
+      # path by the Roger renderer.
+      def process_path_by_roger?(path)
+        return false unless path
+
+        return false unless match_path(path, @options[:match], @options[:skip])
+
+        ::Roger::Renderer.will_render?(path)
+      end
+
       def build_response(template_path, env)
         renderer = ::Roger::Renderer.new(
           env,
@@ -43,6 +68,7 @@ module Roger
         mime = ::Rack::Mime.mime_type(File.extname(template_path), "text/html")
         ::Rack::Response.new do |res|
           res.headers["Content-Type"] = mime if mime
+          res.headers["X-Handled-By"] = "Roger"
           res.status = 200
           res.write renderer.render(template_path, @project.options[:renderer] || {})
         end

data/lib/roger/renderer.rb

@@ -22,6 +22,11 @@ module Roger
         @helpers || []
       end
 
+      # Will the renderer render this path to something meaningful?
+      def will_render?(path)
+        Tilt.templates_for(path.to_s).any?
+      end
+
       # Try to infer the final extension of the output file.
       def target_extension_for(path)
         if type = MIME::Types[target_mime_type_for(path)].first

data/lib/roger/server.rb

@@ -28,6 +28,11 @@ module Roger
 
     attr_accessor :port, :handler, :host, :auto_port
 
+    # @attr_accessor [Hash] Options pass to ::Roger::Rack::Roger initialization
+    #
+    # @see ::Roger::Rack:Roger
+    attr_accessor :application_options
+
     def initialize(project, options = {})
       @project = project
 
@@ -143,7 +148,7 @@ module Roger
     def application
       return @app if @app
 
-      @stack.run Rack::Roger.new(project)
+      @stack.run Rack::Roger.new(project, @application_options || {})
 
       @app = @stack
     end

data/lib/roger/version.rb

@@ -1,4 +1,4 @@
 # Roger main namespace
 module Roger
-  VERSION = "1.7.2".freeze
+  VERSION = "1.8.0".freeze
 end

data/test/project/partials/test/array.html.erb

@@ -0,0 +1 @@
+<% yield.each do |value| %><%= value %><% end %>

data/test/unit/helpers/get_files_test.rb

@@ -34,6 +34,7 @@ module Roger
       files = [
         "a.js",
         "1.js",
+        "2.js",
         "1.html",
         "dir/2.js",
         "dir/3.js",
@@ -55,6 +56,12 @@ module Roger
       assert_array_contains(expect, files)
     end
 
+    def test_glob_extended
+      files = @object.get_files(["**/{1,2}.js"])
+      expect = @files.grep(/[12]\.js\Z/)
+      assert_array_contains(expect, files)
+    end
+
     def test_get_only_files
       dir = @object.construct.directory "evil.js"
       files = @object.get_files(["*.js"])
@@ -67,6 +74,34 @@ module Roger
       assert_array_contains(expect, files)
     end
 
+    def test_match_path_with_glob_in_root
+      path = "file.js"
+      assert @object.match_path(path, ["*"])
+      assert @object.match_path(path, ["**/*"])
+      assert @object.match_path(path, ["**/*.js"])
+    end
+
+    def test_match_path_with_glob_in_subdir
+      path = "dir/subdir/4.js"
+      assert !@object.match_path(path, [])
+      assert !@object.match_path(path, ["*"])
+      assert @object.match_path(path, ["**/*"])
+      assert @object.match_path(path, ["**/*.js"])
+      assert !@object.match_path(path, ["**/*.html"])
+      assert @object.match_path(path, ["**/*.html", "**/*.js"])
+    end
+
+    def test_match_path_with_extended_glob
+      assert @object.match_path("4.js", ["{3,4}.js"])
+      assert !@object.match_path("4.js", ["{5}.js"])
+    end
+
+    def test_match_path_with_excludes
+      path = "dir/subdir/4.js"
+      assert @object.match_path(path, ["**/*"], [/\.html\Z/])
+      assert !@object.match_path(path, ["**/*"], [/\.js\Z/])
+    end
+
     protected
 
     def assert_array_contains(expect, result)

data/test/unit/rack/roger_test.rb

@@ -19,6 +19,25 @@ module Roger
         response = request.get("/erb")
 
         assert response.body.include?("ERB format")
+        assert_equal "Roger", response.headers["X-Handled-By"]
+      end
+
+      def test_middleware_does_not_render_unrenderables
+        @project.construct.file "html/myjpeg.jpg", "JPG"
+        request = ::Rack::MockRequest.new(@app)
+        response = request.get("/myjpeg.jpg")
+
+        assert response.body.include?("JPG")
+        assert_equal nil, response.headers["X-Handled-By"]
+      end
+
+      def test_middleware_does_not_render_unwanteds
+        @project.construct.file "html/mysass.scss", ".scss{}"
+        request = ::Rack::MockRequest.new(@app)
+        response = request.get("/mysass.scss")
+
+        assert response.body.include?(".scss{}")
+        assert_equal nil, response.headers["X-Handled-By"]
       end
 
       def test_renderer_options_are_passed

data/test/unit/server_test.rb

@@ -59,5 +59,26 @@ module Roger
       # This is a bit of a clunky comparison but it suffices for now
       assert_equal @project.object_id.to_s, request.get("/").body
     end
+
+    def test_application_options
+      @server.application_options = { test_option: true }
+
+      test = Class.new do
+        def initialize(app)
+          @app = app
+        end
+
+        def call(_env)
+          [200, {}, [@app.options[:test_option].to_s]]
+        end
+      end
+
+      @server.use test
+
+      request = ::Rack::MockRequest.new(@server.send(:application))
+
+      # This is a bit of a clunky comparison but it suffices for now
+      assert_equal "true", request.get("/").body
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: roger
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.8.0
 platform: ruby
 authors:
 - Flurin Egger
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-09 00:00:00.000000000 Z
+date: 2017-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -302,6 +302,7 @@ files:
 - test/project/partials/formats/erb.html.erb
 - test/project/partials/partials-test.html.erb
 - test/project/partials/test/_underscored.html.erb
+- test/project/partials/test/array.html.erb
 - test/project/partials/test/deep_recursive.html.erb
 - test/project/partials/test/erb.html.erb
 - test/project/partials/test/front_matter.html.erb
@@ -418,6 +419,7 @@ test_files:
 - test/project/partials/formats/erb.html.erb
 - test/project/partials/partials-test.html.erb
 - test/project/partials/test/_underscored.html.erb
+- test/project/partials/test/array.html.erb
 - test/project/partials/test/deep_recursive.html.erb
 - test/project/partials/test/erb.html.erb
 - test/project/partials/test/front_matter.html.erb