srgs 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 11427469daf0138bcee8940476817a59795e94b4
-  data.tar.gz: 2dee9400e173605943be165458fff749b02df6c5
+  metadata.gz: 78d562ce8bb4d8ecf263c1c97ff74e3149e4ba2f
+  data.tar.gz: 58826d3300604e031ab6dce87a589948abd3812b
 SHA512:
-  metadata.gz: 66e55b92d117c7b46cb722b0f373b6828e7adcad1132a7df7f69e3bc3acb29d7ed0866e07443def4ec746a95da0d0dadb46ab9a6d2dde88c62021b22162c351f
-  data.tar.gz: 324530f3b886948a870d4907443c2ec2650a0740a2c84da23eacfd533ccf7b66c156b08a14aae6c88f033cbeaeb96538b094edc4c0c4cdac9e785f4abc31a17b
+  metadata.gz: 4b69a52d2570830a940305af7af4db007205c1deca27ff0189d081d09328c53117bad69c9837363093b38ca3c87870d352f000d93aa4a1cc3f03e48f97653171
+  data.tar.gz: 4d3719463019e41d9425913970757e65c2513ae9a400efedccce1372c3e40b71c47f388559809c7ac2f5c5a7689609299261563453a46fd30e53f14171363a31

data/README.md

@@ -20,9 +20,6 @@ Or install it yourself as:
 
 Here's an example file. It will be documented better later
 
