rley 0.1.10 → 0.1.11

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzgzNjZlYTc1NjRjYTkxZTNkNmVkNmE3MmY2OGRjNzAwYjBjM2E0MQ==
+    MDNkYmEzYTFiNmUyMzk2MTgwOTczZmNlMTVjMDU3ZDIzNjI4YWNmYw==
   data.tar.gz: !binary |-
-    MmMzNWNiZjRlZDcyOTJiZmE0Nzc4Y2ZjYjBhYmYyM2ZkNTE5MzM5OQ==
+    ZWQ1MmMzMDA2NzcxOTUzM2ZjMDg0Yjg2OTg0MTVhODgzOTQ1OTExNg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YTRiZTJhZjRkOTcyYzQ3NTE4ZDFmZGQ1NTI4ZGM3MTdhOGVlN2Q2NGFlNWE1
-    NmVlMmE2NGUzYjJhOTE0MTJjNmY0ZmI3MDMzYTA3N2VjYzVlNGQ4ODNhNDc2
-    MzdiYzdkMzhlZWVmYTJhNWUxMjg4ZWM2OTQ3Zjg3ZDcyNDY1MjE=
+    ZjhmMDlmZjk2ZDYwY2EwNDBjZjIxYWMyMDA1ZjQ4MTVmOWE0NjRhZmI4OTg1
+    MWZiMzQwNzFkOGIyMzJmZTdmMTg2NTRkOGVmM2ViNjg0MzU1MjllODJkZTIx
+    NzQ4NDA3NmUwYzY4YzBhMmYwODg1MGIzNGJmMDU3NDBjMzJmZDY=
   data.tar.gz: !binary |-
-    YmE3MmE2OGM5MzBhMDY4NDgyNTA5MmY0NjA3ZjcyNDQ3Yzg3NDJiNTJjNzc0
-    NjczZDFjN2QyNTIwODNmYmE5ZGQwMzBjMTYwMWQwNDJkN2UwYWQ5MTc4MWJh
-    OWU5OTdlNmFkNWYyNTA2NzU3NWI0MjUxZTM1NjRmMzE4MGNhOGE=
+    OTBhM2JiNzRiNzJlNmNmZWRjODJhMzY3MzkyMDdkNDRmNzcyYzFiMGNmYThm
+    YWVhMTBjMzkzMDI1NzMyNTNiOTkzZGFlODAxYzcyYWQ0Y2QyNGEwZWUxYjBj
+    YTk0OTViZWVkODk5N2U4MmUxZWJlZTBjY2QxOTNmMDk5YmIxZjU=

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.1.11 / 2014-12-16
+* [FIX] Fixed all but one YARD (documentation) warnings. Most of them were due to mismatch
+in method argument names between source code and documentation.  
+* [CHANGE] File `README.md` added Gemnasium badge (for the gem dependency checks)
+
 ### 0.1.10 / 2014-12-14
 * [CHANGE] Added more examples in `examples` folder (e.g. parsing then parse tree ).
 * [CHANGE] File `rley.rb`: added more requires of the library to ease integration.

data/README.md

