jekyll_archive_create 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3531174ed9e9f9be3cab608ed7e7e29c3fcce3935ed5a4ff2dfc5c763b69de56
-  data.tar.gz: ae50073228731d3f369b3281776525dd465ea2f55c9054b6906d21b6cabfd715
+  metadata.gz: cbfdc187732bb7308269e72e2cd4efdf4fcbeecc65b96f0741898f5fdf744b64
+  data.tar.gz: c30082b96f08d8d44365b658502a36acec7efbcdb65cf65d9d843c5380bb2ae9
 SHA512:
-  metadata.gz: 36e7fdfb1b49f7507eaaadba247e7a97a3144d6f56e11e7f24de68f9f93aa74dea18e0b223f114ed1a32a379133cc44aad41f36441a8d298ec55c8600231ebb5
-  data.tar.gz: 8d32e4db4c66a09fb3c94c539a540dcc46c69717db1fd22b539f85159364793c0c4a5f4bd8e901ff37bbab3ddb99af4af8d59e06be453092720d6f1e8259f613
+  metadata.gz: b1b4d88c919312a64c331b654ef9bd0436bb40552acbf108ceb293bd530623793e69b324a037c59570c7546d0458eb59c2b7a9a3c788ae3a6aafa6bcbd0fe49e
+  data.tar.gz: d71e8f628c977d12e13ebd9f1acccb7876954327579374c692252eeb247d2f91e99e665fcbf04e227e8932d3ce44cb53c356c83e6d62dcc14044cc3452eb032d

data/.rubocop.yml

@@ -1,37 +1,106 @@
-inherit_gem:
-  rubocop-jekyll: .rubocop.yml
+require:
+  # - rubocop-jekyll
+  - rubocop-md
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+# inherit_gem:
+#   rubocop-jekyll: .rubocop.yml
 
 AllCops:
   Exclude:
-      - vendor/**/*
-      - Gemfile*
+    - demo/_site/**/*
+    - exe/**/*
+    - vendor/**/*
+    - Gemfile*
   NewCops: enable
   TargetRubyVersion: 2.6
 
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  Exclude:
+    - jekyll_archive_create.gemspec
+
+Layout/InitialIndentation:
+  Exclude:
+    - README.md
+
 Layout/LineLength:
   Max: 150
 
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
 Metrics/AbcSize:
-  Max: 20
+  Max: 45
+
+Lint/RedundantCopDisableDirective:
   Exclude:
-    - "test/**/*"
+    - jekyll_archive_create.gemspec
 
 Metrics/BlockLength:
   Exclude:
-    - "*.gemspec"
-    - "Rakefile"
+    - jekyll_archive_create.gemspec
+    - spec/**/*
 
 Metrics/ClassLength:
-  Max: 50
   Exclude:
-    - "test/**/*"
+    - spec/**/*
+  Max: 40
+
+Metrics/CyclomaticComplexity:
+  Max: 20
 
 Metrics/MethodLength:
+  Max: 40
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/FileName:
   Exclude:
-    - "test/**/*"
+    - Rakefile
+
+RSpec/ExampleLength:
+  Max: 20
+
+RSpec/MultipleExpectations:
+  Max: 15
 
 Style/CommandLiteral:
   Enabled: false
 
+Style/CommentedKeyword:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Style/StringConcatenation:
+  Exclude:
+    - spec/**/*
+
 Style/StringLiterals:
-  EnforcedStyle: double_quotes
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -1,9 +1,15 @@
+## 1.0.2 / 2023-02-21
+  * Improved `.gitignore` handling.
+  * Improved logging output.
+  * Added `demo` website.
+  * Improved Rubocop usage.
+
 ## 1.0.1 / 2022-04-05
   * Updated to jekyll_plugin_logger v2.1.0
 
-
 ## 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).
+  * 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

data/README.md

@@ -4,15 +4,16 @@ 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.
+In production mode, the archives are built each time Jekyll generates the website. 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 !).
+ * Absolute filenames (start with `/`).
+ * Filenames relative to the top-level directory of the Jekyll website
+   (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.
@@ -22,16 +23,18 @@ 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' ]
+    files: [ index.html, 404.html, ~/.ssh/config, /etc/passwd, '!date' ]
   -
     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' ]
+    files: [ index.html, 404.html, ~/.ssh/config, /etc/passwd, '!date' ]
 ```
 
+The file called `date` contains the executable program or script of that name.
+
 
 ## 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).
+More information is available on my website about [my Jekyll plugins](https://mslinn.com/jekyll/3000-jekyll-plugins.html#archive_create).
 
 
 ## Installation
@@ -44,13 +47,44 @@ group :jekyll_plugins do
 end
 ```
 
-And then execute:
+And then install dependent gems as usual:
 
     $ bundle install
 
-Or install it yourself as:
 
-    $ gem install jekyll_archive_create
+## Demo Website
+A test/demo website is provided in the `demo` directory.
+You can run it under a debugger, or let it run free.
+
+The `demo/_bin/debug` script can set various parameters for the demo.
+View the help information with the `-h` option:
+```shell
+$ demo/_bin/debug -h
+
+debug - Run the demo Jekyll website.
+
+By default the demo Jekyll website runs without restriction under ruby-debug-ide and debase.
+View it at http://localhost:4444
+
+Options:
+  -h  Show this error message
+
+  -r  Run freely, without a debugger
+```
+
+
+### Debugging the Demo
+To run under a debugger, for example Visual Studio Code:
+ 1. Set breakpoints.
+
+ 2. Initiate a debug session from the command line:
+    ```shell
+    $ demo/bin/debug
+    ```
+
+  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).
 
 
 ## Development
