jsgf 0.2.1 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5f37d8d1978f31b192515183e6be841c83f4dc4
-  data.tar.gz: 3179b3009527599016cafec61255e4d38003f841
+  metadata.gz: a35679fd0c76d2953a7e6bf557f145e0fff63a63
+  data.tar.gz: 04a9e77a8561aa76bf73e4977933adfdec8f9f13
 SHA512:
-  metadata.gz: 17d0b2333de1dd3ee537f091b79fe4aaa44eec199528c14af461a328fbd009ee5f5976187bfc6c7a6a3d077c41d8bedaaf782760d653bec7503bd3e89196beaf
-  data.tar.gz: f9f966bd54797f0aa5e49fbe60b5ebd015d9dc9ea3f755ea2053add15a6a83fe2910a2231875309b8409a58750ce8d0d77d6142931f16984b8697cfb55f1f5b5
+  metadata.gz: 43fd8dc5e6757e7c9cc3753784e1fecda9cf4fda61049c54eeb45a0e4b48cf318d1f953ecd2b3b454be709f081ab6d61c885e73a03b24a8bcc1d7bba708563da
+  data.tar.gz: a5d9a59efb08497e731232b6554aaa9015cc8cb8fdc71b7444fdcad6c769789d34d42a2e23643edf9be9814da5dba0eca3c6b663f9e95edd8812139f3609ca6e

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.2.1'
+    spec.version       = '0.3'
     spec.authors       = ["Brandon Fosdick"]
     spec.email         = ["bfoz@bfoz.net"]
     spec.summary       = %q{Java Speech Grammar Format}

data/lib/jsgf/alternation.rb

@@ -1,5 +1,7 @@
 module JSGF
     class Alternation
+	include Enumerable
+
 	attr_reader :elements
 	attr_accessor :optional
 	attr_reader :tags
@@ -10,6 +12,12 @@ module JSGF
 	    @tags = []
 	end
 
+	# @group Enumerable
+	def each(*args, &block)
+	    elements.each(*args, &block)
+	end
+	# @endgroup
+
 	def push(*args)
 	    @elements.push *args
 	end

data/lib/jsgf/grammar.rb

@@ -8,6 +8,7 @@ module JSGF
 	attr_reader :version
 
 	def initialize(name:nil, character_encoding:nil, locale:nil, private_rules:{}, public_rules:{}, version:nil)
+	    raise ArgumentError, "Grammar requires a name" unless name
 	    @character_encoding = character_encoding
 	    @locale = locale
 	    @grammar_name = name
@@ -16,12 +17,30 @@ module JSGF
 	    @version = version
 	end
 
+	# @!attribute roots
+	#   @return [Hash]  the set of public rules that comprise the roots of the {Grammar} tree
+	def roots
+	    # Descend through the public rule trees to see if they reference each other
+	    root_rules = public_rules.dup
+	    public_rules.each do |(name, rule)|
+		names = find_rule_names(rule).compact
+		root_rules.delete_if {|k,v| names.include?(k)}
+	    end
+	    root_rules.empty? ? nil : root_rules
+	end
+
 	# @!attribute rules
 	#   @return [Hash]  Returns a {Hash} of the public and private rules, keyed by rule name
 	def rules
 	    @public_rules.merge(@private_rules)
 	end
 
+	# @!attribute version
+	#   @return [String]  the JSGF specification version
+	def version
+	    @version || 'V1.0'
+	end
+
 	def to_s
 	    private_rule_array = @private_rules.map do |(name, rule)|
 		atoms = rule.map {|a| unparse_atom(a) }.join(' ')
@@ -36,6 +55,20 @@ module JSGF
 	end
 
     private
+	# Expand the given rule and collect any references to other rules
+	# @param rule	[Array]	the right-hand-side of the rule to expand
+	# @return [Array]   an array of referenced rule names
+	def find_rule_names(rule)
+	    case rule
+		when Alternation, Array, Optional
+		    rule.flat_map {|a| find_rule_names(a) }
+		when Hash
+		    rule[:name]
+		else
+		    raise StandardError, "Unkown atom #{rule.class}"
+	    end
+	end
+
 	# Generate the grammar name header line
 	def grammar_header
 	    "grammar #{grammar_name};"

data/lib/jsgf/optional.rb

@@ -1,11 +1,19 @@
 module JSGF
     class Optional
+	include Enumerable
+
 	attr_reader :elements
 
 	def initialize(*args)
 	    @elements = args
 	end
 
+	# @group Enumerable
+	def each(*args, &block)
+	    elements.each(*args, &block)
+	end
+	# @endgroup
+
 	def optional
 	    true
 	end

data/test/jsgf/alternation.rb

@@ -0,0 +1,15 @@
+require 'minitest/autorun'
+require 'jsgf/parser'
+
+describe JSGF::Alternation do
+    it 'must be enumerable' do
+	alternation = JSGF::Alternation.new('one', 'two', 'three')
+	alternation.all? {|a| a}
+    end
+
+    it 'must be mappable' do
+	alternation = JSGF::Alternation.new('one', 'two', 'three')
+	i = 0
+	alternation.map {|a| i = i + 1 }.must_equal [1,2,3]
+    end
+end

