gretel 4.3.0 → 4.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1fe62ed99bb8f03e6a00a782f55adc5f6b6fcf84a444d77aa1c771b41d148a9
-  data.tar.gz: 1660db0b73ddbf77dac315c8d1466fb66958b9ebab59629c96f999536f17b824
+  metadata.gz: e11382c45e0cd902386dec63fccbfedbbfd7658bc03e2d22a70c8bc88b317431
+  data.tar.gz: fd662355346c8e056a71b8b4abc8d83b325b452ae2436339a15307a3355dffd9
 SHA512:
-  metadata.gz: 4bddd221544196836669a1309c97d536ad2d2b11ef10c74a265e034d0a1463ba5b4955651235ad395b9c37249a9d5eff2ef9ec9b659ab896a8fbca959b199924
-  data.tar.gz: ebd6e183dc3597f83c9ac8b22399d0ad52e345da6586b9de59c2386c8b5116d40199fcf494c44cd8d094a25ed543d5ee21397506d1979ebf851a973e23da3ced
+  metadata.gz: 141851ca991537082c0efaa5a7ca487d5a76ee46515f884cf4ced76cdf16df23c65c9472c2926c4962b68ab4f8cdb54ab720d43c51309b49bee19438ebbeffab
+  data.tar.gz: 74ad6b5a791c45b1c895f12bea6cb39e761775a99e7ff469ca98297f8ebada132484f6c40db2162cfa32a4f0f9c2defc294b1a516669b4c63b3072a187c4dbd2

data/.github/workflows/ci.yml

@@ -11,39 +11,44 @@ jobs:
     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]
+        rails_version: [5.1.0, 5.2.0, 6.0.0, 6.1.0, 7.0.0, master]
+        ruby_version: ['3.2', '3.1', '3.0', '2.7', '2.6']
         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
+          - { ruby_version: '2.6', rails_version: 7.0.0 }
+          - { 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 }
+          - { ruby_version: '3.1', rails_version: 5.1.0 }
+          - { ruby_version: '3.1', rails_version: 5.2.0 }
+          - { ruby_version: '3.1', rails_version: 6.0.0 }
+          - { ruby_version: '3.1', rails_version: 6.1.0 }
+          - { ruby_version: '3.2', rails_version: 5.1.0 }
+          - { ruby_version: '3.2', rails_version: 5.2.0 }
+          - { ruby_version: '3.2', rails_version: 6.0.0 }
+          - { ruby_version: '3.2', rails_version: 6.1.0 }
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
     - name: Setup Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: ${{ matrix.ruby_version }}
+        ruby-version: "${{ matrix.ruby_version }}"
 
     - name: Run test
       env:
-        RAILS_VERSION: ${{ matrix.rails_version }}
+        RAILS_VERSION: "${{ matrix.rails_version }}"
       run: |
+        gem update --system
         bundle update
         cd spec/dummy; rake db:migrate db:test:prepare; cd ../..
         bundle exec rake
 
     - name: Upload coverage
-      uses: actions/upload-artifact@v2
+      uses: actions/upload-artifact@v3
       if: always()
       with:
-        name: coverage-ruby-${{ matrix.ruby_version }}-rails-${{ matrix.rails_version }}
+        name: "coverage-ruby-${{ matrix.ruby_version }}-rails-${{ matrix.rails_version }}"
         path: coverage
 
     - name: Show coverage

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## Unreleased
+
+## Version 4.5.0
+* Use `link` element for link item in semantic markup instead of `meta` element (via #36, thanks @tkawa)
+* Use `link_data` to set data attributes for link item (via #38, thanks @SpaYco)
+
+## Version 4.4.0
+* Support Bootstrap 5. See the `:style` option in the readme for more info (via #30, thanks @tochi)
+* Support Rails 7.0
+* Link class is now customizable with `<%= breadcrumbs link_class: "some-class" %>`. (via #10)
+
 ## Version 4.3.0
 * Support generating `aria-current` attribute. It's disabled by default. See the readme for more info
 

data/README.md

@@ -1,5 +1,5 @@
 [![Gem Version](https://badge.fury.io/rb/gretel.svg)](http://badge.fury.io/rb/gretel)
-![](https://github.com/kzkn/gretel/workflows/CI/badge.svg)
+[![](https://github.com/kzkn/gretel/workflows/CI/badge.svg)](https://github.com/kzkn/gretel/actions/workflows/ci.yml)
 
 <img src="http://i.imgur.com/CAKEaBM.png" alt="Handle breadcrumb trails... like a boss :)" />
 
@@ -96,9 +96,11 @@ Option                   | Description
 :current_class           | CSS class for the current link or span. Can be set to `nil` for no class.                                                  | `"current"`
 :pretext_class           | CSS class for the pretext, if given. Can be set to `nil` for no class.                                                     | `"pretext"`
 :posttext_class          | CSS class for the posttext, if given. Can be set to `nil` for no class.                                                    | `"posttext"`
+:link_class              | CSS class for the link, if given. Can be set to `nil` for no class.                                                        | None
 :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
+:link_data               | Adds data attributes to breadcrumb                                                                                         | `nil`
 
 ### Styles
 
@@ -110,7 +112,8 @@ Style          | Description
 `:ol`          | Renders the links in `<li>` elements contained in an outer `<ol>`.
 `:ul`          | Renders the links in `<li>` elements contained in an outer `<ul>`.
 `:bootstrap`   | Renders the links for use in [Bootstrap v3](https://getbootstrap.com/docs/3.4/).
-`:bootstrap4`  | Renders the links for use in [Bootstrap v4](https://getbootstrap.com/).
+`:bootstrap4`  | Renders the links for use in [Bootstrap v4](https://getbootstrap.com/docs/4.6/getting-started/introduction/).
+`:bootstrap5`  | Renders the links for use in [Bootstrap v5](https://getbootstrap.com/).
 `:foundation5` | Renders the links for use in [Foundation 5](https://get.foundation/).
 
 Or you can build the breadcrumbs manually for full customization; see below.

data/gretel.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["kzkn@users.noreply.github.com"]
   gem.description   = %q{Gretel is a Ruby on Rails plugin that makes it easy yet flexible to create breadcrumbs.}
   gem.summary       = %q{Flexible Ruby on Rails breadcrumbs plugin.}
-  gem.homepage      = "http://github.com/kzkn/gretel"
+  gem.homepage      = "https://github.com/kzkn/gretel"
   gem.license       = "MIT"
 
   gem.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
@@ -15,8 +15,12 @@ Gem::Specification.new do |gem|
   end
   gem.require_paths = ["lib"]
 
-  gem.add_dependency "railties", [">= 5.1", "< 7.0"]
-  gem.add_dependency "actionview", [">= 5.1", "< 7.0"]
+  gem.metadata = {
+    "changelog_uri" => "https://github.com/kzkn/gretel/blob/master/CHANGELOG.md",
+  }
+
+  gem.add_dependency "railties", [">= 5.1", "< 7.1"]
+  gem.add_dependency "actionview", [">= 5.1", "< 7.1"]
   gem.add_development_dependency "sqlite3"
   gem.add_development_dependency "rspec-rails"
   gem.add_development_dependency "simplecov"

data/lib/gretel/renderer.rb

@@ -17,8 +17,10 @@ module Gretel
       current_class: "current",
       pretext_class: "pretext",
       posttext_class: "posttext",
+      link_class: nil,
       id: nil,
-      aria_current: nil
+      aria_current: nil,
+      link_data: nil
     }
 
     DEFAULT_STYLES = {
@@ -27,6 +29,7 @@ module Gretel
       ul: { container_tag: :ul, fragment_tag: :li },
       bootstrap: { container_tag: :ol, fragment_tag: :li, class: "breadcrumb", current_class: "active" },
       bootstrap4: { container_tag: :ol, fragment_tag: :li, class: "breadcrumb", fragment_class: "breadcrumb-item", current_class: "active" },
+      bootstrap5: { container_tag: :ol, fragment_tag: :li, class: "breadcrumb", fragment_class: "breadcrumb-item", current_class: "active" },
       foundation5: { container_tag: :ul, fragment_tag: :li, class: "breadcrumbs", current_class: "current" }
     }
 
@@ -85,7 +88,7 @@ module Gretel
       end
 
       # Set current link to actual path
-      if options[:link_current_to_request_path] && out.any? && request
+      if options[:link_current_to_request_path] && out.any? && request&.fullpath.present?
         out.last.url = request.fullpath
       end
 
@@ -190,83 +193,111 @@ module Gretel
       def render
         return "" if links.empty?
 
+        renderer_class = options[:semantic] ? SemanticRenderer : NonSemanticRenderer
+        renderer = renderer_class.new(context, options)
         # Loop through all but the last (current) link and build HTML of the fragments
         fragments = links[0..-2].map.with_index do |link, index|
-          render_fragment(options[:fragment_tag], link.text, link.url, options[:semantic], index + 1, fragment_class: options[:fragment_class])
+          renderer.render_fragment(link, index + 1)
         end
 
         # 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, aria_current: options[:aria_current])
+        fragments << renderer.render_current_fragment(current_link, position)
 
         # Build the final HTML
-        html_fragments = []
+        html_fragments = [
+          renderer.render_pretext,
+          fragments.join(options[:separator]),
+          renderer.render_posttext
+        ]
+        html = html_fragments.compact.join(" ").html_safe
+        renderer.render_container(html)
+      end
+
+      alias :to_s :render
+
+      # Avoid unnecessary html escaping by template engines.
+      def html_safe?
+        true
+      end
+    end
+
+    class Base
+      attr_reader :context, :options
+
+      def initialize(context, options)
+        @context = context
+        @options = options
+      end
+
+      def render_fragment(link, position)
+        render_fragment_tag(fragment_tag, link.text, link.url, position, **fragment_options)
+      end
+
+      def render_current_fragment(link, position)
+        url = options[:link_current] ? link.url : nil
+        opts = fragment_options.merge(class: options[:current_class], current_link: link.url, aria_current: options[:aria_current])
+        render_fragment_tag(fragment_tag, link.text, url, position, **opts)
+      end
 
+      def render_fragment_tag(fragment_tag, text, url, position, options = {})
+      end
+
+      def render_container(html)
+      end
+
+      def render_pretext
         if options[:pretext].present?
-          html_fragments << content_tag(:span, options[:pretext], class: options[:pretext_class])
+          content_tag(:span, options[:pretext], class: options[:pretext_class])
         end
+      end
 
-        html_fragments << fragments.join(options[:separator])
-
+      def render_posttext
         if options[:posttext].present?
-          html_fragments << content_tag(:span, options[:posttext], class: options[:posttext_class])
+          content_tag(:span, options[:posttext], class: options[:posttext_class])
         end
+      end
 
-        html = html_fragments.join(" ").html_safe
+      private
 
-        if options[:semantic]
-          content_tag(options[:container_tag], html, id: options[:id], class: options[:class], itemscope: "", itemtype: "https://schema.org/BreadcrumbList")
-        else
-          content_tag(options[:container_tag], html, id: options[:id], class: options[:class])
-        end
+      def fragment_tag
+        options[:fragment_tag]
       end
 
-      alias :to_s :render
-
-      # Renders HTML for a breadcrumb fragment, i.e. a breadcrumb link.
-      def render_fragment(fragment_tag, text, url, semantic, position, options = {})
-        if semantic
-          render_semantic_fragment(fragment_tag, text, url, position, options)
-        else
-          render_nonsemantic_fragment(fragment_tag, text, url, options)
-        end
+      def fragment_options
+        options.slice(:fragment_class, :link_class, :link_data)
       end
 
-      # Renders semantic fragment HTML.
-      def render_semantic_fragment(fragment_tag, text, url, position, options = {})
-        fragment_class = [options[:fragment_class], options[:class]].join(' ').strip
-        fragment_class = nil if fragment_class.blank?
-        fragment_tag = fragment_tag || 'span'
-        text = content_tag(:span, text, itemprop: "name")
+      def join_classes(*classes)
+        clazz = classes.join(' ').strip
+        clazz.blank? ? nil : clazz
+      end
 
-        aria_current = options[:aria_current]
-        if url.present?
-          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
+      # Proxy for +context.link_to+ that can be overridden by plugins.
+      def breadcrumb_link_to(name, url, options = {})
+        context.link_to(name, url, options)
+      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", "aria-current": aria_current)
+      # Proxy to view context.
+      def method_missing(method, *args, &block)
+        context.send(method, *args, &block)
       end
+    end
 
-      # Renders regular, non-semantic fragment HTML.
-      def render_nonsemantic_fragment(fragment_tag, text, url, options = {})
-        fragment_class = [options[:fragment_class], options[:class]].join(' ').strip
-        fragment_class = nil if fragment_class.blank?
+    class NonSemanticRenderer < Base
+      def render_fragment_tag(fragment_tag, text, url, position, options = {})
+        fragment_class = join_classes(options[:fragment_class], options[:class])
 
         if fragment_tag
           if url.present?
-            text = breadcrumb_link_to(text, url, "aria-current": options[:aria_current])
+            text = breadcrumb_link_to(text, url, "aria-current": options[:aria_current], data: options[:link_data])
             content_tag(fragment_tag, text, class: fragment_class)
           else
-            content_tag(fragment_tag, text, class: fragment_class, "aria-current": options[:aria_current])
+            content_tag(fragment_tag, text, class: fragment_class, "aria-current": options[:aria_current], data: options[:link_data])
           end
         elsif url.present?
-          breadcrumb_link_to(text, url, class: fragment_class, "aria-current": options[:aria_current])
+          breadcrumb_link_to(text, url, class: join_classes(fragment_class, options[:link_class]), "aria-current": options[:aria_current], data: options[:link_data])
         elsif options[:class].present?
           content_tag(:span, text, class: fragment_class, "aria-current": options[:aria_current])
         else
@@ -274,19 +305,31 @@ module Gretel
         end
       end
 
-      # Proxy for +context.link_to+ that can be overridden by plugins.
-      def breadcrumb_link_to(name, url, options = {})
-        context.link_to(name, url, options)
+      def render_container(html)
+        content_tag(options[:container_tag], html, id: options[:id], class: options[:class])
       end
+    end
 
-      # Proxy to view context.
-      def method_missing(method, *args, &block)
-        context.send(method, *args, &block)
+    class SemanticRenderer < Base
+      def render_fragment_tag(fragment_tag, text, url, position, options = {})
+        fragment_class = join_classes(options[:fragment_class], options[:class])
+        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", "aria-current": aria_current, class: options[:link_class], data: options[:link_data])
+          aria_current = nil
+        elsif options[:current_link].present?
+          text = text + tag(:link, itemprop: "item", href: options[:current_link])
+        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", "aria-current": aria_current, data: options[:link_data])
       end
 
-      # Avoid unnecessary html escaping by template engines.
-      def html_safe?
-        true
+      def render_container(html)
+        content_tag(options[:container_tag], html, id: options[:id], class: options[:class], itemscope: "", itemtype: "https://schema.org/BreadcrumbList")
       end
     end
   end

data/lib/gretel/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.5.0
 platform: ruby
 authors:
 - Lasse Bunk
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2023-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -20,7 +20,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +30,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: actionview
   requirement: !ruby/object:Gem::Requirement
@@ -40,7 +40,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
         version: '5.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -136,10 +136,11 @@ files:
 - lib/gretel/resettable.rb
 - lib/gretel/version.rb
 - lib/gretel/view_helpers.rb
-homepage: http://github.com/kzkn/gretel
+homepage: https://github.com/kzkn/gretel
 licenses:
 - MIT
-metadata: {}
+metadata:
+  changelog_uri: https://github.com/kzkn/gretel/blob/master/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Flexible Ruby on Rails breadcrumbs plugin.