caliber 0.51.0 → 0.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fff7e5a660df0819409521f6ee3340920b1fb133fc9ed8191c24031da849b654
-  data.tar.gz: 6e019c4d292014b27b5780138bfe4d154840bb8416e0e76ee4be40fa7465251a
+  metadata.gz: 03ef9e509842c030139692644b4dde8a99fcfc596338eb82cf9fb095f0af4160
+  data.tar.gz: 40ecc02698b9dfb3d25a416942ff11b49b1b67208d765a4b4aeba856e72a12ca
 SHA512:
-  metadata.gz: f96b76b784ff63835d1ebf6271eab98c7315212b6428f626ecbe8383160df63475f27a550b15c8ab9e8bcc0237325965cb07692fe297d01b358c84d41dcac316
-  data.tar.gz: df5e7920c03d57bd21399d7a3fa3821bb202474a918d5f964c6723694ce4be62f52d15b69a0752a61e4d771c368c6175b8faba8cf7cf17241f96eb48a23f9779
+  metadata.gz: 62fbe47abd8dad48d2fa46a43c75b58d72b90448c28921cc51f79b854771e70ce082dff58a5d6c4826343b9673a361fdcf12951b2ecf2bbd37fb948dd650fab6
+  data.tar.gz: 475f059c2703b912cce667f19b99401bdaf05c84890b7b54dbe9e33734ea5eeb7029737d25ab39b768a58fafd3e82e3e0c9a5fce5bd7430894f9a750e8fabd35

data/README.adoc

@@ -2,15 +2,16 @@
 :toclevels: 5
 :figure-caption!:
 
-:rubocop_link: link:https://docs.rubocop.org/rubocop[RuboCop]
 :rubocop_capybara_link: link:https://docs.rubocop.org/rubocop-capybara[RuboCop Capybara]
 :rubocop_disable_syntax_link: link:https://github.com/fatkodima/rubocop-disable_syntax[RuboCop Disable Syntax]
 :rubocop_factory_bot_link: link:https://docs.rubocop.org/rubocop-factory_bot/[RuboCop FactoryBot]
+:rubocop_link: link:https://docs.rubocop.org/rubocop[RuboCop]
 :rubocop_packaging_link: link:https://docs.rubocop.org/rubocop-packaging[RuboCop Packaging]
 :rubocop_performance_link: link:https://docs.rubocop.org/rubocop-performance[RuboCop Performance]
-:rubocop_thread_safety_link: link:https://github.com/rubocop/rubocop-thread_safety[RuboCop Thread Safety]
 :rubocop_rake_link: link:https://docs.rubocop.org/rubocop-rspec[RuboCop Rake]
 :rubocop_rspec_link: link:https://docs.rubocop.org/rubocop-rspec[RuboCop RSpec]
+:rubocop_thread_safety_link: link:https://github.com/rubocop/rubocop-thread_safety[RuboCop Thread Safety]
+:xdg_configuration_link: link:https://alchemists.io/articles/xdg_base_directory_specification[XDG Base Directory Specification]
 
 = Caliber
 
@@ -291,6 +292,26 @@ require:
 
 Adding additional RuboCop gems only requires adding them to your YAML configuration.
 
+=== Command Line Interface (CLI)
+
+⚠️ This is experimental but might be of interest to anyone using RuboCop's local {xdg_configuration_link} (highly recommend).
+
+At the moment, RuboCop doesn't have native functionality for handling these updates and this CLI is one solution to that problem (see this link:https://github.com/rubocop/rubocop/issues/12729[issue] for details). So this CLI automates the updating of outstanding issues you have not resolved for your RuboCop configuration (i.e. `.rubocop_todo.yml`) and is handy when you've fixed issues and want to update your configuration to reflect these changes. The CLI assumes you are using the following structure:
+
+....
+.config/rubocop/config.yml
+.config/rubocop/issues.yml
+....
+
+...and that you have this line in `.config/rubocop/config.yml`:
+
+[source,yaml]
+----
+inherit_from: issues.yml
+----
+
+Assuming the above is true, you can run the `caliber` CLI and follow the prompts for either updating your outstanding issues or exiting. Upon competition, the CLI will update your `.config/rubocop/issues.yml` so you can commit these updates/changes to your repository.
+
 == Development
 
 To contribute, run:

data/caliber.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "caliber"
-  spec.version = "0.51.0"
+  spec.version = "0.52.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/caliber"
@@ -26,11 +26,13 @@ Gem::Specification.new do |spec|
   spec.add_dependency "rubocop", "~> 1.61"
   spec.add_dependency "rubocop-disable_syntax", "~> 0.1"
   spec.add_dependency "rubocop-packaging", "~> 0.5"
-  spec.add_dependency "rubocop-performance", "~> 1.20"
+  spec.add_dependency "rubocop-performance", "~> 1.21"
   spec.add_dependency "rubocop-rake", "~> 0.6"
-  spec.add_dependency "rubocop-rspec", "~> 2.27"
+  spec.add_dependency "rubocop-rspec", "~> 2.27.1"
   spec.add_dependency "rubocop-thread_safety", "~> 0.5"
 
+  spec.bindir = "exe"
+  spec.executables << "caliber"
   spec.extra_rdoc_files = Dir["README*", "LICENSE*"]
   spec.files = Dir["*.gemspec", "config/**/*", "lib/**/*"]
 end

data/exe/caliber

@@ -0,0 +1,82 @@
+#! /usr/bin/env ruby
+# frozen_string_literal: true
+
+require "pathname"
+
+PATHS = {
+  xdg_config: ".config/rubocop/config.yml",
+  xdg_issues: ".config/rubocop/issues.yml",
+  config: ".rubocop.yml",
+  todo: ".rubocop_todo.yml"
+}.freeze
+
+class Updater
+  def initialize root: Pathname.pwd, paths: PATHS
+    @root = root
+    @paths = paths
+  end
+
+  def call
+    prompt
+    check_xdg_configuration
+    check_standard_configuration
+    copy_configuration
+    remove_inheritance
+    generate_issues
+    apply_changes
+  end
+
+  private
+
+  attr_reader :root, :paths
+
+  def prompt
+    puts "Update RuboCop configuration with outstanding issues (y/n)?"
+
+    return if gets.chomp == "y"
+
+    puts "RuboCop configuration update canceled."
+    exit
+  end
+
+  def check_xdg_configuration
+    return if full_path(:xdg_config).exist?
+
+    abort "RuboCop XDG configuration must exist before proceeding."
+  end
+
+  def check_standard_configuration
+    return unless full_path(:config).exist?
+
+    abort "RuboCop configuration exists. Please use a XDG configuration instead."
+  end
+
+  def copy_configuration = full_path(:config).write full_path(:xdg_config).read
+
+  def generate_issues = system "bundle exec rubocop --auto-gen-config"
+
+  def remove_inheritance
+    full_path(:config).then do |path|
+      content = path.read.sub(/inherit_from:\s(issues|\.rubocop_todo.).yml/, "")
+      path.write content
+    end
+  end
+
+  def apply_changes
+    config_path = full_path :config
+    todo_path = full_path :todo
+
+    if todo_path.empty?
+      puts "No changes were detected."
+    else
+      full_path(:xdg_issues).write todo_path.read
+    end
+
+    config_path.delete
+    todo_path.delete
+  end
+
+  def full_path(key) = root.join(paths.fetch(key))
+end
+
+Updater.new.call

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: caliber
 version: !ruby/object:Gem::Version
-  version: 0.51.0
+  version: 0.52.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2024-03-02 00:00:00.000000000 Z
+date: 2024-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -85,14 +85,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: '1.21'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.20'
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -113,14 +113,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.27'
+        version: 2.27.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.27'
+        version: 2.27.1
 - !ruby/object:Gem::Dependency
   name: rubocop-thread_safety
   requirement: !ruby/object:Gem::Requirement
@@ -138,7 +138,8 @@ dependencies:
 description:
 email:
 - brooke@alchemists.io
-executables: []
+executables:
+- caliber
 extensions: []
 extra_rdoc_files:
 - README.adoc
@@ -157,6 +158,7 @@ files:
 - config/rspec.yml
 - config/ruby.yml
 - config/thread.yml
+- exe/caliber
 - lib/caliber.rb
 homepage: https://alchemists.io/projects/caliber
 licenses:
@@ -184,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.7
 signing_key:
 specification_version: 4
 summary: A global, high quality, and constantly updated RuboCop configuration.