dendroid 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ff4ff7eb5079476c9a8e2dffc5bfa1a52fe1d801f03f275a89815c272a806805
-  data.tar.gz: 34ea2ca6aa3eb8370a818f87a39ede323422acbf2007a63cf5c2524a41f85064
+  metadata.gz: 869334c2ae25a3765d7105eca383f1ba89162ae9a9446a2b5268a0d463261cc7
+  data.tar.gz: 7811bca0c671959b90618a8e667c57da65ed2c5d8ccc4171a86e0c8a3a80a6c0
 SHA512:
-  metadata.gz: d77f31670304b1a34c9ce7dd596bdc221a78d607e0f2a1b820f31b8b82f0c1da41a031bc33d7829296acba4c613299428962567f3942ee3843edbd8e64c908ce
-  data.tar.gz: 28515f2fb59f08da94a6af6cd3b05dbacf1c10ebe9bc49c1f44e312b4f3d2d1068d6699f8cbe2d6aae0f1a75be9ccf7177c6b17c91ac836441cc41c2eb541c5d
+  metadata.gz: 582c360f25cab435de732a6a7837461302a4af9325f6ddf93448be3c9f674acf59c05e6aa756d21a7ea805c1c55373bed298c4c659844fb67781f51c3444bf67
+  data.tar.gz: 52a3e9325988a534998dbbfb35471220c087702f7a97df0acc77c62ef55202be4cb5a858fe16e77ee525f4bfb98ff6fa7756fb99689ce980a8e02cd38ab24aa0

data/.rubocop.yml

@@ -1,3 +1,11 @@
+Layout/EndOfLine:
+  Enabled: true
+  EnforcedStyle: lf
+
+Metrics/BlockLength:
+  Enabled: true
+  Max: 50
+
 Naming/MethodParameterName:
   Enabled: false
   

data/LICENSE

