rubocop_director 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9495c42ab7429abd8ad0cf4c31074079fba3419b9cccc56a9ab51fdd66ae3c49
-  data.tar.gz: e634bc7e5f50acedb08be3c5dbb2f2e8ea03cbda5ef9694f89e87c5943b16a8d
+  metadata.gz: b39e90da2a16a400346bb55cf128eb323ac3feb04a617d43ed791e4b2eb6cfa7
+  data.tar.gz: b358b9f928eea4ce911e837837f19ec7be09d4e6467f1601c37f9e34250367dd
 SHA512:
-  metadata.gz: 5ad6d7874bae6bc6bab004da66c96b777a24bec8f50457a7dc46aabb7b5e349bc49d52d2866e4f06c14c2ad71e9840d03c9fcc088d1d237061f80acfef3735f8
-  data.tar.gz: 8b1aeda0559907b4696f47b77a069f605816e7d25b99318bb36e54288511c859350d144ddc8469c40e8c347afb0c2c16cbd0cd956d02200974703b9decbb04f4
+  metadata.gz: 2222f3a7fe1c71f335356877a6d8b9714e7ab54f787575d7cebdbd5009658aeeeac7778f6617044abe1d3f4796627c08e0fb91106bf27b2204e2c3541821b4d2
+  data.tar.gz: 4d090d5d404844a7b6c8b3dca91e34589bcf5f2f5585b8bf580bcbf759796af4ec6c53a7c6ae382e255a892ef0f3f3116aeadba471a32c974dedc58e1d0266aa

data/CHANGELOG.md

@@ -1,5 +1,21 @@
-## [Unreleased]
+# Change log
 
-## [0.1.0] - 2023-05-08
+## master
 
