rley 0.5.13 → 0.5.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 457b41c7e35823bc234ddad0419bac1416494790
-  data.tar.gz: a50f2c9df76426c56c3106b2d5ef1dd46b319a98
+  metadata.gz: 331a505963faf201ef03664616805ce831a591e0
+  data.tar.gz: 1e80b03ca806612f72fa97db13dd49b1cc55e218
 SHA512:
-  metadata.gz: db08ac3611d797984b6b196a5de5a4b15b5507b6b4973428ab28f1271b8b609b35b920bf54a883dbeb5d24dc503bf85b6952f5d0ad9c7bae74327e5cf411f0c8
-  data.tar.gz: 2d0b8623dd36c3f8fcfa3d2515eadae0cfc5bfd4934e0d03838b2e5a7b029ca382d6d03b3dd9565b77107b8b49ae96ca9a35e024020c26e61a949d5e1b2b3a85
+  metadata.gz: e070d60d75abd4beace97c65d938a7bc4e81e1c9c4bc0c4d3f0b1bba4acd13662e3196f83113bfd5def31992d2df85367dc6a3fb6ab367480e6e1d51d9d6d98d
+  data.tar.gz: 3816e3675513be5608d731fba3b37e9c08b41ced276403182790dcb8d38235cd88c7908b8a3540bf2c5afc87fec84e3340a1b61f9caf55fa095e9b4f6092774d

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 0.5.14 / 2018-XX-XX
+* [NEW] Files spec/rley/sppf/token_node_spec.rb` Added RSpec file for testing  `SPPF::TokenNode` class.
+* [CHANGE] Files `lib/rley/sppf` Minor update in the YARD documentation of the SPPF node classes.
+* [FIX] Method `Parser::CSTRawNode#initialize`. Yard warning because of duplicate parameter names in documentation.
+* [FIX] Method `GFG::Edge#initialize`. Yard warning because parameter names were missing in documentation.
+
 ### 0.5.13 / 2018-02-09
 * [CHANGE] File `examples/general/SRL/grammar.rb added names to each production rule.
 * [CHANGE] File `examples/general/SRL/ast_builder.rb Code refactoring to take profit of rule naming.
@@ -24,7 +30,7 @@
 * [CHANGE] File `examples/general/SRL/grammar.rb increased coverage of Simple Regex Language parser.
 * [CHANGE] File `examples/general/SRL/ast_builder.rb Added transformation rules for constructing regular expressions.
 * [CHANGE] File `examples/general/SRL/spac/integration_spec.rb Added tests for SRL expressions.
-* [FIX] Added an custom `inspect` method to sevaral core classes. This was necessary because default implementation from Ruby got lost with object graphs.
+* [FIX] Added an custom `inspect` method to several core classes. This was necessary because default implementation from Ruby got lost with object graphs.
 
 ### 0.5.10 / 2017-12-02
 * [CHANGE] Dir `examples/general/SRL/ Added support for digit range to Simple Regex Language parser.

data/examples/general/left.rb

@@ -1,8 +1,10 @@
 # Purpose: define a grammar with left-recursive rule
 require 'rley' # Load Rley library
 
-# Instantiate a builder object that will build the grammar for us
+# Instantiate a builder object that will build the grammar for us.
 builder = Rley::Syntax::GrammarBuilder.new do
+  # The grammar defines a language that consists in a sequence
+  # of 0 or more dots...
   add_terminals('DOT')
   
   # Grammar with left recursive rule.

data/examples/general/right.rb

@@ -3,9 +3,11 @@ require 'rley' # Load Rley library
 
 # Instantiate a builder object that will build the grammar for us
 builder = Rley::Syntax::GrammarBuilder.new do
+  # The grammar defines a language that consists in a sequence
+  # of 0 or more dots...
   add_terminals('DOT')
   
