hamlit 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a4c110b4d613b181e5b4265b38bb5e9be5462536
-  data.tar.gz: 4078a4b2b491555689955e4c89d42e37e20bcd20
+  metadata.gz: acd45b093acf5ae8f7120e1e7e595028fa78915b
+  data.tar.gz: cf875adfcd85ff188fdc10efdb0af616cb2fd993
 SHA512:
-  metadata.gz: 1e594931f0a2095ab3a179d9fd11faa431497cda613ea5ecefad9f0c408608bf97a6f9f8ea091c2c9b8304f987ef522059e9a676b9e504e3a8c1db8ad8766fe8
-  data.tar.gz: 7c45353f42bad632bd45cda5384271543b73b29aee44a171e8e8fdb60789a1e15d3d7521d5ba52e99465b141359e35d35c625b95a037743c530197bf11baf9b1
+  metadata.gz: 48cdaa2c88be9efe9a526f025c94ed30ec6a597971097a5976f502d74ab4914f08635ceccdc4aa38f226419920a775b50a5f4f42c3b54a7afdf87974ea6778ce
+  data.tar.gz: f7cf63537580965878635d161a4c619caba202f5e0f1626f5f4a7bcd6bd28fb96ce7b421a2ba57a3966ee0dcf2f1c6fcc5273eb7b32cf920108b777c0ce5193c

data/.travis.yml

@@ -13,6 +13,8 @@ matrix:
       env: TASK=test
     - rvm: 2.3.1
       env: TASK=test
+    - rvm: ruby-head
+      env: TASK=test
     - rvm: 2.3.1
       env: TASK=bench TEMPLATE=benchmark/boolean_attribute.haml,benchmark/class_attribute.haml,benchmark/id_attribute.haml,benchmark/data_attribute.haml,benchmark/common_attribute.haml
     - rvm: 2.3.1
@@ -28,6 +30,8 @@ matrix:
     - rvm: 2.3.1
       env: TASK=bench TEMPLATE=test/haml/templates/standard.haml COMPILE=1
   allow_failures:
+    - rvm: ruby-head
+      env: TASK=test
     - env: TASK=bench TEMPLATE=benchmark/boolean_attribute.haml,benchmark/class_attribute.haml,benchmark/id_attribute.haml,benchmark/data_attribute.haml,benchmark/common_attribute.haml
     - env: TASK=bench TEMPLATE=benchmark/dynamic_attributes/boolean_attribute.haml,benchmark/dynamic_attributes/class_attribute.haml,benchmark/dynamic_attributes/id_attribute.haml,benchmark/dynamic_attributes/data_attribute.haml,benchmark/dynamic_attributes/common_attribute.haml
     - env: TASK=bench SLIM_BENCH=1

