dsfr_accessible_skip_links 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 463e7169b07cd041b6e60fd1590f865dae3dd3589df63adaff28e3005f504a7a
-  data.tar.gz: d660e5cb0f9cdd34e58c4db423e5f6a1ae3f6c6749dd7ea57a3e6afbbbdf96ef
+  metadata.gz: 1c1aa834669fc2810bad9ffe69cad4af0d1640ea1b294d514c755b72e80cea81
+  data.tar.gz: 57a4ffa98aa9217fd8937a137df89a810ddf04fbda942e5b1736baabbf5c3911
 SHA512:
-  metadata.gz: 6a7b721500e9d5e31b190a9e53c2ff232f9f8d722780f10c65543fe23063e9e5e549aa2c2f0233035441c30ca5b4d4573004496b4ddf091ddba0d2819cc445d0
-  data.tar.gz: a50f6bedb857566c476cf7cd913c17f411f6bb2f384714530b6e629b4b8abcce7443f731ac224eb349ab12507acd6959259269aa1c8a9bc59bc4ab75e26b45d5
+  metadata.gz: b2fa2f71d3ed56fe3dbbc9966e57ff9743a2bdc360a16fb17574396fcbb978d1659abfd5e865e5c2addb95a69dd350b9b39e9bc681a852598a2245b9a276ebd5
+  data.tar.gz: d4ca7582ffe46826b82801d41f673b29cbae349e01be2d0c77f54450d09f1e0ad957440b74fc0f5128b64c2ecdf2549d550ddb1eb0e631474b944f4921dfaffb

data/CHANGELOG.md

@@ -7,6 +7,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.1.3] - 2025-08-27
+### Fixed
+- Generator now uses `copy_file` instead of `template` to avoid evaluating ERB in the partial during generation. This prevents `NameError` for `skip_links_content`.
+- Ensure DsfrAccessibleSkipLinks::SkipLinks is automatically included using `ActiveSupport.on_load` hooks:
+- Included into `ActionController::Base` (controller-side) and exposed as view helpers
+- Included into `ActionView` (view-side) so helpers are available in templates without manual setup
+
+## [0.1.2] - 2025-08-27
+### Added
+- Rails generator `dsfr_accessible_skip_links:install` to copy the skip links partial and inject the render call into the application layout.
+- README updated with installation instructions using the generator.
+
 ## [0.1.0] - 2025-08-27
 
 ### Added
@@ -14,4 +26,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Skip links helper methods for Rails applications
 - DSFR-compliant CSS classes and HTML structure
 - Configuration system for customizing default behavior
-- Accessibility features following WCAG 2.2 guidelines
+- Accessibility features following WCAG 2.2 guidelines

data/README.md

@@ -10,11 +10,15 @@ Add this line to your application's Gemfile:
 gem 'dsfr_accessible_skip_links'
 ```
 
-And then execute:
+Then install the gem:
 
     $ bundle install
 
-Or install it yourself as:
+Run the installer to set up the skip links in your Rails app (copies the partial and injects the render in your layout):
+
+    $ bin/rails g dsfr_accessible_skip_links:install
+
+You can also install the gem itself directly as:
 
     $ gem install dsfr_accessible_skip_links
 
@@ -22,7 +26,7 @@ Or install it yourself as:
 
 ### Rails Integration
 
-The gem automatically integrates with Rails through a Rails Engine. The `SkipLinks` module is automatically included in `ApplicationController`.
+The gem automatically integrates with Rails through a Rails Engine. The `SkipLinks` module is automatically included in controllers and views (via Rails on_load hooks), so you can call the helpers directly from templates and controllers.
 
 In your layout file (e.g., `app/views/layouts/application.html.erb`), add the skip links at the top:
 
@@ -131,6 +135,69 @@ This gem implements skip links following WCAG 2.2 guidelines and DSFR specificat
 - Focus management
 - Compatible with DSFR CSS for visual styling
 
+## How to test this gem
+
+There are two main ways to test this gem:
+
+1) Run the gem's test suite locally (fast, no Rails app needed)
+- Install dependencies:
+  ```bash
+  bundle install
+  ```
+- Run RSpec:
+  ```bash
+  bundle exec rake spec
+  ```
+- Run RuboCop:
+  ```bash
+  bundle exec rake rubocop
+  ```
+- Run both (default task):
+  ```bash
+  bundle exec rake
+  ```
+
+2) Try it inside a real Rails app (to test the generator and integration)
+- Create a new Rails app (or use an existing one):
+  ```bash
+  rails new demo_app --skip-javascript --skip-hotwire --skip-action-mailbox --skip-action-text --skip-active-storage --skip-active-job --skip-system-test
+  cd demo_app
+  ```
+- Point the app to your local copy of this gem. In demo_app/Gemfile add:
+  ```ruby
+  gem 'dsfr_accessible_skip_links', path: '../path/to/your/dsfr_accessible_skip_links'
+  ```
+  Then run:
+  ```bash
+  bundle install
+  ```
+- Run the installer (copies the partial and injects a render line into your layout):
+  ```bash
+  bin/rails g dsfr_accessible_skip_links:install
+  ```
+- Verify changes:
+  - The partial should exist at: app/views/shared/_skip_links.html.erb
+  - Your app layout (app/views/layouts/application.html.erb) should include:
+    ```erb
+    <%= render partial: 'shared/skip_links' %>
+    ```
+  - Ensure your layout has the anchor targets used by default links:
+    ```erb
+    <header id="header"></header>
+    <main id="content"><%= yield %></main>
+    <footer id="footer"></footer>
+    ```
+- Start the server and check the skip links at the top of the page:
+  ```bash
+  bin/rails s
+  ```
+  Visit http://localhost:3000 and look for the skip links markup
+  ("Aller au contenu", "Menu", "Pied de page").
+
+Notes
+- The generator is idempotent: it won’t insert the render line twice if it already exists.
+- You can customize the skip links in any view using `content_for :skip_links` as described below in Usage.
+
 ## Development
 
 After checking out the repo, run `bundle install` to install dependencies. 

data/lib/dsfr_accessible_skip_links/engine.rb

@@ -14,8 +14,16 @@ module DsfrAccessibleSkipLinks
       end
     end
 
-    config.to_prepare do
-      ApplicationController.include(DsfrAccessibleSkipLinks::SkipLinks) if defined?(ApplicationController)
+    # Ensure helpers are available automatically in controllers and views
+    initializer "dsfr_accessible_skip_links.helpers" do
+      ActiveSupport.on_load(:action_controller_base) do
+        include DsfrAccessibleSkipLinks::SkipLinks
+        helper DsfrAccessibleSkipLinks::SkipLinks if respond_to?(:helper)
+      end
+
+      ActiveSupport.on_load(:action_view) do
+        include DsfrAccessibleSkipLinks::SkipLinks
+      end
     end
   end
 end

data/lib/dsfr_accessible_skip_links/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DsfrAccessibleSkipLinks
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

data/lib/generators/dsfr_accessible_skip_links/install_generator.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module DsfrAccessibleSkipLinks
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc(
+        "Installs DsfrAccessibleSkipLinks by copying the skip links partial " \
+        "and injecting the render call into the application layout."
+      )
+      def copy_partial
+        # Use copy_file instead of template to avoid evaluating ERB in the generator context
+        copy_file "_skip_links.html.erb", "app/views/shared/_skip_links.html.erb"
+      end
+
+      # rubocop:disable Metrics/MethodLength
+      def inject_into_layout
+        layout_path = "app/views/layouts/application.html.erb"
+        return unless File.exist?(layout_path)
+
+        render_snippet = "    <%= render partial: 'shared/skip_links' %>\n"
+
+        content = File.read(layout_path)
+        if content.include?("render partial: 'shared/skip_links'") || content.include?("render 'shared/skip_links'")
+          return
+        end
+
+        if content =~ /<body[^>]*>/
+          insert_into_file layout_path, after: /<body[^>]*>\s*\n?/ do
+            render_snippet
+          end
+        else
+          # If <body> tag is not found, append at the beginning of the file as a fallback
+          prepend_to_file layout_path, render_snippet
+        end
+      end
+      # rubocop:enable Metrics/MethodLength
+
+      def readme
+        say <<~MSG
+          DsfrAccessibleSkipLinks installed.
+
+          - A copy of the skip links partial has been placed at app/views/shared/_skip_links.html.erb
+          - Your application layout has been updated to render the skip links.
+
+          Ensure your layout contains elements with ids: #header, #content, and #footer for the default links.
+        MSG
+      end
+    end
+  end
+end

data/lib/generators/dsfr_accessible_skip_links/templates/_skip_links.html.erb

@@ -0,0 +1,7 @@
+<div class="fr-skiplinks">
+  <nav class="fr-container" role="navigation" aria-label="Accès rapide">
+    <ul class="fr-skiplinks__list">
+      <%= skip_links_content %>
+    </ul>
+  </nav>
+</div>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dsfr_accessible_skip_links
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Isabelle Lafont
@@ -115,6 +115,8 @@ files:
 - lib/dsfr_accessible_skip_links/engine.rb
 - lib/dsfr_accessible_skip_links/skip_links.rb
 - lib/dsfr_accessible_skip_links/version.rb
+- lib/generators/dsfr_accessible_skip_links/install_generator.rb
+- lib/generators/dsfr_accessible_skip_links/templates/_skip_links.html.erb
 homepage: https://github.com/Isalafont/dsfr_accessible_skip_links
 licenses:
 - MIT
@@ -124,7 +126,13 @@ metadata:
   source_code_uri: https://github.com/Isalafont/dsfr_accessible_skip_links
   changelog_uri: https://github.com/Isalafont/dsfr_accessible_skip_links/blob/main/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: |
+  Thank you for installing dsfr_accessible_skip_links (v0.1.3)!
+
+  To complete setup in your Rails app, run:
+    bin/rails g dsfr_accessible_skip_links:install
+
+  This will copy the skip links partial and inject the render call into your application layout.
 rdoc_options: []
 require_paths:
 - lib