slaw 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 655dd4179f692952514dc6341d332b92bb5ed09f
-  data.tar.gz: f94a6f5d09da791132c901343cdc7c0f228822ec
+SHA256:
+  metadata.gz: 9caa9135d576212d4a7d6b2300bfe65fad7ef36cf938243f59ea002b25a41273
+  data.tar.gz: faf61f38ee828b2d0f3024ca42ee7fe6ad560acfde021f1cdcbd1cfacdc73fd4
 SHA512:
-  metadata.gz: dae4cc911be85f416e81252489f7914d8da142aa0eacf6e92a15c4f314f7569394eb718cad620ccabe098c352c87f02c4a5ae0bdb8cc7430523a4db1f65add54
-  data.tar.gz: ea1bc757d9a29b0f998366f36bd5c5baec6b2b0196705369a06a9ded88aafb1740ac27e364a9ccd1b5320a14a00cb57179911294cd858fd94f5106a2ff5f2d18
+  metadata.gz: 7e69b0a96eb59ae723d8f3c217d7e0dfe13a236908f894061072a680d33e0e318496ec99f267672fcf49fb347cde79bc21c8bd9a2d449f315e6548b2f43cde84
+  data.tar.gz: 380eb2d660d556715ce1339d841c44efe07c5c88271ae10bc4d9e44d648c420788c60137b917daf6f1768d745b273ad8fa3b7b6559ccec873f201b305c129e37

data/README.md

