RubyGems - dsfr_accessible_skip_links - Versions diffs - 0.1.0 - Mend

dsfr_accessible_skip_links 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

checksums.yaml +7 -0
data/.rspec +1 -0
data/.rubocop.yml +29 -0
data/CHANGELOG.md +17 -0
data/Gemfile +9 -0
data/LICENSE.txt +21 -0
data/README.md +161 -0
data/Rakefile +13 -0
data/app/views/shared/_skip_links.html.erb +7 -0
data/dsfr_accessible_skip_links.gemspec +39 -0
data/lib/dsfr_accessible_skip_links/engine.rb +11 -0
data/lib/dsfr_accessible_skip_links/skip_links.rb +49 -0
data/lib/dsfr_accessible_skip_links/version.rb +5 -0
data/lib/dsfr_accessible_skip_links.rb +9 -0
metadata +148 -0

checksums.yaml ADDED Viewed

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 794bc710db3516cb3b73043093d4a8e25c5aa2678897e79d0a4e011ae2367cf9
+  data.tar.gz: a4d345e260e6557364cc9bffc3931986a1e1755f2604b324afba0f1fecfb8076
+SHA512:
+  metadata.gz: 1e4ffb3bd674953927839fa4957b343d3a5df68ef91166267be12a288ac0a18c0d461adb52ab869d01a7443b80978f43d2614fdd30e4b37c5997618ec209fcf9
+  data.tar.gz: 6534795c4a521680b1cb06cf4f336f9f0ea767cad92a4c54eab9eda1a2fa6a70882b5b7ed8e9d42e95cccbff6efdce6c5fa656d7f2a518128d86c90e6dea7068

data/.rspec ADDED Viewed

	@@ -0,0 +1 @@
1	+ --require spec_helper

data/.rubocop.yml ADDED Viewed

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+  SuggestExtensions: false
+  Exclude:
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+Layout/LineLength:
+  Max: 120
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+    - '*.gemspec'
+Style/Documentation:
+  Enabled: false
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Naming/PredicateMethod:
+  Enabled: false
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/CHANGELOG.md ADDED Viewed

@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+## [Unreleased]
+## [0.1.0] - 2025-08-27
+### Added
+- Initial release
+- 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

data/Gemfile ADDED Viewed

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+gemspec
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.0"

data/LICENSE.txt ADDED Viewed

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+Copyright (c) 2025 Isabelle Lafont
+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 ADDED Viewed

