jekyll_basename_dirname 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 455811bf056657fa622e9e13187a9cf8f7beaf7919375d1942dea1619bfa2e38
-  data.tar.gz: 68998518b65ea687220e21c30269f8c28acabeb0481944a9b690e3da0526260b
+  metadata.gz: e761e421cbfe93a85e44672d67e542846d789b54c7107d6a4132a27f7b89a92d
+  data.tar.gz: 3bed361f072142c738bb9dade039eccbc697859a3b1661dd3fe0c78f4f59201e
 SHA512:
-  metadata.gz: 4c04f3873e3d7978074a816d2704683a01fe61b452dadb631058e8e3cb9a035c4e101d245018d35aafe2e9ce883bacf30d5427281753cc5e1faffab21d3e92ec
-  data.tar.gz: 3efff20f1cf8fa13fd1bfed4011301c18c2a78cb5782cec635ffc6c54053057beeee125a3c91c6a63a55b61a52bca5613279572de094b6727ec07e0e47eca2f5
+  metadata.gz: a71d2579ad70dd666ec14c990d5c791b0a34e8d45bf67751046d3bf302e5d6b3e191a5456ebe467ad92ac8e65985fb050f2e4a72e6a5f95ab825895d214e4b8c
+  data.tar.gz: '086e1d9049145fea6feb2854dd4337e1d17069754ba48d86ee85901231c354a743ba5ce61888332dc8164f9cf80709d5d294737f95b24b73b03f5541aacefd79'

data/.rubocop.yml

@@ -11,21 +11,3 @@ AllCops:
 
 Layout/LineLength:
   Max: 150
-
-Layout/MultilineMethodCallIndentation:
-  Enabled: false
-
-Metrics/BlockLength:
-  Enabled: false
-
-Style/PercentLiteralDelimiters:
-  Enabled: false
-
-Style/RegexpLiteral:
-  Enabled: false
-
-Style/StringLiterals:
-  Enabled: false
-
-Style/StringLiteralsInInterpolation:
-  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,9 @@
+## HEAD / 2022-03-12
+  * Added unit tests
+
 ## 1.0.1 / 2022-03-11
   * 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

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Mike Slinn
+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

data/README.md

@@ -1,6 +1,11 @@
-# JekyllBasenameDirname
+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 two Liquid filters: `basename` and `dirname`.
+They work like the similarly named bash commands.
+
+More information is available on my web site about [my Jekyll plugins](https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html).
 
 
 ## Installation
@@ -24,20 +29,28 @@ Or install it yourself as:
 
 ## Usage
 
-## Basename
+### Dirname
+
+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.
+```
+{{ "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:
 ```
-{{ "blah/blah/filename.ext" | basename }}
+{{ "blah/blah/filename.ext" | basename }} => filename.ext
 ```
 
-## Dirname
+### Basename Without Extension
+Filters a string containing a path and returns the filename extracted from the path, including the filetype.
 
-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.
+Example: Extracts "filename.ext" from the path:
 ```
-{{ "blah/blah/filename.ext" | dirname }}
+{{ "blah/blah/filename.ext" | basename_without_extension  }} => filename
 ```
 
 
@@ -45,7 +58,25 @@ Example: Extracts "blah/blah" from the path.
 
 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.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Install development dependencies like this:
+```
+$ 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).
 
 
 ## Contributing

data/Rakefile

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

data/jekyll_basename_dirname.gemspec

@@ -2,39 +2,45 @@
 
 require_relative "lib/jekyll_basename_dirname/version"
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
-  spec.name = "jekyll_basename_dirname"
-  spec.version = JekyllBasenameDirname::VERSION
+  github = "https://github.com/mslinn/jekyll_basename_dirname"
+
   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.summary = "Jekyll plugin that provides two Liquid filters: basename and dirname."
-  spec.description = "Jekyll plugin that provides two Liquid filters: basename and dirname. They work like the similarly named bash commands."
-  spec.homepage = "https://github.com/mslinn/jekyll_basename_dirname"
+  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.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+  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_basename_dirname"
+  spec.post_install_message = <<~END_MESSAGE
 
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://github.com/mslinn/jekyll_basename_dirname"
-  spec.metadata["changelog_uri"] = "https://github.com/mslinn/jekyll_basename_dirname/CHANGELOG.md"
+    Thanks for installing #{spec.name}!
 
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  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.test_files = spec.files.grep(%r!^(test|spec|features)/!)
+  spec.version = JekyllBasenameDirname::VERSION
+
+  spec.add_dependency "jekyll", ">= 3.5.0"
+  spec.add_dependency "jekyll_plugin_logger"
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'rubocop-jekyll'
+  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/jekyll_basename_dirname/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JekyllBasenameDirname
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/lib/jekyll_basename_dirname.rb

