stealth_dom_id 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b2873eeed2f0437b75fe061a5261673f08992c186a60349c2460f63bdfbc007
-  data.tar.gz: 8ba04b34323b83b852f172a97a3ff4af9bc7756da6a1185e47ea34501465bd52
+  metadata.gz: bf34f14ddf5664d87736392bf155b9e62537479b04f54cc71fa079907ab5a152
+  data.tar.gz: 1b0a148be68c737e327a8c39f5bb611c7ac4cc1785b706750b9234dbcabc8278
 SHA512:
-  metadata.gz: 6bf8818c874009b129f470fb5d9742ecb58e8f8bdf3abe81b20f725a80b62ccb7c20bf0f8b2e7535c1d5f7a8ca8aa8e336884d849b781e3a4ea1858d7a5ac441
-  data.tar.gz: 7deef458663e54886b5ed878bab0b2365fe4c61509cb0446899d228ada8d404ab45046c2e542043cbdfc6a475b56f41a446d0c2080b2ecc1963051553c7c1c97
+  metadata.gz: d84dad44771f169545508d05df8d205e36f831ff7eaba8ec18014d41482acbc8980216b0f4ee82cb512d2cef537f883a3230c71536d4b9ec1d19e58f231f318b
+  data.tar.gz: 97d53062743fe65d01ca52b140c56183d00107881c954c8893b0eead75b370394fdd499351438718e7c2b5468aec6a0d56dfbac9fbd64191c3e50f0409e660b5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    stealth_dom_id (0.2.0)
+    stealth_dom_id (0.3.0)
       actionview (>= 3.0, < 8.1)
       activesupport (>= 3.0, < 8.1)
 

data/README.md

@@ -1,6 +1,6 @@
-# StealthDomId
+# stealth_dom_id
 
-stealth_dom_id extends Rails' [`dom_id`](https://github.com/rails/rails/blob/main/actionview/lib/action_view/record_identifier.rb) helper to generate DOM IDs using alternative columns instead of database primary keys. This helps prevent exposing internal database IDs
+stealth_dom_id extends Rails' [`dom_id`](https://github.com/rails/rails/blob/main/actionview/lib/action_view/record_identifier.rb) helper to generate DOM IDs using an alternative attribute instead of database primary keys. This helps prevent exposing internal database IDs
 
 
 ## Installation
@@ -20,21 +20,21 @@ gem install stealth_dom_id
 
 ## Usage
 
-This gem extends Rails' `dom_id` helper to use alternative columns instead of exposing database IDs in your HTML elements.
+This gem extends Rails' `dom_id` helper to use an alternative attribute instead of exposing database IDs in your HTML elements.
 
 Instead of:
 ```erb
 <%= dom_id(@user) %>
 # => "user_1"
 
-<%= dom_id(@user, column: :public_id) %>
+<%= dom_id(@user, attribute: :public_id) %>
 # => Outputs: "user_a1b2c3"
 ```
 
-The `column` attribute is optional. `prefix` attribute is also supported.
+`attribute` is optional. `prefix` attribute is, just with `dom_id`, also supported.
 
 ```erb
-<%= dom_id(@user, :admin, column: :public_id) %>
+<%= dom_id(@user, :admin, attribute: :public_id) %>
 # => Outputs: "admin_user_a1b2c3"
 ```
 

data/lib/stealth_dom_id/core.rb

@@ -1,11 +1,11 @@
 module StealthDomId
-  class ColumnError < ArgumentError; end
+  class AttributeError < ArgumentError; end
 
   module Core
-    def dom_id(record_or_class, prefix = nil, column: nil)
+    def dom_id(record_or_class, prefix = nil, attribute: nil)
       unless record_or_class.is_a?(Class)
-        record_id = if column
-          record_key_for_dom_id_by_column(record_or_class, column: column)
+        record_id = if attribute
+          record_key_for_dom_id_by_attribute(record_or_class, attribute: attribute)
         else
           record_key_for_dom_id(record_or_class)
         end
@@ -23,12 +23,12 @@ module StealthDomId
     JOIN = "_".freeze
     NEW = "new".freeze
 
-    def record_key_for_dom_id_by_column(record, column:)
-      key = [convert_to_model(record).send(column)]
+    def record_key_for_dom_id_by_attribute(record, attribute:)
+      key = [convert_to_model(record).send(attribute)]
 
       key ? key.join(JOIN) : key
     rescue NoMethodError => e
-      raise ColumnError, "[StealthDomId] Column '#{column}' not found on #{record.class}"
+      raise AttributeError, "[StealthDomId] Attribute '#{attribute}' not found on #{record.class}"
     end
   end
 end

data/lib/stealth_dom_id/railtie.rb

@@ -4,6 +4,10 @@ module StealthDomId
       ActiveSupport.on_load(:action_view) do
         include StealthDomId::Core
       end
+
+      ActiveSupport.on_load(:view_component) do
+        ViewComponent::Base.include StealthDomId::Core
+      end
     end
   end
 end

data/lib/stealth_dom_id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StealthDomId
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/stealth_dom_id.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "stealth_dom_id/version"
+# require "active_support"
+require "stealth_dom_id/version"
 require "stealth_dom_id/core"
-require "active_support"
+require "stealth_dom_id/railtie" if defined?(Rails)
 
 module StealthDomId
   class Error < StandardError; end
 end
-
-ActiveSupport.on_load(:action_view) do
-  include StealthDomId::Core
-end

data/stealth_dom_id.gemspec

@@ -8,13 +8,12 @@ Gem::Specification.new do |spec|
   spec.authors = ["Rails Designer Developers"]
   spec.email = ["devs@railsdesigner.com"]
 
-  spec.summary = "Extends Rails `dom_id` helper to support custom column-based identifiers"
-  spec.description = "StealthDomId extends Rails' `dom_id` helper to generate DOM IDs using alternative columns instead of database primary keys. This helps prevent exposing internal database IDs."
+  spec.summary = "Extends Rails `dom_id` helper to support custom attribute-based identifiers (example “slug”)"
+  spec.description = "stealth_dom_id extends Rails' `dom_id` helper to generate DOM IDs using an alternative attribute instead of database primary keys. This helps prevent exposing internal database IDs."
   spec.homepage = "https://github.com/Rails-Designer/stealth_dom_id/"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 3.0.0"
 
-  spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/Rails-Designer/stealth_dom_id/"
 
   spec.files = Dir["{bin,app,config,db,lib,public}/**/*", "Rakefile", "README.md", "stealth_dom_id.gemspec", "Gemfile", "Gemfile.lock"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stealth_dom_id
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Rails Designer Developers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-06 00:00:00.000000000 Z
+date: 2024-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -50,8 +50,8 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.1'
-description: StealthDomId extends Rails' `dom_id` helper to generate DOM IDs using
-  alternative columns instead of database primary keys. This helps prevent exposing
+description: stealth_dom_id extends Rails' `dom_id` helper to generate DOM IDs using
+  an alternative attribute instead of database primary keys. This helps prevent exposing
   internal database IDs.
 email:
 - devs@railsdesigner.com
@@ -75,7 +75,6 @@ homepage: https://github.com/Rails-Designer/stealth_dom_id/
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/Rails-Designer/stealth_dom_id/
   source_code_uri: https://github.com/Rails-Designer/stealth_dom_id/
 post_install_message:
 rdoc_options: []
@@ -95,5 +94,6 @@ requirements: []
 rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
-summary: Extends Rails `dom_id` helper to support custom column-based identifiers
+summary: Extends Rails `dom_id` helper to support custom attribute-based identifiers
+  (example “slug”)
 test_files: []