-[This](http://msdn.microsoft.com/en-us/library/hh361653.aspx) is a good
-reference on how srgs grammars work.
-
 ```ruby
 require 'srgs'
 
@@ -53,7 +50,7 @@ module WeatherGrammar
       tag 'out.day=rules.days;'
     end
 
-    public_rule 'days' do
+    public_rule 'sun' do
       item 'Mycroft when is sun'
       reference 'riseset'
       tag 'out.rise_or_set=rules.riseset;'
@@ -64,7 +61,7 @@ module WeatherGrammar
     public_rule 'topLevel' do
       one_of do
         reference_item 'weather'
-        reference_item 'days'
+        reference_item 'sun'
       end
     end
   end
@@ -72,6 +69,51 @@ end
 ```
 
 Running that will print to console the corresponding xml.
+```xml
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://www.w3.org/2001/06/grammar" xml:lang="en-US" root="toplevel" tag-format="semantics/1.0" version="1.0">
+   <rule id="toplevel">
+      <one-of>
+         <item>
+            <ruleref uri="#weather" />
+         </item>
+         <item>
+            <ruleref uri="#sun" />
+         </item>
+      </one-of>
+   </rule>
+   <rule id="weather" scope="public">
+      <item>Mycroft what is the weather</item>
+      <ruleref uri="#days" />
+      <tag>out.day=rules.days;</tag>
+   </rule>
+   <rule id="sun" scope="public">
+      <item>Mycroft When is sun</item>
+      <ruleref uri="#riseset" />
+      <tag>out.rise_or_set=rules.riseset;</tag>
+      <ruleref uri="#days" />
+      <tag>out.day=rules.days;</tag>
+   </rule>
+   <rule id="days" scope="private">
+      <one-of>
+         <item>today</item>
+         <item>tomorrow</item>
+         <item>currently</item>
+      </one-of>
+   </rule>
+   <rule id="riseset" scope="private">
+      <one-of>
+         <item>rise</item>
+         <item>set</item>
+      </one-of>
+   </rule>
+</grammar>
+```
+
+## References
+
+* [Speech Recognition Grammar Specification Version 1.0](http://www.w3.org/TR/speech-grammar/#S4.13)
+* [SRGS Grammar XML Reference](http://msdn.microsoft.com/en-us/library/hh361653.aspx)
 
 ## Contributing
 

data/lib/srgs/dsl.rb

@@ -9,11 +9,13 @@ module Srgs
       @grammar = Grammar.new root
       instance_eval &block
       @grammar.current_level = nil
-      puts Srgs.build(@grammar)
+      grammar =  Srgs.build(@grammar)
+      puts grammar
+      grammar
     end
 
-    def item(element = '', tag=nil, repeat=nil, repeat_prob = nil, weight = nil, &block)
-      item = Item.new(element, tag, repeat, repeat_prob, weight)
+    def item(element = '', args = {}, &block)
+      item = Item.new(element, args[:repeat], args[:repeat_prob], args[:weight])
       @grammar.current_level << item
       old_current = @grammar.current_level
       @grammar.current_level = item
@@ -21,12 +23,12 @@ module Srgs
       @grammar.current_level = old_current
     end
 
-    def lexicon(uri, type=nil)
-      @grammar << Lexicon.new(uri, type)
+    def lexicon(uri, args = {})
+      @grammar << Lexicon.new(uri, args[:type])
     end
 
-    def meta(content, name = nil, http_equiv = nil)
-      @grammar << Meta.new(content, name, http_equiv)
+    def meta(content, args = {})
+      @grammar << Meta.new(content, args[:name], args[:http_equiv])
     end
 
     def one_of(&block)
@@ -37,34 +39,38 @@ module Srgs
       @grammar.current_level = old_current
     end
 
-    def public_rule(id, dynamic= nil,  &block)
-      @grammar.current_level = Rule.new(id, 'public', dynamic)
+    def public_rule(id, args = {}, &block)
+      @grammar.current_level = Rule.new(id, 'public', args[:dynamic])
       @grammar << @grammar.current_level
       instance_eval &block
       @grammar.current_level = nil
     end
 
-    def private_rule(id, dynamic= nil,  &block)
-      @grammar.current_level = Rule.new(id, 'private', dynamic)
+    def private_rule(id, args = {},  &block)
+      @grammar.current_level = Rule.new(id, 'private', args[:dynamic])
       @grammar << @grammar.current_level
       instance_eval &block
       @grammar.current_level = nil
     end
 
-    def reference(name, special=nil)
-      @grammar.current_level << RuleRef.new(name, special)
+    def reference(name, args = {})
+      @grammar.current_level << RuleRef.new(name, args[:special])
     end
 
-    def reference_item(name, special=nil)
-      @grammar.current_level << Item.new(RuleRef.new(name, special))
+    def reference_item(name, args = {})
+      @grammar.current_level << Item.new(RuleRef.new(name, args[:special]))
     end
 
     def tag(text)
       @grammar.current_level << Tag.new(text)
     end
 
-    def token(text, display=nil, pron = nil)
-      @grammar.current_level << Token.new(text, display, pron)
+    def text(text)
+      @grammar.current_level << text
+    end
+
+    def token(text, args = {})
+      @grammar.current_level << Token.new(text, args[:display], args[:pron])
     end
   end
 end

data/lib/srgs/elements/item.rb

@@ -1,10 +1,10 @@
 module Srgs
   class Item
 
-    attr_accessor :element, :repeat, :repeat_prob, :weight, :tag
+    attr_accessor :elements, :repeat, :repeat_prob, :weight
 
-    def initialize(element, tag=nil, repeat=nil, repeat_prob = nil, weight = nil)
-      @element = element
+    def initialize(element = '', repeat=nil, repeat_prob = nil, weight = nil)
+      @elements = [element]
       @tag = tag
       @repeat = repeat
       @repeat_prob = repeat_prob
@@ -12,8 +12,7 @@ module Srgs
     end
 
     def <<(element)
-      @tag = element if element.is_a? Tag
-      @element = element if(element.is_a? Token or element.is_a? String)
+      @elements << element
       self
     end
 

data/lib/srgs/grammar_builder.rb

@@ -30,19 +30,20 @@ module Srgs
     set(:repeat, att, item.repeat)
     set(:'repeat-prob', att, item.repeat_prob)
     set(:weight, att, item.weight)
-    if item.element.is_a? Token
-      xml.item(att) do
-        tag(item.tag, xml) unless item.tag.nil?
-        token(item.element, xml)
-      end
-    elsif item.element.is_a? RuleRef
-      xml.item(att) do
-        tag(item.tag, xml) unless item.tag.nil?
-        rule_ref(item.element, xml)
-      end
-    else
-      xml.item(item.element, att) do
-        tag(item.tag, xml) unless item.tag.nil?
+    xml.item(att) do
+      item.elements.each do |element|
+        case element
+        when Token
+          token(element, xml)
+        when RuleRef
+          rule_ref(element, xml)
+        when Tag
+          tag(element, xml)
+        when String
+          text(element, xml)
+        else
+          raise "Can't add #{element.class} to item."
+        end
       end
     end
   end
@@ -79,16 +80,21 @@ module Srgs
     set(:'sapi:dynamic', att, rule.dynamic)
     xml.rule(att) do
       rule.elements.each do |element|
-        if element.is_a? Item
+        case element
+        when Item
           item(element, xml)
-        elsif element.is_a? RuleRef
+        when RuleRef
           rule_ref(element, xml)
-        elsif element.is_a? OneOf
+        when OneOf
           one_of(element, xml)
-        elsif element.is_a? Token
+        when Token
           token(element, xml)
-        elsif element.is_a? Tag
+        when Tag
           tag(element, xml)
+        when Example
+          example(element, xml)
+        else
+          raise "Can't add #{element.class} to item"
         end
       end
     end
@@ -104,6 +110,10 @@ module Srgs
     xml.tag tag.text
   end
 
+  def text(text, xml)
+    xml.text text
+  end
+
   def token(token, xml)
     att = {}
     set(:'sapi:display', att, token.display)
@@ -114,5 +124,4 @@ module Srgs
   def set(sym, att, value)
     att[sym] = value unless value.nil?
   end
-
-end
+end

data/lib/srgs/version.rb

@@ -1,3 +1,3 @@
 module Srgs
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: srgs
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - kristenmills
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-24 00:00:00.000000000 Z
+date: 2014-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -78,7 +78,6 @@ files:
 - lib/srgs/elements/tag.rb
 - lib/srgs/elements/token.rb
 - lib/srgs/grammar_builder.rb
-- lib/srgs/test.rb
 - lib/srgs/version.rb
 - srgs.gemspec
 homepage: https://github.com/kristenmills/srgs
@@ -106,3 +105,4 @@ signing_key:
 specification_version: 4
 summary: A gem for building SRGS/grXML documents.
 test_files: []
+has_rdoc: 

data/lib/srgs/test.rb

@@ -1,49 +0,0 @@
-require 'srgs'
-
-grammar = Srgs::Grammar.new
-
-sunriseset = Srgs::Rule.new('riseset')
-sunriseset_choices = Srgs::OneOf.new << Srgs::Item.new('rise') << Srgs::Item.new('set')
-sunriseset << sunriseset_choices
-sunriseset.scope = 'private'
-
-sunriseset_ref = Srgs::RuleRef.new(sunriseset)
-
-days = Srgs::Rule.new('days')
-days_choices = Srgs::OneOf.new << Srgs::Item.new('today') << Srgs::Item.new('tomorrow') << Srgs::Item.new('currently')
-days << days_choices
-days.scope = 'private'
-
-days_ref = Srgs::RuleRef.new(days)
-
-weather = Srgs::Rule.new('weather')
-sun = Srgs::Rule.new('sun')
-
-question1 = Srgs::Item.new("Mycroft what is the weather");
-question2 = Srgs::Item.new("Mycroft When is sun");
-
-weather << question1
-weather << days_ref
-weather << Srgs::Tag.new("out.day=rules.days;")
-weather.scope = 'public'
-
-sun << question2
-sun << sunriseset_ref
-sun << Srgs::Tag.new("out.rise_or_set=rules.riseset;")
-sun << days_ref
-sun << Srgs::Tag.new("out.day=rules.days;")
-sun.scope = 'public'
-
-top_level = Srgs::Rule.new("toplevel");
-top_level_choices = Srgs::OneOf.new
-item1 = Srgs::Item.new Srgs::RuleRef.new(weather)
-item2 = Srgs::Item.new Srgs::RuleRef.new(sun)
-top_level_choices << item1
-top_level_choices << item2
-top_level << top_level_choices
-
-grammar << top_level << weather << sun << days << sunriseset
-
-grammar.root = "toplevel"
-
-puts Srgs.build(grammar)