gretel 3.0.7 → 4.0.2

data/lib/gretel/crumb.rb

@@ -3,6 +3,12 @@ module Gretel
     # Initializes a new crumb from the given +key+.
     # It finds the breadcrumb created in +Gretel::Crumbs.layout+ and renders the block using the arguments supplied in +args+.
     def initialize(context, key, *args)
+      if key.class.respond_to?(:model_name)
+        # Enables calling `breadcrumb @product` instead of `breadcrumb :product, @product`
+        args.unshift key
+        key = key.class.model_name.to_s.underscore.to_sym
+      end
+
       block = Gretel::Crumbs.crumbs[key]
       raise ArgumentError, "Breadcrumb :#{key} not found." unless block
       @key = key
@@ -38,6 +44,9 @@ module Gretel
     #
     # Example:
     #   parent :category, category
+    #
+    # Or short, which will infer the key from the model's `model_name`:
+    #   parent category
     def parent(*args)
       return @parent if args.empty?
       key = args.shift

data/lib/gretel/renderer.rb

@@ -8,6 +8,7 @@ module Gretel
       autoroot: true,
       display_single_fragment: false,
       link_current: false,
+      link_current_to_request_path: true,
       semantic: false,
       class: "breadcrumbs",
       current_class: "current",
@@ -21,6 +22,7 @@ module Gretel
       ol: { container_tag: :ol, fragment_tag: :li },
       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" },
       foundation5: { container_tag: :ul, fragment_tag: :li, class: "breadcrumbs", current_class: "current" }
     }
 
@@ -38,11 +40,6 @@ module Gretel
       LinkCollection.new(context, links, options)
     end
 
-    # Yields links with applied options.
-    def yield_links(options = {})
-      yield render(options)
-    end
-
     # Returns the parent breadcrumb.
     def parent_breadcrumb(options = {})
       render(options)[-2]
@@ -84,7 +81,7 @@ module Gretel
       end
 
       # Set current link to actual path
-      if out.any? && request
+      if options[:link_current_to_request_path] && out.any? && request
         out.last.url = request.fullpath
       end
 
@@ -111,7 +108,7 @@ module Gretel
 
         # Links of first crumb
         links = crumb.links.dup
-        
+
         # Get parent links
         links.unshift *parent_links_for(crumb)
 
@@ -137,9 +134,9 @@ module Gretel
 
     class << self
       include Resettable
-      
+
       # Registers a style for later use.
-      # 
+      #
       #   Gretel::Renderer.register_style :ul, { container_tag: :ul, fragment_tag: :li }
       def register_style(style_key, options)
         styles[style_key] = options
@@ -169,13 +166,14 @@ module Gretel
         return "" if links.empty?
 
         # Loop through all but the last (current) link and build HTML of the fragments
-        fragments = links[0..-2].map do |link|
-          render_fragment(options[:fragment_tag], link.text, link.url, options[:semantic])
+        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])
         end
 
         # The current link is handled a little differently, and is only linked if specified in the options
         current_link = links.last
-        fragments << render_fragment(options[:fragment_tag], current_link.text, (options[:link_current] ? current_link.url : nil), options[:semantic], class: options[:current_class])
+        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)
 
         # Build the final HTML
         html_fragments = []
@@ -191,42 +189,55 @@ module Gretel
         end
 
         html = html_fragments.join(" ").html_safe
-        content_tag(options[:container_tag], html, id: options[:id], class: options[:class])
+        
+        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
       end
 
       alias :to_s :render
 
       # Renders HTML for a breadcrumb fragment, i.e. a breadcrumb link.
-      def render_fragment(fragment_tag, text, url, semantic, options = {})
+      def render_fragment(fragment_tag, text, url, semantic, position, options = {})
         if semantic
-          render_semantic_fragment(fragment_tag, text, url, options)
+          render_semantic_fragment(fragment_tag, text, url, position, options)
         else
           render_nonsemantic_fragment(fragment_tag, text, url, options)
         end
       end
 
       # Renders semantic fragment HTML.
