l43_peg 0.1.5 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 733dffa78d9d7b41f75297f5d9f3b2d8e77212df079cd0643d39fc876b87f91d
-  data.tar.gz: c392f1ece61f72a537f673ec9f4f0b235eb6319ea0a90cf553ce11415f396d7f
+  metadata.gz: 373ca9885275389a284235de2dc5f95eb2f470aeece99bf47e9b54ed6e3fdf60
+  data.tar.gz: 62ac1897c26b540da5205d7b0fcb6aa1ff472f036e36ca5389c3ac4767fbf926
 SHA512:
-  metadata.gz: 518b0be6499f49df9ec63c334e4067f1b679d592eed92150b17057f71b4eaa54527339e30e2c48f1a7dbd2538cffc2b9c1df16de318857309b097be7ce475c4e
-  data.tar.gz: 3be2dfb70569649ae360192b0fca8f6beb923127a8020992881b158cc11fc2954848a424ba7ee8801410a4882c4b3246a9ec9716e31eaf482c1ba5b98d2b8326
+  metadata.gz: b51cd93714348ba6be2394cd63543603af953820394a6cc201a39c4721d1a10a4ec4bf224ad84c3a9eae49f426126da35dcc0b8cd751f9d6e6265f0341172daf
+  data.tar.gz: edbcd0d28cedcb395a6721a28f5f2284fefdaa28c1d7eb6449d8f53a90a00219177aace6e15208f87bd12488ab01712aa015b75179d0195decc34b1d78bba1a7

data/README.md

@@ -101,7 +101,49 @@ Then parsing the following input
     assert_parse_success(wh_parser, input, ast:, rest: %w[w:74])
 ```
 
-## Author
+### Context: User Interface
+
+#### Context: Exposing the args_parser
+
+Above we have seen that we had to include an internal module so to get access to the `args_parser`.
+Client code might not want to use these intrusive methods and therefore the parsers are also exposed
+as module methods
+
+Given an _exposed_ `args_parser`
+```ruby
+   let :parser do
+     L43Peg::Parsers.args_parser(
+       {
+          negative: "(-\\d+)",
+          positive: "\\+?(\\d+)"
+       },
+       &:to_i
+     )
+   end
+```
+
+But we are also not interested in the internal representation of success and failure of parsing which was
+used in the speculations above. Nor do we want to transform our input into the internal representations
+as was done above by the helpers. (If you need to see the details of this you can inspect the
+file [`parser_test.rb` in `spec/support`](spec/support/parser_test.rb))
+   
+Then we can uses the interface of `L43Peg`
+
+```ruby
+   L43Peg.parse_tokens(parser, %w[43 -44 +45]) => :ok, result
+   expect(result).to eq(positive: [43, 45], negative: -44)
+```
+
+And if we get an error the result is as follows
+
+```ruby
+   parser = L43Peg::Parsers.char_parser('a') 
+   L43Peg.parse_string(parser, 'b') => :error, message
+   expect(message).to eq("char \"b\"")
+```
+
+
+# Author
 
 Copyright © 2024 Robert Dober
 robert.dober@gmail.com

data/lib/l43_peg/parsers.rb

@@ -5,7 +5,8 @@ require_subdir {}
 
 module L43Peg
   module Parsers extend self
-    def args_parser(args, name: nil)      = L43Peg::Parsers::ArgsParser.new(args, name:)
+    def args_parser(args, name: nil, stop: nil, &blk) =
+      L43Peg::Combinators.args_parser(args, name:, stop:, &blk)
     def char_parser(charset = nil)        = L43Peg::Parsers::CharParser.new(charset)
     def end_parser                        = L43Peg::Parsers::EndParser.instance
     def failure_parser                    = L43Peg::Parsers::FailureParser.instance

data/lib/l43_peg/success.rb

@@ -2,13 +2,11 @@
 
 module L43Peg
   class Success
-    def _init
-      return if @position
-      @position = _position
-    end
     extend L43::OpenObject
 
-    attributes ast: nil, cache: nil, position: nil, rest: nil
+    attributes ast: nil, cache: nil, position: nil, rest: nil do
+      @position ||= _position
+    end
 
     def map(&mapper)
       self.class.new(ast: mapper.(ast), cache:, position:, rest:)
@@ -16,7 +14,6 @@ module L43Peg
 
     private
 
-
     def _position
       case @rest
       when Tokens

data/lib/l43_peg.rb

@@ -1,10 +1,32 @@
 # frozen_string_literal: true
 
+require 'l43/open_object'
+
 require_relative 'l43/require_helper'
-require_relative 'l43/open_object'
 require_subdir {}
 
-module L43Peg
-  VERSION = "0.1.5"
+module L43Peg extend self
+  VERSION = "0.1.7"
+
+  def parse_string(parser, input, lnb: 1, col: 1, context: {})
+    input = Input.new(input:, col:, lnb:, context:)
+    _parse(parser, input)
+  end
+
+  def parse_tokens(parser, tokens, tnb: 1, context: {})
+    tokens = Tokens.new(tokens:, tnb:, context:)
+    _parse(parser, tokens)
+  end
+
+  private
+
+  def _parse(parser, input)
+    case parser.(input)
+    in Success => success
+      [:ok, success.ast]
+    in Failure => failure
+      [:error, failure.reason]
+    end
+  end
 end
 # SPDX-License-Identifier: AGPL-3.0-or-later

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: l43_peg
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.7
 platform: ruby
 authors:
 - Robert Dober
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-23 00:00:00.000000000 Z
-dependencies: []
+date: 2024-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: l43_open_object
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 description: |
   A (still incomplete) PEG Library
 
@@ -22,7 +36,6 @@ files:
 - LICENSE
 - README.md
 - lib/l43/match_data_extenstion.rb
-- lib/l43/open_object.rb
 - lib/l43/require_helper.rb
 - lib/l43_peg.rb
 - lib/l43_peg/cache.rb
@@ -65,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.8
 signing_key:
 specification_version: 4
 summary: A (still incomplete) PEG Library

data/lib/l43/open_object.rb

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