hmote 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 944f108a4471141ffe3b7265b6d7f2895443259c
-  data.tar.gz: 92d6d888dadad1e50ac3f471bb020c20e24937c8
+  metadata.gz: 62b364d0904c64b47d40549e99b1b074f3b34830
+  data.tar.gz: 4f636c64838e7abfd047a963e37ce5d2de5392b8
 SHA512:
-  metadata.gz: 8b7d2b3e3b1dabc260e22c1214da5f45499e45f05674ace3ca4c29d156293733a78f12399527eb1046966b1999e3001cc5c2ece01410246cb5c531cb9480a233
-  data.tar.gz: ae500aa801dfd837eee00e82c8a1ffee987b1977081255aafcf1113e69d52e7f96452d480f97c88fe82939632b00252533eb86eb97b957d5d66356696abee8b0
+  metadata.gz: cecb32632d690a9e5fccf139cf298c9d462633aa1438f2e935ddabc2b344e93d29249a9670ea2ee94dcd408c0b837deafdb1d1acb3aa979369411cc3d9827a56
+  data.tar.gz: 2df94a7b9b45bcf51978cb6bd326c3f86de5929777fc50ea91663f0abced820afc7aee35fceeb9c29c25ecf782189ad4735ab4886cffe6cc6edd6a45c0896976

data/.gems

@@ -1,4 +1,4 @@
 cutest -v 1.2.2
 hache -v 1.1.0
-cuba -v 3.3.0
-rack-test -v 0.6.2
+cuba -v 3.4.0
+rack-test -v 0.6.3

data/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2014-Present Francesco Rodríguez, Mayn Kjær
+Copyright (c) 2011-2014 Michel Martens
+Copyright (c) 2014-2015 Francesco Rodríguez
+Copyright (c) 2014-2015 Mayn Ektvedt Kjær
 
 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

@@ -6,7 +6,7 @@ Minimal template engine with default escaping.
 Description
 -----------
 
-HMote is based on [Mote][mote] and uses [Hache][hache]
+HMote is a fork of [Mote][mote] that uses [Hache][hache]
 to auto-escape HTML special characters.
 
 Basic Usage
@@ -22,18 +22,23 @@ template.call
 # => "your template goes here!"
 ```
 
-HMote recognizes two tags to evaluate Ruby code: `%` and `{{}}`.
-The difference between them is that while the `%` tag only evaluates
-the code, the `{{}}` tag also prints the result to the template.
+HMote recognizes three tags to evaluate Ruby code: `%`, `{{}}` and `<? ?>`.
+The difference between them is that while the `%` and `<? ?>` tags only
+evaluate the code, the `{{}}` tag also prints the result to the template.
 
 Imagine that your template looks like this:
 
 ```ruby
+% # single-line code
 % gems = ["rack", "cuba", "hmote"]
 
+<?
+  # multi-line code
+  sorted = gems.sort
+?>
+
 <ul>
-% # this is a comment.
-% gems.sort.each do |gem|
+% sorted.each do |gem|
   <li>{{ gem }}</li>
 % end
 </ul>
@@ -213,5 +218,5 @@ $ gem install hmote
 
 [cuba]: http://cuba.is
 [mote]: https://github.com/soveran/mote
-[hache]: https://github.com/frodsan/hache
+[hache]: https://github.com/harmoni/hache
 [xss]: http://en.wikipedia.org/wiki/Cross-Site_Scripting

data/benchmarks/.gems

@@ -1,2 +1,3 @@
-actionview -v 4.1.8
-benchmark-ips -v 2.1.0
+actionview -v 4.2.3
+allocation_stats -v 0.1.5
+benchmark-ips -v 2.3.0

data/benchmarks/escaping.rb

@@ -1,17 +1,11 @@
-require_relative "helper"
-require_relative "hmote_helper"
-require_relative "rails_helper"
+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
-
-# Calculating -------------------------------------
-#                hmote    13.122k i/100ms
-#                rails     7.907k i/100ms
-# -------------------------------------------------
-#                hmote    148.020k (± 3.6%) i/s -    747.954k
-#                rails     88.623k (± 2.7%) i/s -    442.792k

