dolos 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95e38957665c1a69da17f65d7aad2a63f93e4d0ca4130acb55b60bc037a64947
-  data.tar.gz: 8f715a942a8ef9e2edff94362b29624a9b053f90bc7fae72095161739cbd415a
+  metadata.gz: c8a83a078e5fa82aa8f6d28f3315597937b84c604d59e18f177a950594860e93
+  data.tar.gz: bccf5fc9390189e43ef9c785baeaf93b85e00d1ce480c63057cf0cc26c468050
 SHA512:
-  metadata.gz: c7857e955041ace2291d005ad8ebab84d2c93c175c7364813b91a7753e1e6683af0458abf668cd9c5b628d02e74b9281c471e8568f746a87ec3fe5b211059ba1
-  data.tar.gz: 4bc5adb33d601c88aa51af48dc611a2e7d20d9aaaf41919dbb0e83849641644be824e7369fa1e56c9fad7d74af30a5a551f33800a0aa8c633221e46692ac1113
+  metadata.gz: 75fcc5acf6a6dfbd4eeaf7493f9f82a3d31b5d6b61c64f2d9ee3f6f7fe8856fa1392866cbde95ba12bdb06155f07ed7c9cfe46c24f4353c111bf3782f6033289
+  data.tar.gz: '0608ddcb140a18c1d156ae8729f4c998b1abe4b257be8e02dddff796a3e7d861892ddfebcc6f54b744e9b03d381ed029ad81954b2ff484cc2621d5b7f804d3cb'

data/README.md

@@ -11,15 +11,24 @@
 It does not use exceptions and instead returns a result object.
 Library is composable and concise.
 
+### Getting started
+
+#### Installation
+- Update Gemfile with `gem 'dolos'`
+- Run bundle install
+
+#### Usage
 ```ruby
+require 'dolos'
 include Dolos
 
+ws = c(" ")
 parser = c("Parsers") >> ws >> c("are") >> ws >> c("great!")
-parser.parse("Parsers are great!") # <Result::Success>
+parser.run("Parsers are great!") # <Result::Success>
 
 greeter = c("Hello")
 greet_and_speak = greeter >> c(", ") >> parser
-greet_and_speak.parse("Hello, Parsers are great!") # <Result::Success>
+greet_and_speak.run("Hello, Parsers are great!") # <Result::Success>
 ```
 
 ### Letter address parser example
@@ -30,12 +39,14 @@ require 'dolos_common_parsers/common_parsers'
 include Dolos
 
 # Include common parsers
-# In future this can be more structured, moved them to separate module to prevent breaking changes
+# In future this can be more structured, 
+# moved them to separate module to prevent breaking changes
 include Dolos::CommonParsers
 
 # Library usage example
 # Parse out a name and address from a letter
-# For higher difficulty, we will not split this into multiple lines, but instead parse it all at once
+# For higher difficulty, we will not split this into multiple lines, 
+# but instead parse it all at once
 letter = <<-LETTER
         Mr. Vardeniui Pavardeniui
         AB „Lietuvos Paštas“
@@ -77,23 +88,35 @@ second_line = ws.rep0 >> company_info >> eol
 # After that result is captured and mapped to hash
 # Mapping to hash so at the end its easy to tell tuples apart
 # Also while mapping, doing some cleaning with '.strip'
-street_name = char_while(->(char) { !char.match(/\d/) }).capture!.map(&:first).map { |s| { street: s.strip } }
+street_name = char_while(->(char) { !char.match(/\d/) })
+  .capture!
+  .map(&:first)
+  .map { |s| { street: s.strip } }
 building = digits.capture!.map(&:first).map { |s| { building: s.strip } }
 address_line = ws.rep0 >> street_name >> building >> eol
 
 # City line
-# All digits can be matched here or 'digits.rep(5)' could be used. Also joining with map.
+# All digits can be matched here or 'digits.rep(5)' could be used. 
+# Also joining with map results.
 postcode = digits.capture!.map(&:join).map { |s| { postcode: s.strip } }
 city = alpha_with_lt.rep.capture!.map(&:join).map { |s| { city: s.strip } }
 city_line = ws.rep0 >> postcode >> ws >> city >> eol
 
-# Full letter parser which is combined from all previous parsers. All previous parsers can be ran separately.
+# Full letter parser which is combined from all previous parsers.
+# Also, all previous parsers can be ran separately.
 letter_parser = name_line >> second_line >> address_line >> city_line
 result = letter_parser.run(letter)
 
+# List of tuples
 pp result.captures
