srl_ruby 0.4.14 → 0.4.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa7a9699a1a4f26e820e1523d4f6d3fa186cd814afeb5b41e164ea191df7303b
-  data.tar.gz: 0f4b1c7de0da2ed0a1acf1f2a700271d35afc383b5d9eeec0d790993f9d8928b
+  metadata.gz: af00786c71ac6736bb80041630395c02bf7e86a8a15c4601b3010edefadc7d21
+  data.tar.gz: ac70e3dc3bdd7ce80e84e9d2c5c72b3f45d4664fb1d47d4e12e85d57b24c3aa7
 SHA512:
-  metadata.gz: 972f392c2817101f0bffcc688b867060f19da7c258e5b0bd2fb2061a602df6d0c8f00df85be855bc6bb2cc24b8bd1c1994fac00d06a7ca9b1fe353277acbd21f
-  data.tar.gz: 7b8e2065d771a5ae84051bc7633d09ea6ed7dcb781b277fd47118b3796cf5a2f7f4d1fe44e29b5acf65303902e8c9a1b9b4f7692b8c9b4079c47115258450870
+  metadata.gz: 42229711b0814750b89ed47ff893defbc51ae40463613f85c3c3d82afff577984452eb8039439ebec6813708f892cf657ed338df6170d0ab0acc411a96cc471f
+  data.tar.gz: dd628a6cdd006763a00a5c82950bc5721bf4f9ee6a065b88f29f0dda9a0161bd7e5613dc3379f30479b3866fbca77b454afe2919084a633cc326a5195b3082f4

data/CHANGELOG.md

@@ -1,4 +1,9 @@
-## [0.4.13] - 2025-02-22
+## [0.4.15] - 2025-03-20
+- Tested against rley  0.9.02 and rubocop 1.74.0
+### Changed
+- File `srl_ruby.gemspec`: make dependencies more lenient
+
+## [0.4.14] - 2025-02-22
 - Tested against rubocop-rspec 3.5.0
 
 ### Fixed

data/lib/regex/character.rb

@@ -41,13 +41,13 @@ module Regex # This module is used as a namespace
     # codepoint value.
     # Examples:
     # Initializing with codepoint value...
-    # RegAn::Character.new(0x3a3) # Represents: Σ
+    # Regex::Character.new(0x3a3) # Represents: Σ
     # (Unicode GREEK CAPITAL LETTER SIGMA)
-    # RegAn::Character.new(931)   # Also represents: Σ (931 dec == 3a3 hex)
+    # Regex::Character.new(931)   # Also represents: Σ (931 dec == 3a3 hex)
     #
     # Initializing with a single character string
-    # RegAn::Character.new(?\u03a3) # Also represents: Σ
-    # RegAn::Character.new('Σ')   # Obviously, represents a Σ
+    # Regex::Character.new(?\u03a3) # Also represents: Σ
+    # Regex::Character.new('Σ')   # Obviously, represents a Σ
     #
     # Initializing with an escape sequence string
     # Recognized escaped characters are: \a (alarm, 0x07), \n (newline, 0xA),
@@ -56,8 +56,8 @@ module Regex # This module is used as a namespace
     # \uXXXX where XXXX is a 4 hex digits integer value, \u{X...}, \ooo (octal)
     # \xXX (hex)
     # Any other escaped character will be treated as a literal character
-    # RegAn::Character.new('\n')    # Represents a newline
-    # RegAn::Character.new('\u03a3')  # Represents a Σ
+    # Regex::Character.new('\n')    # Represents a newline
+    # Regex::Character.new('\u03a3')  # Represents a Σ
     def initialize(aValue)
       super()
       case aValue
@@ -80,7 +80,7 @@ module Regex # This module is used as a namespace
 
     # Convertion method that returns a character given a codepoint (integer) value.
     # Example:
-    # RegAn::Character::codepoint2char(0x3a3) # Returns: Σ (
+    # Regex::Character::codepoint2char(0x3a3) # Returns: Σ (
     # The Unicode GREEK CAPITAL LETTER SIGMA)
     def self.codepoint2char(aCodepoint)
       [aCodepoint].pack('U') # Remark: chr() fails with codepoints > 256
@@ -88,7 +88,7 @@ module Regex # This module is used as a namespace
 
     # Convertion method that returns the codepoint for the given single character.
     # Example:
-    # RegAn::Character::char2codepoint('Σ') # Returns: 0x3a3
+    # Regex::Character::char2codepoint('Σ') # Returns: 0x3a3
     def self.char2codepoint(aChar)
       aChar.ord
     end
