jsgf 0.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e90d5a58e0adaadef490c11911c9443e14fb0a5
-  data.tar.gz: fd7deb3081c443f76c4505b72e1f18397d1ce183
+  metadata.gz: ae316ae11c63ab1272f04970e188ac162df75dd5
+  data.tar.gz: 4e960c23772bc117c4b7955144b72eeffc2ac3b5
 SHA512:
-  metadata.gz: 28d2d63a8f51d32efdcf597877e18ce86d45bded53077ef40e2908364af21fa23eb7b1f90262630738c866dd1df79d0a193bea81e04cb9619685bfbe9541645a
-  data.tar.gz: 132cefa593326e8b2d7c603746c8e114a1872de5bb566a5fa1fe8ec76ff5127492a8e28e9fa6f686ba4d1641071732399459bb976cb4a27c2b10592306a98d28
+  metadata.gz: 42d12240171fd99346507d7850f73e880c321337bf50d421cf4411e5a1d300badc2c4459491fcacc2c97716f739616488bb74c4c95a79912bae51dbfa3617536
+  data.tar.gz: 4e34672b1e1cd91993f55d069270e692fddb16590610934cce1136b04c9c10b21c77c369afb55269802b547d5e562e5cc7c36a305d9678803468e5221b7c014e

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

data/lib/jsgf/alternation.rb

@@ -1,3 +1,5 @@
+require_relative 'rule'
+
 module JSGF
     class Alternation
 	include Enumerable
@@ -9,12 +11,7 @@ module JSGF
 	def initialize(*args)
 	    @elements = args.map do |a|
 		case a
-		    when String
-			case a
-			    when /\<(.*)\>/, /:(.*)/ then {name:$1, weight:1.0, tags:[]}
-			    else
-				{atom:a, weight:1.0, tags:[]}
-			end
+		    when String then Rule.parse_atom(a)
 		    when Symbol then {name:a.to_s, weight:1.0, tags:[]}
 		    else
 			a
@@ -35,12 +32,14 @@ module JSGF
 	    @elements.push *args
 	end
 
+	# @group Attributes
 	def size
 	    @elements.size
 	end
 
 	def weights
-	    @elements.map {|a| a[:weight]}
+	    @elements.map {|a| a.respond_to?(:weight) ? a.weight : a[:weight]}
 	end
+	# @endgroup
     end
 end

data/lib/jsgf/atom.rb

@@ -0,0 +1,34 @@
+module JSGF
+    class Atom
+	# @!attribute atom
+	#   @return [String]  the atom of the {Atom}
+	attr_accessor :atom
+
+	# @!attribute weight
+	#   @return [Number]  the {Atom}'s weight, when part of an {Alternation}. Defaults to 1.0.
+	attr_accessor :weight
+
+	# @!attribute tags
+	#   @return [Array]  the collection of tags to be stored with the {Atom}
+	attr_accessor :tags
+
+	# @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)
+	    @atom = atom
+	    @tags = tags
+	    @weight = (weight && (weight != 1.0)) ? weight : nil
+	end
+
+	def eql?(other)
+	    @atom.eql?(other.atom) && @tags.eql?(other.tags) && @weight.eql?(other.weight)
+	end
+	alias == eql?
+
+	# Stringify in a manner suitable for output to a JSGF file
+	def to_s
+	    [(weight && (weight != 1.0)) ? "/#{weight}/" : nil, atom, *tags].compact.join(' ')
+	end
+    end
+end

data/lib/jsgf/builder.rb

@@ -37,16 +37,10 @@ module JSGF
 	def rule(**options)
 	    options.each do |name, v|
 		@rules[name.to_s] = case v
-		    when Array	then [Alternation.new(*v)]
-		    when Symbol	then [{name:v.to_s, weight:1.0, tags:[]}]
+		    when Array	then Rule.new [Alternation.new(*v)]
+		    when Symbol	then Rule.new [{name:v.to_s, weight:1.0, tags:[]}]
 		    else
-			v.split(' ').map do |a|
-			    case a
-				when /\<(.*)\>/, /:(.*)/ then {name:$1, weight:1.0, tags:[]}
-				else
-				    {atom:a, weight:1.0, tags:[]}
-			    end
-			end
+			v.split(' ').map {|a| Rule.parse_atom(a) }
 		end
 	    end
 	end

data/lib/jsgf/grammar.rb

@@ -1,3 +1,4 @@
+require_relative 'atom'
 require_relative 'optional'
 
 module JSGF
