stealth_dom_id 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1b2873eeed2f0437b75fe061a5261673f08992c186a60349c2460f63bdfbc007
+  data.tar.gz: 8ba04b34323b83b852f172a97a3ff4af9bc7756da6a1185e47ea34501465bd52
+SHA512:
+  metadata.gz: 6bf8818c874009b129f470fb5d9742ecb58e8f8bdf3abe81b20f725a80b62ccb7c20bf0f8b2e7535c1d5f7a8ca8aa8e336884d849b781e3a4ea1858d7a5ac441
+  data.tar.gz: 7deef458663e54886b5ed878bab0b2365fe4c61509cb0446899d228ada8d404ab45046c2e542043cbdfc6a475b56f41a446d0c2080b2ecc1963051553c7c1c97

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.16"
+gem 'standard', "~> 1.41"

data/Gemfile.lock

@@ -0,0 +1,124 @@
+PATH
+  remote: .
+  specs:
+    stealth_dom_id (0.2.0)
+      actionview (>= 3.0, < 8.1)
+      activesupport (>= 3.0, < 8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (7.2.2)
+      activesupport (= 7.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (7.2.2)
+      base64
+      benchmark (>= 0.3)
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.3.1)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
+      minitest (>= 5.1)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+    ast (2.4.2)
+    base64 (0.2.0)
+    benchmark (0.3.0)
+    bigdecimal (3.1.8)
+    builder (3.3.0)
+    concurrent-ruby (1.3.4)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    drb (2.2.1)
+    erubi (1.13.0)
+    i18n (1.14.6)
+      concurrent-ruby (~> 1.0)
+    json (2.7.5)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    logger (1.6.1)
+    loofah (2.23.1)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.25.1)
+    nokogiri (1.16.7-aarch64-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86-linux)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.16.7-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.26.3)
+    parser (3.3.5.1)
+      ast (~> 2.4.1)
+      racc
+    racc (1.8.1)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rubocop (1.66.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.33.1)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.22.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    securerandom (0.3.1)
+    standard (1.41.1)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.66.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.5)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.5.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.22.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.6.0)
+
+PLATFORMS
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  x86-linux
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  minitest (~> 5.16)
+  rake (~> 13.0)
+  standard (~> 1.41)
+  stealth_dom_id!
+
+BUNDLED WITH
+   2.5.22

data/README.md

@@ -0,0 +1,51 @@
+# StealthDomId
+
+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
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add stealth_dom_id
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+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.
+
+Instead of:
+```erb
+<%= dom_id(@user) %>
+# => "user_1"
+
+<%= dom_id(@user, column: :public_id) %>
+# => Outputs: "user_a1b2c3"
+```
+
+The `column` attribute is optional. `prefix` attribute is also supported.
+
+```erb
+<%= dom_id(@user, :admin, column: :public_id) %>
+# => Outputs: "admin_user_a1b2c3"
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "stealth_dom_id"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/release

@@ -0,0 +1,19 @@
+#!/usr/bin/env bash
+
+VERSION=$1
+
+if [ -z "$VERSION" ]; then
+  echo "Error: The version number is required."
+  echo "Usage: $0 <version-number>"
+  exit 1
+fi
+
+printf "# frozen_string_literal: true\n\nmodule StealthDomId\n  VERSION = \"$VERSION\"\nend\n" > ./lib/stealth_dom_id/version.rb
+bundle
+git add Gemfile.lock lib/stealth_dom_id/version.rb
+git commit -m "Bump version for $VERSION"
+git push
+git tag v$VERSION
+git push --tags
+gem build stealth_dom_id.gemspec
+gem push "stealth_dom_id-$VERSION.gem"

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/stealth_dom_id/core.rb

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

data/lib/stealth_dom_id/railtie.rb

@@ -0,0 +1,9 @@
+module StealthDomId
+  class Railtie < Rails::Railtie
+    initializer "stealth_dom_id.action_view" do
+      ActiveSupport.on_load(:action_view) do
+        include StealthDomId::Core
+      end
+    end
+  end
+end

data/lib/stealth_dom_id/version.rb

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

data/lib/stealth_dom_id.rb

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

data/stealth_dom_id.gemspec

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "lib/stealth_dom_id/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "stealth_dom_id"
+  spec.version = StealthDomId::VERSION
+  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.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"]
+
+  spec.required_ruby_version = ">= 3.0.0"
+  spec.add_dependency "actionview", ">= 3.0", "< 8.1"
+  spec.add_dependency "activesupport", ">= 3.0", "< 8.1"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: stealth_dom_id
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Rails Designer Developers
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionview
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "<"
+      - !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
+  internal database IDs.
+email:
+- devs@railsdesigner.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/release
+- bin/setup
+- lib/stealth_dom_id.rb
+- lib/stealth_dom_id/core.rb
+- lib/stealth_dom_id/railtie.rb
+- lib/stealth_dom_id/version.rb
+- stealth_dom_id.gemspec
+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: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.23
+signing_key:
+specification_version: 4
+summary: Extends Rails `dom_id` helper to support custom column-based identifiers
+test_files: []