-  # Grammar with left recursive rule.
+  # Grammar with right recursive rule.
 	rule 'r_dots' => []
 	rule 'r_dots' => %w[DOT r_dots]  
 end

data/lib/rley/constants.rb

@@ -3,7 +3,7 @@
 
 module Rley # Module used as a namespace
   # The version number of the gem.
-  Version = '0.5.13'.freeze
+  Version = '0.5.14'.freeze
 
   # Brief description of the gem.
   Description = "Ruby implementation of the Earley's parsing algorithm".freeze

data/lib/rley/gfg/edge.rb

@@ -8,8 +8,8 @@ module Rley # This module is used as a namespace
       attr_reader :successor
 
       # Construct a directed edge between two given vertices
-      # @param [Vertex]
-      # @param [Vertex]
+      # @param thePredecessor [Vertex]
+      # @param theSuccessor [Vertex]
       def initialize(thePredecessor, theSuccessor)
         @successor = theSuccessor
         thePredecessor.add_edge(self)

data/lib/rley/parser/parse_tree_builder.rb

@@ -13,7 +13,7 @@ module Rley # This module is used as a namespace
     # Structure used internally by ParseTreeBuilder class.
     CSTRawNode = Struct.new(:range, :symbol, :children) do
       # Constructor.
-      # @param aSymbol [Lexical::TokenRange] The token position range.
+      # @param aRange [Lexical::TokenRange] The token position range.
       # @param aSymbol [Syntax::Symbol] A symbol from grammar.
       def initialize(aRange, aSymbol)
         super

data/lib/rley/sppf/alternative_node.rb

@@ -5,16 +5,17 @@ module Rley # This module is used as a namespace
     # A node in a parse forest that is a child
     # of a parent node with :or refinement
     class AlternativeNode < CompositeNode
-      # GFG vertex label
+      # @return [String] GFG vertex label
       attr_reader(:label)
 
-      # Link to lhs symbol
+      # @return [Syntax::NonTerminal] Link to lhs symbol
       attr_reader(:symbol)
 
-      # @param aVertex [ItemVertex] An GFG vertex that corresponds
-      # a dotted item (with the dot at the end)for the alternative under
-      # consideration.
-      # @param aRange [TokenRange]
+      # @param aVertex [GFG::ItemVertex] 
+      #   A GFG vertex that corresponds to a dotted item 
+      #   with the dot at the end) for the alternative under consideration.
+      # @param aRange [Lexical::TokenRange] 
+      #   A range of token indices corresponding to this node.
       def initialize(aVertex, aRange)
         super(aRange)
         @label = aVertex.label
@@ -23,6 +24,7 @@ module Rley # This module is used as a namespace
 
       # Emit a (formatted) string representation of the node.
       # Mainly used for diagnosis/debugging purposes.
+      # @return [String]
       def to_string(indentation)
         return "Alt(#{label})#{range.to_string(indentation)}"
       end

data/lib/rley/sppf/composite_node.rb

@@ -5,18 +5,28 @@ module Rley # This module is used as a namespace
     # Abstract class. The generalization for nodes that have
     # children node(s).
     class CompositeNode < SPPFNode
-      # Array of sub-nodes.
+      # @return [Array<SPFFNode>] Sub-nodes (children).
       attr_reader(:subnodes)
 
+      # Constructor
+      # @param aRange [Lexical::TokenRange]      
       def initialize(aRange)
         super(aRange)
         @subnodes = []
       end
 
+      # Add a sub-node (child) to this one.
+      # @param aSubnode [SPPFNode]
       def add_subnode(aSubnode)
         subnodes.unshift(aSubnode)
       end
+      
+      # @return [String] a text representation of the node.
+      def inspect()
+        key
+      end      
 
+      # @return [String]
       def key()
         @key ||= to_string(0)
       end

data/lib/rley/sppf/epsilon_node.rb

@@ -5,7 +5,7 @@ module Rley # This module is used as a namespace
     # A leaf node in a parse forest that matches an empty
     # string from the input
     class EpsilonNode < LeafNode
