pestle 0.1.0

data/sig/pair.rbs

@@ -0,0 +1,168 @@
+module Pestle
+  class Token
+    @rule: Symbol
+
+    @pos: Integer
+
+    attr_reader rule: Symbol
+
+    attr_reader pos: Integer
+
+    def initialize: (Symbol rule, Integer pos) -> void
+  end
+
+  class Start < Token
+    def to_s: () -> ::String
+  end
+
+  class End < Token
+    def to_s: () -> ::String
+  end
+
+  class Span
+    @text: String
+
+    @start: Integer
+
+    @end: Integer
+
+    attr_reader text: String
+
+    attr_reader start: Integer
+
+    attr_reader end: Integer
+
+    def initialize: (String text, Integer start, Integer stop) -> void
+
+    def to_s: () -> String
+
+    def start_pos: () -> Position
+
+    def end_pos: () -> Position
+
+    # Return an array of lines covered by this span.
+    def lines: () -> Array[String]
+  end
+
+  class Position
+    @text: String
+
+    @pos: Integer
+
+    attr_reader text: String
+
+    attr_reader pos: Integer
+
+    def initialize: (String text, Integer pos) -> void
+
+    def line_col: () -> [Integer, Integer]
+
+    def line_of: () -> String
+  end
+
+  class Pair
+    @source: String
+
+    @start: Integer
+
+    @end: Integer
+
+    @rule: Symbol
+
+    @children: Array[Pair]
+
+    @tag: String?
+
+    @name: String
+
+    attr_reader start: Integer
+
+    attr_reader end: Integer
+
+    attr_reader rule: Symbol
+
+    attr_reader tag: String?
+
+    attr_reader name: String
+
+    attr_reader children: Array[Pair]
+
+    def initialize: (String source, Integer start, Integer stop, String rule_name, Array[Pair] children, ?tag: untyped?) -> void
+
+    def deconstruct: () -> Array[untyped]
+                   
+    def deconstruct_keys: (untyped keys) -> Hash[Symbol, untyped]
+
+    def to_s: () -> String
+
+    def each: () ?{ (?) -> untyped } -> untyped
+            
+    def to_ary: () -> Array[Pair]
+
+    def inner: () -> Pairs
+
+    def stream: () -> Stream
+
+    def tokens: () -> Enumerable[Token]
+
+    def span: () -> Span
+
+    def dump: () -> Hash[String, untyped]
+
+    def dumps: (?indent: ::Integer, ?new_line: bool) -> String
+
+    def line_col: () -> [Integer, Integer]
+
+    def text: () -> String
+
+    def inner_texts: () -> Array[String]
+  end
+
+  class Pairs
+    @pairs: Array[Pair]
+
+    def initialize: (Array[Pair] pairs) -> void
+
+    def each: () ?{ (?) -> untyped } -> untyped
+
+    def length: () -> Integer
+
+    def tokens: () -> Enumerable[Token]
+
+    def stream: () -> Stream
+
+    def dump: () -> Array[untyped]
+
+    def dumps: (?compact: bool) -> String
+
+    def flatten: () -> Enumerable[Pair]
+
+    def first: () -> Pair?
+             
+    def pop: () -> Pair?
+
+    def find_first_tagged: (String label) -> (Pair | nil)
+
+    def find_tagged: (String label) -> Enumerable[Pair]
+  end
+
+  # Step through pairs of tokens.
+  class Stream
+    @pairs: Array[Pair]
+
+    @pos: Integer
+
+    attr_accessor pos: Integer
+
+    def initialize: (Array[Pair] pairs) -> void
+
+    # Consume and return the next pair, or nil if we're at the end of the stream.
+    def next: () -> Pair?
+
+    # Go back one position. This is a no-op if we're at the beginning of the stream.
+    def backup: () -> void
+
+    # Return the next pair without consuming it, or nil if we're at the end of the stream.
+    def peek: () -> Pair?
+  end
+end

