activeadmin_friendly_id_disabler 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bde44090af3a0c7f166d64dc3b4fbedab9754367cc7b9e3ebcc7349117adfa07
+  data.tar.gz: 92c723789faba3b5cf6dea6a472425a1bed7048ebc29d0384d45d8009bd48e27
+SHA512:
+  metadata.gz: 89a5af8bd0d6bc09ea13d866deb0e623e6e186e8a82013a6de379770c2148e18b2fc10d95aa457fb04d9a0524b52678fc7ccb64cc9f43d23d8e478196e7521c4
+  data.tar.gz: 8d73421e4e80c36a3cfbf69a8ccba6b9362c6e1351f63287ad2a066754f1fd61935df8499b7a10d2a7ab5d4bcddb5a9ee8f94451ee370652f9806abf2b3b1054

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Alexey Gordienko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,69 @@
+# ActiveAdmin FriendlyId Disabler
+
+`activeadmin_friendly_id_disabler` is a Ruby gem designed to selectively disable the `FriendlyId` behavior for ActiveAdmin environments.
+This allows applications to use standard IDs in URLs instead of slugs, which can help avoid potential conflicts and improve compatibility with certain frameworks.
+
+## Features
+
+- Temporarily disables `FriendlyId` functionality in ActiveAdmin controllers.
+- Automatically reverts to standard ID usage within the specified context.
+- Integrated using thread-local variables to ensure thread safety.
+
+## Installation
+
+1. **Add the gem to your Gemfile:**
+
+   ```ruby
+   gem 'activeadmin_friendly_id_disabler'
+
+   ```
+
+2. **Bundle Install:**
+
+   Run the following command to install the gem:
+
+   ```shell
+   bundle install
+
+   ```
+
+3. **Create an initializer:**
+
+   You need to configure your Rails application to use this module in ActiveAdmin controllers by creating an initializer. Create a file `config/initializers/activeadmin_friendly_id_disabler.rb`:
+
+   ```ruby
+   Rails.application.config.after_initialize do
+     ActiveAdmin::BaseController.include(ActiveAdmin::FriendlyIdDisabler)
+   end
+
+   ```
+
+   This code ensures that the `FriendlyId` is disabled for ActiveAdmin actions after the application initializes.
+
+## Usage
+
+Once you have installed the gem and set up the initializer, `FriendlyId` will be disabled in the context of ActiveAdmin controllers. This means any URLs generated will use the standard record IDs instead of slugs, preventing issues where slugs may not be necessary or desirable.
+
+## Example
+
+Here's a simple example of a `to_param` override within your models:
+
+```ruby
+class Post < ApplicationRecord
+  extend FriendlyId
+  friendly_id :title, use: :slugged
+end
+
+```
+
+## Configuration
+
+By default, the gem will automatically disable `FriendlyId` only for the duration of an action within ActiveAdmin controllers. If you need more granular control or need to disable `FriendlyId` in other parts of your application, consider implementing additional custom logic.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/gordienko/activeadmin_friendly_id_disabler](https://github.com/gordienko/activeadmin_friendly_id_disabler).
+
+## License
+
+The gem is available as open-source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/activeadmin/friendly_id_disabler.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# The FriendlyIdDisabler module is designed to be used in ActiveAdmin controllers
+# to temporarily disable FriendlyId's functionality during specific actions.
+# This is especially useful when dealing with ActiveAdmin, which may not require
+# the friendly slugs that FriendlyId generates.
+#
+# To use this module, include it in the ActiveAdmin controller context where you
+# want to disable FriendlyId.
+
+module ActiveAdmin
+  # This module disables FriendlyId for the duration of the specified action.
+  module FriendlyIdDisabler
+    extend ActiveSupport::Concern
+
+    included do
+      # Prepend an around_action filter to disable FriendlyId when the action is run.
+      prepend_around_action :disable_friendly_id
+    end
+
+    # Temporarily disables FriendlyId functionality within the given block.
+    #
+    # @param action [Proc] the block of code (typically a controller action) during which
+    #   FriendlyId should be disabled.
+    #
+    # @note This method leverages a thread-local variable to manage the disabled state,
+    #   ensuring that the disabling is scoped to the current thread only.
+    def disable_friendly_id(&action)
+      ::FriendlyId::Disabler.disable_friendly_id(&action)
+    end
+  end
+end

data/lib/activeadmin_friendly_id_disabler/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveadminFriendlyIdDisabler
+  VERSION = '0.1.0'
+end

data/lib/activeadmin_friendly_id_disabler.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/concern'
+require_relative 'activeadmin_friendly_id_disabler/version'
+require 'activeadmin/friendly_id_disabler'
+require 'friendly_id/disabler'
+
+module ActiveadminFriendlyIdDisabler
+  class Error < StandardError; end
+end

data/lib/friendly_id/disabler.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module FriendlyId
+  # The Disabler module manages the temporary disabling of FriendlyId functionality
+  # by utilizing a thread-local variable. This module provides methods to check
+  # the current state of FriendlyId (enabled/disabled) and to execute blocks with
+  # FriendlyId disabled.
+  module Disabler
+    # A key used in `Thread.current` to store the state of FriendlyId (enabled/disabled).
+    THREAD_LOCAL_KEY = :__friendly_id_enabler_disabled
+
+    class << self
+      # Checks if FriendlyId is currently disabled.
+      #
+      # @return [Boolean] returns true if FriendlyId is currently disabled in the thread.
+      def disabled?
+        !!Thread.current[THREAD_LOCAL_KEY]
+      end
+
+      # Temporarily disables FriendlyId for the duration of the given block.
+      #
+      # This method sets a thread-local flag that is checked by the `FriendlyId::Slugged#to_param`
+      # method. It ensures that the disabling is scoped only to the current thread of execution.
+      #
+      # @yield the block of code during which FriendlyId should be disabled.
+      def disable_friendly_id
+        old_value = Thread.current[THREAD_LOCAL_KEY]
+        Thread.current[THREAD_LOCAL_KEY] = true
+        yield
+      ensure
+        Thread.current[THREAD_LOCAL_KEY] = old_value
+      end
+    end
+  end
+
+  # The Slugged module is an extension of FriendlyId''s functionality,
+  # providing a way to customize how object URLs are generated with slugs.
+  module Slugged
+    # Overrides the default `to_param` method to conditionally return the record''s ID
+    # when FriendlyId is disabled, otherwise leveraging the slug functionality.
+    #
+    # @return [String] the URL-safe parameter string representing the object.
+    def to_param
+      ::FriendlyId::Disabler.disabled? ? id&.to_s : super
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: activeadmin_friendly_id_disabler
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Gordienko
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeadmin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: friendly_id
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.3.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+description: |-
+  This gem helps disable FriendlyId''s default behavior in ActiveAdmin to allow usage of standard
+                          ID instead of friendly slugs in URLs, eliminating possible conflicts.
+email:
+- alx@anadyr.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/activeadmin/friendly_id_disabler.rb
+- lib/activeadmin_friendly_id_disabler.rb
+- lib/activeadmin_friendly_id_disabler/version.rb
+- lib/friendly_id/disabler.rb
+homepage: https://github.com/gordienko/activeadmin_friendly_id_disabler
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/gordienko/activeadmin_friendly_id_disabler
+  source_code_uri: https://github.com/gordienko/activeadmin_friendly_id_disabler
+  changelog_uri: https://github.com/gordienko/activeadmin_friendly_id_disabler/CHANGELOG.md
+  rubygems_mfa_required: 'false'
+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.16
+signing_key:
+specification_version: 4
+summary: Disables FriendlyId in ActiveAdmin environments where it''s not needed.
+test_files: []