jekyll_from_to_until 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40367980839f79b78e22874ba3a0987a3c7411aa424f062f560cd97c70abaeec
-  data.tar.gz: 2a9893e23007d9945dd1f2494399b3379102d95cd69db2c1942caf9863dcdbb0
+  metadata.gz: ae2bab81284396893b6c47b1bd67c4e95c95f2d44ed2521405eb1ce8905d05f8
+  data.tar.gz: 98decead66f66d2a77dc55e752ee6d2a17cb947adbd259783a5e992f32b95480
 SHA512:
-  metadata.gz: dffeaed4162224160e6bbc499cb409c5123a0c9b75692617a343fb538d0eff3df54ce82ef0822f8190d1896bb5cd2ba565f548ece16e2883c733ac78ece4532f
-  data.tar.gz: 91ce5fdae2e170e07e6867a4f53c7d4289d2d0548b02a0af3e95e8a4da4f936cd2ca9418457c4db0b2e16099e5889f4b4a50dbb5566135dddaddd746f6f0fd3b
+  metadata.gz: 881d77fdb20184c3062ee5da4faf129bb8a0e7bac2311308de006f63ace6183906075b19a886e84f1814ed6dbd00bd53faba10bcba4e6d95af27efadce0e86fd
+  data.tar.gz: 2220e933a40ec1a17231c21f7d620e1734bad5402147dc5f5ddeb5961246ef7a9bb84637b0836a5be0b1a7f6dd299c2653d81732752a14e3681490c66ec5604c

data/.rubocop.yml

@@ -1,16 +1,105 @@
-require: rubocop-jekyll
-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/InitialIndentation:
+  Exclude:
+    - README.md
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  Exclude:
+    - jekyll_from_to_until.gemspec
+
 Layout/LineLength:
   Max: 150
 
-Layout/MultilineOperationIndentation:
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - jekyll_from_to_until.gemspec
+
+Metrics/AbcSize:
+  Max: 45
+
+Metrics/BlockLength:
+  Exclude:
+    - jekyll_from_to_until.gemspec
+    - spec/**/*
+
+Metrics/ClassLength:
+  Exclude:
+    - spec/**/*
+
+Metrics/CyclomaticComplexity:
+  Max: 20
+
+Metrics/MethodLength:
+  Max: 40
+
+Metrics/PerceivedComplexity:
+  Max: 15
+
+Naming/FileName:
+  Exclude:
+    - 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:
+  Enabled: false
+
+Style/StringLiteralsInInterpolation:
+  Enabled: false
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: comma

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 1.0.2 / 2023-02-21
+  * Improved how the logger was used.
+  * Added `demo` website
+
 ## 1.0.1 / 2022-04-05
   * Updated to `jekyll_plugin_logger` v2.1.0
 

data/README.md

@@ -23,14 +23,10 @@ Add this line to your application's Gemfile:
 gem 'jekyll_from_to_until'
 ```
 
-And then execute:
+And then install in the usual fashion:
 
     $ bundle install
 
-Or install it yourself as:
-
-    $ gem install jekyll_from_to_until
-
 
 ## Syntax
 The regular expression may be enclosed in single quotes, double quotes, or nothing.
@@ -92,7 +88,6 @@ target/
 .idea
 .jekyll-cache/
 .jekyll-metadata
-.makeAwsBucketAndDistribution.log
 .sass-cache/
 .yardoc/
 __pycache__/
@@ -237,7 +232,9 @@ mslinn_aws.tar
 ```
 
 ### More Complex Regular Expressions
-The from, to and until filters can all accept more complex regular expressions. This regular expression matches lines that have either the string sun or cloud at the beginning of the line.
+The `from`, `to` and `until` filters can all accept regular expressions.
+The regular expression matches lines that have either the string `sun` or `cloud`
+at the beginning of the line.
 ```
 {{ gitignore | from: '^(cloud|sun)' }}
 ```
@@ -259,11 +256,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
 ```
 
@@ -283,6 +275,40 @@ jekyll_from_to_until (1.0.0)
     Generates Jekyll logger with colored output.
 ```
 
+## 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).
+
 
 ### Build and Push to RubyGems
 To release a new version,

data/Rakefile

@@ -1,4 +1,2 @@
-# frozen_string_literal: true
-
 require "bundler/gem_tasks"
-task :default => %i[]
+task default: %i[]

data/jekyll_from_to_until.gemspec

@@ -1,47 +1,37 @@
-# frozen_string_literal: true
+require_relative 'lib/jekyll_from_to_until/version'
 
-require_relative "lib/jekyll_from_to_until/version"
-
-# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
-  github = "https://github.com/mslinn/jekyll_from_to_until"
+  github = 'https://github.com/mslinn/jekyll_from_to_until'
 
