ruby_speech 2.1.0-java

data/.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+*.gem
+*.bundle
+*.jar
+Gemfile.lock
+pkg/*
+spec/reports
+.yardoc
+doc
+.*.swp
+vendor
+tmp/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--colour
+--tty

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+matrix:
+  allow_failures:
+    # - rvm: jruby-19mode
+before_install:
+  - sudo apt-get install libpcre3 libpcre3-dev
+
+notifications:
+  irc: "irc.freenode.org#adhearsion"

data/CHANGELOG.md

@@ -0,0 +1,144 @@
+# [develop](https://github.com/benlangfeld/ruby_speech)
+
+# [2.1.0](https://github.com/benlangfeld/ruby_speech/compare/v2.0.2...v2.1.0) - [2013-05-07](https://rubygems.org/gems/ruby_speech/versions/2.1.0)
+  * Feature: Support for SISR literal syntax
+
+# [2.0.2](https://github.com/benlangfeld/ruby_speech/compare/v2.0.1...v2.0.2) - [2013-05-01](https://rubygems.org/gems/ruby_speech/versions/2.0.2)
+  * Bugfix: Differentiate between GRXML match cases with are and are not maximal
+    * A Match can accept further input while still matching, while a a MaxMatch cannot.
+    * Matching implementation moved down to C/Java to avoid repeated regex compilation and confusing jumping about.
+  * Bugfix: Back to functioning on JRuby with latest Nokogiri release
+
+# [2.0.1](https://github.com/benlangfeld/ruby_speech/compare/v2.0.0...v2.0.1) - [2013-04-27](https://rubygems.org/gems/ruby_speech/versions/2.0.1)
+  * Bugfix: Build native C extension in the correct location
+
+# [2.0.0](https://github.com/benlangfeld/ruby_speech/compare/v1.1.0...v2.0.0) - [2013-04-27](https://rubygems.org/gems/ruby_speech/versions/2.0.0)
+  * Change: Comply with MRCPv2 flavour of NLSML
+    * Confidence is now a float in the XML representation
+    * Models are no longer used
+    * XForms no longer used
+    * Now have a true namespace
+    * Instance is in the NLSML namespace
+    * Must support string instances
+  * Change: Grammar matching now uses a Matcher rather than directly on the Grammar element
+  * Feature: Grammar matching now uses native C/Java regexes with PCRE/java.util.regex for clean partial matching and SPEEEEEED
+  * Bugfix: Item repeats now work correctly
+
+# [1.1.0](https://github.com/benlangfeld/ruby_speech/compare/v1.0.2...v1.1.0) - [2013-03-02](https://rubygems.org/gems/ruby_speech/versions/1.1.0)
+  * Feature: NLSML building & parsing
+
+# [1.0.2](https://github.com/benlangfeld/ruby_speech/compare/v1.0.1...v1.0.2) - [2012-12-26](https://rubygems.org/gems/ruby_speech/versions/1.0.2)
+  * Bugfix: Get test suite passing on JRuby
+
+# [1.0.1](https://github.com/benlangfeld/ruby_speech/compare/v1.0.0...v1.0.1) - [2012-10-24](https://rubygems.org/gems/ruby_speech/versions/1.0.1)
+  * Bugfix: Don't load rubygems because it is evil
+  * Bugfix: Allow setting language (and other) attributes on root of SSML doc when using #draw DSL
+
+# 1.0.0 - 2012-03-13
+  * Bump major version because we have a stable API
+
+# 0.5.1 - 2012-01-09
+  * Feature: Chaining child injection using #<< now works
+  * Feature: Reading the repeat value for a GRXML Item now returns an Integer or a Range, rather than the plain string
+  * Feature: Most simple GRXML grammars now return PotentialMatch when the provided input is valid but incomplete. This does not work for complex grammars including repeats and deep nesting. Fixes for these coming soon.
+
+# 0.5.0 - 2012-01-03
+  * Feature: Add a whole bunch more SSML elements:
+    * p & s
+    * mark
+    * desc
+    * sub
+    * phoneme
+  * Feature: Added the ability to inline grammar rule references in both destructive and non-destructive modes
+  * Feature: Added the ability to tokenize a grammar, turning all tokens into unambiguous `<token/>` elements
+  * Feature: Added the ability to whitespace normalize a grammar
+  * Feature: Added the ability to match an input string against a Grammar
+  * Feature: Constructing a GRXML grammar with a root rule specified but not provided will raise an exception
+  * Feature: Embedding a GRXML grammar of a mode different from the host will raise an exception
+  * Bugfix: Fix upward traversal through a document via #parent
+
+# 0.4.0 - 2011-12-30
+  * Feature: Add the ability to look up child elements by name/attributes easily
+  * Feature: Allow easy access to a GRXML grammar's root rule element
+  * Feature: Allow inlining a Grammar's rulerefs
+  * Bugfix: Ruby 1.8 and JRuby don't do a tree-search for const_defined?
+  * Bugfix: Don't try to pass a method call up to the DSL block binding if it doesn't respond to the method either
+
+# 0.3.4
+  * Eager-autoload all elements so that importing will work with elements that havn't been used yet directly
+  * Allow using the DSL with method calls out of the block
+  * Fix inspection/comparison of some elements that don't have a language attribute
+
+# 0.3.3
+  * Allow `SSML::Element.import` and `GRXML::Element.import` to take a string as well as a Nokogiri::XML::Node
+  * Allow importing GRXML/SSML documents via their respective modules (eg `RubySpeech::GRXML.import '<grammar ... />'`)
+
+# 0.3.2
+  * Fix inheriting an `SSML::Speak`'s language. Previously an imported `<speak/>` would end up with a `lang` attribute in addition to `xml:lang`, and `xml:lang` would have the default value (`en-US`). This required a Niceogiri dependency update.
+
+# 0.3.1
+  * Get the whole test suite passing on Ruby 1.8.7 and JRuby (thanks to Taylor Carpenter!)
+
+# 0.3.0
+  * Feature (Taylor Carpenter): Added support for GRXML documents with most elements implemented.
+
+# 0.2.2
+  * Feature: The SSML DSL now supports embedding SSML documents, elements or strings via the `embed` method. This behaves as you might expect:
+
+  ```ruby
+    doc1 = RubySpeech::SSML.draw do
+      string "Hi, I'm Fred. The time is currently "
+      say_as :interpret_as => 'date', :format => 'dmy' do
+        "01/02/1960"
+      end
+    end
+
+    doc2 = RubySpeech::SSML.draw do
+      voice :gender => :male, :name => 'fred' do
+        embed doc1
+      end
+    end
+
+    doc2.to_s
+  ```
+
+  ```xml
+    <speak xmlns="http://www.w3.org/2001/10/synthesis" version="1.0" xml:lang="en-US">
+      <voice gender="male" name="fred">
+        Hi, I'm Fred. The time is currently
+        <say-as interpret-as="date" format="dmy">
+          01/02/1960
+        </say-as>
+      </voice>
+    </speak>
+  ```
+
+# 0.2.1
+  * Bugfix: SSML element's children now include any text content, and text content is copied when importing/concatenating documents
+
+# 0.2.0
+  * API Change: SSML::SayAs.new (and the DSL method `say_as`) now take `:interpret_as` in the options hash, rather than a separate first argument. This is for consistency with the other element types.
+  * Feature: SSML elements can now be imported from a Nokogiri Node or a string
+  * Feature: SSML elements now respond to #children with an array of SSML elements, rather than a Nokogiri NodeSet
+  * Bugfix/Feature: Comparing SSML elements now compares children
+
+# 0.1.5
+  * Feature: Now added support for SSML `<audio/>`
+
+# 0.1.4
+  * Bugfix: Speak#+ now returns a brand new Speak rather than modifying the original object
+  * Bugfix: Speak#+ now re-sets the namespace on child elements to ensure no default namespace prefix is added
+
+# 0.1.3
+  * Bugfix: Strings included via the DSL (both as a block return value and by calling #string) are now properly escaped
+
+# 0.1.2
+  * API Change: SSML.draw now returns a Speak
+  * Feature: Speak objects can be turned into an XML document using #to_doc
+  * Feature: Speak objects can now be concatenated such that children are merged together
+
+# 0.1.1
+  * Bugfix: DSL now allows for nesting all allowed elements within each other
+
+# 0.1.0
+  * Initial Release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+guard 'rake', :task => 'compile' do
+  watch(%r{^ext/(.+)\.(c|java)$})
+end
+
+guard 'rspec', :cli => '--format documentation' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec/" }
+end

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ben Langfeld
+
+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/README.md

@@ -0,0 +1,314 @@
+# RubySpeech
+RubySpeech is a library for constructing and parsing Text to Speech (TTS) and Automatic Speech Recognition (ASR) documents such as [SSML](http://www.w3.org/TR/speech-synthesis), [GRXML](http://www.w3.org/TR/speech-grammar/) and [NLSML](http://www.w3.org/TR/nl-spec/). Such documents can be constructed to be processed by TTS and ASR engines, parsed as the result from such, or used in the implementation of such engines.
+
+## Installation
+    gem install ruby_speech
+
+## Library
+
+### SSML
+RubySpeech provides a DSL for constructing SSML documents like so:
+
+```ruby
+require 'ruby_speech'
+
+speak = RubySpeech::SSML.draw do
+  voice gender: :male, name: 'fred' do
+    string "Hi, I'm Fred. The time is currently "
+    say_as interpret_as: 'date', format: 'dmy' do
+      "01/02/1960"
+    end
+  end
+end
+
+speak.to_s
+```
+
+becomes:
+
+```xml
+<speak xmlns="http://www.w3.org/2001/10/synthesis" version="1.0" xml:lang="en-US">
+  <voice gender="male" name="fred">
+    Hi, I'm Fred. The time is currently <say-as format="dmy" interpret-as="date">01/02/1960</say-as>
+  </voice>
+</speak>
+```
+
+Once your `Speak` is fully prepared and you're ready to send it off for processing, you must call `to_doc` on it to add the XML header:
+
+```xml
+<?xml version="1.0"?>
+<speak xmlns="http://www.w3.org/2001/10/synthesis" version="1.0" xml:lang="en-US">
+  <voice gender="male" name="fred">
+    Hi, I'm Fred. The time is currently <say-as format="dmy" interpret-as="date">01/02/1960</say-as>
+  </voice>
+</speak>
+```
+
+You may also then need to call `to_s`.
+
+### GRXML
+
+Construct a GRXML (SRGS) document like this:
+
+```ruby
+require 'ruby_speech'
+
+grammy = RubySpeech::GRXML.draw mode: :dtmf, root: 'pin' do
+  rule id: 'digit' do
+    one_of do
+      ('0'..'9').map { |d| item { d } }
+    end
+  end
+
+  rule id: 'pin', scope: 'public' do
+    one_of do
+      item do
+        item repeat: '4' do
+          ruleref uri: '#digit'
+        end
+        "#"
+      end
+      item do
+        "* 9"
+      end
+    end
+  end
+end
+
+grammy.to_s
+```
+
+which becomes
+
+```xml
+<grammar xmlns="http://www.w3.org/2001/06/grammar" version="1.0" xml:lang="en-US" mode="dtmf" root="pin">
+  <rule id="digit">
+    <one-of>
+      <item>0</item>
+      <item>1</item>
+      <item>2</item>
+      <item>3</item>
+      <item>4</item>
+      <item>5</item>
+      <item>6</item>
+      <item>7</item>
+      <item>8</item>
+      <item>9</item>
+    </one-of>
+  </rule>
+  <rule id="pin" scope="public">
+    <one-of>
+      <item><item repeat="4"><ruleref uri="#digit"/></item>#</item>
+      <item>* 9</item>
+    </one-of>
+  </rule>
+</grammar>
+```
+
+#### Grammar matching
+
+It is possible to match some arbitrary input against a GRXML grammar, like so:
+
+```ruby
+require 'ruby_speech'
+
+>> grammar = RubySpeech::GRXML.draw mode: :dtmf, root: 'pin' do
+  rule id: 'digit' do
+    one_of do
+      ('0'..'9').map { |d| item { d } }
+    end
+  end
+
+  rule id: 'pin', scope: 'public' do
+    one_of do
+      item do
+        item repeat: '4' do
+          ruleref uri: '#digit'
+        end
+        "#"
+      end
+      item do
+        "* 9"
+      end
+    end
+  end
+end
+
+matcher = RubySpeech::GRXML::Matcher.new grammar
+
+>> matcher.match '*9'
+=> #<RubySpeech::GRXML::Match:0x00000100ae5d98
+      @mode = :dtmf,
+      @confidence = 1,
+      @utterance = "*9",
+      @interpretation = "*9"
+    >
+>> matcher.match '1234#'
+=> #<RubySpeech::GRXML::Match:0x00000100b7e020
+      @mode = :dtmf,
+      @confidence = 1,
+      @utterance = "1234#",
+      @interpretation = "1234#"
+    >
+>> matcher.match '5678#'
+=> #<RubySpeech::GRXML::Match:0x00000101218688
+      @mode = :dtmf,
+      @confidence = 1,
+      @utterance = "5678#",
+      @interpretation = "5678#"
+    >
+>> matcher.match '1111#'
+=> #<RubySpeech::GRXML::Match:0x000001012f69d8
+      @mode = :dtmf,
+      @confidence = 1,
+      @utterance = "1111#",
+      @interpretation = "1111#"
+    >
+>> matcher.match '111'
+=> #<RubySpeech::GRXML::NoMatch:0x00000101371660>
+```
+
+### NLSML
+
+[Natural Language Semantics Markup Language](http://tools.ietf.org/html/draft-ietf-speechsc-mrcpv2-27#section-6.3.1) is the format used by many Speech Recognition engines and natural language processors to add semantic information to human language. RubySpeech is capable of generating and parsing such documents.
+
+It is possible to generate an NLSML document like so:
+
+```ruby
+require 'ruby_speech'
+
+nlsml = RubySpeech::NLSML.draw grammar: 'http://flight' do
+  interpretation confidence: 0.6 do
+    input "I want to go to Pittsburgh", mode: :speech
+
+    instance do
+      airline do
+        to_city 'Pittsburgh'
+      end
+    end
+  end
+
+  interpretation confidence: 0.4 do
+    input "I want to go to Stockholm"
+
+    instance do
+      airline do
+        to_city "Stockholm"
+      end
+    end
+  end
+end
+
+nlsml.to_s
+```
+
+becomes:
+
+```xml
+<?xml version="1.0"?>
+<result xmlns="http://www.ietf.org/xml/ns/mrcpv2" grammar="http://flight">
+  <interpretation confidence="0.6">
+    <input mode="speech">I want to go to Pittsburgh</input>
+    <instance>
+      <airline>
+        <to_city>Pittsburgh</to_city>
+      </airline>
+    </instance>
+  </interpretation>
+  <interpretation confidence="0.4">
+    <input>I want to go to Stockholm</input>
+    <instance>
+      <airline>
+        <to_city>Stockholm</to_city>
+      </airline>
+    </instance>
+  </interpretation>
+</result>
+```
+
+It's also possible to parse an NLSML document and extract useful information from it. Taking the above example, one may do:
+
+```ruby
+document = RubySpeech.parse nlsml.to_s
+
+document.match? # => true
+document.interpretations # => [
+      {
+        confidence: 0.6,
+        input: { mode: :speech, content: 'I want to go to Pittsburgh' },
+        instance: { airline: { to_city: 'Pittsburgh' } }
+      },
+      {
+        confidence: 0.4,
+        input: { content: 'I want to go to Stockholm' },
+        instance: { airline: { to_city: 'Stockholm' } }
+      }
+    ]
+document.best_interpretation # => {
+          confidence: 0.6,
+          input: { mode: :speech, content: 'I want to go to Pittsburgh' },
+          instance: { airline: { to_city: 'Pittsburgh' } }
+        }
+```
+
+Check out the [YARD documentation](http://rdoc.info/github/benlangfeld/ruby_speech/master/frames) for more
+
+## Features:
+### SSML
+* Document construction
+* `<voice/>`
+* `<prosody/>`
+* `<emphasis/>`
+* `<say-as/>`
+* `<break/>`
+* `<audio/>`
+* `<p/>` and `<s/>`
+* `<phoneme/>`
+* `<sub/>`
+
+#### Misc
+* `<mark/>`
+* `<desc/>`
+
+### GRXML
+* Document construction
+* `<item/>`
+* `<one-of/>`
+* `<rule/>`
+* `<ruleref/>`
+* `<tag/>`
+* `<token/>`
+
+### NLSML
+* Document construction
+* Simple data extraction from documents
+
+## TODO:
+### SSML
+* `<lexicon/>`
+* `<meta/>` and `<metadata/>`
+
+### GRXML
+* `<meta/>` and `<metadata/>`
+* `<example/>`
+* `<lexicon/>`
+
+## Links:
+* [Source](https://github.com/benlangfeld/ruby_speech)
+* [Documentation](http://rdoc.info/gems/ruby_speech/frames)
+* [Bug Tracker](https://github.com/benlangfeld/ruby_speech/issues)
+* [CI](https://travis-ci.org/#!/benlangfeld/ruby_speech)
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  * If you want to have your own version, that is fine but bump version in a commit by itself so I can ignore when I pull
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2013 Ben Langfeld. MIT licence (see LICENSE for details).

data/Rakefile

@@ -0,0 +1,34 @@
+require 'bundler/gem_tasks'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+require 'ci/reporter/rake/rspec'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = '--color'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  spec.rspec_opts = '--color'
+end
+
+task :default => [:compile, :spec]
+task :ci => ['ci:setup:rspec', :compile, :spec]
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+if RUBY_PLATFORM =~ /java/
+  require 'rake/javaextensiontask'
+  Rake::JavaExtensionTask.new 'ruby_speech' do |ext|
+    ext.lib_dir = 'lib/ruby_speech'
+  end
+else
+  require 'rake/extensiontask'
+  Rake::ExtensionTask.new 'ruby_speech' do |ext|
+    ext.lib_dir = 'lib/ruby_speech'
+  end
+end