-      def render_semantic_fragment(fragment_tag, text, url, options = {})
-        if fragment_tag
-          text = content_tag(:span, text, itemprop: "title")
-          text = breadcrumb_link_to(text, url, itemprop: "url") if url.present?
-          content_tag(fragment_tag, text, class: options[:class], itemscope: "", itemtype: "http://data-vocabulary.org/Breadcrumb")
-        elsif url.present?
-          content_tag(:span, breadcrumb_link_to(content_tag(:span, text, itemprop: "title"), url, class: options[:class], itemprop: "url"), itemscope: "", itemtype: "http://data-vocabulary.org/Breadcrumb")
-        else
-          content_tag(:span, content_tag(:span, text, class: options[:class], itemprop: "title"), itemscope: "", itemtype: "http://data-vocabulary.org/Breadcrumb")
+      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")
+
+        if url.present?
+          text = breadcrumb_link_to(text, url, itemprop: "item")
+        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")
       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?
+
         if fragment_tag
           text = breadcrumb_link_to(text, url) if url.present?
-          content_tag(fragment_tag, text, class: options[:class])
+          content_tag(fragment_tag, text, class: fragment_class)
         elsif url.present?
-          breadcrumb_link_to(text, url, class: options[:class])
+          breadcrumb_link_to(text, url, class: fragment_class)
         elsif options[:class].present?
-          content_tag(:span, text, class: options[:class])
+          content_tag(:span, text, class: fragment_class)
         else
           text
         end
@@ -241,6 +252,11 @@ module Gretel
       def method_missing(method, *args, &block)
         context.send(method, *args, &block)
       end
+
+      # Avoid unnecessary html escaping by template engines.
+      def html_safe?
+        true
+      end
     end
   end
 end

data/lib/gretel/version.rb

@@ -1,3 +1,3 @@
 module Gretel
-  VERSION = "3.0.7"
-end
+  VERSION = "4.0.2"
+end

data/lib/gretel/view_helpers.rb

@@ -10,10 +10,6 @@ module Gretel
     def breadcrumb(key = nil, *args)
       if key.nil? || key.is_a?(Hash)
         raise ArgumentError, "The `breadcrumb` method was called with #{key.inspect} as the key. This method is used to set the breadcrumb. Maybe you meant to call the `breadcrumbs` method (with an 's' in the end) which is used to render the breadcrumbs?"
-      elsif key.class.respond_to?(:model_name)
-        # Enables calling `breadcrumb @product` instead of `breadcrumb :product, @product`
-        args.unshift key
-        key = key.class.model_name.to_s.underscore.to_sym
       end
       @_gretel_renderer = Gretel::Renderer.new(self, key, *args)
     end

metadata

@@ -1,61 +1,102 @@
 --- !ruby/object:Gem::Specification
 name: gretel
 version: !ruby/object:Gem::Version
-  version: 3.0.7
+  version: 4.0.2
 platform: ruby
 authors:
 - Lasse Bunk
-autorequire: 
+- Kazuki Nishikawa
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2020-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '5.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-erb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Gretel is a Ruby on Rails plugin that makes it easy yet flexible to create
   breadcrumbs.
 email:
-- lassebunk@gmail.com
+- kzkn@users.noreply.github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/Gemfile-rails.3.2.x
-- gemfiles/Gemfile-rails.4.0.x
-- gemfiles/Gemfile-rails.4.1.x
+- coverage/coverage.txt
 - gretel.gemspec
 - lib/generators/gretel/USAGE
 - lib/generators/gretel/install_generator.rb
@@ -63,126 +104,32 @@ files:
 - lib/gretel.rb
 - lib/gretel/crumb.rb
 - lib/gretel/crumbs.rb
