keela 0.0.2 → 0.2.0

data/lib/keela/strategy.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Keela
+  # Base class for detection strategies.
+  #
+  # Subclasses define how to find definitions and detect usage for
+  # different types of code (methods, scopes, etc.)
+  #
+  class Strategy
+    # Human-readable name for this strategy (e.g., "methods", "scopes")
+    def name
+      raise NotImplementedError, "#{self.class} must implement #name"
+    end
+
+    # Regex pattern to match files that may contain definitions
+    # (e.g., /app\/models/ for scopes)
+    def definition_file_pattern
+      raise NotImplementedError, "#{self.class} must implement #definition_file_pattern"
+    end
+
+    # Extract a definition name from a line of code, or nil if no definition found
+    def extract_definition(line)
+      raise NotImplementedError, "#{self.class} must implement #extract_definition"
+    end
+
+    # Build a regex to detect usage of the given definition name
+    def usage_regex(name)
+      raise NotImplementedError, "#{self.class} must implement #usage_regex"
+    end
+
+    # Whether to skip lines that start with # (comments)
+    def skip_comments?
+      false
+    end
+
+    # Override this method for strategies that need custom file parsing
+    # (e.g., YAML files for I18n keys).
+    # Returns an array of { name:, file: } hashes, or nil to use default line-by-line parsing.
+    def extract_definitions_from_file(_filepath, _lines)
+      nil
+    end
+  end
+end

data/lib/keela/version.rb

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

data/lib/keela.rb

@@ -1,5 +1,36 @@
 # frozen_string_literal: true
 
+require_relative "keela/version"
+require_relative "keela/configuration"
+require_relative "keela/config_file"
+require_relative "keela/strategy"
+require_relative "keela/strategies/methods"
+require_relative "keela/strategies/scopes"
+require_relative "keela/strategies/constants"
+require_relative "keela/strategies/delegations"
+require_relative "keela/strategies/attributes"
+require_relative "keela/strategies/i18n_keys"
+require_relative "keela/reporter"
+require_relative "keela/baseline"
+require_relative "keela/scanner"
+
 module Keela
-  VERSION = '0.0.2'
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
 end

metadata

@@ -1,26 +1,90 @@
 --- !ruby/object:Gem::Specification
 name: keela
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Kerri Miller
-bindir: bin
+bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
 description: Like the famous CSI dog who found what others missed, Keela detects unused
   methods and scopes in your Ruby codebase.
 email: kerrizor@kerrizor.com
-executables: []
+executables:
+- keela
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- exe/keela
 - lib/keela.rb
+- lib/keela/baseline.rb
+- lib/keela/config_file.rb
+- lib/keela/configuration.rb
+- lib/keela/reporter.rb
+- lib/keela/scanner.rb
+- lib/keela/strategies/attributes.rb
+- lib/keela/strategies/constants.rb
+- lib/keela/strategies/delegations.rb
+- lib/keela/strategies/i18n_keys.rb
+- lib/keela/strategies/methods.rb
+- lib/keela/strategies/scopes.rb
+- lib/keela/strategy.rb
+- lib/keela/version.rb
 homepage: https://github.com/kerrizor/keela
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/kerrizor/keela
+  source_code_uri: https://github.com/kerrizor/keela
+  changelog_uri: https://github.com/kerrizor/keela/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/kerrizor/keela/issues
 rdoc_options: []
 require_paths:
 - lib