srgs 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 390a6193c41c0b64138ec62e9398d204b92fd56f
-  data.tar.gz: 82d27e46aaafceae8313531e052c747dfc1e1825
+  metadata.gz: 36ca218a8938ba13a38b4582a2fa757635d07ff4
+  data.tar.gz: 63925ebfa4aaa9697b61a165c4fc9abf1e774207
 SHA512:
-  metadata.gz: 2815041a09db82312bb0284c31fef3ae0380d4a367333adaa5bf6c52c664c9dae83a23898decf84d65601a3edc32c0d706af4e5e2ab663070f62ecfc4d31cb62
-  data.tar.gz: e2ed6e86daef6652ba3c29485cbd353b9ef747dca3ec2dd1de30edab23e4391aa70a060af02321b9a574d55deb045d5df1702721778552b96724df3e3eeba906
+  metadata.gz: 2b399f5f039aed7127c50f50f239240e80d731ddbc9de36d9fa18fe2c5361bcef39b1b948432e95f16c21f9bedb2f8fdb35ed5d192721b75c1da6e2f5cd35597
+  data.tar.gz: aeb17f9b4c653d77f0976dcf6aeda9df9a3190b06f780d3c19ea7abfdf839c39ccd4685669ce3be544d420b3a752cf935d0043a5685f3c174eda3ad5895d2a0c

data/README.md

@@ -20,62 +20,59 @@ 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(v=office.14).aspx) is a good
+[This](http://msdn.microsoft.com/en-us/library/hh361653.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)
+module WeatherGrammar
+  include Srgs::DSL
+
+  extend self
+
+  grammar 'topLevel' do
+    private_rule 'riseset' do
+      one_of do
+        item 'rise'
+        item 'set'
+      end
+    end
+
+    private_rule 'days' do
+      one_of do
+        item 'today'
+        item 'tomorrow'
+        item 'currently'
+      end
+    end
+
+    public_rule 'weather' do
+      item 'Mycroft what is the weather'
+      reference 'days'
+      tag 'out.day=rules.days;'
+    end
+
+    public_rule 'days' do
+      item 'Mycroft when is sun'
+      reference 'riseset'
+      tag 'out.rise_or_set=rules.riseset;'
+      reference 'days'
+      tag 'out.day=rules.days;'
+    end
+
+    public_rule 'topLevel' do
+      one_of do
+        reference_item 'weather'
+        reference_item 'days'
+      end
+    end
+  end
+end
 ```
 
+Running that will print to console the corresponding xml.
+
 ## Contributing
 
 1. Fork it

data/lib/srgs/dsl.rb

@@ -0,0 +1,70 @@
+module Srgs
+  module DSL
+    @grammer = nil
+    def example(text)
+      @grammar.current_level << Example.new(text)
+    end
+
+    def grammar(root, &block)
+      @grammar = Grammar.new 'root'
+      instance_eval &block
+      @grammar.current_level = nil
+      puts Srgs.build(@grammar)
+    end
+
+    def item(element = '', tag=nil, repeat=nil, repeat_prob = nil, weight = nil, &block)
+      item = Item.new(element, tag, repeat, repeat_prob, weight)
+      @grammar.current_level << item
+      old_current = @grammar.current_level
+      @grammar.current_level = item
+      instance_eval &block unless block.nil?
+      @grammar.current_level = old_current
+    end
+
+    def lexicon(uri, type=nil)
+      @grammar << Lexicon.new(uri, type)
+    end
+
+    def meta(content, name = nil, http_equiv = nil)
+      @grammar << Meta.new(content, name, http_equiv)
+    end
+
+    def one_of(&block)
+      old_current = @grammar.current_level
+      @grammar.current_level = OneOf.new
+      old_current << @grammar.current_level
+      instance_eval &block
+      @grammar.current_level = old_current
+    end
+
+    def public_rule(id, dynamic= nil,  &block)
+      @grammar.current_level = Rule.new(id, 'public', 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)
+      @grammar << @grammar.current_level
+      instance_eval &block
+      @grammar.current_level = nil
+    end
+
+    def reference(name, special=nil)
+      @grammar.current_level << RuleRef.new(name, special)
+    end
+
+    def reference_item(name, special=nil)
+      @grammar.current_level << Item.new(RuleRef.new(name, 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)
+    end
+  end
+end

data/lib/srgs/elements/grammar.rb

@@ -1,13 +1,14 @@
 module Srgs
   class Grammar
 
-    attr_accessor :root, :lexicon, :rules, :metas
+    attr_accessor :root, :lexicon, :rules, :metas, :current_level
 
     def initialize(root = '')
       @root = root
       @lexicon = nil
       @metas = Array.new
       @rules = Array.new
+      @current_level = nil
     end
 
     def <<(element)

data/lib/srgs/elements/item.rb

@@ -11,5 +11,11 @@ module Srgs
       @weight = weight
     end
 
+    def <<(element)
+      @tag = element if element.is_a? Tag
+      @element = element if(element.is_a? Token or element.is_a? String)
+      self
+    end
+
   end
 end

data/lib/srgs/elements/rule_ref.rb

@@ -4,7 +4,7 @@ module Srgs
     attr_accessor :uri, :special
 
     def initialize(rule, special=nil)
-      @uri = "##{rule.id}"
+      @uri = "##{rule}"
       @special =special
     end
 

data/lib/srgs/grammar_builder.rb

@@ -102,8 +102,8 @@ module Srgs
 
   def token(token, xml)
     att = {}
-    att(:'sapi:display', att, token.display)
-    att(:'sapi:pron', att, token.pron)
+    set(:'sapi:display', att, token.display)
+    set(:'sapi:pron', att, token.pron)
     xml.token(token.text, att)
   end
 

data/lib/srgs/version.rb

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

data/lib/srgs.rb

@@ -11,6 +11,7 @@ require 'srgs/elements/rule_ref'
 require 'srgs/elements/tag'
 require 'srgs/elements/token'
 require 'srgs/grammar_builder'
+require 'srgs/dsl'
 
 module Srgs
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: srgs
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - kristenmills
@@ -65,6 +65,7 @@ files:
 - README.md
 - Rakefile
 - lib/srgs.rb
+- lib/srgs/dsl.rb
 - lib/srgs/elements/example.rb
 - lib/srgs/elements/grammar.rb
 - lib/srgs/elements/item.rb