data/CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file. This
 project adheres to [Semantic Versioning](http://semver.org/). This change log is based upon
 [keep-a-changelog](https://github.com/olivierlacan/keep-a-changelog).
 
+## [2.6.0](https://github.com/k0kubun/hamlit/compare/v2.5.0...v2.6.0) - 2016-08-14
+
+### Changed
+
+- Stop using [houdini](https://github.com/vmg/houdini) and rewrite HTML escape function to resolve building or packaging problems [#82](https://github.com/k0kubun/hamlit/pull/82).
+  - No behavior is changed
+
 ## [2.5.0](https://github.com/k0kubun/hamlit/compare/v2.4.2...v2.5.0) - 2016-06-04
 
 ### Changed

data/README.md

@@ -103,6 +103,13 @@ $ hamlit render in.haml
 
 ## Contributing
 
+### Test latest version
+
+```rb
+# Gemfile
+gem 'hamlit', github: 'k0kubun/hamlit', submodules: true
+```
+
 ### Development
 
 Contributions are welcomed. It'd be good to see

data/ext/hamlit/extconf.rb

@@ -1,18 +1,10 @@
 require 'mkmf'
 
-houdini_dir = File.expand_path('./houdini', __dir__)
-$INCFLAGS << " -I#{houdini_dir}"
-$CFLAGS   << ' -Wall -Wextra'
+$CFLAGS << ' -Wall -Wextra'
 
-$srcs = %w[hamlit.c]
-Dir[File.join(houdini_dir, '*.c')].each do |path|
-  src = File.basename(path)
-  if /mswin|mingw|cygwin|bccwin/ =~ RUBY_PLATFORM
-    FileUtils.cp(path, src)
-  else
-    FileUtils.ln_s(path, src, force: true)
-  end
-  $srcs << src
-end
+$srcs = %w[
+  hamlit.c
+  hescape.c
+]
 
 create_makefile('hamlit/hamlit')

data/ext/hamlit/hamlit.c

@@ -1,6 +1,6 @@
 #include <ruby.h>
 #include <ruby/encoding.h>
-#include "houdini.h"
+#include "hescape.h"
 #include "string.h"
 
 VALUE mAttributeBuilder, mObjectRef;
@@ -58,13 +58,14 @@ hyphenate(VALUE str)
 static VALUE
 escape_html(VALUE str)
 {
-  gh_buf buf = GH_BUF_INIT;
-
+  char *buf;
+  unsigned int size;
   Check_Type(str, T_STRING);
 
-  if (houdini_escape_html0(&buf, (const uint8_t *)RSTRING_PTR(str), RSTRING_LEN(str), 0)) {
-    str = rb_enc_str_new(buf.ptr, buf.size, rb_utf8_encoding());
-    gh_buf_free(&buf);
+  size = hesc_escape_html(&buf, RSTRING_PTR(str), RSTRING_LEN(str));
+  if (size > RSTRING_LEN(str)) {
+    str = rb_enc_str_new(buf, size, rb_utf8_encoding());
+    free((void *)buf);
   }
 
   return str;

data/ext/hamlit/hescape.c

@@ -0,0 +1,108 @@
+#include <stdio.h>
+#include <string.h>
+#include <stdlib.h>
+#include "hescape.h"
+
+static const char *ESCAPED_STRING[] = {
+  "",
+  "&quot;",
+  "&amp;",
+  "&#39;",
+  "&lt;",
+  "&gt;",
+};
+
+// This is strlen(ESCAPED_STRING[x]) optimized specially.
+// Mapping: 1 => 6, 2 => 5, 3 => 5, 4 => 4, 5 => 4
+#define ESC_LEN(x) ((13 - x) / 2)
+
+/*
+ * Given ASCII-compatible character, return index of ESCAPED_STRING.
+ *
+ * " (34) => 1 (&quot;)
+ * & (38) => 2 (&amp;)
+ * ' (39) => 3 (&#39;)
+ * < (60) => 4 (&lt;)
+ * > (62) => 5 (&gt;)
+ */
+static const char HTML_ESCAPE_TABLE[] = {
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 1, 0, 0, 0, 2, 3, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 0, 5, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+  0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+};
+
+static char*
+ensure_allocated(char *buf, size_t size, size_t *asize)
+{
+  size_t new_size;
+
+  if (size < *asize)
+    return buf;
+
+  if (*asize == 0) {
+    new_size = size;
+  } else {
+    new_size = *asize;
+  }
+
+  // Increase buffer size by 1.5x if realloced multiple times.
+  while (new_size < size)
+    new_size = (new_size << 1) - (new_size >> 1);
+
+  // Round allocation up to multiple of 8.
+  new_size = (new_size + 7) & ~7;
+
+  *asize = new_size;
+  return realloc(buf, new_size);
+}
+
+size_t
+hesc_escape_html(char **dest, const char *buf, size_t size)
+{
+  size_t asize = 0, esc_i, esize = 0, i = 0, rbuf_end = 0;
+  const char *esc;
+  char *rbuf = NULL;
+
+  while (i < size) {
+    // Loop here to skip non-escaped characters fast.
+    while (i < size && (esc_i = HTML_ESCAPE_TABLE[(unsigned char)buf[i]]) == 0)
+      i++;
+
+    if (i < size && esc_i) {
+      esc = ESCAPED_STRING[esc_i];
+      rbuf = ensure_allocated(rbuf, sizeof(char) * (size + esize + ESC_LEN(esc_i) + 1), &asize);
+
+      // Copy pending characters and escaped string.
+      memmove(rbuf + rbuf_end, buf + (rbuf_end - esize), i - (rbuf_end - esize));
+      memmove(rbuf + i + esize, esc, ESC_LEN(esc_i));
+      rbuf_end = i + esize + ESC_LEN(esc_i);
+      esize += ESC_LEN(esc_i) - 1;
+    }
+    i++;
+  }
+
+  if (rbuf_end == 0) {
+    // Return given buf and size if there are no escaped characters.
+    *dest = (char *)buf;
+    return size;
+  } else {
+    // Copy pending characters including NULL character.
+    memmove(rbuf + rbuf_end, buf + (rbuf_end - esize), (size + 1) - (rbuf_end - esize));
+
+    *dest = rbuf;
+    return size + esize;
+  }
+}

data/ext/hamlit/hescape.h

@@ -0,0 +1,20 @@
+#ifndef HESCAPE_H
+#define HESCAPE_H
+
+#include <sys/types.h>
+
+/*
+ * Replace characters according to the following rules.
+ * Note that this function can handle only ASCII-compatible string.
+ *
+ * " => &quot;
+ * & => &amp;
+ * ' => &#39;
+ * < => &lt;
+ * > => &gt;
+ *
+ * @return size of dest. If it's larger than len, dest is required to be freed.
+ */
+extern size_t hesc_escape_html(char **dest, const char *src, size_t size);
+
+#endif

data/hamlit.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/k0kubun/hamlit'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|sample)/}) } + `git -C ext/hamlit/houdini ls-files -z`.split("\x0").map { |path| "ext/hamlit/houdini/#{path}" }
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|sample)/}) }
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.extensions    = ['ext/hamlit/extconf.rb']

data/lib/hamlit/version.rb

@@ -1,3 +1,3 @@
 module Hamlit
-  VERSION = '2.5.0'
+  VERSION = '2.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hamlit
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Takashi Kokubun
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-04 00:00:00.000000000 Z
+date: 2016-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: temple
@@ -244,7 +244,6 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".gitignore"
-- ".gitmodules"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
@@ -290,26 +289,8 @@ files:
 - exe/hamlit
 - ext/hamlit/extconf.rb
 - ext/hamlit/hamlit.c
-- ext/hamlit/houdini/.gitignore
-- ext/hamlit/houdini/COPYING
-- ext/hamlit/houdini/Makefile
-- ext/hamlit/houdini/README.md
-- ext/hamlit/houdini/buffer.c
-- ext/hamlit/houdini/buffer.h
-- ext/hamlit/houdini/houdini.h
-- ext/hamlit/houdini/houdini_href_e.c
-- ext/hamlit/houdini/houdini_html_e.c
-- ext/hamlit/houdini/houdini_html_u.c
-- ext/hamlit/houdini/houdini_js_e.c
-- ext/hamlit/houdini/houdini_js_u.c
-- ext/hamlit/houdini/houdini_uri_e.c
-- ext/hamlit/houdini/houdini_uri_u.c
-- ext/hamlit/houdini/houdini_xml_e.c
-- ext/hamlit/houdini/html_unescape.gperf
-- ext/hamlit/houdini/html_unescape.h
-- ext/hamlit/houdini/tools/build_table.py
-- ext/hamlit/houdini/tools/build_tables.c
-- ext/hamlit/houdini/tools/wikipedia_table.txt
+- ext/hamlit/hescape.c
+- ext/hamlit/hescape.h
 - hamlit.gemspec
 - lib/hamlit.rb
 - lib/hamlit/attribute_builder.rb

data/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "ext/hamlit/houdini"]
-	path = ext/hamlit/houdini
-	url = https://github.com/k0kubun/houdini