data/sig/parser.rbs

@@ -0,0 +1,16 @@
+module Pestle
+  class Parser
+    @rules: Hash[String, Pestle::Grammar::Rule]
+
+    @doc: String?
+
+    # Parse a grammar definition and return a new parser for it.
+    def self.from_grammar: (String grammar) -> Parser
+
+    def initialize: (Hash[String, Pestle::Grammar::Rule] rules, String? doc) -> void
+
+    def parse: (String | Symbol start_rule, String text, ?start_pos: ::Integer) -> Pairs
+             
+    def tree_view: () -> String
+  end
+end

data/sig/pestle.rbs

@@ -0,0 +1,5 @@
+module Pestle
+  VERSION: String
+
+  def self.parse_grammar: (String grammar) -> [Hash[String, Pestle::Grammar::Rule], String?]
+end

data/sig/pratt.rbs

@@ -0,0 +1,27 @@
+module Pestle
+  # A Generic Pratt parser base class operating on a Pestle::Stream of token pairs.
+  class PrattParser[ExprT]
+    # A mapping of prefix operator rule symbols to precedence levels.
+    PREFIX_OPS: ::Hash[Symbol, Integer]
+
+    # A mapping of infix operator rule symbols to [precedence, right_associative].
+    INFIX_OPS: ::Hash[Symbol, [Integer, bool]]
+
+    # A mapping of postfix operator rule symbols to precedence levels.
+    POSTFIX_OPS: ::Hash[Symbol, Integer]
+
+    LEFT_ASSOC: false
+
+    RIGHT_ASSOC: true
+
+    def parse_primary: (Pair pair) -> ExprT
+
+    def parse_prefix: (Pair op, ExprT rhs) -> ExprT
+
+    def parse_infix: (ExprT lhs, Pair op, ExprT rhs) -> ExprT
+
+    def parse_postfix: (ExprT lhs, Pair op) -> ExprT
+
+    def parse_expr: (Stream stream, ?::Integer min_prec) -> ExprT
+  end
+end

data/sig/state.rbs

@@ -0,0 +1,95 @@
+module Pestle
+  class ParserState
+    @text: String
+
+    @scanner: StringScanner
+
+    @rules: Hash[String, Pestle::Grammar::Rule]
+
+    @pos_checkpoints: Array[Integer]
+
+    @atomic_depth: Integer
+
+    @atomic_depth_checkpoints: Array[Integer]
+
+    @tags: Array[String]
+
+    @user_stack: Array[String]
+
+    @user_stack_popped: Array[String]
+
+    @user_stack_lengths: Array[[Integer, Integer]]
+
+    @rule_stack: Array[String]
+
+    @neg_pred_stack: Array[Integer]
+
+    @furthest_pos: Integer
+
+    @furthest_rules: Array[String]
+
+    @furthest_expected: Hash[String, Array[String]]
+
+    @furthest_unexpected: Hash[String, Array[String]]
+
+    attr_reader text: String
+
+    attr_reader scanner: StringScanner
+
+    attr_reader rules: Hash[String, Pestle::Grammar::Rule]
+
+    attr_reader tags: Array[String]
+
+    attr_reader atomic_depth: Integer
+
+    attr_reader user_stack: Array[String]
+
+    attr_reader rule_stack: Array[String]
+
+    attr_reader furthest_pos: Integer
+
+    attr_reader furthest_expected:  Hash[String, Array[String]]
+
+    attr_reader furthest_unexpected: Hash[String, Array[String]]
+    
+    attr_reader furthest_rules: Array[String]
+
+    attr_reader neg_pred_stack: Array[Integer]
+
+    def initialize: (String text, Hash[String, Pestle::Grammar::Rule] rules, ?start_pos: ::Integer) -> void
+
+    def checkpoint: () -> void
+
+    def ok: () -> void
+
+    def restore: () -> void
+
+    def stack_snapshot: () -> void
+
+    def stack_drop_snapshot: () -> void
+
+    def stack_restore: () -> void
+
+    def stack_empty?: () -> bool
+
+    def stack_push: (String value) -> void
+
+    def stack_pop: () -> String?
+
+    def stack_peek: () -> String?
+
+    def stack_peek_slice: (Integer? start, Integer? stop) -> Array[String]
+                        
+    def stack_clear: () -> void
+
+    def parse_trivia: (Array[Pestle::Pair] pairs) -> bool
+                    
+    def with_tag: (String name) { () -> untyped } -> untyped
+                
+    def atomic: () { () -> untyped } -> untyped
+              
+    def nonatomic: () { () -> untyped } -> untyped
+                 
+    def track: (String label, bool matched) -> void
+  end
+end

