jekyll_outline 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3efed359f1a20b1b255dff89ae002fc464162ae11f2ffbaaf2463cfdce031cfa
-  data.tar.gz: ba1a9378d1424cc673fb75bcc0bd8a0758b6861facb66474a24dad19a568940d
+  metadata.gz: 464b66396b0abd3369669875ca6b2be97b51e7823e31d5fa163b4248afc0dc50
+  data.tar.gz: 1253ef8b8218d0c4f76cb66d5f79ef0bc4fef48cec8d057ef33b0af0411e352f
 SHA512:
-  metadata.gz: a1147061ffb817c16a64002a8b300380943a319eb44c0077c54f76b9d6cd2f6d4500778fd369deed65f7256357feb5140129bda26be08344b2149bce00861b06
-  data.tar.gz: d03d8db73e90f7c39aa5b6f8f379ab2cfe8d47dae740e2e0a9d6355ac486713db28e02af07145e33279cba2d9aba982ae10f07c08087c192c953851d7fd51f25
+  metadata.gz: 96bf42bd9e24050bf05fc9c5d1a2094383f2dd3853c301da97ce5e8276969de31ddc98cc5102f3288e46cb84ae9032a2e8c40813993445d837a5a60ffd4b0559
+  data.tar.gz: 56facfe2c9305b0945ad1d315018b078f1a0402b1c91655ea01a2741f9f39d2975bce5de31eb84490126f4b19700e98a617a84d61a17fbc27a225cc750b941ba

data/.rubocop.yml

@@ -1,6 +1,8 @@
 require:
- - rubocop-rspec
+ - rubocop-md
+ - rubocop-performance
  - rubocop-rake
+ - rubocop-rspec
 
 AllCops:
   Exclude:
@@ -17,7 +19,8 @@ Gemspec/RequireMFA:
   Enabled: false
 
 Layout/HashAlignment:
-  Enabled: false
+  EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
 
 Layout/LineLength:
   Max: 150

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 1.1.1 / 2023-04-02
+  * Added [`attribution` support](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution).
+
 ## 1.1.0 / 2023-03-14
   * `outline_js` tag added, for including Javascript necessary to position images relating to the outline.
   * Now generates a series of divs, instead of one big div.

data/README.md

@@ -6,11 +6,12 @@
 
 
 ## Installation
-
-Add this line to your application's Gemfile:
+Add the following line to your Jekyll project's Gemfile, within the `jekyll_plugins` group:
 
 ```ruby
-gem 'jekyll_outline'
+group :jekyll_plugins do
+  gem 'jekyll_outline'
+end
 ```
 
 And then execute:
@@ -45,7 +46,6 @@ If passed the `wrap_in_script_tag` parameter, it wraps the JavaScript in `<scrip
 
 
 ## Explanation
-
 Given an outline that looks like this:
 ```html
 {% outline stuff %}
@@ -85,7 +85,10 @@ and have `id`s that correspond to outline sections.
 
 Each of following image's `id`s have a `outline_` prefix, followed by a number, which corresponds to one of the sections.
 Note that leading zeros in the first column above are not present in the `id`s below.
+
+The images are wrapped within an invisible `div` so the web page does not jump around as the images are loaded.
 ```html
+<div style="display: none;">
 {% img align="right"
   id="outline_0"
   size="quartersize"
@@ -107,6 +110,7 @@ Note that leading zeros in the first column above are not present in the `id`s b
   style="margin-top: 0"
   wrapper_class="clear"
 %}
+</div>
 ```
 The JavaScript identifies the images and repositions them in the DOM such that they follow the appropriate heading.
 If no image corresponds to a heading, no error or warning is generated.
@@ -114,20 +118,18 @@ The images can be located anywhere on the page; they will be relocated appropria
 If an image does not correspond to a heading, it is deleted.
 
 
+## Attribution
+See [`jekyll_plugin_support` for `attribution`](https://github.com/mslinn/jekyll_plugin_support#subclass-attribution)
+
+
 ## Additional Information
 More information is available on
 [Mike Slinn&rsquo;s website](https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#outline).
 
 
 ## 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.
-
-Install development dependencies like this:
-```
-$ BUNDLE_WITH="development" bundle install
-```
+After checking out the repo, run `bin/setup` to install development dependencies.
+Then you can run `bin/console` for an interactive prompt that will allow you to experiment with `irb`.
 
 To build and install this gem onto your local machine, run:
 ```shell
@@ -150,16 +152,28 @@ jekyll_outline (0.1.0)
 ```
 
 
-## Test
-A test website is provided in the `demo` directory.
- 1. Set breakpoints.
+## Demo
+A demo / test website is provided in the `demo` directory.
+It can be used to debug the plugin or to run freely.
+
+### Run Freely
+ 1. Run from the command line:
+    ```shell
+    $ demo/_bin/debug -r
+    ```
+
+  2. View the generated website at [`http://localhost:4444`](http://localhost:4444)
+
+### Plugin Debugging
+ 1. Set breakpoints in Visual Studio Code.
 
  2. Initiate a debug session from the command line:
     ```shell
-    $ bin/attach demo
+    $ demo/_bin/debug
     ```
 
-  3. Once the `Fast Debugger` signon appears, launch the Visual Studio Code launch configuration called `Attach rdebug-ide`.
+  3. Once the `Fast Debugger` signon appears, launch the Visual Studio Code launch
+     configuration called `Attach rdebug-ide`.
 
   4. View the generated website at [`http://localhost:4444`](http://localhost:4444)
 
@@ -178,10 +192,8 @@ To release a new version,
 
 
 ## Contributing
-
 Bug reports and pull requests are welcome on GitHub at https://github.com/mslinn/jekyll_outline.
 
 
 ## License
-
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/jekyll_outline.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
     '.rubocop.yml', 'LICENSE.*', 'Rakefile', '{lib,spec}/**/*', '*.gemspec', '*.md',
     'demo/assets/js/jekyll_outline.js'
   ]
-  spec.homepage = 'https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#outline'
+  spec.homepage = 'https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#outline'
   spec.license = 'MIT'
   spec.metadata = {
     'allowed_push_host' => 'https://rubygems.org',
@@ -36,5 +36,5 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
   spec.add_dependency 'jekyll_draft', '~> 1.1.0'
-  spec.add_dependency 'jekyll_plugin_support', '~> 0.5.0'
+  spec.add_dependency 'jekyll_plugin_support', '~> 0.6.0'
 end

data/lib/jekyll_outline/version.rb

@@ -1,3 +1,3 @@
 module JekyllOutlineVersion
-  VERSION = '1.1.0'.freeze
+  VERSION = '1.1.1'.freeze
 end

data/lib/outline_tag.rb

@@ -20,7 +20,7 @@ module OutlineTag
     end
 
     def to_s
-      "  <h3 class='post_title clear' id=\"title_#{order}\">#{title}</h3>"
+      "  <h3 class='post_title clear' id=\"title_#{@order}\">#{@title}</h3>"
     end
   end
 
@@ -30,15 +30,18 @@ module OutlineTag
     FIXNUM_MAX = (2**((0.size * 8) - 2)) - 1
 
     def render_impl(text)
-      @collection_name = argument_string.strip
+      headers = make_headers(super) # Process the block content.
+
+      @helper.gem_file __FILE__
+      @collection_name = @helper.remaining_markup
       abort 'OutlineTag: collection_name was not specified' unless @collection_name
 
-      headers = make_headers(super) # Process the block content.
       collection = headers + obtain_docs(@collection_name)
       <<~HEREDOC
         <div class="outer_posts">
-        #{make_entries(collection).join("\n")}
+        #{make_entries(collection)&.join("\n")}
         </div>
+        #{@helper.attribute if @helper.attribution}
       HEREDOC
     end
 
@@ -56,7 +59,7 @@ module OutlineTag
     # @section_state can have values: :head, :in_body
     # @param collection Array of Jekyll::Document and Outline::Header
     # @return Array of String
-    def make_entries(collection) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Layout/LineEndStringConcatenationIndentation
+    def make_entries(collection) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       sorted = collection.sort_by(&obtain_order)
       pruned = remove_empty_headers(sorted)
       @section_state = :head

data/spec/status_persistence.txt

@@ -0,0 +1,3 @@
+example_id                         | status | run_time        |
+---------------------------------- | ------ | --------------- |
+./spec/jekyll_outline_spec.rb[1:1] | passed | 0.00023 seconds |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_outline
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-15 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.0
 description: 'Jekyll tag plugin that creates a clickable table of contents.
 
   '
@@ -74,14 +74,15 @@ files:
 - lib/outline_tag.rb
 - spec/outline_spec.rb
 - spec/spec_helper.rb
-homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#outline
+- spec/status_persistence.txt
+homepage: https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#outline
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/mslinn/jekyll_outline/issues
   changelog_uri: https://github.com/mslinn/jekyll_outline/CHANGELOG.md
-  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#outline
+  homepage_uri: https://www.mslinn.com/jekyll/3000-jekyll-plugins.html#outline
   source_code_uri: https://github.com/mslinn/jekyll_outline
 post_install_message: |2+
 
@@ -108,4 +109,5 @@ summary: Jekyll tag plugin that creates a clickable table of contents.
 test_files:
 - spec/outline_spec.rb
 - spec/spec_helper.rb
+- spec/status_persistence.txt
 ...