js_regex_to_ruby 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdbe70d784541cad9e2009b2306416e72349cfc5e9136cadb998faf811d5ad91
-  data.tar.gz: fee286185020e60bf68b8c36736993ed75f8056fae28a882d977498a35445b44
+  metadata.gz: 4aafea531008742c38c529eee7b2145db1dbffa69b3fb1d4b6ff5d6c8931a0f8
+  data.tar.gz: 3c26adad1068ded864447c384fab39b339b8abb12a401617fcaaecde385b19ea
 SHA512:
-  metadata.gz: b9290e4565d2635db41c94ffbf865dbe3a085d943c413e5f5c635c74b67584ff73e09e0fe230674f662146cf170e8977e474d9aa0963b47aa84da4a3012a18ce
-  data.tar.gz: d12f32df94de6834ce18c083e0b0ba9eaadacdf1ed4c56a6e39c236e4308e1337710eb33a1ebe5f34474e52ba75db90af5654c6eadea37ecee8c2e8f90f54cd0
+  metadata.gz: ca43d3056ef25e4cf29f630b11dd5bbaf21a210b5e77756d45f572ca5339e9c22941c29eb3131da0c688a56d41e111bdff5643a80097f13385a09b9cc6a84b6f
+  data.tar.gz: eca9a62564569a9a8e4413804e85c6c94254cd98fca8e0d9ecd2c91e7301028c2ef2eea884d16db1a0b1f4d9ed99e3efd64c17da2e5dcbc6776e02e1508e4836

data/README.md

@@ -69,6 +69,25 @@ JsRegexToRuby.try_convert("/(?invalid/")    #=> nil
 JsRegexToRuby.try_convert(nil)              #=> nil
 ```
 
+#### `literal_only` Option
+
+By default, strings without `/` delimiters are treated as raw pattern sources:
+
+```ruby
+JsRegexToRuby.try_convert("cat")  #=> /cat/ (compiled as pattern)
+```
+
+If you only want to accept JS regex literals (strings starting with `/`), use `literal_only: true`:
+
+```ruby
+# Only accept /pattern/flags format
+JsRegexToRuby.try_convert("cat", literal_only: true)   #=> nil (not a literal)
+JsRegexToRuby.try_convert("/cat/", literal_only: true) #=> /cat/
+JsRegexToRuby.try_convert("/cat/i", literal_only: true) #=> /cat/i
+```
+
+This is useful when you want to distinguish between plain strings (like keywords) and regex patterns in user input.
+
 ### Parsing JS Literal Without Converting
 
 ```ruby

data/lib/js_regex_to_ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JsRegexToRuby
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/js_regex_to_ruby.rb

@@ -17,18 +17,32 @@ module JsRegexToRuby
   # Returns the compiled Regexp on success, or nil on failure.
   # Never raises exceptions for invalid input.
   #
-  # @example
+  # @example With JS regex literal (starts with /)
   #   JsRegexToRuby.try_convert('/^foo$/i')  #=> /\Afoo\z/i
-  #   JsRegexToRuby.try_convert('not a regex')  #=> nil
-  #   JsRegexToRuby.try_convert('/invalid[/') #=> nil
+  #   JsRegexToRuby.try_convert('/invalid[/')  #=> nil (invalid regex syntax)
+  #
+  # @example With pattern source (no / delimiter) - treated as raw pattern
+  #   JsRegexToRuby.try_convert('cat')  #=> /cat/
+  #   JsRegexToRuby.try_convert('[invalid')  #=> nil (invalid regex syntax)
   #
-  # @param input [String] Either a JS literal `/.../flags` or a JS pattern source.
+  # @example With literal_only: true - only accept /.../ format
+  #   JsRegexToRuby.try_convert('cat', literal_only: true)  #=> nil (doesn't start with /)
+  #   JsRegexToRuby.try_convert('/cat/', literal_only: true)  #=> /cat/
+  #
+  # @param input [String, #to_s] Either a JS literal `/.../flags` or a JS pattern source.
   # @param flags [String, nil] JS flags if input is not a literal.
+  # @param literal_only [Boolean] If true, returns nil for inputs that don't look like
+  #   JS regex literals (i.e., don't start with "/"). Useful when you want to treat
+  #   plain strings like "cat" as non-regex values rather than pattern sources.
   # @return [Regexp, nil] The compiled Ruby Regexp, or nil if conversion/compilation failed.
-  def self.try_convert(input, flags: nil)
-    result = Converter.convert(input, flags: flags, compile: true)
-    result.regexp
-  rescue ArgumentError, RegexpError
+  def self.try_convert(input, flags: nil, literal_only: false)
+    if literal_only
+      input = input.to_s
+      return nil unless input.start_with?("/")
+    end
+
+    Converter.convert(input, flags: flags, compile: true).regexp
+  rescue
     nil
   end
 

data/sig/js_regex_to_ruby.rbs

@@ -1,3 +1,8 @@
+# Interface for objects that respond to #to_s
+interface _ToS
+  def to_s: () -> String
+end
+
 module JsRegexToRuby
   VERSION: String
 
@@ -5,7 +10,9 @@ module JsRegexToRuby
   def self.convert: (String input, ?flags: String?, ?compile: bool) -> Result
 
   # Try to convert a JS regex to Ruby Regexp, returns nil on failure
-  def self.try_convert: (String input, ?flags: String?) -> Regexp?
+  # - When literal_only: false (default), only String inputs are processed; non-strings return nil
+  # - When literal_only: true, input is converted via #to_s; returns nil if not starting with "/"
+  def self.try_convert: (String | _ToS input, ?flags: String?, ?literal_only: bool) -> Regexp?
 
   # Parse a JS regex literal into pattern and flags
   def self.parse_literal: (String literal) -> [String, String]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: js_regex_to_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - jasl