data/benchmarks/{helper.rb → helpers/helper.rb}

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

data/benchmarks/{hmote_helper.rb → helpers/hmote_helper.rb}

@@ -1,4 +1,4 @@
-require_relative "../lib/hmote"
+require_relative "../../lib/hmote"
 
 include HMote::Helpers
 

data/benchmarks/memory.rb

@@ -0,0 +1,24 @@
+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,17 +1,11 @@
-require_relative "helper"
-require_relative "hmote_helper"
-require_relative "rails_helper"
+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
-
-# Calculating -------------------------------------
-#                hmote    29.035k i/100ms
-#                rails    14.607k i/100ms
-# -------------------------------------------------
-#                hmote    367.044k (± 5.9%) i/s -      1.829M
-#                rails    157.936k (± 5.9%) i/s -    788.778k

data/hmote.gemspec

@@ -1,15 +1,17 @@
+require_relative "lib/hmote/version"
+
 Gem::Specification.new do |s|
   s.name        = "hmote"
-  s.version     = "1.2.0"
+  s.version     = HMote::VERSION
   s.summary     = "A minimum operational template that escapes HTML tags by default."
-  s.description = s.summary
-  s.authors = ["Francesco Rodríguez", "Mayn Kjær"]
-  s.email = ["frodsan@me.com", "mayn.kjaer@gmail.com"]
+  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"
-  s.add_development_dependency "cutest"
+  s.add_dependency "hache", "~> 1.1"
+  s.add_development_dependency "cutest", "~> 1.2"
 end

data/lib/hmote/render.rb

@@ -3,15 +3,22 @@ require_relative "../hmote"
 module HMote::Render
   include HMote::Helpers
 
+  CONTENT_TYPE = "Content-Type".freeze
+  DEFAULT_CONTENT_TYPE = "text/html; charset=utf-8".freeze
+
   def self.setup(app)
     app.settings[:hmote] ||= {}
-    app.settings[:hmote][:views] ||= File.expand_path("views", Dir.pwd)
-    app.settings[:hmote][:layout] ||= "layout"
+
+    app.layout("layout")
+    app.view_path("views")
   end
 
   def render(template, params = {}, layout = settings[:hmote][:layout])
-    res.headers["Content-Type"] ||= "text/html; charset=utf-8"
+    res.status ||= 200
+    res.headers[CONTENT_TYPE] ||= DEFAULT_CONTENT_TYPE
     res.write(view(template, params, layout))
+
+    halt(res.finish)
   end
 
   def view(template, params = {}, layout = settings[:hmote][:layout])
@@ -23,10 +30,16 @@ module HMote::Render
   end
 
   def template_path(template)
-    if template.end_with?(".mote")
-      return template
-    else
-      return File.join(settings[:hmote][:views], "#{template}.mote")
+    return File.join(settings[:hmote][:views], "#{template}.mote")
+  end
+
+  module ClassMethods
+    def layout(name)
+      settings[:hmote][:layout] = name
+    end
+
+    def view_path(path)
+      settings[:hmote][:views] = File.expand_path(path, Dir.pwd)
     end
   end
 end

data/lib/hmote/version.rb

@@ -0,0 +1,3 @@
+class HMote
+  VERSION = "1.3.0"
+end

data/lib/hmote.rb

@@ -1,10 +1,10 @@
 require "hache"
 
 class HMote
-  PATTERN = /^(\n)|             # newlines.
-    ^\s*(%)\s*(.*?)(?:\n|\Z)|   # % single-line code
-    (<\?)\s+(.*?)\s+\?>|        # <? multi-line code ?>
-    (\{\{!?)(.*?)\}\}           # {{ escape }} or {{! unescape }}
+  PATTERN = /
+    ^[^\S\n]*(%)[^\S\n]*(.*?)(?:\n|\z) |  # % single-line code
+    (<\?)\s+(.*?)\s+\?>                |  # <? multi-line code ?>
+    (\{\{!?)(.*?)\}\}                     # {{ escape }} or {{! unescape }}
   /mx
 
   def self.parse(template, context = self, vars = [])
