Merge pull request #15 from vinnyglennon/add_rubocop_standard_linting

Add Rubocop/StandardRB linting

Author: ferrucc-io

.gitignore

@@ -16,4 +16,5 @@ coverage.data
 
 .DS_Store
 .env
-*.gem
+*.gem
+.vscode/*

.rubocop.yml

@@ -6,9 +6,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'rake', '~> 13.0'
-
 gem 'rspec', '~> 3.0'
-
 gem 'simplecov', '~> 0.22'
-
 gem 'pry'
+gem "standard"

Gemfile

@@ -9,50 +9,94 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     coderay (1.1.3)
     diff-lcs (1.5.1)
-    docile (1.4.0)
-    dotenv (2.8.1)
+    docile (1.4.1)
+    dotenv (3.1.2)
     event_stream_parser (1.0.0)
-    faraday (2.9.0)
-      faraday-net_http (>= 2.0, < 3.2)
+    faraday (2.11.0)
+      faraday-net_http (>= 2.0, < 3.4)
+      logger
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
-    faraday-net_http (3.1.0)
+    faraday-net_http (3.3.0)
       net-http
     front_matter_parser (1.0.1)
-    method_source (1.0.0)
-    multipart-post (2.4.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    lint_roller (1.1.0)
+    logger (1.6.1)
+    method_source (1.1.0)
+    multipart-post (2.4.1)
     net-http (0.4.1)
       uri
+    parallel (1.26.3)
+    parser (3.3.5.0)
+      ast (~> 2.4.1)
+      racc
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rake (13.1.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.2.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.7)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.0)
+    rspec-core (3.13.1)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    ruby-openai (6.3.1)
+    rubocop (1.65.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.4, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.32.2)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    ruby-openai (7.1.0)
       event_stream_parser (>= 0.3.0, < 2.0.0)
       faraday (>= 1)
       faraday-multipart (>= 1)
+    ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    uri (0.13.0)
+    standard (1.40.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.65.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.4)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.4.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.21.0)
+    unicode-display_width (2.5.0)
+    uri (0.13.1)
 
 PLATFORMS
   arm64-darwin-23
@@ -64,6 +108,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   simplecov (~> 0.22)
+  standard
 
 BUNDLED WITH
    2.5.6

Gemfile.lock

@@ -44,7 +44,7 @@ codegen path/to/the/file/you/want/to/test --openai_key <your_openai_key>
 ```
 
 
-5. That's it! You're ready to start generating tests for your codebase.
+5. That's it! You're ready to start generating tests for your codebase. 
 
 
 **Extra**:
@@ -80,6 +80,9 @@ CLI takes an optional openai_org_id parameter. Used to specify the organisation
 codegen path/to/the/file/you/want/to/test --openai_key <your_openai_key>  --openai_org_id <your_openai_organisation_id>
 ```
 
+## Linting 
+When testing .rb code, then Rubocop or StandardRB will automatically be applied to the generated test code, if these gems are in your GemFile. For Rubocop, a .rubocop.yml needs to be on the top-level also. If both Rubocop and StandardRB are correctly set up, only StandardRB runs against the generated test code.
+
 
 ## How it works
 

README.md

@@ -7,18 +7,17 @@ def self.run
       source_dir = File.expand_path('../../config/default/.codegen', __dir__)
       destination_dir = File.expand_path('.codegen', Dir.pwd)
 
-      FileUtils.mkdir_p(destination_dir) unless Dir.exist?(destination_dir)
+      FileUtils.mkdir_p(destination_dir)
       FileUtils.cp_r("#{source_dir}/.", destination_dir)
 
       instructions_dir = File.expand_path('instructions', destination_dir)
-      FileUtils.mkdir_p(instructions_dir) unless Dir.exist?(instructions_dir)
+      FileUtils.mkdir_p(instructions_dir)
 
       Dir.glob("#{source_dir}/instructions/*.md").each do |md_file|
         FileUtils.cp(md_file, instructions_dir)
       end
 
-      puts 'Codegen initialized.'
-      exit
+      Rails.logger.info 'Codegen initialized.'
     end
     # rubocop:enable Metrics/MethodLength
   end

lib/dotcodegen/init.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Dotcodegen
+  class LintCode
+    def initialize(file_path:)
+      @file_path = file_path
+    end
+
+    def ruby_supported?
+      @file_path.end_with? ".rb"
+    end
+
+    def run
+      if ruby_supported?
+        if gem_available?('standard')
+          standardrb_code
+
+        # Attempt to lint with RuboCop if the gem is available and .rubocop.yml exists
+        # StandardRB includes Rubocop by default. Hence the presence of .rubocop.yml is best indication that Rubocop is in active use
+        elsif gem_available?('rubocop') && rubocop_config_exists?
+          rubocop_code
+        end
+      end
+    end
+
+
+    def standardrb_code
+      puts "Linting: StandardRB"
+      system("standardrb --fix-unsafely #{@file_path}")
+    end
+
+    def rubocop_code
+      puts "Linting: Rubocop"
+      system("rubocop --autocorrect-all --disable-pending-cops #{@file_path}")
+    end
+
+    def gem_available?(name)
+      Gem::Specification.find_by_name(name)
+    rescue Gem::LoadError
+      false
+    end
+
+    # Function to check for .rubocop.yml configuration file
+    def rubocop_config_exists?
+      File.exist?('.rubocop.yml')
+    end
+  end
+end

lib/dotcodegen/lint_code.rb

@@ -2,6 +2,7 @@
 
 require 'fileutils'
 require_relative 'test_code_generator'
+require_relative 'lint_code'
 
 module Dotcodegen
   class TestFileGenerator
@@ -35,12 +36,15 @@ def ensure_test_file_presence
       File.write(test_file_path, '')
     end
 
+
     def write_generated_code_to_test_file
       generated_code = Dotcodegen::TestCodeGenerator.new(config: matcher,
                                                          file_to_test_path: file_path,
                                                          openai_key:,
                                                          openai_org_id:).generate_test_code
       File.write(test_file_path, generated_code)
+      
+      Dotcodegen::LintCode.new(file_path: test_file_path).run
     end
 
     def open_test_file_in_editor