dendroid 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2c0559bafc9e9cb01c84eff72c403a538e744b88fb12b02f59f2e2de6cfb8a93
+  data.tar.gz: 238e91d9e6e909062c7fca3fb8a9455795fb6f24861fd5ad3be973bdda2c4269
+SHA512:
+  metadata.gz: 779c2551fc57e8f2e0c185e5307815348bda51b2782f4b2fd616112e831cf847920f787b115c5d65035303bdab53aa2768f1f0a36e8c3da409fb4e8a7cd44094
+  data.tar.gz: 5be45c19d4d7ae74fc88333367362cf6c05f3278ecf94fe4110bd6f51db682edf33a1584155cfd3cffc67bc9c4efafa1c1e0444fa96a7bfea639539c1f9c4f69

data/.rubocop.yml

@@ -0,0 +1,8 @@
+Naming/MethodParameterName:
+  Enabled: false
+  
+Naming/VariableName:  
+  Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false

data/LICENSE

@@ -0,0 +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.

data/README.md

@@ -0,0 +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.

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run tests, with RSpec'
+task test: :spec
+
+task default: :test

data/bin/dendroid

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

data/dendroid.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |s|
+  s.name        = 'dendroid'
+  s.version     = '0.0.0'
+  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'
+  ]
+  s.homepage   = 'https://rubygems.org/gems/dendroid'
+  s.license    = 'MIT'
+end

data/lib/dendroid/syntax/grm_symbol.rb

@@ -0,0 +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

data/lib/dendroid/syntax/terminal.rb

@@ -0,0 +1,40 @@
+# 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 terminal symbol corresponds to an input token,
+      # so it is by definition non-nullable.
+      # @return [FalseClass]
+      def nullable?
+        false
+      end
+
+      # Predicate method to check whether the symbol 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

@@ -0,0 +1,43 @@
+# 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

data/spec/dendroid/syntax/terminal_spec.rb

@@ -0,0 +1,29 @@
+# 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

@@ -0,0 +1,13 @@
+# 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

@@ -0,0 +1 @@
+0.0.0

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: dendroid
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Dimitri Geshef
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-27 00:00:00.000000000 Z
+dependencies: []
+description: WIP. A Ruby implementation of a Earley parser
+email: famished.tiger@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- LICENSE
+- README.md
+- Rakefile
+- bin/dendroid
+- dendroid.gemspec
+- lib/dendroid/dendroid.rb
+- lib/dendroid/syntax/grm_symbol.rb
+- lib/dendroid/syntax/terminal.rb
+- spec/dendroid/syntax/grm_symbol_spec.rb
+- spec/dendroid/syntax/terminal_spec.rb
+- spec/spec_helper.rb
+- version.txt
+homepage: https://rubygems.org/gems/dendroid
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Dendroid. TODO
+test_files: []