rack-server-pages 0.2.0 → 0.3.0

data/lib/rack/server_pages.rb

@@ -2,9 +2,9 @@
 require 'rack'
 require 'rack/utils'
 require 'rack/mime'
-require 'rack/logger'
 require 'time'
 require 'forwardable'
+require 'digest/sha2'
 
 module Rack
   class ServerPages
@@ -40,10 +40,49 @@ module Rack
         @app
       else
         file = select_template_file(files)
-        (tpl = Template[file]) ? server_page(tpl) : Rack::Files.new(file.split(path_info).first)
+        (tpl = Template[file]) ? server_page(tpl) : static_file(file, path_info)
       end.call(env)
     end
 
+    module StaticFiles
+      def static_file(file, path_info)
+        root = file.split(path_info).first
+        return Rack::Files.new(root) unless ::File.file?(file) && ::File.readable?(file)
+
+        headers = static_headers(file)
+        files = Rack::Files.new(root, headers)
+        lambda do |env|
+          if @config.static_etags && %w[GET HEAD].include?(env['REQUEST_METHOD']) && matching_etag?(env['HTTP_IF_NONE_MATCH'], headers[Rack::ETAG])
+            [304, headers.dup, []]
+          else
+            files.call(static_request_env(env))
+          end
+        end
+      end
+
+      private
+
+      def static_request_env(env)
+        # If-None-Match takes precedence over If-Modified-Since.
+        ignore_modified_since = !@config.static_timestamps || (@config.static_etags && env.key?('HTTP_IF_NONE_MATCH'))
+        ignore_modified_since ? env.merge('HTTP_IF_MODIFIED_SINCE' => nil) : env
+      end
+
+      def static_headers(file)
+        headers = @config.static_etags ? { Rack::ETAG => %("#{Digest::SHA256.file(file).hexdigest}") } : {}
+        @config.static_cache_control ? headers.merge(Rack::CACHE_CONTROL => @config.static_cache_control) : headers
+      end
+
+      def matching_etag?(condition, etag)
+        condition.to_s.split(',').any? do |candidate|
+          candidate = candidate.strip.sub(%r{\AW/}, '')
+          candidate == '*' || candidate == etag
+        end
+      end
+    end
+
+    include StaticFiles
+
     def find_template_files(path_info)
       if m = path_info.match(@path_regex)
         @config.view_paths.inject([]) do |files, path|
@@ -67,7 +106,7 @@ module Rack
 
     def server_page(template)
       lambda do |env|
-        @binding.new(env).tap do |scope|
+        @binding.new(env, self).tap do |scope|
           catch(:halt) do
             begin
               @config.filter.invoke(scope, :before)
@@ -88,6 +127,36 @@ module Rack
       end
     end
 