@@ -63,11 +97,6 @@ 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:local
-```
-
-The following also does the same thing:
-```shell
 $ bundle exec rake install
 ```
 

data/Rakefile

@@ -1,7 +1,5 @@
-# frozen_string_literal: true
-
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
-task :default => :spec
+task default: :spec

data/jekyll_archive_create.gemspec

@@ -1,44 +1,37 @@
-# frozen_string_literal: true
+require_relative 'lib/jekyll_archive_create/version'
 
-require_relative "lib/jekyll_archive_create/version"
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  github = 'https://github.com/mslinn/jekyll_archive_create'
 
-Gem::Specification.new do |spec|
-  github = "https://github.com/mslinn/jekyll_archive_create"
-
-  spec.authors = ["Mike Slinn"]
-  spec.bindir = "exe"
+  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.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,
+    '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.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.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 = JekyllArchiveCreateVersion::VERSION
 
-  spec.add_dependency "jekyll", ">= 3.5.0"
-  spec.add_dependency "jekyll_plugin_logger", "~> 2.1.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"
+  spec.add_dependency 'jekyll', '>= 3.5.0'
+  spec.add_dependency 'jekyll_plugin_logger', '~> 2.1.0'
+  spec.add_dependency 'rubyzip'
 end

data/lib/jekyll_archive_create/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module JekyllArchiveCreateVersion
-  VERSION = "1.0.1"
+  VERSION = '1.0.2'.freeze
 end

data/lib/jekyll_archive_create.rb

@@ -1,14 +1,13 @@
-# 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"
+require 'fileutils'
+require 'jekyll'
+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
@@ -20,9 +19,9 @@ module Jekyll
     # @return [void]
     def generate(site)
       @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
-      @live_reload = site.config["livereload"]
+      @live_reload = site.config['livereload']
 
-      archive_config = site.config["make_archive"]
+      archive_config = site.config['make_archive']
       return if archive_config.nil?
 
       archive_config.each do |config|
@@ -35,24 +34,28 @@ module Jekyll
     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_name = config['archive_name'] # Relative to _site.source
+      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?
+      @archive_files = config['files'].compact
+      abort 'Error: archive files were not specified in _config.yml.' if @archive_files.nil?
 
-      delete_archive = config["delete"]
+      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}" }
+      @logger.debug do
+        part1 = "@archive_name=#{@archive_name}; @live_reload=#{@live_reload};"
+        part2 = "@force_delete=#{@force_delete}; @archive_files=#{@archive_files}"
+        "#{part1} #{part2}"
+      end
     end
 
     def archive_type(archive_name)
-      if archive_name.end_with? ".zip"
+      if archive_name.end_with? '.zip'
         :zip
-      elsif archive_name.end_with? ".tar"
+      elsif archive_name.end_with? '.tar'
         :tar
       else
         abort "Error: archive must be zip or tar; #{archive_name} is of an unknown archive type."
@@ -73,10 +76,16 @@ module Jekyll
       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?
+      if File.exist? '.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|
+        @logger.warn "#{@archive_name} was not found in .gitignore, adding entry."
+      else
+        @logger.warn "#{Dir.pwd}/.gitignore does not exist, creating it."
+        FileUtils.touch '.gitignore'
+      end
+
+      File.open('.gitignore', 'a') do |f|
         f.puts File.basename(@archive_name)
       end
     end
@@ -93,14 +102,14 @@ module Jekyll
     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
+      return unless !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
 
@@ -117,9 +126,9 @@ module Jekyll
 
     def write_tar(tar_name, dirname)
       # Modified from https://gist.github.com/sinisterchipmunk/1335041/5be4e6039d899c9b8cca41869dc6861c8eb71f13
-      File.open(tar_name, "wb") do |tarfile|
+      File.open(tar_name, 'wb') do |tarfile|
         Gem::Package::TarWriter.new(tarfile) do |tar|
-          Dir[File.join(dirname, "**/*")].each do |filename|
+          Dir[File.join(dirname, '**/*')].each do |filename|
             write_tar_entry(tar, dirname, filename)
           end
         end
@@ -128,12 +137,12 @@ module Jekyll
 
     def write_tar_entry(tar, dirname, filename)
       mode = File.stat(filename).mode
-      relative_file = filename.sub(%r!^#{Regexp.escape dirname}/?!, "")
+      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 }
+          File.open(filename, 'rb') { |f| tf.write f.read }
         end
       end
     end
@@ -141,19 +150,19 @@ module Jekyll
     # @return tuple of filename (without path) and fully qualified filename
     def qualify_file_name(path, source)
       case path[0]
-      when "/" # Is the file absolute?
+      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]
+      when '!' # Should the file be found on the PATH?
+        clean_path = path[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)
+      when '~' # Is the file relative to user's home directory?
+        clean_path = path[2..]
+        filename_full = File.join(Dir.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_archive_create
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Mike Slinn
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2023-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -39,27 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.1.0
 - !ruby/object:Gem::Dependency
-  name: debase
+  name: rubyzip
   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
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -68,7 +54,7 @@ dependencies:
         version: '0'
 description: 'Jekyll generator for creating tar and zip files.
 
-'
+  '
 email:
 - mslinn@mslinn.com
 executables: []
@@ -110,8 +96,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: Jekyll generator for creating tar and zip files.
 test_files: []
+...