gretel 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b80e71f865388974401274f84159318e012a5e9e40800888549453e301881bec
-  data.tar.gz: 06d1a078802e9b8d175f17376c7534ba8004c15327e2fc75b0e01e9386653cb8
+  metadata.gz: c1fe62ed99bb8f03e6a00a782f55adc5f6b6fcf84a444d77aa1c771b41d148a9
+  data.tar.gz: 1660db0b73ddbf77dac315c8d1466fb66958b9ebab59629c96f999536f17b824
 SHA512:
-  metadata.gz: 3b8c092e5e04c48099f0fcad18230b89a6f4c11e760d59f89f629792cb4225eb5db1cf4648c8a6145c6be99bcf104b0d08ee0b74b82d39d1e7b9e366fda6ea37
-  data.tar.gz: 582e6471d0fa5fb59d490bee9a41b1cdd7b0f419b107c9acb56914832ad5b3a5dfc5c4590918dcb38ea46495a0df2578ceeb5e6384e57c0ed7e37ab8e39ea3e7
+  metadata.gz: 4bddd221544196836669a1309c97d536ad2d2b11ef10c74a265e034d0a1463ba5b4955651235ad395b9c37249a9d5eff2ef9ec9b659ab896a8fbca959b199924
+  data.tar.gz: ebd6e183dc3597f83c9ac8b22399d0ad52e345da6586b9de59c2386c8b5116d40199fcf494c44cd8d094a25ed543d5ee21397506d1979ebf851a973e23da3ced

data/.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 0 * * 0'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        rails_version: [5.1.0, 5.2.0, 6.0.0, 6.1.0, master]
+        ruby_version: [3.0, 2.7, 2.6, 2.5]
+        exclude:
+          - ruby_version: 2.5
+            rails_version: master
+          - ruby_version: 2.6
+            rails_version: master
+          - ruby_version: 3.0
+            rails_version: 5.1.0
+          - ruby_version: 3.0
+            rails_version: 5.2.0
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby_version }}
+
+    - name: Run test
+      env:
+        RAILS_VERSION: ${{ matrix.rails_version }}
+      run: |
+        bundle update
+        cd spec/dummy; rake db:migrate db:test:prepare; cd ../..
+        bundle exec rake
+
+    - name: Upload coverage
+      uses: actions/upload-artifact@v2
+      if: always()
+      with:
+        name: coverage-ruby-${{ matrix.ruby_version }}-rails-${{ matrix.rails_version }}
+        path: coverage
+
+    - name: Show coverage
+      if: always()
+      run: |
+        cat coverage/coverage.txt

data/.gitignore

@@ -26,3 +26,4 @@ spec/dummy/.sass-cache
 /coverage/assets
 /coverage/*.json
 /coverage/*.json.lock
+/.ruby-version

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## Version 4.3.0
+* Support generating `aria-current` attribute. It's disabled by default. See the readme for more info
+
 ## Version 4.2.0
 * Support generating JSON-LD structured data. See the readme for more info (via #26, thanks @dkniffin)
 

data/Gemfile

@@ -3,4 +3,6 @@ source "http://rubygems.org"
 gemspec
 
 rails_version = ENV['RAILS_VERSION'] || '>= 0'
+rails_version = "~> #{rails_version}" if rails_version =~ /^\d/
+
 gem 'rails', rails_version == 'master' ? { github: 'rails/rails' } : rails_version

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/gretel.svg)](http://badge.fury.io/rb/gretel)
-[![Build Status](https://travis-ci.org/kzkn/gretel.svg?branch=master)](https://travis-ci.org/kzkn/gretel)
+![](https://github.com/kzkn/gretel/workflows/CI/badge.svg)
 
 <img src="http://i.imgur.com/CAKEaBM.png" alt="Handle breadcrumb trails... like a boss :)" />
 
@@ -98,6 +98,7 @@ Option                   | Description
 :posttext_class          | CSS class for the posttext, if given. Can be set to `nil` for no class.                                                    | `"posttext"`
 :container_tag           | Tag type that contains the breadcrumbs.                                                                                    | `:div`
 :fragment_tag            | Tag type to contain each breadcrumb fragment/link.                                                                         | None
+:aria_current            | Value of `aria-current` attribute.                                                                                         | None
 
 ### Styles
 
@@ -202,6 +203,11 @@ end
 crumb :user do |user|
   link user_name_for(user), user
 end
+
+# I18n
+crumb :home do
+  link t("breadcrumbs.home"), root_path
+end
 ```
 
 ## Building the breadcrumbs manually
@@ -224,7 +230,7 @@ add them back is to use JSON-LD structured data:
 
 ```erb
 <script type="application/ld+json">
-  <%= breadcrumbs.structured_data(url_base: "https://example.com")) %>
+  <%= breadcrumbs.structured_data(url_base: "https://example.com") %>
 </script>
 ```
 
@@ -232,7 +238,7 @@ Or, you can infer `url_base` from `request`:
 
 ```erb
 <script type="application/ld+json">
-  <%= breadcrumbs.structured_data(url_base: "#{request.protocol}#{request.host_with_port}")) %>
+  <%= breadcrumbs.structured_data(url_base: "#{request.protocol}#{request.host_with_port}") %>
 </script>
 ```
 
@@ -309,6 +315,25 @@ breadcrumbs do |links|
 end
 ```
 
+### ARIA support
+
+You can improve the accessibility of your page with the markup that specified in [ARIA](https://www.w3.org/TR/wai-aria-practices/examples/breadcrumb/index.html). Gretel supports generating `aria-current` attribute:
+
+```erb
+<% breadcrumb :issue, @issue %>
+<%= breadcrumbs aria_current: "page" %>
+```
+
+This will generate the following HTML (indented for readability):
+
+```html
+<div class="breadcrumbs">
+  <a href="/">Home</a> &rsaquo;
+  <a href="/issues">All issues</a> &rsaquo;
+  <span class="current" aria-current="page">My Issue</span>
+</div>
+```
+
 ## Documentation
 
 * [Full documentation](https://rubydoc.info/gems/gretel)

data/lib/gretel/renderer.rb

@@ -17,7 +17,8 @@ module Gretel
       current_class: "current",
       pretext_class: "pretext",
       posttext_class: "posttext",
-      id: nil
+      id: nil,
+      aria_current: nil
     }
 
     DEFAULT_STYLES = {
@@ -197,7 +198,7 @@ module Gretel
         # The current link is handled a little differently, and is only linked if specified in the options
         current_link = links.last
         position = links.size
-        fragments << render_fragment(options[:fragment_tag], current_link.text, (options[:link_current] ? current_link.url : nil), options[:semantic], position, fragment_class: options[:fragment_class], class: options[:current_class], current_link: current_link.url)
+        fragments << render_fragment(options[:fragment_tag], current_link.text, (options[:link_current] ? current_link.url : nil), options[:semantic], position, fragment_class: options[:fragment_class], class: options[:current_class], current_link: current_link.url, aria_current: options[:aria_current])
 
         # Build the final HTML
         html_fragments = []
@@ -239,15 +240,17 @@ module Gretel
         fragment_tag = fragment_tag || 'span'
         text = content_tag(:span, text, itemprop: "name")
 
+        aria_current = options[:aria_current]
         if url.present?
-          text = breadcrumb_link_to(text, url, itemprop: "item")
+          text = breadcrumb_link_to(text, url, itemprop: "item", "aria-current": aria_current)
+          aria_current = nil
         elsif options[:current_link].present?
           current_url = "#{root_url}#{options[:current_link].gsub(/^\//, '')}"
           text = text + tag(:meta, itemprop: "item", content: current_url)
         end
 
         text = text + tag(:meta, itemprop:"position", content: "#{position}")
-        content_tag(fragment_tag.to_sym, text, class: fragment_class, itemprop: "itemListElement", itemscope: "", itemtype: "https://schema.org/ListItem")
+        content_tag(fragment_tag.to_sym, text, class: fragment_class, itemprop: "itemListElement", itemscope: "", itemtype: "https://schema.org/ListItem", "aria-current": aria_current)
       end
 
       # Renders regular, non-semantic fragment HTML.
@@ -256,12 +259,16 @@ module Gretel
         fragment_class = nil if fragment_class.blank?
 
         if fragment_tag
-          text = breadcrumb_link_to(text, url) if url.present?
-          content_tag(fragment_tag, text, class: fragment_class)
+          if url.present?
+            text = breadcrumb_link_to(text, url, "aria-current": options[:aria_current])
+            content_tag(fragment_tag, text, class: fragment_class)
+          else
+            content_tag(fragment_tag, text, class: fragment_class, "aria-current": options[:aria_current])
+          end
         elsif url.present?
-          breadcrumb_link_to(text, url, class: fragment_class)
+          breadcrumb_link_to(text, url, class: fragment_class, "aria-current": options[:aria_current])
         elsif options[:class].present?
-          content_tag(:span, text, class: fragment_class)
+          content_tag(:span, text, class: fragment_class, "aria-current": options[:aria_current])
         else
           text
         end

data/lib/gretel/version.rb

@@ -1,3 +1,3 @@
 module Gretel
-  VERSION = "4.2.0"
+  VERSION = "4.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Lasse Bunk
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-04 00:00:00.000000000 Z
+date: 2021-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -115,8 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -155,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Flexible Ruby on Rails breadcrumbs plugin.

data/.travis.yml

@@ -1,17 +0,0 @@
-language: ruby
-sudo: false
-rvm:
-  - 2.7
-  - 2.6
-  - 2.5
-env:
-  - RAILS_VERSION="~> 5.1.0"
-  - RAILS_VERSION="~> 5.2.0"
-  - RAILS_VERSION="~> 6.0.0"
-  - RAILS_VERSION="master"
-before_script:
-  - "cd spec/dummy; rake db:migrate; rake db:test:prepare; cd ../.."
-after_script:
-  - "cat coverage/coverage.txt"
-notifications:
-  email: false