opaque_id 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b3fe09fbe6c8dd3f161f8067f1f4159b20d66987d4f83a1649bfebfe2d68af1
-  data.tar.gz: 3887547bac4c747e9c95b3ff1bbe456ea001d4e0a2432a2186d7a1343f3a40aa
+  metadata.gz: 9c8c508626e3cd753337a4a0ca5a6a7eecdce926bd0532f709bbbb19b2626975
+  data.tar.gz: cee4cdec34b43245b1abb4f35924498c034c9060648f9500705132a9e8742cb1
 SHA512:
-  metadata.gz: d3a0326565ef4d064bc651805c9126d313d22cfffbc26fb10ce5f38a9be794a3d67611838465d74eb59e27313bf8a2db1f1669055b79410e9c4c1cbfd6697a1b
-  data.tar.gz: afe1a2e68f187435cd3efe01871f926b191335bf3bf19958afe66c6e8e873321809e17eb699ff3f6d58cb6175d3296288abdaaa5d8c2b9ccc0ab87cff8c99fe9
+  metadata.gz: 72d0b70b4f3285b14e9522adf8682691c59d82db7457c468ceed724b4c381da8d297921cc891eeda749333f4f81f1170b69b33587e7ef8a0485f948492dea40a
+  data.tar.gz: 71f986687e83368d0a34ae4ce692a526a17c17c55ef3e77edd462e7f0ae9503c5dd943417bc4166e0a8f775eea897b2c93a06dedddf9fc267f5680af869acbab

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.3.0"
+  ".": "1.4.0"
 }

data/CHANGELOG.md

