farseer 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0def0ee29c72d62793716f625d64e599c00f02a30f790062d9e7ae61fb905fea
-  data.tar.gz: 53701b2c7ce3ed0ff8744b43d48587be8ee4530cb776be24cd5ba87eb908dd19
+  metadata.gz: 2700438309a0da4774a6b4c33aa2f8dc01a61e4ae6eae9db5b5d4bc917f45263
+  data.tar.gz: da6f37d9b9582cfb731a39d6de9a7afbe4678b5e67df717008b8fdfa39281409
 SHA512:
-  metadata.gz: 5ef7c3e3fc84215f25c5ea48d9e8af9d5c8bbed1f4bd01bd0756259c5228008ef0c519d01987da29b0dc200dcddc3e5161de9063a6af3c8611ba7e7c1e54c2fc
-  data.tar.gz: a3d7fab449c4904680e265547c4416ddff9c2a16ba0b4c047ecb9975d6fedc825d50b78e2c0ff52d8a5aaa84b9e4ce1dda4348fe869bf76f276877280a06b107
+  metadata.gz: 9fdc000cff13a63b7ecd370d2a9f454736bc43a5b41ff4b001fdbc07a46ff5b6f2c17101eb27be07499c73b39faace6e00ca61ec04cfebac408054a16ba4cab2
+  data.tar.gz: a147d2daafaa1205e316fdcb811ddd8ae78150d060cf890081bd7ad46f2566398fad6b6941711355f13e2f897e37ac290b877e9e418a138a78759beb2fa0eeb3

data/CHANGELOG.md

@@ -0,0 +1,87 @@
+# 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.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/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.join, input) }
+    end
+  end
+end

data/lib/farseer/char.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Farseer
+  class Char
+    def initialize(char)
+      @char = char
+      freeze
+    end
+
+    L_PARENS = new('(')
+    R_PARENS = new(')')
+    PLUS     = new('+')
+    MINUS    = new('-')
+    STAR     = new('*')
+    SLASH    = new('/')
+
+    def parse(input)
+      case input[0]
+      when @char then Maybe.return(Result.new(input[0], input[1..]))
+      else Maybe.none
+      end
+    end
+  end
+end

data/lib/farseer/chars.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Farseer
+  class Chars
+    def initialize(chars)
+      @chars = chars
+      freeze
+    end
+
+    DIGITS        = new(('0'..'9').to_a)
+    BASIC_MATH_OP = new(['+', '-', '*', '/'])
+
+    def parse(input)
+      case input[0]
+      when *@chars then Maybe.return(Result.new(input[0], input[1..]))
+      else Maybe.none
+      end
+    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 = [])
+      @parser.parse(input)
+             .bind { |r| helper(r.rest, [*tokens, r.token]) }
+             .map_none { Result.new(tokens.join, input) }
+    end
+  end
+end

data/lib/farseer/opt.rb

@@ -0,0 +1,15 @@
+# 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/version.rb

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

data/lib/farseer.rb

@@ -10,11 +10,13 @@ module Farseer
   Maybe = Muina::Maybe
 
   def self.any_char_parser
-    ->(chars, input) { Farseer.__send__(:any_char_parser_helper, chars, input) }.curry
+    ->(chars, input) { Chars.new(chars).parse(input) }
+      .curry
   end
 
   def self.char_parser
-    ->(char, input) { Farseer.__send__(:char_parser_helper, char, input) }.curry
+    ->(char, input) { Char.new(char).parse(input) }
+      .curry
   end
 
   def self.ws_parser
@@ -24,23 +26,6 @@ module Farseer
       Maybe.return(Result.new(match[1], match[2]))
     }
   end
-
-  private
-
-  def self.char_parser_helper(char, input)
-    case input[0]
-    when char then Maybe.return(Result.new(input[0], input[1..]))
-    else Maybe.none
-    end
-  end
-
-  def self.any_char_parser_helper(chars, input)
-    if chars.any? { |char| char == input[0]  }
-      Maybe.return(Result.new(input[0], input[1..]))
-    else
-      Maybe.none
-    end
-  end
 end
 
 loader.eager_load

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: farseer
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - vaporyhumo
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
@@ -45,9 +45,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE
 - README.md
+- SECURITY.md
 - lib/farseer.rb
+- lib/farseer/any.rb
+- lib/farseer/char.rb
+- lib/farseer/chars.rb
+- lib/farseer/many.rb
+- lib/farseer/opt.rb
 - lib/farseer/result.rb
 - lib/farseer/version.rb
 homepage: https://github.com/vaporyhumo/farseer