data/test/jsgf/grammar.rb

@@ -2,9 +2,45 @@ require 'minitest/autorun'
 require 'jsgf/parser'
 
 describe JSGF::Grammar do
+    it 'must require a grammar name' do
+	-> { JSGF::Grammar.new }.must_raise ArgumentError
+    end
+
+    it 'must have a default version' do
+	JSGF::Grammar.new(name:'test').version.must_equal 'V1.0'
+	JSGF::Grammar.new(name:'test').to_s.must_equal "#JSGF V1.0;\ngrammar test;"
+    end
+
+    describe 'roots' do
+	it 'must not have roots without public rules' do
+	    grammar = JSGF::Parser.new('#JSGF V1.0; grammar test; <rule>=one | two | three;').parse
+	    grammar.roots.must_equal nil
+	end
+
+	it 'must have one root for one public rule' do
+	    grammar = JSGF::Parser.new('#JSGF V1.0; grammar test; public <rule>=one | two | three;').parse
+	    grammar.roots.size.must_equal 1
+	    grammar.roots['rule'].must_be_kind_of Array
+	end
+
+	it 'must have two roots for two public rules' do
+	    grammar = JSGF::Parser.new('#JSGF V1.0; grammar test; public <rule1>=one | two | three; public <rule2>=four five;').parse
+	    grammar.roots.size.must_equal 2
+	    grammar.roots['rule1'].must_be_kind_of Array
+	    grammar.roots['rule2'].must_be_kind_of Array
+	end
+
+	it 'must ignore nested roots' do
+	    grammar = JSGF::Parser.new('#JSGF V1.0; grammar test; public <rule1>=one | two | three; public <rule2>=four <rule3>; public <rule3>=five;').parse
+	    grammar.roots.size.must_equal 2
+	    grammar.roots['rule1'].must_be_kind_of Array
+	    grammar.roots['rule2'].must_be_kind_of Array
+	end
+    end
+
     it 'must unparse a header' do
 	grammar = JSGF::Parser.new('#JSGF; grammar header_grammar;').parse
-	grammar.to_s.must_equal "#JSGF;\ngrammar header_grammar;"
+	grammar.to_s.must_equal "#JSGF V1.0;\ngrammar header_grammar;"
     end
 
     it 'must unparse a header with a version' do

data/test/jsgf/optional.rb

@@ -0,0 +1,15 @@
+require 'minitest/autorun'
+require 'jsgf/parser'
+
+describe JSGF::Optional do
+    it 'must be enumerable' do
+	optional = JSGF::Optional.new('one', 'two', 'three')
+	optional.all? {|a| a}
+    end
+
+    it 'must be mappable' do
+	optional = JSGF::Optional.new('one', 'two', 'three')
+	i = 0
+	optional.map {|a| i = i + 1 }.must_equal [1,2,3]
+    end
+end

data/test/jsgf/tokenizer.rb

@@ -38,5 +38,17 @@ describe JSGF::Tokenizer do
 	it 'must skip C-style comments' do
 	    JSGF::Tokenizer.new(' /* a comment */ some_token ').next_token.must_equal [:TOKEN, 'some_token']
 	end
+
+	it 'must skip multi-line C-style comments' do
+	    JSGF::Tokenizer.new(" /* a\nmulti-line\ncomment */ some_token ").next_token.must_equal [:TOKEN, 'some_token']
+	end
+
+	it 'must skip single-line C++ comments' do
+	    JSGF::Tokenizer.new(' some_token // a comment ').next_token.must_equal [:TOKEN, 'some_token']
+	end
+
+	it 'must skip single-line C++ comments at the beginning of a line' do
+	    JSGF::Tokenizer.new(" some_token // \n//a comment ").next_token.must_equal [:TOKEN, 'some_token']
+	end
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsgf
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: '0.3'
 platform: ruby
 authors:
 - Brandon Fosdick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-07 00:00:00.000000000 Z
+date: 2015-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,7 +58,9 @@ files:
 - lib/jsgf/parser.rb
 - lib/jsgf/repetition.rb
 - lib/jsgf/tokenizer.rb
+- test/jsgf/alternation.rb
 - test/jsgf/grammar.rb
+- test/jsgf/optional.rb
 - test/jsgf/parser.rb
 - test/jsgf/tokenizer.rb
 homepage: http://github.com/bfoz/jsgf-ruby
@@ -86,6 +88,8 @@ signing_key:
 specification_version: 4
 summary: Java Speech Grammar Format
 test_files:
+- test/jsgf/alternation.rb
 - test/jsgf/grammar.rb
+- test/jsgf/optional.rb
 - test/jsgf/parser.rb
 - test/jsgf/tokenizer.rb