rubocop_director 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06b576908b0f9b2cf1470350c38e53c7339caca11fb7abca712909feac9508f7
-  data.tar.gz: 2087b4e9a5002c5a2c2294a573426def90556ec98866c07421b67355d928fc24
+  metadata.gz: b39e90da2a16a400346bb55cf128eb323ac3feb04a617d43ed791e4b2eb6cfa7
+  data.tar.gz: b358b9f928eea4ce911e837837f19ec7be09d4e6467f1601c37f9e34250367dd
 SHA512:
-  metadata.gz: c798e0ac5e7b7b53339bc0ec001d5165f4bcbe794952f0a297b70cba7ca5cba1fdffd3ea88395e177c72e5d43bc19afe4f56e02e7b77994e56f4e698d77b0dc1
-  data.tar.gz: d46b526303bd4930b5a4b4e9d63054d08ae472ed813bb1fbf366ccd08c18f873a8f1e9b1b8cbb7b357abce89face540b22ca66bf406db56f9130a5878d646479
+  metadata.gz: 2222f3a7fe1c71f335356877a6d8b9714e7ab54f787575d7cebdbd5009658aeeeac7778f6617044abe1d3f4796627c08e0fb91106bf27b2204e2c3541821b4d2
+  data.tar.gz: 4d090d5d404844a7b6c8b3dca91e34589bcf5f2f5585b8bf580bcbf759796af4ec6c53a7c6ae382e255a892ef0f3f3116aeadba471a32c974dedc58e1d0266aa

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## master
 
+## 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][])

data/lib/rubocop_director/commands/generate_config.rb

@@ -8,6 +8,11 @@ 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
         rubocop_todo = yield load_config
         yield check_config_already_exists
@@ -18,30 +23,30 @@ module RubocopDirector
       private
 
       def load_config
-        Success(YAML.load_file(RUBOCOP_TODO))
+        Success(YAML.load_file(@todo_config_path))
       rescue Errno::ENOENT
-        Failure("#{RUBOCOP_TODO} not found, generate it using `rubocop --regenerate-todo`")
+        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 #{CONFIG_NAME} was preserved.")
+        Failure("previous version of #{@director_config_path} was preserved.")
       end
 
       def config_not_exists?
-        !File.file?(CONFIG_NAME)
+        !File.file?(@director_config_path)
       end
 
       def override_config?
-        puts("#{CONFIG_NAME} already exists, do you want to override it? (y/n)")
-        gets.chomp == "y"
+        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(CONFIG_NAME, {
+        File.write(@director_config_path, {
           "update_weight" => 1,
           "default_cop_weight" => 1,
           "weights" => weights

data/lib/rubocop_director/commands/plan.rb

@@ -14,8 +14,10 @@ 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
@@ -30,14 +32,14 @@ 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_rubocop_json
         puts "💡 Running rubocop to get the list of offences to fix..."
-        RubocopStats.new.fetch
+        RubocopStats.new(@rubocop_config_path).fetch
       end
 
       def load_git_stats

data/lib/rubocop_director/rubocop_stats.rb

@@ -11,6 +11,10 @@ module RubocopDirector
 
     TEMP_CONFIG_PATH = "./.temp_rubocop.yml"
 
+    def initialize(rubocop_path)
+      @rubocop_path = rubocop_path
+    end
+
     def fetch
       config = yield load_config
       yield generate_temp_rubocop_config_without_todo(initial_config: config)
@@ -24,7 +28,7 @@ module RubocopDirector
     private
 
     def load_config
-      Success(YAML.load_file("./.rubocop.yml"))
+      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

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.2.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.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - DmitryTsepelev
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-03 00:00:00.000000000 Z
+date: 2023-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-monads