jekyll-breadcrumbs-tag 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cd042d43ddc891227e4d5122bb4c3224e9c14f008e9c14dfb71f4b364cc28801
+  data.tar.gz: 397ed07ee0b102b323826cf6da3d21a14f059df545a577353434a5decd0027a6
+SHA512:
+  metadata.gz: e2e60532715d1211b8615d40c77e4d5a67ca4b87d96366db47ae1856ca425239f7158de9cb521c9b1d62330045328fbbef855210cb0cbccd3adb7114aa103a23
+  data.tar.gz: 7c1ae493eefcfb982c0a2da3fafc5c988a47f9cf59e5b9dfcc632acf3390db7973cb999ef94bb512d8ed618be071a1fbdd2d6b46eac68798715765e127d4d1e3

data/.rspec

@@ -0,0 +1,2 @@
+--require spec_helper
+--require rspec-power_assert

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-gsnippet-tag.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec"
+gem "rspec-power_assert"

data/Gemfile.lock

@@ -0,0 +1,97 @@
+PATH
+  remote: .
+  specs:
+    jekyll-breadcrumbs-tag (0.1.0)
+      jekyll
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    em-websocket (0.5.3)
+      eventmachine (>= 0.12.9)
+      http_parser.rb (~> 0)
+    eventmachine (1.2.7)
+    ffi (1.15.5)
+    forwardable-extended (2.6.0)
+    http_parser.rb (0.8.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.2.2)
+      addressable (~> 2.4)
+      colorator (~> 1.0)
+      em-websocket (~> 0.5)
+      i18n (~> 1.0)
+      jekyll-sass-converter (~> 2.0)
+      jekyll-watch (~> 2.0)
+      kramdown (~> 2.3)
+      kramdown-parser-gfm (~> 1.0)
+      liquid (~> 4.0)
+      mercenary (~> 0.4.0)
+      pathutil (~> 0.9)
+      rouge (~> 3.0)
+      safe_yaml (~> 1.0)
+      terminal-table (~> 2.0)
+    jekyll-sass-converter (2.2.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.4.0)
+      rexml
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    liquid (4.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    mercenary (0.4.0)
+    pathutil (0.16.2)
+      forwardable-extended (~> 2.6)
+    power_assert (1.1.7)
+    public_suffix (5.0.0)
+    rake (13.0.6)
+    rb-fsevent (0.11.2)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.5)
+    rouge (3.30.0)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-power_assert (1.1.0)
+      power_assert (~> 1.1.0)
+      rspec (>= 2.14)
+    rspec-support (3.11.1)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    terminal-table (2.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  arm64-darwin-21
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  jekyll-breadcrumbs-tag!
+  rake (~> 13.0)
+  rspec
+  rspec-power_assert
+
+BUNDLED WITH
+   2.3.14

data/README.md

@@ -0,0 +1,59 @@
+# Jekyll Breadcrumbs Tag
+
+Breadcrumbs tag for Jekyll.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+
+group :jekyll_plugins do
+  gem "jekyll-breadcrumbs-tag"
+end
+```
+
+```
+bundle
+```
+
+```yml
+# _config.yml
+plugins: [jekyll-breadcrumbs-tag]
+```
+
+## Usage
+
+`_config.yaml`:
+
+```yaml
+breadcrumbs:
+  -
+    name: top
+    link: /
+    text: Top Page
+  -
+    name: about
+    link: /about
+    text: About Page
+    parent: top
+```
+
+
+```html
+<%= breadcrumbs about %>
+```
+
+Custom template `_includes/breadcrumbs.html`:
+
+```html
+{% for breadcrumb in breadcrumbs %}
+  {% if forloop.first == false %}&nbsp;>&nbsp;{% endif %}<a href="{{ breadcrumb.link }}">{{ breadcrumb.text }}</a>
+{% endfor %}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/jekyll-breadcrumbs-tag.gemspec

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "breadcrumbs/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "jekyll-breadcrumbs-tag"
+  spec.version = Breadcrumbs::VERSION
+  spec.authors = [""]
+  spec.email = [""]
+
+  spec.summary = "Breadcrumbs tag for Jekyll"
+  spec.description = "Breadcrumbs tag for Jekyll"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["source_code_uri"] = "https://github.com/colorfulcompany/jekyll-breadcrumbs-tag"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "jekyll"
+end

data/lib/breadcrumbs/list.rb

@@ -0,0 +1,20 @@
+module Breadcrumbs
+  class List
+    def initialize(all)
+      @all = all
+    end
+
+    def to_a(name)
+      list = []
+      list << @all.find { |b| b["name"] == name }
+      loop do
+        if list.first["parent"]
+          list.prepend(@all.find { |b| b["name"] === list.first["parent"] })
+        else
+          break
+        end
+      end
+      list
+    end
+  end
+end

data/lib/breadcrumbs/tag.rb

@@ -0,0 +1,23 @@
+require "jekyll"
+require_relative "./template"
+require_relative "./list"
+
+module Breadcrumbs
+  class Tag < Liquid::Tag
+    def initialize(_, name, _)
+      @name = name.strip
+    end
+
+    def render(context)
+      root = context.registers[:site].config["source"]
+      template = Breadcrumbs::Template.new(root).load
+      Liquid::Template.parse(template).render(
+        {
+          "breadcrumbs" => Breadcrumbs::List.new(context.registers[:site].config["breadcrumbs"]).to_a(@name)
+        }
+      )
+    end
+
+    Liquid::Template.register_tag "breadcrumbs", self
+  end
+end

data/lib/breadcrumbs/template.html

@@ -0,0 +1 @@
+{% for breadcrumb in breadcrumbs %}{% if forloop.first == false %}&nbsp;>&nbsp;{% endif %}<a href="{{ breadcrumb.link }}">{{ breadcrumb.text }}</a>{% endfor %}

data/lib/breadcrumbs/template.rb

@@ -0,0 +1,16 @@
+module Breadcrumbs
+  class Template
+    def initialize(root)
+      @root = root
+    end
+
+    def load
+      custom = File.join(@root, "_includes", "breadcrumbs.html")
+      if File.exist?(custom)
+        File.read(custom)
+      else
+        File.read(File.join(__dir__, "template.html"))
+      end
+    end
+  end
+end

data/lib/breadcrumbs/version.rb

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

data/lib/jekyll-breadcrumbs-tag.rb

@@ -0,0 +1 @@
+require "jekyll_breadcrumbs_tag"

data/lib/jekyll_breadcrumbs_tag.rb

@@ -0,0 +1,2 @@
+require "breadcrumbs/version"
+require "breadcrumbs/tag"

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-breadcrumbs-tag
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ''
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Breadcrumbs tag for Jekyll
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- jekyll-breadcrumbs-tag.gemspec
+- lib/breadcrumbs/list.rb
+- lib/breadcrumbs/tag.rb
+- lib/breadcrumbs/template.html
+- lib/breadcrumbs/template.rb
+- lib/breadcrumbs/version.rb
+- lib/jekyll-breadcrumbs-tag.rb
+- lib/jekyll_breadcrumbs_tag.rb
+homepage: 
+licenses: []
+metadata:
+  source_code_uri: https://github.com/colorfulcompany/jekyll-breadcrumbs-tag
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key: 
+specification_version: 4
+summary: Breadcrumbs tag for Jekyll
+test_files: []