urlpattern 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4087f8d670ecc5bb3901622507f4c30faa19cf3c45411eb16ac105bd17f88bdb
-  data.tar.gz: 38229915a8d7bcabbb6b29c42055f7c0cc3bcfe4ec1a6f855a550a2b0824af79
+  metadata.gz: c40ee2230fea1701cf0e24f3b5b7d3701dd44c1144109be76332ea25b04450ba
+  data.tar.gz: 9f190639b5226254b00d6f2d8b9b1cc20bf78bd9e56a2fce518571d2eb685a99
 SHA512:
-  metadata.gz: e6343f07b3d32ddaf1e61b5d9c3a44df9f921afd698695eb411ed85a55884f301da904dbb8560561a6acc64fff1dea128cb7754bf27f8c4d81cf9e88315029c3
-  data.tar.gz: 41e2c84cf4929d2a05a729ad93af724d1b468993541bff10423b548a65808decef08fb0f94876fa99f4b369b7f6cb997652d2f5507b246943908c56fb52116a5
+  metadata.gz: af8101a053b47f4c5d2bd074e9d0586dc8ac90ba205ef75831de8fcacd3f295fc6f61441cda98d82a41131c949a4dc4f3cb7d48c7da39d04ad191ef4d8eb64df
+  data.tar.gz: a8a692f3c4415840b68d65a81ed80e0f521ce2274400d352bbe8cb2152dcb47444eb829cef1ec1bf81ed7baf2971a4d2f2e9a580bc93d143e6b938a444f9c4d0

data/Cargo.lock

@@ -31,9 +31,9 @@ dependencies = [
 
 [[package]]
 name = "bitflags"
-version = "2.11.0"
+version = "2.11.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "843867be96c8daad0d758b57df9392b6d8d271134fce549de6ce169ff98a92af"
+checksum = "c4512299f36f043ab09a583e57bceb5a5aab7a73db1805848e8fef3c9e8c78b3"
 
 [[package]]
 name = "cexpr"
@@ -213,9 +213,9 @@ checksum = "bbd2bcb4c963f2ddae06a2efc7e9f3591312473c50c6685e1f298068316e66fe"
 
 [[package]]
 name = "libc"
-version = "0.2.184"
+version = "0.2.185"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "48f5d2a454e16a5ea0f4ced81bd44e4cfc7bd3a507b61887c99fd3538b28e4af"
+checksum = "52ff2c0fe9bc6cb6b14a0592c2ff4fa9ceb83eea9db979b0487cd054946a2b8f"
 
 [[package]]
 name = "libloading"
@@ -313,18 +313,18 @@ dependencies = [
 
 [[package]]
 name = "rb-sys"
-version = "0.9.126"
+version = "0.9.127"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "284799e73e899fe946fd77c7211b83bff61a1356e039ade7a2516a779e3212d0"
+checksum = "d7d7c9560fe42dcffa576941394075f18a17dce89fcf718a2fa90b7dc2134d12"
 dependencies = [
  "rb-sys-build",
 ]
 
 [[package]]
 name = "rb-sys-build"
-version = "0.9.126"
+version = "0.9.127"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "855fc1ad8943d12c89ef12f9147f1cc531f5bf19fb744112fdd317bb6ee7b5c5"
+checksum = "f1688e8f32967ba48c89e4dfa283b57f901075f542fc7ee9c3d7c5f9091ca1d9"
 dependencies = [
  "bindgen",
  "lazy_static",
@@ -509,7 +509,7 @@ dependencies = [
 
 [[package]]
 name = "urlpattern"
-version = "0.1.0"
+version = "0.1.1"
 dependencies = [
  "magnus",
  "rb-sys",

data/README.md

@@ -1,5 +1,9 @@
 # urlpattern
 
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-rubocop-brightgreen.svg)](https://github.com/rubocop/rubocop)
+[![Gem Version](https://badge.fury.io/rb/urlpattern.svg)](https://badge.fury.io/rb/urlpattern)
+[![Ruby](https://github.com/urlpattern/ruby-urlpattern/actions/workflows/main.yml/badge.svg)](https://github.com/urlpattern/ruby-urlpattern/actions/workflows/main.yml)
+
 An implementation of [the URL Pattern Standard](https://urlpattern.spec.whatwg.org/) for Ruby written in Rust.
 
 ## Description
@@ -10,23 +14,74 @@ It is useful on the server side when serving different pages based on the URL (a
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
 ```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+bundle add urlpattern
 ```
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install urlpattern
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+This library aims to expose an interface as close as possible to the URL Pattern Standard, but some differences are unavoidable because it is designed for Ruby, not JavaScript. For the exact details, please refer to [urlpattern.rbs](https://github.com/urlpattern/ruby-urlpattern/blob/main/sig/urlpattern.rbs).
+
+Most JavaScript examples from [Chrome for Developers](https://developer.chrome.com/docs/web-platform/urlpattern) and [MDN](https://developer.mozilla.org/en-US/docs/Web/API/URL_Pattern_API) can be adapted to Ruby without much difficulty.
+
+### `test`
+
+```rb
+require "urlpattern"
+
+pattern = URLPattern::URLPattern.new "https://example.com/admin/*"
+pattern.test? "https://example.com/admin/main/" #=> true
+pattern.test? "https://example.com/main/"       #=> false
+```
+
+### `exec`
+
+```rb
+require "urlpattern"
+
+pattern = URLPattern::URLPattern.new pathname: "/users/:id/"
+result = pattern.exec pathname: "/users/4163/"
+result[:pathname][:groups][:id] #=> 4163
+```
+
+### `base_url`
+
+```rb
+require "urlpattern"
+
+pattern = URLPattern::URLPattern.new "b", "https://example.com/a/"
+pattern.test? "a/b", "https://example.com/"                     #=> true
+pattern.test? "b", "https://example.com/a/"                     #=> true
+pattern.test? pathname: "b", base_url: "https://example.com/a/" #=> true
+```
+
+### `ignore_case`
+
+```rb
+require "urlpattern"
+
+pattern = URLPattern::URLPattern.new "https://example.com/test"
+pattern.test? "https://example.com/test" #=> true
+pattern.test? "https://example.com/TeST" #=> false
+
+pattern = URLPattern::URLPattern.new "https://example.com/test", ignore_case: true
+pattern.test? "https://example.com/test" #=> true
+pattern.test? "https://example.com/TeST" #=> true
+```
+
+## Limitations
+
+Due to limitations in the dependency [denoland/rust-urlpattern](https://github.com/denoland/rust-urlpattern), it may not support all features specified in [the standard](https://urlpattern.spec.whatwg.org/).
+
+Check `skip` in [`test/test_urlpattern.rb`](https://github.com/urlpattern/ruby-urlpattern/blob/main/test/test_urlpattern.rb).
 
 ## Development
 

data/Rakefile

@@ -19,4 +19,9 @@ RbSys::ExtensionTask.new("urlpattern", GEMSPEC) do |ext|
   ext.lib_dir = "lib/urlpattern"
 end
 
+Rake::Task["release:rubygem_push"].clear
+task "release:rubygem_push" do
+  Dir["pkg/*.gem"].each { |gem| sh "gem", "push", gem }
+end
+
 task default: %i[compile test rubocop]

data/ext/urlpattern/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "urlpattern"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2024"
 authors = ["방성범 (Bang Seongbeom) <bangseongbeom@gmail.com>"]
 license = "MIT"

data/lib/urlpattern/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: urlpattern
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - 방성범 (Bang Seongbeom)
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.91
+        version: 0.9.127
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.91
+        version: 0.9.127
 description: |
   It's a thin wrapper of denoland/rust-urlpattern with Magnus.