-      # aPosition is the position of the token in the input stream.
+      # aPosition [Integer] is the position of the token in the input stream.
       def initialize(aPosition)
         range = { low: aPosition, high: aPosition }
         super(range)
@@ -13,13 +13,10 @@ module Rley # This module is used as a namespace
 
       # Emit a (formatted) string representation of the node.
       # Mainly used for diagnosis/debugging purposes.
+      # @return [String]
       def to_string(indentation)
         return "_#{range.to_string(indentation)}"
       end
-
-      def key()
-        @key ||= to_string(0)
-      end
     end # class
   end # module
 end # module

data/lib/rley/sppf/leaf_node.rb

@@ -2,9 +2,18 @@ require_relative 'sppf_node'
 
 module Rley # This module is used as a namespace
   module SPPF # This module is used as a namespace
-    # Abstract class. The generalization for nodes that don't have
+    # Abstract class. The generalization for SPPF nodes that don't have
     # child node.
     class LeafNode < SPPFNode
+      # @return [String] a text representation of the node.
+      def inspect()
+        key
+      end
+
+      # @return [String]
+      def key()
+        @key ||= to_string(0)
+      end    
     end # class
   end # module
 end # module

data/lib/rley/sppf/non_terminal_node.rb

@@ -3,21 +3,26 @@ require_relative 'composite_node'
 module Rley # This module is used as a namespace
   module SPPF # This module is used as a namespace
     # A node in a parse forest that matches exactly one
-    # non-terminal symbol
+    # non-terminal symbol.
     class NonTerminalNode < CompositeNode
-      # Link to the non-terminal symbol
+      # @return [Syntax::NonTerminal] Link to the non-terminal symbol
       attr_reader(:symbol)
 
       # Indication on how the sub-nodes contribute to the 'success'
       # of parent node. Possible values: :and, :or
       attr_accessor :refinement
 
+      # Constructor
+      # @param aNonTerminal [Syntax::NonTerminal]
+      # @param aRange [Lexical::TokenRange]      
       def initialize(aNonTerminal, aRange)
         super(aRange)
         @symbol = aNonTerminal
         @refinement = :and
       end
 
+      # Add a sub-node (child) to this one.
+      # @param aSubnode [SPPFNode]      
       def add_subnode(aSubnode)
         if refinement == :or
           subnodes << aSubnode
@@ -28,6 +33,7 @@ module Rley # This module is used as a namespace
 
       # Emit a (formatted) string representation of the node.
       # Mainly used for diagnosis/debugging purposes.
+      # @return [String] a text representation of the node.      
       def to_string(indentation)
         return "#{symbol.name}#{range.to_string(indentation)}"
       end

data/lib/rley/sppf/sppf_node.rb

@@ -3,18 +3,22 @@ require_relative '../lexical/token_range'
 module Rley # This module is used as a namespace
   module SPPF # This module is used as a namespace
     # Abstract class. The generalization for all kinds of nodes
-    # occurring in a shared packed parse forest.
+    # occurring in a shared packed parse forest (SPPF).
     class SPPFNode
     
-      # A range of indices for tokens matching this node.
+      # @return [Lexical::TokenRange] 
+      # A range of token indices corresponding to this node.
       attr_reader(:range)
       
+      # Constructor
+      # @param aRange [Lexical::TokenRange]
       def initialize(aRange)
         @range = Lexical::TokenRange.new(aRange)
       end
       
-      # Return the origin (= lower bound of the range 
-      # = position of first token matched by the symbol)
+      # Return the origin, that is, the index of the 
+      # first token matched by this node.
+      # @return [Integer]
       def origin()
         return range.low
       end  

data/lib/rley/sppf/token_node.rb

@@ -2,12 +2,16 @@ require_relative 'leaf_node'
 
 module Rley # This module is used as a namespace
   module SPPF # This module is used as a namespace