@@ -26,6 +27,7 @@ module JSGF
 	    case rule
 		when Alternation, Array, Optional
 		    rule.flat_map {|a| find_rule_names(a) }
+		when Atom then []
 		when Hash
 		    rule[:name]
 		else
@@ -110,13 +112,12 @@ module JSGF
 		when Alternation
 		    s = atom.elements.map {|a| unparse_atom(a, nested:true)}.join(' | ')
 		    atom.optional ? ('[' + s + ']') : s
+		when Atom then atom.to_s
 		when Optional then '[' + atom.elements.map {|a| unparse_atom(a, nested:nested)}.join(' | ') + ']'
 		else
 		    weight = (atom[:weight] != 1.0) ? "/#{atom[:weight]}/" : nil
 		    if atom[:name]
 			[weight, '<' + atom[:name] + '>'].compact.join(' ')
-		    else
-			[weight, atom[:atom], *atom[:tags]].compact.join(' ')
 		    end
 	    end
 	end

data/lib/jsgf/parser.rb

@@ -11,6 +11,7 @@ require_relative 'alternation'
 require_relative 'grammar'
 require_relative 'optional'
 require_relative 'repetition'
+require_relative 'rule'
 require_relative 'tokenizer'
 
 module JSGF
@@ -47,10 +48,6 @@ def define_optional(*args)
     end
 end
 
-def define_atom(atom, weight=1.0, tags=[])
-   {atom:atom, weight:weight, tags:[]}
-end
-
 def define_rule(name, visibility=:private, *args)
     r = {name: name, visibility:visibility, atoms:args.flatten}
     @rules[name] = r
@@ -70,9 +67,9 @@ def parse
 
     @rules.each do |(k,v)|
 	if v[:visibility] == :private
-	    @private_rules[k] = v[:atoms]
+	    @private_rules[k] = JSGF::Rule.new(v[:atoms])
 	else
-	    @public_rules[k] = v[:atoms]
+	    @public_rules[k] = JSGF::Rule.new(v[:atoms])
 	end
     end
 
@@ -353,7 +350,7 @@ end
 # reduce 23 omitted
 
 def _reduce_24(val, _values, result)
- val[0][:tags].push(val[1]); result = val[0] 
+ val[0].tags.push(val[1]); result = val[0] 
     result
 end
 
@@ -365,7 +362,7 @@ def _reduce_26(val, _values, result)
 end
 
 def _reduce_27(val, _values, result)
- val[1][:weight] = val.first[1..-2].to_f; result = val[1] 
+ val[1].respond_to?(:weight) ? (val[1].weight = val.first[1..-2].to_f) : (val[1][:weight] = val.first[1..-2].to_f); result = val[1] 
     result
 end
 
@@ -384,7 +381,7 @@ def _reduce_31(val, _values, result)
 end
 
 def _reduce_32(val, _values, result)
- result = define_atom(val.first) 
+ result = JSGF::Atom.new(val.first) 
     result
 end
 

data/lib/jsgf/rule.rb

@@ -0,0 +1,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)
+	    case atom
+		when /\<(.*)\>/, /:(.*)/ then {name:$1, weight:1.0, tags:[]}
+		else
+		    Atom.new(atom)
+	    end
+	end
+    end
+end

data/test/jsgf/alternation.rb

@@ -4,7 +4,7 @@ require 'jsgf/parser'
 describe JSGF::Alternation do
     it 'must convert string arguments into atoms' do
 	alternation = JSGF::Alternation.new('one', 'two', 'three')
-	alternation.elements.must_equal [{atom:'one', weight:1.0, tags:[]}, {atom:'two', weight:1.0, tags:[]}, {atom:'three', weight:1.0, tags:[]}]
+	alternation.elements.must_equal [Atom.new('one'), Atom.new('two'), Atom.new('three')]
     end
 
     it 'must be enumerable' do

data/test/jsgf/atom.rb

