string_template 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1676affa8a6c17cb3a067f44f136d486175eb9929991cb45eff8f6f2cc6a5866
+  data.tar.gz: 74fde3634a89fd89673b511c7498450127ca4e4a28217e1a13be4d616d4d9d45
+SHA512:
+  metadata.gz: 4ae08e930afd613d01ad6a6ca0fffc7283a30c9ab43f5b2b60c32cfe5890f0d768583d794e8e2abdbacc82618f42fd7a01e72f2107c6424a425f2b0c1ae77d1b
+  data.tar.gz: 1f53eef7a9caa329b86df4f25523e9d08a8380d30aac46c991d0d6bf45a48ba803d17d29dacb9d95ab425f11c53d218f0d4acd9c03280f777d23f2294fadaa27

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem update bundler

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in string_template.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Akira Matsuda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# StringTemplate
+
+The fastest template engine for Rails.
+
+
+## Concept
+
+Ruby's String literal has such a powerful interpolation mechanism.
+It's almost a template engine, it's the fastest way to compose a String, and the syntax is already very well known by every Ruby programmer.
+Why don't we use this for the view files in our apps?
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'string_template'
+```
+
+And then execute:
+
+    % bundle
+
+
+## Syntax
+
+StringTemplate's syntax is based on Ruby's String interpolation.
+Plus, you can use Action View features.
+Please take a look at the tests for actual examples.
+
+
+## Filenames
+By default, string\_template renders view files with `.string` extension, e.g. `app/views/posts/show.html.string`
+
+
+## So, Should We Rewrite Everything with This?
+string\_template may not be the best choice as a general purpose template engine.
+It may sometimes be hard to express your template in a simple and maintainable code, especially when the template includes some business logic.
+So this template engine is recommended to use only for performance hotspots.
+For other templates, you might better use your favorite template engine such as haml, or haml, or haml.
+
+
+## Benchmark
+Following is the benchmark result showing how string\_template is faster than ERB, executed on Ruby trunk (2.6).
+This repo includes [this actual benchmarking script](https://github.com/amatsuda/string_template/blob/master/benchmark.rb) so that you can try it on your machine.
+
+```
+% ruby benchmark.rb
+Warming up --------------------------------------
+                 erb   986.519  i/100ms
+              string     1.614k i/100ms
+Calculating -------------------------------------
+                 erb    10.598k i/s -     49.325k in 4.654229s
+              string    19.550k i/s -     80.686k in 4.127156s
+
+Comparison:
+              string:     19550.0 i/s
+                 erb:     10597.9 i/s - 1.84x  slower
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/amatsuda/string_template.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/benchmark.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'rails'
+require 'action_view'
+require_relative 'lib/string_template'
+StringTemplate::Railtie.run_initializers
+require 'action_view/base'
+require 'benchmark_driver'
+
+Benchmark.driver do |x|
+  x.prelude %{ (view = Class.new(ActionView::Base).new('.')).instance_variable_set(:@world, 'world!') }
+  x.report 'erb', %{ view.render(template: 'hello', handlers: 'erb') }
+  x.report 'string', %{ view.render(template: 'hello', handlers: 'string') }
+  x.compare!
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "string_template"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hello.erb

@@ -0,0 +1,50 @@
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>
+hello, <%= @world %>

data/hello.string

@@ -0,0 +1,50 @@
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }
+hello, #{ @world }

data/lib/string_template.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative 'string_template/handler'
+require_relative 'string_template/railtie'

data/lib/string_template/handler.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module StringTemplate
+  class Handler
+    def self.call(template)
+      "%Q[#{template.source}]"
+    end
+
+    def self.handles_encoding?
+      true
+    end
+  end
+end

data/lib/string_template/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module StringTemplate
+  class Railtie < ::Rails::Railtie
+    initializer 'string_template' do
+      ActiveSupport.on_load :action_view do
+        ActionView::Template.register_template_handler :string, StringTemplate::Handler
+      end
+    end
+  end
+end

data/string_template.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "string_template"
+  spec.version       = '0.1.0'
+  spec.authors       = ["Akira Matsuda"]
+  spec.email         = ["ronnie@dio.jp"]
+
+  spec.summary       = "A template engine for Rails, focusing on speed, using Ruby's String interpolation syntax"
+  spec.description   = 'String is your template engine'
+  spec.homepage      = 'https://github.com/amatsuda/string_template'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rails'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'benchmark_driver'
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: string_template
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Akira Matsuda
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark_driver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: String is your template engine
+email:
+- ronnie@dio.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- benchmark.rb
+- bin/console
+- bin/setup
+- hello.erb
+- hello.string
+- lib/string_template.rb
+- lib/string_template/handler.rb
+- lib/string_template/railtie.rb
+- string_template.gemspec
+homepage: https://github.com/amatsuda/string_template
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.4
+signing_key: 
+specification_version: 4
+summary: A template engine for Rails, focusing on speed, using Ruby's String interpolation
+  syntax
+test_files: []