@@ -1,13 +1,16 @@
 # frozen_string_literal: true
 
+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 JekyllBasenameDirname
-  class Error < StandardError; end
+module JekyllBasenameDirnameName
+  PLUGIN_NAME = "jekyll_basename_dirname"
+
+  _logger = PluginMetaLogger.instance.new_logger(self)
 
   # Filters a string containing a path.
   # @return [String] the filename extracted from the path, including the filetype.
@@ -30,8 +33,9 @@ module JekyllBasenameDirname
   # @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
 end
 
-Liquid::Template.register_filter(JekyllBasenameDirname)
+PluginMetaLogger.instance.info { "Loaded #{JekyllBasenameDirnameName::PLUGIN_NAME} v#{JekyllBasenameDirname::VERSION} plugin." }
+Liquid::Template.register_filter(JekyllBasenameDirnameName)

data/spec/basename_dirname_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "liquid"
+require "fileutils"
+# require "jekyll_plugin_logger"
+require_relative "../lib/jekyll_basename_dirname"
+
+RSpec.describe(JekyllBasenameDirname) do
+  include JekyllBasenameDirname
+
+  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

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

metadata

@@ -1,65 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: jekyll_basename_dirname
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Mike Slinn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: jekyll
   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: pry
-  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: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 3.5.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.5.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: jekyll_plugin_logger
   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:
@@ -67,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: debase
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-jekyll
+  name: ruby-debug-ide
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -94,8 +66,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'Jekyll plugin that provides two Liquid filters: basename and dirname.
-  They work like the similarly named bash commands.'
+description: 'This Jekyll plugin provides 3 Liquid filters: dirname, basename and
+  basename_without_extension.
+
+'
 email:
 - mslinn@mslinn.com
 executables: []
@@ -104,24 +78,27 @@ extra_rdoc_files: []
 files:
 - ".rubocop.yml"
 - CHANGELOG.md
-- Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - jekyll_basename_dirname.gemspec
 - lib/jekyll_basename_dirname.rb
 - lib/jekyll_basename_dirname/version.rb
-- sig/jekyll_basename_dirname.rbs
-homepage: https://github.com/mslinn/jekyll_basename_dirname
+- spec/basename_dirname_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#basename
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org/
-  homepage_uri: https://github.com/mslinn/jekyll_basename_dirname
-  source_code_uri: https://github.com/mslinn/jekyll_basename_dirname
+  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
-post_install_message: 
+  homepage_uri: https://www.mslinn.com/blog/2020/10/03/jekyll-plugins.html#basename
+  source_code_uri: https://github.com/mslinn/jekyll_basename_dirname
+post_install_message: |2+
+
+  Thanks for installing jekyll_basename_dirname!
+
 rdoc_options: []
 require_paths:
 - lib
@@ -136,8 +113,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.5
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: 'Jekyll plugin that provides two Liquid filters: basename and dirname.'
-test_files: []
+summary: 'This Jekyll plugin provides 3 Liquid filters: dirname, basename and basename_without_extension.'
+test_files:
+- spec/basename_dirname_spec.rb
+- spec/spec_helper.rb

data/Gemfile

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in jekyll_basename_dirname.gemspec
-gemspec
-
-gem "rake", "~> 13.0"

data/Gemfile.lock

@@ -1,69 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jekyll_basename_dirname (1.0.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    coderay (1.1.3)
-    diff-lcs (1.5.0)
-    method_source (1.0.0)
-    parallel (1.21.0)
-    parser (3.1.1.0)
-      ast (~> 2.4.1)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.2.1)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.18.4)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.8.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
-      parser (>= 3.1.1.0)
-    rubocop-jekyll (0.12.0)
-      rubocop (~> 1.18.0)
-      rubocop-performance (~> 1.2)
-    rubocop-performance (1.13.3)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  bundler
-  jekyll_basename_dirname!
-  pry
-  rake (~> 13.0)
-  rspec
-  rubocop
-  rubocop-jekyll
-
-BUNDLED WITH
-   2.3.7

data/sig/jekyll_basename_dirname.rbs

@@ -1,4 +0,0 @@
-module JekyllBasenameDirname
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end