dsfr_accessible_skip_links 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 794bc710db3516cb3b73043093d4a8e25c5aa2678897e79d0a4e011ae2367cf9
-  data.tar.gz: a4d345e260e6557364cc9bffc3931986a1e1755f2604b324afba0f1fecfb8076
+  metadata.gz: b4afbed35674b0ec24dfc35c348b73396f4ed4ffba52f4924aec310eb876e0a3
+  data.tar.gz: 26577cd195e55cb9e7dc0d732c121b1f6fca3f71dd1bd8a8fed0690082f5ae76
 SHA512:
-  metadata.gz: 1e4ffb3bd674953927839fa4957b343d3a5df68ef91166267be12a288ac0a18c0d461adb52ab869d01a7443b80978f43d2614fdd30e4b37c5997618ec209fcf9
-  data.tar.gz: 6534795c4a521680b1cb06cf4f336f9f0ea767cad92a4c54eab9eda1a2fa6a70882b5b7ed8e9d42e95cccbff6efdce6c5fa656d7f2a518128d86c90e6dea7068
+  metadata.gz: c642f22b47fbb7df60a42dbe1c9155792feb0c81243d407f6e8870511d56a07acd66fe0439fb8729562fea46c6351ba3ec2aa1ec13bf477c901ca76d0e71e467
+  data.tar.gz: ef4bf61ee5484dd794b73dbcbee89a9f4dd72d06dd4525849bfe34c19d86e32020a2843272e380a13bc31c102256478a2d46304a7e265cc280f2e9ba3051361a

data/CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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 +19,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
 
@@ -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. 
@@ -154,7 +221,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/etalab/dsfr_accessible_skip_links.
+Bug reports and pull requests are welcome on GitHub at https://github.com/Isalafont/dsfr_accessible_skip_links.
 
 ## License
 

data/lib/dsfr_accessible_skip_links/engine.rb

@@ -4,6 +4,16 @@ module DsfrAccessibleSkipLinks
   class Engine < ::Rails::Engine
     isolate_namespace DsfrAccessibleSkipLinks
 
+    initializer "dsfr_accessible_skip_links.view_paths" do
+      ActiveSupport.on_load(:action_controller) do
+        prepend_view_path Engine.root.join("app", "views")
+      end
+
+      ActiveSupport.on_load(:action_mailer) do
+        prepend_view_path Engine.root.join("app", "views")
+      end
+    end
+
     config.to_prepare do
       ApplicationController.include(DsfrAccessibleSkipLinks::SkipLinks) if defined?(ApplicationController)
     end

data/lib/dsfr_accessible_skip_links/version.rb

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

data/lib/generators/dsfr_accessible_skip_links/install_generator.rb

@@ -0,0 +1,53 @@
+# 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
+        template "_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.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Isabelle Lafont
@@ -111,11 +111,12 @@ files:
 - README.md
 - Rakefile
 - app/views/shared/_skip_links.html.erb
-- dsfr_accessible_skip_links.gemspec
 - lib/dsfr_accessible_skip_links.rb
 - 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
@@ -125,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.2)!
+
+  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
@@ -140,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: Accessible skip links implementation following DSFR (Système de design de

data/dsfr_accessible_skip_links.gemspec

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/dsfr_accessible_skip_links/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "dsfr_accessible_skip_links"
-  spec.version = DsfrAccessibleSkipLinks::VERSION
-  spec.authors = ["Isabelle Lafont"]
-  spec.email = ["isalafont@gmail.com"]
-  spec.summary = "Accessible skip links implementation following DSFR (Système de design de l'État français) guidelines"
-  spec.description = "A Ruby gem that helps projects implement accessible skip links according to " \
-                     "the French government design system (DSFR). Provides helpers and utilities " \
-                     "for creating navigation skip links that improve accessibility."
-  spec.homepage = "https://github.com/Isalafont/dsfr_accessible_skip_links"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org"
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/Isalafont/dsfr_accessible_skip_links"
-  spec.metadata["changelog_uri"] = "https://github.com/Isalafont/dsfr_accessible_skip_links/blob/main/CHANGELOG.md"
-  spec.metadata["rubygems_mfa_required"] = "true"
-
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z 2>/dev/null`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rubocop", "~> 1.0"
-  spec.add_development_dependency "rubocop-rake", "~> 0.6"
-  spec.add_development_dependency "rubocop-rspec", "~> 2.0"
-end