srgs 0.0.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 479330b95858e11b3e45f52889d103d99b43b31a
-  data.tar.gz: 0b097d07fc1b72b0a6c49fec84e5cef74facd9c7
+  metadata.gz: 390a6193c41c0b64138ec62e9398d204b92fd56f
+  data.tar.gz: 82d27e46aaafceae8313531e052c747dfc1e1825
 SHA512:
-  metadata.gz: 8c0c0c5a51828ee910f260ffef4803b37e96edfc550a2199eb3fa5a356f6ff179509728be285da512fd1817000907c516df2a9e9ec8847901634559ca8ac0f69
-  data.tar.gz: debfaa559c9b3dc78a7dee28625f7c78087e8bfe455b675f70a8c58c4071a57b6e8362c2796e48869a6fd574f9f8041eb3034a1f545d3ab4ca5faefa25927bb0
+  metadata.gz: 2815041a09db82312bb0284c31fef3ae0380d4a367333adaa5bf6c52c664c9dae83a23898decf84d65601a3edc32c0d706af4e5e2ab663070f62ecfc4d31cb62
+  data.tar.gz: e2ed6e86daef6652ba3c29485cbd353b9ef747dca3ec2dd1de30edab23e4391aa70a060af02321b9a574d55deb045d5df1702721778552b96724df3e3eeba906

data/README.md

@@ -1,12 +1,12 @@
 # SRGS
 
-TODO: Write a gem description
+A tool for building srgs documents
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'srgs_builder'
+    gem 'srgs'
 
 And then execute:
 
@@ -14,11 +14,67 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install srgs_builder
+    $ gem install srgs
 
 ## Usage
 
