dolos 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21d4d37cda494b06bfa565d59b3d9d2a157fa4d0c71b09fc1d252e8867fb17f9
-  data.tar.gz: 9abf404eb2a0da18548f42e5de345776dd8f5c11296b77cee4c81114f3e8ba1e
+  metadata.gz: 68d26c878ffd86122b9c12273645cf351f5b20d6e1306e140c53727c29e49b2b
+  data.tar.gz: 6bda399416128f5692e2966a46194591209f61602408e6873cb4e41f37a22ec4
 SHA512:
-  metadata.gz: 1a5fc2ba17cd43ccb87f3c1b7b8948e27148dfecebfc53a9e46ddf92cb97e1c0c98b5841a87437fe2ab2e9b5b71f65d5753f006c96f9da506290e7fb2d6299a9
-  data.tar.gz: 419cd3a8d8b64a6eb384dd706647f58182154f6ccb84aa2e83485912374261bc6ee89ea827e394dda621ffb43a2a6fa5bc07c8107de3e9b9727880f4a56c1bac
+  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.0"
+  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,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: dolos
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  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:
+description: Parser combinators library for Ruby. In active development, not stable
+  yet.
 email:
 - git@benetis.me
 executables: []
@@ -23,7 +24,6 @@ files:
 - README.md
 - Rakefile
 - docs/dolos_stable_diff.png
-- dolos.gemspec
 - lib/dolos.rb
 - lib/dolos/parser_state.rb
 - lib/dolos/parsers.rb
@@ -65,5 +65,5 @@ requirements: []
 rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
-summary: Parser combinator library for Ruby.
+summary: Parser combinators library for Ruby.
 test_files: []

data/dolos.gemspec

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/dolos/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "dolos"
-  spec.version = Dolos::VERSION
-  spec.authors = ["benetis"]
-  spec.licenses    = ['MIT']
-  spec.email = ["git@benetis.me"]
-  spec.files = Dir["lib/**/*"]
-
-  spec.summary = "Parser combinator library for Ruby."
-  spec.homepage = "https://github.com/benetis/dolos"
-  spec.required_ruby_version = ">= 3.1.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/benetis/dolos"
-  spec.metadata["changelog_uri"] = "https://github.com/benetis/dolos/blob/master/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, check out our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end