jekyll_bootstrap5_tabs 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63ce06f23eb1d77f84b9d67685742a46d0eabc7adf6debb4eef596ba73681300
+  data.tar.gz: e11c0c59467faa3d38f96006f7b5bb88ef980baac765f602414274f9bbfa760e
+SHA512:
+  metadata.gz: 83fdc5c10c81e75a6e97303888b2e09ea54f644722363c81d77b2b068310315377c770a81f95c526f1a32fbdbc93192f59f2c0cbff64706dc8ad0b38cad1d912
+  data.tar.gz: c8f51ac97da8afee5d108b2d8b8d9bd27c3a801cc83db6b36d4d2b1213db04f3c52a9172b067cde867ad2c7947c54df3d43de2b909f27996c2e132f910b800ee

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# The gem's dependencies are specified in jekyll_bootstrap5_tabs.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    jekyll_bootstrap5_tabs (1.0.0)
+      jekyll (>= 3.0)
+      slim (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    colorator (1.1.0)
+    concurrent-ruby (1.1.9)
+    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.9.1)
+      concurrent-ruby (~> 1.0)
+    jekyll (4.2.1)
+      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.1.0)
+      sassc (> 2.0.1, < 3.0)
+    jekyll-watch (2.2.1)
+      listen (~> 3.0)
+    kramdown (2.3.1)
+      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)
+    public_suffix (4.0.6)
+    rake (13.0.6)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rexml (3.2.5)
+    rouge (3.28.0)
+    safe_yaml (1.0.5)
+    sassc (2.4.0)
+      ffi (~> 1.9)
+    slim (3.0.9)
+      temple (>= 0.7.6, < 0.9)
+      tilt (>= 1.3.3, < 2.1)
+    temple (0.8.2)
+    terminal-table (2.0.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    tilt (2.0.10)
+    unicode-display_width (1.8.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  jekyll_bootstrap5_tabs!
+  rake (~> 13.0)
+
+BUNDLED WITH
+   2.3.5

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Artur Gabitov
+Portions Copyright (c) 2022 Mike Slinn
+
+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

@@ -0,0 +1,132 @@
+Jekyll Bootstrap 5 Tabs
+[![Gem Version](https://badge.fury.io/rb/jekyll_bootstrap5_tabs.svg)](https://badge.fury.io/rb/jekyll_bootstrap5_tabs)
+===========
+
+The original version, written by Artur Gabitov, expected Markdown and Bootstrap 4.
+This version requires Bootstrap 5 and HTML, not Markdown.
+
+
+## Installation
+
+Add this to your project's `Gemfile`:
+```ruby
+gem "jekyll_bootstrap5_tabs"
+```
+
+Add this to your project's `_config.yml`:
+
+```yaml
+plugins:
+  - jekyll_bootstrap5_tabs
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll-simple-tab5
+
+
+## Usage
+
+Bootstrap 5 is required. One way to include Bootstrap 5 in your project is to add the following HTML into the <head> tag:
+```html
+  <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/css/bootstrap.min.css" rel="stylesheet"
+    integrity="sha384-1BmE4kWBq78iYhFldvKuhfTAU6auU8tT94WrHftjDbrCEXSU1oBoqyl2QvZ6jIW3" crossorigin="anonymous">
+```
+...and add this to the bottom of the HTML file:
+```html
+  <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.1.3/dist/js/bootstrap.bundle.min.js"></script>
+```
+
+See this [working minimal Bootstrap 5 tab example](https://codepen.io/mslinn/pen/OJOjVPR)
+
+For example, given the following content in a Jekyll page:
+```
+---
+---
+{% tabs test %}
+  {% tab test#home %}
+    Home at last!
+  {% endtab %}
+  {% tab test#profile %}
+    Profile meeee...
+  {% endtab %}
+  {% tab test#messages %}
+    Messages - I have none
+  {% endtab %}
+{% endtabs %}
+```
+The jekyll_bootstrap5_tabs plugin will generate code similar to this:
+```html
+<ul class="nav nav-tabs">
+  <li class="nav-item">
+    <a class="nav-link active" data-bs-toggle="tab" aria-current="page" href="#home">Home</a>
+  </li>
+  <li class="nav-item">
+    <a class="nav-link" data-bs-toggle="tab" aria-current="page" href="#profile">Profile</a>
+  </li>
+  <li class="nav-item">
+    <a class="nav-link" data-bs-toggle="tab" aria-current="page" href="#messages">Messages</a>
+  </li>
+</ul>
+
+<div class="tab-content">
+  <div class="tab-pane active" id="home" aria-labelledby="home-tab">Home at last!</div>
+  <div class="tab-pane" id="profile" aria-labelledby="profile-tab">Profile meeee...</div>
+  <div class="tab-pane" id="messages" aria-labelledby="messages-tab">Messages - I have none</div>
+</div>
+```
+
+![Image](docs/tab-screen.gif)
+
+
+## Building
+
+```shell
+$ rake build jekyll_bootstrap5_tabs.gemspec
+jekyll_bootstrap5_tabs 1.0.0 built to pkg/jekyll_bootstrap5_tabs-1.0.0.gem.
+```
+
+The most recently built gem is provided in `pkg/`.
+
+
+## Installing
+
+```shell
+$ gem install pkg/jekyll_bootstrap5_tabs-1.0.0.gem
+Fetching slim-4.1.0.gem
+Fetching temple-0.8.2.gem
+Successfully installed temple-0.8.2
+Successfully installed slim-4.1.0
+Successfully installed jekyll_bootstrap5_tabs-1.0.0
+Parsing documentation for temple-0.8.2
+Installing ri documentation for temple-0.8.2
+Parsing documentation for slim-4.1.0
+Installing ri documentation for slim-4.1.0
+Parsing documentation for jekyll_bootstrap5_tabs-1.0.0
+Installing ri documentation for jekyll_bootstrap5_tabs-1.0.0
+Done installing documentation for temple, slim, jekyll_bootstrap5_tabs after 0 seconds
+3 gems installed
+```
+
+Now go use the gem in a Jekyll project!
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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).
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mslinn/jekyll-simple-tab5.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+task default: %i[]

data/lib/jekyll_bootstrap5_tabs/version.rb

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

data/lib/jekyll_bootstrap5_tabs.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'slim'
+require_relative "jekyll_bootstrap5_tabs/version"
+
+DEFAULT_TEMPLATE = 'template.slim'
+
+module JekyllBootstrap5Tabs
+  # Handles the outer {% tabs %}{% endtabs %} Liquid block for Bootstrap 5
+  class TabsBlock < Liquid::Block
+    def initialize(tag, args, _)
+      super
+
+      raise SyntaxError.new("#{tag} requires name") if args.empty?
+
+      @tab_name = args.strip
+    end
+
+    def template_path(template_name)
+      dir = File.dirname(__FILE__)
+      File.join(dir, template_name.to_s)
+    end
+
+    def render(context)
+      @environment = context.environments.first
+      super
+
+      template_file_path = template_path(DEFAULT_TEMPLATE)
+      template = Slim::Template.new(template_file_path)
+      template.render(self)
+    end
+  end
+
+  # Handles the inner {% tab %}{% endtab %} Liquid block for Bootstrap 5
+  class TabBlock < Liquid::Block
+    def initialize(tag, args, _)
+      super
+
+      @tabs_group, @tab = split_params(args.strip)
+      raise SyntaxError.new("Block #{tag} requires tabs name") if @tabs_group.empty? || @tab.empty?
+    end
+
+    def render(context)
+      content = super
+
+      environment = context.environments.first
+      environment["tabs-#{@tabs_group}"] ||= {}
+      environment["tabs-#{@tabs_group}"][@tab] = content
+    end
+
+    private
+
+    def split_params(params)
+      params.split('#')
+    end
+  end
+end
+
+Liquid::Template.register_tag('tabs', JekyllBootstrap5Tabs::TabsBlock)
+Liquid::Template.register_tag('tab', JekyllBootstrap5Tabs::TabBlock)

data/lib/template.slim

@@ -0,0 +1,15 @@
+ul.nav.nav-tabs
+  - @environment["tabs-#{@tab_name}"].each_with_index do |(key, _), index|
+    li.nav-item
+      - if index == 0
+        a.nav-link.active id="#{key}-tab" data-bs-toggle="tab" href="##{key}" aria-current="page" aria-selected="true"= key
+      - else
+        a.nav-link id="#{key}-tab" data-bs-toggle="tab" href="##{key}" aria-current="page" aria-selected="false"= key
+.tab-content id="#{@tab_name}-content"
+  - @environment["tabs-#{@tab_name}"].each_with_index do |(key, value), index|
+    - if index == 0
+      .tab-pane.active id="#{key}" aria-labelledby="#{key}-tab"
+        == value
+    - else
+      .tab-pane id="#{key}" aria-labelledby="#{key}-tab"
+        == value

data/sig/jekyll_bootstrap5_tabs.rbs

@@ -0,0 +1,4 @@
+module JekyllBootstrap5Tabs
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_bootstrap5_tabs
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Artur Gabitov
+- Mike Slinn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Enables Bootstrap 5 tabs in Jekyll 4 websites.
+email:
+- applifort@gmail.com
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- docs/tab-screen.gif
+- lib/jekyll_bootstrap5_tabs.rb
+- lib/jekyll_bootstrap5_tabs/version.rb
+- lib/template.slim
+- pkg/jekyll_bootstrap5_tabs-1.0.0.gem
+- sig/jekyll_bootstrap5_tabs.rbs
+homepage: https://mslinn.com/blog/2022/02/13/jekyll-gem.html
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://mslinn.com/blog/2022/02/13/jekyll-gem.html
+  source_code_uri: https://github.com/mslinn/jekyll_bootstrap5_tabs
+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.2.5
+signing_key: 
+specification_version: 4
+summary: Jekyll plugin for Bootstrap 5 tabs
+test_files: []