jekyll_bootstrap5_tabs 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63ce06f23eb1d77f84b9d67685742a46d0eabc7adf6debb4eef596ba73681300
-  data.tar.gz: e11c0c59467faa3d38f96006f7b5bb88ef980baac765f602414274f9bbfa760e
+  metadata.gz: 0001fdf1657866adc8d206052cb3ca8fa750ccb47cd3c6804ca9bdd12bf8bb0e
+  data.tar.gz: ca58073ce8c9c79c3a6be3cf557cbe14c5c33a5291bff829f6981c6f064cd981
 SHA512:
-  metadata.gz: 83fdc5c10c81e75a6e97303888b2e09ea54f644722363c81d77b2b068310315377c770a81f95c526f1a32fbdbc93192f59f2c0cbff64706dc8ad0b38cad1d912
-  data.tar.gz: c8f51ac97da8afee5d108b2d8b8d9bd27c3a801cc83db6b36d4d2b1213db04f3c52a9172b067cde867ad2c7947c54df3d43de2b909f27996c2e132f910b800ee
+  metadata.gz: f360a04ac5d004484ea0c87f063bd16471bb517cdc6a48074cb8c7dfff1695b972609996a77d933f73cd7124699c1d639895e26fe863bbbc274fc19cd5b43a13
+  data.tar.gz: f373db002d72ec38e5f3c0f49aace64c064fca11fd37d3fa6bdfda4a2a39c58a5363805ec2f87bdec59227abd11995cc56d035ad0467d5db7b21025ba31a2cb7

data/README.md

