farseer 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2700438309a0da4774a6b4c33aa2f8dc01a61e4ae6eae9db5b5d4bc917f45263
-  data.tar.gz: da6f37d9b9582cfb731a39d6de9a7afbe4678b5e67df717008b8fdfa39281409
+  metadata.gz: 656cdb47ea0c930c3706c4ecb11eba8df657c4890e84a5537ba7e1aa4bcb1624
+  data.tar.gz: 14ec99cefd66715c3d2338fabb10ef56c8e371d2aacef140a835761e42057440
 SHA512:
-  metadata.gz: 9fdc000cff13a63b7ecd370d2a9f454736bc43a5b41ff4b001fdbc07a46ff5b6f2c17101eb27be07499c73b39faace6e00ca61ec04cfebac408054a16ba4cab2
-  data.tar.gz: a147d2daafaa1205e316fdcb811ddd8ae78150d060cf890081bd7ad46f2566398fad6b6941711355f13e2f897e37ac290b877e9e418a138a78759beb2fa0eeb3
+  metadata.gz: d658b63d11e9c0aac8ffda570a1a2ab43e225645433a178981fb1850a7d6e23cf98027684e86354974082719655dad75c4b7d14386b5013e007c1bac3ad53092
+  data.tar.gz: e9fec41b0d13895de5c9404997f7cf6474fbda1370584806b35caa426d4c2204761650a8a874b11efbb645fc5b941fa7ba1fd9888f8334bc59472af8b7d13b7b

data/CHANGELOG.md

@@ -7,6 +7,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.8.0] - 2024-06-04
+### Added
+- `Farseer::Map` which is a parser with a callback to map the resulting token
+    into something else.
+- `Farseer::MapFactory` which adds `#map`, a factory method for new parsers with
+    callbacks. It creates a new instance of `Farseer::Map`.
+- Included `Farseer::MapFactory` into all parsers.
+
+
+## [0.7.0] - 2024-06-04
+### Added
+- `Farseer::And` to run a sequence of parsers that must all succeed.
+- `Farseer::Or` to try multiple parsers until one works.
+- `Farseer::Word` to parse a keyword at the beginning of a string.
+- `Farseer::Regexp` to parse a token using `regexp`.
+- `mutant` development dependency for mutation testing.
+- Achieve `100%` mutation test coverage.
+- `byebug` development dependency for debugging.
+
+### Removed
+- All helper methods of `Farseer`.
+
+### Changed
+- Update development dependencies.
+
+
 ## [0.6.0] - 2024-06-03
 ### Added
 - `Farseer::Opt`  to parse `0` to `1` times the wrapped parser. (`?`)
@@ -21,6 +47,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Updated development dependencies
 
+
 ## [0.5.0] - 2024-06-03
 ### Added
 - `Farseer::Char` as a single character parser.
@@ -38,6 +65,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Update `muina` version requirement to `~> 0.5`
 
+
 ## [0.4.0] - 2024-06-03
 ### Added
 - `Farseer.any_char_parser` to parse a single character from a given set.
@@ -48,6 +76,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Stop using `module_function` and change methods into singleton methods.
 - Update `bundler` version.
 
+
 ## [0.3.0] - 2024-06-02
 ### Added
 - `Farseer#ws_parser` to parse all leading whitespace.

data/lib/farseer/and.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Farseer
+  class And
+    include MapFactory
+
+    def initialize(*parsers)
+      @parsers = parsers.flatten
+      freeze
+    end
+
+    def parse(input)
+      return Maybe.none if @parsers.empty?
+
+      initial = Maybe.return(Result.new('', input))
+
+      @parsers.reduce(initial) do |maybe_acc, parser|
+        bind_accumulator(maybe_acc, parser)
+      end
+    end
+
+    def bind_accumulator(maybe_acc, parser)
+      maybe_acc.bind do |acc_result|
+        parse_with_rest(parser, acc_result)
+      end
+    end
+
+    def parse_with_rest(parser, acc_result)
+      parser.parse(acc_result.rest).bind do |result|
+        combine_results(acc_result, result)
+      end
+    end
+
+    def combine_results(acc_result, result)
+      combined_tokens = acc_result.token + result.token
+      Maybe.return(Result.new(combined_tokens, result.rest))
+    end
+  end
+end

data/lib/farseer/any.rb

@@ -2,19 +2,21 @@
 
 module Farseer
   class Any
+    include MapFactory
+
     def initialize(parser)
       @parser = parser
       freeze
     end
 
     def parse(input)
-      helper(input)
+      helper(input, '')
     end
 
-    def helper(input, tokens = [])
+    def helper(input, tokens)
       @parser.parse(input)
-             .bind { |r| helper(r.rest, [*tokens, r.token]) }
-             .map_none { Result.new(tokens.join, input) }
+             .bind { |r| helper(r.rest, tokens + r.token) }
+             .map_none { Result.new(tokens, input) }
     end
   end
 end

data/lib/farseer/char.rb

@@ -2,6 +2,8 @@
 
 module Farseer
   class Char
+    include MapFactory
+
     def initialize(char)
       @char = char
       freeze

data/lib/farseer/chars.rb

@@ -2,8 +2,10 @@
 
 module Farseer
   class Chars
-    def initialize(chars)
-      @chars = chars
+    include MapFactory
+
+    def initialize(*chars)
+      @chars = chars.flatten
       freeze
     end
 