data/ext/hamlit/houdini/.gitignore

@@ -1,3 +0,0 @@
-*.[ao]
-*.d
-*~

data/ext/hamlit/houdini/COPYING

@@ -1,7 +0,0 @@
-Copyright (C) 2012 Vicent Martí
-
-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/ext/hamlit/houdini/Makefile

@@ -1,79 +0,0 @@
-# GNU Makefile
-# Copyright (C) 2012 Przemyslaw Pawelczyk <przemoc@gmail.com>
-#
-# 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.
-
-SRCS := buffer.c houdini_href_e.c houdini_html_e.c houdini_html_u.c houdini_js_e.c houdini_js_u.c houdini_uri_e.c houdini_uri_u.c houdini_xml_e.c
-OBJS := $(addsuffix .o,$(basename $(SRCS)))
-DEPS := $(addsuffix .d,$(basename $(SRCS)))
-NAME := houdini
-
-SRCDIR := $(dir $(lastword $(MAKEFILE_LIST)))
-OBJDIR ?= ./
-OBJS := $(addprefix $(OBJDIR),$(OBJS))
-SLIB := lib$(NAME).a
-
-vpath %.c $(SRCDIR)
-vpath %.h $(SRCDIR)
-
-AR ?= ar
-CC ?= gcc
-GPERF ?= gperf
-SED ?= sed
-
-CFLAGS ?= -O2
-# -Wno-missing-field-initializers - gperf's header doesn't pass on -Wextra
-MANDATORY_FLAGS := -Wall -Wextra -Wno-missing-field-initializers
-override CFLAGS := $(MANDATORY_FLAGS) $(CFLAGS)
-
-.PHONY: all clean objects package
-
-all: package
-
-objects: $(OBJS)
-package: $(SLIB)
-
-$(SLIB): $(OBJS)
-	$(AR) rcs $@ $^
-
-$(OBJS): | $(OBJDIR)
-
-$(OBJDIR):
-	mkdir -p $@
-
-$(OBJDIR)%.o: %.c
-	$(CC) $(CFLAGS) $(CPPFLAGS) $(TARGET_ARCH) -c -o $@ $<
-
-%.d: %.c
-	@set -e; \
-	$(RM) $@; \
-	$(CC) -MM $(CFLAGS) $(CPPFLAGS) $(TARGET_ARCH) $< >$@.tmp; \
-	$(SED) 's,\($*\)\.o[ :]*,$$(OBJDIR)\1.o $@: ,g' <$@.tmp >$@; \
-	$(RM) $@.tmp
-
-html_unescape.h: html_unescape.gperf
-	$(GPERF) -t -N find_entity -H hash_entity -K entity -C -l --null-strings -m100 $< >$@
-
-clean:
-	$(RM) $(SLIB) $(OBJS) $(DEPS)
-
-ifneq ($(MAKECMDGOALS),clean)
--include $(DEPS)
-endif

