jekyll_archive_display 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 37451a8e360f75ae492f4963417d64a1ea18119ec7102f2c14e37852444c2b30
+  data.tar.gz: e9014b204916062edc00fcd57e60d835f73e9770108ceca09437ce94ac9ed2c9
+SHA512:
+  metadata.gz: ed9d3c414acf0d055a2a583f4bcc8018425b680115c35398f63990c78f1013675fe708a53cbfe6906c4ca3be3bcb85a23f4fa3ec7798c99357b722d7efb8754b
+  data.tar.gz: f0cf471adf5afc40c04706c5182d1a1f4b0737a7f15b82e84f45e3a717f7eaad4fe8a45226722af1ae591a702bc6d624ab32d52545e194dc9a0e4524ba695856

data/.rubocop.yml

@@ -0,0 +1,23 @@
+require: rubocop-jekyll
+inherit_gem:
+ rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - Gemfile*
+      - '*.gemspec' # This does nothing. Why?
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/BlockAlignment:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 150
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+# Gemspec/RequireMFA:
+#   Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 1.0.0 / 2022-03-18
+  * Published as a gem
+
+## 2020-10-03
+  * Initial version published at https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Mike Slinn
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+`jekyll_archive_display`
+[![Gem Version](https://badge.fury.io/rb/jekyll_archive_display.svg)](https://badge.fury.io/rb/jekyll_archive_display)
+===========
+
+`jekyll_archive_display` is a Jekyll plugin, packaged as a Ruby gem, that lists the names and contents of each entry in a `tar` file.
+
+The following HTML is emitted for each text file within the `tar`:
+```HTML
+<div class='codeLabel'>{tar_entry.full_name}</div>
+<pre data-lt-active='false'>{file_contents}</pre>
+```
+
+
+Binary files are displayed like this:
+
+**`usr/bin/ruby2.7 (application/x-sharedlib; charset=binary)`**<br>
+*Binary file*
+
+
+## Syntax
+```
+{% archive_display filename.tar %}
+```
+
+## Additional Information
+More information is available on Mike Slinn's web site about
+[Jekyll plugins](https://www.mslinn.com/blog/index.html#Jekyll).
+
+
+## Installation
+
+### Install dependencies:
+ - Ubuntu:
+   ```shell
+   sudo apt install libmagic-dev
+   ```
+ - Mac:
+   ```shell
+   brew install libmagic
+   ```
+
+### Gems
+Add this line to your Jekyll website's `_config.yml`:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_archive_display'
+end
+```
+
+Also add it to `_config.yml`:
+```yaml
+plugins:
+  - jekyll_archive_display
+```
+
+Install all of the dependent gems of your Jekyll website by typing:
+
+    $ bundle install
+
+Or install just this one gem by typing:
+
+    $ gem install jekyll_archive_display
+
+
+## Additional Information
+More information is available on
+[Mike Slinn&rsquo;s website](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
+
+
+## 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_archive_display 1.0.0 built to pkg/jekyll_archive_display-0.1.0.gem.
+jekyll_archive_display (1.0.0) installed.
+```
+
+Examine the newly built gem:
+```shell
+$ gem info jekyll_archive_display
+
+*** LOCAL GEMS ***
+
+jekyll_archive_display (1.0.0)
+    Author: Mike Slinn
+    Homepage:
+    https://github.com/mslinn/jekyll_archive_display
+    License: MIT
+    Installed at: /home/mslinn/.gems
+
+    Jekyll tag plugin that lists the names and contents of each entry in a tar file.
+```
+
+### 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,10 @@
+# frozen_string_literal: true
+
+# require "bundler/gem_tasks"
+# require "rspec/core/rake_task"
+
+# RSpec::Core::RakeTask.new(:spec)
+# task :default => :spec
+
+require "bundler/gem_tasks"
+task :default => %i[]

data/jekyll_archive_display.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "lib/archive_display/version"
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  github = "https://github.com/mslinn/jekyll_archive_display"
+
+  spec.authors = ["Mike Slinn"]
+  spec.bindir = "exe"
+  spec.description = <<~END_OF_DESC
+    Jekyll tag plugin that lists the names and contents of each entry in a tar file.
+  END_OF_DESC
+  spec.email = ["mslinn@mslinn.com"]
+  spec.files = Dir[".rubocop.yml", "LICENSE.*", "Rakefile", "{lib,spec}/**/*", "*.gemspec", "*.md"]
+  spec.homepage = "https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#archiveDisplay"
+  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_archive_display"
+  spec.post_install_message = <<~END_MESSAGE
+
+    Thanks for installing #{spec.name}!
+
+  END_MESSAGE
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = ">= 2.6.0"
+  spec.summary = "Jekyll tag plugin that lists the names and contents of each entry in a tar file."
+  spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
+  spec.version = JekyllArchiveDisplay::VERSION
+
+  spec.add_dependency "jekyll", ">= 3.5.0"
+  spec.add_dependency "jekyll_plugin_logger"
+  spec.add_dependency "ruby-filemagic", "= 0.7.3"
+  spec.add_dependency "rubyzip"
+
+  spec.add_development_dependency "debase"
+  # spec.add_development_dependency "rubocop-jekyll"
+  # spec.add_development_dependency "rubocop-rake"
+  # spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "ruby-debug-ide"
+end
+# rubocop:enable Metrics/BlockLength

data/lib/archive_display/version.rb

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

data/lib/archive_display.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "jekyll_plugin_logger"
+require "rubygems/package"
+require "ruby-filemagic"
+require_relative "archive_display/version"
+
+module JekyllPluginArchiveDisplayName
+  PLUGIN_NAME = "archive_display"
+end
+
+# Jekyll tag plugin that displays information about the contents of tar files
+module Jekyll
+  # Executes a program and returns the output from STDOUT.
+  class ArchiveDisplayTag < Liquid::Tag
+    # @param tag_name [String] is the name of the tag, which we already know.
+    # @param command_line [Hash, String, Liquid::Tag::Parser] the arguments from the web page.
+    # @param tokens [Liquid::ParseContext] tokenized command line
+    # @return [void]
+    def initialize(tag_name, archive_name, tokens)
+      super(tag_name, archive_name, tokens)
+      @logger = PluginMetaLogger.instance.new_logger(self)
+      @archive_name = archive_name.strip
+    end
+
+    # Method prescribed by the Jekyll plugin lifecycle.
+    # @return [String]
+    def render(context)
+      source = context.registers[:site].config["source"]
+      tar_name = "#{source}/#{@archive_name}"
+      @logger.debug "tar_name=#{tar_name}"
+      traverse_tar(tar_name)
+    end
+
+    private
+
+    def display_entry(entry)
+      heading = "<div class='codeLabel'>#{entry[:name]} <span style='font-size: smaller'>(#{entry[:fm_type]})</span></div>"
+      if entry[:is_text]
+        "#{heading}\n<pre data-lt-active='false'>#{entry[:content]}</pre>"
+      else
+        "#{heading}\n<p><i>Binary file</i></pre>"
+      end
+    end
+
+    # Process one tar entry
+    def tar_entry(entry, file_magic)
+      content = entry.read
+      fm_type = file_magic.buffer(content)
+      {
+        :name    => entry.full_name,
+        :content => content.strip,
+        :is_text => (fm_type.start_with? "text"),
+        :fm_type => fm_type,
+      }
+    end
+
+    # Walk through a `tar` file.
+    #
+    # Modified from this {https://gist.github.com/sinisterchipmunk/1335041/5be4e6039d899c9b8cca41869dc6861c8eb71f13 gist by sinisterchipmunk }.
+    # See https://docs.ruby-lang.org/en/2.6.0/Gem/Package/TarReader.html
+    #
+    # @param tar_name [String] Name of tar file to examine.
+    # @return [String] containing HTML describing the contents of the `tar`.
+    def traverse_tar(tar_name)
+      file_magic = FileMagic.new(FileMagic::MAGIC_MIME)
+      result = ""
+      File.open(tar_name, "rb") do |file|
+        Gem::Package::TarReader.new(file) do |tar|
+          contents = tar.each.map do |entry|
+            next unless entry.file?
+
+            tar_entry(entry, file_magic)
+          end
+          result = contents
+                   .compact
+                   .sort_by { |entry| entry[:name] }
+                   .map { |entry| display_entry entry }
+                   .join("\n")
+        end
+      end
+      @logger.debug { "traverse_tar: result = #{result}" }
+      result
+    end
+  end
+end
+
+PluginMetaLogger.instance.info { "Loaded #{JekyllPluginArchiveDisplayName::PLUGIN_NAME} v#{JekyllArchiveDisplay::VERSION} plugin." }
+Liquid::Template.register_tag(JekyllPluginArchiveDisplayName::PLUGIN_NAME, Jekyll::ArchiveDisplayTag)

data/spec/archive_display.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "../lib/archive_display"
+
+RSpec.describe Jekyll do
+  include Jekyll
+
+  let(:config) { instance_double("Configuration") }
+  let(:context) {
+    context_ = instance_double("Liquid::Context")
+    context_.config = config
+    context_
+  }
+
+  it "works" do
+    # expect(output).to eq("asdf")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "liquid"
+require "jekyll_plugin_logger"
+
+require_relative "../lib/archive_display"
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.order = "random"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_archive_display
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Mike Slinn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-03-25 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: ruby-filemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.3
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  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: 'Jekyll tag plugin that lists the names and contents of each entry in
+  a tar file.
+
+'
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_archive_display.gemspec
+- lib/archive_display.rb
+- lib/archive_display/version.rb
+- spec/archive_display.rb
+- spec/spec_helper.rb
+homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#archiveDisplay
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_archive_display/issues
+  changelog_uri: https://github.com/mslinn/jekyll_archive_display/CHANGELOG.md
+  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#archiveDisplay
+  source_code_uri: https://github.com/mslinn/jekyll_archive_display
+post_install_message: |2+
+
+  Thanks for installing jekyll_archive_display!
+
+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: Jekyll tag plugin that lists the names and contents of each entry in a tar
+  file.
+test_files:
+- spec/archive_display.rb
+- spec/spec_helper.rb