+# ["Vardeniui", "Pavardeniui", "Lietuvos Paštas", {:street=>"Totorių g."},
+# {:building=>"8"}, {:postcode=>"01121"}, {:city=>"Vilnius"}]
 
 ```
+### Roadmap
+- Better error handling
+- Recursive parser
+- Benchmarks & parser tests
 
 ### Contributing
 Contributors are welcome. Note: since library is not yet stable, I recommend getting in touch with me before starting to work on something.

data/lib/dolos/parser_state.rb

@@ -3,10 +3,12 @@
 module Dolos
   class ParserState
     attr_reader :input
+    attr_accessor :last_success_position
 
     def initialize(input)
       @input = StringIOWrapper.new(input)
+      @last_success_position = 0
     end
   end
-
 end
+

data/lib/dolos/parsers.rb

@@ -10,14 +10,17 @@ module Dolos
           Success.new(utf8_str, str.bytesize)
         else
           advanced = state.input.offset
+          got_error = state.input.io.string.byteslice(state.input.backup, advanced)
           state.input.rollback
           Failure.new(
-            "Expected #{str.inspect} but got #{state.input.io.string.inspect}",
-            advanced
+            "Expected #{str.inspect} but got #{got_error.inspect}",
+            advanced,
+            state
           )
         end
       end
     end
+
     alias_method :c, :string
 
     def regex(pattern)
@@ -30,13 +33,13 @@ module Dolos
           state.input.rollback
           Failure.new(
             "Expected pattern #{pattern.inspect} but got #{state.input.io.string.inspect}",
-            advanced
+            advanced,
+            state
           )
         end
       end
     end
 
-
     def any_char
       Parser.new do |state|
         state.input.mark_offset
@@ -48,7 +51,11 @@ module Dolos
         else
           advanced = state.input.offset
           state.input.rollback
-          Failure.new('Expected any character but got end of input', advanced)
+          Failure.new(
+            'Expected any character but got end of input',
+            advanced,
+            state
+          )
         end
       end
     end
@@ -71,7 +78,8 @@ module Dolos
           state.input.rollback
           Failure.new(
             "Expected one of #{characters_array.inspect} but got #{char.inspect}",
-            advanced
+            advanced,
+            state
           )
         end
       end
@@ -92,7 +100,11 @@ module Dolos
 
         if buffer.empty?
           advanced = state.input.offset
-          Failure.new("Predicate never returned true", advanced)
+          Failure.new(
+            "Predicate never returned true",
+            advanced,
+            state
+          )
         else
           Success.new(buffer, 0)
         end

data/lib/dolos/result.rb

@@ -40,18 +40,37 @@ module Dolos
   end
 
   class Failure < Result
-    attr_reader :message, :committed
+    attr_reader :message, :error_position, :state
 
-    def initialize(message, committed)
+    def initialize(message, error_position, state)
       @message = message
-      @committed = committed
+      @error_position = error_position
+      @state = state
     end
 
     def inspect
+      pretty_print
+    end
+
+    def pretty_print
+      input_string = state.input.io.string
+
+      pointer = "^" # This will point to the error position
+
+      context_range = 10 # Chars before and after the error to display
+
+      start_index = [error_position - context_range, 0].max
+      end_index = [error_position + context_range, input_string.length].max
+
+      substring = input_string[start_index..end_index]
+
+      padding = error_position - start_index
+
       [
-        "Failure",
-        "message: #{message}",
-        "committed: #{committed}"
+        "Failure: #{message}",
+        substring,
+        "#{' ' * padding}#{pointer}",
+        "Error Position: #{error_position}, Last Success Position: #{state.last_success_position}"
       ].join("\n")
     end
 

data/lib/dolos/string_io_wrapper.rb

@@ -22,7 +22,6 @@ module Dolos
 
     def matches?(utf8_str)
       read = io.read(utf8_str.bytesize)
-      io.seek(offset)
 
       if read.nil?
         false

data/lib/dolos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dolos
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/dolos.rb

@@ -22,7 +22,11 @@ module Dolos
     end
 
     def run_with_state(state)
-      parser_proc.call(state)
+      result = parser_proc.call(state)
+      if result.success?
+        state.last_success_position = state.input.offset
+      end
+      result
     end
 
     def capture!
@@ -109,23 +113,31 @@ module Dolos
     # repeat(n_min: 2) # 2 or more
     def repeat(n_min:, n_max: Float::INFINITY)
       Parser.new do |state|
-        results = []
+        values = []
+        captures = []
         count = 0
+        state.input.mark_offset
 
         while count < n_max
           result = run_with_state(state.dup)
 
           break if result.failure?
 
-          results << result.value
+          values << result.value
+          captures.concat(result.captures)
           state.input.advance(result.length)
           count += 1
         end
 
         if count < n_min
-          Failure.new("Expected parser to match at least #{n_min} times but matched only #{count} times", false)
+          error_pos = state.input.offset
+          Failure.new(
+            "Expected parser to match at least #{n_min} times but matched only #{count} times",
+            error_pos,
+            state
+          )
         else
-          Success.new(results, 0) # Passing 0, because we already advanced the input and flatmap will advance it again
+          Success.new(values, 0, captures)
         end
       end
     end

data/sig/dolos/parser_state.rbs

@@ -1,6 +1,7 @@
 module Dolos
   class ParserState
     attr_reader input: Dolos::StringIOWrapper
+    attr_accessor last_success_position: Integer
 
     def initialize: (String) -> void
   end

data/sig/dolos/result.rbs

@@ -16,6 +16,7 @@ module Dolos
 
   class Failure < Result[bot]
     attr_reader committed: bool
+    attr_reader error_position: Integer
     attr_reader message: String
 
     def captures: -> []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dolos
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - benetis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-15 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies: []
 description: Parser combinators library for Ruby. In active development, not stable
   yet.