l43_peg 0.0.1 → 0.1.1

data/README.md

@@ -1,91 +1,84 @@
-# l43_my_ruby
+# L43Peg
 
+## A Parse Expression Grammar library for Ruby
 
-## Getting started
+### This Version (v0.1.x) is Alpha Quality (many PEG features are missing, like recursion and even alternatives.
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+It is however released because it offers quite some nice parsing of ARGV which shall be demonstrated by the following
+[speculations](https://rubygems.org/gems/speculate_about)
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+See [README_spec.rb](spec/speculations/README_spec.rb) for the generated code for details
 
-## Add your files
+### Context: `arg_parser`
 
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
+Given the following argument specification
 
+```ruby 
+  include L43Peg::Combinators
+   let :args_spec do
+       {
+          start: "--start=(.*)",
+          end: "(?:--end|-e)=(.*)",
+          kwd: "--(alpha|beta|gamma)"
+       }
+   end
 ```
-cd existing_repo
-git remote add origin https://gitlab.com/lab421/l43_my_ruby.git
-git branch -M main
-git push -uf origin main
-```
-
-## Integrate with your tools
-
-- [ ] [Set up project integrations](https://gitlab.com/lab421/l43_my_ruby/-/settings/integrations)
-
-## Collaborate with your team
-
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
-
-## Test and Deploy
-
-Use the built-in continuous integration in GitLab.
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+And the assoicated parser
 
-***
+```ruby
+   let(:parser) { args_parser(args_spec) } 
+```
 
-# Editing this README
+Then we can parse some input
 
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
+```ruby
+    assert_parse_success(parser, %w[--start=42 --beta -e=44], ast: {start: "42", kwd: "beta", end: "44"}, rest: [])
+```
 
-## Suggestions for a good README
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
+And we can get the rest in a list of tokens
 
-## Name
-Choose a self-explaining name for your project.
+```ruby
+    assert_parse_success(parser, %w[--start=42 --beta -e=44 -s=not_an_arg --end=too_late], ast: {start: "42", kwd: "beta", end: "44"}, rest: %w[-s=not_an_arg --end=too_late])
+```
 
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
+Also note that multiple values are passed into an array
 
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
+```ruby
+    input = %w[--end=42 --beta -e=44 --beta --end=not_too_late --gamma]
+    ast   = {end: %w[42 44 not_too_late], kwd: %w[beta beta gamma]}
+    assert_parse_success(parser, input, ast:, rest: [])
+```
 
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
+#### Context: Postprocessing
 
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
+When we map the parser
 
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
+```ruby
+   let :int_args do
+     {
+      start: "--start=(.*)",
+      end: "--end=(.*)",
+      inc: "--inc=(.*)"
+     }
+   end
+   let(:int_arg_parser) {args_parser(int_args, name: "int parser", &:to_i)}
+```
 
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
+Then we can convert the string valus
 
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
+```ruby
+    assert_parse_success(parser, %w[--start=42 --end=44 --inc=2], ast: {start: 42, end: 44, inc: 2}, rest: [])
+```
 
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
 
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
+## Author
 
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
+Copyright © 2024 Robert Dober
+robert.dober@gmail.com
 
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
+# LICENSE
 
-## License
-For open source projects, say how it is licensed.
+GNU AFFERO GENERAL PUBLIC LICENSE, Version 3, 19 November 2007. Please refer to [LICENSE](LICENSE) for details.
 
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+<!-- SPDX-License-Identifier: AGPL-3.0-or-later -->

data/lib/l43/match_data_extenstion.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+class MatchData
+  def deconstruct(*) = to_a
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43/open_object.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module L43
+  module OpenObject
+    def attributes(*atts, **defaults)
+      attr_reader(*atts)
+      attr_reader(*defaults.keys)
+
+      define_method :== do |other|
+        other&.to_h == to_h
+      end
+
+      define_method :initialize do |**kwds|
+        missing = atts - kwds.keys
+        raise ArgumentError, "missing required keyword parameters: #{missing.inspect}" unless missing.empty?
+        spurious = kwds.keys - atts - defaults.keys
+        raise ArgumentError, "spurious keyword parameters: #{spurious.inspect}" unless spurious.empty?
+
+        values = defaults.merge(kwds)
+        values.each do |key, value|
+          instance_variable_set("@#{key}", value)
+        end
+        _init if respond_to?(:_init)
+      end
+
+      define_method :to_h do |*|
+        first = atts.inject Hash.new do |h, attribute|
+          h.update(attribute => send(attribute))
+        end
+      defaults.keys.inject first do |h, attribute|
+        h.update(attribute => send(attribute))
+      end
+      end
+      alias_method :deconstruct_keys, :to_h
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43/require_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class Object
+  def require_subdir(path=nil, &blk)
+    Dir.glob(File.join([File.dirname(blk.source_location.first), path, '/**/*.rb'].compact)).each { require _1}
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43_peg/cache.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module L43Peg
+  class Cache
+    extend L43::OpenObject
+    attributes cache: {}
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/l43_peg/combinators/many.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "../helper"
+module L43Peg
+  module Combinators
+    module Many extend self
+
+      include L43Peg::Helper
+      def many(input:, cache:, name:, parser:, min:, max:)
+        curr_input = input
+        curr_cache = cache
+        count = 0
+        ast   = []
+
+        loop do
+          if max && count == max
+            return succeed_parser(ast, curr_input, cache: curr_cache)
+          end
+          case parser.(curr_input, cache: curr_cache)
+          in L43Peg::Success => success
+            ast.push(success.ast)
+            curr_input = success.rest
+            curr_cache = success.cache
+            count += 1
+          in L43Peg::Failure
+            if count < min
+              return fail_parser("many #{name} should match at least #{min} times but did only #{count} times")
+            end
+            return succeed_parser(ast, curr_input, cache: curr_cache)
+          end
+        end
+      end
+
+    end
+  end
+end
+
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43_peg/combinators/seq.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "../helper"
+module L43Peg
+  module Combinators
+    module Seq extend self
+
+      include L43Peg::Helper
+      def seq(input:, cache:, name:, parsers:)
+        curr_input = input
+        curr_cache = cache
+        ast = []
+        parsers.each do |parser|
+          case parser.(curr_input, cache: curr_cache)
+          in L43Peg::Failure => failure
+            return L43Peg::Failure.new(reason: "#{failure.reason} in (#{name})", position: failure.position, input:)
+          in L43Peg::Success => success
+            ast.push(success.ast)
+            curr_input = success.rest
+            curr_cache = success.cache
+          end
+        end
+        succeed_parser(ast, curr_input, cache: curr_cache) 
+      end
+
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43_peg/combinators.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require_relative 'helper'
+require_relative 'mappers'
+require_relative 'parser'
+require_relative 'parsers'
+require_subdir('combinators') {}
+
+module L43Peg
+  module Combinators extend self
+
+    include L43Peg::Helper
+    include L43Peg::Mappers
+    include L43Peg::Parsers
+
+    def args_parser(definitions, name: nil, &block)
+      parser = tokens_parser(definitions, &block)
+      name   = name || "args_parser(#{definitions.inspect})"
+      inner  = many(parser)
+      map(inner, name:, fn: join_maps)
+    end
+
+    def many(parser, name: nil, min: 0, max: nil)
+      Parser.new(name || "many(#{parser.name})") {|input, cache, name1=nil| Many.many(input:, cache:, name: name1 || name, parser:, min:, max:)}
+    end
+    
+    def map(parser, name: nil, fn: nil, &mapper)
+      raise ArgumentError, "must not provide keyword parameyer fn and a block" if fn && mapper
+      mapper = fn || mapper
+      raise ArgumentError, "must provide keyword parameyer fn or a block" unless mapper
+      Parser.new(name || "map(#{parser.name})") {|input, cache, name=nil| _map(input:, cache:, name:, parser:, mapper:)}
+    end
+
+    def seq(*parsers, name: nil)
+      name ||= "seq(#{parsers.map(&:name).join(", ")})"
+      Parser.new(name) {|input, cache, _name=nil| Seq.seq(input:, cache:, name:, parsers:)}
+    end
+
+    private
+
+    def _map(input:, cache:, name:, parser:, mapper:)
+      case parser.(input, cache:)
+      in L43Peg::Failure => failure
+        failure
+      in L43Peg::Success => success
+        success.map(&mapper)
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43_peg/failure.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module L43Peg
+  class Failure
+    extend L43::OpenObject
+    attributes cache: nil, input: nil, parsed_by: nil, position: [1, 1], reason: ""
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/l43_peg/helper.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module L43Peg
+  module Helper
+    def fail_parser(reason)
+      L43Peg::Failure.new(reason:)
+    end
+    def succeed_parser(ast, input, cache: nil)
+      L43Peg::Success.new(ast:, rest: input, cache: cache || input.cache)
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43_peg/input.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module L43Peg
+  class Input
+    extend L43::OpenObject
+
+    attributes col: 1, input: "", lnb: 1, context: {}
+    
+    def drop(by=nil)
+      case by
+      when nil
+        _drop_by_n(1)
+      when String
+        _drop_by_n(by.length)
+      else
+        _drop_by_n(by)
+      end
+    end
+
+    def empty? = input.empty?
+
+    def position = [@col, @lnb]
+
+    private
+
+    def _drop_by_n(n)
+      return self if input.empty?
+      _split(n) => col, lnb, head, tail
+      self.class.new(input: tail, context:, col:, lnb:)
+    end
+
+    # Very inefficent but sufficent for my use cases so far
+    # and convenient for regex parsers
+    def _split(n)
+      head = input.slice(0...n)
+      lines = head.count("\n")
+      tail = input.slice(n..-1) || ''
+      new_col = 
+        if lines.zero?
+          col + n
+        else
+          1 + head.sub(%r{\A.*\n}m, "").length
+        end
+      [new_col, lnb + lines, head, tail]
+    end
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/l43_peg/mappers.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module L43Peg
+  module Mappers
+
+    def join_and_to_i
+      -> list do
+        list.join.to_i
+      end
+    end
+    
+    def join_maps
+      -> maps do
+        maps.reduce Hash.new do |map, entry|
+          map.merge(entry) { |*args| args.drop(1).flatten }
+        end
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/l43_peg/parser.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module L43Peg
+  class Parser
+
+    attr_reader :fn, :name
+
+    def call(input, cache: L43Peg::Cache.new) = fn.(input, cache, name)
+
+    private
+
+    def initialize(name, &fn)
+      @name = name
+      @fn = fn
+    end
+    
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/l43_peg/parsers/char_parser.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module L43Peg
+  module Parsers
+    class CharParser < L43Peg::Parser
+
+      private
+
+      def initialize(charset=nil)
+        charset = _mk_set(charset)
+        super("char_parser(#{charset})") do |input, cache, name|
+          if input.input.empty?
+            L43Peg::Failure.new(cache:, input:, parsed_by: self, reason: "cannot parse at end of input #{name}")
+          elsif charset.nil? || charset.member?(input.input[0])
+            L43Peg::Success.new(ast: input.input[0], cache:, rest: input.drop, position: input.position)
+          else
+            L43Peg::Failure.new(cache:, input:, parsed_by: self, reason: "char #{input.input[0].inspect}")
+          end
+        end
+      end
+
+      def _mk_set(charset)
+        return unless charset
+        case charset
+        when String
+          Set.new(charset.split(""))
+        when Set
+          charset
+        else
+          Set.new(charset)
+        end
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43_peg/parsers/end_parser.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../parsers'
+
+module L43Peg
+  module Parsers
+    class EndParser < L43Peg::Parser
+
+      def self.instance
+        @__instance__ ||= new
+      end
+
+      private
+
+      def initialize
+        super('end_parser') do |input, cache, _name=nil|
+          if input.input.empty?
+            L43Peg::Success.new(cache:, rest: input, position: input.position)
+          else
+            L43Peg::Failure.new(cache:, input:, parsed_by: self, reason: "not at end of input")
+          end
+        end
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/l43_peg/parsers/failure_parser.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module L43Peg
+  module Parsers
+    class FailureParser < L43Peg::Parser
+
+      def self.instance
+        @__instance__ ||= new
+      end
+
+      private
+
+      def initialize
+        super('failure_parser') do |input, cache, _name=nil|
+          L43Peg::Failure.new(cache:, input:, parsed_by: self, reason: "this parser always fails")
+        end
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43_peg/parsers/int_parser.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative '../parsers'
+
+module L43Peg
+  module Parsers
+    class IntParser < L43Peg::Parser
+      extend L43Peg::Combinators
+      extend L43Peg::Mappers
+
+      class << self
+        def instance
+          @__instance__ ||= _mk_int_parser
+        end
+
+        private
+
+        def _mk_int_parser
+          map(seq(many(Parsers.char_parser("+-"), max: 1), many(Parsers.char_parser("0".."9"), min: 1), name: "int_parser"), &join_and_to_i)
+        end
+      end
+
+    end
+  end
+end
+# SPDX-License-Identifier: Apache-2.0

data/lib/l43_peg/parsers/rgx_parser.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module L43Peg
+  module Parsers
+    class RgxParser < L43Peg::Parser
+
+      private
+
+      def initialize(rgx, name: nil, **options)
+        name = name || "rgx_parser(#{rgx.inspect})"
+        rgx = _mk_rgx(rgx)
+        super(name) do |input, cache, _name|
+          case rgx.match(input.input)
+          in MatchData => md
+            ast = _from_match(md, options) 
+            L43Peg::Success.new(ast:, cache:, rest: input.drop(md[0]), position: input.position)
+          else
+            L43Peg::Failure.new(cache:, input:, parsed_by: self, reason: "input does not match #{rgx.inspect} (in #{name})")
+          end
+        end
+      end
+
+      def _from_match(md, options)
+        case options[:capture]
+        in NilClass
+          md[1] || md[0]
+        in Integer => n
+          md[n]
+        in :all
+          md.to_a
+        end
+      end
+
+      def _mk_rgx(rgx)
+        case rgx
+        when String
+          Regexp.compile("\\A#{rgx}")
+        else
+         rgx
+        end
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later

data/lib/l43_peg/parsers/token_parser.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module L43Peg
+  module Parsers
+    class TokenParser < L43Peg::Parser
+
+      private
+
+      def initialize(token_spec, name: nil, **options)
+        _check_arg!(token_spec)
+        name = name || "token_parser(#{token_spec.inspect})"
+        super(name) do |tokens, cache, _name|
+          if result = tokens.match(token_spec, options[:capture])
+            L43Peg::Success.new(ast: result, cache:, rest: tokens.drop(1), position: tokens.position)
+          else
+            reason = "token #{tokens.head.inspect} does not match #{token_spec.inspect} (in #{name})"
+            L43Peg::Failure.new(cache:, input: tokens, parsed_by: self, reason:)
+          end
+        end
+      end
+
+      def _check_arg!(token_spec)
+        case token_spec
+        when Regexp, String
+        else
+          raise ArgumentError, "#{token_spec.inspect} must be a regular expression or a string"
+        end
+      end
+    end
+  end
+end
+# SPDX-License-Identifier: AGPL-3.0-or-later