@@ -12,10 +12,10 @@ class HMote
     parts = "Proc.new do |params, __o|\n params ||= {}; __o ||= ''\n"
 
     vars.each do |var|
-      parts << "%s = params[%s]\n" % [var, var.inspect]
+      parts << sprintf("%s = params[%p]\n", var, var)
     end
 
-    while term = terms.shift
+    while (term = terms.shift)
       case term
       when "<?"  then parts << "#{terms.shift}\n"
       when "%"   then parts << "#{terms.shift}\n"

data/makefile

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

data/test/parsing.rb

@@ -36,7 +36,7 @@ scope("parsing") do
 
   test "multiline" do
     example = HMote.parse("The\nMan\nAnd\n{{\"The\"}}\nSea")
-    assert_equal("The\nMan\nAnd\nThe\nSea", example[n: 3])
+    assert_equal("The\nMan\nAnd\nThe\nSea", example.call)
   end
 
   test "quotes" do
@@ -67,17 +67,17 @@ scope("parsing") do
 
   test "multi-line XML-style directives" do
     template = (<<-EOT).gsub(/^    /, "")
-    <? res = ""
-       [1, 2, 3].each_with_index do |item, idx|
-         res << "%d. %d\n" % [idx + 1, item * item]
-       end
+    <?
+      # Multiline code evaluation
+      lucky = [1, 3, 7, 9, 13, 15]
+      prime = [2, 3, 5, 7, 11, 13]
     ?>
-    {{ res }}
+
+    {{ lucky & prime }}
     EOT
 
     example = HMote.parse(template)
-
-    assert_equal("\n1. 1\n2. 4\n3. 9\n\n", example.call)
+    assert_equal "\n\n[3, 7, 13]\n", example.call
   end
 
   test "preserve XML directives" do

data/test/render.rb

@@ -26,12 +26,9 @@ Cuba.define do
     res.write partial("context")
   end
 
-  on "absolute" do
-    render("./test/custom_views/custom.mote", title: "Custom")
-  end
-
-  on "absolute_layout" do
-    render("./test/custom_views/custom.mote", title: "Custom Layout")
+  on "halt" do
+    render("home", title: "Halt before error")
+    raise "This is invalid"
   end
 end
 
@@ -62,17 +59,9 @@ scope do
     assert last_response.body["App"]
   end
 
-  test "use of absolute path for template" do
-    get "/absolute"
-
-    assert last_response.body["<title>Custom</title>\n<h1>Custom</h1>"]
-  end
-
-  test "use of absolute path for layout" do
-    Cuba.settings[:hmote][:layout] = "./test/custom_views/layout.mote"
-
-    get "/absolute_layout"
+  test "render halts request" do
+    get "/halt"
 
-    assert last_response.body["<title>Custom Layout</title>\n<h1>Custom</h1>"]
+    assert true
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hmote
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Francesco Rodríguez
@@ -9,39 +9,40 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-14 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hache
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: cutest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: A minimum operational template that escapes HTML tags by default.
+        version: '1.2'
+description: A minimum operational template that escapes HTML tags by default. Inspired
+  by mote.
 email:
-- frodsan@me.com
+- frodsan@protonmail.ch
 - mayn.kjaer@gmail.com
 executables: []
 extensions: []
@@ -52,18 +53,18 @@ files:
 - README.md
 - benchmarks/.gems
 - benchmarks/escaping.rb
-- benchmarks/helper.rb
-- benchmarks/hmote_helper.rb
-- benchmarks/rails_helper.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/render.rb
+- lib/hmote/version.rb
 - makefile
-- test/custom_views/custom.mote
-- test/custom_views/layout.mote
 - test/foo.mote
 - test/helper.rb
 - test/helpers.rb

data/test/custom_views/custom.mote

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

data/test/custom_views/layout.mote

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