hmote 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 855833b547b4d187ff22113c18fe341b5c51d5cb
-  data.tar.gz: ede1156a3d50af5965e2bf39a5bd9dc550feb767
+  metadata.gz: 19990b7d9d7fe577bc7dc27b2557f6ec928d5620
+  data.tar.gz: 81433bcbf7ddc6068bd41a75ec4e1df0c69a9833
 SHA512:
-  metadata.gz: f8f3e5add70ab91115ffd4c3ec06fccee2527e3a77351aa2d225f7dbf5ee43a4777c70f7c4e54ecbcd598f9b1b7c8f7f9efa48a68d95a48e0b876d16a5d21006
-  data.tar.gz: d38d472e9bc930879e9261f1ddfa6c4e4a00255c0dbc236a1274489af5c1f8c0524a40bca639ea2f0b65535db23d34e614e0c11655254c6c251f5cd398a4cd9a
+  metadata.gz: 67dc3c6016d0f8d3a94bb644f04cf8c1badec0347c70304e8cd3ac4f099f707ee6d5e5a6e3d5a22cb3a9d861096af80a2482487c3ca0a57c3e0cb774149228be
+  data.tar.gz: aa7a8f852a4d7220a273ef42f3924cea6155cccf1d834858c82de74cf04e63f126427de0345a415cc471f32b5ae5f665f28be9c9a553fdde8cb3bba2288256b7

data/LICENSE

@@ -1,6 +1,5 @@
-Copyright (c) 2011-2014 Michel Martens
-Copyright (c) 2014-2015 Francesco Rodríguez
-Copyright (c) 2014-2015 Mayn Ektvedt Kjær
+Copyright (c) 2014-2016 Francesco Rodríguez
+Copyright (c) 2011-2015 Michel Martens
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,4 +1,4 @@
-hmote
+HMote [![Build Status](https://travis-ci.org/frodsan/hmote.svg)](https://travis-ci.org/frodsan/hmote)
 =====
 
 Minimal template engine with default escaping.
@@ -9,6 +9,27 @@ Description
 HMote is a fork of [Mote][mote] that uses [Hache][hache]
 to auto-escape HTML special characters.
 
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "hmote"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install hmote
+```
+
 Basic Usage
 -----------
 
@@ -132,14 +153,37 @@ Related projects:
 
 - [hmote-render][hmote-render]: HMote plugin for Cuba.
 
-Installation
+Contributing
 ------------
 
+Fork the project with:
+
 ```
-$ gem install hmote
+$ git clone git@github.com:frodsan/hmote.git
+```
+
+To install dependencies, use:
+
+```
+$ bundle install
 ```
 
+To run the test suite, do:
+
+```
+$ rake test
+```
+
+For bug reports and pull requests use [GitHub][issues].
+
+License
+-------
+
+HMote is released under the [MIT License][mit].
+
+[mit]: http://www.opensource.org/licenses/MIT
 [mote]: https://github.com/soveran/mote
 [hache]: https://github.com/harmoni/hache
 [hmote-render]: https://github.com/harmoni/hmote-render
+[issues]: https://github.com/frodsan/hmote/issues
 [xss]: http://en.wikipedia.org/wiki/Cross-Site_Scripting

data/lib/hmote/version.rb

@@ -1,3 +1,3 @@
 class HMote
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/hmote.rb

@@ -1,3 +1,26 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2011-2016 Francesco Rodríguez
+# Copyright (c) 2011-2015 Michel Martens
+#
+# 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.
+
 require "hache"
 
 class HMote
@@ -9,20 +32,12 @@ class HMote
 
   def self.parse(template, context = self, vars = [])
     terms = template.split(PATTERN)
-    parts = "Proc.new do |params, __o|\n params ||= {}; __o ||= ''\n"
+    parts = "Proc.new do |params, __o|\n params ||= {}; __o ||= ''\n".dup
 
-    vars.each do |var|
-      parts << sprintf("%s = params[%p]\n", var, var)
-    end
+    vars.each { |var| parts << format("%s = params[%p]\n", var, var) }
 
     while (term = terms.shift)
-      case term
-      when "<?"  then parts << "#{terms.shift}\n"
-      when "%"   then parts << "#{terms.shift}\n"
-      when "{{"  then parts << "__o << Hache.h((#{terms.shift}).to_s)\n"
-      when "{{!" then parts << "__o << (#{terms.shift}).to_s\n"
-      else            parts << "__o << #{term.dump}\n"
-      end
+      parts << parse_expression(terms, term)
     end
 
     parts << "__o; end"
@@ -30,6 +45,16 @@ class HMote
     compile(context, parts)
   end
 
+  def self.parse_expression(terms, term)
+    case term
+      when "<?"  then terms.shift + "\n"
+      when "%"   then terms.shift + "\n"
+      when "{{"  then "__o << Hache.h((" + terms.shift + ").to_s)\n"
+      when "{{!" then "__o << (" + terms.shift + ").to_s\n"
+      else            "__o << " + term.dump + "\n"
+    end
+  end
+
   def self.compile(context, parts)
     context.instance_eval(parts)
   end

data/test/helper.rb

@@ -1,2 +1,5 @@
-require "cutest"
+require "bundler/setup"
+require "minitest/autorun"
+require "minitest/pride"
+require "minitest/sugar"
 require_relative "../lib/hmote"

data/test/{helpers.rb → helpers_test.rb}

@@ -1,16 +1,14 @@
 require_relative "helper"
 
-class Cutest::Scope
+class HelpersTest < Minitest::Test
   include HMote::Helpers
 
-  def foo
-    "foo"
+  setup do
+    hmote_cache.clear
   end
-end
 
-scope("helpers") do
-  prepare do
-    hmote_cache.clear
+  def foo
+    "foo"
   end
 
   test "using functions in the context" do
@@ -18,7 +16,7 @@ scope("helpers") do
   end
 
   test "passing in a context" do
-    assert_raise(NameError) do
+    assert_raises(NameError) do
       hmote("test/foo.mote", {}, TOPLEVEL_BINDING)
     end
   end

data/test/{parsing.rb → parsing_test.rb}

@@ -1,6 +1,6 @@
 require_relative "helper"
 
-scope("parsing") do
+class ParsingTest < Minitest::Test
   test "assignment" do
     template = HMote.parse("{{ 1 + 2 }}")
 

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hmote
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Francesco Rodríguez
-- Mayn Kjær
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2016-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hache
@@ -26,52 +25,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: cutest
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '5.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
-description: A minimum operational template that escapes HTML tags by default. Inspired
-  by mote.
-email:
-- frodsan@protonmail.ch
-- mayn.kjaer@gmail.com
+        version: '5.8'
+- !ruby/object:Gem::Dependency
+  name: minitest-sugar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A minimum operational template that escapes HTML tags by default
+email: frodsan@protonmail.ch
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gems"
 - LICENSE
 - README.md
-- benchmarks/.gems
-- benchmarks/escaping.rb
-- benchmarks/helpers/helper.rb
-- benchmarks/helpers/hmote_helper.rb
-- benchmarks/helpers/rails_helper.rb
-- benchmarks/memory.rb
-- benchmarks/safe.rb
-- benchmarks/templates/erb
-- benchmarks/templates/mote
-- hmote.gemspec
 - lib/hmote.rb
 - lib/hmote/version.rb
-- makefile
-- test/foo.mote
 - test/helper.rb
-- test/helpers.rb
-- test/parsing.rb
-- test/views/context.mote
-- test/views/home.mote
-- test/views/layout.mote
-homepage: https://github.com/harmoni/hmote
+- test/helpers_test.rb
+- test/parsing_test.rb
+homepage: https://github.com/frodsan/hmote
 licenses:
 - MIT
 metadata: {}
@@ -91,8 +99,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: A minimum operational template that escapes HTML tags by default.
-test_files: []
+summary: A minimum operational template that escapes HTML tags by default
+test_files:
+- test/helper.rb
+- test/helpers_test.rb
+- test/parsing_test.rb

data/.gems

@@ -1,2 +0,0 @@
-cutest -v 1.2.2
-hache -v 1.1.0

data/benchmarks/.gems

@@ -1,3 +0,0 @@
-actionview -v 4.2.3
-allocation_stats -v 0.1.5
-benchmark-ips -v 2.3.0

data/benchmarks/escaping.rb

@@ -1,11 +0,0 @@
-require_relative "helpers/helper"
-require_relative "helpers/hmote_helper"
-require_relative "helpers/rails_helper"
-
-text = %q(some < text > inside & these " escapable' characters/1234)
-
-Benchmark.ips do |x|
-  x.report("hmote") { hmote(text: text) }
-  x.report("rails") { rails(text: text) }
-  x.compare!
-end

data/benchmarks/helpers/helper.rb

@@ -1,8 +0,0 @@
-require "benchmark/ips"
-
-def template_path(template)
-  File.join(File.expand_path("../templates", __dir__), template)
-end
-
-MOTE_TEMPLATE = template_path("mote")
-ERB_TEMPLATE  = template_path("erb")

data/benchmarks/helpers/hmote_helper.rb

@@ -1,7 +0,0 @@
-require_relative "../../lib/hmote"
-
-include HMote::Helpers
-
-def hmote(params)
-  super(MOTE_TEMPLATE, params)
-end

data/benchmarks/helpers/rails_helper.rb

@@ -1,28 +0,0 @@
-require "action_view"
-
-class Context
-  class LookupContext
-    def disable_cache
-      yield
-    end
-
-    def find_template(*args)
-    end
-  end
-
-  def lookup_context
-    @lookup_context ||= LookupContext.new
-  end
-end
-
-ACTIONVIEW_CONTEXT = Context.new
-ACTIONVIEW_TEMPLATE = ActionView::Template.new(
-  File.read(ERB_TEMPLATE), "template",
-  ActionView::Template::Handlers::ERB.new,
-  format: :html, virtual_path: "template"
-)
-ACTIONVIEW_TEMPLATE.locals = [:text]
-
-def rails(params)
-  ACTIONVIEW_TEMPLATE.render(ACTIONVIEW_CONTEXT, params)
-end

data/benchmarks/memory.rb

@@ -1,24 +0,0 @@
-require_relative "helpers/helper"
-require_relative "helpers/hmote_helper"
-require "allocation_stats"
-
-def benchmark(text)
-  stats = AllocationStats.new(burn: 5).trace do
-    hmote(text: text)
-  end
-
-  allocations = stats.allocations.all.size
-  memsize = stats.allocations.bytes.to_a.inject(&:+)
-
-  puts "total allocations: #{ allocations }"
-  puts "total memsize: #{ memsize }"
-  puts stats.allocations(alias_paths: true).to_text
-end
-
-puts "== Unsafe mode\n"
-
-benchmark(%q(some < text > inside & these " escapable' characters/1234))
-
-puts "\n== Safe mode\n"
-
-benchmark(%q(some text without escapable characters))

data/benchmarks/safe.rb

@@ -1,11 +0,0 @@
-require_relative "helpers/helper"
-require_relative "helpers/hmote_helper"
-require_relative "helpers/rails_helper"
-
-text = %q(some text without escapable characters).html_safe
-
-Benchmark.ips do |x|
-  x.report("hmote") { hmote(text: text) }
-  x.report("rails") { rails(text: text) }
-  x.compare!
-end

data/benchmarks/templates/erb

@@ -1 +0,0 @@
-<%= text %>

data/benchmarks/templates/mote

@@ -1 +0,0 @@
-{{ text }}

data/hmote.gemspec

@@ -1,17 +0,0 @@
-require_relative "lib/hmote/version"
-
-Gem::Specification.new do |s|
-  s.name        = "hmote"
-  s.version     = HMote::VERSION
-  s.summary     = "A minimum operational template that escapes HTML tags by default."
-  s.description = s.summary + " Inspired by mote."
-  s.authors     = ["Francesco Rodríguez", "Mayn Kjær"]
-  s.email       = ["frodsan@protonmail.ch", "mayn.kjaer@gmail.com"]
-  s.homepage    = "https://github.com/harmoni/hmote"
-  s.license     = "MIT"
-
-  s.files = `git ls-files`.split("\n")
-
-  s.add_dependency "hache", "~> 1.1"
-  s.add_development_dependency "cutest", "~> 1.2"
-end

data/makefile

@@ -1,8 +0,0 @@
-.DEFAULT_GOAL := test
-.PHONY: test
-
-gem:
-	gem build *.gemspec
-
-test:
-	cutest test/*.rb

data/test/foo.mote

@@ -1 +0,0 @@
-{{ foo }}

data/test/views/context.mote

@@ -1 +0,0 @@
-{{ app.name }}

data/test/views/home.mote

@@ -1 +0,0 @@
-<h1>Home</h1>

data/test/views/layout.mote

@@ -1,2 +0,0 @@
-<title>{{ title }}</title>
-{{! content }}