jekyll_bootstrap5_tabs 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0001fdf1657866adc8d206052cb3ca8fa750ccb47cd3c6804ca9bdd12bf8bb0e
-  data.tar.gz: ca58073ce8c9c79c3a6be3cf557cbe14c5c33a5291bff829f6981c6f064cd981
+  metadata.gz: 3ee903a6b9132d44b95aa515db8a8730f966236af24a6509a38c5d2d689c6b74
+  data.tar.gz: 042c83afb00526d342e9ea277fd90e20f085e34f362e82c1b2f4d09cedfbb78b
 SHA512:
-  metadata.gz: f360a04ac5d004484ea0c87f063bd16471bb517cdc6a48074cb8c7dfff1695b972609996a77d933f73cd7124699c1d639895e26fe863bbbc274fc19cd5b43a13
-  data.tar.gz: f373db002d72ec38e5f3c0f49aace64c064fca11fd37d3fa6bdfda4a2a39c58a5363805ec2f87bdec59227abd11995cc56d035ad0467d5db7b21025ba31a2cb7
+  metadata.gz: 286f968d091b8632c85816c06298021f4b52bb9d71f14ee3a0cc310f33f38040a974b2e4732416ce7e2467a372e1a411fa5b72f798469cd8e96f1014279a1ce8
+  data.tar.gz: 83049504f8aa13fcd5da7964437309f0332ec06c4a92603a608c6bd1bfee54094cd082163d13cce70bff506646183d4d116d33c657fd1405392acd5de4639349

data/.rubocop.yml

@@ -0,0 +1,31 @@
+require: rubocop-jekyll
+inherit_gem:
+  rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - Gemfile*
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 150
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false

data/.vscode/launch.json

