l43_peg 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 733dffa78d9d7b41f75297f5d9f3b2d8e77212df079cd0643d39fc876b87f91d
-  data.tar.gz: c392f1ece61f72a537f673ec9f4f0b235eb6319ea0a90cf553ce11415f396d7f
+  metadata.gz: e5b92019011d80442cfe66f4b3a841a31bba54547efd479a2d19b1f7e687adef
+  data.tar.gz: 75cb9467e13dc72e773bebe345b68b05d431bdbfc6671c7bc215bd063a86cd6c
 SHA512:
-  metadata.gz: 518b0be6499f49df9ec63c334e4067f1b679d592eed92150b17057f71b4eaa54527339e30e2c48f1a7dbd2538cffc2b9c1df16de318857309b097be7ce475c4e
-  data.tar.gz: 3be2dfb70569649ae360192b0fca8f6beb923127a8020992881b158cc11fc2954848a424ba7ee8801410a4882c4b3246a9ec9716e31eaf482c1ba5b98d2b8326
+  metadata.gz: ab3a4841408511554c96725a7659d7b5928336d195323e06dd8c707f247d48f5e2b7d1831768e018de7fdcfbd3d2dfba0aa791d10b1ab422fb08f8b225797066
+  data.tar.gz: be59e8841fcc4e9f22194555fa40c8573805a589f119a728a216e256d729fcdd4ce4abaac76df0547a109415b83208e333fc209ef00bb9e46fcd03ec3dafbd85

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.rb

@@ -4,7 +4,28 @@ 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.6"
+
+  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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: l43_peg
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Robert Dober