dolos 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95e38957665c1a69da17f65d7aad2a63f93e4d0ca4130acb55b60bc037a64947
-  data.tar.gz: 8f715a942a8ef9e2edff94362b29624a9b053f90bc7fae72095161739cbd415a
+  metadata.gz: 68d26c878ffd86122b9c12273645cf351f5b20d6e1306e140c53727c29e49b2b
+  data.tar.gz: 6bda399416128f5692e2966a46194591209f61602408e6873cb4e41f37a22ec4
 SHA512:
-  metadata.gz: c7857e955041ace2291d005ad8ebab84d2c93c175c7364813b91a7753e1e6683af0458abf668cd9c5b628d02e74b9281c471e8568f746a87ec3fe5b211059ba1
-  data.tar.gz: 4bc5adb33d601c88aa51af48dc611a2e7d20d9aaaf41919dbb0e83849641644be824e7369fa1e56c9fad7d74af30a5a551f33800a0aa8c633221e46692ac1113
+  metadata.gz: 7ae6b3a4750cc5bfb5f54a84d518f8d4176eaf10dfef4482f45aaadc3db422a14f04cabb65ee0e1fe85b7dfb95fa1b54c8daf4f91083f4f39beac32c70c25616
+  data.tar.gz: e4ab436619a690d257fdaba829fcbc00ec74c56cd8fda0c754fd5f1985fe2d3b21adcda1db69f7ca116437ccf8cf9c6455f03cb05ab44b8107033db590266398

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,21 +88,29 @@ 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"}]
 
 ```
 

data/lib/dolos/version.rb

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

data/lib/dolos.rb

@@ -109,7 +109,8 @@ 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
 
         while count < n_max
@@ -117,7 +118,8 @@ module Dolos
 
           break if result.failure?
 
-          results << result.value
+          values << result.value
+          captures.concat(result.captures)
           state.input.advance(result.length)
           count += 1
         end
@@ -125,7 +127,7 @@ module Dolos
         if count < n_min
           Failure.new("Expected parser to match at least #{n_min} times but matched only #{count} times", false)
         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

metadata

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