linter_changes 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 51419ad25d4ed787015da7a0e24ba91cf7e5ccfbaedc7fa30fb444e60342ce34
+  data.tar.gz: 2cd1208664fcc6e82c499fb95808d1091181c6fddfe10f712c3d5cf9b9a51f19
+SHA512:
+  metadata.gz: 41f118035e002bd8211a7678b09e888df1cd460878c39d17e09cca1a9ac956ed1f06f1f6c5092489a605c58dfe3eeb45cebd0f5eb80afd1a5651e1e92e9c9df9
+  data.tar.gz: 581696d673db1788efbc256b5d9018ada57ba134e2999574179a82e27c248fba23f5ced757640796f9c3edafc109324f1d707990fa5ac1628cece901fcf152bf

data/README.md

@@ -0,0 +1,157 @@
+# LinterChanges
+
+LinterChanges is a Ruby gem that runs linters on files changed between your current branch and a target branch (e.g., `master`). It helps maintain code quality by ensuring that only the changed files are linted, saving time and resources.
+
+**What sets LinterChanges apart from other tools like Pronto is that it checks entire files rather than just the changed lines when raising errors. Additionally, if configuration changes for the linter occur, LinterChanges will run the linter on the entire repository, not just on the current changes.**
+
+Currently, **LinterChanges** supports **RuboCop** for Ruby code. Support for additional linters can be added in the future.
+
+---
+
+## Table of Contents
+
+- [LinterChanges](#linterchanges)
+  - [Table of Contents](#table-of-contents)
+  - [Installation](#installation)
+  - [Usage](#usage)
+    - [Basic Usage](#basic-usage)
+    - [Specifying the Target Branch](#specifying-the-target-branch)
+    - [Customizing RuboCop Configuration](#customizing-rubocop-configuration)
+  - [Contributing](#contributing)
+  - [Running the test suite](#running-the-test-suite)
+  - [Acknowledgments](#acknowledgments)
+
+---
+
+## Installation
+
+Add this line to your application's `Gemfile`:
+
+```ruby
+gem 'linter_changes', git: 'https://github.com/bukhr/linter_changes.git'
+```
+
+```bash
+bundle install
+```
+---
+
+## Usage
+
+LinterChanges provides a command-line interface (CLI) to run RuboCop on the files changed between your current branch and the target branch.
+
+### Basic Usage
+
+By default, LinterChanges will:
+
+- Compare your current branch with the `main` branch.
+- Run the linters on the changed files that linter listen to.
+
+**Command:**
+
+```bash
+bin/linter_changes lint
+```
+
+**Example Output:**
+
+```
+Running RuboCop linter
+Linting files with RuboCop: app/models/user.rb, app/controllers/users_controller.rb
+Inspecting 2 files
+..
+
+2 files inspected, no offenses detected
+```
+
+### Specifying the Target Branch
+
+If you want to compare against a different branch, you can specify it using the `--target-branch` option.
+
+**Command:**
+
+```bash
+bin/linter_changes lint --target-branch origin/master
+```
+
+This will compare your current branch with the `origin/master` branch.
+
+### Customizing RuboCop Configuration
+
+You can customize the RuboCop configuration files and command options.
+
+**Specify Custom Config Files:**
+
+Note: each config file passed is interpreted as regex on the full file path
+
+```bash
+bin/linter_changes lint --config-files rubocop:rubocop,custom_rubocop.yml
+```
+
+**Specify Custom RuboCop Command:**
+
+```bash
+bin/linter_changes lint --linter-command rubocop:"rubocop --parallel"
+```
+
+**Combining Both:**
+
+```bash
+bin/linter_changes lint \
+  --config-files rubocop:.rubocop.yml,custom_rubocop.yml \
+  --linter-command rubocop:"rubocop --parallel"
+```
+
+---
+
+## Contributing
+
+Contributions are welcome! If you'd like to contribute, please follow these steps:
+
+1. Fork the repository.
+2. Create a new branch:
+
+   ```bash
+   git checkout -b feature/your_feature_name
+   ```
+
+3. Make your changes.
+4. Commit your changes:
+
+   ```bash
+   git commit -m "Add your commit message"
+   ```
+
+5. Push to your branch:
+
+   ```bash
+   git push origin feature/your_feature_name
+   ```
+
+6. Open a pull request on GitHub.
+
+---
+
+## Running the test suite
+
+```bash
+bundle exec rake test
+```
+
+---
+
+## Acknowledgments
+
+- [RuboCop](https://github.com/rubocop/rubocop) - The Ruby static code analyzer and formatter.
+- [Thor](https://github.com/erikhuda/thor) - A toolkit for building powerful command-line interfaces.
+
+---
+
+**Note:** Currently, LinterChanges supports only RuboCop for linting Ruby files. Support for additional linters may be added in the future.
+
+**Key Features:**
+
+- **Full File Linting:** Unlike tools like Pronto that only check the changed lines, LinterChanges lints the entire files that have been modified. This ensures that any issues in the modified files are caught, not just those in the changed lines.
+- **Configuration Change Detection:** If a configuration file for the linter (e.g., `.rubocop.yml`) has changed, LinterChanges will run the linter on the entire repository. This ensures that any new or altered linting rules are applied across all files.
+
+---

data/bin/linter_changes

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require_relative '../lib/cli'
+
+LinterChanges::CLI.start(ARGV)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/cli.rb

@@ -0,0 +1,89 @@
+# lib/linter_changes/cli.rb
+
+require 'bundler/setup'
+require 'thor'
+require_relative 'git_diff'
+require_relative 'logger'
+require_relative 'linter/base'
+require_relative 'linter/rubocop/adapter'
+require 'pry-byebug'
+
+module LinterChanges
+  class CLI < Thor
+    class_option :debug, type: :boolean, default: false, desc: 'Enable debug mode'
+    class_option :target_branch, type: :string, default: nil, desc: 'Specify the target branch'
+
+    desc 'lint', 'Run linters on changed files'
+    method_option :linters, type: :array, default: [], desc: 'Specify linters to run (e.g., rubocop,eslint)'
+    method_option :config_files, type: :hash, default: {},
+                                 desc: 'Specify config files per linter (e.g., rubocop=.rubocop.yml)'
+    method_option :linter_command, type: :hash, default: {},
+                                   desc: 'Specify command per linter (e.g., rubocop="rubocop --parallel")'
+    def lint
+      Logger.debug_mode = options[:debug]
+
+      git_diff = GitDiff.new(target_branch: options[:target_branch])
+      changed_files = git_diff.changed_files
+      linters = select_linters git_diff
+      overall_success = true
+
+      linters.each do |linter|
+        Logger.debug "Running #{linter.name.capitalize} linter"
+        if linter.config_changed?(changed_files)
+          Logger.debug "#{linter.name.capitalize} configuration changed. Running linter globally."
+          success = linter.run
+        else
+          files_to_lint = linter.list_target_files & changed_files
+          if files_to_lint.empty?
+            Logger.debug "No files to lint for #{linter.name.capitalize}."
+            next
+          else
+            Logger.debug "Linting files with #{linter.name.capitalize}: #{files_to_lint.join(', ')}"
+            success = linter.run(files: files_to_lint)
+          end
+        end
+
+        overall_success &&= success
+      end
+
+      exit(overall_success ? 0 : 1)
+    end
+
+    def self.exit_on_failure?
+      true
+    end
+
+    no_commands do
+      def select_linters git_diff
+        linter_names = if options[:linters].empty?
+                         AVAILABLE_LINTERS.keys
+                       else
+                         options[:linters]
+                       end
+        linter_names.map do |name|
+          klass = AVAILABLE_LINTERS[name]
+          unless klass
+            Logger.error "Unknown linter specified: #{name}"
+            exit 1
+          end
+
+          # Pass custom config files and commands if provided
+          config_files = parse_config_files_option(name)
+          command = options[:linter_command][name]
+          klass.new(config_files:, command:, git_diff:)
+        end
+      end
+
+      def parse_config_files_option(linter_name)
+        config_files_option = options[:config_files][linter_name]
+        return nil unless config_files_option
+
+        config_files_option.split(',')
+      end
+    end
+
+    AVAILABLE_LINTERS = {
+      'rubocop' => LinterChanges::Linter::RuboCop::Adapter
+    }.freeze
+  end
+end

data/lib/git_diff.rb

@@ -0,0 +1,39 @@
+# lib/your_linter_gem/git_diff.rb
+
+require 'open3'
+
+module LinterChanges
+  class GitDiff
+    DEFAULT_TARGET_BRANCH = 'origin/master'
+
+    def initialize(target_branch: nil)
+      @target_branch = target_branch || ENV['CHANGE_TARGET'] || DEFAULT_TARGET_BRANCH
+      Logger.debug "Target branch: #{@target_branch}"
+    end
+
+    def changed_files
+      cmd = "git diff --name-only #{@target_branch}...HEAD"
+      Logger.debug "Executing command: #{cmd}"
+
+      stdout, stderr, status = Open3.capture3(cmd)
+      unless status.success?
+        Logger.error "Error obtaining git changes: #{stderr}"
+        exit 1
+      end
+
+      files = stdout.strip.split("\n")
+      Logger.debug "Changed files: #{files.join(', ')}"
+      files
+    end
+
+    def changed_lines_contains? file:, pattern:
+      cmd = "git diff #{@target_branch}...HEAD -- #{file}"
+      stdout, stderr, status = Open3.capture3(cmd)
+      unless status.success?
+        Logger.error "Error obtaining git diff for #{file}: #{stderr}"
+        exit 1
+      end
+      stdout.include? pattern
+    end
+  end
+end

data/lib/linter/base.rb

@@ -0,0 +1,46 @@
+# lib/linter_changes/linter/base.rb
+
+module LinterChanges
+  module Linter
+    class Base
+      attr_reader :name
+
+      def initialize(config_files: nil, command: nil, git_diff: nil)
+        @name = self.class.name.split('::')[-2].downcase
+        default_config_file = YAML.load_file("lib/linter/#{@name}/default_config.yml")
+        @config_files = config_files || default_config_file['config_files']
+        @command = command || default_config_file['command']
+        @git_diff = git_diff
+      end
+
+      # Returns an array of files that the linter targets
+      def list_target_files
+        raise NotImplementedError, "#{self.class} must implement #list_target_files"
+      end
+
+      # Checks if any configuration files have changed
+      def config_changed?(changed_files)
+        changed = @config_files.any? do |pattern|
+          changed_files.any? { |file| file.match? Regexp.new(pattern) }
+        end
+        Logger.debug "#{@name.capitalize} configuration changed: #{changed}"
+        changed
+      end
+
+      # Runs the linter on the specified files
+      def run(files: [])
+        raise NotImplementedError, "#{self.class} must implement #run"
+      end
+
+      private
+
+      def default_config_files
+        raise NotImplementedError, "#{self.class} must implement #default_config_files"
+      end
+
+      def default_command
+        raise NotImplementedError, "#{self.class} must implement #default_command"
+      end
+    end
+  end
+end

data/lib/linter/rubocop/adapter.rb

@@ -0,0 +1,64 @@
+# lib/linter_changes/linter/rubocop/adapter.rb
+
+module LinterChanges
+  module Linter
+    module RuboCop
+      class Adapter < Base
+        # By default, anything containing rubocop on the file path will be consider a config file
+        DEFAULT_CONFIG_FILES = [/rubocop/].freeze
+        DEFAULT_COMMAND = 'bin/rubocop'.freeze
+
+        def list_target_files
+          cmd = "#{DEFAULT_COMMAND} --list-target-files"
+          Logger.debug "Executing command: #{cmd}"
+
+          stdout, stderr, status = Open3.capture3(cmd)
+          unless status.success?
+            Logger.error "Error listing RuboCop target files: #{stderr}"
+            exit 1
+          end
+
+          stdout.strip.split("\n")
+        end
+
+        def run(files: [])
+          cmd = if files.empty?
+                  @command
+                else
+                  "#{@command} #{files.join(' ')}"
+                end
+          execute_linter(cmd)
+        end
+
+        def config_changed?(changed_files)
+          # Check if any of the config files have changed
+          return true if super
+
+          # TODO: get the location of Gemfile.lock with bundle command
+          # Check if Gemfile.lock has changed and contains something related to rubocop
+          if changed_files.include?('Gemfile.lock') && @git_diff.changed_lines_contains?(file: 'Gemfile.lock',
+                                                                                        pattern: 'rubocop')
+            Logger.debug 'Something related to rubocop gem version changed in Gemfile.lock'
+            return true
+          end
+          false
+        end
+
+        private
+
+        def default_config_files
+          DEFAULT_CONFIG_FILES
+        end
+
+        def default_command
+          DEFAULT_COMMAND
+        end
+
+        def execute_linter(command)
+          Logger.debug "Executing RuboCop command: #{command}"
+          system(command)
+        end
+      end
+    end
+  end
+end

data/lib/linter/rubocop/default_config.yml

@@ -0,0 +1,5 @@
+---
+# Only regex supported
+config_files:
+  - rubocop
+command: bin/rubocop

data/lib/logger.rb

@@ -0,0 +1,17 @@
+# lib/your_linter_gem/logger.rb
+
+module LinterChanges
+  class Logger
+    class << self
+      attr_accessor :debug_mode
+
+      def debug(message)
+        puts "[DEBUG] #{message}" if debug_mode
+      end
+
+      def error(message)
+        puts "[ERROR] #{message}"
+      end
+    end
+  end
+end

data/lib/version.rb

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

metadata

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: linter_changes
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jose Lara
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: open3
+  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: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.24.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.24.1
+- !ruby/object:Gem::Dependency
+  name: mocha
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.63.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.63.4
+- !ruby/object:Gem::Dependency
+  name: shoulda-context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+description: 
+email:
+- jvlara@uc.cl
+executables:
+- linter_changes
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/linter_changes
+- bin/setup
+- lib/cli.rb
+- lib/git_diff.rb
+- lib/linter/base.rb
+- lib/linter/rubocop/adapter.rb
+- lib/linter/rubocop/default_config.yml
+- lib/logger.rb
+- lib/version.rb
+homepage: https://github.com/bukhr/linter_changes
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.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: Runs linters on code changes based on Git, either globally or only on modified
+  files, depending on the changes.
+test_files: []