fat_model_finder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9a30d1580e0dc9d1966d74185b29372007beea368312f00fdd087eaf392d811
+  data.tar.gz: 986451dcaa07049fc205e6b03b024a9a6b0911be5db516d6a631598e0a309fc5
+SHA512:
+  metadata.gz: 5ab672193131ada1a0c5517b2d20b197244e53b0f387c66fd63390cb23f7764f9629ada620a5f0f5f461c9aad853d1dc629cfc87da61fdf21e489b24c5e0e507
+  data.tar.gz: 8f4928672bb948f089f69abb7f96e38a8b6197d6578f662e4f73ed44c849326ef389cc9f4762558d3b461ac75712b41462977abeb441b4817c52725809b5ff8b

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/MethodLength:
+  Max: 20

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in fat_model_finder.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"
+
+gem 'thor'
+
+gem 'colorize'
+
+gem 'pry', require: false

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    fat_model_finder (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    coderay (1.1.3)
+    colorize (1.1.0)
+    json (2.13.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    method_source (1.1.0)
+    minitest (5.25.5)
+    parallel (1.27.0)
+    parser (3.3.9.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    pry (0.15.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    regexp_parser (2.11.2)
+    rubocop (1.80.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.46.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.46.0)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    thor (1.4.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.1.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  colorize
+  fat_model_finder!
+  minitest (~> 5.0)
+  pry
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  thor
+
+BUNDLED WITH
+   2.4.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Max Normand
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# FatModelFinder
+
+Whats the only kind of Model a Ruby Developer can get?
+
+A Fat one...
+
+FatModelFinder is a CLI tool designed to help developers identify "fat models" in their Rails applications. It scans the `/app/models` directory, analyzes each model file, and determines whether the model is "fat" based on conditions defined in this gem.
+
+## Installation
+
+To install the gem and add it to your application's Gemfile, execute:
+
+    $ bundle add fat_model_finder
+
+If Bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install fat_model_finder
+
+## Usage
+
+After installing the gem, you can use the CLI tool to scan your Rails application's models. Navigate to the root directory of your Rails application and run:
+
+1. To scan the models and save the fat model data into a JSON file named `file_data`:
+
+    ```bash
+    $ bin/fat_model_finder scan
+    ```
+
+2. To display the fat models based on the saved JSON data:
+
+    ```bash
+    $ bin/fat_model_finder show_fat_models
+    ```
+
+The `scan` command analyzes the models in the `/app/models` directory and saves the results in a JSON file. The `show_fat_models` command parses the JSON file and outputs the fat model data to the user.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/fat_model_finder.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/fat_model_finder/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "fat_model_finder"
+  spec.version = FatModelFinder::VERSION
+  spec.authors = ["Max Normand"]
+  spec.email = ["maxnormand97@gmail.com"]
+
+  spec.summary = "Working on a new app? Want to find Fat Models, use ME"
+  spec.description = "A CLI tool that scans the `/app/models` directory in a Rails application to identify 'fat models' based on conditions defined in this gem."
+  spec.homepage = "https://github.com/maxnormand97"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/maxnormand97/fat_model_finder"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Runtime dependencies
+  spec.add_dependency "thor"
+  spec.add_dependency "colorize"
+
+  # Development dependencies
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rubocop", "~> 1.21"
+  spec.add_development_dependency "pry"
+end

data/lib/fat_model_finder/file_data.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module FatModelFinder
+  # Class to store attributes of file data, later to be parsed to JSON file for storage
+  class FileData
+    # TODO: we can have a method that overrides these rules and is configurable by the user later. These can just be
+    # set as the default values...
+    METHOD_THRESHOLD = 10
+    CALLBACK_THRESHOLD = 5
+    VALIDATION_THRESHOLD = 5
+    ASSOCIATION_THRESHOLD = 5
+    LINE_COUNT_THRESHOLD = 300
+
+    attr_accessor :line_count, :file_name, :file_size, :file_extension, :last_modified, :word_count, :char_count,
+                  :is_empty, :file, :method_count, :callback_count, :association_count, :validation_count, :fat,
+                  :fat_model_data
+
+    def initialize(file:)
+      @file = file
+      @method_count = nil
+      @callback_count = nil
+      @association_count = nil
+      @validation_count = nil
+      @fat = false
+      @fat_model_data = {}
+    end
+
+    def set_base_attributes
+      @line_count = File.foreach(@file).count
+      @file_name = File.basename(@file)
+      @file_size = File.size(@file)
+      @file_extension = File.extname(@file)
+      @last_modified = File.mtime(@file)
+      @word_count = File.read(@file).split.size
+      @char_count = File.read(@file).length
+      @is_empty = File.zero?(@file)
+    end
+
+    # Convert the object to a hash for JSON serialization
+    def to_h
+      {
+        file_name: @file_name,
+        file_size: @file_size,
+        file_extension: @file_extension,
+        last_modified: @last_modified,
+        line_count: @line_count,
+        word_count: @word_count,
+        char_count: @char_count,
+        is_empty: @is_empty,
+        method_count: @method_count,
+        callback_count: @callback_count,
+        association_count: @association_count,
+        validation_count: @validation_count,
+        fat: @fat,
+        fat_model_data: @fat_model_data
+      }
+    end
+
+    def count_methods
+      file_content = File.read(@file)
+      @method_count = file_content.scan(/^\s*def\s+/).size
+    end
+
+    def count_callbacks
+      file_content = File.read(@file)
+      # Match Active Record callbacks like before_save, after_create, etc.
+      @callback_count = file_content.scan(/^\s*(before_|after_)\w+/).size
+    end
+
+    def count_associations
+      file_content = File.read(@file)
+      # Match Active Record associations like has_many, belongs_to, etc.
+      @association_count = file_content.scan(/^\s*(has_many|has_one|belongs_to|has_and_belongs_to_many)/).size
+    end
+
+    def count_validations
+      file_content = File.read(@file)
+      # Match both `validates` and `validate` for validations
+      @validation_count = file_content.scan(/^\s*(validates|validate)\b/).size
+    end
+
+    def calculate_if_fat_model
+      @fat_model_data = {
+        method_count_high: @method_count.to_i > METHOD_THRESHOLD,
+        callback_count_high: @callback_count.to_i > CALLBACK_THRESHOLD,
+        association_count_high: @association_count.to_i > ASSOCIATION_THRESHOLD,
+        validation_count_high: @validation_count.to_i > VALIDATION_THRESHOLD,
+        line_count_high: @line_count.to_i > LINE_COUNT_THRESHOLD
+      }
+
+      # A model is considered fat if greater than or eq to 2 of the conditions are true OR the line count is huge
+      @fat = @fat_model_data.values.count(true) >= 2 || @fat_model_data[:line_count_high]
+    end
+
+    # TODO: find the longest method...
+  end
+end

data/lib/fat_model_finder/file_data_presenter.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module FatModelFinder
+  # Presentation helper methods to output fat model data
+  # rubocop:disable Layout/LineLength
+  class FileDataPresenter
+    # rubocop:disable Metrics/AbcSize
+    def self.display(file_data:)
+      puts "File Name: #{file_data.file_name.colorize(:green)}"
+      puts "File Size: #{file_data.file_size} bytes".colorize(:green)
+      puts "File Extension: #{file_data.file_extension.colorize(:green)}"
+      puts "Last Modified: #{file_data.last_modified.to_s.colorize(:green)}"
+
+      puts "Line Count: #{colorize_threshold(file_data.line_count, FatModelFinder::FileData::LINE_COUNT_THRESHOLD)}"
+      puts "Word Count: #{file_data.word_count.to_s.colorize(:green)}"
+      puts "Character Count: #{file_data.char_count.to_s.colorize(:green)}"
+      puts "Is Empty: #{file_data.is_empty ? "Yes".colorize(:red) : "No".colorize(:green)}"
+
+      puts "Method Count: #{colorize_threshold(file_data.method_count, FatModelFinder::FileData::METHOD_THRESHOLD)}"
+      puts "Callback Count: #{colorize_threshold(file_data.callback_count, FatModelFinder::FileData::CALLBACK_THRESHOLD)}"
+      puts "Association Count: #{colorize_threshold(file_data.association_count, FatModelFinder::FileData::ASSOCIATION_THRESHOLD)}"
+      puts "Validation Count: #{colorize_threshold(file_data.validation_count, FatModelFinder::FileData::VALIDATION_THRESHOLD)}"
+      puts "\n"
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def self.present_fat_model(json_data:)
+      file_name = json_data["file_name"]
+      fat_model_data = json_data["fat_model_data"] || {}
+
+      file_name_message = "The model in file '#{file_name.colorize(:red)}' is considered fat due to the following issues:"
+
+      breakdown = fat_model_data.select { |_key, value| value == true }
+      breakdown_message = breakdown.map { |key, _| "- #{key.to_s.gsub("_", " ").capitalize}".colorize(:red) }.join("\n")
+
+      puts "#{file_name_message}\n#{breakdown_message}\n\n"
+    end
+
+    def self.display_tips
+      tips = <<~TIPS
+        To address these issues:
+        - Reduce the number of methods by moving business logic to service objects or concerns.
+        - Minimize callbacks by using them sparingly and considering alternative patterns.
+        - Simplify associations by ensuring they are necessary and not overly complex.
+        - Break down validations into smaller, reusable components if possible.
+        - If the line count is high, split the model into smaller, more focused classes.
+
+        Remember, the goal is to keep your models focused and maintainable.
+      TIPS
+
+      puts tips
+    end
+
+    # Flag fat model conditions that have passed
+    def self.colorize_threshold(value, threshold)
+      value.to_i > threshold ? value.to_s.colorize(:red) + " - (LIMIT EXCEEDED)".colorize(:red) : value.to_s.colorize(:green)
+    end
+  end
+  # rubocop:enable Layout/LineLength
+end

data/lib/fat_model_finder/version.rb

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

data/lib/fat_model_finder.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+require "thor"
+require "json"
+require "colorize"
+require_relative "fat_model_finder/version"
+require_relative "fat_model_finder/file_data"
+require_relative "fat_model_finder/file_data_presenter"
+
+module FatModelFinder
+  class Error < StandardError; end
+
+  # Interface for the program to the CLI
+  class CLI < Thor
+    DATA_FILE = "file_data.json"
+
+    # rubocop:disable Metrics/BlockLength
+    no_commands do
+      def load_file_data
+        if File.exist?(DATA_FILE)
+          file_content = File.read(DATA_FILE)
+          file_content.empty? ? [] : JSON.parse(file_content)
+        else
+          []
+        end
+      end
+
+      def purge_file_data
+        File.write("file_data.json", "[]") if File.exist?("file_data.json")
+      end
+
+      def save_file_data(data)
+        # Clear the file data by overwriting with an empty array
+        File.write(DATA_FILE, JSON.dump([])) if File.exist?(DATA_FILE)
+
+        File.write(DATA_FILE, JSON.dump(data))
+        puts "Updated file data saved to #{DATA_FILE}"
+      end
+
+      def directory_exists?(directory)
+        unless Dir.exist?(directory)
+          puts "Directory not found: #{directory}"
+          return false
+        end
+        true
+      end
+
+      def process_file(file, all_file_data)
+        return if all_file_data.any? { |entry| entry["file"] == file }
+
+        puts "#{file} - Adding new file"
+        file_data = create_file_data(file)
+        FileDataPresenter.display(file_data: file_data)
+        all_file_data << file_data.to_h
+      end
+
+      def create_file_data(file)
+        create_file_data = FileData.new(file: file)
+        create_file_data.set_base_attributes
+        create_file_data.count_methods
+        create_file_data.count_callbacks
+        create_file_data.count_associations
+        create_file_data.count_validations
+        create_file_data.calculate_if_fat_model
+        create_file_data
+      end
+    end
+    # rubocop:enable Metrics/BlockLength
+
+    # Command: Scan a directory
+    desc "scan DIRECTORY", "Scan a directory in a Rails app and save file data to a JSON file"
+    def scan(directory = "app/models")
+      puts "Scanning directory: #{directory}"
+      return unless directory_exists?(directory)
+
+      purge_file_data
+
+      all_file_data = load_file_data
+      files = Dir.glob("#{directory}/**/*")
+
+      files.each do |file|
+        next unless File.file?(file) # Skip directories
+
+        process_file(file, all_file_data)
+      end
+
+      save_file_data(all_file_data)
+    end
+
+    # Command: Show stored file data
+    desc "show_fat_models", "Output details based on file_data JSON file"
+    def show_fat_models
+      all_file_data = load_file_data
+      puts "No data found. Run 'scan' first." if all_file_data.empty?
+
+      fat_models = all_file_data.select { |record| record["fat"] == true }
+
+      if !fat_models.empty?
+        puts "Your Fat Models are..."
+        fat_models.each do |fat_model|
+          FileDataPresenter.present_fat_model(json_data: fat_model)
+        end
+
+        FileDataPresenter.display_tips
+      else
+        puts "Nothing to worry about you have no Fat Models!"
+      end
+    end
+  end
+end

data/sig/fat_model_finder.rbs

@@ -0,0 +1,4 @@
+module FatModelFinder
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: fat_model_finder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Max Normand
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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 CLI tool that scans the `/app/models` directory in a Rails application
+  to identify 'fat models' based on conditions defined in this gem.
+email:
+- maxnormand97@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- fat_model_finder.gemspec
+- lib/fat_model_finder.rb
+- lib/fat_model_finder/file_data.rb
+- lib/fat_model_finder/file_data_presenter.rb
+- lib/fat_model_finder/version.rb
+- sig/fat_model_finder.rbs
+homepage: https://github.com/maxnormand97
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/maxnormand97
+  source_code_uri: https://github.com/maxnormand97/fat_model_finder
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Working on a new app? Want to find Fat Models, use ME
+test_files: []