@@ -0,0 +1,161 @@
+# DsfrAccessibleSkipLinks
+A Ruby gem that helps projects implement accessible skip links according to the French government design system (DSFR - Système de design de l'État français). This gem provides helpers and utilities for creating navigation skip links that improve web accessibility.
+## Installation
+Add this line to your application's Gemfile:
+```ruby
+gem 'dsfr_accessible_skip_links'
+```
+And then execute:
+    $ bundle install
+Or install it yourself as:
+    $ gem install dsfr_accessible_skip_links
+## Usage
+### Rails Integration
+The gem automatically integrates with Rails through a Rails Engine. The `SkipLinks` module is automatically included in `ApplicationController`.
+In your layout file (e.g., `app/views/layouts/application.html.erb`), add the skip links at the top:
+```erb
+<!DOCTYPE html>
+<html>
+  <head>
+    <!-- head content -->
+  </head>
+  <body>
+    <%= render partial: 'shared/skip_links' %>
+    <!-- rest of your layout -->
+    <header id="header">
+      <!-- your navigation -->
+    </header>
+    <main id="content">
+      <%= yield %>
+    </main>
+    <footer id="footer">
+      <!-- your footer -->
+    </footer>
+  </body>
+</html>
+```
+### Default Skip Links
+By default, the gem provides three skip links:
+- **"Aller au contenu"** → `#content`
+- **"Menu"** → `#header`
+- **"Pied de page"** → `#footer`
+### Custom Skip Links
+You can customize skip links on a per-page basis using Rails' `content_for`:
+```erb
+<% content_for :skip_links do %>
+  <%= skip_link('Aller au contenu principal', 'main-section') %>
+  <%= skip_link('Aller à la navigation spéciale', 'special-nav') %>
+  <%= skip_link('Aller aux résultats', 'results') %>
+<% end %>
+```
+### Custom Content Link Text
+You can customize the main content link text:
+```erb
+<% content_for :content_skip_link_text, 'Go to main content' %>
+```
+### Tab-Prefixed Links
+For links that need JavaScript interaction, use the `tab-` prefix:
+```erb
+<%= skip_link('Tab Navigation', 'tab-special-section') %>
+```
+This will add a `data-anchor` attribute for JavaScript handling.
+### Helper Methods
+The gem provides these helper methods (automatically available in controllers and views):
+- `skip_link(text, anchor)` - Creates a single skip link
+- `default_skip_links` - Returns the default set of skip links
+- `skip_links_content` - Returns either custom or default skip links
+- `content_skip_link_text` - Returns the content link text
+### CSS Classes
+The gem uses official DSFR CSS classes:
+- `.fr-skiplinks` - Main container
+- `.fr-container` - DSFR container wrapper
+- `.fr-skiplinks__list` - List container
+- `.fr-link` - Individual link styling
+### HTML Structure
+The generated HTML follows this structure:
+```html
+<div class="fr-skiplinks">
+  <nav class="fr-container" role="navigation" aria-label="Accès rapide">
+    <ul class="fr-skiplinks__list">
+      <li><a class="fr-link" href="#content">Aller au contenu</a></li>
+      <li><a class="fr-link" href="#header">Menu</a></li>
+      <li><a class="fr-link" href="#footer">Pied de page</a></li>
+    </ul>
+  </nav>
+</div>
+```
+## Accessibility Features
+This gem implements skip links following WCAG 2.2 guidelines and DSFR specifications:
+- Proper semantic HTML structure with `nav` element and `role="navigation"`
+- Descriptive `aria-label` for screen readers
+- Keyboard navigation support
+- Focus management
+- Compatible with DSFR CSS for visual styling
+## Development
+After checking out the repo, run `bundle install` to install dependencies.
+Run the test suite:
+```bash
+bundle exec rake spec
+```
+Run RuboCop for code quality checks:
+```bash
+bundle exec rake rubocop
+```
+Run both tests and RuboCop:
+```bash
+bundle exec rake
+```
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/etalab/dsfr_accessible_skip_links.
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile ADDED Viewed

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+desc "Run RuboCop"
+task :rubocop do
+  sh "bundle exec rubocop"
+end
+task default: %i[rubocop spec]

data/app/views/shared/_skip_links.html.erb ADDED Viewed

@@ -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>

data/dsfr_accessible_skip_links.gemspec ADDED Viewed

@@ -0,0 +1,39 @@
+# 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

data/lib/dsfr_accessible_skip_links/engine.rb ADDED Viewed

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+module DsfrAccessibleSkipLinks
+  class Engine < ::Rails::Engine
+    isolate_namespace DsfrAccessibleSkipLinks
+    config.to_prepare do
+      ApplicationController.include(DsfrAccessibleSkipLinks::SkipLinks) if defined?(ApplicationController)
+    end
+  end
+end

data/lib/dsfr_accessible_skip_links/skip_links.rb ADDED Viewed

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+module DsfrAccessibleSkipLinks
+  module SkipLinks
+    TAB_PREFIX = "tab-"
+    def skip_link(text, anchor)
+      anchor_str = anchor.to_s
+      content_tag(:li) do
+        if anchor_str.start_with?(TAB_PREFIX)
+          link_to(text, "##{anchor_str}", class: "fr-link", data: { anchor: anchor_str })
+        else
+          link_to(text, "##{anchor_str}", class: "fr-link")
+        end
+      end
+    end
+    def default_skip_links
+      result = [
+        skip_link(content_skip_link_text, "content"),
+        skip_link("Menu", "header"),
+        skip_link("Pied de page", "footer")
+      ].join
+      result.respond_to?(:html_safe) ? result.html_safe : result
+    end
+    def skip_links_content
+      return content_for(:skip_links) if content_for?(:skip_links)
+      validate_skip_links_in_test! if defined?(Rails) && Rails.env.test?
+      default_skip_links
+    end
+    def content_skip_link_text
+      return content_for(:content_skip_link_text) if content_for?(:content_skip_link_text)
+      "Aller au contenu"
+    end
+    private
+    def validate_skip_links_in_test!
+      # This would be implemented to validate skip links in test environment
+      # For now, just a placeholder
+      true
+    end
+  end
+end

data/lib/dsfr_accessible_skip_links/version.rb ADDED Viewed

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

data/lib/dsfr_accessible_skip_links.rb ADDED Viewed

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require_relative "dsfr_accessible_skip_links/version"
+require_relative "dsfr_accessible_skip_links/engine" if defined?(Rails)
+require_relative "dsfr_accessible_skip_links/skip_links"
+module DsfrAccessibleSkipLinks
+  class Error < StandardError; end
+end

metadata ADDED Viewed

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: dsfr_accessible_skip_links
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Isabelle Lafont
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+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.
+email:
+- isalafont@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- 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
+homepage: https://github.com/Isalafont/dsfr_accessible_skip_links
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Isalafont/dsfr_accessible_skip_links
+  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:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: Accessible skip links implementation following DSFR (Système de design de
+  l'État français) guidelines
+test_files: []