slaw 1.0.0.alpha.6 → 1.0.0

data/lib/slaw/bylaw.rb

@@ -1,62 +0,0 @@
-require 'slaw/act'
-
-module Slaw
-  # An extension of {Slaw::Act} which wraps an AkomaNtoso XML document describing an By-Law.
-  #
-  # There are minor differences between Acts and By-laws, the most notable being that a by-law
-  # is not identified by a year and a number, and therefore has a different FRBR uri structure.
-  class ByLaw < Act
-
-    # [String] The code of the region this by-law applies to
-    attr_reader :region
-    
-    # [String] A short file-like name of this by-law, unique within its year and region
-    attr_reader :name
-
-    # ByLaws don't have numbers, use their short-name instead
-    def num
-      name
-    end
-
-    def title
-      node = @meta.at_xpath('./a:identification/a:FRBRWork/a:FRBRalias', a: NS)
-      title = node ? node['value'] : "(Unknown)"
-
-      if amended? and not title.end_with?("as amended")
-        title = title + " as amended"
-      end
-
-      title
-    end
-
-    # Set the short (file-like) name for this bylaw. This changes the {#id_uri}.
-    def name=(value)
-      @name = value
-      rebuild_id_uri
-    end
-
-    # Set the region code for this bylaw. This changes the {#id_uri}.
-    def region=(value)
-      @region = value
-      rebuild_id_uri
-    end
-
-    protected
-
-    def extract_id_uri
-      # /za/by-law/cape-town/2010/public-parks
-
-      @id_uri = @meta.at_xpath('./a:identification/a:FRBRWork/a:FRBRuri', a: NS)['value']
-      empty, @country, @nature, @region, date, @name = @id_uri.split('/')
-
-      # yyyy[-mm-dd]
-      @year = date.split('-', 2)[0]
-    end
-
-    def build_id_uri
-      # /za/by-law/cape-town/2010/public-parks
-      "/#{@country}/#{@nature}/#{@region}/#{@year}/#{@name}"
-    end
-
-  end
-end

data/lib/slaw/collection.rb

@@ -1,60 +0,0 @@
-require 'forwardable'
-
-module Slaw
-  # A collection of Act instances.
-  #
-  # This is useful for looking up acts by their FRBR uri and for
-  # loading a collection of XML act documents.
-  #
-  # This collection is enumerable and can be iterated over. Use {#items} to
-  # access the underlying array of objects.
-  #
-  # @example Load a collection of acts and then iterate over them.
-  #
-  #     acts = Slaw::DocumentCollection.new
-  #     acts.discover('/path/to/acts/')
-  #
-  #     for act in acts
-  #       puts act.short_name
-  #     end
-  #
-  class DocumentCollection
-
-    include Enumerable
-    extend Forwardable
-
-    # [Array<Act>] The underlying array of acts
-    attr_accessor :items
-
-    def_delegators :items, :each, :<<, :length
-
-    def initialize(items=nil)
-      @items = items || []
-    end
-
-    # Find all XML files in `path` and add them into this
-    # collection.
-    #
-    # @param path [String] the path to glob for xml files
-    # @param cls [Class] the class to instantiate for each file
-    #
-    # @return [DocumentCollection] this collection
-    def discover(path, cls=Slaw::Act)
-      for fname in Dir.glob("#{path}/**/*.xml")
-        @items << cls.new(fname)
-      end
-
-      self
-    end
-
-    # Try to find an act who's FRBRuri matches this one,
-    # returning nil on failure
-    #
-    # @param uri [String] the uri to look for
-    #
-    # @return [Act, nil] the act, or nil
-    def for_uri(uri)
-      return @items.find { |doc| doc.id_uri == uri }
-    end
-  end
-end

data/lib/slaw/lifecycle_event.rb

@@ -1,23 +0,0 @@
-module Slaw
-  # An event in the lifecycle of an act
-  class LifecycleEvent
-    include Slaw::Namespace
-
-    # Date of the event
-    attr_accessor :date
-
-    # type of the event
-    attr_accessor :type
-
-    # the source of the event, an XML reference element
-    attr_accessor :source
-
-    def initialize(element)
-      @date = element['date']
-      @type = element['type']
-
-      source_id = element['source'][1..-1]
-      @source = element.document.at_xpath("//a:references/*[@id=\"#{source_id}\"]", a: NS)
-    end
-  end
-end

data/lib/slaw/render/html.rb

@@ -1,70 +0,0 @@
-module Slaw
-  module Render
-
-    # Support for transforming XML AN documents into HTML.
-    #
-    # This rendering is done using XSLT stylesheets. Both an entire
-    # document and fragments can be rendered.
-    class HTMLRenderer
-
-      # [Hash] A Hash of Nokogiri::XSLT objects
-      attr_accessor :xslt
-
-      def initialize
-        here = File.dirname(__FILE__)
-
-        @xslt = {
-          act: Nokogiri::XSLT(File.open(File.join([here, 'xsl/act.xsl']))),
-          fragment: Nokogiri::XSLT(File.open(File.join([here, 'xsl/fragment.xsl']))),
-        }
-      end
-
-      # Transform an entire XML document (a Nokogiri::XML::Document object) into HTML.
-      # Specify `base_url` to manage the base for relative URLs generated by
-      # the transform.
-      #
-      # @param doc [Nokogiri::XML::Document] document to render
-      # @param base_url [String] root URL for relative URLs (cannot be empty)
-      #
-      # @return [String]
-      def render(doc, base_url='')
-        params = _transform_params({'base_url' => base_url})
-        _run_xslt(:act, doc, params)
-      end
-
-      # Transform just a single node and its children into HTML.
-      #
-      # If +elem+ has an id, we use xpath to tell the XSLT which
-      # element to transform. Otherwise we copy the node into a new
-      # tree and apply the XSLT to that.
-      #
-      # @param node [Nokogiri::XML::Node] node to render
-      # @param base_url [String] root URL for relative URLs (cannot be empty)
-      #
-      # @return [String]
-      def render_node(node, base_url='')
-        params = _transform_params({'base_url' => base_url})
-
-        if node.id
-          params += ['root_elem', "//*[@id='#{node.id}']"]
-          doc = node.document
-        else
-          # create a new document with just this element at the root
-          doc = Nokogiri::XML::Document.new
-          doc.root = node
-          params += ['root_elem', '*']
-        end
-
-        _run_xslt(:fragment, doc, params)
-      end
-
-      def _run_xslt(xslt, doc, params)
-        @xslt[xslt].transform(doc, params).to_s
-      end
-
-      def _transform_params(params)
-        Nokogiri::XSLT.quote_params(params)
-      end
-    end
-  end
-end

data/lib/slaw/render/xsl/act.xsl

@@ -1,15 +0,0 @@
-<?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="/">
-    <xsl:apply-templates select="a:akomaNtoso/a:act" />
-  </xsl:template>
-  
-</xsl:stylesheet> 
-

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

@@ -1,120 +0,0 @@
-<?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:template match="a:eol">
-    <xsl:element name="br" />
-  </xsl:template>
-
-</xsl:stylesheet>

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

@@ -1,16 +0,0 @@
-<?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/spec/act_spec.rb

@@ -1,56 +0,0 @@
-# encoding: UTF-8
-
-require 'spec_helper'
-require 'slaw'
-
-describe Slaw::Act do
-  let(:filename) { File.dirname(__FILE__) + "/fixtures/community-fire-safety.xml" }
-  subject { Slaw::Act.new(filename) }
-
-  it 'should have correct basic properties' do
-    subject.title.should == 'Community Fire Safety By-law'
-    subject.amended?.should be_true
-  end
-
-  it 'should set the title correctly' do
-    subject.title = 'foo'
-    subject.meta.at_xpath('./a:identification/a:FRBRWork/a:FRBRalias', a: Slaw::NS)['value'].should == 'foo'
-  end
-
-  it 'should set the title if it doesnt exist' do
-    subject.meta.at_xpath('./a:identification/a:FRBRWork/a:FRBRalias', a: Slaw::NS).remove
-    subject.title = 'bar'
-    subject.title.should == 'bar'
-  end
-
-  it 'should set the publication details' do
-    subject.meta.at_xpath('./a:publication', a: Slaw::NS).remove
-
-    subject.published!(name: 'foo', number: '1234', date: '2014-01-01')
-    subject.publication['name'].should == 'foo'
-    subject.publication['showAs'].should == 'foo'
-    subject.publication['number'].should == '1234'
-  end
-
-  it 'should get/set the work date' do
-    subject.date.should == '2002-02-28'
-
-    subject.date = '2014-01-01'
-    subject.date.should == '2014-01-01'
-    subject.meta.at_xpath('./a:identification/a:FRBRWork/a:FRBRdate[@name="Generation"]', a: Slaw::NS)['date'].should == '2014-01-01'
-    subject.meta.at_xpath('./a:identification/a:FRBRExpression/a:FRBRdate[@name="Generation"]', a: Slaw::NS)['date'].should == '2014-01-01'
-
-    subject.id_uri.should == '/za/by-law/2014/2002'
-  end
-
-  it 'should update the uri when the year changes' do
-    subject.id_uri.should == '/za/by-law/cape-town/2002/community-fire-safety'
-    subject.year = '1980'
-    subject.id_uri.should == '/za/by-law/1980/2002'
-  end
-
-  it 'should validate' do
-    subject.validate.should == []
-    subject.validates?.should be_true
-  end
-end

data/spec/bylaw_spec.rb

@@ -1,49 +0,0 @@
-# encoding: UTF-8
-
-require 'spec_helper'
-require 'slaw'
-
-describe Slaw::ByLaw do
-  let(:filename) { File.dirname(__FILE__) + "/fixtures/community-fire-safety.xml" }
-  subject { Slaw::ByLaw.new(filename) }
-
-  it 'should have correct basic properties' do
-    subject.title.should == 'Community Fire Safety By-law as amended'
-    subject.amended?.should be_true
-  end
-
-  it 'should update the uri when the region changes' do
-    subject.id_uri.should == '/za/by-law/cape-town/2002/community-fire-safety'
-    subject.region = 'foo-bar'
-    subject.id_uri.should == '/za/by-law/foo-bar/2002/community-fire-safety'
-  end
-
-  it 'should update the uri when the name changes' do
-    subject.id_uri.should == '/za/by-law/cape-town/2002/community-fire-safety'
-    subject.name = 'foo-bar'
-    subject.id_uri.should == '/za/by-law/cape-town/2002/foo-bar'
-  end
-
-  it 'should set the title if it doesnt exist' do
-    subject.meta.at_xpath('./a:identification/a:FRBRWork/a:FRBRalias', a: Slaw::NS).remove
-    subject.title = 'bar'
-    subject.title.should == 'bar as amended'
-  end
-
-  it 'should get/set the work date' do
-    subject.date.should == '2002-02-28'
-
-    subject.date = '2014-01-01'
-    subject.date.should == '2014-01-01'
-    subject.meta.at_xpath('./a:identification/a:FRBRWork/a:FRBRdate[@name="Generation"]', a: Slaw::NS)['date'].should == '2014-01-01'
-    subject.meta.at_xpath('./a:identification/a:FRBRExpression/a:FRBRdate[@name="Generation"]', a: Slaw::NS)['date'].should == '2014-01-01'
-
-    subject.id_uri.should == '/za/by-law/cape-town/2014/community-fire-safety'
-  end
-
-  it 'should update the uri when the year changes' do
-    subject.id_uri.should == '/za/by-law/cape-town/2002/community-fire-safety'
-    subject.year = '1980'
-    subject.id_uri.should == '/za/by-law/cape-town/1980/community-fire-safety'
-  end
-end