-- Initial release
+## 0.3.0 (2023-06-03)
+
+- [PR #12](https://github.com/DmitryTsepelev/rubocop_director/pull/12) Added option to pass configs as args for all config files ([@samarthkathal][])
+
+## 0.2.0 (2023-06-03)
+
+- [PR #13](https://github.com/DmitryTsepelev/rubocop_director/pull/13) Prettify output formatter and change stats calculation algorithm ([@DmitryTsepelev][])
+- [PR #9](https://github.com/DmitryTsepelev/rubocop_director/pull/9) Removed sed dependency: stats generated using temp config ([@samarthkathal][])
+- [PR #8](https://github.com/DmitryTsepelev/rubocop_director/pull/8) Reorder plan flow to run expensive check first ([@DmitryTsepelev][])
+- [PR #7](https://github.com/DmitryTsepelev/rubocop_director/pull/7) GenerateConfig will a prompt to overwrite when config already exists ([@samarthkathal][])
+
+## 0.1.0 (2023-05-08)
+
+- Initial version ([@DmitryTsepelev][])
+
+[@DmitryTsepelev]: https://github.com/DmitryTsepelev
+[@samarthkathal]: https://github.com/samarthkathal

data/README.md

@@ -6,7 +6,6 @@ A command–line utility for refactoring planning. It uses `.rubocop_todo.yml` a
 
 Prerequisites:
 
-- `sed`;
 - `git` repo;
 - generated `.rubocop_todo.yml`.
 
@@ -44,21 +43,24 @@ As a result you'll get something like this:
 💡 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%)
+
+Path: app/controllers/user_controller.rb
+Updated 99 times since 2023-01-01
+Offenses:
+  🚓 Rails/SomeCop - 2
+Refactoring value: 1.5431217598108933 (54.79575%)
+
+Path: app/models/user.rb
+Updated 136 times since 2023-01-01
+Offenses:
+  🚓 Rails/SomeCop - 1
+  🚓 Rails/AnotherCop - 1
+Refactoring value: 1.2730122208719792 (45.20425%)
 ```
 
 > 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>)`.
+Value is calculated using a formula: `sum of value from each cop (<count of offences> * <cop weight> * (<count of file updates> / <total count of updates>) ** <update weight>)`.
 
 If you need to count updates from a specific date—use `--since`:
 
@@ -68,7 +70,7 @@ bundle exec rubocop-director --since=2023-01-01
 
 ## Development
 
-After checking out the repo, run `bundle insatll` to install dependencies
+After checking out the repo, run `bundle install` to install dependencies
 
 ## Contributing
 

data/lib/rubocop_director/commands/generate_config.rb

@@ -8,15 +8,45 @@ module RubocopDirector
 
       RUBOCOP_TODO = ".rubocop_todo.yml"
 
+      def initialize(director_config:)
+        @director_config_path = director_config
+        @todo_config_path = TODO_CONFIG_NAME
+      end
+
       def run
-        todo = yield load_config
+        rubocop_todo = yield load_config
+        yield check_config_already_exists
+
+        create_config(rubocop_todo)
+      end
+
+      private
 
-        weights = todo.keys.each_with_object({}).each do |cop, acc|
-          acc.merge!(cop => 1)
-        end
+      def load_config
+        Success(YAML.load_file(@todo_config_path))
+      rescue Errno::ENOENT
+        Failure("#{@todo_config_path} not found, generate it using `rubocop --regenerate-todo`")
+      end
+
+      def check_config_already_exists
+        return Success() if config_not_exists? || override_config?
+
+        Failure("previous version of #{@director_config_path} was preserved.")
+      end
 
-        # TODO: warn if file exists
-        File.write(".rubocop-director.yml", {
+      def config_not_exists?
+        !File.file?(@director_config_path)
+      end
+
+      def override_config?
+        puts("#{@director_config_path} already exists, do you want to override it? (y/n)")
+        $stdin.gets.chomp == "y"
+      end
+
+      def create_config(rubocop_todo)
+        weights = rubocop_todo.keys.to_h { |key| [key, 1] }
+
+        File.write(@director_config_path, {
           "update_weight" => 1,
           "default_cop_weight" => 1,
           "weights" => weights
@@ -24,14 +54,6 @@ module RubocopDirector
 
         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

@@ -14,14 +14,16 @@ module RubocopDirector
       include Dry::Monads[:result]
       include Dry::Monads::Do.for(:run)
 
-      def initialize(since)
-        @since = since || "1995-01-01"
+      def initialize(director_config:, rubocop_config:, since: "1995-01-01")
+        @since = since.to_s
+        @director_config_path = director_config
+        @rubocop_config_path = rubocop_config
       end
 
       def run
         config = yield load_config
-        update_counts = yield load_git_stats
         rubocop_json = yield load_rubocop_json
+        update_counts = yield load_git_stats
         ranged_files = yield range_files(rubocop_json: rubocop_json, update_counts: update_counts, config: config)
 
         OutputFormatter.new(ranged_files: ranged_files, since: @since).call
@@ -30,24 +32,24 @@ module RubocopDirector
       private
 
       def load_config
-        Success(YAML.load_file(CONFIG_NAME))
+        Success(YAML.load_file(@director_config_path))
       rescue Errno::ENOENT
-        Failure("#{CONFIG_NAME} not found, generate it using `rubocop-director --generate-config`")
+        Failure("#{@director_config_path} 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
+      def load_rubocop_json
+        puts "💡 Running rubocop to get the list of offences to fix..."
+        RubocopStats.new(@rubocop_config_path).fetch
       end
 
-      def load_rubocop_json
-        puts "💡🎥 Running rubocop to get the list of offences to fix..."
-        RubocopStats.new.fetch
+      def load_git_stats
+        puts "💡🎥 Checking git history since #{@since} to find hot files..."
+        GitLogStats.new(@since).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
+        FileStatsBuilder.new(rubocop_json: rubocop_json, update_counts: update_counts, config: config).build
       end
     end
   end

data/lib/rubocop_director/file_stats_builder.rb

@@ -10,6 +10,8 @@ module RubocopDirector
     end
 
     def build
+      update_weight = yield fetch_update_weight
+
       file_stats = files_with_offenses.map do |file|
         stats = {
           path: file["path"],
@@ -17,11 +19,17 @@ module RubocopDirector
           offense_counts: file["offenses"].group_by { |offense| offense["cop_name"] }.transform_values(&:count)
         }
 
-        stats[:value] = yield find_refactoring_value(stats)
+        stats[:cop_value] = yield find_refactoring_value(stats)
 
         stats
       end
 
+      total_updates_count = file_stats.sum { |f| f[:updates_count] }
+
+      file_stats = file_stats.each do |stats|
+        stats[:value] = stats[:cop_value] * ((stats[:updates_count] / total_updates_count.to_f)**update_weight)
+      end
+
       Success(file_stats.sort_by { _1[:value] }.reverse)
     end
 
@@ -32,14 +40,12 @@ module RubocopDirector
     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|
+      value = 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)
+      Success(value)
     end
 
     def fetch_cop_weight(cop_name)

data/lib/rubocop_director/output_formatter.rb

@@ -15,11 +15,13 @@ module RubocopDirector
 
     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)}%)"
+        result << ""
+
+        result << "Path: #{file[:path]}"
+        result << "Updated #{file[:updates_count]} times since #{@since}"
+        result << "Offenses:"
+        file[:offense_counts].each { |cop, count| result << "  🚓 #{cop} - #{count}" }
+        result << "Refactoring value: #{file[:value]} (#{(100 * file[:value] / total_value.to_f).round(5)}%)"
       end
 
       Success(result)

data/lib/rubocop_director/rubocop_stats.rb

@@ -7,22 +7,52 @@ require "dry/monads"
 module RubocopDirector
   class RubocopStats
     include Dry::Monads[:result]
+    include Dry::Monads::Do.for(:fetch)
+
+    TEMP_CONFIG_PATH = "./.temp_rubocop.yml"
+
+    def initialize(rubocop_path)
+      @rubocop_path = rubocop_path
+    end
 
     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
+      config = yield load_config
+      yield generate_temp_rubocop_config_without_todo(initial_config: config)
+
+      stats = yield generate_stats
+      yield remove_temp_config
+
+      Success(stats)
+    end
 
-      stdout, stderr = Open3.capture3("bundle exec rubocop --format json")
+    private
+
+    def load_config
+      Success(YAML.load_file(@rubocop_path))
+    rescue Errno::ENOENT
+      Failure("unable to load rubocop config. Please ensure .rubocop.yml file is present at your project's root directory")
+    end
+
+    def generate_temp_rubocop_config_without_todo(initial_config:)
+      initial_config.dig("inherit_from")&.delete(".rubocop_todo.yml")
+
+      Success(File.write(TEMP_CONFIG_PATH, initial_config.to_yaml))
+    rescue IOError => e
+      Failure("Failed to create a temporary config file to generate stats: #{e}")
+    end
+
+    def generate_stats
+      stdout, stderr = Open3.capture3("bundle exec rubocop -c #{TEMP_CONFIG_PATH} --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
+
+    def remove_temp_config
+      Success(File.delete(TEMP_CONFIG_PATH))
     end
   end
 end

data/lib/rubocop_director/runner.rb

@@ -1,4 +1,5 @@
 require "optparse"
+require "optparse/date"
 
 require_relative "commands/generate_config"
 require_relative "commands/plan"
@@ -6,12 +7,13 @@ require_relative "commands/plan"
 module RubocopDirector
   class Runner
     def initialize(args)
-      arg_parser.parse(args)
-      @command ||= Commands::Plan.new(@since)
+      @options = {}
+      arg_parser.parse(args, into: @options)
+      verify_options
     end
 
     def perform
-      @command.run.either(
+      command.run.either(
         ->(success_message) { puts success_message },
         ->(failure_message) { puts "\nFailure: #{failure_message}" }
       )
@@ -19,15 +21,43 @@ module RubocopDirector
 
     private
 
+    def verify_options
+      @options[:rubocop_config] = verified_path(config_name: RUBOCOP_CONFIG_NAME, path: @options[:rubocop_config])
+      @options[:director_config] = verified_path(config_name: CONFIG_NAME, path: @options[:director_config])
+    end
+
+    def verified_path(config_name:, path:)
+      path = project_root if path.nil?
+      path.directory? ? path + config_name : path
+    end
+
+    def project_root
+      return Rails.root if defined?(Rails)
+      return Bundler.root if defined?(Bundler)
+
+      Pathname.new(Dir.pwd)
+    end
+
+    def command
+      @command ||= if @options[:generate_config]
+        Commands::GenerateConfig.new(**@options.slice(:director_config))
+      else
+        Commands::Plan.new(**@options.slice(:since, :director_config, :rubocop_config))
+      end
+    end
+
     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
+        p.accept(Pathname) do |s|
+          Pathname.new(s)
+        rescue ArgumentError, TypeError
+          raise OptionParser::InvalidArgument, s
         end
 
-        p.on("--since=SINCE", "Specify date to start checking git history") do |since|
-          @since = since
-        end
+        p.on("--generate_config", "Generate default config based on .rubocop_todo.yml")
+        p.on("--since=SINCE", Date, "Specify date to start checking git history")
+        p.on("--director_config=PATH", Pathname, "Specify path where .rubocop_director.yml config must be read from OR written to, default path: {PROJECTROOT}/.rubocop_director.yml")
+        p.on("--rubocop_config=PATH", Pathname, "Specify path where .rubocop.yml config must be read from, default path: {PROJECTROOT}/.rubocop.yml")
 
         p.on("--help", "Prints this help") do
           puts p

data/lib/rubocop_director/version.rb

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

data/lib/rubocop_director.rb

@@ -4,5 +4,7 @@ require "rubocop_director/version"
 require "rubocop_director/runner"
 
 module RubocopDirector
-  CONFIG_NAME = ".rubocop-director.yml"
+  CONFIG_NAME = ".rubocop_director.yml"
+  RUBOCOP_CONFIG_NAME = ".rubocop.yml"
+  TODO_CONFIG_NAME = ".rubocop_todo.yml"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_director
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-13 00:00:00.000000000 Z
+date: 2023-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads