jekyll_all_collections 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e34cd7f0b53f1aaed58a4ca679749c7f994d39674e5d28b93670de7eb1dfdc18
+  data.tar.gz: 165017e7f22556651106c18526155b5ac36efbc23e18d1c12c9af47b57a9a3b7
+SHA512:
+  metadata.gz: 795682f6119d6ccba25ad2d11e92ddfed6f54bfcdcb9cf95fd48bf9240a44db18af334e79650c0220ce5e40d5790bb98b0c33f78102259a1d43ff2bd232d4483
+  data.tar.gz: 5ed14e1c82ea41769abb3192704db70aa842aac6d171a910b883309fcebe6f1b45324a0a98e4832c7fa4fd9fe751d1fa9baff2976788b42f0cc7ead77167cf8a

data/.rubocop.yml

@@ -0,0 +1,35 @@
+# require: rubocop-jekyll
+# inherit_gem:
+#  rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - Gemfile*
+      - '*.gemspec' # This does nothing. Why?
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+# Gemspec/RequireMFA:
+#   Enabled: false
+
+# Jekyll/NoPutsAllowed:
+#   Enabled: false
+
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/BlockLength:
+  Max: 50
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 0.1.1 / 2022-04-27
+  * Changed invocation from a `:site` hook to an idempotent method invocation.
+
+## 0.1.0 / 2022-04-26
+  * Initial version published

data/LICENSE.txt

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

data/README.md

@@ -0,0 +1,106 @@
+`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 add a new property called `all_collections` to `site`.
+
+
+
+## Debugging
+Run `bin/attach` and pass it the directory name of a Jekyll website that has a suitable script called `_bin/debug`.
+The `demo` subdirectory fits this description.
+```script
+$ bin/attach demo
+Successfully uninstalled jekyll_all_collections-0.1.2
+jekyll_all_collections 0.1.2 built to pkg/jekyll_all_collections-0.1.2.gem.
+jekyll_all_collections (0.1.2) installed.
+Fast Debugger (ruby-debug-ide 0.7.3, debase 0.2.4.1, file filtering is supported) listens on 0.0.0.0:1234
+```
+Now attach to the debugger process.
+This git repo includes a Visual Studio Code launcher for this purpose labeled `Attach rdebug-ide`.
+
+
+## Additional Information
+More information is available on Mike Slinn's web site about
+[Jekyll plugins](https://www.mslinn.com/blog/index.html#Jekyll).
+
+
+## Installation
+This has already been done for the demo; these instructions are for incorporating the plugin(s) into other Jekyll websites.
+Add this line to your application's Gemfile:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_all_collections'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_all_collections
+
+
+## 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.
+
+
+### Build and Install Locally
+To build and install this gem onto your local machine, run:
+```shell
+$ rake install:local
+```
+
+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.
+jekyll_all_collections (0.1.0) installed.
+```
+
+Examine the newly built gem:
+```shell
+$ gem info jekyll_all_collections
+
+*** LOCAL GEMS ***
+
+jekyll_all_collections (0.1.0)
+    Author: Firstname Lastname
+    Homepage:
+    https://github.com/username/jekyll_all_collections
+    License: MIT
+    Installed at: /home/mslinn/.gems
+
+    Write a short summary; RubyGems requires one.
+```
+
+
+### 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).
+
+
+## Contributing
+
+1. Fork the project
+2. Create a descriptively named feature branch
+3. Add your feature
+4. Submit a pull request
+
+
+## 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,7 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/jekyll_all_collections.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll_all_collections/version"
+
+Gem::Specification.new do |spec|
+  github = "https://github.com/mslinn/jekyll_all_collections"
+
+  spec.authors = ["Mike Slinn"]
+  spec.bindir = "bin"
+  spec.description = <<~END_OF_DESC
+    Provides a collection of all collections in site.all_collections.
+  END_OF_DESC
+  spec.email = ["email@email.com"]
+  spec.executables = []
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = Dir[".rubocop.yml", "LICENSE.*", "Rakefile", "{lib,spec}/**/*", "*.gemspec", "*.md"]
+
+  spec.homepage = "https://www.mslinn.com/blog/2020/12/30/jekyll-plugin-template-collection.html"
+  spec.license = "MIT"
+  spec.metadata = {
+    "allowed_push_host" => "https://rubygems.org",
+    "bug_tracker_uri"   => "#{github}/issues",
+    "changelog_uri"     => "#{github}/CHANGELOG.md",
+    "homepage_uri"      => spec.homepage,
+    "source_code_uri"   => github,
+  }
+  spec.name = "jekyll_all_collections"
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary = "Provides a collection of all collections in site.all_collections."
+  spec.version = JekyllAllCollectionsVersion::VERSION
+
+  spec.add_dependency "jekyll", ">= 3.5.0"
+  spec.add_dependency "jekyll_plugin_logger"
+
+  spec.add_development_dependency "debase"
+  spec.add_development_dependency "ruby-debug-ide"
+end

data/lib/jekyll_all_collections/version.rb

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

data/lib/jekyll_all_collections.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "jekyll_plugin_logger"
+require_relative "jekyll_all_collections/version"
+
+# Creates a property called site.all_collections if it does not already exist
+module JekyllAllCollections
+  @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+
+  def maybe_compute_all_collections(site)
+    @logger.debug { "JekyllAllCollections.maybe_compute_all_collections invoked" }
+    return if site.class.method_defined? :all_collections
+
+    @logger.debug { "JekyllAllCollections.maybe_compute_all_collections creating site.all_collections" }
+
+    site.class.module_eval { attr_accessor :all_collections }
+    site.all_collections =
+      site.collections
+          .values
+          .map { |x| x.class.method_defined?(:docs) ? x.docs : x }
+          .flatten
+  end
+
+  module_function :maybe_compute_all_collections
+
+  PluginMetaLogger.instance.logger.info { "Loaded JekyllAllCollections v#{JekyllAllCollectionsVersion::VERSION} plugin." }
+end

data/spec/jekyll_all_collections_spec.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require_relative "../lib/jekyll_all_collections"
+
+RSpec.describe(JekyllAllCollections) do
+  it "does nothing" do
+    # expect(remainder_of_line).to eq("remainder of line")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "jekyll"
+require "fileutils"
+require "key_value_parser"
+require "shellwords"
+
+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
+
+  # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
+  config.example_status_persistence_file_path = "spec/status_persistence.txt"
+end

data/spec/status_persistence.txt

@@ -0,0 +1,5 @@
+example_id                                 | status | run_time        |
+------------------------------------------ | ------ | --------------- |
+./spec/jekyll_all_collections_spec.rb[1:1] | passed | 0.02165 seconds |
+./spec/run_this_first_spec.rb[1:1]         | failed | 0.00134 seconds |
+./spec/run_this_first_spec.rb[1:2]         | failed | 2.84 seconds    |

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_all_collections
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mike Slinn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-04-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: jekyll_plugin_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debase
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-debug-ide
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'Provides a collection of all collections in site.all_collections.
+
+'
+email:
+- email@email.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_all_collections.gemspec
+- lib/jekyll_all_collections.rb
+- lib/jekyll_all_collections/version.rb
+- spec/jekyll_all_collections_spec.rb
+- spec/spec_helper.rb
+- spec/status_persistence.txt
+homepage: https://www.mslinn.com/blog/2020/12/30/jekyll-plugin-template-collection.html
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_all_collections/issues
+  changelog_uri: https://github.com/mslinn/jekyll_all_collections/CHANGELOG.md
+  homepage_uri: https://www.mslinn.com/blog/2020/12/30/jekyll-plugin-template-collection.html
+  source_code_uri: https://github.com/mslinn/jekyll_all_collections
+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.1.4
+signing_key: 
+specification_version: 4
+summary: Provides a collection of all collections in site.all_collections.
+test_files: []