-- lib/gretel/deprecated.rb
-- lib/gretel/deprecated/default_style_key.rb
-- lib/gretel/deprecated/layout.rb
-- lib/gretel/deprecated/show_root_alone.rb
-- lib/gretel/deprecated/yield_links.rb
 - lib/gretel/link.rb
 - lib/gretel/renderer.rb
 - lib/gretel/resettable.rb
 - lib/gretel/version.rb
 - lib/gretel/view_helpers.rb
-- test/deprecated_test.rb
-- test/dummy/Rakefile
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/mailers/.gitkeep
-- test/dummy/app/models/.gitkeep
-- test/dummy/app/models/issue.rb
-- test/dummy/app/models/project.rb
-- test/dummy/app/views/breadcrumbs/site.rb
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/breadcrumbs.rb
-- test/dummy/config/breadcrumbs/test_crumbs.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/db/migrate/20130122163007_create_projects.rb
-- test/dummy/db/migrate/20130122163051_create_issues.rb
-- test/dummy/db/schema.rb
-- test/dummy/lib/assets/.gitkeep
-- test/dummy/log/.gitkeep
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/script/rails
-- test/fixtures/issues.yml
-- test/fixtures/projects.yml
-- test/gretel_test.rb
-- test/helper_methods_test.rb
-- test/test_helper.rb
-homepage: http://github.com/lassebunk/gretel
+homepage: http://github.com/kzkn/gretel
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.1.10
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Flexible Ruby on Rails breadcrumbs plugin.
-test_files:
-- test/deprecated_test.rb
-- test/dummy/Rakefile
-- test/dummy/app/assets/javascripts/application.js
-- test/dummy/app/assets/stylesheets/application.css
-- test/dummy/app/controllers/application_controller.rb
-- test/dummy/app/helpers/application_helper.rb
-- test/dummy/app/mailers/.gitkeep
-- test/dummy/app/models/.gitkeep
-- test/dummy/app/models/issue.rb
-- test/dummy/app/models/project.rb
-- test/dummy/app/views/breadcrumbs/site.rb
-- test/dummy/config.ru
-- test/dummy/config/application.rb
-- test/dummy/config/boot.rb
-- test/dummy/config/breadcrumbs.rb
-- test/dummy/config/breadcrumbs/test_crumbs.rb
-- test/dummy/config/database.yml
-- test/dummy/config/environment.rb
-- test/dummy/config/environments/development.rb
-- test/dummy/config/environments/production.rb
-- test/dummy/config/environments/test.rb
-- test/dummy/config/initializers/backtrace_silencers.rb
-- test/dummy/config/initializers/inflections.rb
-- test/dummy/config/initializers/mime_types.rb
-- test/dummy/config/initializers/secret_token.rb
-- test/dummy/config/initializers/session_store.rb
-- test/dummy/config/initializers/wrap_parameters.rb
-- test/dummy/config/locales/en.yml
-- test/dummy/config/routes.rb
-- test/dummy/db/migrate/20130122163007_create_projects.rb
-- test/dummy/db/migrate/20130122163051_create_issues.rb
-- test/dummy/db/schema.rb
-- test/dummy/lib/assets/.gitkeep
-- test/dummy/log/.gitkeep
-- test/dummy/public/404.html
-- test/dummy/public/422.html
-- test/dummy/public/500.html
-- test/dummy/public/favicon.ico
-- test/dummy/script/rails
-- test/fixtures/issues.yml
-- test/fixtures/projects.yml
-- test/gretel_test.rb
-- test/helper_methods_test.rb
-- test/test_helper.rb
+test_files: []

data/gemfiles/Gemfile-rails.3.2.x

@@ -1,17 +0,0 @@
-source "https://rubygems.org"
-
-gem "gretel",  :path => ".."
-
-gem "rails", "~> 3.2.0"
-gem "sqlite3"
-
-# jquery-rails is used by the dummy application
-gem "jquery-rails"
-
-# Declare any dependencies that are still in development here instead of in
-# your gemspec. These might include edge Rails or gems from your path or
-# Git. Remember to move these dependencies to your gemspec before releasing
-# your gem to rubygems.org.
-
-# To use debugger
-# gem 'debugger'