@@ -102,7 +102,7 @@ module Regex # This module is used as a namespace
     # \xXX (hex)
     # Any other escaped character will be treated as a literal character
     # Example:
-    # RegAn::Character::esc2codepoint('\n') # Returns: 0xd
+    # Regex::Character::esc2codepoint('\n') # Returns: 0xd
     def self.esc2codepoint(esc_seq)
       msg = "Escape sequence #{esc_seq} does not begin with a backslash (\\)."
       raise StandardError, msg unless esc_seq[0] == '\\'

data/lib/regex/multiplicity.rb

@@ -70,6 +70,7 @@ module Regex # This module is used as a namespace
     end
 
     # Validation method. Return the validated lower bound value
+    # @param anUpperBound [Integer, Symbol] integer or :more symbol
     def valid_upper_bound(anUpperBound)
       err_msg = "Invalid upper bound of repetition count #{anUpperBound}"
       unless anUpperBound.kind_of?(Integer) || (anUpperBound == :more)

data/lib/srl_ruby/ast_builder.rb

@@ -12,8 +12,10 @@ module SrlRuby
   # (say, a parse tree) from simpler objects (terminal and non-terminal
   # nodes) and using a step by step approach.
   class ASTBuilder < Rley::ParseRep::ASTBaseBuilder
+    # @return [Hash]
     Terminal2NodeClass = {}.freeze
 
+    # @return [Array<Symbol>] Options for the regular expression
     attr_reader :options
 
     # Create a new AST builder instance.
@@ -24,6 +26,7 @@ module SrlRuby
     end
 
     # Notification that the parse tree construction is complete.
+    # @return [void]
     def done!
       apply_options
       super
@@ -31,10 +34,12 @@ module SrlRuby
 
     protected
 
+    # @return [Hash]
     def terminal2node
       Terminal2NodeClass
     end
 
+    # @return [void]
     def apply_options
       tree_root = result.root
       regexp_opts = []
@@ -62,12 +67,17 @@ module SrlRuby
       Rley::PTree::TerminalNode.new(aToken, aTokenPosition)
     end
 
+    # @param lowerBound [Integer]
+    # @param upperBound [Integer, Symbol]
+    # @return [Regex::Multiplicity]
     def multiplicity(lowerBound, upperBound)
       Regex::Multiplicity.new(lowerBound, upperBound, :greedy)
     end
 
     # rubocop: disable Style/OptionalBooleanParameter
 
+    # @param aString [String]
+    # @param [Array<Regex::Character>, Regex::Concatenation, Regex::Character]
     def string_literal(aString, to_escape = true)
       if aString.size > 1
         chars = []
@@ -90,6 +100,8 @@ module SrlRuby
     end
     # rubocop: enable Style/OptionalBooleanParameter
 
+    # @param lowerBound [Integer]
+    # @param upperBound [Integer]
     def char_range(lowerBound, upperBound)
       lower = Regex::Character.new(lowerBound)
       upper = Regex::Character.new(upperBound)

data/lib/srl_ruby/grammar.rb

@@ -111,6 +111,6 @@ module SrlRuby
   end
 
   # And now build the grammar and make it accessible via a global constant
-  # [Rley::Syntax::Grammar]
+  # @return [Rley::Syntax::Grammar]
   Grammar = builder.grammar
 end # module

data/lib/srl_ruby/tokenizer.rb

@@ -17,14 +17,31 @@ module SrlRuby
   # Delimiters: parentheses '(' and ')'
   # Separators: comma (optional)
   class Tokenizer
+    # @return [Regexp] Matches a SRL character class
     PATT_CHAR_CLASS = /[^,"\s]{2,}/
+
+    # @return [Regexp] Matches single digit
     PATT_DIGIT_LIT = /[0-9]((?=\s|,|\))|$)/
+
+    # @return [Regexp] Matches a SRL identifier
     PATT_IDENTIFIER = /[a-zA-Z_][a-zA-Z0-9_]+/
-    PATT_INTEGER = /[0-9]{2,}((?=\s|,|\))|$)/ # An integer has 2..* digits
+
+    # @return [Regexp] Matches a decimal integer. An integer has 2..* digits
+    PATT_INTEGER = /[0-9]{2,}((?=\s|,|\))|$)/
+
+    # @return [Regexp] Matches a single letter.
     PATT_LETTER_LIT = /[a-zA-Z]((?=\s|,|\))|$)/