-  spec.authors = ["Mike Slinn"]
-  spec.bindir = "exe"
+  spec.authors = ['Mike Slinn']
+  spec.bindir = 'exe'
   spec.description = <<~END_DESC
     This Jekyll plugin provides 3 filters that return portions of a multiline string: from, to and until.
     Regular expression is used to specify matches; the simplest regular expression is a string.
   END_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#from_to_until"
-  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#from_to_until'
+  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_from_to_until"
+  spec.name = 'jekyll_from_to_until'
   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 = "This Jekyll plugin provides 3 filters that return portions of a multiline string: from, to and until."
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.summary = 'This Jekyll plugin provides 3 filters that return portions of a multiline string: from, to and until.'
   spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
   spec.version = JekyllFromToUntilVersion::VERSION
 
-  spec.add_dependency "jekyll", ">= 3.5.0"
-  spec.add_dependency "jekyll_plugin_logger"
-
-  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'
 end
-# rubocop:enable Metrics/BlockLength

data/lib/jekyll_from_to_until/version.rb

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

data/lib/jekyll_from_to_until.rb

@@ -1,18 +1,18 @@
-# frozen_string_literal: true
-
 # @author Copyright 2020 Michael Slinn
 # Jekyll filters for working with multiline strings.
 
-require "jekyll_plugin_logger"
-require "liquid"
-require_relative "jekyll_from_to_until/version"
+require 'jekyll_plugin_logger'
+require 'liquid'
+require_relative 'jekyll_from_to_until/version'
 
 module JekyllPluginFromToUntilName
-  PLUGIN_NAME = "jekyll_from_to_until"
+  PLUGIN_NAME = 'jekyll_from_to_until'.freeze
 end
 
 module FromToUntil
-  @logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
+  def initialize(_)
+    @logger = PluginMetaLogger.instance.new_logger("FromToUntil", PluginMetaLogger.instance.config)
+  end
 
   # Filters a multiline string, returning the portion beginning with the line that satisfies a regex.
   # The regex could be enclosed in single quotes, double quotes, or nothing.
@@ -22,11 +22,11 @@ module FromToUntil
   # @example Returns remaining lines starting with the line containing the word `module`.
   #   {{ flexible_include '/blog/2020/10/03/jekyll-plugins.html' | from 'module' }}
   def from(input_strings, regex)
-    return "" unless check_parameters(input_strings, regex)
+    return '' unless check_parameters(input_strings, regex)
 
     regex = remove_quotations(regex.to_s.strip)
     matched = false
-    result = ""
+    result = ''
     input_strings.each_line do |line|
       matched = true if !matched && line =~ %r!#{regex}!
       result += line if matched
@@ -39,10 +39,10 @@ module FromToUntil
   # @example Returns lines up to and including the line containing the word `module`.
   #   {{ flexible_include '/blog/2020/10/03/jekyll-plugins.html' | to 'module' }}
   def to(input_strings, regex)
-    return "" unless check_parameters(input_strings, regex)
+    return '' unless check_parameters(input_strings, regex)
 
     regex = remove_quotations(regex.to_s.strip)
-    result = ""
+    result = ''
     input_strings.each_line do |line|
       result += line
       return result if line.match?(%r!#{regex}!)
@@ -55,10 +55,10 @@ module FromToUntil
   # @example Returns lines up to but not including the line containing the word `module`.
   #   {{ flexible_include '/blog/2020/10/03/jekyll-plugins.html' | until 'module' }}
   def until(input_strings, regex)
-    return "" unless check_parameters(input_strings, regex)
+    return '' unless check_parameters(input_strings, regex)
 
     regex = remove_quotations(regex.to_s.strip)
-    result = ""
+    result = ''
     input_strings.each_line do |line|
       return result if line.match?(%r!#{regex}!)
 

data/spec/from_to_until_spec.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'jekyll'
 require 'fileutils'
 require_relative '../lib/jekyll_from_to_until'

data/spec/spec_helper.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require 'jekyll'
 require 'fileutils'
 require_relative '../lib/jekyll_from_to_until'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_from_to_until
 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-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -38,34 +38,6 @@ dependencies:
     - - ">="
       - !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: |
   This Jekyll plugin provides 3 filters that return portions of a multiline string: from, to and until.
   Regular expression is used to specify matches; the simplest regular expression is a string.
@@ -112,11 +84,12 @@ 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: 'This Jekyll plugin provides 3 filters that return portions of a multiline
   string: from, to and until.'
 test_files:
 - spec/from_to_until_spec.rb
 - spec/spec_helper.rb
+...