rubocop_director 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9495c42ab7429abd8ad0cf4c31074079fba3419b9cccc56a9ab51fdd66ae3c49
+  data.tar.gz: e634bc7e5f50acedb08be3c5dbb2f2e8ea03cbda5ef9694f89e87c5943b16a8d
+SHA512:
+  metadata.gz: 5ad6d7874bae6bc6bab004da66c96b777a24bec8f50457a7dc46aabb7b5e349bc49d52d2866e4f06c14c2ad71e9840d03c9fcc088d1d237061f80acfef3735f8
+  data.tar.gz: 8b1aeda0559907b4696f47b77a069f605816e7d25b99318bb36e54288511c859350d144ddc8469c40e8c347afb0c2c16cbd0cd956d02200974703b9decbb04f4

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+require:
+  - standard
+
+inherit_gem:
+  standard: config/base.yml
+
+AllCops:
+  TargetRubyVersion: 3.2

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 3.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-05-08
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rubocop_director.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 DmitryTsepelev
+
+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,79 @@
+# RubocopDirector
+
+A command–line utility for refactoring planning. It uses `.rubocop_todo.yml` and git history to prioritize a list of refactorings that can bring the most value.
+
+## Installation
+
+Prerequisites:
+
+- `sed`;
+- `git` repo;
+- generated `.rubocop_todo.yml`.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+$ bundle add rubocop_director
+```
+
+## Usage
+
+First of all, create the initial config file based on `.rubocop_todo.yml`:
+
+```bash
+bundle exec rubocop-director --generate-config
+```
+
+Optionally adjust weights in the config:
+
+1. `update_weight` means how important the fact that file was recently updated;
+2. `default_cop_weight` will be used in case when weight for a specific cop is not set;
+3. `weights` contains weights for specific cops.
+
+_You can use any numbers you want, but I think it's better to stick with something from 0 to 1._
+
+Build the report:
+
+```bash
+bundle exec rubocop-director
+```
+
+As a result you'll get something like this:
+
+```bash
+💡 Checking git history since 1995-01-01 to find hot files...
+💡🎥 Running rubocop to get the list of offences to fix...
+💡🎥🎬 Calculating a list of files to refactor...
+--------------------
+spec/models/user.rb
+updated 10 times since -4712-01-01
+offences: RSpec/AroundBlock - 8
+refactoring value: 110 (55%)
+--------------------
+spec/models/order.rb
+updated 20 times since -4712-01-01
+offences: Rspec/BeEql - 4
+refactoring value: 90 (45%)
+```
+
+> Want a different output format (e.g., CSV)? Let me know, open an issue!
+
+Value is calculated using a formula: `sum of value from each cop (<number of offences> * <cop weight> * <number of file updates> * <update weight>)`.
+
+If you need to count updates from a specific date—use `--since`:
+
+```bash
+bundle exec rubocop-director --since=2023-01-01
+```
+
+## Development
+
+After checking out the repo, run `bundle insatll` to install dependencies
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/DmitryTsepelev/rubocop_director.
+
+## 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,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/exe/rubocop-director

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require "rubocop_director"
+
+RubocopDirector::Runner.new(ARGV).perform

data/lib/rubocop_director/commands/generate_config.rb

@@ -0,0 +1,37 @@
+require "dry/monads"
+
+module RubocopDirector
+  module Commands
+    class GenerateConfig
+      include Dry::Monads[:result]
+      include Dry::Monads::Do.for(:run)
+
+      RUBOCOP_TODO = ".rubocop_todo.yml"
+
+      def run
+        todo = yield load_config
+
+        weights = todo.keys.each_with_object({}).each do |cop, acc|
+          acc.merge!(cop => 1)
+        end
+
+        # TODO: warn if file exists
+        File.write(".rubocop-director.yml", {
+          "update_weight" => 1,
+          "default_cop_weight" => 1,
+          "weights" => weights
+        }.to_yaml)
+
+        Success("Config generated")
+      end
+
+      private
+
+      def load_config
+        Success(YAML.load_file(RUBOCOP_TODO))
+      rescue Errno::ENOENT
+        Failure("#{RUBOCOP_TODO} not found, generate it using `rubocop --regenerate-todo`")
+      end
+    end
+  end
+end

data/lib/rubocop_director/commands/plan.rb

@@ -0,0 +1,54 @@
+require "open3"
+require "json"
+require "yaml"
+require "date"
+
+require "rubocop_director/rubocop_stats"
+require "rubocop_director/git_log_stats"
+require "rubocop_director/file_stats_builder"
+require "rubocop_director/output_formatter"
+
+module RubocopDirector
+  module Commands
+    class Plan
+      include Dry::Monads[:result]
+      include Dry::Monads::Do.for(:run)
+
+      def initialize(since)
+        @since = since || "1995-01-01"
+      end
+
+      def run
+        config = yield load_config
+        update_counts = yield load_git_stats
+        rubocop_json = yield load_rubocop_json
+        ranged_files = yield range_files(rubocop_json: rubocop_json, update_counts: update_counts, config: config)
+
+        OutputFormatter.new(ranged_files: ranged_files, since: @since).call
+      end
+
+      private
+
+      def load_config
+        Success(YAML.load_file(CONFIG_NAME))
+      rescue Errno::ENOENT
+        Failure("#{CONFIG_NAME} not found, generate it using `rubocop-director --generate-config`")
+      end
+
+      def load_git_stats
+        puts "💡 Checking git history since #{@since} to find hot files..."
+        GitLogStats.new(@since).fetch
+      end
+
+      def load_rubocop_json
+        puts "💡🎥 Running rubocop to get the list of offences to fix..."
+        RubocopStats.new.fetch
+      end
+
+      def range_files(rubocop_json:, update_counts:, config:)
+        puts "💡🎥🎬 Calculating a list of files to refactor..."
+        RubocopDirector::FileStatsBuilder.new(rubocop_json: rubocop_json, update_counts: update_counts, config: config).build
+      end
+    end
+  end
+end

data/lib/rubocop_director/file_stats_builder.rb

@@ -0,0 +1,65 @@
+module RubocopDirector
+  class FileStatsBuilder
+    include Dry::Monads[:result]
+    include Dry::Monads::Do.for(:build, :find_refactoring_value)
+
+    def initialize(rubocop_json:, update_counts:, config:)
+      @rubocop_json = rubocop_json
+      @update_counts = update_counts
+      @config = config
+    end
+
+    def build
+      file_stats = files_with_offenses.map do |file|
+        stats = {
+          path: file["path"],
+          updates_count: update_counts[file["path"]] || 0,
+          offense_counts: file["offenses"].group_by { |offense| offense["cop_name"] }.transform_values(&:count)
+        }
+
+        stats[:value] = yield find_refactoring_value(stats)
+
+        stats
+      end
+
+      Success(file_stats.sort_by { _1[:value] }.reverse)
+    end
+
+    private
+
+    attr_reader :rubocop_json, :update_counts, :config
+
+    def files_with_offenses = rubocop_json.select { |file| file["offenses"].any? }
+
+    def find_refactoring_value(file)
+      update_weight = yield fetch_update_weight
+
+      offence_sum = file[:offense_counts].sum do |cop_name, count|
+        cop_weight = yield fetch_cop_weight(cop_name)
+        cop_weight * count
+      end
+
+      Success((offence_sum * file[:updates_count] * update_weight).to_f)
+    end
+
+    def fetch_cop_weight(cop_name)
+      weight = config.dig("weights", cop_name) || config["default_cop_weight"]
+
+      if weight
+        Success(weight)
+      else
+        Failure("could not find weight for #{cop_name} and `default_cop_weight` is not configured")
+      end
+    end
+
+    def fetch_update_weight
+      weight = config["update_weight"]
+
+      if weight
+        Success(weight)
+      else
+        Failure("`update_weight` is not configured")
+      end
+    end
+  end
+end

data/lib/rubocop_director/git_log_stats.rb

@@ -0,0 +1,28 @@
+require "json"
+require "optparse"
+require "yaml"
+
+require "dry/monads"
+
+module RubocopDirector
+  class GitLogStats
+    include Dry::Monads[:result]
+
+    def initialize(since)
+      @since = since
+    end
+
+    def fetch
+      stdout, stderr = Open3.capture3("git log --since=\"#{@since}\" --pretty=format: --name-only | sort | uniq -c | sort -rg")
+
+      return Failure("Failed to fetch git stats: #{stderr}") if stderr.length > 0
+
+      stats = stdout.split("\n")[1..].each_with_object({}) do |line, acc|
+        number, path = line.split
+        acc[path] = number.to_i
+      end
+
+      Success(stats)
+    end
+  end
+end

data/lib/rubocop_director/output_formatter.rb

@@ -0,0 +1,32 @@
+require "json"
+require "optparse"
+require "yaml"
+
+require "dry/monads"
+
+module RubocopDirector
+  class OutputFormatter
+    include Dry::Monads[:result]
+
+    def initialize(ranged_files:, since:)
+      @ranged_files = ranged_files
+      @since = since
+    end
+
+    def call
+      result = @ranged_files.each_with_object([]) do |file, result|
+        result << "-" * 20
+        result << file[:path]
+        result << "updated #{file[:updates_count]} times since #{@since}"
+        result << "offences: #{file[:offense_counts].map { |cop, count| "#{cop} - #{count}" }.join(", ")}"
+        result << "refactoring value: #{file[:value]} (#{(100 * file[:value] / total_value.to_f).round(5)}%)"
+      end
+
+      Success(result)
+    end
+
+    private
+
+    def total_value = @ranged_files.sum { _1[:value] }
+  end
+end

data/lib/rubocop_director/rubocop_stats.rb

@@ -0,0 +1,28 @@
+require "open3"
+require "json"
+require "yaml"
+
+require "dry/monads"
+
+module RubocopDirector
+  class RubocopStats
+    include Dry::Monads[:result]
+
+    def fetch
+      _, stderr = Open3.capture3("sed '/todo/d' ./.rubocop.yml > tmpfile; mv tmpfile ./.rubocop.yml")
+      if stderr.length > 0
+        return Failure("Failed to remove TODO from rubocop config: #{stderr}")
+      end
+
+      stdout, stderr = Open3.capture3("bundle exec rubocop --format json")
+
+      if stderr.length > 0
+        Failure("Failed to fetch rubocop stats: #{stderr}")
+      else
+        Success(JSON.parse(stdout)["files"])
+      end
+    ensure
+      Open3.capture3("git checkout ./.rubocop.yml")
+    end
+  end
+end

data/lib/rubocop_director/runner.rb

@@ -0,0 +1,39 @@
+require "optparse"
+
+require_relative "commands/generate_config"
+require_relative "commands/plan"
+
+module RubocopDirector
+  class Runner
+    def initialize(args)
+      arg_parser.parse(args)
+      @command ||= Commands::Plan.new(@since)
+    end
+
+    def perform
+      @command.run.either(
+        ->(success_message) { puts success_message },
+        ->(failure_message) { puts "\nFailure: #{failure_message}" }
+      )
+    end
+
+    private
+
+    def arg_parser
+      OptionParser.new do |p|
+        p.on("--generate-config", "Generate default config based on .rubocop_todo.yml") do |since|
+          @command = Commands::GenerateConfig.new
+        end
+
+        p.on("--since=SINCE", "Specify date to start checking git history") do |since|
+          @since = since
+        end
+
+        p.on("--help", "Prints this help") do
+          puts p
+          exit
+        end
+      end
+    end
+  end
+end

data/lib/rubocop_director/version.rb

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

data/lib/rubocop_director.rb

@@ -0,0 +1,8 @@
+require "rubocop_director/commands/generate_config"
+require "rubocop_director/commands/plan"
+require "rubocop_director/version"
+require "rubocop_director/runner"
+
+module RubocopDirector
+  CONFIG_NAME = ".rubocop-director.yml"
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: rubocop_director
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- DmitryTsepelev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Plan your refactorings properly.
+email:
+- dmitry.a.tsepelev@gmail.com
+executables:
+- rubocop-director
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".standard.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/rubocop-director
+- lib/rubocop_director.rb
+- lib/rubocop_director/commands/generate_config.rb
+- lib/rubocop_director/commands/plan.rb
+- lib/rubocop_director/file_stats_builder.rb
+- lib/rubocop_director/git_log_stats.rb
+- lib/rubocop_director/output_formatter.rb
+- lib/rubocop_director/rubocop_stats.rb
+- lib/rubocop_director/runner.rb
+- lib/rubocop_director/version.rb
+homepage: https://github.com/DmitryTsepelev/rubocop_director
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/DmitryTsepelev/rubocop_director
+  source_code_uri: https://github.com/DmitryTsepelev/rubocop_director
+  changelog_uri: https://github.com/DmitryTsepelev/rubocop_director/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Plan your refactorings properly.
+test_files: []