@@ -0,0 +1,31 @@
+require 'minitest/autorun'
+require 'jsgf/atom'
+
+describe JSGF::Atom do
+    Atom = JSGF::Atom
+
+    it 'must have a word' do
+	Atom.new('test').atom.must_equal 'test'
+    end
+
+    it 'must not have a weight until given a weight' do
+	Atom.new('test').weight.must_equal nil
+    end
+
+    it 'must stringify a word' do
+	Atom.new('test').to_s.must_equal 'test'
+    end
+
+    it 'must stringify a weight' do
+	Atom.new('test', weight:0.5).to_s.must_equal '/0.5/ test'
+    end
+
+    it 'must not stringify a nil weight' do
+	Atom.new('test').to_s.must_equal 'test'
+    end
+
+    it 'must not stringify a default weight' do
+	Atom.new('test', weight:1.0).to_s.must_equal 'test'
+	Atom.new('test', weight:1).to_s.must_equal 'test'
+    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:'one', weight:1.0, tags:[]}]
+	grammar.rules['rule1'].must_equal [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:'one', weight:1.0, tags:[]}, {atom:'two', weight:1.0, tags:[]}]
+	grammar.rules['rule1'].must_equal [Atom.new('one'), Atom.new('two')]
     end
 
     it 'must build a rule with a rule reference as a Symbol' 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:'one', weight:1.0, tags:[]}, {atom:'two', weight:1.0, tags:[]}]
+	    grammar.rules['rule1'].first.elements.must_equal [Atom.new('one'), Atom.new('two')]
 	end
 
 	it 'must build an alternation from an array of rule reference symbols' do

data/test/jsgf/parser.rb

@@ -64,9 +64,9 @@ describe JSGF::Parser do
 	    alternation = grammar.rules['rule'].first
 	    alternation.must_be_kind_of JSGF::Alternation
 	    alternation.size.must_equal 3
-	    alternation.elements[0].must_equal Hash[atom:'one', weight:1.0, tags:[]]
-	    alternation.elements[1].must_equal Hash[atom:'two', weight:1.0, tags:[]]
-	    alternation.elements[2].must_equal Hash[atom:'three', weight:1.0, tags:[]]
+	    alternation.elements[0].must_equal Atom.new('one')
+	    alternation.elements[1].must_equal Atom.new('two')
+	    alternation.elements[2].must_equal Atom.new('three')
 	end
 
 	it 'must parse a weighted alternation' do
@@ -78,7 +78,9 @@ describe JSGF::Parser do
 	    alternation.must_be_kind_of JSGF::Alternation
 	    alternation.size.must_equal 3
 	    alternation.weights.must_equal [0.5, 0.25, 0.25]
-	    alternation.elements[0].must_equal Hash[atom:'one', weight:0.5, tags:[]]
+	    alternation.elements[0].must_equal Atom.new('one', weight:0.5)
+	    alternation.elements[1].must_equal Atom.new('two', weight:0.25)
+	    alternation.elements[2].must_equal Atom.new('three', weight:0.25)
 	end
 
 	it 'must parse a grouped alternation' do
@@ -127,7 +129,7 @@ describe JSGF::Parser do
 	    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['rule1'].must_equal [{atom:'one', weight:1.0, tags:[]}]
+	    grammar.rules['rule1'].must_equal [Atom.new('one')]
 	end
 
 	it 'must parse a weighted rule reference' do
@@ -137,9 +139,9 @@ 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:'two', weight:0.5, tags:[]}]
+	    grammar.rules['rule'].first.elements.must_equal [{name:'rule1', weight:0.5, tags:[]}, Atom.new('two', weight:0.5)]
 
-	    grammar.rules['rule1'].must_equal [{atom:'one', weight:1.0, tags:[]}]
+	    grammar.rules['rule1'].must_equal [Atom.new('one')]
 	end
     end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsgf
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.4.1
 platform: ruby
 authors:
 - Brandon Fosdick
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-08 00:00:00.000000000 Z
+date: 2015-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -53,13 +53,16 @@ files:
 - jsgf.gemspec
 - lib/jsgf.rb
 - lib/jsgf/alternation.rb
+- lib/jsgf/atom.rb
 - lib/jsgf/builder.rb
 - lib/jsgf/grammar.rb
 - lib/jsgf/optional.rb
 - lib/jsgf/parser.rb
 - lib/jsgf/repetition.rb
+- lib/jsgf/rule.rb
 - lib/jsgf/tokenizer.rb
 - test/jsgf/alternation.rb
+- test/jsgf/atom.rb
 - test/jsgf/builder.rb
 - test/jsgf/grammar.rb
 - test/jsgf/optional.rb
@@ -91,6 +94,7 @@ specification_version: 4
 summary: Java Speech Grammar Format
 test_files:
 - test/jsgf/alternation.rb
+- test/jsgf/atom.rb
 - test/jsgf/builder.rb
 - test/jsgf/grammar.rb
 - test/jsgf/optional.rb