keela 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47038e1bf08a377dba99ae8fe91134d51726c3ee20f12a24083ee4f6ecd421db
-  data.tar.gz: 429275504d8993d585671dde3cb8b09f374aa315080667d3272958656a38fff3
+  metadata.gz: 4fcf07cf3f0adee173c2dfaef9e79f256f6a6318c5dd843935b6113fede4dea4
+  data.tar.gz: 454fa3bc9a9839dcf7d5f40a6d2fa2160daeb3a2d113d2f372da6ce15f9a49b0
 SHA512:
-  metadata.gz: 146b50c0ec50be23c122a63481ba8a6185234dc9234577530178753346f1da8f30bccbecfc4d414a014bb056bf1d2adbcbb80531391ebb7f1185a266497b9ffc
-  data.tar.gz: d3250b7c810ae53389e0a18551d1c408f7218b1437f5047b76bc36e36e4fdf069d1166cd6e0ac64356366278ed73b986d0e511ad1cbf531814bdab3093fbf233
+  metadata.gz: f9105a9cc47b95443d527772bd1dc44b5578d3b88829ec0144109e1ce82cc03d3414be62de9c8e4f8a7ab308b742e3beea343e6aefd2b4e3184f694847bba711
+  data.tar.gz: b583a1e03b6b460d4393ed687ef8796315c6fc4e8f9e4afde3a4edce26581536ef0b72dbef7215237b97835263b12a52b55879f391d901efe5409007ae407982

data/CHANGELOG.md

