lock_diff 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49e90bd5a6ed3fbc00553bdcda81175a6284e823
-  data.tar.gz: 55e43f00d8cbb5debda5a9a0f5a8e36bda970443
+  metadata.gz: 8c0b8383d775ad39dbd93fff93530652b7e60e3d
+  data.tar.gz: 34ef1bd10ad27bb846e4ba47c7926dd9a0281ae4
 SHA512:
-  metadata.gz: f4b8f38e2309147797b3b5204deaa874a82f638d670254cd82a6171e9186b8104f60264ec81f43c1374c5ded1cb4c083156a4a49732a4eac24db0df427943dad
-  data.tar.gz: 18447bbe8452d330ba39ee8af80dcd43d40f8932696e36e200d72c915660c8db5db4e49f2c7e9eac67b3ba81b3f18264c1bda0ee2a128faa86e25a224631da8c
+  metadata.gz: f2885f2572e82adffed6fa073a2f1fa7b7ae0500a0f8aca59039fe4a52b2da2163f764c0357978016c133e1592a60fedf2da8273b4e8c66a36e39808d086eff4
+  data.tar.gz: c076daeb953b7da33bb7a20fc2e2e607791261b15cedc41b862493f8fb9b4043e30b4b33647c940ad01b33d10a055913cb2c8bca36dccde52421a2ea9f1b3e50

data/README.md