+
+    # @return [Regexp] Matches a new line (cross-platform)
     PATT_NEWLINE = /(?:\r\n)|\r|\n/
-    PATT_STR_DBL_QUOTE = /"(?:\\"|[^"])*"/ # Double quotes literal?
-    PATT_STR_SNGL_QUOTE = /'(?:\\'|[^'])*'/ # Single quotes literal?
+
+    # @return [Regexp] Matches a text enclosed in double quotes
+    PATT_STR_DBL_QUOTE = /"(?:\\"|[^"])*"/
+
+    # @return [Regexp] Matches a text enclosed in single quotes
+    PATT_STR_SNGL_QUOTE = /'(?:\\'|[^'])*'/
+
+    # @return [Regexp] Matches SRL blank(s)
     PATT_WHITESPACE = /[ \t\f]+/
 
     # @return [StringScanner]
@@ -36,6 +53,7 @@ module SrlRuby
     # @return [Integer] offset of start of current line within input
     attr_reader(:line_start)
 
+    # @return [{String => String}] Mapping special single characters to symbolic names.
     Lexeme2name = {
       '(' => 'LPAREN',
       ')' => 'RPAREN',
@@ -43,6 +61,7 @@ module SrlRuby
     }.freeze
 
     # Here are all the SRL keywords (in uppercase)
+    # @return [{String => String}]
     Keywords = %w[
       ALL
       ALREADY
@@ -102,6 +121,7 @@ module SrlRuby
       WORD
     ].to_h { |x| [x, x] }
 
+    # Exception class for scanner/tokenizer failures.
     class ScanError < StandardError; end
 
     # Constructor. Initialize a tokenizer for SRL.
@@ -112,6 +132,8 @@ module SrlRuby
       @line_start = 0
     end
 
+    # Returns the sequence of tokens recognized from the input text given at initialization.
+    # @return [Array<Rley::Lexical::Token>]
     def tokens
       tok_sequence = []
       until @scanner.eos?
@@ -124,6 +146,7 @@ module SrlRuby
 
     private
 
+    # @return [Rley::Lexical::Token]
     def _next_token
       token = nil
 
@@ -170,6 +193,9 @@ module SrlRuby
       token
     end
 
+    # @param aSymbolName [String]
+    # @param aLexeme [String]
+    # @return [Rley::Lexical::Token]
     def build_token(aSymbolName, aLexeme)
       begin
         col = scanner.pos - aLexeme.size - @line_start + 1
@@ -184,6 +210,7 @@ module SrlRuby
     end
 
     # Event: next line detected.
+    # @return [Integer] Current scanning position (offset)
     def next_line_scanned
       @lineno += 1
       @line_start = scanner.pos

data/lib/srl_ruby/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module SrlRuby
-  VERSION = '0.4.14'
+  # @return [String] Version number of the Gem
+  VERSION = '0.4.15'
 end

data/srl_ruby.gemspec

@@ -68,12 +68,12 @@ SUMMARY
   spec.required_ruby_version = '>= 3.2.0'
 
   # Runtime dependencies
-  spec.add_dependency 'rley', '~> 0.8.11'
+  spec.add_dependency 'rley', '~> 0.9', '>= 0.9.02'
 
   # Development dependencies
-  spec.add_development_dependency 'bundler', '>= 2.2.0'
-  spec.add_development_dependency 'cucumber', '>= 3.1.2'
-  spec.add_development_dependency 'rake', '>= 12.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 2.2', '>= 2.2.0'
+  spec.add_development_dependency 'cucumber', '~> 9'
+  spec.add_development_dependency 'rake', '~> 13'
+  spec.add_development_dependency 'rspec', '~> 3', '>= 3.10.0'
   spec.metadata = { 'rubygems_mfa_required' => 'true' }
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: srl_ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.14
+  version: 0.4.15
 platform: ruby
 authors:
 - Dimitri Geshef
 bindir: bin
 cert_chain: []
-date: 2025-02-22 00:00:00.000000000 Z
+date: 2025-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rley
@@ -15,18 +15,27 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.11
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.02
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.11
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.02
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
@@ -34,6 +43,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
@@ -41,44 +53,50 @@ dependencies:
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: '9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.2
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.10.0
 description: |2
     A compiler and library that transforms highly readable Simple Regex Language
     patterns into regular expressions.
@@ -205,7 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.6
 specification_version: 4
 summary: A parser for the [Simple Regex Language](https://simple-regex.com/). It translates
   patterns expressed in SRL into plain Ruby Regexp objects or in regex literals. Use