grex_ruby 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a2dd5cd77e2c7169182cc883204cf332f79822fb906c459644b982f8a882614
-  data.tar.gz: e8dfeb8f839b02283c62e2f0fc4c25d54dc505c8e10952d4405113fb9a898094
+  metadata.gz: 9eea98be32e92c0d87bc6675840278c2472767a7f57e48d01fde8bedb59b650d
+  data.tar.gz: 7bd0abf1026dbe6f9bb4e6c764952301c948da7b6647b9a2015b3a7553bb3e04
 SHA512:
-  metadata.gz: 695f7ea72cf70580dae52d2d755281e408cc357e6ca772fde12b10fca2aa4efbcd9d88933f2395e26fb5c25d126daa5775470aa28fa6ccb70bd910d6f507baa9
-  data.tar.gz: 1b1789d8ec092b42df5ecfd98fa8128412a22193c0e26c2890cf50ac325f4ca7bef79c7bd43ced3fc1121052ab783b1f272b207f4096104130e705d798aedb44
+  metadata.gz: 25bb8ab1dd9ac55dfdfcf1eb37841be34abd390cf2d27a4f541e1fb59735b780b5f4dabc0853b8463b2464cc0d7c222dfba91afa3c1f059196c5e7c0d4607f20
+  data.tar.gz: a45f66a23f259de711df1c84ce8e2df4335c2b568a493492cdddb4b7bce21f89fc072e29e88dff2ec2008cf43d824a6d45ebee51bf4ff0047a788823f08d66f2

data/CHANGELOG.md

@@ -1,7 +1,20 @@
-# Changelog
-
-## 0.1.0
-
-- Generate regular expression patterns from arrays of strings.
-- Support digit and repetition conversion.
-- Adapt digit classes for Unicode matching in Ruby.
+# Changelog
+
+## 0.2.0
+
+- Expose the public API as `Grex`, keeping `GrexRuby` as a compatibility alias.
+- Add conversion of non-digits, whitespace, non-whitespace, words and non-words.
+- Adapt character classes for Unicode matching in Ruby, preserving escaped literals.
+- Add minimum repetition count and minimum repeated substring length settings.
+- Support case-insensitive matching, capturing groups and verbose patterns.
+- Allow disabling both anchors or the start and end anchors individually.
+- Support non-ASCII escaping with Unicode code points understood by Ruby Regexp.
+- Document Ruby's line anchor semantics and local build prerequisites.
+- Include grex's Apache-2.0 license and third-party attribution in the gem.
+- Add regression coverage for combinations of conversion options.
+
+## 0.1.0
+
+- Generate regular expression patterns from arrays of strings.
+- Support digit and repetition conversion.
+- Adapt digit classes for Unicode matching in Ruby.

data/Cargo.lock