@@ -0,0 +1,20 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Debug test/test3.rb",
+      "type": "Ruby",
+      "request": "launch",
+      "program": "test/test3.rb"
+    },
+    {
+      "name": "Debug test/test.rb",
+      "type": "Ruby",
+      "request": "launch",
+      "program": "${workspaceFolderBasename}/test/test.rb"
+    }
+  ]
+}

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+## 1.1.1 / 2022-03-14
+  * Using `Jekyll.logger` instead of `puts`
+
+## 1.1.0 / 2022-03-13
+  * Added support for controlling pretty-printed output in `_config.yml`:
+    ```yml
+    jekyll_bootstrap5_tabs
+      -pretty_print: true
+    ```
+
+## 1.0.0 / 2022-03-13
+  * Mike Slinn forked the project
+  * Made into a Ruby gem and published on RubyGems.org as [jekyll_pre](https://rubygems.org/gems/jekyll_pre).
+  * `bin/attach` script added for debugging
+  * Rubocop standards added
+  * Proper versioning and CHANGELOG.md added
+
+## 0.1.6 2021-02-28
+
+## 0.1.5 2021-02-28
+
+## 0.1.4 2021-02-28
+
+## 0.1.3 2021-02-28
+
+## 0.1.2 2021-02-28
+
+## 0.1.1 2021-02-28
+
+## 0.1.0 2021-02-28
+  * Initial version published

data/Gemfile

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-source "https://rubygems.org"
+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"
+gem 'listen'
+gem 'rake', '~> 13.0'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jekyll_bootstrap5_tabs (1.0.0)
+    jekyll_bootstrap5_tabs (1.1.1)
       jekyll (>= 3.0)
       slim (~> 3.0)
 
@@ -19,9 +19,9 @@ GEM
     ffi (1.15.5)
     forwardable-extended (2.6.0)
     http_parser.rb (0.8.0)
-    i18n (1.9.1)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    jekyll (4.2.1)
+    jekyll (4.2.2)
       addressable (~> 2.4)
       colorator (~> 1.0)
       em-websocket (~> 0.5)
@@ -36,7 +36,7 @@ GEM
       rouge (~> 3.0)
       safe_yaml (~> 1.0)
       terminal-table (~> 2.0)
-    jekyll-sass-converter (2.1.0)
+    jekyll-sass-converter (2.2.0)
       sassc (> 2.0.1, < 3.0)
     jekyll-watch (2.2.1)
       listen (~> 3.0)
@@ -75,7 +75,8 @@ PLATFORMS
 
 DEPENDENCIES
   jekyll_bootstrap5_tabs!
+  listen
   rake (~> 13.0)
 
 BUNDLED WITH
-   2.3.5
+   2.3.7

data/README.md

@@ -111,7 +111,7 @@ The `jekyll_bootstrap5_tabs` plugin will generate code similar to the following.
 ```
 
 ### New for Version 1.1.0
-By default, the output is not pretty-printed.
+By default, the plugin 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 %}
@@ -119,43 +119,30 @@ However, you can enable pretty-printing for a single set of tabs by including th
 {% endtabs%}
 ```
 
-You can enable pretty-printing for the entire site by adding the following to `_config.yaml`:
+You can enable pretty-printing for the entire Jekyll site by adding the following to `_config.yaml`:
 ```yaml
 jekyll_bootstrap5_tabs:
   - pretty: true
 ```
 
 
-## Building
+## Installation
 
-```shell
-$ rake build jekyll_bootstrap5_tabs.gemspec
-jekyll_bootstrap5_tabs 1.0.0 built to pkg/jekyll_bootstrap5_tabs-1.0.0.gem.
-```
+Add this line to your application's Gemfile, within the `jekyll_plugins` group:
 
-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
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_bootstrap5_tabs'
+end
 ```
 
-Now go use the gem in a Jekyll project!
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_bootstrap5_tabs
 
 
 ## Development
@@ -163,15 +150,27 @@ Now go use the gem in a Jekyll project!
 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 publicly release a new version:
+
+ 1. Update the version number in `version.rb`
+ 2. Commit changes to git.
+ 3. Run:
+    ```shell
+    $ bundle exec rake release
+    ```
+    The above creates a git tag for the version,
+    pushes the created git tag to the git repo,
+    and pushes the new `.gem` file in `pkg/` to [RubyGems.org](https://rubygems.org).
 
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/mslinn/jekyll-bootstrap5-tabs.
+Bug reports and pull requests are welcome on GitHub at [`github.com/mslinn/jekyll_bootstrap5_tabs`](https://github.com/mslinn/jekyll_bootstrap5_tabs).
 
 
 ## License

data/lib/jekyll_bootstrap5_tabs/version.rb

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

data/lib/jekyll_bootstrap5_tabs.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'slim'
-require_relative "jekyll_bootstrap5_tabs/version"
+require_relative 'jekyll_bootstrap5_tabs/version'
 
 DEFAULT_TEMPLATE = 'template.slim'
 
@@ -11,30 +11,30 @@ module JekyllBootstrap5Tabs
     def initialize(tag, args, _)
       super
 
-      raise SyntaxError.new("#{tag} requires name") if args.empty?
+      raise SyntaxError, "#{tag} requires name" if args.empty?
 
       argv = args.strip.split ' '
-      @tab_name = argv[0] # TODO @tab_name is never used. Should act as a namespace.
+      @tab_name = argv[0]
 
       # 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
+      return unless argv.length > 1 && argv[1].downcase == 'pretty'
+
+      @pretty_print = true
+      Jekyll.logger.info "Bootstrap tab pretty-printing is enabled for the tabs with id '#{@tab_name}'"
     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)
+    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']
+      hash = tabs_options.detect { |opt| opt['pretty'] }
+      Jekyll.logger.debug "jekyll_bootstrap5_tabs: tabs_options = #{tabs_options}"
+      Jekyll.logger.debug "jekyll_bootstrap5_tabs: hash = #{hash}"
+      !hash.nil? && hash['pretty']
     end
 
     def template_path(template_name)
@@ -48,11 +48,11 @@ module JekyllBootstrap5Tabs
       # 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."
+        Jekyll.logger.info '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}'")
+      @environment = context.environments.first # Has type Jekyll::Drops::UnifiedPayloadDrop
+      Jekyll.logger.debug "TabsBlock.render: @environment = '#{@environment}'"
       super
 
       template_file_path = template_path(DEFAULT_TEMPLATE)
@@ -68,8 +68,8 @@ 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?
+      Jekyll.logger.debug "TabBlock: @tabs_group = '#{@tabs_group}', @tab = '#{@tab}'"
+      raise SyntaxError, "Block #{tag} requires tabs name" if @tabs_group.empty? || @tab.empty?
     end
 
     def render(context)

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_bootstrap5_tabs
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Artur Gabitov
 - Mike Slinn
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-19 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -47,6 +47,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
+- ".vscode/launch.json"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -57,8 +60,6 @@ files:
 - 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:
@@ -66,7 +67,7 @@ licenses:
 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -81,8 +82,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Jekyll plugin for Bootstrap 5 tabs
 test_files: []