syro-tilt 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c344875f1c37067ea3ede68552941eda515bf0d3e0b66e9b3335c5e5b15900f
-  data.tar.gz: a2d4cec3221689f8b5f7c221c9e09f2e22f5c148266aacdb73c8cf41716e245d
+  metadata.gz: 1cfe3eed8f52da21ccc32308b4ec07c7992fb4a4cc378685a62760bb1d3e1496
+  data.tar.gz: 750a5807d161a85b49882fb2ada1ab1ce425688dd8346a7fd1724c98ff196a5e
 SHA512:
-  metadata.gz: 67f316b8d950eb1fcf8409883c47a000c1959c1ab208593681012d70b74642d6bce3b7df77e10bf6ff87975f121cb632da015704104c35774582a67df494e211
-  data.tar.gz: 03711476cdca8eb7867d3ab041e349f4d0cd57d464393753a46ab3319db766169054d97b4cefd694cca88f27a6e805b8747e8117724f987f78c27664a9ebbe7a
+  metadata.gz: 27d77ed0f98427523090cae24cf2e301adf305a27e78b4c41251eb0f4e8e9faa5d10a0f181df589312ada9cdd483cc8453e017e702f963677bc2e3af4f5e8bc4
+  data.tar.gz: 756805dbea57d98b914b755f8765ce5b55176917928698cf750cd566762c66489c36c0e1efbd94a1b0609baa432aea6f224086b96d13e452626ae7628be1ff16

data/.rubocop.yml

@@ -4,7 +4,7 @@ AllCops:
   DisplayCopNames: true
   DisplayStyleGuide: true
   ExtraDetails: true
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.3
 
 
 Performance:
@@ -57,4 +57,3 @@ Style/IfUnlessModifier:
 
 Style/Next:
   MinBodyLength: 8
-

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.6
+  - 2.5
+  - 2.4
+  - 2.3

data/README.md

@@ -1,5 +1,8 @@
 # Syro::Tilt
 
+[![Gem Version](https://badge.fury.io/rb/syro-tilt.svg)](https://badge.fury.io/rb/syro-tilt)
+[![Build Status](https://secure.travis-ci.org/evanleck/syro-tilt.svg)](https://travis-ci.org/evanleck/syro-tilt)
+
 Render [Tilt][tilt] templates in [Syro][syro] routes.
 
 
@@ -75,6 +78,38 @@ end
 `content_for`: capture content for use later.
 
 
+## Template File Naming
+
+For templates that will be passed to `render`, it's important that you name your
+templates following the pattern `#{ identifier }.#{ mime_type }.#{
+template_engine }`. For example `home.html.erb` would be returned with the MIME
+type `text/html` (derived from the `.html` extension) and rendered by Tilt using
+the preferred mapping for `.erb` extensions.
+
+Templates that are only ever used by the `partial` method do not require the
+same naming because `partial` does not set the response's content type.
+
+
+## Caching
+
+There's an optional in-memory cache included that will cache calls to `template`
+and `template_path`. You probably don't want to use the cache during development
+since you'll have to restart your server to see updated templates, but it will
+likely be useful in production. To use it, require `syro/tilt/cache`.
+
+```ruby
+require 'syro'
+require 'syro/tilt'
+require 'syro/tilt/cache'
+
+app = Syro.new do
+  get do
+    render 'home'
+  end
+end
+```
+
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/syro/tilt.rb

@@ -51,23 +51,22 @@ class Syro # :nodoc:
     #
     # @return [String]
     #   The path to the template file.
-    def template_path(path, from = nil)
+    def template_path(path, from = nil, accept = nil)
       from ||= templates_directory
       path = File.join(from, path)
 
-      accepts = env.fetch(HTTP_ACCEPT) { EMPTY }.to_s.then do |header|
-        # Taken from Rack::Request#parse_http_accept_header (which is a private
-        # method).
-        header.split(ACCEPT_SPLIT_MULTIPLES).map do |part|
-          attribute, parameters = part.split(ACCEPT_SPLIT_PARTS, 2)
-          quality = 1.0
-
-          if parameters && ACCEPT_CAPTURE_QUALITY.match?(parameters)
-            quality = ACCEPT_CAPTURE_QUALITY.match(parameters)[1].to_f
+      # Taken from Rack::Request#parse_http_accept_header (which is a private
+      # method).
+      accepts = (accept || env.fetch(HTTP_ACCEPT) { EMPTY }).to_s.split(ACCEPT_SPLIT_MULTIPLES).map do |part|
+        attribute, parameters = part.split(ACCEPT_SPLIT_PARTS, 2)
+        quality =
+          if parameters =~ ACCEPT_CAPTURE_QUALITY
+            ACCEPT_CAPTURE_QUALITY.match(parameters)[1].to_f
+          else
+            1.0
           end
 
-          [attribute, quality]
-        end
+        [attribute, quality]
       end
 
       # Reject "*/*" because it will always match the first thing it is compared
@@ -76,7 +75,7 @@ class Syro # :nodoc:
 
       # Find all potential templates e.g. ones with the same name but different
       # template engines or MIME types.
-      potentials = Dir.glob(File.join(from, '**', '*')).filter do |potential|
+      potentials = Dir.glob(File.join(from, '**', '*')).select do |potential|
         potential.start_with?(path)
       end.sort
 
@@ -116,7 +115,10 @@ class Syro # :nodoc:
     #
     # @return [String]
     def partial(path, locals = {})
-      template(template_path(path, locals.delete(:from))).render(self, locals) { yield if block_given? }
+      accept = env.fetch(HTTP_ACCEPT) { EMPTY }
+      from = locals.delete(:from) { templates_directory }
+
+      template(template_path(path, from, accept)).render(self, locals) { yield if block_given? }
     end
 
     # Set or get the current layout. A layout is just another template to wrap
@@ -141,10 +143,13 @@ class Syro # :nodoc:
     # @option locals [String] :from
     #   The directory to look for templates within.
     def render(path, locals = {})
+      accept = env.fetch(HTTP_ACCEPT) { EMPTY }
+      from = locals.delete(:from) { templates_directory }
+
       content = partial(path, locals.dup) { yield if block_given? }
       content = partial(layout, locals.dup) { content } if layout
 
-      res.headers[Rack::CONTENT_TYPE] = template_mime_type(template_path(path, locals[:from]))
+      res.headers[Rack::CONTENT_TYPE] = template_mime_type(template_path(path, from, accept))
       res.write content
     end
 

data/lib/syro/tilt/cache.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+require_relative '../tilt'
+
+class Syro # :nodoc:
+  module Tilt
+    # Add template and path caching to Syro::Tilt.
+    module Cache
+      # A very thin wrapper around Hash, with a Mutex.
+      class MemoryStore
+        def initialize
+          @cache = {}
+          @mutex = Mutex.new
+        end
+
+        def fetch(*key)
+          @mutex.synchronize do
+            @cache.fetch(key) do
+              @cache[key] = yield
+            end
+          end
+        end
+      end
+
+      @template_cache = MemoryStore.new
+      @template_path_cache = MemoryStore.new
+
+      # @return [MemoryStore]
+      def self.template_cache
+        @template_cache
+      end
+
+      # @return [MemoryStore]
+      def self.template_path_cache
+        @template_path_cache
+      end
+
+      # Cache calls to Syro::Tilt#template.
+      def template(path)
+        Cache.template_cache.fetch(path) do
+          super(path)
+        end
+      end
+
+      # Cache calls to Syro::Tilt#template_path.
+      def template_path(path, from, accept)
+        Cache.template_path_cache.fetch(path, from, accept) do
+          super(path, from, accept)
+        end
+      end
+    end
+  end
+
+  Tilt.prepend(Tilt::Cache)
+end

data/syro-tilt.gemspec

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 Gem::Specification.new do |spec|
   spec.name = 'syro-tilt'
-  spec.version = '0.1.0'
+  spec.version = '0.2.0'
   spec.authors = ['Evan Lecklider']
   spec.email = ['evan@lecklider.com']
   spec.summary = 'Render Tilt templates in Syro routes.'
@@ -9,12 +9,14 @@ Gem::Specification.new do |spec|
   spec.homepage = 'https://github.com/evanleck/syro-tilt'
   spec.license = 'MIT'
   spec.files = `git ls-files`.split("\n")
+  spec.required_ruby_version = '>= 2.3.0'
   spec.require_paths = ['lib']
 
   spec.add_dependency 'syro', '~> 3.0'
   spec.add_dependency 'tilt', '~> 2.0'
 
-  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'bundler', '>= 1.7'
+  spec.add_development_dependency 'erubi', '>= 1.8'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
 end

data/test/syro_tilt_test.rb

@@ -24,7 +24,7 @@ describe Syro::Tilt do
     end
 
     it 'finds the first match for an ambiguous file' do
-      assert_equal 'test/views/plain.txt.erb', template_path('plain')
+      assert_equal 'test/views/plain.anope.erb', template_path('plain')
     end
 
     it "returns nil for files that don't exist" do
@@ -46,7 +46,7 @@ describe Syro::Tilt do
 
   describe '#partial' do
     it 'returns the contents of a template' do
-      assert_equal "Plain text.\n", partial('plain')
+      assert_equal "First plain text.\n", partial('plain')
     end
 
     it 'accepts local variables' do
@@ -93,7 +93,7 @@ describe Syro::Tilt do
       render('plain')
 
       assert_equal 'text/plain', res.headers['Content-Type']
-      assert_equal ["Plain text.\n"], res.body
+      assert_equal ["First plain text.\n"], res.body
     end
 
     it 'writes html text to the response' do
@@ -146,4 +146,34 @@ describe Syro::Tilt do
       refute content_for?(:notthere)
     end
   end
+
+  describe '#template' do
+    it 'returns a Tilt template' do
+      assert_instance_of Tilt::ErubiTemplate, template('test/views/typed.html.erb')
+    end
+
+    it "raises an error on missing files (Tilt's default behavior)" do
+      assert_raises(Errno::ENOENT) do
+        template('test/views/notthere.txt.erb')
+      end
+    end
+  end
+
+  describe 'Syro::Tilt::Cache' do
+    require_relative '../lib/syro/tilt/cache'
+
+    prepend Syro::Tilt::Cache
+
+    it 'caches templates' do
+      initial = template('test/views/typed.html.erb')
+
+      assert_equal initial, Syro::Tilt::Cache.template_cache.fetch('test/views/typed.html.erb')
+    end
+
+    it 'caches template paths' do
+      initial = template_path('typed.html', 'test/views', 'html')
+
+      assert_equal initial, Syro::Tilt::Cache.template_path_cache.fetch('typed.html', 'test/views', 'html')
+    end
+  end
 end

data/test/views/plain.anope.erb

@@ -0,0 +1 @@
+First plain text.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: syro-tilt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Evan Lecklider
@@ -42,16 +42,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: erubi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -89,16 +103,19 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/syro/tilt.rb
+- lib/syro/tilt/cache.rb
 - syro-tilt.gemspec
 - test/syro_tilt_test.rb
 - test/views/layout.erb
 - test/views/locals.erb
 - test/views/notsoplain.html.erb
+- test/views/plain.anope.erb
 - test/views/plain.txt.erb
 - test/views/typed.anope.erb
 - test/views/typed.html.erb
@@ -115,7 +132,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="