jsgf 0.4.1 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae316ae11c63ab1272f04970e188ac162df75dd5
-  data.tar.gz: 4e960c23772bc117c4b7955144b72eeffc2ac3b5
+  metadata.gz: dc08df8d2819a5f14a5c0a037dc0cf1b6c337e0b
+  data.tar.gz: d605f5c4211fce201299b52fb824e90d7148034e
 SHA512:
-  metadata.gz: 42d12240171fd99346507d7850f73e880c321337bf50d421cf4411e5a1d300badc2c4459491fcacc2c97716f739616488bb74c4c95a79912bae51dbfa3617536
-  data.tar.gz: 4e34672b1e1cd91993f55d069270e692fddb16590610934cce1136b04c9c10b21c77c369afb55269802b547d5e562e5cc7c36a305d9678803468e5221b7c014e
+  metadata.gz: 09e2f534bf4bfeff71a197b21b83f816b7311a8c2242f7815bf3e5ace6ae158da5ec95af03c5a8995aceb53c3440e8275d3a3531ae8295d1159c6aa3eefada3d
+  data.tar.gz: d90cf4b5c10039c20282d533393ffb2e9eb8e138a4c8cb98bb6c5b4e08f9e29642b133cd1cd24f1ced87b08da44fda4a3cbb88e4db4c90ac8f188f73ec7b1e40

data/README.md