@@ -1,22 +1,22 @@
-The MIT License
-
-Copyright (c) 2023 Dimitri Geshef
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The MIT License
+
+Copyright (c) 2023 Dimitri Geshef
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,60 +1,60 @@
-dendroid
-===========
-
-FIXME (describe your package)
-
-Features
---------
-
-* FIXME (list of features and unsolved problems)
-
-Examples
---------
-
-    FIXME (code sample of usage)
-
-Requirements
-------------
-
-* FIXME (list of requirements)
-
-Install
--------
-
-* FIXME (sudo gem install, anything else)
-
-Author
-------
-
-Original author: FIXME (author's name)
-
-Contributors:
-
-* FIXME (contributor 1?)
-* FIXME (contributor 2?)
-
-License
--------
-
-(The MIT License) FIXME (different license?)
-
-Copyright (c) 2023 FIXME (author's name)
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+dendroid
+===========
+
+A Ruby implementation of the Earley parsing algorithm. WIP
+
+Features
+--------
+
+* WIP 
+
+Examples
+--------
+
+    FIXME (code sample of usage)
+
+Requirements
+------------
+
+* FIXME (list of requirements)
+
+Install
+-------
+
+* FIXME (sudo gem install, anything else)
+
+Author
+------
+
+Original author: Dimitri Geshef
+
+Contributors:
+
+* FIXME (contributor 1?)
+* FIXME (contributor 2?)
+
+License
+-------
+
+(The MIT License)
+
+Copyright (c) 2023 Dimitri Geshef
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/bin/dendroid

@@ -1,7 +1,6 @@
-#!/usr/bin/env ruby
-
-root = File.expand_path('../..', __FILE__)
-require File.join(root, %w[lib dendroid])
-
-# Put your code here
-
+#!/usr/bin/env ruby
+
+root = File.expand_path('../..', __FILE__)
+require File.join(root, %w[lib dendroid])
+
+# Put your code here

data/dendroid.gemspec

@@ -3,25 +3,26 @@
 Gem::Specification.new do |s|
   s.name        = 'dendroid'
   s.version     = begin
-                    LIBPATH = ::File.expand_path( __FILE__) + ::File::SEPARATOR
-                    PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
-                    ::File.read(PATH + 'version.txt').strip
-                  end
+    libpath = ::File.expand_path(__FILE__) + ::File::SEPARATOR
+    path = ::File.dirname(libpath) + ::File::SEPARATOR
+    ::File.read("#{path}version.txt").strip
+  end
   s.summary     = 'Dendroid. TODO'
   s.description = 'WIP. A Ruby implementation of a Earley parser'
   s.authors     = ['Dimitri Geshef']
   s.email       = 'famished.tiger@yahoo.com'
   s.files       = Dir['bin/dendroid',
-    'lib/*.*',
-    'lib/**/*.rb',
-    'spec/**/*.rb',
-    '.rubocop.yml',
-    'dendroid.gemspec',
-    'LICENSE',
-    'Rakefile',
-    'README.md',
-    'version.txt'
+                      'lib/*.*',
+                      'lib/**/*.rb',
+                      'spec/**/*.rb',
+                      '.rubocop.yml',
+                      'dendroid.gemspec',
+                      'LICENSE',
+                      'Rakefile',
+                      'README.md',
+                      'version.txt'
   ]
+  s.required_ruby_version = '>=3.1'
   s.homepage   = 'https://github.com/famished-tiger/Dendroid'
   s.license    = 'MIT'
 end

data/lib/dendroid/dendroid.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+# Namespace for all modules, classes and constants from Dendroid library.
+module Dendroid
+end # module

data/lib/dendroid/syntax/grm_symbol.rb

@@ -1,45 +1,45 @@
-# frozen_string_literal: true
-
-module Dendroid
-  module Syntax
-    # Abstract class for grammar symbols.
-    # A grammar symbol is an element that appears in grammar rules.
-    class GrmSymbol
-      # @return [String] The name of the grammar symbol
-      attr_reader :name
-
-      # Constructor.
-      # aSymbolName [String] The name of the grammar symbol.
-      def initialize(symbolName)
-        @name = valid_name(symbolName)
-      end
-
-      # The String representation of the grammar symbol
-      # @return [String]
-      def to_s
-        name.to_s
-      end
-
-      # Equality testing (based on symbol name)
-      # @return [Boolean]
-      def ==(other)
-        name == other.name
-      end
-
-      private
-
-      def valid_name(symbolName)
-        if symbolName.is_a?(String)
-          stripped = symbolName.strip
-          if stripped.empty?
-            err_msg = 'A symbol name cannot be empty.'
-            raise StandardError, err_msg
-          end
-          stripped.to_sym
-        else
-          symbolName
-        end
-      end
-    end # class
-  end # module
-end # module
+# frozen_string_literal: true
+
+module Dendroid
+  module Syntax
+    # Abstract class for grammar symbols.
+    # A grammar symbol is an element that appears in grammar rules.
+    class GrmSymbol
+      # @return [String] The name of the grammar symbol
+      attr_reader :name
+
+      # Constructor.
+      # aSymbolName [String] The name of the grammar symbol.
+      def initialize(symbolName)
+        @name = valid_name(symbolName)
+      end
+
+      # The String representation of the grammar symbol
+      # @return [String]
+      def to_s
+        name.to_s
+      end
+
+      # Equality testing (based on symbol name)
+      # @return [Boolean]
+      def ==(other)
+        name == other.name
+      end
+
+      private
+
+      def valid_name(symbolName)
+        if symbolName.is_a?(String)
+          stripped = symbolName.strip
+          if stripped.empty?
+            err_msg = 'A symbol name cannot be empty.'
+            raise StandardError, err_msg
+          end
+          stripped.to_sym
+        else
+          symbolName
+        end
+      end
+    end # class
+  end # module
+end # module

data/lib/dendroid/syntax/non_terminal.rb

@@ -1,43 +1,38 @@
-# frozen_string_literal: true
-require_relative 'grm_symbol'
-
-module Dendroid
-  module Syntax
-    # A non-terminal symbol (sometimes called a syntactic variable) represents
-    # a composition of terminal or non-terminal symbols
-    class NonTerminal < GrmSymbol
-      # @return [Boolean] true if symbol can derive the null token
-      attr_accessor :nullable
-
-      # @return [Boolean] true iff the symbol always matches a non-empty
-      #   sequence of terminal symbols
-      attr_accessor :productive
-
-      # Constructor.
-      # aSymbolName [String] The name of the grammar symbol.
-      def initialize(symbolName)
-        super(symbolName)
-      end
-
-      # Predicate method to check whether the symbol is a terminal symbol.
-      # @return [FalseClass]
-      def terminal?
-        false
-      end
-
-      # Predicate method to check whether the symbol can derive (match)
-      # the null token.
-      # @return [Boolean]
-      def nullable?
-        @nullable
-      end
-
-      # Predicate method to check whether the symbol always matches
-      # a non-empty sequence of terminal symbols.
-      # @return [Boolean]
-      def productive?
-        @productive
-      end
-    end # class
-  end # module
-end # module
+# frozen_string_literal: true
+
+require_relative 'grm_symbol'
+
+module Dendroid
+  module Syntax
+    # A non-terminal symbol (sometimes called a syntactic variable) represents
+    # a composition of terminal or non-terminal symbols
+    class NonTerminal < GrmSymbol
+      # @return [Boolean] true if symbol can derive the null token
+      attr_accessor :nullable
+
+      # @return [Boolean] true iff the symbol always matches a non-empty
+      #   sequence of terminal symbols
+      attr_accessor :productive
+
+      # Predicate method to check whether the symbol is a terminal symbol.
+      # @return [FalseClass]
+      def terminal?
+        false
+      end
+
+      # Predicate method to check whether the symbol can derive (match)
+      # the null token.
+      # @return [Boolean]
+      def nullable?
+        @nullable
+      end
+
+      # Predicate method to check whether the symbol always matches
+      # a non-empty sequence of terminal symbols.
+      # @return [Boolean]
+      def productive?
+        @productive
+      end
+    end # class
+  end # module
+end # module

data/lib/dendroid/syntax/rule.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Dendroid
+  module Syntax
+    # In a context-free grammar, a rule has its left-hand side (LHS)
+    # that consists solely of one non-terminal symbol.
+    # and the right-hand side (RHS) consists of one or more sequence of symbols.
+    # The symbols in RHS can be either terminal or non-terminal symbols.
+    # The rule stipulates that the LHS is equivalent to the RHS,
+    # in other words every occurrence of the LHS can be substituted to
+    # corresponding RHS.
+    class Rule
+      # @return [Dendroid::Syntax::NonTerminal] The left-hand side of the rule.
+      attr_reader :head
+      alias lhs head
+
+      # Create a Rule instance.
+      # @param lhs [Dendroid::Syntax::NonTerminal] The left-hand side of the rule.
+      def initialize(lhs)
+        @head = valid_head(lhs)
+      end
+
+      # Return the text representation of the rule
+      # @return [String]
+      def to_s
+        head.to_s
+      end
+
+      # The set of all grammar symbols that occur in the rhs.
+      # @return [Array<Dendroid::Syntax::GrmSymbol>]
+      def rhs_symbols
+        symbols = rhs.reduce([]) do |result, alt|
+          result.concat(alt.members)
+        end
+        symbols.uniq
+      end
+
+      # The set of all non-terminal symbols that occur in the rhs.
+      # @return [Array<Dendroid::Syntax::NonTerminal>]
+      def nonterminals
+        rhs_symbols.reject(&:terminal?)
+      end
+
+      # The set of all terminal symbols that occur in the rhs.
+      # @return [Array<Dendroid::Syntax::Terminal>]
+      def terminals
+        rhs_symbols.select(&:terminal?)
+      end
+
+      private
+
+      def valid_head(lhs)
+        if lhs.terminal?
+          err_msg = "Terminal symbol '#{lhs}' may not be on left-side of a rule."
+          raise StandardError, err_msg
+        end
+
+        lhs
+      end
+    end # class
+  end # module
+end # module

data/lib/dendroid/syntax/symbol_seq.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require_relative 'grm_symbol'
+
+module Dendroid
+  module Syntax
+    # A sequence of grammar symbols. This class is used to represent
+    # members of right-hand side of production rules
+    class SymbolSeq
+      extend Forwardable
+
+      # @return [Array<Dendroid::Syntax::GrmSymbol>] The sequence of symbols
+      attr_reader :members
+
+      def_delegators(:@members, :empty?, :first, :map, :size)
+
+      # Create a sequence of grammar symbols (as in right-hand side of
+      # a production rule).
+      # @param symbols [Array<Dendroid::Syntax::GrmSymbol>] An array of symbols.
+      def initialize(symbols)
+        @members = symbols
+      end
+
+      # @return [String] A text representation of the symbol sequence
+      def to_s
+        members.join(' ')
+      end
+
+      # Retrieve all the non-terminal symbols in the sequence.
+      # @return [Array<Dendroid::Syntax::NonTerminal>] array of non-terminals.
+      def nonterminals
+        members.reject(&:terminal?)
+      end
+
+      # Retrieve all the terminal symbols in the sequence.
+      # @return [Array<Dendroid::Syntax::Terminal>] array of terminals
+      def terminals
+        members.select(&:terminal?)
+      end
+
+      # Predicate method to check whether the sequence always derives (matches)
+      # a non-empty sequence of terminal symbols.
+      # @return [Boolean]
+      def productive?
+        empty? || members.all?(&:productive?)
+      end
+
+      # Equality operator.
+      # @param other [Dendroid::Syntax::SymbolSeq]
+      # @return [Boolean] true when members are equal to the ones from `other`
+      def ==(other)
+        members == other.members
+      end
+
+      private
+
+      def valid_members(symbols)
+        raise StandardError unless symbols.all? { |symb| symb.is_a?(GrmSymbol) }
+      end
+    end # class
+  end # module
+end # module

data/lib/dendroid/syntax/terminal.rb

@@ -1,40 +1,39 @@
-# frozen_string_literal: true
-require_relative 'grm_symbol'
-
-module Dendroid
-  module Syntax
-    # A terminal symbol is an elementary symbol of the language defined by the grammar.
-    # More specifically, it represents a class of 'words'(or a token) of the language.
-    class Terminal < GrmSymbol
-      # Constructor.
-      # aSymbolName [String] The name of the grammar symbol.
-      def initialize(symbolName)
-        super(symbolName)
-        freeze
-      end
-
-      # Predicate method to check whether the symbol is a terminal symbol.
-      # @return [TrueClass]
-      def terminal?
-        true
-      end
-
-      # Predicate method to check whether the symbol derives (matches)
-      # the empty string. As a terminal symbol corresponds to an input token,
-      # it is by definition non-nullable.
-      # @return [FalseClass]
-      def nullable?
-        false
-      end
-
-      # Predicate method to check whether the symbol always matches
-      # a non-empty sequence of terminal symbols.
-      # @return [TrueClass]
-      def productive?
-        true
-      end
-    end # class
-  end # module
-end # module
-
-
+# frozen_string_literal: true
+
+require_relative 'grm_symbol'
+
+module Dendroid
+  module Syntax
+    # A terminal symbol is an elementary symbol of the language defined by the grammar.
+    # More specifically, it represents a class of 'words'(or a token) of the language.
+    class Terminal < GrmSymbol
+      # Constructor.
+      # aSymbolName [String] The name of the grammar symbol.
+      def initialize(symbolName)
+        super(symbolName)
+        freeze
+      end
+
+      # Predicate method to check whether the symbol is a terminal symbol.
+      # @return [TrueClass]
+      def terminal?
+        true
+      end
+
+      # Predicate method to check whether the symbol derives (matches)
+      # the empty string. As a terminal symbol corresponds to an input token,
+      # it is by definition non-nullable.
+      # @return [FalseClass]
+      def nullable?
+        false
+      end
+
+      # Predicate method to check whether the symbol always matches
+      # a non-empty sequence of terminal symbols.
+      # @return [TrueClass]
+      def productive?
+        true
+      end
+    end # class
+  end # module
+end # module

data/spec/dendroid/syntax/grm_symbol_spec.rb

@@ -1,43 +1,45 @@
-# frozen_string_literal: true
-
-require_relative '..\..\spec_helper'
-require_relative '..\..\..\lib\dendroid\syntax\grm_symbol'
-
-describe Dendroid::Syntax::GrmSymbol do
-  let(:sample_symbol_name) { 'INTEGER' }
-
-  subject { described_class.new(sample_symbol_name) }
-
-  context 'Initialization:' do
-    it 'is initialized with a name as String' do
-      expect { described_class.new(sample_symbol_name) }.not_to raise_error
-    end
-
-    it 'is initialized with a name as Symbol' do
-      expect { described_class.new(:INTEGER) }.not_to raise_error
-    end
-
-    it 'raises an error if the symbol name is empty' do
-      err_msg = 'A symbol name cannot be empty.'
-      expect { described_class.new('') }.to raise_error(StandardError, err_msg)
-    end
-  end # context
-
-  context 'Provided services:' do
-    it 'knows its name as a Symbol' do
-      expect(subject.name).to eq(sample_symbol_name.to_sym)
-    end
-
-    it 'renders a String representation of itself' do
-      expect(subject.to_s).to eq(sample_symbol_name)
-    end
-
-    it 'can compare with another symbol' do
-      expect(subject == subject).to be_truthy
-      same = described_class.new(sample_symbol_name)
-      expect(subject == same).to be_truthy
-      different = described_class.new('NUMBER')
-      expect(subject == different).to be_falsey
-    end
-  end # context
-end # describe
+# frozen_string_literal: true
+
+require_relative '..\..\spec_helper'
+require_relative '..\..\..\lib\dendroid\syntax\grm_symbol'
+
+describe Dendroid::Syntax::GrmSymbol do
+  let(:sample_symbol_name) { 'INTEGER' }
+
+  subject { described_class.new(sample_symbol_name) }
+
+  context 'Initialization:' do
+    it 'is initialized with a name as String' do
+      expect { described_class.new(sample_symbol_name) }.not_to raise_error
+    end
+
+    it 'is initialized with a name as Symbol' do
+      expect { described_class.new(:INTEGER) }.not_to raise_error
+    end
+
+    it 'raises an error if the symbol name is empty' do
+      err_msg = 'A symbol name cannot be empty.'
+      expect { described_class.new('') }.to raise_error(StandardError, err_msg)
+    end
+  end # context
+
+  context 'Provided services:' do
+    it 'knows its name as a Symbol' do
+      expect(subject.name).to eq(sample_symbol_name.to_sym)
+    end
+
+    it 'renders a String representation of itself' do
+      expect(subject.to_s).to eq(sample_symbol_name)
+    end
+
+    # rubocop: disable Lint/BinaryOperatorWithIdenticalOperands
+    it 'can compare with another symbol' do
+      expect(subject == subject).to be_truthy
+      same = described_class.new(sample_symbol_name)
+      expect(subject == same).to be_truthy
+      different = described_class.new('NUMBER')
+      expect(subject == different).to be_falsey
+    end
+    # rubocop: enable Lint/BinaryOperatorWithIdenticalOperands
+  end # context
+end # describe

data/spec/dendroid/syntax/non_terminal_spec.rb

@@ -1,16 +1,16 @@
-# frozen_string_literal: true
-
-require_relative '..\..\spec_helper'
-require_relative '..\..\..\lib\dendroid\syntax\non_terminal'
-
-describe Dendroid::Syntax::NonTerminal do
-  let(:sample_nonterminal_name) { 'EXPRESSION' }
-
-  subject { described_class.new(sample_nonterminal_name) }
-
-  context 'Provided services:' do
-    it 'knows it is not a terminal symbol' do
-      expect(subject.terminal?).to be_falsey
-    end
-  end # context
-end # describe
+# frozen_string_literal: true
+
+require_relative '..\..\spec_helper'
+require_relative '..\..\..\lib\dendroid\syntax\non_terminal'
+
+describe Dendroid::Syntax::NonTerminal do
+  let(:sample_nonterminal_name) { 'EXPRESSION' }
+
+  subject { described_class.new(sample_nonterminal_name) }
+
+  context 'Provided services:' do
+    it 'knows it is not a terminal symbol' do
+      expect(subject.terminal?).to be_falsey
+    end
+  end # context
+end # describe

data/spec/dendroid/syntax/rule_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '..\..\spec_helper'
+require_relative '..\..\..\lib\dendroid\syntax\terminal'
+require_relative '..\..\..\lib\dendroid\syntax\non_terminal'
+require_relative '..\..\..\lib\dendroid\syntax\rule'
+
+describe Dendroid::Syntax::Rule do
+  let(:num_symb) { Dendroid::Syntax::Terminal.new('NUMBER') }
+  let(:expr_symb) { Dendroid::Syntax::NonTerminal.new('expression') }
+
+  subject { described_class.new(expr_symb) }
+
+  context 'Initialization:' do
+    it 'is initialized with a non-terminal' do
+      expect { described_class.new(expr_symb) }.not_to raise_error
+    end
+
+    it 'knows its head (aka lhs)' do
+      expect(subject.head).to eq(expr_symb)
+    end
+  end # context
+end # describe

data/spec/dendroid/syntax/symbol_seq_spec.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative '..\..\spec_helper'
+require_relative '..\..\..\lib\dendroid\syntax\terminal'
+require_relative '..\..\..\lib\dendroid\syntax\non_terminal'
+require_relative '..\..\..\lib\dendroid\syntax\symbol_seq'
+
+describe Dendroid::Syntax::SymbolSeq do
+  let(:num_symb) { Dendroid::Syntax::Terminal.new('NUMBER') }
+  let(:plus_symb) { Dendroid::Syntax::Terminal.new('PLUS') }
+
+  subject { described_class.new([num_symb, plus_symb, num_symb]) }
+
+  context 'Initialization:' do
+    it 'is initialized with an empty array' do
+      expect { described_class.new([]) }.not_to raise_error
+    end
+
+    it 'is initialized with an array of GrmSymbols' do
+      expect { described_class.new([num_symb, plus_symb, num_symb]) }.not_to raise_error
+    end
+
+    it 'knows its members' do
+      expect(subject.members).to eq([num_symb, plus_symb, num_symb])
+    end
+  end # context
+
+  context 'Provided services:' do
+    let(:expr_symb) { Dendroid::Syntax::NonTerminal.new('PLUS') }
+
+    it 'knows whether its body empty is empty or not' do
+      expect(described_class.new([]).empty?).to be_truthy
+      expect(subject.empty?).to be_falsey
+    end
+
+    it 'renders a String representation of itself' do
+      expect(subject.to_s).to eq('NUMBER PLUS NUMBER')
+    end
+
+    it 'knows its non-terminal members' do
+      instance = described_class.new([expr_symb, plus_symb, expr_symb])
+      expect(instance.nonterminals).to eq([expr_symb, expr_symb])
+    end
+
+    it 'knows its terminal members' do
+      expect(subject.terminals).to eq([num_symb, plus_symb, num_symb])
+    end
+
+    # rubocop: disable Lint/BinaryOperatorWithIdenticalOperands
+    it 'can compare with another symbol sequence' do
+      expect(subject == subject).to be_truthy
+      same = described_class.new([num_symb, plus_symb, num_symb])
+      expect(subject == same).to be_truthy
+      different = described_class.new([num_symb, plus_symb, plus_symb])
+      expect(subject == different).to be_falsey
+
+      # Comparing two empty sequences
+      empty = described_class.new([])
+      void = described_class.new([])
+      expect(empty == void).to be_truthy
+    end
+    # rubocop: enable Lint/BinaryOperatorWithIdenticalOperands
+
+    it 'knows whether it is productive' do
+      # Case: all members are productive
+      expect(subject.productive?).to be_truthy
+
+      # Case: at least one member is non-productive (expr_symb.productive is nil)
+      instance = described_class.new([expr_symb, plus_symb, num_symb])
+      expect(instance.productive?).to be_falsey
+    end
+  end # context
+end # describe

data/spec/dendroid/syntax/terminal_spec.rb

@@ -1,29 +1,28 @@
-# frozen_string_literal: true
-
-require_relative '..\..\spec_helper'
-require_relative '..\..\..\lib\dendroid\syntax\terminal'
-
-describe Dendroid::Syntax::Terminal do
-  let(:sample_terminal_name) { 'INTEGER' }
-
-  subject { described_class.new(sample_terminal_name) }
-
-  context 'Provided services:' do
-    it 'knows it is a terminal symbol' do
-      expect(subject.terminal?).to be_truthy
-    end
-
-    it 'is frozen after initialization' do
-      expect(subject).to be_frozen
-    end
-
-    it 'is not nullable' do
-      expect(subject).not_to be_nullable
-    end
-
-    it 'is productive (generative)' do
-      expect(subject).to be_productive
-    end
-  end # context
-end # describe
-
+# frozen_string_literal: true
+
+require_relative '..\..\spec_helper'
+require_relative '..\..\..\lib\dendroid\syntax\terminal'
+
+describe Dendroid::Syntax::Terminal do
+  let(:sample_terminal_name) { 'INTEGER' }
+
+  subject { described_class.new(sample_terminal_name) }
+
+  context 'Provided services:' do
+    it 'knows it is a terminal symbol' do
+      expect(subject.terminal?).to be_truthy
+    end
+
+    it 'is frozen after initialization' do
+      expect(subject).to be_frozen
+    end
+
+    it 'is not nullable' do
+      expect(subject).not_to be_nullable
+    end
+
+    it 'is productive (generative)' do
+      expect(subject).to be_productive
+    end
+  end # context
+end # describe

data/spec/spec_helper.rb

@@ -1,13 +1,12 @@
-# frozen_string_literal: true
-
-# require 'rubygems'
-require 'rspec'
-
-RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = ".rspec_status"
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-end
-
+# frozen_string_literal: true
+
+# require 'rubygems'
+require 'rspec'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/version.txt

@@ -1 +1 @@
-0.0.1
+0.0.3

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dendroid
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
 platform: ruby
 authors:
 - Dimitri Geshef
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-27 00:00:00.000000000 Z
+date: 2023-10-28 00:00:00.000000000 Z
 dependencies: []
 description: WIP. A Ruby implementation of a Earley parser
 email: famished.tiger@yahoo.com
@@ -25,9 +25,13 @@ files:
 - lib/dendroid/dendroid.rb
 - lib/dendroid/syntax/grm_symbol.rb
 - lib/dendroid/syntax/non_terminal.rb
+- lib/dendroid/syntax/rule.rb
+- lib/dendroid/syntax/symbol_seq.rb
 - lib/dendroid/syntax/terminal.rb
 - spec/dendroid/syntax/grm_symbol_spec.rb
 - spec/dendroid/syntax/non_terminal_spec.rb
+- spec/dendroid/syntax/rule_spec.rb
+- spec/dendroid/syntax/symbol_seq_spec.rb
 - spec/dendroid/syntax/terminal_spec.rb
 - spec/spec_helper.rb
 - version.txt
@@ -43,7 +47,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="