diff-suggester 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7b607ca09b45ce7add2558237deed9d31fee26d4b3ad13c2fb7f29b0afee357
-  data.tar.gz: 701bdeeae497c20b37f30dea56e4565f78142ea623067c9081841384b1e3eff0
+  metadata.gz: e928ab5a56d9207124800a481c535dce74a443adf6746adf905facf6a00caff1
+  data.tar.gz: 03f2acbd5595b5c5d54ddac6696fe002ad0b0f72dad06c6bd0a752497151330e
 SHA512:
-  metadata.gz: 7f12a83ec6ae1d5cacf2c7903546aada163ba23db8b3626e312f35a5fbf3103be006da8a9a15caa91dd3c07853d8ec1a6c4321ee4afe01d16d725cf042593022
-  data.tar.gz: e7641b38ba0813c3d5eec2824866ed10c16906ceb47276181aa0efed195e569e47339527c3fd1b0b2bd499f9f815e8fdf3b81e57bf41d63ee8b3c295a1793734
+  metadata.gz: d9ea25ac11eaf22a19b105b472e9c6937eb8020aaad4b6a99c3af6f78b6ec0570fae48c50ad4e97ddc37bc96aa48a0e2e432d5374a7321c96a78906f502b3c13
+  data.tar.gz: 6be82ef0be2903514151234801695788b40feb8c2bade92c7f70467265e1648fcf6893b8f70d04e616f02918736457b1629934b0bac2efea764d462bb24f7215

data/Gemfile

@@ -9,6 +9,5 @@ gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
 
-gem "danger"
 gem "git_diff"
 gem "octokit"

data/README.md

@@ -1 +1,50 @@
 # diff-suggester
+
+It collaborates with formatters to suggest the differences shown by 'git diff' for GitHub Pull Request.
+
+## How to use
+
+1. Install
+
+```zsh
+gem install diff-suggester
+```
+
+2. Usage
+
+First, run the formatter. Example for Android using spotless and ktlint is:
+
+```
+./gradlew spotlessKotlinApply
+```
+
+Next, run the suggester. It will comment the suggested changes as a diff on the Pull Request.
+
+```ruby
+suggester = DiffSuggester::Suggester.new(
+  repo: '<your-name/repo-name>',
+  pr_number: 0, # Pull Request number
+  access_token: '<Your PAT>'
+)
+suggester.suggest
+```
+
+If use GitHub Actions:
+
+```yml
+    - name: Run suggester
+      env:
+        REPOSITORY: ${{ github.repository }}
+        PR_NUMBER: ${{ github.event.number }}
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      run: ruby suggest.rb
+```
+
+```ruby
+suggester = DiffSuggester::Suggester.new(
+	repo: ENV["REPOSITORY"],
+	pr_number: ENV["PR_NUMBER"],
+	access_token: ENV["GITHUB_TOKEN"]
+)
+suggester.suggest
+```

data/lib/diff-suggester/client/requester.rb

@@ -5,11 +5,13 @@ require 'octokit'
 module GitHubRequester
   class PullRequest
 
-    def initialize(repo:, pr_number:, access_token:)
-      octokit_client = Octokit::Client.new(access_token: access_token)
+    def initialize(repo:, pr_number:, access_token:, base_url: nil)
+      octokit_client = base_url.nil? ? Octokit::Client.new(access_token: access_token) :
+        Octokit::Client.new(access_token: access_token, api_endpoint: base_url)
       @pr = octokit_client.pull_request(repo, pr_number)
 
-      @uri = URI.parse("https://api.github.com/repos/#{repo}/pulls/#{@pr.number}/comments")
+      @uri = URI.parse("#{base_url || default_base_url}/repos/#{repo}/pulls/#{@pr.number}/comments")
+
       @request = Net::HTTP::Post.new(@uri)
       @request['Accept'] = 'application/vnd.github+json'
       @request['Authorization'] = "Bearer #{access_token}"
@@ -32,5 +34,9 @@ module GitHubRequester
       end
       return response
     end
+
+    private def default_base_url
+      return 'https://api.github.com'
+    end
   end
 end

data/lib/diff-suggester/suggester.rb

@@ -4,8 +4,8 @@ require_relative 'client/requester'
 module DiffSuggester
   class Suggester
 
-    def initialize(repo:, pr_number:, access_token:)
-      @pull_request = GitHubRequester::PullRequest.new(repo: repo, pr_number: pr_number, access_token: access_token)
+    def initialize(repo:, pr_number:, access_token:, base_url: nil)
+      @pull_request = GitHubRequester::PullRequest.new(repo: repo, pr_number: pr_number, access_token: access_token, base_url: base_url)
     end
 
     def suggest

data/lib/diff-suggester/version.rb

@@ -1,3 +1,3 @@
 module DiffSuggester
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: diff-suggester
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - tick-taku
@@ -9,7 +9,35 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2023-04-28 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git_diff
+  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: octokit
+  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'
 description:
 email:
 - tick.taku.77@gmail.com