@@ -3,6 +3,7 @@ JSGF
 
 [![Build Status](https://travis-ci.org/bfoz/jsgf-ruby.png)](https://travis-ci.org/bfoz/jsgf-ruby)
 [![Gem Version](https://badge.fury.io/rb/jsgf.svg)](http://badge.fury.io/rb/jsgf)
+[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg?style=flat)](http://www.rubydoc.info/gems/jsgf/frames)
 
 For all of your [Java Speech Grammar Format](http://www.w3.org/TR/jsgf/) parsing needs.
 
@@ -37,7 +38,7 @@ The JSGF gem includes a simple DSL for generating new grammars. The syntax follo
 the [JSGF](http://www.w3.org/TR/jsgf/) syntax, but with a few differences.
 
 - Rule names can be either Symbols or Strings (they're converted to Strings internally)
-- Rules can be referenced using symbols in addition to the angle-bracket syntax used by JSGF.
+- Rules can be referenced using symbols in addition to the angle-bracket syntax used by JSGF
 - Alternations are created using arrays
 - Rules are private by default, however the root rules are automatically made public
 
@@ -51,6 +52,15 @@ grammar = JSGF.grammar 'Turtle' do
 end
 ```
 
+Atoms can be made optional using the JSGF square-bracket syntax...
+
+```ruby
+grammar = JSGF.grammar 'PoliteTurtle' do
+    rule move: '[please] go :direction :distance'
+    ...
+end
+```
+
 Installation
 ------------
 
@@ -71,4 +81,4 @@ Or install it yourself as:
 License
 -------
 
-Copyright 2015 Brandon Fosdick <bfoz@bfoz.net> and released under the BSD license.
+Copyright 2015-2016 Brandon Fosdick <bfoz@bfoz.net> and released under the BSD license.

data/jsgf.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
     spec.name          = "jsgf"
-    spec.version       = '0.4.1'
+    spec.version       = '0.5'
     spec.authors       = ["Brandon Fosdick"]
     spec.email         = ["bfoz@bfoz.net"]
     spec.summary       = %q{Java Speech Grammar Format}

data/lib/jsgf/alternation.rb

@@ -5,14 +5,19 @@ module JSGF
 	include Enumerable
 
 	attr_reader :elements
+
+	# @!attribute
+	#   @return [Bool]  Sometimes an {Alternation} is optional
 	attr_accessor :optional
+	alias optional? optional
+
 	attr_reader :tags
 
 	def initialize(*args)
 	    @elements = args.map do |a|
 		case a
 		    when String then Rule.parse_atom(a)
-		    when Symbol then {name:a.to_s, weight:1.0, tags:[]}
+		    when Symbol then JSGF::Atom.new(a.to_s, reference:true)
 		    else
 			a
 		end

data/lib/jsgf/atom.rb

@@ -4,6 +4,16 @@ module JSGF
 	#   @return [String]  the atom of the {Atom}
 	attr_accessor :atom
 
+	# @!attribute
+	#   @return [Bool]  Sometimes an {Atom} is optional
+	attr_accessor :optional
+	alias optional? optional
+
+	# @!attribute reference
+	#   @return [Bool]  The {Atom} is a reference to a {Rule}
+	attr_accessor :reference
+	alias reference? reference
+
 	# @!attribute weight
 	#   @return [Number]  the {Atom}'s weight, when part of an {Alternation}. Defaults to 1.0.
 	attr_accessor :weight
@@ -15,8 +25,10 @@ module JSGF
 	# @param atom	[String]    the atom of the {Atom}
 	# @param weight	[Number]    the weight to be used when part of an {Alternation}. Valid values are 0..1.0.
 	# @param tags	[Array]	    any tags to be stored with the {Atom}
-	def initialize(atom, *tags, weight:nil)
+	def initialize(atom, *tags, weight:nil, optional:nil, reference:nil)
 	    @atom = atom
+	    @optional = optional
+	    @reference = reference
 	    @tags = tags
 	    @weight = (weight && (weight != 1.0)) ? weight : nil
 	end
@@ -28,7 +40,9 @@ module JSGF
 
 	# Stringify in a manner suitable for output to a JSGF file
 	def to_s
-	    [(weight && (weight != 1.0)) ? "/#{weight}/" : nil, atom, *tags].compact.join(' ')
+	    s = [(weight && (weight != 1.0)) ? "/#{weight}/" : nil, reference? ? '<'+atom+'>' : atom, *tags].compact.join(' ')
+	    s = '[' + s + ']' if optional?
+	    s
 	end
     end
 end

data/lib/jsgf/builder.rb

@@ -38,9 +38,33 @@ module JSGF
 	    options.each do |name, v|
 		@rules[name.to_s] = case v
 		    when Array	then Rule.new [Alternation.new(*v)]
-		    when Symbol	then Rule.new [{name:v.to_s, weight:1.0, tags:[]}]
+		    when Symbol	then Rule.new [Rule.parse_atom(v.to_s).tap {|a| a.reference=true}]
 		    else
-			v.split(' ').map {|a| Rule.parse_atom(a) }
+			stack = nil
+			v.split(' ').map do |a|
+			    if stack
+				if a == ']'
+				    next if stack.empty?
+
+				    if stack.length == 1
+					stack.first.optional = true
+					stack.first
+				    else
+					Optional.new(*stack)
+				    end.tap do
+					stack = nil
+				    end
+				else
+				    stack.push(Rule.parse_atom(a))
+				    next
+				end
+			    elsif a == '['
+				stack = []
+				next
+			    else
+				Rule.parse_atom(a)
+			    end
+			end.compact
 		end
 	    end
 	end

data/lib/jsgf/grammar.rb

@@ -27,11 +27,9 @@ module JSGF
 	    case rule
 		when Alternation, Array, Optional
 		    rule.flat_map {|a| find_rule_names(a) }
-		when Atom then []
-		when Hash
-		    rule[:name]
+		when Atom then rule.reference ? rule.atom : []
 		else
-		    raise StandardError, "Unkown atom #{rule.class}"
+		    raise StandardError, "Unkown atom #{rule.class}: #{rule}"
 	    end
 	end
 

data/lib/jsgf/parser.rb

@@ -55,7 +55,7 @@ def define_rule(name, visibility=:private, *args)
 end
 
 def rule_reference(name)
-    {name:name, weight:1.0, tags:[]}
+    JSGF::Atom.new(name, reference:true)
 end
 
 def next_token

data/lib/jsgf/rule.rb

@@ -2,11 +2,13 @@ module JSGF
     class Rule < Array
 	# Convert a string containing a single atom into an {Atom} or a rule reference
 	# @param atom	[String]	the text to parse
-	def self.parse_atom(atom)
+	def self.parse_atom(atom, optional:nil)
 	    case atom
-		when /\<(.*)\>/, /:(.*)/ then {name:$1, weight:1.0, tags:[]}
+		# Parse optionals first to prevent the reference-regex from grabbing it first
+		when /\[(.*)\]/		    then parse_atom($1, optional:true)
+		when /\<(.*)\>/, /:(.*)/    then Atom.new($1, optional:optional, reference:true)
 		else
-		    Atom.new(atom)
+		    Atom.new(atom, optional:optional)
 	    end
 	end
     end

data/test/jsgf/builder.rb

@@ -20,13 +20,13 @@ describe JSGF::Builder do
 	end
 
 	grammar.rules.size.must_equal 1
-	grammar.rules['rule1'].must_equal [Atom.new('one')]
+	grammar.rules['rule1'].must_equal [JSGF::Atom.new('one')]
     end
 
     it 'must build a multi-atom rule' do
 	grammar = JSGF::Builder.build {rule rule1: 'one two' }
 	grammar.rules.size.must_equal 1
-	grammar.rules['rule1'].must_equal [Atom.new('one'), Atom.new('two')]
+	grammar.rules['rule1'].must_equal [JSGF::Atom.new('one'), JSGF::Atom.new('two')]
     end
 
     it 'must build a rule with a rule reference as a Symbol' do
@@ -36,7 +36,7 @@ describe JSGF::Builder do
 	end
 
 	grammar.rules.size.must_equal 2
-	grammar.rules['rule1'].must_equal [{name:'one', weight:1.0, tags:[]}]
+	grammar.rules['rule1'].must_equal [JSGF::Atom.new('one', reference:true)]
     end
 
     it 'must build a rule with a JSGF-style rule reference embedded in a string' do
@@ -46,7 +46,7 @@ describe JSGF::Builder do
 	end
 
 	grammar.rules.size.must_equal 2
-	grammar.rules['rule1'].must_equal [{name:'one', weight:1.0, tags:[]}]
+	grammar.rules['rule1'].must_equal [JSGF::Atom.new('one', reference:true)]
     end
 
     it 'must build a rule with a rule reference symbol embedded in a string' do
@@ -56,7 +56,7 @@ describe JSGF::Builder do
 	end
 
 	grammar.rules.size.must_equal 2
-	grammar.rules['rule1'].must_equal [{name:'one', weight:1.0, tags:[]}]
+	grammar.rules['rule1'].must_equal [JSGF::Atom.new('one', reference:true)]
     end
 
     describe 'alternation' do
@@ -66,7 +66,7 @@ describe JSGF::Builder do
 	    end
 	    grammar.rules.size.must_equal 1
 	    grammar.rules['rule1'].first.must_be_kind_of JSGF::Alternation
-	    grammar.rules['rule1'].first.elements.must_equal [Atom.new('one'), Atom.new('two')]
+	    grammar.rules['rule1'].first.elements.must_equal [JSGF::Atom.new('one'), JSGF::Atom.new('two')]
 	end
 
 	it 'must build an alternation from an array of rule reference symbols' do
@@ -78,7 +78,7 @@ describe JSGF::Builder do
 
 	    grammar.rules.size.must_equal 3
 	    grammar.rules['rule1'].first.must_be_kind_of JSGF::Alternation
-	    grammar.rules['rule1'].first.elements.must_equal [{name:'one', weight:1.0, tags:[]}, {name:'two', weight:1.0, tags:[]}]
+	    grammar.rules['rule1'].first.elements.must_equal [JSGF::Atom.new('one', reference:true), JSGF::Atom.new('two', reference:true)]
 	end
 
 	it 'must build an alternation from an array of strings containing embedded rule reference symbols' do
@@ -90,7 +90,7 @@ describe JSGF::Builder do
 
 	    grammar.rules.size.must_equal 3
 	    grammar.rules['rule1'].first.must_be_kind_of JSGF::Alternation
-	    grammar.rules['rule1'].first.elements.must_equal [{name:'one', weight:1.0, tags:[]}, {name:'two', weight:1.0, tags:[]}]
+	    grammar.rules['rule1'].first.elements.must_equal [JSGF::Atom.new('one', reference:true), JSGF::Atom.new('two', reference:true)]
 	end
 
 	it 'must build an alternation from an array of strings containing embedded JSGF-style rule reference names' do
@@ -102,7 +102,113 @@ describe JSGF::Builder do
 
 	    grammar.rules.size.must_equal 3
 	    grammar.rules['rule1'].first.must_be_kind_of JSGF::Alternation
-	    grammar.rules['rule1'].first.elements.must_equal [{name:'one', weight:1.0, tags:[]}, {name:'two', weight:1.0, tags:[]}]
+	    grammar.rules['rule1'].first.elements.must_equal [JSGF::Atom.new('one', reference:true), JSGF::Atom.new('two', reference:true)]
+	end
+    end
+
+    describe 'optional' do
+	it 'must parse a rule with an optional word' do
+	    grammar = JSGF::Builder.build do
+		rule rule1: "this [is] optional"
+	    end
+
+	    grammar.rules.size.must_equal 1
+	    rule = grammar.rules['rule1']
+	    rule.size.must_equal 3
+
+	    rule.first.atom.must_equal 'this'
+	    rule.first.wont_be :optional?
+
+	    rule[1].atom.must_equal 'is'
+	    rule[1].must_be :optional?
+
+	    rule.last.atom.must_equal 'optional'
+	    rule.last.wont_be :optional?
+	end
+
+	it 'must parse a rule with an optional reference' do
+	    grammar = JSGF::Builder.build do
+		rule rule1: "this [:is] optional"
+	    end
+
+	    grammar.rules.size.must_equal 1
+	    rule = grammar.rules['rule1']
+	    rule.size.must_equal 3
+
+	    rule.first.atom.must_equal 'this'
+	    rule.first.wont_be :optional?
+
+	    rule[1].atom.must_equal 'is'
+	    rule[1].must_be :optional?
+	    rule[1].must_be :reference?
+
+	    rule.last.atom.must_equal 'optional'
+	    rule.last.wont_be :optional?
+	end
+
+	it 'must parse a rule with an optional word surrounded by whitespace' do
+	    grammar = JSGF::Builder.build do
+		rule rule1: "this [ is ] optional"
+	    end
+
+	    grammar.rules.size.must_equal 1
+	    rule = grammar.rules['rule1']
+	    rule.size.must_equal 3
+	    rule.map(&:atom).must_equal ['this', 'is', 'optional']
+
+	    rule.first.wont_be :optional?
+	    rule[1].must_be :optional?
+	    rule.last.wont_be :optional?
+	end
+
+	it 'must parse a rule with an optional reference surrounded by whitespace' do
+	    grammar = JSGF::Builder.build do
+		rule rule1: "this [ :is ] optional"
+	    end
+
+	    grammar.rules.size.must_equal 1
+	    rule = grammar.rules['rule1']
+	    rule.size.must_equal 3
+	    rule.map(&:atom).must_equal ['this', 'is', 'optional']
+
+	    rule.first.wont_be :optional?
+
+	    rule[1].must_be :optional?
+	    rule[1].must_be :reference?
+
+	    rule.last.wont_be :optional?
+	end
+
+	it 'must parse a rule with an optional words surrounded by whitespace' do
+	    grammar = JSGF::Builder.build do
+		rule rule1: "this [ is optional ]"
+	    end
+
+	    grammar.rules.size.must_equal 1
+	    rule = grammar.rules['rule1']
+	    rule.size.must_equal 2
+
+	    rule.first.atom.must_equal 'this'
+	    rule.first.wont_be :optional?
+
+	    rule[1].must_be_kind_of JSGF::Optional
+	    rule[1].elements.map(&:atom).must_equal ['is', 'optional']
+	end
+
+	it 'must parse a rule with an optional references surrounded by whitespace' do
+	    grammar = JSGF::Builder.build do
+		rule rule1: "this [ :is :optional ]"
+	    end
+
+	    grammar.rules.size.must_equal 1
+	    rule = grammar.rules['rule1']
+	    rule.size.must_equal 2
+
+	    rule.first.atom.must_equal 'this'
+	    rule.first.wont_be :optional?
+
+	    rule.last.must_be_kind_of JSGF::Optional
+	    rule.last.elements.map(&:atom).must_equal ['is', 'optional']
 	end
     end
 end

data/test/jsgf/parser.rb

@@ -128,7 +128,7 @@ describe JSGF::Parser do
 	    grammar = JSGF::Parser.new('#JSGF V1.0; grammar header_grammar;<rule>=<rule1>;<rule1>=one;').parse
 	    grammar.rules.size.must_equal 2
 	    grammar.rules.keys.must_equal ['rule', 'rule1']
-	    grammar.rules['rule'].must_equal [{name:'rule1', weight:1.0, tags:[]}]
+	    grammar.rules['rule'].must_equal [JSGF::Atom.new('rule1', reference:true)]
 	    grammar.rules['rule1'].must_equal [Atom.new('one')]
 	end
 
@@ -139,7 +139,7 @@ describe JSGF::Parser do
 
 	    grammar.rules['rule'].size.must_equal 1
 	    grammar.rules['rule'].first.must_be_kind_of JSGF::Alternation
-	    grammar.rules['rule'].first.elements.must_equal [{name:'rule1', weight:0.5, tags:[]}, Atom.new('two', weight:0.5)]
+	    grammar.rules['rule'].first.elements.must_equal [JSGF::Atom.new('rule1', weight:0.5, reference:true), Atom.new('two', weight:0.5)]
 
 	    grammar.rules['rule1'].must_equal [Atom.new('one')]
 	end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: jsgf
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: '0.5'
 platform: ruby
 authors:
 - Brandon Fosdick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-05 00:00:00.000000000 Z
+date: 2016-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
 - !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'
 description: A parser and DSL for JSGF files
@@ -45,8 +45,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -78,17 +78,17 @@ 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.4.5
+rubygems_version: 2.4.3
 signing_key: 
 specification_version: 4
 summary: Java Speech Grammar Format