slaw 0.1.2

data/lib/slaw/render/xsl/elements.xsl

@@ -0,0 +1,116 @@
+<?xml version="1.0"?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
+  xmlns:a="http://www.akomantoso.org/2.0"
+  exclude-result-prefixes="a">
+
+  <xsl:template match="a:act">
+    <xsl:element name="span" namespace="">
+      <xsl:attribute name="class">an-act</xsl:attribute>
+      <xsl:apply-templates select="a:preamble" />
+      <xsl:apply-templates select="a:body/a:part | a:body/a:chapter | a:body/a:section" />
+    </xsl:element>
+  </xsl:template>
+
+  <!-- for parts and chapters, include an easily stylable heading -->
+  <xsl:template match="a:part">
+    <div class="an-part" id="{@id}">
+      <h1>
+        <xsl:text>Part </xsl:text>
+        <xsl:value-of select="./a:num" />
+        <xsl:text> - </xsl:text>
+        <xsl:value-of select="./a:heading" />
+      </h1>
+      
+      <xsl:apply-templates select="./*[not(self::a:num) and not(self::a:heading)]" />
+    </div>
+  </xsl:template>
+
+  <xsl:template match="a:chapter">
+    <div class="an-chapter" id="{@id}">
+      <h1>
+        <xsl:text>Chapter </xsl:text>
+        <xsl:value-of select="./a:num" />
+        <br/>
+        <xsl:value-of select="./a:heading" />
+      </h1>
+      
+      <xsl:apply-templates select="./*[not(self::a:num) and not(self::a:heading)]" />
+    </div>
+  </xsl:template>
+
+  <!-- the schedules "chapter" isn't actually a chapter -->
+  <xsl:template match="a:chapter[starts-with(@id, 'schedule')]">
+    <div class="an-chapter" id="{@id}">
+      <h1>
+        <xsl:text>Schedule </xsl:text>
+        <xsl:value-of select="./a:num" />
+        <br/>
+        <xsl:value-of select="./a:heading" />
+      </h1>
+      
+      <xsl:apply-templates select="./*[not(self::a:num) and not(self::a:heading)]" />
+    </div>
+  </xsl:template>
+
+  <xsl:template match="a:section">
+    <div class="an-{local-name()}" id="{@id}">
+      <h3>
+        <xsl:value-of select="./a:num" />
+        <xsl:text> </xsl:text>
+        <xsl:value-of select="./a:heading" />
+      </h3>
+      
+      <xsl:apply-templates select="./*[not(self::a:num) and not(self::a:heading)]" />
+    </div>
+  </xsl:template>
+  
+  <xsl:template match="a:subsection">
+    <span class="an-{local-name()}" id="{@id}">
+      <xsl:apply-templates select="./*[not(self::a:heading)]" />
+    </span>
+  </xsl:template>
+
+  <!-- for term nodes, ensure we keep the refersTo element -->
+  <xsl:template match="a:term">
+    <a class="an-{local-name()}">
+      <xsl:attribute name="data-refers-to">
+        <xsl:value-of select="@refersTo" />
+      </xsl:attribute>
+
+      <xsl:attribute name="href"><xsl:value-of select="$base_url" />definitions/#def-<xsl:value-of select="translate(@refersTo, '#', '')" /></xsl:attribute>
+
+      <xsl:apply-templates />
+    </a>
+  </xsl:template>
+
+  <!-- for all nodes, generate a SPAN element with a class matching
+       the AN name of the node and copy over the ID if it exists -->
+  <xsl:template match="*">
+    <span class="an-{local-name()}">
+      <xsl:if test="@id">
+        <xsl:attribute name="id">
+          <xsl:value-of select="@id" />
+        </xsl:attribute>
+      </xsl:if>
+      <xsl:apply-templates />
+    </span>
+  </xsl:template>
+  
+  <!-- For HTML table elements, copy them over then apply normal AN
+       processing to their contents -->
+  <xsl:template match="a:table | a:tr | a:th | a:td">
+    <xsl:element name="{local-name()}">
+      <xsl:copy-of select="@*" />
+      <xsl:apply-templates />
+    </xsl:element>
+  </xsl:template>
+
+  <!-- special HTML elements -->
+  <xsl:template match="a:a | a:abbr | a:b | a:i | a:span | a:sub | a:sup | a:u">
+    <xsl:element name="{local-name()}">
+      <xsl:copy-of select="@*" />
+      <xsl:apply-templates />
+    </xsl:element>
+  </xsl:template>
+
+</xsl:stylesheet>

