jekyll_basename_dirname 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4019dc240e1548eb16d1742626466a114c7ccd6f3a5c3185cf6e2543140e1ccf
-  data.tar.gz: a480bfc77c6f2d273e8cd09946d441c75816ea9c2c8bb7aaf655288c0c0ac99c
+  metadata.gz: '029c8bf4dccc0a05d629d11f48c10040549dbb43abe60ea968d5ebaf3dc5411e'
+  data.tar.gz: 7bd1aa48e9a29514a2e6e95098699b9cf8a7ae72b4da53db2080847bf9e4855a
 SHA512:
-  metadata.gz: 5667cca741db2db4c2fd3b7f863750307f03ea7307a05b545aa0b4384f41471385dcbcf945fe823dd807a52917577267ba0e60b47db51a47c02cb489acb6e69b
-  data.tar.gz: 1d8bfc8966db94ae5437e26429e8f51937b67504227452885a23b1be68771e67efd39fc9c88663f35f967b520a296cd88f32102e2be696882c93494979057bd7
+  metadata.gz: d23bd5913c0f9d122e5b322c80eff132a3bd41d4d41b45e6e1623c4193ca47b83113627b50e507fe76087d8df114efe5cad3b16f7b18dd9246e5ff4d2bdbdc59
+  data.tar.gz: 945bb59763f128e67afec7b2f3b7852ae7d3fb0a9a14bb9d31c76eee3f5294a8cd821019a01cb11fb0461295fde0358dc49c8ed955c9ecc84ca4dcdbb61fc191

data/.rubocop.yml

@@ -1,13 +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/**/*
+    - binstub/**/*
+    - vendor/**/*
+    - Gemfile*
   NewCops: enable
-  TargetRubyVersion: 2.6
+
+Gemspec/DeprecatedAttributeAssignment:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Layout/InitialIndentation:
+  Exclude:
+    - README.md
+
+Layout/MultilineMethodCallIndentation:
+  Enabled: false
+
+Layout/HashAlignment:
+  EnforcedColonStyle: table
+  Exclude:
+    - jekyll_basename_dirname.gemspec
 
 Layout/LineLength:
   Max: 150
+
+Metrics/AbcSize:
+  Max: 45
+
+Lint/RedundantCopDisableDirective:
+  Exclude:
+    - jekyll_basename_dirname.gemspec
+
+Metrics/BlockLength:
+  Exclude:
+    - jekyll_basename_dirname.gemspec
+    - spec/**/*
+
+Metrics/ClassLength:
+  Exclude:
+    - spec/**/*
+  Max: 40
+
+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,15 +1,35 @@
+# Change Log
+
+## 1.0.4 / 2025-07-21
+
+* Added demo
+* Added wbr filter
+
+
+## 1.0.3 / 2022-04-06
+
+* Brought up to current standards
+
+
 ## 1.0.2 / 2022-04-05
-  * Updated to jekyll_plugin_logger v2.1.0
-  * Added unit tests
+
+* Updated to jekyll_plugin_logger v2.1.0
+* Added unit tests
+
 
 ## 1.0.1 / 2022-03-11
-  * Corrected dumb error
+
+* Corrected dumb error
+
 
 ## 1.0.0 / 2022-03-11