@@ -2,7 +2,12 @@
 
 [![CircleCI](https://circleci.com/gh/vividmuimui/lock_diff.svg?style=svg)](https://circleci.com/gh/vividmuimui/lock_diff)
 
-This Gem is generates `changelog url`, `github compare link` by lock file of Github pull request. And comment to pull request.
+This gem detects changes to your package manager (e.g. Gemfile) and generates a Markdown-formatted diff including:
+
+* links to the corresponding package's change logs
+* Github `...`-delineated diff links for the relevant changes
+
+It also optionally posts the diff as a comment to the pull request responsible for the package update.
 
 Like this.
 
@@ -31,7 +36,7 @@ Or install it yourself as:
 
 ## Usage
 
-Require `GITHUB_ACCESS_TOKEN` environment.
+lock_diff requires you to provide a `GITHUB_ACCESS_TOKEN` as an environment variable.
 
 ### Command line
 
@@ -40,9 +45,11 @@ $ lock_diff
 Usage: lock_diff [options]
     -r, --repository=REPOSITORY      required. Like as "user/repository"
     -n, --number=PULL_REQUEST_NUMBER required
-        --post-comment=true or false dafault=false
+        --post-comment=true or false (default=false. Print result to stdout when false.)
 ```
 
+For example, to comment on https://github.com/vividmuimui/rails_tutorial/pull/26#issuecomment-312491272, run this command:
+
 ```sh
 $ lock_diff -r "vividmuimui/rails_tutorial" -n 26 --post-comment=false
 ```
@@ -54,6 +61,31 @@ require 'lock_diff'
 LockDiff.run(repository: "vividmuimui/rails_tutorial", number: 26, post_comment: false)
 ```
 
+### For Tachikoma pull request
+
+When used in conjunction with [tachikoma](https://rubygems.org/gems/tachikoma), use the `lock_diff_for_tachikoma` command instead of `lock_diff`.
+`lock_diff_for_tachikoma` automatically detects and comments on the most recent tachikoma pull request.
+
+#### Command line
+
+```sh
+$ lock_diff
+Usage: lock_diff_for_tachikoma [options]
+    -r, --repository=REPOSITORY      required. Like as "user/repository"
+        --post-comment=true or false default=false
+```
+
+```sh
+$ lock_diff_for_tachikoma -r "vividmuimui/rails_tutorial" --post-comment=false
+```
+
+#### Ruby
+
+```ruby
+require 'lock_diff'
+LockDiff.lock_diff_for_tachikoma(repository: "vividmuimui/rails_tutorial", post_comment: false)
+```
+
 ## Development
 
 TODO:

data/exe/lock_diff

@@ -10,7 +10,7 @@ opt = OptionParser.new
 
 opt.on('-r', '--repository=REPOSITORY', 'required. Like as "user/repository"') { |v| options[:repository] = v }
 opt.on('-n', '--number=PULL_REQUEST_NUMBER', 'required') { |v| options[:number] = v }
-opt.on('--post-comment=true or false', 'dafault=false') { |v| options[:post_comment] = v }
+opt.on('--post-comment=true or false', '(default=false. Print result to stdout when false.)') { |v| options[:post_comment] = v }
 opt.parse!
 
 unless options[:repository] && options[:number]

data/exe/lock_diff_for_tachikoma

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require "lock_diff"
+require "optparse"
+
+options = {
+  post_comment: false
+}
+opt = OptionParser.new
+
+opt.on('-r', '--repository=REPOSITORY', 'required. Like as "user/repository"') { |v| options[:repository] = v }
+opt.on('--post-comment=true or false', '(default=false. Print result to stdout when false.)') { |v| options[:post_comment] = v }
+opt.parse!
+
+unless options[:repository]
+  $stdout.puts opt.help
+else
+  LockDiff.run_by_latest_tachikoma(options)
+end

data/lib/lock_diff/github/client.rb

@@ -24,6 +24,11 @@ module LockDiff
         Github::PullRequest.new(@client.pull_request(repository, number))
       end
 
+      def latest_pull_request(repository, limit: 3)
+        @client.pull_requests(repository).first(limit).
+          map { |pull_request| Github::PullRequest.new(pull_request) }
+      end
+
       def pull_request_content_path(repository, number, file_name)
         content = @client.pull_request_files(repository, number).
           find { |file| file.filename.include?(file_name) }

data/lib/lock_diff/github/pull_request.rb

@@ -13,6 +13,18 @@ module LockDiff
       def head_sha
         @pr.head.sha
       end
+
+      def base_ref
+        @pr.base.ref
+      end
+
+      def head_ref
+        @pr.head.ref
+      end
+
+      def number
+        @pr.number
+      end
     end
   end
 end

data/lib/lock_diff/version.rb

@@ -1,3 +1,3 @@
 module LockDiff
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/lock_diff.rb

@@ -26,10 +26,20 @@ module LockDiff
         $stdout.puts result
       end
     end
+
+    def run_by_latest_tachikoma(repository:, post_comment: false)
+      pr = Github.client.latest_pull_request(repository, limit: 10).
+        find { |pull_request| pull_request.head_ref.include?("tachikoma") }
+      if pr
+        run(repository: repository, number: pr.number, post_comment: post_comment)
+      else
+        LockDiff.logger.info("Not found pull request by tachikoma.")
+      end
+    end
   end
 
   self.client_class = Github
   self.formatter = Formatter::GithubMarkdown
   self.strategy = Gem
-  self.logger = Logger.new(nil)
+  self.logger = Logger.new($stdout)
 end

data/lock_diff.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["vividmuimui"]
   spec.email         = ["vivid.muimui@gmail.com"]
 
-  spec.summary       = %q{Generate links by Gemfile.lock of Github PR, and post comment to it.}
-  spec.description   = %q{Generate links by Gemfile.lock of Github PR, and post comment to it.}
+  spec.summary       = %q{This gem detects changes to your package manager (e.g. Gemfile) and generates a Markdown-formatted diff.}
+  spec.description   = %q{This gem detects changes to your package manager (e.g. Gemfile) and generates a Markdown-formatted diff.}
   # spec.homepage      = "https://github.com/vividmuimui/lock_diff"
   spec.homepage      = ""
   spec.license       = "MIT"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lock_diff
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - vividmuimui
@@ -108,11 +108,13 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Generate links by Gemfile.lock of Github PR, and post comment to it.
+description: This gem detects changes to your package manager (e.g. Gemfile) and generates
+  a Markdown-formatted diff.
 email:
 - vivid.muimui@gmail.com
 executables:
 - lock_diff
+- lock_diff_for_tachikoma
 extensions: []
 extra_rdoc_files: []
 files:
@@ -127,6 +129,7 @@ files:
 - bin/console
 - bin/setup
 - exe/lock_diff
+- exe/lock_diff_for_tachikoma
 - lib/lock_diff.rb
 - lib/lock_diff/formatter/github_markdown.rb
 - lib/lock_diff/gem.rb
@@ -171,5 +174,6 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Generate links by Gemfile.lock of Github PR, and post comment to it.
+summary: This gem detects changes to your package manager (e.g. Gemfile) and generates
+  a Markdown-formatted diff.
 test_files: []