data/lib/slaw/render/xsl/fragment.xsl

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0"
+  xmlns:a="http://www.akomantoso.org/2.0"
+  exclude-result-prefixes="a">
+
+  <xsl:import href="elements.xsl" />
+
+  <xsl:output method="html" />
+
+  <xsl:template match="/">
+    <!-- root_elem is passed in as an xpath parameter -->
+    <xsl:apply-templates select="$root_elem" />
+  </xsl:template>
+  
+</xsl:stylesheet> 
+

data/lib/slaw/version.rb

@@ -0,0 +1,3 @@
+module Slaw
+  VERSION = "0.1.2"
+end

data/lib/slaw/xml_support.rb

@@ -0,0 +1,77 @@
+# Add some helper methods to XML node objects
+class Nokogiri::XML::Node
+
+  # The AkomaNtoso number of this node, or nil if unknown.
+  # Major AN elements such as chapters, parts and sections almost
+  # always have numbers.
+  def num
+    node = at_xpath('./a:num', a: Slaw::NS)
+    node ? node.text.gsub(/\.$/, '') : nil
+  end
+
+  def heading
+    node = at_xpath('./a:heading', a: Slaw::NS)
+    node ? node.text : nil
+  end
+
+  def id
+    self['id']
+  end
+
+  def chapters
+    xpath('./a:chapter', a: Slaw::NS)
+  end
+
+  def sections
+    xpath('./a:section', a: Slaw::NS)
+  end
+
+  def parts
+    xpath('./a:part', a: Slaw::NS)
+  end
+
+  # Get a nodeset of child elements of this node which should show
+  # up in the table of contents
+  def toc_children
+    if in_schedules?
+      # in schedules, we only care about chapters that have numbers in them, because we
+      # can't link to them otherwise
+      xpath('a:chapter[a:num]', a: Slaw::NS)
+    else
+      xpath('a:part | a:chapter | a:section', a: Slaw::NS)
+    end
+  end
+
+  # Does this element hold children for the table of contents?
+  def toc_container?
+    !toc_children.empty?
+  end
+
+  # Title for this element in the table of contents
+  def toc_title
+    case name
+    when "mainBody"
+      "Schedules"
+    when "chapter"
+      title = in_schedules? ? "Schedule" : "Chapter" 
+      title << ' ' + num
+      title << ' - ' + heading if heading
+      title
+    when "part"
+      "Part #{num} - #{heading}"
+    when "section"
+      if not heading or heading.empty?
+        "Section #{num}" 
+      elsif num
+        "#{num}. #{heading}"
+      else
+        heading
+      end
+    end        
+  end
+
+  # Is this element part of a schedule document?
+  def in_schedules?
+    not ancestors('doc[name="schedules"]').empty?
+  end
+end

data/lib/slaw.rb

@@ -0,0 +1,24 @@
+require 'nokogiri'
+
+require 'slaw/version'
+require 'slaw/namespace'
+require 'slaw/logging'
+
+require 'slaw/act'
+require 'slaw/bylaw'
+require 'slaw/collection'
+
+require 'slaw/xml_support'
+require 'slaw/lifecycle_event'
+
+require 'slaw/render/html'
+require 'slaw/parse/blocklists'
+require 'slaw/parse/builder'
+require 'slaw/parse/cleanser'
+require 'slaw/parse/error'
+require 'slaw/parse/grammar_helpers'
+require 'slaw/parse/nodes'
+require 'slaw/elasticsearch'
+
+module Slaw
+end

data/slaw.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'slaw/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "slaw"
+  spec.version       = Slaw::VERSION
+  spec.authors       = ["Greg Kempe"]
+  spec.email         = ["greg@kempe.net"]
+  spec.summary       = %q{A lightweight library for using Akoma Ntoso acts in Ruby.}
+  spec.description   = %q{Slaw is a lightweight library for rendering and generating Akoma Ntoso acts from plain text and PDF documents.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14.1"
+
+  spec.add_runtime_dependency "nokogiri", "~> 1.6.0"
+  spec.add_runtime_dependency "elasticsearch", "~> 1.0.5"
+  spec.add_runtime_dependency "treetop", "~> 1.5"
+  spec.add_runtime_dependency "builder", "~> 3.2.2"
+  spec.add_runtime_dependency "log4r", "~> 1.1.10"
+end