@@ -2,15 +2,17 @@ Jekyll Bootstrap 5 Tabs
 [![Gem Version](https://badge.fury.io/rb/jekyll_bootstrap5_tabs.svg)](https://badge.fury.io/rb/jekyll_bootstrap5_tabs)
 ===========
 
+<img src="docs/tabDemo.gif" width="500" height="auto" />
+
 The original version, written by Artur Gabitov, expected Markdown and Bootstrap 4.
-This version requires Bootstrap 5 and HTML, not Markdown.
+[This version](https://rubygems.org/gems/jekyll_bootstrap5_tabs) requires Bootstrap 5 and HTML, not Markdown.
 
 
 ## Installation
 
 Add this to your project's `Gemfile`:
 ```ruby
-gem "jekyll_bootstrap5_tabs"
+gem 'jekyll_bootstrap5_tabs'
 ```
 
 Add this to your project's `_config.yml`:
@@ -26,40 +28,56 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install jekyll-simple-tab5
+    $ gem install jekyll_bootstrap5_tabs
 
 
 ## Usage
 
-Bootstrap 5 is required. One way to include Bootstrap 5 in your project is to add the following HTML into the &lt;head> tag:
+Bootstrap 5 is required.
+One way to include Bootstrap 5 into a page within 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:
+...and add this to the bottom of the HTML file, within the `<body/>` tag:
 ```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:
+
+## Two New Liquid Tags
+The `jekyll_bootstrap5_tabs` plugin provides two new Liquid tags: `tabs` and `tab`.
+Jekyll interprets the Liquid language when embedded into HTML pages.
+
+For example, given the following content in a Jekyll page that has
+[minimal front matter](https://jekyllrb.com/docs/front-matter/):
 ```
 ---
 ---
-{% tabs test %}
-  {% tab test#home %}
+{% tabs demo %}
+  {% tab demo#Home %}
     Home at last!
   {% endtab %}
-  {% tab test#profile %}
+  {% tab demo#Profile %}
     Profile meeee...
   {% endtab %}
-  {% tab test#messages %}
+  {% tab demo#Messages %}
     Messages - I have none
   {% endtab %}
 {% endtabs %}
 ```
-The jekyll_bootstrap5_tabs plugin will generate code similar to this:
+The outer tabs tag has a name: `demo`.
+Conceptually, this name defines a namespace scope for the inner `tab` tags, but actually this version does not use the name for any purpose.
+The inner `tab` tags reference the outer `tabs` tag (yes, this is redundant),
+and introduces the name of the tab that it defines after the octothorpe (aka hash mark, number sign, and pound sign: #). A Bootstrap 5 tab is created for every `tab` tag, and the `id` for each `tag` is defined by the characters following the octothorpe.
+This `id` is also displayed as the label for the `tab`, so if you want it capitalized a certain way, specify the tag capitalization in the `tab` tag.
+
+The current implementation does not allow spaces within tab labels.
+Instead, tab labels may only consist of one word each.
+
+The `jekyll_bootstrap5_tabs` plugin will generate code similar to the following.
 ```html
 <ul class="nav nav-tabs">
   <li class="nav-item">
@@ -74,13 +92,38 @@ The jekyll_bootstrap5_tabs plugin will generate code similar to this:
 </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 class="tab-pane active" id="home" aria-labelledby="home-tab">
+    <editor_fold Home>
+    Home at last!
+    </editor_fold>
+  </div>
+  <div class="tab-pane" id="profile" aria-labelledby="profile-tab">
+    <editor_fold Profile>
+      Profile meeee...
+    </editor_fold>
+  </div>
+  <div class="tab-pane" id="messages" aria-labelledby="messages-tab">
+    <editor_fold Messages>
+      Messages - I have none
+    </editor_fold>
+  </div>
 </div>
 ```
 
-![Image](docs/tab-screen.gif)
+### New for Version 1.1.0
+By default, the output is not pretty-printed.
+However, you can enable pretty-printing for a single set of tabs by including the `pretty` keyword in the `tabs` tag, like this:
+```
+{% tabs demo pretty %}
+  ... tab tags go here
+{% endtabs%}
+```
+
+You can enable pretty-printing for the entire site by adding the following to `_config.yaml`:
+```yaml
+jekyll_bootstrap5_tabs:
+  - pretty: true
+```
 
 
 ## Building
@@ -117,14 +160,18 @@ 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.
+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).
+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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/mslinn/jekyll-bootstrap5-tabs.
 
 
 ## License

data/jekyll_bootstrap5_tabs.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/jekyll_bootstrap5_tabs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jekyll_bootstrap5_tabs'
+  spec.version       = JekyllBootstrap5Tabs::VERSION
+  spec.authors       = ['Artur Gabitov', 'Mike Slinn']
+  spec.email         = ['applifort@gmail.com', 'mslinn@mslinn.com']
+
+  spec.summary       = 'Jekyll plugin for Bootstrap 5 tabs'
+  spec.description   = 'Enables Bootstrap 5 tabs in Jekyll 4 websites.'
+  spec.homepage      = 'https://mslinn.com/blog/2022/02/13/jekyll-gem.html'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.6.0'
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = 'https://github.com/mslinn/jekyll_bootstrap5_tabs'
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+
+  spec.bindir = 'bin'
+  spec.executables = spec.files.grep(%r{\Abin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'jekyll', '>= 3.0'
+  spec.add_dependency 'slim', '~> 3.0'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/jekyll_bootstrap5_tabs/version.rb

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

data/lib/jekyll_bootstrap5_tabs.rb

@@ -13,7 +13,28 @@ module JekyllBootstrap5Tabs
 
       raise SyntaxError.new("#{tag} requires name") if args.empty?
 
-      @tab_name = args.strip
+      argv = args.strip.split ' '
+      @tab_name = argv[0] # TODO @tab_name is never used. Should act as a namespace.
+
+      # Usage can override default and enable pretty-printing, not possible to disable per-tab
+      @pretty_print = false
+      if argv.length>1 && argv[1].downcase == 'pretty'
+        @pretty_print = true
+        puts "Bootstrap tab pretty-printing is enabled for {@tab_name}"
+      end
+    end
+
+    # @param config [YAML] Configuration data that might contain a entry for `jekyll_bootstrap5_tabs`
+    # @param progname [String] The name of the `option:` subentry to look for underneath the `jekyll_bootstrap5_tabs` entry
+    # @return [TrueClass, FalseClass]
+    def check_config_boolean(config, option)
+      tabs_options = config['jekyll_bootstrap5_tabs']
+      return false if tabs_options.nil?
+
+      hash = tabs_options.detect {|option| option["pretty"] }
+      # puts("*********** tabs_options = #{tabs_options}")
+      # puts("*********** hash = #{hash}")
+      return (not hash.nil?) && hash['pretty']
     end
 
     def template_path(template_name)
@@ -22,10 +43,20 @@ module JekyllBootstrap5Tabs
     end
 
     def render(context)
-      @environment = context.environments.first
+      site = context.registers[:site]
+      # Set the pretty-print option for the Slim engine
+      # Global configuration provides the default value of @pretty_print
+      if check_config_boolean(site.config, 'pretty')
+        @pretty_print = true
+        puts "Bootstrap tab pretty-printing is enabled by default for the entire Jekyll site."
+      end
+
+      @environment = context.environments.first  # Has type Jekyll::Drops::UnifiedPayloadDrop
+      #puts("TabsBlock.render: @environment = '#{@environment}'")
       super
 
       template_file_path = template_path(DEFAULT_TEMPLATE)
+      Slim::Engine.set_options pretty: @pretty_print
       template = Slim::Template.new(template_file_path)
       template.render(self)
     end
@@ -37,13 +68,14 @@ module JekyllBootstrap5Tabs
       super
 
       @tabs_group, @tab = split_params(args.strip)
+      #puts("TabBlock: @tabs_group = '#{@tabs_group}', @tab = '#{@tab}'")
       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 = context.environments.first # Has type Jekyll::Drops::UnifiedPayloadDrop
       environment["tabs-#{@tabs_group}"] ||= {}
       environment["tabs-#{@tabs_group}"][@tab] = content
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_bootstrap5_tabs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Artur Gabitov
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-14 00:00:00.000000000 Z
+date: 2022-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -52,11 +52,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- docs/tab-screen.gif
+- docs/tabDemo.gif
+- jekyll_bootstrap5_tabs.gemspec
 - lib/jekyll_bootstrap5_tabs.rb
 - lib/jekyll_bootstrap5_tabs/version.rb
 - lib/template.slim
 - pkg/jekyll_bootstrap5_tabs-1.0.0.gem
+- pkg/jekyll_bootstrap5_tabs-1.1.0.gem
 - sig/jekyll_bootstrap5_tabs.rbs
 homepage: https://mslinn.com/blog/2022/02/13/jekyll-gem.html
 licenses: