jekyll_all_collections 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7f7fa2e1b1ca3dc3ee52ef85f6b1f55db8710bca3fed39386469d686bd6341f
-  data.tar.gz: 3827c3d5b908b972fb2d4efb3b6c0f703d84fbd710d5887485f1f6e0810718f9
+  metadata.gz: 48527cdeb305237310b14a6748a3a95aab2fea5a837a650d277a8d9c93daed97
+  data.tar.gz: 98b3eebd250c4d16e2141b9aaac2c211a54ff9478eafe4a5cbb68f7de905cc6a
 SHA512:
-  metadata.gz: fed15d67819f65a6711f9b4a3550fd4d309184f06e774cffe4ba9e9a4673f04e422e785a62c17c4151f12e1e98685f8317bec2e02542cfebac87ec94c9557a0c
-  data.tar.gz: 750f6e7f00532dc66bd992269c6cc0651deaebf2e10b385883c29010e4032a52ea7a925de12d55ecc064cdc2c604c919d6eb1a0807a641a31e7055f99a588048
+  metadata.gz: 0ebd2507129ca1d62ca6fba8bbeb3bce545c100093ed1bab1390f03c5d495b7dd51fcb0780e8438253fcbf87a74cb57f54034b526fe54d290338f3b732b325c1
+  data.tar.gz: 30b284bb7cb19a4ef0cb246c052e2818086343fc722e4713065c4b9f5cb9a0fd0d807d0df1d7a5e16cb0cf08993ed56ddad3bd006f93175393b27d81305740a9

data/.rubocop.yml

@@ -7,11 +7,11 @@ require:
 
 AllCops:
   Exclude:
-    - exe/**/*
+    - binstub/**/*
+    - demo/_site/*
     - vendor/**/*
     - Gemfile*
   NewCops: enable
-  TargetRubyVersion: 2.6
 
 Gemspec/DeprecatedAttributeAssignment:
   Enabled: false
@@ -19,6 +19,9 @@ Gemspec/DeprecatedAttributeAssignment:
 Gemspec/RequireMFA:
   Enabled: false
 
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
 Layout/HashAlignment:
   EnforcedColonStyle: table
   EnforcedHashRocketStyle: table

data/CHANGELOG.md

@@ -1,29 +1,51 @@
+# Changelog
+
+## 0.3.4 / 2023-12-24
+
+* Changed dependency to Jekyll >= 4.3.2
+
+
 ## 0.3.3 / 2023-05-22
-  * Corrected key presence checks in APage.initialize
-  * Using `warn_short_trace` from `jekyll_plugin_support` for non-fatal errors.
+
+* Corrected key presence checks in APage.initialize
+* Using `warn_short_trace` from `jekyll_plugin_support` for non-fatal errors.
+
 
 ## 0.3.2 / 2023-04-05
-  * Modified dependency `'jekyll_plugin_support', '>= 0.5.0'`
+
+* Modified dependency `'jekyll_plugin_support', '>= 0.5.0'`
+
 
 ## 0.3.1 / 2023-03-16
-  * Reduced the verbosity of the `@logger` message
+
+* Reduced the verbosity of the `@logger` message
 
 ## 0.3.0 / 2023-02-16
-  * Updated dependency `'jekyll_plugin_support', '~> 0.5.0'`
+
+* Updated dependency `'jekyll_plugin_support', '~> 0.5.0'`
 
 ## 0.2.2 / 2023-02-12
-  * Updated dependency `'jekyll_plugin_support', '~> 0.4.0'`
+
+* Updated dependency `'jekyll_plugin_support', '~> 0.4.0'`
+
 
 ## 0.2.1 / 2023-02-12
-  * Reduced the verbosity of log output from `info` to `debug`
+
+* Reduced the verbosity of log output from `info` to `debug`
+
 
 ## 0.2.0 / 2023-02-04
-  * Returns Array[APage] instead of a collection of different types of objects.
-  * Converted the plugin to a `:site, :post_read` hook instead of a tag,
+
+* Returns Array[APage] instead of a collection of different types of objects.
+* Converted the plugin to a `:site, :post_read` hook instead of a tag,
     so explicit initialization is no longer required.
 
+
 ## 0.1.1 / 2022-04-27
-  * Changed invocation from a `:site` hook to an idempotent method invocation.
+
+* Changed invocation from a `:site` hook to an idempotent method invocation.
+
 
 ## 0.1.0 / 2022-04-26
-  * Initial version published
+
+* Initial version published

data/README.md

@@ -1,6 +1,5 @@
-`jekyll_all_collections`
-[![Gem Version](https://badge.fury.io/rb/jekyll_all_collections.svg)](https://badge.fury.io/rb/jekyll_all_collections)
-===========
+# `jekyll_all_collections` [![Gem Version](https://badge.fury.io/rb/jekyll_all_collections.svg)](https://badge.fury.io/rb/jekyll_all_collections)
+
 
 `Jekyll_all_collections` is a Jekyll plugin that adds a new property called `all_collections` to `site`.
 It also provides a new Jekyll tag called `all_collections`,
@@ -16,6 +15,7 @@ Pages that are not in any collection are not included.
 
 
 ## Installation
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -26,42 +26,56 @@ end
 
 And then execute:
 
-    $ bundle
+```shell
+$ bundle
+```
 
 
 ## Requirements
-All the pages in the Jekyll website must have an implicit date (for example, all posts are assigned this property by Jekyll),
+
+All the pages in the Jekyll website must have an implicit date
+(for example, all posts are assigned this property by Jekyll),
 or an explicit `date` set in front matter, like this:
-   ```
-   ---
-   date: 2022-01-01
-   ---
-   ```
-If a front matter variable called `last_modified` or `last_modified_at` exists, its value will be converted to a Ruby `Date`:
-   ```
-   ---
-   last_modified: 2023-01-01
-   ---
-   ```
-
-   Or:
-   ```
-   ---
-   last_modified_at: 2023-01-01
-   ---
-   ```
-
-Otherwise, if `last_modified` or `last_modified_at` is not present in the front matter for a page, the `date` value will be used last modified date value.
+
+```html
+---
+date: 2022-01-01
+---
+```
+
+If a front matter variable called `last_modified` or `last_modified_at` exists,
+its value will be converted to a Ruby `Date`:
+
+```html
+---
+last_modified: 2023-01-01
+---
+```
+
+Or:
+
+```html
+---
+last_modified_at: 2023-01-01
+---
+```
+
+Otherwise, if `last_modified` or `last_modified_at` is not present in the front matter for a page,
+the `date` value will be used last modified date value.
+
 
 ## Usage
 
 ### `Site.all_collections`
+
 No explicit initialization or setup is required.
 Jekyll plugins can access the value of `site.all_collections`, however Liquid code in Jekyll pages and documents cannot.
 
 
 ### `All_collections` Tag
+
 Add the following CSS to your stylesheet:
+
 ```css
 .posts {
   display: flex;
@@ -82,17 +96,24 @@ Add the following CSS to your stylesheet:
 }
 ```
 
+
 #### Excluding Pages
-Adding the following entry to a page's front matter `` causes that page to be excluded from the collection created by this plugin:
-```
+
+Adding the following entry to a page’s front matter causes that page to be excluded
+from the collection created by this plugin:
+
+```html
 ---
 exclude_from_all: true
 ---
 ```
 
+
 #### General Form
+
 The general form of the Jekyll tag is:
-```
+
+```html
 {% all_collections
   date_column='date|last_modified'
   heading='All Posts'
@@ -101,7 +122,9 @@ The general form of the Jekyll tag is:
 %}
 ```
 
+
 #### `date_column` Attribute
+
 One of two date columns can be displayed in the generated HTML:
 either `date` (when the article was originally written),
 or `last_modified`.
@@ -109,48 +132,59 @@ The default value for the `date_column` attribute is `date`.
 
 
 #### `heading` Attribute
-If no `heading` attribute is specified, a heading will automatically be generated, which contains the `sort_by` values, for example:
-```
+
+If no `heading` attribute is specified, a heading will automatically be generated, which contains the `sort_by` values,
+for example:
+
+```html
 {% all_collections id='abcdef' sort_by="last_modified" %}
 ```
+
 Generates a heading like:
-```
+
+```html
 <h2 id="abcdef">All Posts Sorted By last_modified</h2>
 ```
 
 To suppress both a `h2` heading (and the enclosed `id`) from being generated,
 specify an empty string for the value of `heading`:
-```
+
+```html
 {% all_collections heading='' %}
 ```
 
 
 #### `id` Attribute
+
 If your Jekyll layout employs [`jekyll-toc`](https://github.com/allejo/jekyll-toc), then `id` attributes are important.
-The `jekyll-toc` include checks for `id` attributes in `h2` ... `h6` tags, and if found, and if the attribute value is enclosed in double quotes (`id="my_id"`, not `id='my_id'`),
+The `jekyll-toc` include checks for `id` attributes in `h2` ... `h6` tags, and if found,
+and if the attribute value is enclosed in double quotes (`id="my_id"`, not `id='my_id'`),
 then the heading is included in the table of contents.
 
 To suppress an `id` from being generated,
 and thereby preventing the heading from appearing in the automatically generated table of contents from `jekyll-toc`,
 specify an empty string for the value of `id`, like this:
-```
+
+```html
 {% all_collections id='' %}
 ```
 
 
 #### `SORT_KEYS` Values
+
 `SORT_KEYS` specifies how to sort the collection.
 Values can include one or more of the following attributes:
-`date`, `destination`, `draft`, `label`, `last_modified`, `last_modified_at`, `path`, `relative_path`, `title`, `type`, and `url`.
+`date`, `destination`, `draft`, `label`, `last_modified`, `last_modified_at`, `path`, `relative_path`,
+`title`, `type`, and `url`.
 Ascending sorts are the default, however a descending sort can be achieved by prepending `-` before an attribute.
 
 To specify more than one sort key, provide a comma-delimited string of values.
 Included spaces are ignored.
-For example, specify the primary sort key as <code>draft</code>,
-the secondary sort key as <code>last_modified</code>,
-and the tertiary key as <code>label</code>:
+For example, specify the primary sort key as `draft`,
+the secondary sort key as `last_modified`,
+and the tertiary key as `label`:
 
-```
+```html
 {% all_collections
   date_column='last_modified'
   heading='All Posts'
@@ -161,9 +195,11 @@ and the tertiary key as <code>label</code>:
 
 
 #### Usage Examples
+
 Here is a short Jekyll page, including front matter,
 demonstrating this plugin being invoked with all default attribute values:
-```
+
+```html
 ---
 description: "
   Dump of all collections, sorted by date originally written, newest to oldest.
@@ -177,51 +213,62 @@ title: Testing, 1, 2, 3
 
 Explicitly express the default sort
 (sort by the date originally written, newest to oldest):
-```
+
+```html
 {% all_collections sort_by="-date" %}
 ```
 
 Sort by date, from oldest to newest:
-```
+
+```html
 {% all_collections sort_by="date" %}
 ```
 
 Sort by the date last modified, oldest to newest:
-```
+
+```html
 {% all_collections sort_by="last_modified" %}
 ```
 
 Sort by the date last modified, newest to oldest:
-```
+
+```html
 {% all_collections sort_by="-last_modified" %}
 ```
 
 Several attributes can be specified as sort criteria by passing them as a comma-delimited string.
 Included spaces are ignored:
-```
+
+```html
 {% all_collections sort_by="-last_modified, -date" %}
 {% all_collections sort_by="-last_modified, title" %}
 {% all_collections sort_by="-last_modified, -date, title" %}
 ```
 
 The following two examples produce the same output:
-```
+
+```html
 {% all_collections sort_by="-last_modified,-date" %}
 {% all_collections sort_by="-last_modified, -date" %}
 ```
 
 
 ## Demo
+
 The [`demo`](./demo) directory contains a demonstration website, which uses the plugin.
 To run, type:
+
 ```console
 $ demo/_bin/debug -r
 ```
+
 Now point your web browser to http://localhost:4444
 
 
 ## Debugging
+
 You can control the verbosity of log output by adding the following to `_config.yml` in your Jekyll project:
+
 ```yaml
 plugin_loggers:
   AllCollectionsTag::AllCollectionsTag: warn
@@ -231,7 +278,8 @@ plugin_loggers:
 1. You have two options for initiating a debug session:
 
    1. Run `demo/_bin/debug`, without the `-r` options shown above.
-      ```
+
+      ```console
       ... lots of output as bundle update runs...
       Bundle updated!
 
@@ -248,6 +296,7 @@ plugin_loggers:
 
    2. Run `bin/attach` and pass the directory name of a Jekyll website that has a suitable script called `_bin/debug`.
       The `demo` subdirectory fits this description.
+
       ```console
       $ bin/attach demo
       Successfully uninstalled jekyll_all_collections-0.1.2
@@ -265,6 +314,7 @@ plugin_loggers:
 
 
 ## Additional Information
+
 More information is available on Mike Slinn's website about
 [Jekyll plugins](https://www.mslinn.com/blog/index.html#Jekyll).
 
@@ -277,12 +327,9 @@ You can also run `bin/console` for an interactive prompt that will allow you to
 
 
 ### Build and Install Locally
+
 To build and install this gem onto your local machine, run:
-```shell
-$ rake install
-```
 
-The following also does the same thing:
 ```shell
 $ bundle exec rake install
 jekyll_all_collections 0.1.0 built to pkg/jekyll_all_collections-0.1.0.gem.
@@ -290,6 +337,7 @@ jekyll_all_collections (0.1.0) installed.
 ```
 
 Examine the newly built gem:
+
 ```shell
 $ gem info jekyll_all_collections
 
@@ -306,15 +354,19 @@ jekyll_all_collections (0.1.0)
 
 
 ### Build and Push to RubyGems
+
 To release a new version,
-  1. Update the version number in `version.rb`.
-  2. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
-  3. Run the following:
-     ```shell
-     $ bundle exec rake release
-     ```
-     The above creates a git tag for the version, commits the created tag,
-     and pushes the new `.gem` file to [RubyGems.org](https://rubygems.org).
+
+1. Update the version number in `version.rb`.
+2. Commit all changes to git; if you don't the next step might fail with an unexplainable error message.
+3. Run the following:
+
+    ```shell
+    $ bundle exec rake release
+    ```
+
+    The above creates a git tag for the version, commits the created tag,
+    and pushes the new `.gem` file to [RubyGems.org](https://rubygems.org).
 
 
 ## Contributing

data/Rakefile

@@ -1,5 +1,5 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 task default: :spec

data/jekyll_all_collections.gemspec

@@ -4,11 +4,11 @@ Gem::Specification.new do |spec|
   github = 'https://github.com/mslinn/jekyll_all_collections'
 
   spec.authors = ['Mike Slinn']
-  spec.bindir = 'bin'
+  spec.bindir = 'exe'
   spec.description = <<~END_OF_DESC
     Provides a collection of all collections in site.all_collections.
   END_OF_DESC
-  spec.email = ['email@email.com']
+  spec.email = ['mslinn@mslinn.com']
   spec.executables = []
 
   # Specify which files should be added to the gem when it is released.
@@ -30,6 +30,6 @@ Gem::Specification.new do |spec|
   spec.version = JekyllAllCollectionsVersion::VERSION
 
   spec.add_dependency 'jekyll', '>= 3.5.0'
-  spec.add_dependency 'jekyll_draft', '~> 1.1.1'
+  spec.add_dependency 'jekyll_draft', '>= 1.1.1'
   spec.add_dependency 'jekyll_plugin_support', '>= 0.7.0'
 end

data/lib/all_collections_hooks.rb

@@ -77,7 +77,10 @@ module AllCollectionsHooks
       @content = obj.content if obj.respond_to? :content
       @date = (@data['date'].to_date if @data&.key?('date')) || Date.today
       @description = @data['description'] if @data.key? 'description'
-      @destination = obj.destination('') if obj.respond_to? :destination # TODO: What _config.yml setting should be passed to destination()?
+
+      # TODO: What _config.yml setting should be passed to destination()?
+      @destination = obj.destination('') if obj.respond_to? :destination
+
       @draft = Jekyll::Draft.draft?(obj)
       @excerpt = @data['excerpt'] if @data.key? 'excerpt'
       @ext = @data['ext'] if @data.key? 'ext'

data/lib/all_collections_tag.rb

@@ -8,8 +8,7 @@ class NullBinding < BasicObject
   def min_binding
     ::Kernel
       .instance_method(:binding)
-      .bind(self)
-      .call
+      .bind_call(self)
   end
 end
 
@@ -36,7 +35,7 @@ module AllCollectionsTag
       end
       @id = @helper.parameter_specified?('id') || SecureRandom.hex(10)
       sort_by_param = @helper.parameter_specified? 'sort_by'
-      sort_by = (sort_by_param&.gsub(' ', '')&.split(',') if sort_by_param != false) || ['-date']
+      sort_by = (sort_by_param&.delete(' ')&.split(',') if sort_by_param != false) || ['-date']
       @heading = @helper.parameter_specified?('heading') || self.class.default_head(sort_by)
       sort_lambda_string = self.class.create_lambda_string(sort_by)
       @logger.debug do
@@ -98,7 +97,11 @@ module AllCollectionsTag
     private
 
     def last_modified_value(post)
-      @logger.debug { "  post.last_modified='#{post.last_modified}'; post.last_modified_at='#{post.last_modified_at}'; @date_column='#{@date_column}'" }
+      @logger.debug do
+        "  post.last_modified='#{post.last_modified}'; " \
+          "post.last_modified_at='#{post.last_modified_at}'; " \
+          "@date_column='#{@date_column}'"
+      end
       last_modified = if @date_column == 'last_modified' && post.respond_to?(:last_modified)
                         post.last_modified
                       elsif post.respond_to? :last_modified_at

data/lib/jekyll_all_collections/version.rb

@@ -1,3 +1,3 @@
 module JekyllAllCollectionsVersion
-  VERSION = '0.3.3'.freeze
+  VERSION = '0.3.4'.freeze
 end

data/lib/jekyll_all_collections.rb

@@ -1,5 +1,5 @@
-require_relative './all_collections_hooks'
-require_relative './all_collections_tag'
+require_relative 'all_collections_hooks'
+require_relative 'all_collections_tag'
 
 module JekyllAllCollections
   include AllCollectionsHooks

data/spec/spec_helper.rb

@@ -6,9 +6,8 @@ require_relative '../lib/jekyll_all_collections'
 Jekyll.logger.log_level = :info
 
 RSpec.configure do |config|
-  config.filter_run :focus
   # config.order = 'random'
-  config.run_all_when_everything_filtered = true
+  config.filter_run_when_matching focus: true
 
   # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
   config.example_status_persistence_file_path = 'spec/status_persistence.txt'

data/spec/status_persistence.txt

@@ -0,0 +1,23 @@
+example_id                       | status | run_time        |
+-------------------------------- | ------ | --------------- |
+./spec/date_sort_spec.rb[1:1]    | passed | 0.00111 seconds |
+./spec/date_sort_spec.rb[1:2]    | passed | 0.00019 seconds |
+./spec/date_sort_spec.rb[1:3]    | passed | 0.00014 seconds |
+./spec/date_sort_spec.rb[1:4]    | passed | 0.00016 seconds |
+./spec/date_sort_spec.rb[1:5]    | passed | 0.00016 seconds |
+./spec/date_sort_spec.rb[1:6]    | passed | 0.00015 seconds |
+./spec/date_sort_spec.rb[1:7]    | passed | 0.00014 seconds |
+./spec/date_sort_spec.rb[1:8]    | passed | 0.00014 seconds |
+./spec/date_sort_spec.rb[1:9]    | passed | 0.00016 seconds |
+./spec/date_sort_spec.rb[1:10]   | passed | 0.00015 seconds |
+./spec/lambda_sort_spec.rb[1:1]  | passed | 0.00017 seconds |
+./spec/lambda_sort_spec.rb[1:2]  | passed | 0.00022 seconds |
+./spec/lambda_sort_spec.rb[1:3]  | passed | 0.00029 seconds |
+./spec/lambda_sort_spec.rb[1:4]  | passed | 0.0002 seconds  |
+./spec/lambda_sort_spec.rb[1:5]  | passed | 0.00018 seconds |
+./spec/lambda_sort_spec.rb[1:6]  | passed | 0.0002 seconds  |
+./spec/lambda_sort_spec.rb[1:7]  | passed | 0.00019 seconds |
+./spec/lambda_sort_spec.rb[1:8]  | passed | 0.00019 seconds |
+./spec/lambda_sort_spec.rb[1:9]  | passed | 0.00019 seconds |
+./spec/lambda_sort_spec.rb[1:10] | passed | 0.00019 seconds |
+./spec/lambda_sort_spec.rb[1:11] | passed | 0.00036 seconds |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_all_collections
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Mike Slinn
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-07-06 00:00:00.000000000 Z
+date: 2023-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -28,14 +28,14 @@ dependencies:
   name: jekyll_draft
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.1
 - !ruby/object:Gem::Dependency
@@ -56,7 +56,7 @@ description: 'Provides a collection of all collections in site.all_collections.
 
   '
 email:
-- email@email.com
+- mslinn@mslinn.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -71,9 +71,10 @@ files:
 - lib/all_collections_tag.rb
 - lib/jekyll_all_collections.rb
 - lib/jekyll_all_collections/version.rb
-- spec/all_collections_tag_sort_spec.rb
+- spec/all_collections_tag/all_collections_tag_sort_spec.rb
 - spec/date_sort_spec.rb
 - spec/spec_helper.rb
+- spec/status_persistence.txt
 homepage: https://www.mslinn.com/jekyll_plugins/jekyll_all_collections.html
 licenses:
 - MIT