+    module AssetPaths
+      def asset_path(path)
+        path, fragment = path.to_s.split('#', 2)
+        path, query = path.to_s.split('?', 2)
+        path, file = asset_file(path.to_s)
+        query = Rack::Utils.parse_query(query)
+        query['v'] = Digest::SHA256.file(file).hexdigest
+        "#{path}?#{Rack::Utils.build_query(query)}#{fragment && "##{fragment}"}"
+      end
+
+      private
+
+      def asset_file(path)
+        raise ArgumentError, 'asset_path requires a local asset path without parent-directory traversal' unless valid_asset_path?(CGI.unescape(path))
+
+        path = "#{@config.effective_path}/#{path.sub(%r{\A/}, '')}"
+        file = select_template_file(find_template_files(CGI.unescape(path)) || [])
+        raise Errno::ENOENT, path unless file && ::File.file?(file)
+
+        [path, file]
+      end
+
+      def valid_asset_path?(path)
+        !path.empty? && (path !~ %r{\A(?:[a-z][a-z0-9+.-]*:|//)}i) &&
+          !path.split('/').include?('..') && !path.include?("\0")
+      end
+    end
+
+    include AssetPaths
+
     class Filter
       TYPES = [:before, :after, :on_error].freeze
       TYPES.each do |type|
@@ -144,7 +213,8 @@ module Rack
         end
       end
 
-      hash_accessor :view_path, :effective_path, :cache_control, :default_charset, :failure_app, :show_exceptions
+      hash_accessor :view_path, :effective_path, :cache_control, :static_cache_control, :static_etags, :static_timestamps,
+                    :default_charset, :failure_app, :show_exceptions
 
       attr_reader :filter
 
@@ -154,6 +224,8 @@ module Rack
         super
         self[:default_charset] ||= 'utf-8'
         self[:view_path] ||= %w(views public)
+        self[:static_etags] = true
+        self[:static_timestamps] = true
         @helpers = []
         @filter  = Filter.new
       end
@@ -188,7 +260,7 @@ module Rack
         end
 
         def tilt?
-          @use_tilt.nil? ? (@use_tilt ||= !!defined?(Tilt)) : @use_tilt && defined?(Tilt)
+          @use_tilt != false && !!defined?(Tilt) && Tilt.respond_to?(:[])
         end
 
         def use_tilt(bool = true)
@@ -274,6 +346,10 @@ module Rack
     end
 
     module CoreHelper
+      def asset_path(path)
+        url(@server_pages.asset_path(path))
+      end
+
       def redirect(target, status = 302)
         response.redirect(target, status)
         halt
@@ -315,7 +391,7 @@ module Rack
 
       attr_reader :request, :response
 
-      def_delegators :request, :env, :params, :session, :cookies, :logger
+      def_delegators :request, :env, :params, :session, :cookies
       def_delegators :response, :headers, :set_cookies, :delete_cookie
 
       class << self
@@ -330,9 +406,10 @@ module Rack
         end
       end
 
-      def initialize(env)
+      def initialize(env, server_pages = nil)
         @request  = Rack::Request.new(env)
         @response = Rack::Response.new
+        @server_pages = server_pages
         # @response['Content-Type'] = nil
       end
 

data/lib/rack-server-pages/version.rb

@@ -1,5 +1,5 @@
 module Rack
   class ServerPages
-    VERSION = '0.2.0'.freeze
+    VERSION = '0.3.0'.freeze
   end
 end

data/rack-server-pages.gemspec

@@ -9,13 +9,10 @@ Gem::Specification.new do |s|
   s.email       = ['m@igrs.jp']
   s.homepage    = 'http://github.com/migrs/rack-server-pages'
   s.licenses    = ['MIT']
-  s.summary     = 'Rack middleware and appilcation for serving dynamic pages in very simple way.'
-  s.description = 'Rack middleware and appilcation for serving dynamic pages in very simple way.
-                     There are no controllers and no models, just only views like a asp, jsp and php!'
+  s.summary     = 'Rack middleware and appilcation for serving dynamic pages.'
+  s.description = 'Rack middleware and appilcation for serving dynamic pages in very simple way, without controllers or models, only views similar to ASP, JSP and PHP.'
 
-  s.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(spec)/})
-  end
+  s.files = Dir['lib/**/*', 'CHANGES.md', 'README.md', 'UPGRADING.md', 'RELEASING.md', 'LICENSE.md', 'rack-server-pages.gemspec']
 
   s.require_paths = ['lib']
 

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rack-server-pages
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Masato Igarashi
 - Daniel Doubrovkine
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -25,79 +24,27 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: |-
-  Rack middleware and appilcation for serving dynamic pages in very simple way.
-                       There are no controllers and no models, just only views like a asp, jsp and php!
+description: Rack middleware and appilcation for serving dynamic pages in very simple
+  way, without controllers or models, only views similar to ASP, JSP and PHP.
 email:
 - m@igrs.jp
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/lint.yml"
-- ".github/workflows/test.yml"
-- ".gitignore"
-- ".rspec"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
 - CHANGES.md
-- Gemfile
-- Guardfile
 - LICENSE.md
 - README.md
-- Rakefile
-- config.ru
+- RELEASING.md
+- UPGRADING.md
 - lib/rack-server-pages.rb
 - lib/rack-server-pages/version.rb
 - lib/rack/server_pages.rb
-- public/CHANGES.erb
-- public/README.erb
-- public/_layout.html.erb
-- public/folder/sample.erb
-- public/folder/special-sub.folder-@/sample.erb
-- public/folder/subfolder/(sub-folder)/sample-in-sub-folder.extension.erb
-- public/folder/subfolder/sample.erb
-- public/folder/по-русски/пример.erb
-- public/index.html
-- public/info.php
-- public/rack_logo.png
-- public/rack_logo@2x.png
-- public/sample.erb
-- public/style.css.sass
 - rack-server-pages.gemspec
-- views/about.html.slim
-- views/article.html.md
-- views/betty.css.sass
-- views/contact.xml.builder
-- views/examples/_layout.html.erb
-- views/examples/_time.html.erb
-- views/examples/builder.xml.builder
-- views/examples/coffee.js.coffee
-- views/examples/erb.html.erb
-- views/examples/haml.html.haml
-- views/examples/html.html
-- views/examples/index.html.erb
-- views/examples/less.css.less
-- views/examples/liquid.html.liquid
-- views/examples/markaby.html.mab
-- views/examples/markdown.html.markdown
-- views/examples/nokogiri.xml.nokogiri
-- views/examples/radius.html.radius
-- views/examples/rdoc.html.rdoc
-- views/examples/robots.txt
-- views/examples/sass.css.sass
-- views/examples/scss.css.scss
-- views/examples/slim.html.slim
-- views/examples/source.html.slim
-- views/examples/textile.html.textile
-- views/examples/wiki.html.wiki
-- views/examples/yajl.json.yajl
-- views/script.js.coffee
 homepage: http://github.com/migrs/rack-server-pages
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,9 +59,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 4.0.20
 specification_version: 4
-summary: Rack middleware and appilcation for serving dynamic pages in very simple
-  way.
+summary: Rack middleware and appilcation for serving dynamic pages.
 test_files: []

data/.github/workflows/lint.yml

@@ -1,15 +0,0 @@
-name: lint
-on: [push, pull_request]
-jobs:
-  rubocop:
-    name: RuboCop
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.2"
-          bundler-cache: true
-      - run: bundle exec rubocop

data/.github/workflows/test.yml

@@ -1,37 +0,0 @@
----
-name: test
-on: [push, pull_request]
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    name: test (ruby=${{ matrix.ruby-version }}, rack=${{ matrix.rack-version }})
-    strategy:
-      fail-fast: false
-      matrix:
-        rack-version:
-          - "~> 2"
-          - "~> 3"
-        ruby-version:
-          - "3.3"
-          - "3.2"
-          - "3.1"
-          - "3.0"
-    env:
-      RACK_VERSION: ${{ matrix.rack-version }}
-    steps:
-      - uses: actions/checkout@v4
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby-version }}
-          bundler-cache: true
-      - run: bundle show | grep rack
-      - uses: browser-actions/setup-firefox@latest
-        with:
-          firefox-version: "108.0"
-      - uses: browser-actions/setup-geckodriver@latest
-        with:
-          geckodriver-version: "0.34.0"
-      - uses: GabrielBB/xvfb-action@v1
-        with:
-          run: |
-            bundle exec rake spec

data/.gitignore

@@ -1,11 +0,0 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-.DS_Store
-*.swp
-tmp/*
-.sass-cache
-coverage/
-.rbenv-version
-.rvmrc

data/.rspec

@@ -1,2 +0,0 @@
---format=documentation
---color

data/.rubocop.yml

@@ -1,10 +0,0 @@
-AllCops:
-  NewCops: enable
-  TargetRubyVersion: 3.0
-
-inherit_from: .rubocop_todo.yml
-
-require:
-  - rubocop-capybara
-  - rubocop-rake
-  - rubocop-rspec