@@ -7,6 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2026-08-05
+
+### Added
+
+- **Strategy-aware exclusion file format** - Exclusion files can now be organized by strategy (methods, scopes, etc.) to match the baseline file format. This allows excluding the same name in one strategy while flagging it in another. The legacy flat format is still supported for backward compatibility. ([#35](https://github.com/kerrizor/keela/pull/35))
+
+### Changed
+
+- **Performance: Share source files across strategies** - When scanning multiple strategies, source files are now loaded once and shared, reducing scan time by ~33% on large codebases. ([#37](https://github.com/kerrizor/keela/pull/37))
+
+### Fixed
+
+- CLI options now correctly override config file settings ([#36](https://github.com/kerrizor/keela/pull/36))
+
 ## [0.2.3] - 2026-07-31
 
 ### Fixed

data/README.md

@@ -271,21 +271,46 @@ This is useful for integrating with other tools, generating reports, or processi
 
 ## Exclusion File
 
-Some code appears unused but is actually called dynamically. Exclude it:
+Some code appears unused but is actually called dynamically. Exclude it using the **strategy-aware format** (recommended):
 
 ```yaml
-# .keela_excluded.yml
+# .keela/excluded.yml (strategy-aware format)
+methods:
+  app/models/user.rb:
+    - legacy_method: "Called via metaprogramming"
+    - callback_method: "Used as ActiveRecord callback"
+  app/helpers/application_helper.rb:
+    - helper_method: "Called from views dynamically"
+scopes:
+  app/models/user.rb:
+    - active: "Called dynamically via send()"
+```
+
+This format mirrors the baseline file structure and allows you to exclude the same name in one strategy while flagging it in another. For example, if you have both `scope :active` and `def active` in the same file, you can exclude them independently.
+
+### Legacy Flat Format
+
+The flat format is still supported for backward compatibility:
+
+```yaml
+# .keela_excluded.yml (legacy flat format)
 app/models/user.rb:
   - legacy_method: "Called via metaprogramming"
   - callback_method: "Used as ActiveRecord callback"
-app/helpers/application_helper.rb:
-  - helper_method: "Called from views dynamically"
 ```
 
-Then run with:
+**Note:** With the flat format, an exclusion applies to ALL strategies. If you exclude `active`, both the method and scope named `active` will be excluded.
+
+### Usage
 
 ```bash
-keela --excluded .keela_excluded.yml
+keela --excluded .keela/excluded.yml
+```
+
+Or configure in `keela.yml`:
+
+```yaml
+excluded_path: ".keela/excluded.yml"
 ```
 
 ## Ruby API

data/exe/keela

@@ -13,6 +13,9 @@ options = {
   quiet: false
 }
 
+# Store CLI overrides separately so they can be applied after config file loads
+cli_overrides = {}
+
 OptionParser.new do |opts|
   opts.banner = "Usage: keela [options]"
 
@@ -45,23 +48,25 @@ OptionParser.new do |opts|
   end
 
   opts.on("--excluded PATH", "Path to YAML file of excluded items") do |path|
-    Keela.configuration.excluded_path = path
+    cli_overrides[:excluded_path] = path
   end
 
   opts.on("--baseline PATH", "Path to YAML baseline file (default: .keela_baseline.yml)") do |path|
-    Keela.configuration.baseline_path = path
+    cli_overrides[:baseline_path] = path
   end
 
   opts.on("--extensions EXTS", "Comma-separated file extensions to scan (default: rb,haml,erb)") do |exts|
-    Keela.configuration.extensions = exts.split(",").map(&:strip)
+    cli_overrides[:extensions] = exts.split(",").map(&:strip)
   end
 
   opts.on("--exclude PATTERN", "Glob pattern for files to exclude (can be used multiple times)") do |pattern|
-    Keela.configuration.exclude_patterns << pattern
+    cli_overrides[:exclude_patterns] ||= []
+    cli_overrides[:exclude_patterns] << pattern
   end
 
   opts.on("--include PATTERN", "Additional glob pattern to scan (can be used multiple times)") do |pattern|
-    Keela.configuration.include_patterns << pattern
+    cli_overrides[:include_patterns] ||= []
+    cli_overrides[:include_patterns] << pattern
   end
 
   opts.on("--config PATH", "-c", "Path to config file (default: keela.yml or .keela.yml)") do |path|
@@ -84,9 +89,13 @@ OptionParser.new do |opts|
 end.parse!
 
 # Load config file (keela.yml or .keela.yml) if present
-# CLI options override config file settings
 Keela::ConfigFile.load(path: options[:config_path])
 
+# Apply CLI overrides (these take precedence over config file)
+cli_overrides.each do |key, value|
+  Keela.configuration.public_send("#{key}=", value)
+end
+
 # Apply quiet mode if requested
 Keela.configuration.show_progress = false if options[:quiet]
 
@@ -129,6 +138,9 @@ strategies = build_strategies(options[:types])
 # Share a single baseline across all strategies
 baseline = Keela::Baseline.new(Keela.configuration.baseline_path)
 
+# Load source files once and share across all strategies
+source_files = Keela::Scanner.load_source_files
+
 success = true
 results = {}
 
@@ -139,7 +151,7 @@ strategies.each_with_index do |strategy, index|
     puts Rainbow("=== Sniffing for unused #{strategy.name} ===").cyan.bright if strategies.size > 1
   end
 
-  scanner = Keela::Scanner.new(strategy: strategy, baseline: baseline)
+  scanner = Keela::Scanner.new(strategy: strategy, baseline: baseline, source_files: source_files)
   success &&= scanner.run(
     force_report: options[:force_report],
     update_baseline: options[:update_baseline],

data/lib/keela/scanner.rb

@@ -10,11 +10,43 @@ module Keela
     DEFAULT_EXCLUDED_PATHS = [".keela/excluded.yml", "keela_excluded.yml"].freeze
     DEFAULT_BASELINE_PATHS = [".keela/baseline.yml", "keela_baseline.yml"].freeze
 
-    def initialize(strategy:, configuration: Keela.configuration, baseline: nil)
+    # Load source files once for sharing across multiple Scanner instances.
+    # Returns a hash of { filename => [lines] }.
+    def self.load_source_files(configuration: Keela.configuration)
+      source_files = {}
+      file_globs = build_file_globs(configuration)
+
+      Dir.glob(file_globs).each do |filename|
+        next if excluded_file?(filename, configuration)
+
+        source_files[filename] = File.readlines(filename)
+      end
+
+      source_files
+    end
+
+    def self.build_file_globs(configuration)
+      all_patterns = configuration.directory_patterns + configuration.include_patterns
+
+      configuration.extensions.flat_map do |ext|
+        all_patterns.map { |pattern| format(pattern, ext: ext) }
+      end
+    end
+
+    def self.excluded_file?(filename, configuration)
+      return false if configuration.exclude_patterns.empty?
+
+      configuration.exclude_patterns.any? do |pattern|
+        File.fnmatch?(pattern, filename, File::FNM_PATHNAME | File::FNM_EXTGLOB)
+      end
+    end
+
+    def initialize(strategy:, configuration: Keela.configuration, baseline: nil, source_files: nil)
       @strategy = strategy
       @configuration = configuration
       @baseline = baseline || Baseline.new(resolve_baseline_path)
-      @source_files = {}
+      @source_files = source_files || {}
+      @source_files_preloaded = !source_files.nil?
       @unused_collection = Hash.new { |hash, key| hash[key] = [] }
       @new_unused = []
       @removed = []
@@ -97,6 +129,8 @@ module Keela
     end
 
     def load_source_files
+      return if @source_files_preloaded
+
       Dir.glob(file_globs).each do |filename|
         next if excluded_file?(filename)
 
@@ -134,7 +168,16 @@ module Keela
       path = resolve_excluded_path
       return definitions unless path
 
-      excluded = YAML.load_file(path, symbolize_names: true) || {}
+      all_excluded = YAML.load_file(path, symbolize_names: true) || {}
+
+      # Support both formats:
+      # 1. Strategy-aware (new): { methods: { "file.rb": [{ name: "reason" }] } }
+      # 2. Flat (legacy): { "file.rb": [{ name: "reason" }] }
+      excluded = if all_excluded.key?(strategy.name.to_sym)
+                   all_excluded[strategy.name.to_sym] || {}
+                 else
+                   all_excluded # Legacy flat format
+                 end
 
       definitions.reject do |h|
         excluded_for_file = excluded[h[:file].to_sym]

data/lib/keela/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Keela
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keela
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Kerri Miller