jekyll_archive_create 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b486efbfa5c71cc654c2615b370ee68033e121ab7a4cdee0a74ce6ad6d00a1ba
+  data.tar.gz: 58f743530dd3c2b6e3a68e06bb0c7e3d2ab831e42d82d060eec9f16ceb7d9827
+SHA512:
+  metadata.gz: cb2334d5cd6ecf52c89fa242f8e521ef2e8214195935a8e3dc41a7cf25d44a5d1fa94885bfc65a2b952d6baf02fc75bd6dfcd7d3fceb0e94dcf13f43c830156b
+  data.tar.gz: c63208486b129490beeabffedbc67ed3b7e5550db9f93286af18c21c786add9fc7290bdcf6953bf8146081ae6a5ede9ba056aef330f2aa081db25f1e97cf6419

data/.rubocop.yml

@@ -0,0 +1,37 @@
+inherit_gem:
+  rubocop-jekyll: .rubocop.yml
+
+AllCops:
+  Exclude:
+      - vendor/**/*
+      - Gemfile*
+  NewCops: enable
+  TargetRubyVersion: 2.6
+
+Layout/LineLength:
+  Max: 150
+
+Metrics/AbcSize:
+  Max: 20
+  Exclude:
+    - "test/**/*"
+
+Metrics/BlockLength:
+  Exclude:
+    - "*.gemspec"
+    - "Rakefile"
+
+Metrics/ClassLength:
+  Max: 50
+  Exclude:
+    - "test/**/*"
+
+Metrics/MethodLength:
+  Exclude:
+    - "test/**/*"
+
+Style/CommandLiteral:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## 1.0.0 / 2022-03-13
+  * Made into a Ruby gem and published on RubyGems.org as [jekyll_archive_create](https://rubygems.org/gems/jekyll_archive_create).
+  * `bin/attach` script added for debugging
+  * Rubocop standards added
+  * Proper versioning and CHANGELOG.md added
+
+## 2020-12-29
+  * Initial version published

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 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,113 @@
+jekyll_archive_create
+[![Gem Version](https://badge.fury.io/rb/jekyll_archive_create.svg)](https://badge.fury.io/rb/jekyll_archive_create)
+===========
+
+This is a Jekyll plugin that makes tar or zip files based on `_config.yml` entries.
+
+In production mode, the archives are built each time Jekyll generates the web site. In development mode, the archives are only built if they do not already exist, or if `delete: true` is set for that archive in `_config.yml`. Archives are placed in the top-level of the Jekyll project, and are copied to `_site` by Jekyll's normal build process. Entries are created in `.gitignore` for each of the generated archives.
+
+## Usage
+This plugin supports 4 types of file specifications:
+
+ * Absolute filenames (start with /).
+ * Filenames relative to the top-level directory of the Jekyll web site (do not preface with . or /).
+ * Filenames relative to the user home directory (preface with ~).
+ * Executable filenames on the PATH (preface with !).
+
+## `_config.yml` Syntax
+Any number of archives can be specified. Each archive has 3 properties: `archive_name`, `delete` (defaults to true) and `files`. Take care that the dashes have exactly 2 spaces before them, and that the 2 lines following each dash have exactly 4 spaces in front.
+
+```
+make_archive:
+  -
+    archive_name: cloud9.zip
+    delete: true  # This is the default, and need not be specified.
+    files: [ index.html, 404.html, ~/.ssh/config, /etc/passwd, '!update' ]
+  -
+    archive_name: cloud9.tar
+    delete: false  # Do not overwrite the archive if it already exists
+    files: [ index.html, 404.html, ~/.ssh/config, /etc/passwd, '!update' ]
+```
+
+
+## Additional Information
+More information is available on my web site about [my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
+
+
+## Installation
+
+Add this line to your Jekyll project's Gemfile, within the `jekyll_plugins` group:
+
+```ruby
+group :jekyll_plugins do
+  gem 'jekyll_archive_create'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll_archive_create
+
+
+## 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
+```
+
+Examine the newly built gem:
+```shell
+$ gem info jekyll_archive_create
+
+*** LOCAL GEMS ***
+
+jekyll_archive_create (1.0.0)
+    Author: Mike Slinn
+    Homepage:
+    https://github.com/mslinn/jekyll_archive_create
+    License: MIT
+    Installed at: /home/mslinn/.gems
+
+    Generates Jekyll logger with colored output.
+```
+
+
+### 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_archive_create.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative "lib/jekyll_archive_create/version"
+
+Gem::Specification.new do |spec|
+  github = "https://github.com/mslinn/jekyll_archive_create"
+
+  spec.authors = ["Mike Slinn"]
+  spec.bindir = "exe"
+  spec.description = <<~END_OF_DESC
+    Jekyll generator for creating tar and zip files.
+  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#make_archive"
+  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_create"
+  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 generator for creating tar and zip files."
+  spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
+  spec.version = JekyllArchiveCreate::VERSION
+
+  spec.add_dependency "jekyll", ">= 3.5.0"
+  spec.add_dependency "jekyll_plugin_logger", "~> 2.0.0"
+
+  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

data/lib/jekyll_archive_create/version.rb

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

data/lib/jekyll_archive_create.rb

@@ -0,0 +1,167 @@
+# frozen_string_literal: true
+
+require "fileutils"
+require "jekyll_plugin_logger"
+require "ptools"
+require "rubygems"
+require "rubygems/package"
+require "tmpdir"
+require "zlib"
+require "zip"
+require_relative "jekyll_archive_create/version"
+
+module Jekyll
+  # Makes tar or zip file based on _config.yml entry
+  class MakeArchive < Jekyll::Generator # rubocop:disable Metrics/ClassLength
+    priority :high
+
+    # Method prescribed by the Jekyll plugin lifecycle.
+    # @param site [Jekyll.Site] Automatically provided by Jekyll plugin mechanism
+    # @return [void]
+    def generate(site)
+      @logger = PluginMetaLogger.instance.new_logger(self)
+      @live_reload = site.config["livereload"]
+
+      archive_config = site.config["make_archive"]
+      return if archive_config.nil?
+
+      archive_config.each do |config|
+        setup_instance_variables config
+        create_archive site.source
+        site.keep_files << @archive_name
+      end
+    end
+
+    private
+
+    def setup_instance_variables(config)
+      @archive_name = config["archive_name"] # Relative to _site
+      abort "Error: archive_name was not specified in _config.yml." if @archive_name.nil?
+
+      @archive_type = archive_type(@archive_name)
+
+      @archive_files = config["files"].compact
+      abort "Error: archive files were not specified in _config.yml." if @archive_files.nil?
+
+      delete_archive = config["delete"]
+      @force_delete = delete_archive.nil? ? !@live_reload : delete_archive
+
+      @logger.debug { "@archive_name=#{@archive_name}; @live_reload=#{@live_reload}; @force_delete=#{@force_delete}; @archive_files=#{@archive_files}" }
+    end
+
+    def archive_type(archive_name)
+      if archive_name.end_with? ".zip"
+        :zip
+      elsif archive_name.end_with? ".tar"
+        :tar
+      else
+        abort "Error: archive must be zip or tar; #{archive_name} is of an unknown archive type."
+      end
+    end
+
+    def create_archive(source)
+      archive_name_full = "#{source}/#{@archive_name}"
+      archive_exists = File.exist?(archive_name_full)
+      return if archive_exists && @live_reload
+
+      @logger.debug { "#{archive_name_full} exists? #{archive_exists}" }
+      if archive_exists && @force_delete
+        @logger.debug "Deleting old #{archive_name_full}"
+        File.delete(archive_name_full)
+      end
+
+      make_tar_or_zip(archive_exists, archive_name_full, source)
+
+      @logger.debug { "Looking for #{@archive_name} in .gitignore..." }
+      return if File.foreach(".gitignore").grep(%r!^#{@archive_name}\n?!).any?
+
+      warn "#{@archive_name} not found in .gitignore, adding entry."
+      File.open(".gitignore", "a") do |f|
+        f.puts File.basename(@archive_name)
+      end
+    end
+
+    def make_tar(tar_name, source)
+      Dir.mktmpdir do |dirname|
+        @archive_files.each do |filename|
+          fn, filename_full = qualify_file_name(filename, source)
+          @logger.debug { "Copying #{filename_full} to temporary directory #{dirname}; filename=#{filename}; fn=#{fn}" }
+          FileUtils.copy(filename_full, dirname)
+        end
+        write_tar(tar_name, dirname)
+      end
+    end
+
+    def make_tar_or_zip(archive_exists, archive_name_full, source)
+      if !archive_exists || @force_delete
+        @logger.debug { "Making #{archive_name_full}" }
+        case @archive_type
+        when :tar
+          make_tar(archive_name_full, source)
+        when :zip
+          make_zip(archive_name_full, source)
+        end
+      end
+    end
+
+    def make_zip(zip_name, source)
+      Zip.default_compression = Zlib::DEFAULT_COMPRESSION
+      Zip::File.open(zip_name, Zip::File::CREATE) do |zipfile|
+        @archive_files.each do |filename|
+          filename_in_archive, filename_original = qualify_file_name(filename, source)
+          @logger.debug { "make_zip: adding #{filename_original} to #{zip_name} as #{filename_in_archive}" }
+          zipfile.add(filename_in_archive, filename_original)
+        end
+      end
+    end
+
+    def write_tar(tar_name, dirname)
+      # Modified from https://gist.github.com/sinisterchipmunk/1335041/5be4e6039d899c9b8cca41869dc6861c8eb71f13
+      File.open(tar_name, "wb") do |tarfile|
+        Gem::Package::TarWriter.new(tarfile) do |tar|
+          Dir[File.join(dirname, "**/*")].each do |filename|
+            write_tar_entry(tar, dirname, filename)
+          end
+        end
+      end
+    end
+
+    def write_tar_entry(tar, dirname, filename)
+      mode = File.stat(filename).mode
+      relative_file = filename.sub(%r!^#{Regexp.escape dirname}/?!, "")
+      if File.directory?(filename)
+        tar.mkdir relative_file, mode
+      else
+        tar.add_file relative_file, mode do |tf|
+          File.open(filename, "rb") { |f| tf.write f.read }
+        end
+      end
+    end
+
+    # @return tuple of filename (without path) and fully qualified filename
+    def qualify_file_name(path, source)
+      case path[0]
+      when "/" # Is the file absolute?
+        @logger.debug { "Absolute filename: #{path}" }
+        [File.basename(path), path]
+      when "!" # Should the file be found on the PATH?
+        clean_path = path[1..-1]
+        filename_full = File.which(clean_path)
+        abort "Error: #{clean_path} is not on the PATH." if filename_full.nil?
+
+        @logger.debug { "File on PATH: #{clean_path} -> #{filename_full}" }
+        [File.basename(clean_path), filename_full]
+      when "~" # Is the file relative to user's home directory?
+        clean_path = path[2..-1]
+        filename_full = File.join(ENV["HOME"], clean_path)
+        @logger.debug { "File in home directory: #{clean_path} -> #{filename_full}" }
+        [File.basename(clean_path), filename_full]
+      else # The file is relative to the Jekyll website top-level directory
+        @logger.debug { "Relative filename: #{path}" }
+        [File.basename(path), File.join(source, path)] # join yields the fully qualified path
+      end
+    end
+
+    PluginMetaLogger.instance.logger.info { "Loaded jekyll_archive_create v#{JekyllArchiveCreate::VERSION} plugin." }
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: jekyll_archive_create
+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: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.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 generator for creating tar and zip files.
+
+'
+email:
+- mslinn@mslinn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- jekyll_archive_create.gemspec
+- lib/jekyll_archive_create.rb
+- lib/jekyll_archive_create/version.rb
+homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#make_archive
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/mslinn/jekyll_archive_create/issues
+  changelog_uri: https://github.com/mslinn/jekyll_archive_create/CHANGELOG.md
+  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#make_archive
+  source_code_uri: https://github.com/mslinn/jekyll_archive_create
+post_install_message: |2+
+
+  Thanks for installing jekyll_archive_create!
+
+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 generator for creating tar and zip files.
+test_files: []