-  * Made into a Ruby gem and published on RubyGems.org as [jekyll_basename_dirname](https://rubygems.org/gems/jekyll_basename_dirname).
-  * `bin/attach` script added for debugging
-  * Rubocop standards added
-  * Proper versioning and CHANGELOG.md added
+
+* Made into a Ruby gem and published on RubyGems.org as [jekyll_basename_dirname](https://rubygems.org/gems/jekyll_basename_dirname).
+* `bin/attach` script added for debugging
+* Rubocop standards added
+* Proper versioning and CHANGELOG.md added
+
 
 ## 0.1.0 / 2020-12-29
-  * Initial version published
+
+* Initial version published

data/README.md

@@ -1,16 +1,19 @@
-Jekyll_basename_dirname
-[![Gem Version](https://badge.fury.io/rb/jekyll_basename_dirname.svg)](https://badge.fury.io/rb/jekyll_basename_dirname)
-===========
+# Jekyll_basename_dirname [![Gem Version](https://badge.fury.io/rb/jekyll_basename_dirname.svg)](https://badge.fury.io/rb/jekyll_basename_dirname)
 
-This is a Jekyll plugin that provides two Liquid filters: `basename` and `dirname`.
-They work like the similarly named bash commands.
+This is a Jekyll plugin that provides the following Liquid filters:
+`basename`, `basename_without_extension`, `dirname` and `wbr`.
 
-More information is available on my web site about [my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
+`basename` and `dirname` work like the similarly named bash commands.
+
+More information is available on Mike Slinn's web site about [my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
 
 
 ## Installation
 
-Add this line to your Jekyll website's `Gemfile`, within the `jekyll_plugins` group:
+### As a Jekyll Filter Plugin
+
+If you want to use this Ruby gem in a Jekyll application,
+add the following line to your application's `Gemfile`:
 
 ```ruby
 group :jekyll_plugins do
@@ -18,13 +21,41 @@ group :jekyll_plugins do
 end
 ```
 
-And then execute:
+And then install in the usual fashion:
+
+```shell
+$ bundle
+```
+
 
-    $ bundle install
+### As a Dependency Of a Gem
 
-Or install it yourself as:
+Add the following line to your application's `.gemspec`:
 
-    $ gem install jekyll_basename_dirname
+```ruby
+spec.add_dependency 'jekyll_basename_dirname'
+```
+
+And then install the dependencies in the usual fashion:
+
+```shell
+$ bundle
+```
+
+
+### As a Ruby Module In a Ruby Program
+
+Add the following line to your application's `Gemfile`:
+
+```ruby
+gem 'jekyll_basename_dirname'
+```
+
+And then install the dependencies in the usual fashion:
+
+```shell
+$ bundle
+```
 
 
 ## Usage
@@ -33,48 +64,72 @@ Or install it yourself as:
 
 Filters a string containing a path and returns the portion of th path before the filename and extension.
 Example: Extracts "blah/blah" from the path.
-```
+
+```html
 {{ "blah/blah/filename.ext" | dirname }} => blah/blah
 ```
 
+
 ### Basename
+
 Filters a string containing a path and returns the filename extracted from the path, including the filetype.
 
 Example: Extracts "filename.ext" from the path:
-```
+
+```html
 {{ "blah/blah/filename.ext" | basename }} => filename.ext
 ```
 
+
 ### Basename Without Extension
+
 Filters a string containing a path and returns the filename extracted from the path, including the filetype.
 
 Example: Extracts "filename.ext" from the path:
-```
+
+```html
 {{ "blah/blah/filename.ext" | basename_without_extension  }} => filename
 ```
 
 
+### wbr
+
+Filters a string containing a path so long paths wrap in an HTML page.
+
+Example:
+
+```html
+{{ 'blah/blah/filename.ext' | wbr }} => blah/<wbr>/blah/<wbr>filename.ext
+```
+
+
 ## 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.
+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.
 
 Install development dependencies like this:
-```
+
+```shell
 $ BUNDLE_WITH="development" bundle install
 ```
 
 To install this gem onto your local machine, run:
+
 ```shell
 $ bundle exec rake install
 ```
 
 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).
 

data/Rakefile

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

data/jekyll_basename_dirname.gemspec

@@ -1,46 +1,36 @@
-# frozen_string_literal: true
+require_relative 'lib/jekyll_basename_dirname/version'
 
-require_relative "lib/jekyll_basename_dirname/version"
+Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength
+  github = 'https://github.com/mslinn/jekyll_basename_dirname'
 
-# rubocop:disable Metrics/BlockLength
-Gem::Specification.new do |spec|
-  github = "https://github.com/mslinn/jekyll_basename_dirname"
-
-  spec.authors = ["Mike Slinn"]
-  spec.bindir = "exe"
+  spec.authors = ['Mike Slinn']
+  spec.bindir = 'exe'
   spec.description = <<~END_OF_DESC
     This Jekyll plugin provides 3 Liquid filters: dirname, basename and basename_without_extension.
   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#basename"
-  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/jekyll_plugins/jekyll_basename_dirname.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,
+    '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_basename_dirname"
+  spec.name = 'jekyll_basename_dirname'
   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 Liquid filters: dirname, basename and basename_without_extension."
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.6.0'
+  spec.summary = 'This Jekyll plugin provides 3 Liquid filters: dirname, basename and basename_without_extension.'
   spec.test_files = spec.files.grep(%r!^(test|spec|features)/!)
   spec.version = JekyllBasenameDirnameVersion::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_basename_dirname/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module JekyllBasenameDirnameVersion
-  VERSION = "1.0.3"
+  VERSION = '1.0.4'.freeze
 end

data/lib/jekyll_basename_dirname.rb

@@ -1,40 +1,48 @@
-# frozen_string_literal: true
-
-require "jekyll"
-require "jekyll_plugin_logger"
-require_relative "jekyll_basename_dirname/version"
+require 'jekyll'
+require 'jekyll_plugin_logger'
+require_relative 'jekyll_basename_dirname/version'
 
 # @author Copyright 2020 Michael Slinn
 # @license SPDX-License-Identifier: Apache-2.0
 #
 # Jekyll filters for working with paths.
 module JekyllBasenameDirnameName
-  PLUGIN_NAME = "jekyll_basename_dirname"
+  PLUGIN_NAME = 'jekyll_basename_dirname'.freeze
 
   _logger = PluginMetaLogger.instance.new_logger(self, PluginMetaLogger.instance.config)
 
   # Filters a string containing a path.
   # @return [String] the filename extracted from the path, including the filetype.
-  # @example Extracts "filename.ext" from the path
-  #   {{ "blah/blah/filename.ext" | basename }}
+  # @example Extracts 'filename.ext' from the path
+  #   {{ 'blah/blah/filename.ext' | basename }}
   def basename(filepath)
     File.basename(filepath)
   end
 
   # Filters a string containing a path.
   # @return [String] the portion of th path before the filename and extension.
-  # @example Extracts "blah/blah" from the path.
-  #   {{ "blah/blah/filename.ext" | dirname }}
+  # @example Extracts 'blah/blah' from the path.
+  #   {{ 'blah/blah/filename.ext' | dirname }}
   def dirname(filepath)
     File.dirname(filepath)
   end
 
   # Filters a string containing a path.
   # @return the filename without the extension.
-  # @example Extracts "filename" from the path.
-  #   {{ "blah/blah/filename.ext" | basename_without_extension }}
+  # @example Extracts 'filename' from the path.
+  #   {{ 'blah/blah/filename.ext' | basename_without_extension }}
   def basename_without_extension(filepath)
-    File.basename(filepath).split(".")[0...-1].join(".")
+    File.basename(filepath).split('.')[0...-1].join('.')
+  end
+
+  # Filters a string containing a path so long paths wrap in an HTML page.
+  # @return the path with '<wbr>' inserted after every slash.
+  # @example
+  #   {{ 'blah/blah/filename.ext' | wbr }}
+  # Returns:
+  #   blah/<wbr>/blah/<wbr>filename.ext
+  def wbr(filepath)
+    filepath.gsub '/', '/<wbr>'
   end
 end
 

data/spec/jekyll_basename_dirname_name_spec.rb

@@ -0,0 +1,17 @@
+require 'jekyll'
+require 'fileutils'
+require_relative '../lib/jekyll_basename_dirname'
+
+RSpec.describe(JekyllBasenameDirnameName) do
+  include described_class
+
+  it 'verifies basename' do
+    expect(basename('a/b/c/d/e.html')).to eq('e.html')
+    expect(basename('blah.html')).to eq('blah.html')
+  end
+
+  it 'verifies dirname' do
+    expect(dirname('a/b/c/d/e.html')).to eq('a/b/c/d')
+    expect(dirname('blah.html')).to eq('.')
+  end
+end

data/spec/spec_helper.rb

@@ -1,13 +1,10 @@
-# frozen_string_literal: true
-
 require "liquid"
 require "fileutils"
 require_relative "../lib/jekyll_basename_dirname"
 
 RSpec.configure do |config|
-  config.filter_run :focus
-  config.order = "random"
-  config.run_all_when_everything_filtered = true
+  # config.order = "random"
+  config.filter_run_when_matching focus: true
 
   # See https://relishapp.com/rspec/rspec-core/docs/command-line/only-failures
   config.example_status_persistence_file_path = "spec/status_persistence.txt"

data/spec/status_persistence.txt

@@ -0,0 +1,4 @@
+example_id                                       | status | run_time        |
+------------------------------------------------ | ------ | --------------- |
+./spec/jekyll_basename_dirname_name_spec.rb[1:1] | passed | 0.00226 seconds |
+./spec/jekyll_basename_dirname_name_spec.rb[1:2] | passed | 0.00005 seconds |

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_basename_dirname
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Mike Slinn
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-06 00:00:00.000000000 Z
+date: 2024-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -38,38 +38,10 @@ 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 Liquid filters: dirname, basename and
   basename_without_extension.
 
-'
+  '
 email:
 - mslinn@mslinn.com
 executables: []
@@ -84,16 +56,17 @@ files:
 - jekyll_basename_dirname.gemspec
 - lib/jekyll_basename_dirname.rb
 - lib/jekyll_basename_dirname/version.rb
-- spec/basename_dirname_spec.rb
+- spec/jekyll_basename_dirname_name_spec.rb
 - spec/spec_helper.rb
-homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#basename
+- spec/status_persistence.txt
+homepage: https://www.mslinn.com/jekyll_plugins/jekyll_basename_dirname.html
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
   bug_tracker_uri: https://github.com/mslinn/jekyll_basename_dirname/issues
   changelog_uri: https://github.com/mslinn/jekyll_basename_dirname/CHANGELOG.md
-  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#basename
+  homepage_uri: https://www.mslinn.com/jekyll_plugins/jekyll_basename_dirname.html
   source_code_uri: https://github.com/mslinn/jekyll_basename_dirname
 post_install_message: |2+
 
@@ -113,10 +86,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.5.10
+signing_key:
 specification_version: 4
 summary: 'This Jekyll plugin provides 3 Liquid filters: dirname, basename and basename_without_extension.'
 test_files:
-- spec/basename_dirname_spec.rb
+- spec/jekyll_basename_dirname_name_spec.rb
 - spec/spec_helper.rb
+- spec/status_persistence.txt
+...

data/spec/basename_dirname_spec.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require "jekyll"
-require "fileutils"
-require_relative "../lib/jekyll_basename_dirname"
-
-RSpec.describe(JekyllBasenameDirnameName) do
-  include JekyllBasenameDirnameName
-
-  it "verifies basename" do
-    expect(basename("a/b/c/d/e.html")).to eq("e.html")
-    expect(basename("blah.html")).to eq("blah.html")
-  end
-
-  it "verifies dirname" do
-    expect(dirname("a/b/c/d/e.html")).to eq("a/b/c/d")
-    expect(dirname("blah.html")).to eq(".")
-  end
-end