data/sig/stdlib/strscan.rbs

@@ -0,0 +1,3 @@
+class StringScanner
+  def scan_byte: () -> Integer?
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: pestle
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- James Prior
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIEhTCCAu2gAwIBAgIBATANBgkqhkiG9w0BAQsFADBEMRYwFAYDVQQDDA1qYW1l
+  c2dyLnByaW9yMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
+  FgNjb20wHhcNMjUxMDI1MDc0ODI4WhcNMjYxMDI1MDc0ODI4WjBEMRYwFAYDVQQD
+  DA1qYW1lc2dyLnByaW9yMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJ
+  k/IsZAEZFgNjb20wggGiMA0GCSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDYTvQW
+  0JzsHenYu4w0iHgJRtU9uK8vkDx1wlMioKlPFkaiMfxqUcTTfg80U/n8n/KKmpdq
+  y2rpUqv+VPE2nrfCUncf7ukqs+gF8uehbciMXV4iOzsZmqmtlPUJiGuSyO8REe/O
+  ERAyxYV8y5psF+WnW4uQzsWCKTnKbexIc6rf237veuYvYoBpnodJu0mJ0m9tBCFU
+  qH3Nk1sHBRIEEwn+nTiIiOMb+QMU5p0NIQkIhJO3el5nEQgIGxMPnie7PnwxPquQ
+  1rouuISbLmQy5oKYc9kScwnHdAu2PtnnJFNNuQ37vED375iQgMem/tK8EgMm9/Qr
+  Qxd2DQqqehgtEySWntGHTxNLXQouqHIRyqzkbcCatJqC+PBBql1x2N1KqgyvbLM3
+  B0dZCdJECr5J8zrluMxYsy7uGMmLz3LZ7PskGaJg4XxXP3j/B/e03/AxDj0neZZu
+  xuDLIfMDSNILO1pskMc+Xp0xdnkbS4IjiMDTrhqABuEcdNYH/GpyTiA/I0cCAwEA
+  AaOBgTB/MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQWBBR4j7UhnpT9
+  mLcAkshwkFtwVpMdejAiBgNVHREEGzAZgRdqYW1lc2dyLnByaW9yQGdtYWlsLmNv
+  bTAiBgNVHRIEGzAZgRdqYW1lc2dyLnByaW9yQGdtYWlsLmNvbTANBgkqhkiG9w0B
+  AQsFAAOCAYEAbTkg946BsGPQFX3jskBjwINeFnMP0IppuStonPQv3SNQu1SWP0xS
+  o1Qji1dxkWDfOcp1ffrRMUo7ecrJbTqQ5Sdx+7zw0OLodSVqSu1LMIVDw/T73smg
+  ADO2r3eZ8vxCKh7z4wUeKXvmBXi5NvpmvhH7D+qeG4OMLI8jnfmfbSHZQZbe2tpd
+  tJC+MYVok/m91fBrfv5wqLsR5QiJl3vcVhG+xACd46gr3JZFOxBqpSJrCYL8Gwqx
+  BaKEySCLGqkb0d1Rnt2/zTR2KtW2QJVH9rBMnJ+LsPEFKs1UHH4qHzxmwmmaQLon
+  MoE4UJ51GHGrjJ4WsHOUSOy5UbjaQec3kuIDwTXKbHws0J0Ut9S4S38opZKdQHDD
+  PUBpY0QA1CgE/VjKAYEDHOJyfUCNOl+sEESM+WxEXZAUVZLrFF7MljJqyQq+JyTD
+  vFKHe1ZAA76NFrPscB/ODPTBK8i+u4gwrD1UAsVAHuIbOpQu4LYAujluCu5cl2A8
+  HhmlCT7sTkqG
+  -----END CERTIFICATE-----
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+email:
+- jamesgr.prior@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- LICENSE.txt
+- LICENSE_PEST.txt
+- README.md
+- Rakefile
+- Steepfile
+- benchmarks/jsonpath_ips.rb
+- examples/calculator_pratt.rb
+- examples/calculator_prec_climber.rb
+- examples/calculator_stack_vm.rb
+- examples/csv.rb
+- examples/ini.rb
+- examples/json_example.rb
+- examples/jsonpath/README.md
+- examples/jsonpath/jsonpath.pest
+- examples/jsonpath/lib/jsonpath.rb
+- examples/jsonpath/lib/jsonpath/ast.rb
+- examples/jsonpath/lib/jsonpath/function_extensions.rb
+- examples/jsonpath/lib/jsonpath/node.rb
+- examples/jsonpath/lib/jsonpath/query.rb
+- lib/pestle.rb
+- lib/pestle/errors.rb
+- lib/pestle/grammar/builtin_rules/ascii.rb
+- lib/pestle/grammar/builtin_rules/special.rb
+- lib/pestle/grammar/builtin_rules/unicode.rb
+- lib/pestle/grammar/errors.rb
+- lib/pestle/grammar/expression.rb
+- lib/pestle/grammar/expressions/choice.rb
+- lib/pestle/grammar/expressions/group.rb
+- lib/pestle/grammar/expressions/identifier.rb
+- lib/pestle/grammar/expressions/postfix.rb
+- lib/pestle/grammar/expressions/prefix.rb
+- lib/pestle/grammar/expressions/range.rb
+- lib/pestle/grammar/expressions/sequence.rb
+- lib/pestle/grammar/expressions/stack.rb
+- lib/pestle/grammar/expressions/string.rb
+- lib/pestle/grammar/lexer.rb
+- lib/pestle/grammar/parser.rb
+- lib/pestle/grammar/rule.rb
+- lib/pestle/pair.rb
+- lib/pestle/parser.rb
+- lib/pestle/pratt.rb
+- lib/pestle/state.rb
+- lib/pestle/version.rb
+- sig/errors.rbs
+- sig/grammar/ascii.rbs
+- sig/grammar/choice.rbs
+- sig/grammar/errors.rbs
+- sig/grammar/expression.rbs
+- sig/grammar/group.rbs
+- sig/grammar/identifier.rbs
+- sig/grammar/lexer.rbs
+- sig/grammar/parser.rbs
+- sig/grammar/postfix.rbs
+- sig/grammar/prefix.rbs
+- sig/grammar/range.rbs
+- sig/grammar/rule.rbs
+- sig/grammar/sequence.rbs
+- sig/grammar/special.rbs
+- sig/grammar/stack.rbs
+- sig/grammar/string.rbs
+- sig/grammar/unicode.rbs
+- sig/pair.rbs
+- sig/parser.rbs
+- sig/pestle.rbs
+- sig/pratt.rbs
+- sig/state.rbs
+- sig/stdlib/strscan.rbs
+homepage: https://github.com/jg-rp/ruby-pestle
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jg-rp/ruby-pestle
+  source_code_uri: https://github.com/jg-rp/ruby-pestle
+  changelog_uri: https://github.com/jg-rp/ruby-pestle/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: A general purpose parser for Ruby.
+test_files: []