-    # A node in a parse forest that matches exactly one
-    # token from the input
+    # A SPPF node that matches exactly one
+    # token from the input.
     class TokenNode < LeafNode
+      # @return [Lexical::Token]
+      # The input token that is represented by this parse node.
       attr_reader(:token)
 
-      # aPosition is the position of the token in the input stream.
+      # Constructor
+      # @param aToken [Lexical::Token] input token represented by this node.
+      # @param aPosition [Integer] index of the token in the input stream.
       def initialize(aToken, aPosition)
         range = { low: aPosition, high: aPosition + 1 }
         super(range)
@@ -16,13 +20,11 @@ module Rley # This module is used as a namespace
 
       # Emit a (formatted) string representation of the node.
       # Mainly used for diagnosis/debugging purposes.
+      # @param indentation [Integer]
+      # @return [String]
       def to_string(indentation)
         return "#{token.terminal.name}#{range.to_string(indentation)}"
       end
-
-      def key()
-        @key ||= to_string(0)
-      end
     end # class
   end # module
 end # module

data/spec/rley/sppf/token_node_spec.rb

@@ -0,0 +1,46 @@
+require 'ostruct'
+require_relative '../../spec_helper'
+
+require_relative '../../../lib/rley/syntax/terminal'
+require_relative '../../../lib/rley/lexical/token_range'
+require_relative '../../../lib/rley/lexical/token'
+
+# Load the class under test
+require_relative '../../../lib/rley/sppf/token_node'
+
+module Rley # Open this namespace to avoid module qualifier prefixes
+  module SPPF # Open this namespace to avoid module qualifier prefixes
+    describe TokenNode do
+      let(:sample_symbol) { Syntax::Terminal.new('Noun') }
+      let(:sample_token) { Lexical::Token.new('language', sample_symbol) }
+      let(:sample_position) { 3 } 
+
+      subject { TokenNode.new(sample_token, sample_position) }
+
+      context 'Initialization:' do
+        it 'should know its token' do
+          expect(subject.token).to eq(sample_token)
+        end
+
+        it 'should know its token range' do
+          expect(subject.origin).to eq(sample_position)
+          expect(subject.range.low).to eq(sample_position)
+          expect(subject.range.high).to eq(sample_position + 1)
+        end
+      end # context
+      
+      context 'Provided services:' do
+        it 'should know its string representation' do
+          expect(subject.to_string(0)).to eq('Noun[3, 4]')
+          expect(subject.inspect).to eq('Noun[3, 4]')
+        end
+        
+        it 'should return a key value of itself' do
+          expect(subject.key).to eq('Noun[3, 4]')
+        end
+      end # context
+    end # describe
+  end # module
+end # module
+
+# End of file

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rley
 version: !ruby/object:Gem::Version
-  version: 0.5.13
+  version: 0.5.14
 platform: ruby
 authors:
 - Dimitri Geshef
@@ -304,6 +304,7 @@ files:
 - spec/rley/ptree/terminal_node_spec.rb
 - spec/rley/sppf/alternative_node_spec.rb
 - spec/rley/sppf/non_terminal_node_spec.rb
+- spec/rley/sppf/token_node_spec.rb
 - spec/rley/support/ambiguous_grammar_helper.rb
 - spec/rley/support/expectation_helper.rb
 - spec/rley/support/grammar_abc_helper.rb
@@ -398,6 +399,7 @@ test_files:
 - spec/rley/ptree/terminal_node_spec.rb
 - spec/rley/sppf/alternative_node_spec.rb
 - spec/rley/sppf/non_terminal_node_spec.rb
+- spec/rley/sppf/token_node_spec.rb
 - spec/rley/syntax/grammar_builder_spec.rb
 - spec/rley/syntax/grammar_spec.rb
 - spec/rley/syntax/grm_symbol_spec.rb