domain_extractor 0.1.9 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b919b52fe3fda7edf9738141e66e2acbcb2458d276800cb62b48c4c34d3b914
-  data.tar.gz: be02cf195da3a6a9da51136140f1487e96c026b22f1a300825d15733eb493acf
+  metadata.gz: e98bbd81335ec24e45ed141b05b71f65106e3e441f54a772722b7a56d4e1cb5c
+  data.tar.gz: 9cdecbb53f3ec5bb9b6758d5e6b95991245f1ad97d8b22ef15fbc0fd4f074b32
 SHA512:
-  metadata.gz: 981d228483ba55b85834c38df3146a47018be6b7456053add7356a74f15d33cd27038d50682e5488f14ff9dfd09ef463bee1bbd6f7c486d9e9698dd305543738
-  data.tar.gz: e320e6d216196664de8f73b18be95746863b60fba99e496dc166ebd2f051afdf475d56f7d7a30dc6910e66d380e5b03b7d472730698905ed5b83e87aba3eb4e5
+  metadata.gz: 23d81dafbcbb998c8bd94d0c649796ecc999fad5263354d49172ebd7db5ecc536c4705c537726d88be9b88d3c49bb071e9e841ef5f025e912ed0413557050777
+  data.tar.gz: 34b21e93c8e7351dcb867c8bacf106175dcd5cb432e372ad60031a7e0733e82371e66410790b5d6f77e8429d80fe9949b458cdda51ff9db2c399e347042d406e

data/README.md

@@ -1,12 +1,12 @@
 # DomainExtractor
 
-[![Gem Version](https://badge.fury.io/rb/domain_extractor.svg)](https://badge.fury.io/rb/domain_extractor)
+[![Gem Version](https://badge.fury.io/rb/domain_extractor.svg?v=020)](https://badge.fury.io/rb/domain_extractor)
 [![CI](https://github.com/opensite-ai/domain_extractor/actions/workflows/ci.yml/badge.svg)](https://github.com/opensite-ai/domain_extractor/actions/workflows/ci.yml)
 [![Code Climate](https://codeclimate.com/github/opensite-ai/domain_extractor/badges/gpa.svg)](https://codeclimate.com/github/opensite-ai/domain_extractor)
 
 A lightweight, robust Ruby library for url parsing and domain parsing with **accurate multi-part TLD support**. DomainExtractor delivers a high-throughput url parser and domain parser that excels at domain extraction tasks while staying friendly to analytics pipelines. Perfect for web scraping, analytics, url manipulation, query parameter parsing, and multi-environment domain analysis.
 
-Use DomainExtractor whenever you need a dependable tld parser for tricky multi-part tld registries or reliable subdomain extraction in production systems.
+Use **DomainExtractor** whenever you need a dependable tld parser for tricky multi-part tld registries or reliable subdomain extraction in production systems.
 
 ## Why DomainExtractor?
 
@@ -78,6 +78,7 @@ DomainExtractor now returns a `ParsedURL` object that supports three accessor st
 ### Method Accessor Styles
 
 #### 1. Default Methods (Silent Nil)
+
 Returns the value or `nil` - perfect for exploratory code or when handling invalid data gracefully.
 
 ```ruby
@@ -93,6 +94,7 @@ result.domain       # => 'example'
 ```
 
 #### 2. Bang Methods (!) - Explicit Errors
+
 Returns the value or raises `InvalidURLError` - ideal for production code where missing data should fail fast.
 
 ```ruby
@@ -102,6 +104,7 @@ result.subdomain!   # raises InvalidURLError: "subdomain not found or invalid"
 ```
 
 #### 3. Question Methods (?) - Boolean Checks
+
 Always returns `true` or `false` - perfect for conditional logic without exceptions.
 
 ```ruby
@@ -261,7 +264,7 @@ hash = result.to_h
 # }
 ```
 
-**See [docs/PARSED_URL_API.md](docs/PARSED_URL_API.md) for comprehensive documentation and real-world examples.**
+**[Comprehensive documentation and real-world examples of parsed URL quick start guide](https://github.com/opensite-ai/domain_extractor/blob/master/docs/PARSED_URL_QUICK_START.md)**
 
 ## Usage Examples
 
@@ -326,31 +329,38 @@ DomainExtractor.parse('not-a-url')
 
 ## API Reference
 
-### `DomainExtractor.parse(url_string)`
-
-Parses a URL string and extracts domain components.
+```ruby
+DomainExtractor.parse(url_string)
 
-**Returns:** Hash with keys `:subdomain`, `:domain`, `:tld`, `:root_domain`, `:host`, `:path`
+# => Parses a URL string and extracts domain components.
 
-**Raises:** `DomainExtractor::InvalidURLError` when the URL fails validation
+# Returns: Hash with keys :subdomain, :domain, :tld, :root_domain, :host, :path
+# Raises: DomainExtractor::InvalidURLError when the URL fails validation
+```
 
-### `DomainExtractor.parse_batch(urls)`
+```ruby
+DomainExtractor.parse_batch(urls)
 
-Parses multiple URLs efficiently.
+# => Parses multiple URLs efficiently.
 
-**Returns:** Array of parsed results
+# Returns: Array of parsed results
+```
 
-### `DomainExtractor.valid?(url_string)`
+```ruby
+DomainExtractor.valid?(url_string)
 
-Checks if a URL can be parsed successfully without raising.
+# => Checks if a URL can be parsed successfully without raising.
 
-**Returns:** `true` or `false`
+# Returns: true or false
+```
 
-### `DomainExtractor.parse_query_params(query_string)`
+```ruby
+DomainExtractor.parse_query_params(query_string)
 
-Parses a query string into a hash of parameters.
+# => Parses a query string into a hash of parameters.
 
-**Returns:** Hash of query parameters
+# Returns: Hash of query parameters
+```
 
 ## Use Cases
 
@@ -389,7 +399,7 @@ Optimized for high-throughput production use:
 - **Thread-safe**: Stateless modules, safe for concurrent use
 - **Zero-allocation hot paths**: Frozen constants, pre-compiled regex
 
-See [PERFORMANCE.md](https://github.com/opensite-ai/domain_extractor/docs/PERFORMANCE.md) for detailed benchmarks and optimization strategies and benchmark results along with a full set of enhancements made in order to meet the highly performance centric requirements of the OpenSite AI site rendering engine, showcased in the [OPTIMIZATION_SUMMARY.md](https://github.com/opensite-ai/domain_extractor/docs/OPTIMIZATION_SUMMARY.md)
+View [performance analysis](https://github.com/opensite-ai/domain_extractor/blob/master/docs/PERFORMANCE.md) for detailed benchmarks and optimization strategies and benchmark results along with a full set of enhancements made in order to meet the highly performance centric requirements of the OpenSite AI site rendering engine, showcased in the [optimization summary](https://github.com/opensite-ai/domain_extractor/blob/master/docs/OPTIMIZATION_SUMMARY.md)
 
 ## Comparison with Alternatives
 

data/lib/domain_extractor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DomainExtractor
-  VERSION = '0.1.9'
+  VERSION = '0.2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: domain_extractor
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.1
 platform: ruby
 authors:
 - OpenSite AI
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-10-31 00:00:00.000000000 Z
+date: 2025-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: public_suffix