nlg_xml_realiser_builder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0b9ac3b073d046a5716db912bcf9f8ec79db54a3
+  data.tar.gz: 3c16b1dd32d8e05c292d37a188d319b220e55bd5
+SHA512:
+  metadata.gz: fd217f950e9663fed67e2582b0f1d2339d4e14950018846ed0ae8aa22a5a27915c2c8e9ce8c946dd6cc9a1b2896a6f2e83d77c08ed46448146b818954252bfae
+  data.tar.gz: dc76fcfeeb3cc22dd13bf3287cc299a225c3e22c13343bfff52acea1816dcc56a54bda68caf24d955da0deffe486575ce0a3014d7b4072a6b2c341f458385afb

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.13.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in nlg_xml_realiser_builder.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,198 @@
+# Simple NLG compatible XML Realiser Builder
+
+This is still not a full featured builder for Simple NLG but the goal is to make it easier to compose the XML Realiser recordings.
+
+There is an online service at https://nlg-service.herokuapp.com which embeds SimpleNLG in a web service.
+
+Check out [nlg-service](https://github.com/Codeminer42/nlg_service) to see the Rails-API running under JRuby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nlg_xml_realiser_builder'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nlg_xml_realiser_builder
+
+## Usage
+
+The XML Realiser format can be checked through it's [XML Schema](https://github.com/simplenlg/simplenlg/blob/master/src/main/resources/xml/RealizerSchema.xsd) which is roughly implemented in this DSL, with most of the relevant attributes validations as well.
+
+The usage is mainly nesting the main builder elements:
+
+* Sentence-like Phrase - SPhraseSpec - `sp(tag, options, &block)`
+* Noun Phrase - NPPhraseSpec - `np(tag, noun, options, &block)`
+* Verb Phrase - VPPhraseSpec - `vp(tag, verb, options, &block)`
+* Adjective Phrase - AdjPhraseSpec - `adj(tag, adjective, options, &block)`
+* Adverbial Phrase - AdvPhraseSpec - `adv(tag, adverb, options, &block)`
+* Propositional Phrase - PPPhraseSpec - `pp(tag, preposition, options, &block)`
+* Coordination between 2 or more phrases - CoordinatedPhraseElement - `cp(tag, options, &block)`
+
+Example:
+
+```
+dsl = NlgXmlRealiserBuilder::DSL.new
+dsl.builder(true) do
+  sp :child do
+    subj :np, 'there', cat: 'ADVERB'
+    verb 'be' do
+      compl [ 'a', 'restenosis' ] do
+        preMod :cp, conj: ',' do
+          coord :adj, 'eccentric'
+          coord :adj, 'tubular'
+        end
+        postMod :str, '(18 mm x 1 mm)'
+      end
+      postMod :pp, 'from' do
+        preMod :vp, 'extend', FORM: 'GERUND'
+        compl ['the'] do
+          preMod :adj, 'proximal'
+        end
+        postMod :pp, 'to' do
+          compl [ 'a', 'right coronary artery' ] do
+            preMod :adj, 'mid'
+          end
+        end
+      end
+      postMod :pp, 'with' do
+        compl :np, 'TIMI 1 flow'
+      end
+    end
+  end
+end.to_xml
+```
+
+Resulting XML:
+
+```
+<?xml version="1.0"?>
+<NLGSpec xmlns="http://simplenlg.googlecode.com/svn/trunk/res/xml" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <Recording>
+    <Record>
+      <Document cat="PARAGRAPH">
+        <child xsi:type="SPhraseSpec">
+          <subj xsi:type="NPPhraseSpec">
+            <head cat="ADVERB">
+              <base>there</base>
+            </head>
+          </subj>
+          <vp xsi:type="VPPhraseSpec">
+            <head cat="VERB">
+              <base>be</base>
+            </head>
+            <compl xsi:type="NPPhraseSpec">
+              <head cat="NOUN">
+                <base>restenosis</base>
+              </head>
+              <spec cat="DETERMINER">
+                <base>a</base>
+              </spec>
+              <preMod xsi:type="CoordinatedPhraseElement" conj=",">
+                <coord xsi:type="AdjPhraseSpec">
+                  <head cat="ADJECTIVE">
+                    <base>eccentric</base>
+                  </head>
+                </coord>
+                <coord xsi:type="AdjPhraseSpec">
+                  <head cat="ADJECTIVE">
+                    <base>tubular</base>
+                  </head>
+                </coord>
+              </preMod>
+              <postMod xsi:type="StringElement">
+                <val>(18 mm x 1 mm)</val>
+              </postMod>
+            </compl>
+            <postMod xsi:type="PPPhraseSpec">
+              <head cat="PREPOSITION">
+                <base>from</base>
+              </head>
+              <preMod xsi:type="VPPhraseSpec" FORM="GERUND">
+                <head cat="VERB">
+                  <base>extend</base>
+                </head>
+              </preMod>
+              <compl xsi:type="NPPhraseSpec">
+                <spec cat="DETERMINER">
+                  <base>the</base>
+                </spec>
+                <preMod xsi:type="AdjPhraseSpec">
+                  <head cat="ADJECTIVE">
+                    <base>proximal</base>
+                  </head>
+                </preMod>
+              </compl>
+              <postMod xsi:type="PPPhraseSpec">
+                <head cat="PREPOSITION">
+                  <base>to</base>
+                </head>
+                <compl xsi:type="NPPhraseSpec">
+                  <head cat="NOUN">
+                    <base>right coronary artery</base>
+                  </head>
+                  <spec cat="DETERMINER">
+                    <base>a</base>
+                  </spec>
+                  <preMod xsi:type="AdjPhraseSpec">
+                    <head cat="ADJECTIVE">
+                      <base>mid</base>
+                    </head>
+                  </preMod>
+                </compl>
+              </postMod>
+            </postMod>
+            <postMod xsi:type="PPPhraseSpec">
+              <head cat="PREPOSITION">
+                <base>with</base>
+              </head>
+              <compl xsi:type="NPPhraseSpec">
+                <head cat="NOUN">
+                  <base>TIMI 1 flow</base>
+                </head>
+              </compl>
+            </postMod>
+          </vp>
+        </child>
+      </Document>
+    </Record>
+  </Recording>
+</NLGSpec>
+```
+
+From here you can use the [NLG Service Web Service](https://github.com/Codeminer42/nlg_service) to transform this XML into a grammatically and ortographically correct natural English phrase.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+You can use the NLG Web Service from the `bin/console` using:
+
+```
+NlgXmlRealiserBuilder.test_post(builder.to_xml)
+```
+
+It should return a properly realised English phrase.
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Codeminer42/nlg_xml_realiser_builder.
+
+
+## License
+
+Author: Fabio Akita
+Copyright 2016 (C) Codeminer 42
+
+The gem is available as open source under the terms of the [LGPL-3.0 License](https://opensource.org/licenses/LGPL-3.0).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nlg_xml_realiser_builder"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nlg_xml_realiser_builder.rb

@@ -0,0 +1,17 @@
+require "nlg_xml_realiser_builder/version"
+require "nlg_xml_realiser_builder/consts"
+require "nlg_xml_realiser_builder/primitive_operations"
+require "nlg_xml_realiser_builder/phrase_specs"
+require "nlg_xml_realiser_builder/porcelain"
+require "nlg_xml_realiser_builder/dsl"
+require "nokogiri"
+require "net/http"
+require "uri"
+
+module NlgXmlRealiserBuilder
+  def self.test_post(text)
+    uri = URI.parse("#{ENV['SERVICE_URL'] || 'http://nlg-service.herokuapp.com'}/api/realiser")
+    response = Net::HTTP.post_form(uri, {"xml" => text})
+    response.body.strip
+  end
+end

data/lib/nlg_xml_realiser_builder/consts.rb

@@ -0,0 +1,225 @@
+# frozen_string_literal: true
+module NlgXmlRealiserBuilder
+  module Consts
+    XML_SCHEMA = {
+      'xmlns'     => 'http://simplenlg.googlecode.com/svn/trunk/res/xml',
+      'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
+      'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance'}.freeze
+
+    SPEC_METHODS = %i(sp np vp adj adv cp pp str)
+
+    DOCUMENT_CATEGORIES = %w(DOCUMENT
+        SECTION
+        PARAGRAPH
+        SENTENCE
+        LIST
+        ENUMERATED_LIST
+        LIST_ITEM).freeze
+
+    PHRASE_SPEC_TYPES = %w(SPhraseSpec
+      VPPhraseSpec
+      NPPhraseSpec
+      AdjPhraseSpec
+      AdvPhraseSpec
+      PPPhraseSpec
+      CoordinatedPhraseElement
+      PhraseElement
+      StringElement
+      WordElement).freeze
+
+    # What elements does each phrase spec type accepts
+
+    DOCUMENTELEMENT_ELEMENTS       = %i(child).freeze
+    SPHRASESPEC_ELEMENTS           = %i(cuePhrase subj vp).freeze
+    PHRASE_ELEMENTS                = %i(frontMod preMod compl postMod head).freeze
+    COORDINATEDPHRASEELEMENT_ELEMENTS = %i(coord).freeze
+
+    VPPHRASESPEC_ELEMENTS          = PHRASE_ELEMENTS
+    NPPHRASESPEC_ELEMENTS          = ( PHRASE_ELEMENTS + [ :spec ] ).freeze
+    ADJPHRASESPEC_ELEMENTS         = PHRASE_ELEMENTS
+    ADVPHRASESPEC_ELEMENTS         = PHRASE_ELEMENTS
+    PPPHRASESPEC_ELEMENTS          = PHRASE_ELEMENTS
+
+    # What attributes does each phrase spec type accepts
+
+    SPHRASESPEC_ATTRIBUTES = %i(AGGREGATE_AUXILIARY
+                                CLAUSE_STATUS
+                                COMPLEMENTISER
+                                FORM
+                                INTERROGATIVE_TYPE
+                                MODAL
+                                NEGATED
+                                PASSIVE
+                                PERFECT
+                                PERSON
+                                PROGRESSIVE
+                                SUPPRESS_GENITIVE_IN_GERUND
+                                SUPRESSED_COMPLEMENTISER
+                                TENSE).freeze
+
+    VPPHRASESPEC_ATTRIBUTES = %i(AGGREGATE_AUXILIARY
+                                FORM
+                                MODAL
+                                NEGATED
+                                PASSIVE
+                                PERFECT
+                                PERSON
+                                PROGRESSIVE
+                                SUPPRESS_GENITIVE_IN_GERUND
+                                SUPRESSED_COMPLEMENTISER
+                                TENSE).freeze
+
+    NPPHRASESPEC_ATTRIBUTES = %i(ADJECTIVE_ORDERING
+                                ELIDED
+                                NUMBER
+                                GENDER
+                                PERSON
+                                POSSESSIVE
+                                PRONOMINAL
+                                cat
+                                discourseFunction
+                                appositive).freeze
+
+    ADJPHRASESPEC_ATTRIBUTES = %i(IS_COMPARATIVE IS_SUPERLATIVE).freeze
+
+    ADVPHRASESPEC_ATTRIBUTES = [].freeze
+
+    PPPHRASESPEC_ATTRIBUTES  = [].freeze
+
+    COORDINATEDPHRASEELEMENT_ATTRIBUTES = %i(conj
+                                cat
+                                APPOSITIVE
+                                CONJUNCTION_TYPE
+                                MODAL
+                                NEGATED
+                                NUMBER
+                                PERSON
+                                POSSESSIVE
+                                PROGRESSIVE
+                                RAISE_SPECIFIER
+                                SUPRESSED_COMPLEMENTISER
+                                TENSE).freeze
+
+    WORDELEMENT_ATTRIBUTES = %i(cat
+                               id
+                               EXPLETIVE_SUBJECT
+                               PROPER
+                               var
+                               canned).freeze
+
+    # What primitive values does each kind of attribute accepts
+
+    NLG_PHRASE_CATEGORY = %w(CLAUSE
+      ADJECTIVE_PHRASE
+      ADVERB_PHRASE
+      NOUN_PHRASE
+      PREPOSITIONAL_PHRASE
+      VERB_PHRASE
+      CANNED_TEXT).freeze
+
+    NLG_LEXICAL_CATEGORY = %w(ANY
+      SYMBOL
+      NOUN
+      ADJECTIVE
+      ADVERB
+      VERB
+      DETERMINER
+      PRONOUN
+      CONJUNCTION
+      PREPOSITION
+      COMPLEMENTISER
+      MODAL
+      AUXILIARY).freeze
+
+    NLG_TENSE = %w(FUTURE PAST PRESENT).freeze
+
+    NLG_CLAUSE_STATUS = %w(MATRIX SUBORDINATE).freeze
+
+    NLG_DISCOURSE_FUNCTION = %w(AUXILIARY
+      COMPLEMENT
+      CONJUNCTION
+      CUE_PHRASE
+      FRONT_MODIFIER
+      HEAD
+      INDIRECT_OBJECT
+      OBJECT
+      PRE_MODIFIER
+      POST_MODIFIER
+      SPECIFIER
+      SUBJECT
+      VERB_PHRASE).freeze
+
+    NLG_FORM = %w(BARE_INFINITIVE
+      GERUND
+      IMPERATIVE
+      INFINITIVE
+      NORMAL
+      PAST_PARTICIPLE
+      PRESENT_PARTICIPLE).freeze
+
+    NLG_GENDER = %w(MASCULINE FEMININE NEUTER).freeze
+
+    NLG_NUMBER_AGREEMENT = %w(BOTH PLURAL SINGULAR).freeze
+
+    NLG_PERSON = %w(FIRST SECOND THIRD).freeze
+
+    NLG_INTERROGATIVE_TYPE = %w(HOW
+      WHAT_OBJECT
+      WHAT_SUBJECT
+      WHERE
+      WHO_INDIRECT_OBJECT
+      WHO_OBJECT
+      WHO_SUBJECT
+      WHY
+      YES_NO).freeze
+
+    NLG_INFLECTION = %w(GRECO_LATIN_REGULAR
+      IRREGULAR
+      REGULAR
+      REGULAR_DOUBLE
+      UNCOUNT
+      INVARIANT).freeze
+
+    NLG_BOOLEAN = [true, false].freeze
+
+    ATTRIBUTES = {
+      ADJECTIVE_ORDERING:            NLG_BOOLEAN,
+      AGGREGATE_AUXILIARY:           NLG_BOOLEAN,
+      APPOSITIVE:                    NLG_BOOLEAN,
+      CLAUSE_STATUS:                 NLG_CLAUSE_STATUS,
+      COMPLEMENTISER:                String,
+      CONJUNCTION_TYPE:              String,
+      ELIDED:                        NLG_BOOLEAN,
+      EXPLETIVE_SUBJECT:             NLG_BOOLEAN,
+      FORM:                          NLG_FORM,
+      GENDER:                        NLG_GENDER,
+      INTERROGATIVE_TYPE:            NLG_INTERROGATIVE_TYPE,
+      IS_COMPARATIVE:                NLG_BOOLEAN,
+      IS_SUPERLATIVE:                NLG_BOOLEAN,
+      MODAL:                         String,
+      NEGATED:                       NLG_BOOLEAN,
+      NUMBER:                        NLG_NUMBER_AGREEMENT,
+      PASSIVE:                       NLG_BOOLEAN,
+      PERFECT:                       NLG_BOOLEAN,
+      PERSON:                        NLG_PERSON,
+      POSSESSIVE:                    NLG_BOOLEAN,
+      PROGRESSIVE:                   NLG_BOOLEAN,
+      PRONOMINAL:                    NLG_BOOLEAN,
+      PROPER:                        NLG_BOOLEAN,
+      RAISE_SPECIFIER:               NLG_BOOLEAN,
+      SUPPRESS_GENITIVE_IN_GERUND:   NLG_BOOLEAN,
+      SUPRESSED_COMPLEMENTISER:      NLG_BOOLEAN,
+      TENSE:                         NLG_TENSE,
+      appositive:                    NLG_BOOLEAN,
+      base:                          String,
+      canned:                        NLG_BOOLEAN,
+      cat:                           ( NLG_PHRASE_CATEGORY + NLG_LEXICAL_CATEGORY ).freeze,
+      conj:                          String,
+      discourseFunction:             NLG_DISCOURSE_FUNCTION,
+      id:                            String,
+      val:                           String,
+      var:                           NLG_INFLECTION,
+    }.freeze
+
+  end
+end

data/lib/nlg_xml_realiser_builder/dsl.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+module NlgXmlRealiserBuilder
+  class DSL
+    include NlgXmlRealiserBuilder::PrimitiveOperations
+    include NlgXmlRealiserBuilder::PhraseSpecs
+    include NlgXmlRealiserBuilder::Porcelain
+  end
+end

data/lib/nlg_xml_realiser_builder/phrase_specs.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+module NlgXmlRealiserBuilder
+  module PhraseSpecs
+    SPEC_METHODS = %i(sp np vp adj adv cp pp)
+
+    def sp(tag = :child, options = {}, &block)
+      abstract_spec('SPhraseSpec', tag, options, block)
+    end
+
+    def np(tag = :subj, noun = nil, options = {}, &block)
+      determiner = options.delete(:determiner)
+      cat        = options.delete(:cat) || 'NOUN'
+      determiner, noun = noun if noun.is_a?(Array)
+
+      abstract_spec('NPPhraseSpec', tag, options, block) do
+        head(noun, cat)  if noun
+        spec(determiner) if determiner
+      end
+    end
+
+    def vp(tag = :vp, verb = nil, options = {}, &block)
+      abstract_spec('VPPhraseSpec', tag, options, block) do
+        head(verb, 'VERB') if verb
+      end
+    end
+
+    def adj(tag = :coord, adjective = nil, options = {}, &block)
+      abstract_spec('AdjPhraseSpec', tag, options, block) do
+        head(adjective, 'ADJECTIVE') if adjective
+      end
+    end
+
+    def adv(tag = :coord, adverb = nil, options = {}, &block)
+      abstract_spec('AdvPhraseSpec', tag, options, block) do
+        head(adjective, 'ADVERB') if adjective
+      end
+    end
+
+    def cp(tag = :vp, options = { conj: ',' }, &block)
+      abstract_spec('CoordinatedPhraseElement', tag, options, block)
+    end
+
+    def pp(tag = :compl, preposition = nil, options = {}, &block)
+      abstract_spec('PPPhraseSpec', tag, options, block) do
+        head(preposition, 'PREPOSITION') if preposition
+      end
+    end
+  end
+end

data/lib/nlg_xml_realiser_builder/porcelain.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+module NlgXmlRealiserBuilder
+  module Porcelain
+    def list(enumerated: false, &block)
+      document_category = enumerated ? 'ENUMERATED_LIST' : 'LIST'
+      doc(:Document, cat: document_category, &block)
+    end
+
+    def item(&block)
+      doc(:child, cat: 'LIST_ITEM', &block)
+    end
+
+    def verb(verb = nil, options = {}, &block)
+      vp(:vp, verb, options, &block)
+    end
+
+    # Invert the tag for the phrase spec
+    private def abstract_tag(spec_method, tag = nil, main_value = nil, options = {}, &block)
+      unless Consts::SPEC_METHODS.include?(spec_method)
+        raise "spec method #{spec_method} not included in [#{Consts::SPEC_METHODS.join(", ")}]"
+      end
+      if main_value.is_a?(Hash)
+        send(spec_method, tag, main_value, &block) # case of 'cp' which has no main value parameter
+      else
+        send(spec_method, tag, main_value, options, &block)
+      end
+    end
+
+    # Create inverted methods so instead of doing:
+    #
+    #   np(:compl, ['an', 'apple'])
+    #
+    # we can do:
+    #
+    #   compl(:np, ['an', 'apple'])
+    #
+    (Consts::DOCUMENTELEMENT_ELEMENTS + Consts::SPHRASESPEC_ELEMENTS + Consts::PHRASE_ELEMENTS + Consts::COORDINATEDPHRASEELEMENT_ELEMENTS).each do |main_tag|
+      next if %i(head vp).include? main_tag
+      module_eval <<-EOF
+      def #{main_tag}(spec_method, main_value = nil, options = {}, &block)
+        if spec_method.is_a?(Array)
+          abstract_tag(:np, :#{main_tag}, spec_method, main_value || {}, &block)
+        else
+          abstract_tag(spec_method, :#{main_tag}, main_value, options, &block)
+        end
+      end
+      EOF
+    end
+  end
+end

data/lib/nlg_xml_realiser_builder/primitive_operations.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+module NlgXmlRealiserBuilder
+  module PrimitiveOperations
+    def builder(simple = false, &block)
+      Nokogiri::XML::Builder.new do |xml|
+        @xml = xml
+        xml.NLGSpec(Consts::XML_SCHEMA) {
+          xml.Recording {
+            if simple
+              record {
+                doc {
+                  instance_eval(&block) if block
+                }
+              }
+            else
+              instance_eval(&block) if block
+            end
+          }
+        }
+      end
+    end
+
+    def record(name = nil, &block)
+      attributes = {}
+      attributes.merge!(name: name) if name
+      @xml.Record(attributes) {
+        instance_eval(&block) if block
+      }
+    end
+
+    def doc(tag = :Document, options = {}, &block)
+      category = options.delete(:cat) || 'PARAGRAPH'
+      unless Consts::DOCUMENT_CATEGORIES.include?(category)
+        raise "Document category '#{category}' is not in [#{Consts::DOCUMENT_CATEGORIES.join(", ")}]"
+      end
+      attributes = {}
+      attributes.merge!('xsi:type' => 'DocumentElement') unless tag == :Document
+      attributes.merge!('cat' => category)
+      @xml.send(tag, attributes) {
+        nlg_eval('DocumentElement', &block)
+      }
+    end
+
+    def str(tag = :compl, val = nil, options = nil, &block)
+      return unless val
+      @xml.send(tag, 'xsi:type' => 'StringElement') {
+        @xml.val val.to_s
+      }
+    end
+
+    def head(base, cat = 'NOUN')
+      unless Consts::NLG_LEXICAL_CATEGORY.include?(cat)
+        raise "Head category '#{cat}' is not in [#{Consts::NLG_LEXICAL_CATEGORY.join(", ")}]"
+      end
+      @xml.head('cat' => cat) {
+        @xml.base base
+      }
+    end
+
+    def spec(base, cat = 'DETERMINER')
+      unless Consts::NLG_LEXICAL_CATEGORY.include?(cat)
+        raise "Specifier category must be in [#{Consts::NLG_LEXICAL_CATEGORY.join(", ")}]"
+      end
+      @xml.spec_('xsi:type' => 'WordElement', 'cat' => cat) {
+        @xml.base base
+      }
+    end
+
+    private def nlg_eval(spec_type, &block)
+      begin
+        previous_call, @last_call = @last_call, spec_type
+        instance_eval(&block) if block
+      ensure
+        @last_call = previous_call
+      end
+    end
+
+    private def validate_element!(tag)
+      elements = Consts.const_get("#{@last_call.upcase}_ELEMENTS".to_sym)
+      unless elements.include?(tag)
+        raise "Element #{tag} is now allowed within #{@last_call}. Must be in [#{elements.join(', ')}]"
+      end
+    end
+
+    private def validate_spec_type!(spec_type)
+      unless Consts::PHRASE_SPEC_TYPES.include?(spec_type)
+        raise "There is no '#{spec_type}' in [#{Consts::PHRASE_SPEC_TYPES.join(", ")}]"
+      end
+    end
+
+    private def is_attribute_valid?(value, validation)
+      validation.is_a?(Array) ? validation.include?(value) : value.is_a?(validation)
+    end
+
+    private def validate_attributes!(options = {}, spec_type)
+      valid_attributes   = Consts.const_get("#{spec_type.upcase}_ATTRIBUTES")
+      invalid_attributes = options.keys - valid_attributes
+      unless invalid_attributes.empty?
+        raise "Attributes [#{invalid_attributes.join(", ")}] are invalid for #{spec_type} which only allows [#{valid_attributes.join(", ")}]"
+      end
+
+      results = options.keys.reject { |key|
+        is_attribute_valid?( options[key], Consts::ATTRIBUTES[key] )
+      }.reduce([]) { |key|
+        results << "Attribute #{key} with value '#{options[key]}' should be in [#{Consts::ATTRIBUTES[key].join(", ")}]"
+      }
+
+      raise results.join("\n") unless results.empty?
+    end
+
+    private def abstract_spec(spec_type, tag, options = {}, block)
+      validate_element! tag
+      validate_spec_type! spec_type
+      validate_attributes! options, spec_type
+
+      attributes = { 'xsi:type' => spec_type }
+      attributes.merge!(options) if options && !options.empty?
+
+      @xml.send(tag, attributes) {
+        yield if block_given?
+        nlg_eval(spec_type, &block)
+      }
+    end
+  end
+end

data/lib/nlg_xml_realiser_builder/version.rb

@@ -0,0 +1,3 @@
+module NlgXmlRealiserBuilder
+  VERSION = "0.1.0"
+end

data/nlg_xml_realiser_builder.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nlg_xml_realiser_builder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nlg_xml_realiser_builder"
+  spec.version       = NlgXmlRealiserBuilder::VERSION
+  spec.authors       = ["Fabio Akita"]
+  spec.email         = ["boss@akitaonrails.com"]
+
+  spec.summary       = %q{Builder for Simple NLG XML format}
+  spec.description   = %q{Builds Simple NLG compatible XML recordings}
+  spec.homepage      = "https://github.com/Codeminer42/nlg_xml_realiser_builder"
+  spec.license       = "LGPL"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.4"
+
+  spec.add_runtime_dependency "nokogiri", "~> 1.6.8.1"
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: nlg_xml_realiser_builder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Fabio Akita
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.8.1
+description: Builds Simple NLG compatible XML recordings
+email:
+- boss@akitaonrails.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nlg_xml_realiser_builder.rb
+- lib/nlg_xml_realiser_builder/consts.rb
+- lib/nlg_xml_realiser_builder/dsl.rb
+- lib/nlg_xml_realiser_builder/phrase_specs.rb
+- lib/nlg_xml_realiser_builder/porcelain.rb
+- lib/nlg_xml_realiser_builder/primitive_operations.rb
+- lib/nlg_xml_realiser_builder/version.rb
+- nlg_xml_realiser_builder.gemspec
+homepage: https://github.com/Codeminer42/nlg_xml_realiser_builder
+licenses:
+- LGPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Builder for Simple NLG XML format
+test_files: []