data/ext/hamlit/houdini/README.md

@@ -1,59 +0,0 @@
-Houdini - The Escapist
-======================
-
-Houdini doesn't quite qualify as a library. In fact, I didn't even bother
-to write a Makefile (well, others did). It's zero-dependency and modular.
-Just stick the files you need in your project. Or go with all of them
-(e.g. via git submodule) and use the static library that is built by
-default when GNU make is invoked. Now you can freely escape some shit.
-
-Houdini is a simple API for escaping text for the web. And unescaping it.
-But that kind of breaks the joke in the name so nevermind.
-
-- HTML escaping follows the OWASP suggestion. All other entities are left
-as-is.
-
-        & --> &
-        < --> &lt;
-        > --> &gt;
-        " --> &quot;
-        ' --> &#x27;     &apos; is not recommended
-        / --> &#x2F;     forward slash is included as it helps end an HTML entity
-
-- HTML unescaping is fully RFC-compliant. Yes, that's the 253 different entities
-for you, and decimal/hex code point specifiers.
-
-- URI escaping and unescaping is fully RFC-compliant.
-
-- URL escaping and unescaping is the same as generic URIs,
-    but spaces are changed to `+`.
-
-**WARNING:** Houdini parses **only** UTF-8 strings, and generates **only**
-UTF-8 strings. If you are using another encoding, you should probably transcode
-*before* passing the buffer to Houdini.
-
-### Current API:
-
-Do you really need docs for this?
-
-~~~~ c
-int houdini_escape_html(gh_buf *ob, const uint8_t *src, size_t size);
-int houdini_escape_html0(gh_buf *ob, const uint8_t *src, size_t size, int secure);
-int houdini_unescape_html(gh_buf *ob, const uint8_t *src, size_t size);
-int houdini_escape_xml(gh_buf *ob, const uint8_t *src, size_t size);
-int houdini_escape_uri(gh_buf *ob, const uint8_t *src, size_t size);
-int houdini_escape_url(gh_buf *ob, const uint8_t *src, size_t size);
-int houdini_escape_href(gh_buf *ob, const uint8_t *src, size_t size);
-int houdini_unescape_uri(gh_buf *ob, const uint8_t *src, size_t size);
-int houdini_unescape_url(gh_buf *ob, const uint8_t *src, size_t size);
-int houdini_escape_js(gh_buf *ob, const uint8_t *src, size_t size);
-int houdini_unescape_js(gh_buf *ob, const uint8_t *src, size_t size);
-~~~~
-
-Pass your string. It'll get escaped/unescaped in the target buffer, and the call will return 1.
-If the given string has nothing to escape/unescape, the call will return 0 and the
-output buffer will be empty.
-
-### Questions?
-
-Open an issue. Or shout angrily at me on Twitter ([@vmg](https://twitter.com/vmg)).