farseer 0.5.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: faf7eb2a08edee2ef9fac3c334377895fdec31998d3f4de95f97d87c6cdc8d25
-  data.tar.gz: af09bea3a95f554886f66ef09034a0723c7384d57a924534a94da1166ea8d2fc
+  metadata.gz: 22cbc0c49fc2a306b2e0e7291dd58e09047bd2eef4b679d2be9f9e307c6db2e1
+  data.tar.gz: a3a1a49b2748d129931af363e3a4bcbb9fdbd174956de07a4de0daceb0cc07cb
 SHA512:
-  metadata.gz: 9da67d2aeab63fc0d89e43d9034ebc9f3c4abe5e79736d2508231907ed1acaff01cb6e7cb0e3337f0c06540977a97c07d0badd1e632e8aaf474c07a42fe044f2
-  data.tar.gz: a27eb0388cf156ee964a90788de733bd9ad923ef1abbde9a7121812ffd30021c15d806ea0a108f9772ed3af3e4a06c8e2f699b4412afa383dfab297ff98989f1
+  metadata.gz: 8b3bc436e67fcd46f61964cb6e3e70c7f3a8c374a1712680f4a91901daaf9ae071c79428ac40da19038619e8a05556cbbfd0167d43b5841020b082d730f909a6
+  data.tar.gz: 2303e7849b72c10e9353ff9faf362c3d8e0113f24247dbd95104ea45d2c5877e96bcf2444d402853909f14590f4a3c8295f813f99ebc23e1c4bbccbb33c11ae8

data/CHANGELOG.md

@@ -0,0 +1,103 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [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. (`?`)
+- `Farseer::Any`  to parse `0` to multiple times the wrapped parser. (`*`)
+- `Farseer::Many` to parse `1` to multiple times the wrapped parser. (`+`)
+- A couple of instances of `Farseer::Chars` as constants:
+  - `Farseer::Chars::DIGITS` to parse digits from `0` to `9`.
+  - `Farseer::Chars::BASIC_MATH_OP` to parse symbols `+`, `-`, `*`, `/`.
+- Enabled more `Lint` `rubocop` rules.
+- Enabled `Performance` `rubocop` rules.
+
+### Changed
+- Updated development dependencies
+
+## [0.5.0] - 2024-06-03
+### Added
+- `Farseer::Char` as a single character parser.
+- `Farseer::Chars` as a single character from set parser.
+- Multiple instances of `Farseer::Char` as constants:
+  - `Farseer::Char::L_PARENS` for `(`.
+  - `Farseer::Char::R_PARENS` for `)`.
+  - `Farseer::Char::PLUS`     for `+`.
+  - `Farseer::Char::MINUS`    for `-`.
+  - `Farseer::Char::STAR`     for `*`.
+  - `Farseer::Char::SLASH`    for `/`.
+- Enabled `Lint` `rubocop` rules.
+- Enabled a couple more `Layout` `rubocop` rules.
+
+### 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.
+- `irb` development dependency.
+- `.gitignore.local` symlink to `.git/info/exclude`.
+
+### Changed
+- 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.
+- Multiple development dependencies:
+  - `flay`, `flog`, `guard`, `guard-rspec`, `guard-rubocop`, `lefthook`, and
+    `rubocop-performance` with corresponding `binstubs`.
+  - `Guardfile` with `rspec` and `rubocop` guards.
+  - `.lefthook.yml` including `pre-commit` and `pre-push` hooks, and `audit` and
+    `full_audit` tasks.
+
+### Changed
+- Bump `muina` required version to `~> 0.4`.
+- Enabled `Lint` `rubocop` department.
+
+
+## [0.2.0] - 2024-06-02
+### Added
+- `Farseer::Result` to hold the result of succesful parses.
+- `Farseer#char_parser` to parse a single specific character.
+- `muina` as a dependency.
+- `bin/console` to jump into `irb` with the project loaded.
+
+
+## [0.1.0] - 2024-06-02
+### Added
+- Initial gem relase.
+- Set up code quality dependencies:
+  - `rake`:      for running common tasks.
+  - `rubocop`:   for linting.
+  - `rspec`:     for testing.
+  - `simplecov`: for code coverage.
+- License the project with `The Unlicense`.
+- `Rakefile` with `gem`, `rubocop`, and `rspec` tasks.
+- `SECURITY.md` to keep track of maintained versions.
+- `Farseer::VERSION`: Keep the gem version in a constant.
+- `.ruby-version` for rbenv, with version `3.2.2`
+- This `CHANGELOG.md`

data/SECURITY.md

@@ -0,0 +1,14 @@
+# Security Policy
+
+## Supported Versions
+
+Currently supported version are:
+
+| Version | Supported          |
+| ------- | ------------------ |
+|   0.6.0 | :white_check_mark: |
+| < 0.6.0 | :x:                |
+
+## Reporting a Vulnerability
+
+If you find any vulnerability please open an issue.

data/lib/farseer/and.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Farseer
+  class And
+    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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Farseer
+  class Any
+    def initialize(parser)
+      @parser = parser
+      freeze
+    end
+
+    def parse(input)
+      helper(input, '')
+    end
+
+    def helper(input, tokens)
+      @parser.parse(input)
+             .bind { |r| helper(r.rest, tokens + r.token) }
+             .map_none { Result.new(tokens, input) }
+    end
+  end
+end

data/lib/farseer/chars.rb

@@ -2,16 +2,18 @@
 
 module Farseer
   class Chars
-    def initialize(chars)
-      @chars = chars
+    def initialize(*chars)
+      @chars = chars.flatten
       freeze
     end
 
+    DIGITS        = new(('0'..'9').to_a)
+    BASIC_MATH_OP = new(['+', '-', '*', '/'])
+
     def parse(input)
-      if @chars.any? { |char| char == input[0] }
-        Maybe.return(Result.new(input[0], input[1..]))
-      else
-        Maybe.none
+      case input[0]
+      when *@chars then Maybe.return(Result.new(input[0], input[1..]))
+      else Maybe.none
       end
     end
   end

data/lib/farseer/many.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Farseer
+  class Many
+    def initialize(parser)
+      @parser = parser
+      freeze
+    end
+
+    def parse(input)
+      @parser.parse(input)
+             .bind { |r| helper(r.rest, r.token) }
+    end
+
+    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/opt.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Farseer
+  class Opt
+    def initialize(parser)
+      @parser = parser
+      freeze
+    end
+
+    def parse(input)
+      @parser
+        .parse(input)
+        .map_none { Result.new('', input) }
+    end
+  end
+end

data/lib/farseer/or.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Farseer
+  class Or
+    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,23 @@
+# frozen_string_literal: true
+
+module Farseer
+  class Regexp
+    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.5.0'
+  VERSION = '0.7.0'
   public_constant :VERSION
 end

data/lib/farseer/word.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Farseer
+  class Word
+    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.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - vaporyhumo
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-03 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: muina
@@ -45,13 +45,22 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - 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/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