-TODO: Write usage instructions here
+Here's an example file. It will be documented better later
+
+[This](http://msdn.microsoft.com/en-us/library/hh361653(v=office.14).aspx) is a good
+reference on how srgs grammars work.
+
+In the future, I plan to create a dsl for this but for now this is how it works.
+```ruby
+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)
+```
 
 ## Contributing
 

data/lib/srgs/elements/example.rb

@@ -0,0 +1,11 @@
+module Srgs
+  class Example
+
+    attr_accessor :text
+
+    def initialize(text)
+      @text = text
+    end
+
+  end
+end

data/lib/srgs/elements/grammar.rb

@@ -0,0 +1,21 @@
+module Srgs
+  class Grammar
+
+    attr_accessor :root, :lexicon, :rules, :metas
+
+    def initialize(root = '')
+      @root = root
+      @lexicon = nil
+      @metas = Array.new
+      @rules = Array.new
+    end
+
+    def <<(element)
+      @rules << element if element.is_a? Rule
+      @lexicon = element if element.is_a? Lexicon
+      @metas << element if element.is_a? Meta
+      self
+    end
+
+  end
+end

data/lib/srgs/elements/item.rb

@@ -0,0 +1,15 @@
+module Srgs
+  class Item
+
+    attr_accessor :element, :repeat, :repeat_prob, :weight, :tag
+
+    def initialize(element, tag=nil, repeat=nil, repeat_prob = nil, weight = nil)
+      @element = element
+      @tag = tag
+      @repeat = repeat
+      @repeat_prob = repeat_prob
+      @weight = weight
+    end
+
+  end
+end

data/lib/srgs/elements/lexicon.rb

@@ -0,0 +1,12 @@
+module Srgs
+  class Lexicon
+
+    attr_accessor :uri, :type
+
+    def initialize(uri, type=nil)
+      @uri = uri
+      @type = type
+    end
+
+  end
+end

data/lib/srgs/elements/meta.rb

@@ -0,0 +1,12 @@
+module Srgs
+  class Meta
+
+    attr_accessor :name, :http_equiv, :content
+
+    def initialize(content, name=nil, http_equiv=nil)
+      @name = name
+      @content = content
+      @http_equiv = http_equiv
+    end
+  end
+end

data/lib/srgs/elements/metadata.rb

@@ -0,0 +1,11 @@
+module Srgs
+  class Metadata
+
+    attr_accessor :text
+
+    def initialize(text)
+      @text = text
+    end
+
+  end
+end

data/lib/srgs/elements/one_of.rb

@@ -0,0 +1,16 @@
+module Srgs
+  class OneOf
+
+    attr_accessor :items
+
+    def initialize
+      @items = Array.new
+    end
+
+    def <<(item)
+      @items << item
+      self
+    end
+
+  end
+end

data/lib/srgs/elements/rule.rb

@@ -0,0 +1,19 @@
+module Srgs
+  class Rule
+
+    attr_accessor :id, :scope, :dynamic, :elements
+
+    def initialize(id, scope = 'private', dynamic = nil)
+      @id = id
+      @elements = Array.new
+      @scope = scope
+      @dynamic = dynamic
+    end
+
+    def <<(element)
+      @elements << element
+      self
+    end
+
+  end
+end

data/lib/srgs/elements/rule_ref.rb

@@ -0,0 +1,12 @@
+module Srgs
+  class RuleRef
+
+    attr_accessor :uri, :special
+
+    def initialize(rule, special=nil)
+      @uri = "##{rule.id}"
+      @special =special
+    end
+
+  end
+end

data/lib/srgs/elements/tag.rb

@@ -0,0 +1,11 @@
+module Srgs
+  class Tag
+
+    attr_accessor :text
+
+    def initialize(text)
+      @text = text
+    end
+
+  end
+end

data/lib/srgs/elements/token.rb

@@ -0,0 +1,13 @@
+module Srgs
+  class Token
+
+    attr_accessor :text, :display, :pron
+
+    def initialize(text, display = nil, pron = nil)
+      @text = text
+      @display = display
+      @pron = pron
+    end
+
+  end
+end

data/lib/srgs/grammar_builder.rb

@@ -0,0 +1,114 @@
+require 'nokogiri'
+
+module Srgs
+  extend self
+
+  def build(grammar)
+    builder = Nokogiri::XML::Builder.new do |xml|
+      xml.grammar do
+        lexicon(grammar.lexicon, xml) unless grammar.lexicon.nil?
+        grammar.metas.each do |meta|
+          meta(meta, xml)
+        end
+        grammar.rules.each do |rule|
+          rule(rule, xml)
+        end
+      end
+    end.to_xml
+  end
+
+  def example(example, xml)
+    xml.example example.text
+  end
+
+  def item(item, xml)
+    att = {}
+    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?
+      end
+    end
+  end
+
+  def lexicon(lexicon, xml)
+    att = {uri: lexicon.uri }
+    set(:type, att, lexicon.type)
+    xml.lexicon(att)
+  end
+
+  def meta(meta, xml)
+    att = { content: meta.content }
+    set(:'http-equiv', att, meta.http_equiv)
+    set(:name, att, meta.name)
+    xml.meta(att)
+  end
+
+  def metadata(metadata, xml)
+    #TODO
+    raise "Not yet implemented"
+  end
+
+  def one_of(one_of, xml)
+    xml.send('one-of') do
+      one_of.items.each do |item|
+        item(item, xml)
+      end
+    end
+  end
+
+  def rule(rule, xml)
+    att = {id: rule.id}
+    set(:scope, att, rule.scope)
+    set(:'sapi:dynamic', att, rule.dynamic)
+    xml.rule(att) do
+      rule.elements.each do |element|
+        if element.is_a? Item
+          item(element, xml)
+        elsif element.is_a? RuleRef
+          rule_ref(element, xml)
+        elsif element.is_a? OneOf
+          one_of(element, xml)
+        elsif element.is_a? Token
+          token(element, xml)
+        elsif element.is_a? Tag
+          tag(element, xml)
+        end
+      end
+    end
+  end
+
+  def rule_ref(rule_ref, xml)
+    att = { uri: rule_ref.uri }
+    set(:special, att, rule_ref.special)
+    xml.ruleref(att)
+  end
+
+  def tag(tag, xml)
+    xml.tag tag.text
+  end
+
+  def token(token, xml)
+    att = {}
+    att(:'sapi:display', att, token.display)
+    att(:'sapi:pron', att, token.pron)
+    xml.token(token.text, att)
+  end
+
+  def set(sym, att, value)
+    att[sym] = value unless value.nil?
+  end
+
+end

data/lib/srgs/test.rb

@@ -0,0 +1,49 @@
+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)

data/lib/srgs/version.rb

@@ -1,3 +1,3 @@
 module Srgs
-  VERSION = "0.0.1"
+  VERSION = "0.5.0"
 end

data/lib/srgs.rb

@@ -1,5 +1,16 @@
-require "srgs/version"
+require 'srgs/version'
+require 'srgs/elements/grammar'
+require 'srgs/elements/item'
+require 'srgs/elements/example'
+require 'srgs/elements/lexicon'
+require 'srgs/elements/meta'
+require 'srgs/elements/metadata'
+require 'srgs/elements/one_of'
+require 'srgs/elements/rule'
+require 'srgs/elements/rule_ref'
+require 'srgs/elements/tag'
+require 'srgs/elements/token'
+require 'srgs/grammar_builder'
 
 module Srgs
-  # Your code goes here...
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: srgs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.5.0
 platform: ruby
 authors:
 - kristenmills
@@ -65,6 +65,19 @@ files:
 - README.md
 - Rakefile
 - lib/srgs.rb
+- lib/srgs/elements/example.rb
+- lib/srgs/elements/grammar.rb
+- lib/srgs/elements/item.rb
+- lib/srgs/elements/lexicon.rb
+- lib/srgs/elements/meta.rb
+- lib/srgs/elements/metadata.rb
+- lib/srgs/elements/one_of.rb
+- lib/srgs/elements/rule.rb
+- lib/srgs/elements/rule_ref.rb
+- 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