calltally 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 500a5c27806a402198ff657275586756c3a3d004f01b03cdad133b13b119c1bf
-  data.tar.gz: 1f479fe7061ad208fb22d376519a6040d85bf93d80a92672e4ab01db51fdac59
+  metadata.gz: 7bbb05d3dd40bb7ec180388541a0d0290023f2a152834f8246c98f285dcf40b9
+  data.tar.gz: 363208eb22a5a347963ce4accb45ce85744f2e10507a74071d450f5af44d9a51
 SHA512:
-  metadata.gz: eaa590ed4f0c510b262597e1b89fd08f8e01940a4abc35a6dc768018b1c1ee2220cb8f4ca141e9190f1e09be956368ab8b7b9be8ec316b1ced685e2e9548ff9d
-  data.tar.gz: b9390cb686dbeb010039999fc4c93d53f2e0508468b3a4df2cb3a2fdeb06e0abbf7f8bb3da9948349ae82203ec9919cbfe21cce5792b2bba61762c1f4ea0d8c4
+  metadata.gz: 1c4797bf33d18a63b4230887986df0a917785f5d0064053f91bb9702089230de430ceeef0224fbd5a7178bd2b4f610c75b8ea336f823e8dd5cda82a34e070726
+  data.tar.gz: 015abe2bf689816f2c81951797fac0da9cefb1eebf51f0ed80990b76ff02f21453c1b508e4039524aeba2d22949b612006915ec4d3e6e20786e1119192aa1129

data/CHANGELOG.md

@@ -0,0 +1,58 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.3.0] - 2025-09-20
+
+### Added
+- Plugin system for extensible file processing
+  - New `--plugins` option to load external plugins
+  - Plugin API with `register`, `handle`, and `registered_exts` methods
+  - Plugins can register custom file handlers for any extension
+
+### Changed
+- Updated Prism dependency to 1.5.1
+
+## [0.2.0] - 2025-09-14
+
+### Removed
+- **BREAKING:** ERB file analysis
+  - `.erb` files are no longer analyzed
+  - Removed the `--erb` CLI option
+  - Disabled automatic ERB processing in the Rails profile
+  - This eliminates noise from ERB compilation artifacts (e.g., `to_s`, `safe_concat`, `concat`, etc.)
+
+### Fixed
+- Method-call tallies better reflect actual Ruby code usage (no ERB-generated noise)
+
+### Rationale
+ERB compilation introduces implementation artifacts that distort frequency counts:
+- Implicit `to_s` for `<%= ... %>`
+- Buffer operations (`safe_concat`, `concat`, `append`, etc.)
+- Framework helpers (`html_escape`, etc.)
+
+Focus for now is on Ruby code in models/controllers/services; view logic can be assessed via helpers or future plugins.
+
+### Migration
+- Remove any use of `--erb` (it now errors/does nothing).
+- If you relied on ERB counts, consider extracting key helpers to Ruby modules and scanning those instead.
+
+## [0.1.0] - 2025-09-13
+### Added
+- Initial release
+- Static analysis of method usage in Ruby/Rails codebases
+- Modes: receiver×method pairs, methods only, receivers only
+- Variable bucketing and receiver filters
+- Rails project auto-detection
+- Output formats: table, JSON, CSV
+- Ruby 3.2+ compatibility
+
+[Unreleased]: https://github.com/nsgc/calltally/compare/v0.3.0...HEAD
+[0.3.0]: https://github.com/nsgc/calltally/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/nsgc/calltally/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/nsgc/calltally/releases/tag/v0.1.0

data/README.md

@@ -44,8 +44,8 @@ Calltally automatically detects Rails projects and scans the right directories:
 # Auto-detects Rails and scans app/, lib/, config/
 calltally
 
-# Include ERB templates
-calltally --erb
+# Analyze specific file patterns
+calltally app/models
 
 # Focus on ActiveRecord methods
 calltally --methods where,find,joins --mode pairs
@@ -95,7 +95,6 @@ exclude:                # Patterns to exclude
   - test
   - vendor
 top: 50                 # Number of results to show