data/lib/farseer/many.rb

@@ -2,6 +2,8 @@
 
 module Farseer
   class Many
+    include MapFactory
+
     def initialize(parser)
       @parser = parser
       freeze
@@ -9,13 +11,13 @@ module Farseer
 
     def parse(input)
       @parser.parse(input)
-             .bind { |r| helper(r.rest, [r.token]) }
+             .bind { |r| helper(r.rest, r.token) }
     end
 
-    def helper(input, tokens = [])
-      @parser.parse(input)
-             .bind { |r| helper(r.rest, [*tokens, r.token]) }
-             .map_none { Result.new(tokens.join, input) }
+    def helper(input, tokens)
+      parse(input)
+        .bind { |r| helper(r.rest, tokens + r.token) }
+        .map_none { Result.new(tokens, input) }
     end
   end
 end

data/lib/farseer/map.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Farseer
+  class Map
+    include MapFactory
+
+    def initialize(parser, &map)
+      @parser = parser
+      @map = map
+      freeze
+    end
+
+    def parse(input)
+      @parser.parse(input).map { |r| Result.new(@map.call(r.token), r.rest) }
+    end
+  end
+end

data/lib/farseer/map_factory.rb

@@ -0,0 +1,7 @@
+module Farseer
+  module MapFactory
+    def map(&)
+      Map.new(self, &)
+    end
+  end
+end

data/lib/farseer/opt.rb

@@ -2,14 +2,17 @@
 
 module Farseer
   class Opt
+    include MapFactory
+
     def initialize(parser)
       @parser = parser
       freeze
     end
 
     def parse(input)
-      @parser.parse(input)
-             .map_none { Result.new('', input) }
+      @parser
+        .parse(input)
+        .map_none { Result.new('', input) }
     end
   end
 end

data/lib/farseer/or.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Farseer
+  class Or
+    include MapFactory
+
+    def initialize(*parsers)
+      @parsers = parsers.flatten
+      freeze
+    end
+
+    def parse(input)
+      case @parsers.length
+      when 0 then Maybe.none
+      when 1 then @parsers.first.parse(input)
+      else parse_helper(input)
+      end
+    end
+
+    def parse_helper(input)
+      @parsers.reduce do |acc, parser|
+        acc.parse(input).bind_none { parser.parse(input) }
+      end
+    end
+  end
+end

data/lib/farseer/regexp.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Farseer
+  class Regexp
+    include MapFactory
+
+    WS_REGEXP = /^(?'token'\s*)(?'rest'.*)$/
+    RegexpError = Class.new(ArgumentError)
+
+    def initialize(regexp)
+      raise RegexpError unless regexp.names == ['token', 'rest']
+
+      @regexp = regexp
+      freeze
+    end
+
+    WS = new(WS_REGEXP)
+
+    def parse(input)
+      match = input.match(@regexp)
+
+      Maybe.return(Result.new(match[:token], match[:rest]))
+    end
+  end
+end

data/lib/farseer/result.rb

@@ -11,8 +11,8 @@ module Farseer
 
     def eql?(other)
       self.class.eql?(other.class) and
-        self.token.eql?(other.token) and
-        self.rest.eql?(other.rest)
+        token.eql?(other.token) and
+        rest.eql?(other.rest)
     end
     alias == eql?
   end

data/lib/farseer/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
 module Farseer
-  VERSION = '0.6.0'
+  VERSION = '0.8.0'
   public_constant :VERSION
 end

data/lib/farseer/word.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Farseer
+  class Word
+    include MapFactory
+
+    def initialize(word)
+      @word = word
+      freeze
+    end
+
+    def parse(input)
+      case
+      when input.start_with?(@word) then Maybe.return(Result.new(@word, input[@word.length..]))
+      else Maybe.none
+      end
+    end
+  end
+end

data/lib/farseer.rb

@@ -6,26 +6,7 @@ loader = Zeitwerk::Loader::for_gem
 loader.setup
 
 module Farseer
-  WS_REGEX = /^(\s*)(.*)$/
   Maybe = Muina::Maybe
-
-  def self.any_char_parser
-    ->(chars, input) { Chars.new(chars).parse(input) }
-      .curry
-  end
-
-  def self.char_parser
-    ->(char, input) { Char.new(char).parse(input) }
-      .curry
-  end
-
-  def self.ws_parser
-    ->(input) {
-      match = input.match(WS_REGEX)
-
-      Maybe.return(Result.new(match[1], match[2]))
-    }
-  end
 end
 
 loader.eager_load

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: farseer
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - vaporyhumo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-03 00:00:00.000000000 Z
+date: 2024-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: muina
@@ -50,13 +50,19 @@ files:
 - README.md
 - SECURITY.md
 - lib/farseer.rb
+- lib/farseer/and.rb
 - lib/farseer/any.rb
 - lib/farseer/char.rb
 - lib/farseer/chars.rb
 - lib/farseer/many.rb
+- lib/farseer/map.rb
+- lib/farseer/map_factory.rb
 - lib/farseer/opt.rb
+- lib/farseer/or.rb
+- lib/farseer/regexp.rb
 - lib/farseer/result.rb
 - lib/farseer/version.rb
+- lib/farseer/word.rb
 homepage: https://github.com/vaporyhumo/farseer
 licenses:
 - Unlicense