@@ -1,4 +1,4 @@
-# Slaw [![Build Status](https://travis-ci.org/longhotsummer/slaw.svg)](http://travis-ci.org/longhotsummer/slaw)
+# Slaw [![Build Status](https://travis-ci.org/longhotsummer/slaw.svg)](http://travis-ci.org/longhotsummer/slaw) [![Gem Version](https://badge.fury.io/rb/slaw.svg)](https://badge.fury.io/rb/slaw)
 
 Slaw is a lightweight library for generating Akoma Ntoso 2.0 Act XML from plain text documents.
 It is used to power [Indigo](https://github.com/OpenUpSA/indigo) and uses grammars developed for the legal
@@ -84,6 +84,10 @@ You can create your own grammar by creating a gem that provides these files and
 
 ## Changelog
 
+### 3.1.0 (29 March 2019)
+
+* Add --ascii flag to %-encode utf-8 strings into US-ASCII for speed. See https://github.com/cjheath/treetop/issues/31
+
 ### 3.0.0 (28 March 2019)
 
 * Inline bold and italics

data/bin/slaw

@@ -18,6 +18,7 @@ class SlawCLI < Thor
   option :id_prefix, type: :string, desc: "Prefix to be used when generating ID elements when parsing a fragment."
   option :section_number_position, enum: ['before-title', 'after-title', 'guess'], desc: "Where do section titles come in relation to the section number? Default: before-title"
   option :grammar, type: :string, desc: "Grammar name (usually a two-letter country code). Default is za."
+  option :ascii, type: :boolean, default: false, desc: "Process text as ASCII using %-encoding. This can provide significant speed improvements if the grammar uses only ASCII literals. See https://github.com/cjheath/treetop/issues/31."
   def parse(name)
     logging
 
@@ -65,6 +66,8 @@ class SlawCLI < Thor
       generator.parser.options[:section_number_after_title] = after
     end
 
+    generator.builder.force_ascii = options[:ascii]
+
     begin
       act = generator.generate_from_text(text)
     rescue Slaw::Parse::ParseError => e

data/lib/slaw/grammars/terminals.treetop

@@ -48,14 +48,6 @@ module Slaw
         [a-zA-Z0-9]+
       end
 
-      rule quotes
-        ["“”]
-      end
-      
-      rule non_quotes
-        [^"“”]
-      end
-
       ##########
       # whitespace
 

data/lib/slaw/parse/builder.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 
+require 'uri'
 require 'treetop'
 
 module Slaw
@@ -32,6 +33,9 @@ module Slaw
       # Prefix to use when generating IDs for fragments
       attr_accessor :fragment_id_prefix
 
+      # Should the parsing re-encoding the string as ASCII?
+      attr_accessor :force_ascii
+
       # Create a new builder.
       #
       # Specify either `:parser` or `:grammar_file` and `:grammar_class`.
@@ -41,6 +45,7 @@ module Slaw
       def initialize(opts={})
         @parser = opts[:parser]
         @parse_options = opts[:parse_optiosn] || {}
+        @force_ascii = false
       end
 
       # Do all the work necessary to parse text into a well-formed XML document.
@@ -77,8 +82,37 @@ module Slaw
       # @return [String] an XML string
       def parse_text(text, parse_options={})
         text = preprocess(text)
+
+        text = escape_utf8(text) if @force_ascii
+
         tree = text_to_syntax_tree(text, parse_options)
-        xml_from_syntax_tree(tree)
+        xml = xml_from_syntax_tree(tree)
+
+        xml = unescape_utf8(xml) if @force_ascii
+
+        xml
+      end
+
+      # Use %-encoding to escape everything outside of the US_ASCII range,
+      # including encoding % itself.
+      #
+      # This can have a huge performance benefit. String lookups on utf-8 strings
+      # are linear in Ruby, while string lookups on US_ASCII encoded strings
+      # are constant time.
+      #
+      # This option can only be used if the grammar doesn't include non-ascii literals.
+      #
+      # See https://github.com/cjheath/treetop/issues/31
+      def escape_utf8(text)
+        unsafe = (0..126).to_a - ['%'.ord]
+        unsafe = unsafe.map { |i| '\u%04x' % i }
+        unsafe = Regexp.new('[^' + unsafe.join('') + ']')
+
+        URI::DEFAULT_PARSER.escape(text, unsafe)
+      end
+
+      def unescape_utf8(xml)
+        URI.unescape(xml)
       end
 
       # Parse plain text into a syntax tree.

data/lib/slaw/version.rb

@@ -1,3 +1,3 @@
 module Slaw
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/slaw.gemspec

@@ -18,12 +18,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "rake", "~> 10.3.1"
-  spec.add_development_dependency "rspec", "~> 2.14.1"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.8"
 
-  spec.add_runtime_dependency "nokogiri", "~> 1.8.5"
+  spec.add_runtime_dependency "nokogiri", "~> 1.8"
   spec.add_runtime_dependency "treetop", "~> 1.5"
-  spec.add_runtime_dependency "log4r", "~> 1.1.10"
-  spec.add_runtime_dependency "thor", "~> 0.19.1"
-  spec.add_runtime_dependency "mimemagic", "~> 0.2.1"
+  spec.add_runtime_dependency "log4r", "~> 1.1"
+  spec.add_runtime_dependency "thor", "~> 0.20"
+  spec.add_runtime_dependency "mimemagic", "~> 0.2"
 end

data/spec/generator_spec.rb

@@ -16,13 +16,13 @@ Section title
 Another section title
 2. Section content that is long.
 "
-        subject.guess_section_number_after_title(text).should be_true
+        subject.guess_section_number_after_title(text).should be true
       end
     end
 
     context 'section number before title' do
       it 'should default to false' do
-        subject.guess_section_number_after_title("").should be_false
+        subject.guess_section_number_after_title("").should be false
       end
 
       it 'should be false' do
@@ -36,7 +36,7 @@ Some content.
 
 Some content.
 "
-        subject.guess_section_number_after_title(text).should be_false
+        subject.guess_section_number_after_title(text).should be false
       end
     end
   end

data/spec/za/act_block_spec.rb

@@ -1973,12 +1973,12 @@ EOS
     it 'should handle a clause with a remark' do
       node = parse :inline_items, "simple [[remark]]. text"
       node.text_value.should == "simple [[remark]]. text"
-      node.elements[7].is_a?(Slaw::Grammars::ZA::Act::Remark).should be_true
+      node.elements[7].is_a?(Slaw::Grammars::ZA::Act::Remark).should be true
 
       node = parse :inline_items, "simple [[remark]][[another]] text"
       node.text_value.should == "simple [[remark]][[another]] text"
-      node.elements[7].is_a?(Slaw::Grammars::ZA::Act::Remark).should be_true
-      node.elements[7].is_a?(Slaw::Grammars::ZA::Act::Remark).should be_true
+      node.elements[7].is_a?(Slaw::Grammars::ZA::Act::Remark).should be true
+      node.elements[7].is_a?(Slaw::Grammars::ZA::Act::Remark).should be true
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slaw
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Greg Kempe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-28 00:00:00.000000000 Z
+date: 2019-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.3.1
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.3.1
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.5
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.5
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: treetop
   requirement: !ruby/object:Gem::Requirement
@@ -72,42 +72,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.10
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.10
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.1
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: mimemagic
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: '0.2'
 description: Slaw is a lightweight library for rendering and generating Akoma Ntoso
   acts from plain text and PDF documents.
 email:
@@ -181,8 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A lightweight library for using Akoma Ntoso acts in Ruby.