typocop 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 73d0256f21e87ac1bba922c625fcf8e4a8414a92cac575fb0e8d37d2a88e2c7c
+  data.tar.gz: b99668b71119931d91308efd71654921cbafa341af1193d3e00e2ee1599c93cd
+SHA512:
+  metadata.gz: bbab9f5f5bb23893e1b3b7dfae39919b149a8d4455c803cfc379c44c82d1ad014c4e0e7dc2ae2b532d4ebe79c9f7e5787af12b8bfda8c4795a9bfdad9ab0cf65
+  data.tar.gz: a5812be1b939d0fa9ac9345a230511cbcc9a438e8ccfe8950c57821f2d4e5b115f61778c1a1d3bd6515447f5c8e432d71e75f9bdf8540450ecf8d4db1e1d19b2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2022] [datpmt]
+
+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,36 @@
+# Check Typos in Pull Request
+
+![image](https://github.com/user-attachments/assets/bbcdcedb-cf0b-4cc0-959a-fe5caa71f833)
+
+This GitHub Action automatically checks for typos in the files changed in a pull request. It comments on the pull request with any detected typos and provides suggestions for corrections.
+
+## Features
+
+- Detects typos in files that are part of the pull request.
+- Provides a brief output of typos found in each file.
+- Comments on the pull request with the results.
+- Supports all programing languages.
+
+## Usage
+
+- Copy content `.github/workflows/typos-check.yml` and `typos-check.js` into your project.
+- Create new PR.
+
+## Contributors
+
+- [datpmt](https://github.com/datpmt)
+
+I welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b your-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin your-feature`).
+5.  Create a new pull request.
+
+## References
+1. https://github.com/crate-ci/typos
+2. https://github.com/prontolabs/pronto
+
+## License
+The gem is available as open source under the terms of the [MIT License](LICENSE).

data/bin/typocop

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'typocop/cli'
+Typocop::CLI.start(ARGV)

data/lib/typocop/cli.rb

@@ -0,0 +1,11 @@
+require 'thor'
+
+module Typocop
+  class CLI < Thor
+    require 'typocop'
+    desc 'execute', 'Run typocop'
+    def execute
+      Typocop.execute
+    end
+  end
+end

data/lib/typocop/client.rb

@@ -0,0 +1,193 @@
+module Typocop
+  class Client
+    attr_reader :pull_comments, :repo
+
+    def initialize(repo)
+      @client = Octokit::Client.new(
+        api_endpoint: 'https://api.github.com/',
+        web_endpoint: 'https://github.com/',
+        access_token: GITHUB_TOKEN,
+        auto_paginate: true
+      )
+      @repo = repo
+      @repo_name = @repo.name
+
+      pull_comments = @client.pull_request_comments(@repo_name, PULL_ID)
+      @pull_comments = pull_comments.map do |comment|
+        Comment.new(comment.id, comment.path, comment.line, comment.body, comment.user.login)
+      end
+    end
+
+    def execute(cops)
+      current_cops = current_cops(cops)
+      if current_cops.empty?
+        delete_all_comments
+        accept_pull_request
+      else
+        dismiss_accept_pull_request
+        delete_comments(current_cops)
+        create_comments(current_cops)
+      end
+    end
+
+    private
+
+    def pull_request
+      @pull_request ||= @client.pull_request(@repo_name, PULL_ID)
+    end
+
+    def commit_id
+      @commit_id ||= pull_request.head.sha
+    end
+
+    def current_cops(cops)
+      result_cops = []
+      common_paths = common_paths(cops)
+      common_paths.each do |path|
+        patch_by_path = patch_by_path(path)
+        cops_by_path = cops_by_path(cops, path)
+        cops_lines = patch_by_path.added_lines.map(&:new_lineno) & cops_by_path.map(&:line)
+        next if cops_lines.empty?
+
+        result_cops.concat(cops_by_path.select { |cop| cops_lines.include?(cop.line) })
+      end
+
+      result_cops
+    end
+
+    def common_paths(cops)
+      @repo.patch_additions.map(&:path) & cops.map(&:path)
+    end
+
+    def patch_by_path(path)
+      @repo.patch_additions.find { |patch| patch.path == path }
+    end
+
+    def cops_by_path(cops, path)
+      cops.select { |cop| cop.path == path }
+    end
+
+    def create_comments(cops)
+      cops.each do |cop|
+        next if exist_comment?(cop)
+
+        line_content = line_content(cop)
+        suggestion_content = suggestion_content(line_content, cop.typos)
+
+        body = <<~BODY
+          ```suggestion
+          #{suggestion_content}```
+          #{suggestion_comment(cop.typos)}
+        BODY
+
+        create_comment(body, cop.path, cop.line)
+      end
+    end
+
+    def suggestion_content(content, typos)
+      typos.each do |typo|
+        content.gsub!(typo[:incorrect_word], typo[:correct_word])
+      end
+      content
+    end
+
+    def suggestion_comment(typos)
+      comment = typos.map do |typo|
+        "`#{typo[:incorrect_word]}` with `#{typo[:correct_word]}`"
+      end
+      "Should replace #{comment.join(', ')}."
+    end
+
+    def line_content(cop)
+      patch = @repo.patch_additions.find { |patch| patch.path == cop.path }
+      patch.added_lines.find { |line| line.new_lineno == cop.line }.content
+    end
+
+    def create_comment(body, path, line)
+      @client.create_pull_request_comment(
+        @repo_name,
+        PULL_ID,
+        body,
+        commit_id,
+        path,
+        line,
+        side: 'RIGHT'
+      )
+      puts "create comment: #{path}:#{line}"
+    end
+
+    def exist_comment?(cop)
+      own_comments.any? do |comment|
+        comment.path == cop.path &&
+          comment.line == cop.line &&
+          !(comment.body.split('`') & cop.incorrect_words).empty?
+      end
+    end
+
+    def user_login
+      @user_login ||= begin
+        @client.user.login
+      rescue Octokit::Forbidden
+        'github-actions[bot]'
+      end
+    end
+
+    def own_comments
+      @own_comments ||= @pull_comments.select { |comment| comment.user_login == user_login }
+    end
+
+    def delete_comments(cops)
+      own_comments.each do |comment|
+        delete_comment(comment) if should_delete?(comment, cops)
+      end
+    end
+
+    def should_delete?(comment, cops)
+      cops.none? do |cop|
+        cop.path == comment.path &&
+          cop.line == comment.line &&
+          !(cop.incorrect_words & comment.body.split('`')).empty?
+      end
+    end
+
+    def delete_comment(comment)
+      @client.delete_pull_comment(@repo_name, comment.id)
+      puts "delete comment: #{comment.path}:#{comment.line}"
+    end
+
+    def delete_all_comments
+      own_comments.each do |comment|
+        delete_comment(comment)
+      end
+    end
+
+    def accept_pull_request
+      @client.create_pull_request_review(
+        @repo_name,
+        PULL_ID,
+        event: 'APPROVE'
+      )
+    rescue Octokit::UnprocessableEntity => e
+      puts e
+    end
+
+    def pull_request_reviews
+      @pull_request_reviews ||= @client.pull_request_reviews(@repo_name, PULL_ID)
+    end
+
+    def own_pull_request_review
+      @own_pull_request_review ||= pull_request_reviews.find do |review|
+        review.state == 'APPROVED' &&
+          review.user.login == user_login
+      end
+    end
+
+    def dismiss_accept_pull_request
+      return unless own_pull_request_review
+
+      review_id = own_pull_request_review.id
+      message = 'Found new typos.'
+      @client.dismiss_pull_request_review(@repo_name, PULL_ID, review_id, message)
+    end
+  end
+end

data/lib/typocop/comment.rb

@@ -0,0 +1,13 @@
+module Typocop
+  class Comment
+    attr_reader :id, :path, :line, :body, :user_login
+
+    def initialize(id, path, line, body, user_login)
+      @id = id
+      @path = path
+      @line = line
+      @body = body
+      @user_login = user_login
+    end
+  end
+end

data/lib/typocop/cop.rb

@@ -0,0 +1,19 @@
+module Typocop
+  class Cop
+    attr_reader :path, :line, :typos
+
+    def initialize(path, line, typos)
+      @path = path
+      @line = line
+      @typos = typos
+    end
+
+    def incorrect_words
+      @typos.map { |typo| typo[:incorrect_word] }
+    end
+
+    def correct_words
+      @typos.map { |typo| typo[:correct_word] }
+    end
+  end
+end

data/lib/typocop/cops.rb

@@ -0,0 +1,11 @@
+module Typocop
+  class Cops
+    attr_reader :path, :line, :cops
+
+    def initialize(cops_data)
+      @cops = cops_data.map do |data|
+        Cop.new(data[:path], data[:line], data[:typos])
+      end
+    end
+  end
+end

data/lib/typocop/patch.rb

@@ -0,0 +1,11 @@
+module Typocop
+  class Patch
+    attr_reader :path, :lines, :added_lines
+
+    def initialize(path, lines, added_lines)
+      @path = path
+      @lines = lines
+      @added_lines = added_lines
+    end
+  end
+end

data/lib/typocop/repo.rb

@@ -0,0 +1,49 @@
+module Typocop
+  class Repo
+    attr_reader :patch_additions
+
+    def initialize(path = '.')
+      @repo = Rugged::Repository.new(path)
+      patch_additions = diff.select { |patch| patch.additions.positive? }
+      @patch_additions = patch_additions.map do |patch|
+        path = patch.delta.new_file[:path]
+        lines = patch.hunks.flat_map(&:lines)
+        added_lines = lines.select(&:addition?)
+        Patch.new(path, lines, added_lines)
+      end
+    end
+
+    def name
+      match = %r{(?:https?://)?(?:www\.)?github\.com[/:](?<repo_name>.*?)(?:\.git)?\z}.match(remote_url)
+      match[:repo_name]
+    end
+
+    def remote_url
+      @repo.remotes.first.url
+    end
+
+    def head
+      @repo.head
+    end
+
+    def head_target
+      head.target
+    end
+
+    def merge_base
+      @repo.merge_base(BASE_BRANCH, head_target)
+    end
+
+    def diff
+      @repo.diff(merge_base, head_target)
+    end
+
+    def target_id
+      head.target_id
+    end
+
+    def target_oid
+      head_target.oid
+    end
+  end
+end

data/lib/typocop.rb

@@ -0,0 +1,60 @@
+require 'rugged'
+# require 'pry'
+require 'octokit'
+
+require 'typocop/cli'
+require 'typocop/client'
+require 'typocop/comment'
+require 'typocop/cop'
+require 'typocop/cops'
+require 'typocop/patch'
+require 'typocop/repo'
+
+GITHUB_TOKEN = ENV['GITHUB_TOKEN'] || ''
+PULL_ID = ENV['PULL_REQUEST_ID']
+GITHUB_BASE_REF = ENV['GITHUB_BASE_REF'] || 'main'
+BASE_BRANCH = GITHUB_BASE_REF.start_with?('origin/') ? GITHUB_BASE_REF : "origin/#{GITHUB_BASE_REF}"
+
+module Typocop
+  def self.execute
+    typo_outputs = `typos --format brief`
+    typo_outputs = typo_outputs.split("\n")
+
+    if typo_outputs.empty?
+      puts 'No typo output.'
+    else
+      result = typo_outputs.each_with_object({}) do |output, hash|
+        path, line, _column, typo_detail = output.split(':')
+        typo_match = /`(.*?)` -> `(.*?)`/.match(typo_detail)
+        incorrect_word, correct_word = typo_match ? typo_match.captures : []
+
+        path = path.start_with?('./') ? path[2..] : path
+        line = line.to_i
+
+        hash[path] ||= {}
+
+        hash[path][:typos] ||= []
+
+        existing_entry = hash[path][:typos].find { |typo| typo[:line] == line }
+
+        if existing_entry
+          existing_entry[:typos] << { incorrect_word: incorrect_word, correct_word: correct_word }
+        else
+          hash[path][:typos] << { line: line, typos: [{ incorrect_word: incorrect_word, correct_word: correct_word }] }
+        end
+      end
+
+      result = result.map do |path, data|
+        data[:typos].map do |entry|
+          { path: path, line: entry[:line], typos: entry[:typos] }
+        end
+      end.flatten
+
+      cops = Cops.new(result)
+      cops_data = cops.cops
+      repo = Repo.new
+      client = Client.new(repo)
+      client.execute(cops_data)
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: typocop
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- datpmt
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 9.2.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+description: Typocop integrates with GitHub Actions to automatically comment on pull
+  requests when typos are detected or when a PR is approved, based on [Crate CI's
+  Typos](https://github.com/crate-ci/typos).
+email: datpmt.2k@gmail.com
+executables:
+- typocop
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/typocop
+- lib/typocop.rb
+- lib/typocop/cli.rb
+- lib/typocop/client.rb
+- lib/typocop/comment.rb
+- lib/typocop/cop.rb
+- lib/typocop/cops.rb
+- lib/typocop/patch.rb
+- lib/typocop/repo.rb
+homepage: https://rubygems.org/gems/typocop
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/datpmt/typocop
+  changelog_uri: https://github.com/datpmt/typocop/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '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: Comment on PRs with typos or approvals
+test_files: []