@@ -228,7 +228,7 @@ dependencies = [
 
 [[package]]
 name = "grex_ruby"
-version = "0.1.0"
+version = "0.2.0"
 dependencies = [
  "grex",
  "magnus",

data/README.md

@@ -1,56 +1,267 @@
-# GrexRuby
+# Grex
 
-GrexRuby provides Ruby bindings for the Rust library [grex](https://github.com/pemistahl/grex).
+Grex provides Ruby bindings for the Rust library [grex](https://github.com/pemistahl/grex).
 It generates a regular expression pattern from an array of example strings.
 
 ## Installation
 
-The gem is not published yet. To build it locally, follow the development instructions below.
+Install from RubyGems:
+
+```bash
+gem install grex_ruby
+```
+
+Or add it to your application's bundle:
+
+```bash
+bundle add grex_ruby
+```
+
+Grex requires Ruby 3.2 or newer. The gem builds its native extension during
+installation, so Rust (including Cargo), a C/C++ compiler, Make, libclang, and
+matching Ruby development headers must be available.
+
+Follow the dependency setup instructions for [Linux](#linux) or
+[Windows](#windows-64-bit-rubyinstaller-with-ucrt) below before installing.
+On Windows, set `LIBCLANG_PATH` and `RUST_TARGET` as shown there, then install with:
+
+```powershell
+ridk.cmd exec gem install grex_ruby
+```
 
 ## Usage
 
-`GrexRuby.generate` accepts a non-empty array of strings and returns a Ruby `String`.
+`Grex.generate` accepts a non-empty array of strings and returns a Ruby `String`.
+
+The gem name and require path remain `grex_ruby`. `GrexRuby` is kept as an alias
+of `Grex` for compatibility with version 0.1.0. The `Grex` module name is introduced
+in 0.2.0; version 0.1.0 uses `GrexRuby`.
 
 ```ruby
 require 'grex_ruby'
 
-GrexRuby.generate(%w[a aa aaa])
+Grex.generate(%w[a aa aaa])
 # => "^a(?:aa?)?$"
 
-GrexRuby.generate(%w[cat])
+Grex.generate(%w[cat])
 # => "^cat$"
 ```
 
-Both keyword options default to `false`:
-
-| Option | Behavior when enabled |
-| --- | --- |
-| `convert_digits` | Generalizes decimal digits to the Unicode digit class `\p{Nd}`. |
-| `convert_repetitions` | Converts repeated substrings to quantifiers such as `{3}`. |
+Keyword options:
+
+| Option                     | Default | Behavior                                                                                                                           |
+| -------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
+| `convert_digits`           | `false` | Generalizes decimal digits to the Unicode digit class `\p{Nd}`.                                                                    |
+| `convert_non_digits`       | `false` | Generalizes non-digit characters to the Unicode class `\P{Nd}`.                                                                    |
+| `convert_whitespace`       | `false` | Generalizes whitespace characters to the Unicode class `\p{Space}`.                                                                |
+| `convert_non_whitespace`   | `false` | Generalizes non-whitespace characters to the Unicode class `\P{Space}`.                                                            |
+| `convert_words`            | `false` | Generalizes individual Unicode word characters, including letters, decimal digits, marks, connector punctuation and join controls. |
+| `convert_non_words`        | `false` | Generalizes characters outside the Unicode word class, including punctuation, whitespace and emoji.                                |
+| `convert_repetitions`      | `false` | Converts repeated substrings to quantifiers such as `{3}`.                                                                         |
+| `minimum_substring_length` | `1`     | Minimum length of a repeated fragment eligible for conversion.                                                                     |
+| `minimum_repetitions`      | `1`     | Minimum number of repetitions after the fragment's first occurrence.                                                               |
+| `anchors`                  | `true`  | Keeps grex's `^` and `$` line anchors; set to `false` to omit both.                                                                |
+| `start_anchor`             | `true`  | Keeps the initial `^` anchor; set to `false` to remove it. `anchors: false` overrides this setting.                                |
+| `end_anchor`               | `true`  | Keeps the final `$` anchor; set to `false` to remove it. `anchors: false` overrides this setting.                                  |
+| `escape_non_ascii`         | `false` | Writes non-ASCII characters as Unicode code point escapes understood by Ruby Regexp.                                               |
+| `ignore_case`              | `false` | Generates a pattern that matches without regard to letter case.                                                                    |
+| `capturing_groups`         | `false` | Uses capturing groups instead of non-capturing groups.                                                                             |
+| `verbose`                  | `false` | Formats the pattern across multiple lines with indentation and enables extended mode.                                              |
+
+The two minimum settings affect generation when `convert_repetitions: true`.
+Both accept integers from `1` to `4_294_967_295`; zero raises `ArgumentError`.
 
 ```ruby
-GrexRuby.generate(%w[123])
+Grex.generate(%w[123])
 # => "^123$"
 
-GrexRuby.generate(%w[123], convert_digits: true)
+Grex.generate(%w[123], convert_digits: true)
 # => "^\\p{Nd}\\p{Nd}\\p{Nd}$"
 
-GrexRuby.generate(['aaa'], convert_repetitions: true)
+Grex.generate(['aaa'], convert_repetitions: true)
 # => "^a{3}$"
 
-GrexRuby.generate(['111'], convert_digits: true, convert_repetitions: true)
+Grex.generate(['111'], convert_digits: true, convert_repetitions: true)
 # => "^\\p{Nd}{3}$"
 ```
 
+Control which repetitions are converted:
+
+```ruby
+Grex.generate(['aaaa'], convert_repetitions: true, minimum_substring_length: 2)
+# => "^aaaa$"
+
+Grex.generate(['ababab'], convert_repetitions: true, minimum_substring_length: 2)
+# => "^(?:ab){3}$"
+
+Grex.generate(['aa'], convert_repetitions: true, minimum_repetitions: 2)
+# => "^aa$"
+
+Grex.generate(['aaa'], convert_repetitions: true, minimum_repetitions: 2)
+# => "^a{3}$"
+```
+
+For `minimum_repetitions`, the first occurrence is not counted as a repetition:
+`'aa'` has one repetition of `'a'`, while `'aaa'` has two.
+
 Digit conversion allows other decimal digits to match too, including non-ASCII
-digits. GrexRuby adapts grex's `\d` tokens to `\p{Nd}` because Ruby's `\d` matches
+digits. Grex adapts grex's `\d` tokens to `\p{Nd}` because Ruby's `\d` matches
 only ASCII digits.
 
+Use `convert_non_digits: true` to match non-digit characters. Ruby's Unicode
+class `\P{Nd}` excludes both ASCII and non-ASCII decimal digits:
+
+```ruby
+pattern = Grex.generate(['abc'], convert_non_digits: true)
+# => "^\\P{Nd}\\P{Nd}\\P{Nd}$"
+
+regexp = Regexp.new(pattern)
+regexp.match?('xyz')
+# => true
+
+regexp.match?('123')
+# => false
+
+regexp.match?('١٢٣')
+# => false
+```
+
+The adapter preserves escaped literal backslashes while
+converting grex's `\D` tokens to `\P{Nd}`.
+
+Use `convert_whitespace: true` to generalize spaces to other whitespace characters.
+Grex adapts grex's `\s` tokens to Ruby's Unicode class `\p{Space}`, so tabs and
+non-ASCII whitespace are recognized too:
+
+```ruby
+pattern = Grex.generate(['a b'], convert_whitespace: true)
+# => "^a\\p{Space}b$"
+
+regexp = Regexp.new(pattern)
+regexp.match?("a\tb")
+# => true
+
+regexp.match?("a\u00A0b") # NO-BREAK SPACE
+# => true
+
+regexp.match?('ab')
+# => false
+```
+
+By default, a literal space remains a literal space.
+
+Use `convert_non_whitespace: true` to match any non-whitespace characters,
+including digits. Grex adapts grex's `\S` tokens to Ruby's Unicode class
+`\P{Space}`, which excludes both ASCII and Unicode whitespace:
+
+```ruby
+pattern = Grex.generate(['abc'], convert_non_whitespace: true)
+# => "^\\P{Space}\\P{Space}\\P{Space}$"
+
+regexp = Regexp.new(pattern)
+regexp.match?('xyz')
+# => true
+
+regexp.match?('123')
+# => true
+
+regexp.match?("a\tb")
+# => false
+
+regexp.match?("a\u00A0b") # NO-BREAK SPACE
+# => false
+```
+
+The `convert_non_whitespace` option defaults to `false`. Escaped literal
+backslashes are preserved during adaptation.
+
+### Word conversion
+
+`convert_words: true` generalizes
+individual Unicode word characters, rather than entire words. Word characters
+include letters, decimal digits, combining marks, connector punctuation such as
+`_`, and join controls.
+
+For example:
+
+```ruby
+pattern = Grex.generate(['кот'], convert_words: true)
+regexp = Regexp.new(pattern)
+
+regexp.match?('мир')
+# => true
+
+regexp.match?('!!!')
+# => false
+```
+
+The default is `false`. Since Ruby's `\w` is ASCII-only, the adapter replaces
+grex's `\w` tokens with the explicit Unicode character class
+`[\p{Alpha}\p{M}\p{Nd}\p{Pc}\p{Join_Control}]`. Escaped literal backslashes
+are preserved. Unicode compatibility tests cover Cyrillic, non-ASCII digits,
+combining marks and join controls.
+
+### Non-word conversion
+
+`convert_non_words: true` generalizes individual characters outside the Unicode
+word class, including punctuation, whitespace and emoji. The default is `false`.
+The adapter replaces grex's `\W` tokens with
+`[^\p{Alpha}\p{M}\p{Nd}\p{Pc}\p{Join_Control}]`, preserving escaped literal
+backslashes.
+
+```ruby
+pattern = Grex.generate(['!'], convert_non_words: true)
+regexp = Regexp.new(pattern)
+
+regexp.match?('?')
+# => true
+
+regexp.match?('🐈')
+# => true
+
+regexp.match?('к')
+# => false
+
+regexp.match?('١')
+# => false
+```
+
+Letters, decimal digits, combining marks, connector punctuation such as `_`,
+and join controls are excluded.
+
+### Escaping non-ASCII characters
+
+Set `escape_non_ascii: true` to represent non-ASCII characters using `\u{...}`
+escapes. The resulting pattern still matches the original characters:
+
+```ruby
+pattern = Grex.generate(['кот'], escape_non_ascii: true)
+# => "^\\u{43a}\\u{43e}\\u{442}$"
+
+Regexp.new(pattern).match?('кот')
+# => true
+
+pattern = Grex.generate(['🐈'], escape_non_ascii: true)
+# => "^\\u{1f408}$"
+
+Regexp.new(pattern).match?('🐈')
+# => true
+
+Grex.generate(['cat'], escape_non_ascii: true)
+# => "^cat$"
+```
+
+The default is `false`, leaving Unicode characters literal. Emoji are escaped
+as code points rather than UTF-16 surrogate pairs. This changes the pattern's
+representation, not the characters it matches.
+
+### Matching patterns
+
 Pass the returned pattern to `Regexp.new` to match strings. Special characters
 in the examples, such as the dot below, are escaped:
 
 ```ruby
-pattern = GrexRuby.generate(['a.b'])
+pattern = Grex.generate(['a.b'])
 # => "^a\\.b$"
 
 regexp = Regexp.new(pattern)
@@ -62,6 +273,130 @@ regexp.match?('axb')
 # => false
 ```
 
+### Capturing groups
+
+By default, groups introduced by grex are non-capturing. Set
+`capturing_groups: true` to make their matches available through `MatchData#captures`:
+
+```ruby
+pattern = Grex.generate(%w[cat dog], capturing_groups: true)
+regexp = Regexp.new(pattern)
+
+regexp.match('cat').captures
+# => ["cat"]
+
+regexp.match('dog').captures
+# => ["dog"]
+```
+
+This option changes groups created by grex; it does not force a group around
+every pattern.
+
+### Verbose patterns
+
+Set `verbose: true` to generate a multiline pattern. Use `puts` to display
+the actual line breaks:
+
+```ruby
+pattern = Grex.generate(%w[cat dog], verbose: true)
+puts pattern
+```
+
+Output:
+
+```text
+(?x)
+^
+  (?:
+    cat
+    |
+    dog
+  )
+$
+```
+
+The inline `(?x)` flag enables extended mode: formatting whitespace is ignored
+and unescaped `#` starts a comment. grex escapes literal spaces and hashes from
+the input examples so that they still match:
+
+```ruby
+pattern = Grex.generate(['a b#c'], verbose: true)
+regexp = Regexp.new(pattern)
+
+regexp.match?('a b#c')
+# => true
+
+regexp.match?('ab#c')
+# => false
+```
+
+### Anchors in Ruby
+
+By default, grex generates `^` and `$` anchors. In Ruby these match the beginning
+and end of a line, so the pattern can match a complete line inside multiline text:
+
+```ruby
+regexp = Regexp.new(Grex.generate(['cat']))
+
+regexp.match?("dog\ncat\nbird")
+# => true
+```
+
+Use `anchors: false` to allow matches within a line as well:
+
+```ruby
+pattern = Grex.generate(['cat'], anchors: false)
+# => "cat"
+
+Regexp.new(pattern).match?('a cat sleeps')
+# => true
+```
+
+Set `start_anchor: false` to remove only the initial `^`, retaining the final `$`:
+
+```ruby
+pattern = Grex.generate(['cat'], start_anchor: false)
+# => "cat$"
+
+regexp = Regexp.new(pattern)
+regexp.match?('a cat')
+# => true
+
+regexp.match?('cat sleeps')
+# => false
+```
+
+Set `end_anchor: false` to remove only the final `$`, retaining the initial `^`:
+
+```ruby
+pattern = Grex.generate(['cat'], end_anchor: false)
+# => "^cat"
+
+regexp = Regexp.new(pattern)
+regexp.match?('cat sleeps')
+# => true
+
+regexp.match?('a cat')
+# => false
+
+Grex.generate(['cat'], start_anchor: false, end_anchor: false)
+# => "cat"
+```
+
+Both `start_anchor` and `end_anchor` default to `true`. Setting `anchors: false`
+removes both anchors even if the individual settings are explicitly `true`:
+
+```ruby
+Grex.generate(['cat'], anchors: false, start_anchor: true, end_anchor: true)
+# => "cat"
+```
+
+Ruby's `\A` and `\z` anchor the entire string rather than individual lines.
+Grex preserves grex's line anchors and does not automatically replace them with
+`\A` and `\z`.
+
+### Invalid input
+
 An empty array raises `ArgumentError` with the message `samples must not be empty`.
 Passing a string instead of an array, or an array containing an integer, raises
 `TypeError`.
@@ -164,4 +499,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/sk8hig
 
 ## License
 
-GrexRuby is available under the [MIT License](LICENSE.txt).
+The Ruby bindings in this project are available under the [MIT License](LICENSE.txt).
+The underlying Rust library grex is licensed under
+[Apache License 2.0](licenses/grex-APACHE-2.0.txt).
+Dependencies retain their own licenses; see [third-party notices](THIRD_PARTY_NOTICES.md).

data/Rakefile

@@ -1,18 +1,18 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-require "rb_sys/extensiontask"
-
-task build: :compile
-
-GEMSPEC = Gem::Specification.load("grex_ruby.gemspec")
-
-RbSys::ExtensionTask.new("grex_ruby", GEMSPEC) do |ext|
-  ext.lib_dir = "lib/grex_ruby"
-end
-
-task default: %i[compile spec]
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rb_sys/extensiontask"
+
+task build: :compile
+
+GEMSPEC = Gem::Specification.load("grex_ruby.gemspec")
+
+RbSys::ExtensionTask.new("grex_ruby", GEMSPEC) do |ext|
+  ext.lib_dir = "lib/grex_ruby"
+end
+
+task default: %i[compile spec]

data/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,24 @@
+# Third-party notices
+
+The Ruby bindings in this repository are licensed under MIT; see `LICENSE.txt`.
+Dependencies retain their own licenses. The MIT license for the bindings does
+not replace the licenses of those dependencies.
+
+## grex
+
+- Version: 1.4.6 (see `Cargo.lock` for the resolved version).
+- Project: https://github.com/pemistahl/grex
+- License: Apache License, Version 2.0.
+- Upstream copyright notice: Copyright © 2019-today Peter M. Stahl pemistahl@gmail.com
+- License text: `licenses/grex-APACHE-2.0.txt`, copied unchanged from the grex 1.4.6 crate.
+
+The bindings call grex through its public API. The source gem declares grex as
+a Cargo dependency; Cargo downloads it when building the native extension.
+The resulting native extension contains compiled dependency code.
+
+No separate NOTICE file was present in the grex 1.4.6 crate inspected for this
+release. This document records grex attribution and is not an upstream NOTICE file.
+
+Other dependencies listed in `Cargo.lock` and the gemspec have their own license
+terms. Before distributing precompiled gems, include the applicable license
+texts and notices for all dependencies incorporated into those binaries.

data/ext/grex_ruby/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "grex_ruby"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 authors = ["Nelly Simkova <sk8high3r@ya.ru>"]
 publish = false

data/ext/grex_ruby/extconf.rb

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
-
-require "mkmf"
-require "rb_sys/mkmf"
-
-create_rust_makefile("grex_ruby/grex_ruby")
+# frozen_string_literal: true
+
+require "mkmf"
+require "rb_sys/mkmf"
+
+create_rust_makefile("grex_ruby/grex_ruby")

data/ext/grex_ruby/src/lib.rs

@@ -1,18 +1,46 @@
 use grex::RegExpBuilder;
-use magnus::{function, prelude::*, Error, Ruby};
-
-pub fn generate(
-    ruby: &Ruby,
-    samples: Vec<String>,
-    convert_digits: bool,
-    convert_repetitions: bool,
-) -> Result<String, Error> {
+use magnus::{function, prelude::*, Error, RHash, Ruby};
+
+pub fn generate(ruby: &Ruby, samples: Vec<String>, options: RHash) -> Result<String, Error> {
+    let convert_digits: bool = options.fetch(ruby.to_symbol("convert_digits"))?;
+    let convert_repetitions: bool = options.fetch(ruby.to_symbol("convert_repetitions"))?;
+    let minimum_substring_length: u32 =
+        options.fetch(ruby.to_symbol("minimum_substring_length"))?;
+    let minimum_repetitions: u32 = options.fetch(ruby.to_symbol("minimum_repetitions"))?;
+    let anchors: bool = options.fetch(ruby.to_symbol("anchors"))?;
+    let ignore_case: bool = options.fetch(ruby.to_symbol("ignore_case"))?;
+    let capturing_groups: bool = options.fetch(ruby.to_symbol("capturing_groups"))?;
+    let verbose: bool = options.fetch(ruby.to_symbol("verbose"))?;
+    let convert_non_digits: bool = options.fetch(ruby.to_symbol("convert_non_digits"))?;
+    let convert_whitespace: bool = options.fetch(ruby.to_symbol("convert_whitespace"))?;
+    let convert_non_whitespace: bool = options.fetch(ruby.to_symbol("convert_non_whitespace"))?;
+    let convert_words: bool = options.fetch(ruby.to_symbol("convert_words"))?;
+    let convert_non_words: bool = options.fetch(ruby.to_symbol("convert_non_words"))?;
+    let start_anchor: bool = options.fetch(ruby.to_symbol("start_anchor"))?;
+    let end_anchor: bool = options.fetch(ruby.to_symbol("end_anchor"))?;
+    let escape_non_ascii: bool = options.fetch(ruby.to_symbol("escape_non_ascii"))?;
+
     if samples.is_empty() {
         return Err(Error::new(
             ruby.exception_arg_error(),
             "samples must not be empty",
         ));
     }
+
+    if minimum_substring_length == 0 {
+        return Err(Error::new(
+            ruby.exception_arg_error(),
+            "minimum_substring_length must be greater than zero",
+        ));
+    }
+
+    if minimum_repetitions == 0 {
+        return Err(Error::new(
+            ruby.exception_arg_error(),
+            "minimum_repetitions must be greater than zero",
+        ));
+    }
+
     let mut builder = RegExpBuilder::from(&samples);
 
     if convert_digits {
@@ -23,12 +51,63 @@ pub fn generate(
         builder.with_conversion_of_repetitions();
     }
 
+    if ignore_case {
+        builder.with_case_insensitive_matching();
+    }
+
+    builder.with_minimum_substring_length(minimum_substring_length);
+    builder.with_minimum_repetitions(minimum_repetitions);
+
+    if !anchors {
+        builder.without_anchors();
+    }
+
+    if capturing_groups {
+        builder.with_capturing_groups();
+    }
+
+    if verbose {
+        builder.with_verbose_mode();
+    }
+
+    if convert_non_digits {
+        builder.with_conversion_of_non_digits();
+    }
+
+    if convert_whitespace {
+        builder.with_conversion_of_whitespace();
+    }
+
+    if convert_non_whitespace {
+        builder.with_conversion_of_non_whitespace();
+    }
+
+    if convert_words {
+        builder.with_conversion_of_words();
+    }
+
+    if convert_non_words {
+        builder.with_conversion_of_non_words();
+    }
+
+    if !start_anchor {
+        builder.without_start_anchor();
+    }
+
+    if !end_anchor {
+        builder.without_end_anchor();
+    }
+
+    if escape_non_ascii {
+        builder.with_escaping_of_non_ascii_chars(false);
+    }
+
     Ok(builder.build())
 }
 
 #[magnus::init]
 fn init(ruby: &Ruby) -> Result<(), Error> {
-    let module = ruby.define_module("GrexRuby")?;
-    module.define_singleton_method("generate_native", function!(generate, 3))?;
+    let module = ruby.define_module("Grex")?;
+    module.define_singleton_method("generate_native", function!(generate, 2))?;
     Ok(())
 }

data/lib/grex_ruby/version.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
-module GrexRuby
-  VERSION = "0.1.0"
+module Grex
+  VERSION = "0.2.0"
 end
+
+# Compatibility with the public module name used in version 0.1.0.
+GrexRuby = Grex

data/lib/grex_ruby.rb

@@ -1,37 +1,66 @@
-# frozen_string_literal: true
-
-require_relative 'grex_ruby/version'
-require 'grex_ruby/grex_ruby'
-
-module GrexRuby
-  class Error < StandardError; end
-
-  def self.generate(samples, convert_digits: false, convert_repetitions: false)
-    pattern = generate_native(samples, convert_digits, convert_repetitions)
-    adapt_pattern(pattern)
-  end
-
-  def self.adapt_pattern(pattern)
-    chars = pattern.chars
-    result = +''
-    index = 0
-
-    while index < chars.length
-      if chars[index] == '\\'
-        result << if chars[index + 1] == 'd'
-                    '\p{Nd}'
-                  else
-                    chars[index, 2].join
-                  end
-        index += 2
-      else
-        result << chars[index]
-        index += 1
-      end
-    end
-
-    result
-  end
-
-  private_class_method :generate_native, :adapt_pattern
-end
+# frozen_string_literal: true
+
+require_relative 'grex_ruby/version'
+require 'grex_ruby/grex_ruby'
+
+module Grex
+  class Error < StandardError; end
+
+  def self.generate(samples,
+                    convert_digits: false,
+                    convert_repetitions: false,
+                    minimum_substring_length: 1,
+                    minimum_repetitions: 1,
+                    anchors: true,
+                    ignore_case: false,
+                    capturing_groups: false,
+                    verbose: false,
+                    convert_non_digits: false,
+                    convert_whitespace: false,
+                    convert_non_whitespace: false,
+                    convert_words: false,
+                    convert_non_words: false,
+                    start_anchor: true,
+                    end_anchor: true,
+                    escape_non_ascii: false)
+    pattern = generate_native(samples,
+                              { convert_digits:, convert_repetitions:, minimum_substring_length:, minimum_repetitions:,
+                                anchors:, ignore_case:, capturing_groups:, verbose:, convert_non_digits:, convert_whitespace:, convert_non_whitespace:, convert_words:, convert_non_words:, start_anchor:, end_anchor:, escape_non_ascii: })
+    adapt_pattern(pattern)
+  end
+
+  def self.adapt_pattern(pattern)
+    chars = pattern.chars
+    result = +''
+    index = 0
+
+    while index < chars.length
+      if chars[index] == '\\'
+        result << case chars[index + 1]
+                  when 'd'
+                    '\p{Nd}'
+                  when 'D'
+                    '\P{Nd}'
+                  when 's'
+                    '\p{Space}'
+                  when 'S'
+                    '\P{Space}'
+                  when 'w'
+                    '[\p{Alpha}\p{M}\p{Nd}\p{Pc}\p{Join_Control}]'
+                  when 'W'
+                    '[^\p{Alpha}\p{M}\p{Nd}\p{Pc}\p{Join_Control}]'
+                  else
+                    chars[index, 2].join
+                  end
+        index += 2
+      else
+        result << chars[index]
+        index += 1
+      end
+    end
+
+    result
+  end
+
+  private_class_method :generate_native, :adapt_pattern
+end

data/licenses/grex-APACHE-2.0.txt

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/sig/grex_ruby.rbs

@@ -1,5 +1,25 @@
-module GrexRuby
+module Grex
   VERSION: String
 
-  def self.generate: (Array[String], ?convert_digits: bool, ?convert_repetitions: bool) -> String
+  def self.generate: (
+    Array[String],
+    ?convert_digits: bool,
+    ?convert_repetitions: bool,
+    ?minimum_substring_length: Integer,
+    ?minimum_repetitions: Integer,
+    ?anchors: bool,
+    ?ignore_case: bool,
+    ?capturing_groups: bool,
+    ?verbose: bool,
+    ?convert_non_digits: bool,
+    ?convert_whitespace: bool,
+    ?convert_non_whitespace: bool,
+    ?convert_words: bool,
+    ?convert_non_words: bool,
+    ?start_anchor: bool,
+    ?end_anchor: bool,
+    ?escape_non_ascii: bool,
+  ) -> String
 end
+
+module GrexRuby = Grex

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grex_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nelly Simkova
@@ -37,17 +37,22 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- THIRD_PARTY_NOTICES.md
 - ext/grex_ruby/Cargo.toml
 - ext/grex_ruby/build.rs
 - ext/grex_ruby/extconf.rb
 - ext/grex_ruby/src/lib.rs
 - lib/grex_ruby.rb
 - lib/grex_ruby/version.rb
+- licenses/grex-APACHE-2.0.txt
 - sig/grex_ruby.rbs
 homepage: https://github.com/sk8higher/grex_ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/sk8higher/grex_ruby
+  source_code_uri: https://github.com/sk8higher/grex_ruby
+  changelog_uri: https://github.com/sk8higher/grex_ruby/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib