countless 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85b2c0713648dcae4e4c58a61e2fc036d09f72ede97a272455160575d857706c
-  data.tar.gz: ad4d183c8f45052db876ce47de0284cd4ecc6cb990fbfe001f367faa311ecdbe
+  metadata.gz: 9bd40e745d386b15e7078d50dfb2bb101a4eee94e959483558f2081bb336239e
+  data.tar.gz: 3ef387060b53e5757aa7261e24d0cf25c51613a3814dd73f206c2a0ba18d21a6
 SHA512:
-  metadata.gz: 67bef49fba2d75074da94c9c2a0e9d41d1e802c8811a5d7c4beb5c6413e86453b88cb372a45b08ee84d3a0aca516c85066c06abecfaa92f4e59a590d8d741c08
-  data.tar.gz: 9278d34dccec7e2ec980e6fa073f18fea6768318da9e5884e40291a42df3aa9b854449221ba28c874e1b2e678b5ff3667aa6e05a1b49bb8e8834626a1a45de78
+  metadata.gz: b58d7d01c56663f3d3c17aa303fd0e4b88097afd53fa914a7ad3c49c5a16d44991139730493e344b5fb4e6a897e7fb42f5efe391b0b7cc6bfbec343f285200b2
+  data.tar.gz: 692e6523b3ba000c2454759aa3a9f725955b277518e98841ecb693234172764f01d9deeb1fae7abc685541e3e71f184d279c1e4df6907f07757ec77ee069608e

data/.rubocop.yml

@@ -1,10 +1,11 @@
+inherit_from:
+  - https://potpourri.hausgold.de/config/rubocop.yml
+  - https://potpourri.hausgold.de/config/rubocop-gem.yml
+
 plugins:
   - rubocop-rspec
   - rubocop-rails
 
-Style/Documentation:
-  Enabled: true
-
 AllCops:
   NewCops: enable
   SuggestExtensions: false
@@ -18,43 +19,12 @@ AllCops:
     - gemfiles/**/*
     - spec/fixtures/files/**/*
 
-Metrics/BlockLength:
-  Exclude:
-    - Rakefile
-    - '*.gemspec'
-    - spec/**/*.rb
-    - '**/*.rake'
-    - doc/**/*.rb
-
-# MFA is not yet enabled for our gems yet.
-Gemspec/RequireMFA:
-  Enabled: false
-
-# We stay with the original Ruby Style Guide recommendation.
-Layout/LineLength:
-  Max: 80
-
-# Document all the things.
-Style/DocumentationMethod:
-  Enabled: true
-  RequireForNonPublicMethods: true
-
 # It's a deliberate idiom in RSpec.
 # See: https://github.com/bbatsov/rubocop/issues/4222
 Lint/AmbiguousBlockAssociation:
   Exclude:
     - "spec/**/*"
 
-# Because +expect_any_instance_of().to have_received()+ is not
-# supported with the +with(hash_including)+ matchers
-RSpec/MessageSpies:
-  EnforcedStyle: receive
-
-# Because nesting makes sense here to group the feature tests
-# more effective. This increases maintainability.
-RSpec/NestedGroups:
-  Max: 4
-
 # Disable regular Rails spec paths.
 Rails/FilePath:
   Enabled: false

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 * TODO: Replace this bullet point with an actual description of a change.
 
+### 2.3.0 (19 December 2025)
+
+* Migrated to a shared Rubocop configuration for HAUSGOLD gems ([#16](https://github.com/hausgold/countless/pull/16))
+
 ### 2.2.0 (23 October 2025)
 
 * Added support for Rails 8.1 ([#14](https://github.com/hausgold/countless/pull/14))

data/Envfile

@@ -1,3 +1,4 @@
 LANG=en_US.UTF-8
 LANGUAGE=en_US.UTF-8
 LC_ALL=en_US.UTF-8
+RUBOCOP_CACHE_ROOT=/app/tmp

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 HAUSGOLD | talocasa GmbH
+Copyright (c) 2025 HAUSGOLD | talocasa GmbH
 
 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

@@ -17,7 +17,7 @@ with the gem package.
 - [Installation](#installation)
 - [Requirements](#requirements)
 - [Usage](#usage)
-  - [Addtional Configuration](#addtional-configuration)
+  - [Additional Configuration](#additional-configuration)
 - [Development](#development)
 - [Code of Conduct](#code-of-conduct)
 - [Contributing](#contributing)
@@ -50,7 +50,7 @@ $ bundle
 
 ## Usage
 
-You can configure the Countless gem in serveral ways, but the most common
+You can configure the Countless gem in several ways, but the most common
 usecase is to install its Rake tasks and configure it in order to work
 properly. Here comes a self descriptive example (within a Rakefile):
 
@@ -92,14 +92,14 @@ Afterwards the following Rake tasks are available to you:
   * **notes:custom**: Show notes for custom annotation (run via `bundle exec
     rake notes:custom ANNOTATION='NOTE'`)
 
-### Addtional Configuration
+### Additional Configuration
 
 ```ruby
 # All the configured values here represent the Gem defaults.
 Countless.configure do |config|
   # The base/root path of the project to work on. This path is used as a #
   # prefix to all relative path/file configurations. By default we check for a
-  # Rake invokation (Rakefile location), a Rails invokation (project root) or
+  # Rake invocation (Rakefile location), a Rails invocation (project root) or
   # fallback the the current working directory of the process.
   config.base_path = Dir.pwd
 

data/lib/countless/annotations.rb

@@ -10,9 +10,6 @@ module Countless
   # of the line (or closing ERB comment tag) is considered to be their text.
   #
   # Heavily stolen from: https://bit.ly/3nBS0aj
-  #
-  # rubocop:disable Metrics/ClassLength -- because of the nested Annotation
-  #   class
   class Annotations
     attr_reader :tag, :options, :dirs, :files, :annotations
 
@@ -124,8 +121,6 @@ module Countless
     # Formats the found annotations.
     #
     # @return [String] the formatted annotations
-    #
-    # rubocop:disable Metrics/AbcSize -- because of the indentation logic
     def to_s
       buf = []
       options[:indent] = annotations.flat_map do |_f, a|
@@ -138,7 +133,6 @@ module Countless
       end
       buf.join("\n")
     end
-    # rubocop:enable Metrics/AbcSize
 
     # A single annotation representation.
     Annotation = Struct.new(:line, :tag, :text) do
@@ -240,5 +234,4 @@ module Countless
       end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/countless/cloc.rb

@@ -33,9 +33,6 @@ module Countless
       #   directories) to fetch the statistics for
       # @return [Hash{String => Hash{String => Mixed}] the raw CLOC
       #   YAML output
-      #
-      # rubocop:disable Metrics/MethodLength -- because of the system command
-      #   preparation
       def raw_stats(*paths)
         cmd = [
           Countless.cloc_path,
@@ -61,7 +58,6 @@ module Countless
         # Otherwise we use the CLOC produced YAML and parse it
         YAML.safe_load(stdout) || {}
       end
-      # rubocop:enable Metrics/MethodLength
     end
   end
 end

data/lib/countless/configuration.rb

@@ -3,8 +3,7 @@
 module Countless
   # The configuration for the countless gem.
   #
-  # rubocop:disable Metrics/ClassLength -- because of the various defaults
-  # rubocop:disable Metrics/BlockLength -- ditto
+  # rubocop:disable Metrics/BlockLength -- because of the various defaults
   class Configuration < ActiveSupport::OrderedOptions
     # Track our configurations settings (+Symbol+ keys) and their defaults as
     # lazy-loaded +Proc+'s values
@@ -242,6 +241,5 @@ module Countless
       }.deep_merge(additional_annotation_patterns)
     end
   end
-  # rubocop:enable Metrics/ClassLength
   # rubocop:enable Metrics/BlockLength
 end

data/lib/countless/extensions/configuration_handling.rb

@@ -3,9 +3,6 @@
 module Countless
   module Extensions
     # A top-level gem-module extension to handle configuration needs.
-    #
-    # rubocop:disable Metrics/BlockLength -- because this is how an
-    #   +ActiveSupport::Concern+ looks like
     module ConfigurationHandling
       extend ActiveSupport::Concern
 
@@ -39,11 +36,6 @@ module Countless
         # checked for code statistics.
         #
         # @return [Array<Hash{Symbol => Mixed}>] the statistics directories
-        #
-        # rubocop:disable Metrics/MethodLength -- because of the configuration
-        #   assembling
-        # rubocop:disable Metrics/AbcSize -- ditto
-        # rubocop:disable Metrics/CyclomaticComplexity -- ditto
         def statistic_directories
           conf = configuration
           pattern_suffix = "/**/*.{#{conf.stats_file_extensions.join(',')}}"
@@ -73,11 +65,7 @@ module Countless
 
           res.sort_by { |cur| [cur[:test].to_s, cur[:name]] }
         end
-        # rubocop:enable Metrics/MethodLength
-        # rubocop:enable Metrics/AbcSize
-        # rubocop:enable Metrics/CyclomaticComplexity
       end
     end
-    # rubocop:enable Metrics/BlockLength
   end
 end

data/lib/countless/statistics.rb

@@ -4,9 +4,6 @@ module Countless
   # The source code statistics displaying handler.
   #
   # Heavily stolen from: https://bit.ly/3qpvgfu
-  #
-  # rubocop:disable Metrics/ClassLength -- because of the calculation and
-  #   formatting logic
   class Statistics
     # Make the extracted information accessible
     attr_reader :dirs, :statistics, :total
@@ -17,12 +14,6 @@ module Countless
     #
     # @param dirs [Array<Hash{Symbol => Mixed}>] the configurations
     # @return [Countless::Statistics] the new instance
-    #
-    # rubocop:disable Metrics/AbcSize -- because of the directory/config
-    #   resolving
-    # rubocop:disable Metrics/PerceivedComplexity -- ditto
-    # rubocop:disable Metrics/CyclomaticComplexity -- ditto
-    # rubocop:disable Metrics/MethodLength -- ditto
     def initialize(*dirs)
       base_path = Countless.configuration.base_path
 
@@ -47,10 +38,6 @@ module Countless
       @statistics = calculate_statistics
       @total = calculate_total if @dirs.length > 1
     end
-    # rubocop:enable Metrics/AbcSize
-    # rubocop:enable Metrics/PerceivedComplexity
-    # rubocop:enable Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/MethodLength
 
     # Calculate the total statistics of all sub-statistics for the configured
     # directories.
@@ -119,9 +106,6 @@ module Countless
     #
     # rubocop:disable Metrics/MethodLength -- because of the complex formatting
     #   logic with fully dynamic columns widths
-    # rubocop:disable Metrics/PerceivedComplexity -- ditto
-    # rubocop:disable Metrics/CyclomaticComplexity -- ditto
-    # rubocop:disable Metrics/AbcSize -- ditto
     def to_s
       col_sizes = {}
       rows = to_table.map do |row|
@@ -152,9 +136,6 @@ module Countless
       end.join("\n")
     end
     # rubocop:enable Metrics/MethodLength
-    # rubocop:enable Metrics/PerceivedComplexity
-    # rubocop:enable Metrics/CyclomaticComplexity
-    # rubocop:enable Metrics/AbcSize
 
     # Convert the code statistics to a processable table structure. Each
     # element in the resulting array is a single line, while array elements
@@ -162,8 +143,6 @@ module Countless
     # later by +#to_s+.
     #
     # @return [Array<Array<String, Integer>, Symbol>] the raw table
-    #
-    # rubocop:disable Metrics/MethodLength -- because of the table construction
     def to_table
       table = [
         :splitter,
@@ -181,7 +160,6 @@ module Countless
       table << code_test_stats_line
       table
     end
-    # rubocop:enable Metrics/MethodLength
 
     # Return the final meta statistics line.
     #
@@ -247,7 +225,7 @@ module Countless
       # Parse and add statistics of a single file by path.
       #
       # @param path [String] the path of the file
-      # @param stats [Hash{Symbol => Integer}] addtional CLOC statistics
+      # @param stats [Hash{Symbol => Integer}] additional CLOC statistics
       def add_by_file_path(path, **stats)
         @lines += stats.fetch(:total, 0)
         @code_lines += stats.fetch(:code, 0)
@@ -260,11 +238,6 @@ module Countless
       # the current calculator instance metrics.
       #
       # @param path [String] the path of the file
-      #
-      # rubocop:disable Metrics/AbcSize -- because of the pattern search by
-      #   file extension and pattern matching on each line afterwards
-      # rubocop:disable Metrics/CyclomaticComplexity -- ditto
-      # rubocop:disable Metrics/PerceivedComplexity -- ditto
       def add_details_by_file_path(path)
         all_patterns = Countless.configuration.detailed_stats_patterns
 
@@ -283,9 +256,6 @@ module Countless
           @methods += 1 if patterns[:method]&.match? line
         end
       end
-      # rubocop:enable Metrics/AbcSize
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
 
       # Return the methods per classes.
       #
@@ -316,5 +286,4 @@ module Countless
       end
     end
   end
-  # rubocop:enable Metrics/ClassLength
 end

data/lib/countless/version.rb

@@ -3,7 +3,7 @@
 # The gem version details.
 module Countless
   # The version of the +countless+ gem
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 
   class << self
     # Returns the version of gem as a string.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: countless
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Hermann Mayer