-include_erb: true       # Process ERB files
 mode: pairs            # pairs|methods|receivers
 skip_operators: true    # Skip operators like +, -, ==
 ```
@@ -148,7 +147,6 @@ Options:
   -x, --exclude x,y        Path parts to exclude
   -n, --top N              Show top N results (default: 100)
   -v, --verbose            Verbose output
-  --erb                    Include .erb files (requires erubi gem)
 
   --mode MODE              Output mode:
                            - pairs: receiver-method pairs (default)
@@ -207,6 +205,26 @@ Calltally shows method calls in your codebase with their receivers:
 5. **Code reviews** - Quickly analyze unfamiliar codebases
 6. **Gem development** - See how your gem's methods are used
 
+## FAQ
+
+### Why does grep show different counts than CallTally?
+
+CallTally counts method **calls**, not all text occurrences:
+- `grep "Current.user"` finds both `Current.user` (getter) and `Current.user = value` (setter)
+- CallTally only counts `Current.user` (the getter method call)
+- Setters like `name=` are separate methods and not counted as `name`
+
+### Which file types are analyzed?
+
+- **Ruby files**: `.rb`, `.ru`, `.rake`
+- **Not included**: JavaScript, CSS, YAML, and other file types
+
+### Why do I see (result) as a receiver?
+
+When methods are chained, CallTally shows intermediate results as `(result)`:
+- `user.posts.first` → `(var).posts` + `(result).first`
+- This happens because CallTally doesn't infer types without type annotations
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/nsgc/calltally.

data/lib/calltally/cli.rb

@@ -43,7 +43,6 @@ module Calltally
           -x, --exclude x,y        Path parts to exclude
           -n, --top N              Show top N (default: 100)
           -v, --verbose
-          --erb                    Include .erb (requires 'erubi' gem)
           --mode MODE              Output mode:
                                    - pairs (default): receiver-method pairs
                                    - methods: method names only
@@ -59,6 +58,7 @@ module Calltally
           --only-constants         Show only constant receivers
           --only-results           Show only method results receivers
           --[no-]skip-operators    Skip operator methods like +, -, ==, [] (default: true)
+          --plugins x,y            Enable plugins (e.g., erb for calltally-erb)
           --format F               table(default)|json|csv
           -o, --output PATH        Write result to file instead of STDOUT
           --config PATH            Use a specific .calltally.yml
@@ -77,7 +77,6 @@ module Calltally
         opt.on("-x x,y", "--exclude x,y", Array) { |v| cli_opts["exclude"] = v }
         opt.on("-n N", "--top N", Integer) { |v| cli_opts["top"] = v }
         opt.on("-v", "--verbose") { cli_opts["verbose"] = true }
-        opt.on("--erb") { cli_opts["include_erb"] = true }
         opt.on("--mode MODE", [:pairs, :methods, :receivers]) { |v| cli_opts["mode"] = v.to_s }
         opt.on("--receivers x,y", Array) { |v| cli_opts["receivers"] = v }
         opt.on("--methods x,y", Array) { |v| cli_opts["methods"] = v }
@@ -90,6 +89,7 @@ module Calltally
         opt.on("--only-constants") { (cli_opts["receiver_types"] ||= []) << "constants" }
         opt.on("--only-results") { (cli_opts["receiver_types"] ||= []) << "results" }
         opt.on("--[no-]skip-operators") { |v| cli_opts["skip_operators"] = v }
+        opt.on("--plugins x,y", Array) { |v| cli_opts["plugins"] = v }
         opt.on("--format F", [:table, :json, :csv]) { |v| cli_opts["format"] = v.to_s }
         opt.on("-o PATH", "--output PATH") { |v| cli_opts["output"] = v }
         opt.on("--config PATH") { |v| config_override = v }
@@ -109,11 +109,6 @@ module Calltally
 
       config = Calltally::Config.load(base_dir: base_dir, cli_opts: cli_opts)
 
-      if config["profile"] == "rails" && config["include_erb"] && !Calltally::Config.erubi_available?
-        warn "[calltally] Rails profile detected but 'erubi' not found. ERB will be skipped. Install 'erubi' to include ERB."
-        config["include_erb"] = false
-      end
-
       mode, rows = Calltally::Scanner.new(base_dir: base_dir, config: config).scan
 
       out = config["output"] ? File.open(config["output"], "w") : $stdout

data/lib/calltally/config.rb

@@ -6,21 +6,21 @@ require "set"
 module Calltally
   class Config
     DEFAULTS = {
-      "profile" => "auto",              # auto|rails|default
-      "dirs" => %w[.],
-      "exclude" => %w[spec test vendor node_modules tmp log .git .bundle],
-      "top" => 100,
-      "verbose" => false,
-      "include_erb" => false,
-      "mode" => "pairs",                # pairs|methods|receivers
-      "receivers" => nil,               # ["User","Group"]
-      "methods" => nil,                 # ["where","find"]
+      "profile"              => "auto",  # auto|rails|default
+      "dirs"                 => %w[.],
+      "exclude"              => %w[spec test vendor node_modules tmp log .git .bundle],
+      "top"                  => 100,
+      "verbose"              => false,
+      "mode"                 => "pairs", # pairs|methods|receivers
+      "receivers"            => nil,     # ["User","Group"]
+      "methods"              => nil,     # ["where","find"]
       "include_nil_receiver" => false,
-      "split_variables" => false,      # Show variable names vs grouping
-      "receiver_types" => nil,          # ["locals", "ivars", "constants"] etc.
-      "skip_operators" => true,
-      "format" => "table",              # table|json|csv
-      "output" => nil
+      "split_variables"      => false,   # Show variable names vs grouping
+      "receiver_types"       => nil,     # ["locals", "ivars", "constants"] etc.
+      "skip_operators"       => true,
+      "format"               => "table", # table|json|csv
+      "output"               => nil,
+      "plugins"              => []       # Enable plugins (e.g., ["erb"])
     }.freeze
 
     RAILS_DIR_PRESET = %w[app lib config].freeze
@@ -40,7 +40,6 @@ module Calltally
 
       if config["profile"] == "rails"
         config["dirs"] = RAILS_DIR_PRESET if config["dirs"] == DEFAULTS["dirs"]
-        config["include_erb"] = config["include_erb"] || erubi_available?
       end
 
       config["receivers"] = to_set_or_nil(config["receivers"])
@@ -59,13 +58,6 @@ module Calltally
       end
     end
 
-    def self.erubi_available?
-      require "erubi"
-      true
-    rescue LoadError
-      false
-    end
-
     def self.to_set_or_nil(v)
       case v
       when nil then nil

data/lib/calltally/plugin.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Calltally
+  module Plugin
+    @handlers = {}
+
+    class << self
+      def register(ext, &block)
+        @handlers[ext] = block
+      end
+
+      def handle(path, src, cfg)
+        if (handler = @handlers[File.extname(path)])
+          handler.call(path, src, cfg)
+        end
+      end
+
+      def registered_exts
+        @handlers.keys
+      end
+    end
+  end
+end

data/lib/calltally/scanner.rb

@@ -2,12 +2,14 @@
 
 require "find"
 require "calltally/prism_visitor"
+require "calltally/plugin"
 
 module Calltally
   class Scanner
     def initialize(base_dir:, config:)
       @base_dir = File.expand_path(base_dir)
       @config   = config
+      load_plugins(@config["plugins"])
     end
 
     def scan
@@ -61,7 +63,7 @@ module Calltally
 
     def collect_paths
       exts = %w[.rb .ru .rake]
-      exts << ".erb" if @config["include_erb"]
+      exts.concat(Calltally::Plugin.registered_exts)
 
       files = []
       @config["dirs"].each do |dir|
@@ -86,19 +88,25 @@ module Calltally
     end
 
     def read_source(path)
-      src = File.binread(path)
-      src = src.encode(Encoding::UTF_8, invalid: :replace, undef: :replace, replace: "")
+      src = File.binread(path).encode(Encoding::UTF_8, invalid: :replace, undef: :replace, replace: "")
 
-      if @config["include_erb"] && File.extname(path) == ".erb"
-        begin
-          require "erubi"
-          src = Erubi::Engine.new(src).src
-        rescue LoadError
-          warn "ERB requested but 'erubi' not installed. Skipping ERB compilation for #{path}."
-        end
+      if (plugin_result = Calltally::Plugin.handle(path, src, @config))
+        return plugin_result
       end
 
       src
     end
+
+    def load_plugins(plugin_names = [])
+      return if plugin_names.empty?
+
+      plugin_names.each do |plugin_name|
+        require "calltally/#{plugin_name}"
+
+        warn_verbose "Loaded plugin: calltally-#{plugin_name}"
+      rescue LoadError
+        warn "Plugin 'calltally-#{plugin_name}' not found. Install with: gem install calltally-#{plugin_name}"
+      end
+    end
   end
 end

data/lib/calltally/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: calltally
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Naoki Nishiguchi
@@ -51,20 +51,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: erubi
-  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'
 description: A simple yet powerful tool to analyze method usage in Ruby/Rails codebases.
   Track which methods are called most frequently, filter by receivers or method names,
   and export results in table, JSON, or CSV format. Perfect for understanding code
@@ -74,6 +60,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
@@ -83,6 +70,7 @@ files:
 - lib/calltally/cli.rb
 - lib/calltally/config.rb
 - lib/calltally/formatter.rb
+- lib/calltally/plugin.rb
 - lib/calltally/prism_visitor.rb
 - lib/calltally/scanner.rb
 - lib/calltally/version.rb