@@ -6,6 +6,7 @@ Rley
 [![Build Status](https://travis-ci.org/famished-tiger/Rley.svg?branch=master)](https://travis-ci.org/famished-tiger/Rley)
 [![Coverage Status](https://img.shields.io/coveralls/famished-tiger/Rley.svg)](https://coveralls.io/r/famished-tiger/Rley?branch=master)
 [![Gem Version](https://badge.fury.io/rb/rley.svg)](http://badge.fury.io/rb/rley)
+[![Dependency Status](https://gemnasium.com/famished-tiger/Rley.svg)](https://gemnasium.com/famished-tiger/Rley)
 
 ### What is Rley? ###
 __Rley__ is a Ruby implementation of a Earley parser.  

data/lib/rley/constants.rb

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

data/lib/rley/formatter/debug.rb

@@ -68,7 +68,7 @@ module Rley # This module is used as a namespace
       # Notification of a visit event: the visitor completed the visit of
       # a non-terminal node
       # @param _nonterm [NonTerminalNode]
-      def after_non_terminal(_)
+      def after_non_terminal(_nonterm)
         dedent
         output_event(__method__, indentation)
       end

data/lib/rley/formatter/json.rb

@@ -38,7 +38,7 @@ module Rley # This module is used as a namespace
       # Method called by a ParseTreeVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor is about to visit
       # a non-terminal node
-      # @param _nonterm [NonTerminalNode]
+      # @param nonterm_node [NonTerminalNode]
       def before_non_terminal(nonterm_node)
         separator = sibling_flags[-1] ? ",\n" : "\n"
         name = nonterm_node.symbol.name
@@ -60,7 +60,7 @@ module Rley # This module is used as a namespace
       # Method called by a ParseTreeVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor is about to visit
       # a terminal node
-      # @param _term [TerminalNode]
+      # @param term_node [TerminalNode]
       def before_terminal(term_node)
         separator = sibling_flags[-1] ? ",\n" : "\n"
         name = term_node.symbol.name
@@ -82,15 +82,6 @@ module Rley # This module is used as a namespace
         print_text("\n", '}')
       end
 
-
-      # Method called by a ParseTreeVisitor to which the formatter subscribed.
-      # Notification of a visit event: the visitor completed the visit of
-      # a non-terminal node
-      # @param _nonterm [NonTerminalNode]
-      def after_non_terminal(_)
-      end
-
-
       # Method called by a ParseTreeVisitor to which the formatter subscribed.
       # Notification of a visit event: the visitor completed the visit
       # of the given parse tree

data/lib/rley/parse_tree_visitor.rb

@@ -43,7 +43,7 @@ module Rley # This module is used as a namespace
 
 
     # Visit event. The visitor is about to visit the given non terminal node.
-    # @param aNonTerminal [NonTerminalNode] the node to visit.
+    # @param aNonTerminalNode [NonTerminalNode] the node to visit.
     def start_visit_nonterminal(aNonTerminalNode)
       broadcast(:before_non_terminal, aNonTerminalNode)
     end
@@ -63,7 +63,7 @@ module Rley # This module is used as a namespace
 
     # Visit event. The visitor is visiting the
     # given terminal node.
-    # @param aTerminal [TerminalNode] the terminal to visit.
+    # @param aTerminalNode [TerminalNode] the terminal to visit.
     def visit_terminal(aTerminalNode)
       broadcast(:before_terminal, aTerminalNode)
       broadcast(:after_terminal, aTerminalNode)
@@ -72,7 +72,7 @@ module Rley # This module is used as a namespace
 
     # Visit event. The visitor has completed its visit of the given 
     # non-terminal node.
-    # @param aNonTerminal [NonTerminalNode] the node to visit.
+    # @param aNonTerminalNode [NonTerminalNode] the node to visit.
     def end_visit_nonterminal(aNonTerminalNode)
       broadcast(:after_non_terminal, aNonTerminalNode)
     end

data/lib/rley/parser/earley_parser.rb

@@ -20,8 +20,8 @@ module Rley # This module is used as a namespace
       # after "advancing" the dot
       attr_reader(:next_mapping)
 
-      # @param aGrammar [Grammar] A context-free grammar that defines the 
-      # language of the input to be parsed.
+      # @param aGrammar [Grammar] The grammar of the language 
+      # (to use by the parser).
       def initialize(aGrammar)
         @grammar = aGrammar
         @dotted_items = build_dotted_items(grammar)
@@ -32,7 +32,7 @@ module Rley # This module is used as a namespace
       # Parse a sequence of input tokens.
       # @param aTokenSequence [Array] Array of Tokens objects returned by a 
       # tokenizer/scanner/lexer.
-      # @return a Parsing object that embeds the parse result.
+      # @return [Parsing] an object that embeds the parse results.
       def parse(aTokenSequence)
         result = Parsing.new(start_dotted_item, aTokenSequence)
         last_token_index = aTokenSequence.size
@@ -159,7 +159,7 @@ module Rley # This module is used as a namespace
       # such that the dot appears after terminal.
       # @param aParsing [Parsing] the object that encapsulates the results
       #   result of the parsing process
-      # @param Terminal [Terminal] a terminal symbol that 
+      # @param aTerminal [Terminal] a terminal symbol that 
       #   immediately follows a dot 
       # @param aPosition [Fixnum] position in the input token sequence.
       def scanning(aParsing, aTerminal, aPosition)

data/lib/rley/parser/parsing.rb

@@ -32,22 +32,19 @@ module Rley # This module is used as a namespace
       def parse_tree()
         state_set_index = chart.state_sets.size - 1
         parse_state = end_parse_state
-        curr_dotted_item = parse_state.dotted_rule
         full_range = { low: 0, high: state_set_index }
-        ptree = PTree::ParseTree.new(curr_dotted_item.production, full_range)
+        start_production = chart.start_dotted_rule.production
+        ptree = PTree::ParseTree.new(start_production, full_range)
+        return ptree if parse_state.nil?
         loop do
+          curr_dotted_item = parse_state.dotted_rule
           # Look at the symbol on left of the dot
           curr_symbol = curr_dotted_item.prev_symbol
           case curr_symbol
             when Syntax::Terminal
               state_set_index -= 1
-              ptree.step_back(state_set_index)
-              if ptree.current_node.is_a?(PTree::TerminalNode)
-                ptree.current_node.token = tokens[state_set_index]
-              end
-              state_set = chart[state_set_index]
-              parse_state = state_set.predecessor_state(parse_state)
-              curr_dotted_item = parse_state.dotted_rule
+              parse_state = predecessor_state_terminal(ptree, state_set_index, 
+                parse_state)
               
             when Syntax::NonTerminal
               # Retrieve complete states
@@ -58,10 +55,7 @@ module Rley # This module is used as a namespace
               ptree.current_node.range = { low: parse_state.origin }
               node_range =  ptree.current_node.range
               ptree.add_children(curr_dotted_item.production, node_range)
-              if ptree.current_node.is_a?(PTree::TerminalNode)
-                a_node = ptree.current_node
-                a_node.token = tokens[state_set_index - 1] unless a_node.token
-              end
+              link_node_to_token(ptree, state_set_index - 1)
               
             when NilClass
               lhs = curr_dotted_item.production.lhs
@@ -69,7 +63,6 @@ module Rley # This module is used as a namespace
               break if new_states.empty?
               # TODO: make this more robust
               parse_state = new_states[0]
-              curr_dotted_item = parse_state.dotted_rule
               ptree.step_up(state_set_index)
               ptree.current_node.range = { low: parse_state.origin }
               break if ptree.root == ptree.current_node
@@ -96,7 +89,7 @@ module Rley # This module is used as a namespace
       # a new state like: <next dotted rule, s.origin, aPosition + 1>
       # In other words, we place the dotted rules in the next state set
       # such that the dot appears after terminal.
-      # @param Terminal [Terminal] a terminal symbol that
+      # @param aTerminal [Terminal] a terminal symbol that
       #   immediately follows a dot
       # @param aPosition [Fixnum] position in the input token sequence.
       # @param nextMapping [Proc or Lambda] code to evaluate in order to
@@ -153,6 +146,25 @@ module Rley # This module is used as a namespace
         candidate_states = last_chart_entry.states_for(start_production)
         return candidate_states.find(&:complete?)
       end
+      
+      # Go to the predecessor state for the given terminal
+      def predecessor_state_terminal(aParseTree, aStateSetIndex, current_state)
+        aParseTree.step_back(aStateSetIndex)
+        link_node_to_token(aParseTree, aStateSetIndex)
+        state_set = chart[aStateSetIndex]
+        state_set.predecessor_state(current_state)
+      end
+
+      
+      # If the current node is a terminal node
+      # then link the token to that node
+      def link_node_to_token(aParseTree, aStateSetIndex)
+        if aParseTree.current_node.is_a?(PTree::TerminalNode)
+          a_node = aParseTree.current_node
+          a_node.token = tokens[aStateSetIndex] unless a_node.token
+        end
+      end
+      
     end # class
   end # module
 end # module

data/lib/rley/ptree/parse_tree.rb

@@ -56,7 +56,7 @@ module Rley # This module is used as a namespace
       end
 
       # Move the current node to the parent node.
-      # @param tokenPos [Fixnum] position of the matching input token
+      # @param _tokenPos [Fixnum] position of the matching input token
       def step_up(_tokenPos)
         current_path.pop(2)
       end

data/lib/rley/syntax/grammar.rb

@@ -24,7 +24,7 @@ module Rley # This module is used as a namespace
       # A Hash with pairs of the kind: symbol name => grammar symbol
       attr_reader(:name2symbol)
 
-      # @param theProduction [Array of Production] the list of productions
+      # @param theProductions [Array of Production] the list of productions
       # of the grammar.
       def initialize(theProductions)
         @rules = []

data/lib/rley/syntax/grammar_builder.rb

@@ -25,21 +25,31 @@ module Rley # This module is used as a namespace
       
       # Retrieve a grammar symbol from its name.
       # Raise an exception if not found.
-      # @param [aSymbolName] the name of a symbol grammar.
+      # @param aSymbolName [String] the name of a symbol grammar.
       # @return [GrmSymbol] the retrieved symbol.
       def [](aSymbolName)
         return symbols[aSymbolName]
       end
 
       # Add the terminal symbols of the language
-      # terminalSymbols [String or Terminal] one or more terminal symbols
-      # to add to the grammar.
+      # @param terminalSymbols [String or Terminal] one or more 
+      # terminal symbols to add to the grammar.
       def add_terminals(*terminalSymbols)
         new_symbs = build_symbols(Terminal, terminalSymbols)
         symbols.merge!(new_symbs)
       end
 
-      # builder.add_production('A' => ['a', 'A', 'c'])
+
+      # Add a production rule in the grammar.
+      # @param aProductionRepr [Hash] A Hash-based representation of the 
+      # production. It consists of a key-value pair of the form: 
+      # String => Array.
+      #   Where the key is the name of the non-terminal appearing in the 
+      #   left side of the rule. 
+      #   The value, an Array, is a sequence of grammar symbol names.
+      # The rule is created and inserted in the grammar.
+      # Example:
+      #   builder.add_production('A' => ['a', 'A', 'c'])
       def add_production(aProductionRepr)
         aProductionRepr.each_pair do |(lhs_name, rhs_repr)|
           lhs = get_nonterminal(lhs_name)
@@ -78,7 +88,7 @@ module Rley # This module is used as a namespace
 
       # Add the given grammar symbols.
       # @param aClass [Class] The class of grammar symbols to instantiate.
-      # @param aSymbol [Array] array of elements are treated as follows:
+      # @param theSymbols [Array] array of elements are treated as follows:
       #   if the element is already a grammar symbol, then it added as is,
       #   otherwise it is considered as the name of a grammar symbol
       # of the specified class to build.
@@ -97,7 +107,7 @@ module Rley # This module is used as a namespace
       # returned as is. Otherwise, the argument is treated as a name
       # for a new instance of the given class.
       # @param aClass [Class] The class of grammar symbols to instantiate
-      # @param aSymbol [GrmSymbol-like or String]
+      # @param aSymbolArg [GrmSymbol-like or String]
       # @return [Array] list of grammar symbols
       def build_symbol(aClass, aSymbolArg)
         if aSymbolArg.kind_of?(GrmSymbol)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rley
 version: !ruby/object:Gem::Version
-  version: 0.1.10
+  version: 0.1.11
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-14 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake