rley 0.1.04 → 0.1.05

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDA0YWZhMTI1Mzk3NDdlMTkyNTlmNzQ1ZDEzYzAwNWYxMzM3NjQwZA==
+    OTUxODY4MDAzOWE1NjFkYzc5NGFjYzNhZWIxMTRjMmY5NzA4Zjg3Yw==
   data.tar.gz: !binary |-
-    YzU1N2ZkZDQ2ZjRkMTVjZTc5YjE1NTViOGQ5NTgzNGM2YWExZDQxNg==
+    ZTRlN2M4ZjUyZDE2MTVkMzBlODdjNjdkZWFjMzk5NjI0ZDI1MjNkZA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NjBjYWQ5MDk4NmMwMjlhNjEzOWI5ZWY2MzIwMmFiZDk2MTBmMWQ5YzBlOGZi
-    MjZhNDU1OWZmZWY0YjA4NjAyMmM5NDM4ZTA3ZTdmYTdmNTc3MjQ1YzQzNzZl
-    ZDk1M2RjNjQ1MDQ5NTViZTQ3NjY1OTVkZmRjZTVkNmVhMzU2ZjI=
+    MWE4NTFmODdjMjk3YTU0NjY5YTFmMmI3ZjRmYzNjMDdlYjYwN2FkOTE1YTc3
+    ZmE1YjY2MTAwNGIwZTcyMThiOTQ5MjVjZWIzZDM4NTE3YzA4NWY5ZTMyM2Y2
+    YTQ0YTdkZWE2YjVmYzA3MDE5MjJjNmM1YzE0YzUyMDY0NjBlNDc=
   data.tar.gz: !binary |-
-    ODExMjQ0NmUwMGQ2YmY1ZTY5NzZhOGQ4MGFmZmUxN2YwY2ZiN2I4MzY1ZDli
-    NTVhNmQ0YzI3MDA0NTE2N2Q2YjY4OTc2NzRlOTNiM2Q5ZTViMDE2ZmY5NTIx
-    Y2UyNTNmZDViNTFhOWQzM2E5OWQyOTYxY2ZmMzBmMTQ2ZDViZDI=
+    YTFiMTNkZWVjYjVjYzNiMzg4N2E0ZDY0MWFkYWY5OWE0NGI1YjUyYTlkMjRj
+    YTU2NWM0ZDIwYTE2YWU2MmVjOTg2OTRhZTU0Njk1YjNmNTA0NjVjNDIzNDI2
+    NDkyMzBiYTc2MWI1ZmVhYTcyMjVkNzVjNTVjMTlmZjMyOTU5YjI=

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 0.1.05 / 2014-12-10
+* [NEW] New parse tree formatting classes `BaseFormatter` and `Debug`
+* [CHANGE] Method `Parsing#parse_tree` now add links to Token objects in TerminalNodes.
+
 ### 0.1.04 / 2014-12-08
 * [CHANGE] File `parse_tree_visitor_spec.rb`. Added step-by-step test of a parse tree visit.
 

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.04'
+  Version = '0.1.05'
 
   # Brief description of the gem.
   Description = "Ruby implementation of the Earley's parsing algorithm"

data/lib/rley/formatter/base_formatter.rb

@@ -0,0 +1,33 @@
+module Rley # This module is used as a namespace
+
+  # Namespace dedicated to parse tree formatters.
+  module Formatter
+
+    # Superclass for parse tree formatters.
+    class BaseFormatter
+      # The IO output stream in which the formatter's result will be sent.
+      attr(:output)
+
+      # Constructor.
+      # @param anIO [IO] an output IO where the formatter's result will
+      # be placed.
+      def initialize(anIO)
+        @output = anIO
+      end
+
+      public
+
+      # Given a parse tree visitor, perform the visit
+      # and render the visit events in the output stream.
+      # @param aVisitor [ParseTreeVisitor]
+      def render(aVisitor)
+        aVisitor.subscribe(self)
+        aVisitor.start
+        aVisitor.unsubscribe(self)
+      end
+
+    end # class
+  end # module
+end # module
+
+# End of file

data/lib/rley/formatter/debug.rb

@@ -0,0 +1,121 @@
+require_relative 'base_formatter'
+
+
+module Rley # This module is used as a namespace
+  # Namespace dedicated to parse tree formatters.
+  module Formatter
+
+    # A formatter class that renders the visit notification events
+    # from a parse tree visitor
+    # @example
+    #   some_grammar = ... # Points to a DynamicGrammar-like object
+    #   # Output the result to the standard console output
+    #   formatter = Sequitur::Formatter::Debug.new(STDOUT)
+    #   # Render the visit notifications
+    #   formatter.run(some_grammar.visitor)
+    class Debug < BaseFormatter
+      # Current indentation level
+      attr(:indentation)
+
+      # Constructor.
+      # @param anIO [IO] The output stream to which the rendered grammar
+      # is written.
+      def initialize(anIO)
+        super(anIO)
+        @indentation = 0
+      end
+
+      public
+
+      # Method called by a ParseTreeVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor is about to visit the given
+      # parse tree
+      # @param _ptree [ParseTree]
+      def before_ptree(_ptree)
+        output_event(__method__, indentation)
+        indent
+      end
+
+      # 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]
+      def before_non_terminal(_nonterm)
+        output_event(__method__, indentation)
+        indent
+      end
+
+      # Method called by a ParseTreeVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor is about to visit
+      # the children of a non-terminal node
+      # @param _parent [NonTerminalNode]
+      # @param _children [Array] array of children nodes
+      def before_children(_parent, _children)
+        output_event(__method__, indentation)
+        indent
+      end
+
+      # 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]
+      def before_terminal(_term)
+        output_event(__method__, indentation)
+      end
+
+      # Method called by a ParseTreeVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor completed the visit of
+      # a terminal node.
+      # @param _term [TerminalNode]
+      def after_terminal(_term)
+        output_event(__method__, indentation)
+      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(_)
+        dedent
+        output_event(__method__, indentation)
+      end
+
+      # Method called by a ParseTreeVisitor to which the formatter subscribed.
+      # Notification of a visit event: the visitor completed the visit of
+      # the children of a non-terminal node.
+      # @param _parent [NonTerminalNode]
+      # @param _children [Array] array of children nodes
+      def after_children(_parent, _children)
+        dedent
+        output_event(__method__, indentation)
+      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
+      # @param _ptree [ParseTree]
+      def after_ptree(_ptree)
+        dedent
+        output_event(__method__, indentation)
+      end
+
+      private
+
+      def indent()
+        @indentation += 1
+      end
+
+      def dedent()
+        @indentation -= 1
+      end
+
+      def output_event(anEvent, indentationLevel)
+        output.puts "#{' ' * 2 * indentationLevel}#{anEvent}"
+      end
+
+    end # class
+  end # module
+end # module
+
+# End of file

data/lib/rley/parser/parsing.rb

@@ -42,7 +42,9 @@ module Rley # This module is used as a namespace
             when Syntax::Terminal
               state_set_index -= 1
               ptree.step_back(state_set_index)
-              #ptree.current_node.token = tokens[state_set_index]
+              if ptree.current_node.is_a?(PTree::TerminalNode)
+                ptree.current_node.token = tokens[state_set_index]
+              end
               parse_state = chart[state_set_index].predecessor_state(parse_state)
               curr_dotted_item = parse_state.dotted_rule
               
@@ -147,6 +149,11 @@ module Rley # This module is used as a namespace
         candidate_states = last_chart_entry.states_for(start_production)
         return candidate_states.find(&:complete?)
       end
+      
+      # Complete the generated parse tree.
+      # Link each terminal node to its corresponding token object.
+      def complete_ptree()
+      end
     end # class
   end # module
 end # module

data/spec/rley/formatter/debug_spec.rb

@@ -0,0 +1,120 @@
+require_relative '../../spec_helper'
+require 'stringio'
+
+# require_relative '../../../lib/rley/dynamic_grammar'
+require_relative '../support/grammar_abc_helper'
+require_relative '../../../lib/rley/parser/token'
+require_relative '../../../lib/rley/parser/earley_parser'
+require_relative '../../../lib/rley/ptree/parse_tree'
+require_relative '../../../lib/rley/parse_tree_visitor'
+# Load the class under test
+require_relative '../../../lib/rley/formatter/debug'
+
+module Rley # Re-open the module to get rid of qualified names
+module Formatter
+
+describe Debug do
+  include GrammarABCHelper  # Mix-in module with builder for grammar abc
+
+  # Factory method. Build a production with the given sequence
+  # of symbols as its rhs.
+    let(:grammar_abc) do
+      builder = grammar_abc_builder
+      builder.grammar
+    end
+    
+    # Variables for the terminal symbols
+    let(:a_) { grammar_abc.name2symbol['a'] }
+    let(:b_) { grammar_abc.name2symbol['b'] }
+    let(:c_) { grammar_abc.name2symbol['c'] }
+    
+    # Helper method that mimicks the output of a tokenizer
+    # for the language specified by gramma_abc
+    let(:grm_abc_tokens1) do
+      [
+        Parser::Token.new('a', a_),
+        Parser::Token.new('a', a_),
+        Parser::Token.new('b', b_),
+        Parser::Token.new('c', c_),
+        Parser::Token.new('c', c_)
+      ]
+    end
+
+    # Factory method that builds a sample parse tree.
+    # Generated tree has the following structure:
+    # S[0,5]
+    # +- A[0,5]
+    #    +- a[0,0]
+    #    +- A[1,4]
+    #    |  +- a[1,1]
+    #    |  +- A[2,3]
+    #    |  |  +- b[2,3]
+    #    |  +- c[3,4]
+    #    +- c[4,5]
+    # Capital letters represent non-terminal nodes
+    let(:grm_abc_ptree1) do
+      parser = Parser::EarleyParser.new(grammar_abc)
+      parse_result = parser.parse(grm_abc_tokens1)
+      parse_result.parse_tree
+    end
+  
+  let(:destination) { StringIO.new('', 'w') }
+
+  context 'Standard creation & initialization:' do
+
+    it 'should be initialized with an IO argument' do
+      expect { Debug.new(StringIO.new('', 'w')) }.not_to raise_error
+    end
+    
+    it 'should know its output destination' do
+      instance = Debug.new(destination)
+      expect(instance.output).to eq(destination)
+    end
+  end # context
+  
+
+ 
+  context 'Formatting events:' do   
+    it 'should support visit events of a parse tree' do
+      instance = Debug.new(destination)
+      visitor = Rley::ParseTreeVisitor.new(grm_abc_ptree1)
+      instance.render(visitor)
+      expectations = <<-SNIPPET
+before_ptree
+  before_non_terminal
+    before_children
+      before_non_terminal
+        before_children
+          before_terminal
+          after_terminal
+          before_non_terminal
+            before_children
+              before_terminal
+              after_terminal
+              before_non_terminal
+                before_children
+                  before_terminal
+                  after_terminal
+                after_children
+              after_non_terminal
+              before_terminal
+              after_terminal
+            after_children
+          after_non_terminal
+          before_terminal
+          after_terminal
+        after_children
+      after_non_terminal
+    after_children
+  after_non_terminal
+after_ptree
+SNIPPET
+      expect(destination.string).to eq(expectations)
+    end
+  end # context
+end # describe
+
+end # module
+end # module
+
+# End of file

data/spec/rley/parse_tree_visitor_spec.rb

@@ -1,6 +1,7 @@
 require_relative '../spec_helper'
 
-require_relative '../../lib/rley/syntax/grammar_builder'
+
+require_relative './support/grammar_abc_helper'
 require_relative '../../lib/rley/parser/token'
 require_relative '../../lib/rley/parser/earley_parser'
 # Load the class under test
@@ -8,12 +9,10 @@ require_relative '../../lib/rley/parse_tree_visitor'
 
 module Rley # Open this namespace to avoid module qualifier prefixes
   describe ParseTreeVisitor do
+    include GrammarABCHelper  # Mix-in module with builder for grammar abc
+    
     let(:grammar_abc) do
-      builder = Syntax::GrammarBuilder.new
-      builder.add_terminals('a', 'b', 'c')
-      builder.add_production('S' => ['A'])
-      builder.add_production('A' => %w(a A c))
-      builder.add_production('A' => ['b'])
+      builder = grammar_abc_builder
       builder.grammar
     end
 

data/spec/rley/support/grammar_abc_helper.rb

@@ -0,0 +1,19 @@
+# Load the builder class
+require_relative '../../../lib/rley/syntax/grammar_builder'
+
+
+module GrammarABCHelper
+
+  # Factory method. Creates a grammar builder for a simple grammar.
+  # (based on example in N. Wirth "Compiler Construction" book, p. 6)
+  def grammar_abc_builder()
+    builder = Rley::Syntax::GrammarBuilder.new
+    builder.add_terminals('a', 'b', 'c')
+    builder.add_production('S' => ['A'])
+    builder.add_production('A' => %w(a A c))
+    builder.add_production('A' => ['b'])
+
+    return builder
+  end
+end # module
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rley
 version: !ruby/object:Gem::Version
-  version: 0.1.04
+  version: 0.1.05
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -89,6 +89,8 @@ files:
 - examples/grammars/grammar_L0.rb
 - lib/rley.rb
 - lib/rley/constants.rb
+- lib/rley/formatter/base_formatter.rb
+- lib/rley/formatter/debug.rb
 - lib/rley/parser/chart.rb
 - lib/rley/parser/dotted_item.rb
 - lib/rley/parser/earley_parser.rb
@@ -111,6 +113,7 @@ files:
 - lib/rley/syntax/symbol_seq.rb
 - lib/rley/syntax/terminal.rb
 - lib/rley/syntax/verbatim_symbol.rb
+- spec/rley/formatter/debug_spec.rb
 - spec/rley/parser/chart_spec.rb
 - spec/rley/parser/dotted_item_spec.rb
 - spec/rley/parser/earley_parser_spec.rb
@@ -123,6 +126,7 @@ files:
 - spec/rley/ptree/parse_tree_node_spec.rb
 - spec/rley/ptree/parse_tree_spec.rb
 - spec/rley/ptree/token_range_spec.rb
+- spec/rley/support/grammar_abc_helper.rb
 - spec/rley/syntax/grammar_builder_spec.rb
 - spec/rley/syntax/grammar_spec.rb
 - spec/rley/syntax/grm_symbol_spec.rb
@@ -165,6 +169,7 @@ signing_key:
 specification_version: 4
 summary: Ruby implementation of the Earley's parsing algorithm
 test_files:
+- spec/rley/formatter/debug_spec.rb
 - spec/rley/parser/chart_spec.rb
 - spec/rley/parser/dotted_item_spec.rb
 - spec/rley/parser/earley_parser_spec.rb