@@ -5,6 +5,26 @@ All notable changes to the OpaqueId gem will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.4.0](https://github.com/nyaggah/opaque_id/compare/opaque_id/v1.3.0...opaque_id/v1.4.0) (2025-10-02)
+
+
+### Features
+
+* add external links to sidebar using JavaScript ([cd77079](https://github.com/nyaggah/opaque_id/commit/cd770795936ca76633a18f80cba8482ec09db8e2))
+* add Table of Contents to all documentation pages ([9472175](https://github.com/nyaggah/opaque_id/commit/94721752270211d5b7db460da61d79a8a81218b2))
+* complete Table of Contents implementation ([5b037e4](https://github.com/nyaggah/opaque_id/commit/5b037e42692803204bc4d8991b6d2e0c9639a05c))
+
+
+### Bug Fixes
+
+* correct aux_links configuration format ([61b3fb9](https://github.com/nyaggah/opaque_id/commit/61b3fb9441ce3cfc3cf30637c277d19135f89dab))
+* use correct aux_links format ([d4a4bc0](https://github.com/nyaggah/opaque_id/commit/d4a4bc0c11bc66b661034915b471ed762611d821))
+
+
+### Code Refactoring
+
+* simplify external links implementation ([5cb84c1](https://github.com/nyaggah/opaque_id/commit/5cb84c1e8952a0fd1aa4b9089b9ff11829dc397c))
+
 ## [1.3.0](https://github.com/nyaggah/opaque_id/compare/opaque_id/v1.2.0...opaque_id/v1.3.0) (2025-10-02)
 
 

data/docs/_config.yml

@@ -1,5 +1,5 @@
 # Site settings
-title: OpaqueId Documentation
+title: OpaqueId
 description: Generate cryptographically secure, collision-free opaque IDs for ActiveRecord models
 url: "https://nyaggah.github.io"
 baseurl: "/opaque_id"
@@ -104,23 +104,12 @@ nav_external_links_new_tab: true
 nav_footer: true
 nav_order: 1
 
-# Header and footer
-header_links:
-  - title: "GitHub"
-    url: "https://github.com/nyaggah/opaque_id"
-  - title: "RubyGems"
-    url: "https://rubygems.org/gems/opaque_id"
-
-# Auxiliary links (moved to sidebar top)
+# Auxiliary links (appear at top right)
 aux_links:
-  - title: "GitHub"
-    url: "https://github.com/nyaggah/opaque_id"
-  - title: "RubyGems"
-    url: "https://rubygems.org/gems/opaque_id"
-  - title: "Issues"
-    url: "https://github.com/nyaggah/opaque_id/issues"
-  - title: "Releases"
-    url: "https://github.com/nyaggah/opaque_id/releases"
+  GitHub: https://github.com/nyaggah/opaque_id
+  RubyGems: https://rubygems.org/gems/opaque_id
+  Issues: https://github.com/nyaggah/opaque_id/issues
+  Releases: https://github.com/nyaggah/opaque_id/releases
 
 # Color scheme - use system theme with light fallback
 color_scheme: light

data/docs/algorithms.md

@@ -10,6 +10,9 @@ permalink: /algorithms/
 
 OpaqueId uses sophisticated algorithms to generate cryptographically secure, collision-free opaque IDs. This guide explains the technical details behind the generation process, optimization strategies, and mathematical foundations.
 
+- TOC
+  {:toc}
+
 ## Overview
 
 OpaqueId implements two primary algorithms optimized for different scenarios:

data/docs/alphabets.md

@@ -10,6 +10,9 @@ permalink: /alphabets/
 
 OpaqueId provides flexible alphabet configuration for generating IDs with different character sets. This guide covers built-in alphabets, custom alphabet creation, and best practices for alphabet selection.
 
+- TOC
+  {:toc}
+
 ## Built-in Alphabets
 
 OpaqueId comes with two pre-configured alphabets optimized for different use cases.

data/docs/api-reference.md

@@ -10,6 +10,9 @@ permalink: /api-reference/
 
 This document provides complete API documentation for OpaqueId, including all methods, classes, and configuration options.
 
+- TOC
+  {:toc}
+
 ## Core Module: OpaqueId
 
 The main module for generating opaque IDs.

data/docs/assets/css/custom.scss

@@ -292,59 +292,12 @@ table {
   color: var(--nav-child-link-color);
 }
 
-// Auxiliary links styling (top of sidebar)
-.aux-nav {
-  margin-bottom: 1.5rem;
-  padding-bottom: 1rem;
-  border-bottom: 1px solid var(--border-color-light);
-
-  .aux-nav-list {
-    list-style: none;
-    margin: 0;
-    padding: 0;
-    display: flex;
-    flex-wrap: wrap;
-    gap: 0.5rem;
-
-    .aux-nav-list-item {
-      margin: 0;
-
-      .aux-nav-list-link {
-        display: inline-flex;
-        align-items: center;
-        padding: 0.375rem 0.75rem;
-        font-size: 0.875rem;
-        font-weight: 500;
-        color: var(--aux-link-color);
-        text-decoration: none;
-        border: 1px solid var(--border-color);
-        border-radius: 6px;
-        background-color: transparent;
-        transition: all 0.2s ease;
-
-        &:hover {
-          color: var(--aux-link-hover-color);
-          border-color: var(--aux-link-hover-color);
-          background-color: rgba(168, 85, 247, 0.05);
-          text-decoration: none;
-        }
-
-        &:focus {
-          outline: 2px solid var(--aux-link-hover-color);
-          outline-offset: 2px;
-        }
-
-        // External link icon
-        &[href^="http"]:not([href*="nyaggah.github.io"]) {
-          &::after {
-            content: "↗";
-            margin-left: 0.25rem;
-            font-size: 0.75rem;
-            opacity: 0.7;
-          }
-        }
-      }
-    }
+// Simple external links styling
+.nav-list .nav-list-item .nav-list-link[href^="http"] {
+  color: var(--link-color);
+  
+  &:hover {
+    color: var(--link-color-hover);
   }
 }
 

data/docs/configuration.md

@@ -10,6 +10,9 @@ permalink: /configuration/
 
 OpaqueId provides extensive configuration options to customize ID generation for your specific needs. This guide covers all available configuration options with practical examples.
 
+- TOC
+  {:toc}
+
 ## Model-Level Configuration
 
 Configure OpaqueId on a per-model basis using class-level settings.

data/docs/development.md

@@ -10,6 +10,9 @@ permalink: /development/
 
 This guide covers development setup, guidelines, and contribution information for OpaqueId. Whether you're contributing to the project or developing applications that use OpaqueId, this guide will help you get started.
 
+- TOC
+  {:toc}
+
 ## Prerequisites
 
 Before you begin development, ensure you have the following installed:

data/docs/getting-started.md

@@ -10,6 +10,9 @@ permalink: /getting-started/
 
 This guide will help you get up and running with OpaqueId in your Rails application. We'll cover installation, basic setup, and common usage patterns.
 
+- TOC
+  {:toc}
+
 ## Prerequisites
 
 Before you begin, ensure you have:

data/docs/index.md

@@ -14,6 +14,9 @@ permalink: /
 
 A Ruby gem for generating cryptographically secure, collision-free opaque IDs for ActiveRecord models. OpaqueId provides a drop-in replacement for `nanoid.rb` using Ruby's built-in `SecureRandom` methods with optimized algorithms for unbiased distribution.
 
+- TOC
+  {:toc}
+
 ## Features
 
 - **🔐 Cryptographically Secure**: Uses Ruby's `SecureRandom` for secure ID generation

data/docs/installation.md

@@ -10,6 +10,9 @@ permalink: /installation/
 
 This guide covers all installation methods for OpaqueId, from basic setup to advanced configurations.
 
+- TOC
+  {:toc}
+
 ## Requirements
 
 Before installing OpaqueId, ensure your environment meets these requirements:

data/docs/performance.md

@@ -10,6 +10,9 @@ permalink: /performance/
 
 OpaqueId is designed for high performance with optimized algorithms and efficient memory usage. This guide covers benchmarks, optimization strategies, and scalability considerations.
 
+- TOC
+  {:toc}
+
 ## Performance Characteristics
 
 ### Generation Speed

data/docs/security.md

@@ -10,6 +10,9 @@ permalink: /security/
 
 OpaqueId is designed with security as a primary concern, providing cryptographically secure ID generation with protection against various attack vectors. This guide covers security considerations, best practices, and threat model analysis.
 
+- TOC
+  {:toc}
+
 ## Cryptographic Security
 
 ### SecureRandom Foundation

data/docs/usage.md

@@ -10,6 +10,9 @@ permalink: /usage/
 
 This guide covers all usage patterns for OpaqueId, from basic standalone generation to advanced ActiveRecord integration.
 
+- TOC
+  {:toc}
+
 ## Standalone ID Generation
 
 OpaqueId can be used independently of ActiveRecord for generating secure, random IDs.

data/docs/use-cases.md

@@ -10,6 +10,9 @@ permalink: /use-cases/
 
 OpaqueId is designed for a wide range of applications where secure, unpredictable identifiers are needed. This guide covers real-world use cases with practical examples and implementation patterns.
 
+- TOC
+  {:toc}
+
 ## E-Commerce Applications
 
 ### Order Management

data/lib/opaque_id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpaqueId
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opaque_id
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Joe Nyaggah