compare_linker 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bd91ee90fc917c5cae680d6d5c3316b142d95d2
-  data.tar.gz: 7b594db9f42c2a2b854308395884b514e58d7f63
+  metadata.gz: 82c24082c7f1e558330f73e82641d3bb89170a06
+  data.tar.gz: a1f100bf18a6bf9a1c1e3b0742334cb508b0f18b
 SHA512:
-  metadata.gz: 514183f5e9ff8ed40cddf123857048296b2b04e4833f57cadbd02b787ab97ecb286892fd3ee002e1db7bec80a71d13cbf7e43a058811b8f7bbf0c4b2421043cc
-  data.tar.gz: 82673469c08f0e6905479c30acf6f896c2c3f0c4ea8abe7105995fd4435c93bfddf7f8c3948fe694fe6e9176945ec445bf994f16df53fbe0208fc0683d18a782
+  metadata.gz: 50591bfabe3b54b10fe058e5130b3a56a971254322b5d9334b24b1caf08c824ba7a9f3931bc7c93946177e80dd5af507e1108fe2b7bee3a9194b51ca0fbdd4c7
+  data.tar.gz: be7eb5a92eb8d282309d583d6f2beffc5e736cfc52d0f1ae18e78cdc33e0226dda03ac7c74d3d10535c75c3d78386fcabfd472cd8692a3c674cccd1c6d121be1

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 2.3.0
   - 2.2.0
   - 2.1.0
   - 2.0.0

data/README.md

@@ -1,4 +1,14 @@
-# Compare Linker [![Build Status][travis-badge]][travis-link] [![Gem Version][gem-badge]][gem-link]
+# Compare Linker
+
+[![Travis Status](https://img.shields.io/travis/masutaka/compare_linker.svg?maxAge=2592000)][travisci]
+[![License](https://img.shields.io/github/license/masutaka/compare_linker.svg?maxAge=2592000?style=flat-square)][license]
+[![Gem](https://img.shields.io/gem/v/compare_linker.svg?maxAge=2592000?style=flat-square)][gem-link]
+
+[travisci]: https://travis-ci.org/masutaka/compare_linker
+[license]: https://github.com/masutaka/compare_linker/blob/master/LICENSE.txt
+[gem-link]: http://badge.fury.io/rb/compare_linker
+
+## Description
 
 Create GitHub's compare view URLs for pull request from diff of `Gemfile.lock` (and post comment to pull request).
 
@@ -6,6 +16,22 @@ Create GitHub's compare view URLs for pull request from diff of `Gemfile.lock` (
 
 [GitHub Compare View](https://github.com/blog/612-introducing-github-compare-view) rocks.But [diff of Gemfile.lock](https://github.com/kyanny/compare_linker_demo/pull/14/files) sucks. So I made Compare Linker.
 
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'compare_linker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install compare_linker
+
 ## Usage
 
 ```ruby
@@ -19,13 +45,16 @@ comment = compare_linker.make_compare_links.to_a.join("\n")
 compare_linker.add_comment('masutaka/compare_linker', '17', comment)
 ```
 
-## Rack app for listening GitHub Webhook
+## Development
 
-There's rack application for Compare Linker with GitHub's Webhook.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-https://github.com/kyanny/compare_linker_rack_app
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-[travis-badge]: https://travis-ci.org/masutaka/compare_linker.svg?branch=master
-[travis-link]: https://travis-ci.org/masutaka/compare_linker
-[gem-badge]: https://badge.fury.io/rb/compare_linker.svg
-[gem-link]: http://badge.fury.io/rb/compare_linker
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/masutaka/compare_linker. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/data/rubygems.yml

@@ -0,0 +1,13 @@
+# Gem name: GitHub repository
+
+actioncable: rails/rails
+actionmailer: rails/rails
+actionpack: rails/rails
+actionview: rails/rails
+activejob: rails/rails
+activemodel: rails/rails
+activerecord: rails/rails
+activesupport: rails/rails
+capistrano: capistrano/capistrano
+railties: rails/rails
+serverspec: mizzy/serverspec

data/lib/compare_linker.rb

@@ -2,19 +2,21 @@ require "octokit"
 require_relative "compare_linker/formatter/base"
 require_relative "compare_linker/formatter/text"
 require_relative "compare_linker/formatter/markdown"
+require_relative "compare_linker/gem_dictionary"
 require_relative "compare_linker/github_link_finder"
 require_relative "compare_linker/github_tag_finder"
 require_relative "compare_linker/lockfile_comparator"
 require_relative "compare_linker/lockfile_fetcher"
 
 class CompareLinker
-  attr_reader :repo_full_name, :pr_number, :compare_links
+  attr_reader :repo_full_name, :pr_number, :compare_links, :gem_dictionary
   attr_accessor :formatter, :octokit
 
   def initialize(repo_full_name, pr_number)
     @repo_full_name = repo_full_name
     @pr_number = pr_number
     @octokit ||= Octokit::Client.new(access_token: ENV["OCTOKIT_ACCESS_TOKEN"])
+    @gem_dictionary = GemDictionary.new
     @formatter = Formatter::Text.new
   end
 
@@ -30,18 +32,18 @@ class CompareLinker
       comparator.compare(old_lockfile, new_lockfile)
       @compare_links = comparator.updated_gems.map { |gem_name, gem_info|
         if gem_info[:owner].nil?
-          finder = GithubLinkFinder.new(octokit)
+          finder = GithubLinkFinder.new(octokit, gem_dictionary)
           finder.find(gem_name)
+          gem_info[:homepage_uri] = finder.homepage_uri
           if finder.repo_owner.nil?
-            gem_info[:homepage_uri] = finder.homepage_uri
             formatter.format(gem_info)
           else
             gem_info[:repo_owner] = finder.repo_owner
             gem_info[:repo_name] = finder.repo_name
 
-            tag_finder = GithubTagFinder.new(octokit)
-            old_tag = tag_finder.find(finder.repo_full_name, gem_info[:old_ver])
-            new_tag = tag_finder.find(finder.repo_full_name, gem_info[:new_ver])
+            tag_finder = GithubTagFinder.new(octokit, gem_name, finder.repo_full_name)
+            old_tag = tag_finder.find(gem_info[:old_ver])
+            new_tag = tag_finder.find(gem_info[:new_ver])
 
             if old_tag && new_tag
               gem_info[:old_tag] = old_tag.name

data/lib/compare_linker/formatter/base.rb

@@ -9,7 +9,7 @@ class CompareLinker
       end
 
       def to_ver(tag)
-        tag.sub(/\Av/, '')
+        return $1 if tag =~ /(\d+(?:\.\d+)+)\z/
       end
     end
   end

data/lib/compare_linker/formatter/markdown.rb

@@ -9,15 +9,49 @@ class CompareLinker
         text = "* [ ] "
         text += case
         when g.owner && g.old_rev && g.new_rev
-          "#{g.gem_name}: https://github.com/#{g.owner}/#{g.gem_name}/compare/#{g.old_rev}...#{g.new_rev}"
+          "[%s](%s): [`%s...%s`](%s)" % [
+            g.gem_name,
+            github_url(g.owner, g.gem_name),
+            g.old_rev,
+            g.new_rev,
+            github_compare_url(g.owner, g.gem_name, g.old_rev, g.new_rev),
+          ]
+        when g.homepage_uri && g.old_tag && g.new_tag
+          "[%s](%s): [`%s...%s`](%s)" % [
+            g.gem_name,
+            github_url(g.repo_owner, g.repo_name),
+            g.old_ver,
+            g.new_ver,
+            github_compare_url(g.repo_owner, g.repo_name, g.old_tag, g.new_tag),
+          ]
         when g.homepage_uri
-          "[#{g.gem_name}](#{g.homepage_uri}): #{g.old_ver} => #{g.new_ver}"
+          "[%s](%s): `%s...%s`" % [
+            g.gem_name,
+            g.homepage_uri,
+            g.old_ver,
+            g.new_ver,
+          ]
         when g.old_tag && g.new_tag
-          "#{g.gem_name}: https://github.com/#{g.repo_owner}/#{g.repo_name}/compare/#{g.old_tag}...#{g.new_tag}"
+          "[%s](%s): [`%s...%s`](%s)" % [
+            g.gem_name,
+            github_url(g.repo_owner, g.repo_name),
+            g.old_ver,
+            g.new_ver,
+            github_compare_url(g.repo_owner, g.repo_name, g.old_tag, g.new_tag),
+          ]
         when g.repo_owner && g.repo_name
-          "[#{g.gem_name}](https://github.com/#{g.repo_owner}/#{g.repo_name}): #{g.old_ver} => #{g.new_ver}"
+          "[%s](%s): `%s...%s`" % [
+            g.gem_name,
+            github_url(g.repo_owner, g.repo_name),
+            g.old_ver,
+            g.new_ver,
+          ]
         else
-          "#{g.gem_name}: (link not found) #{g.old_ver} => #{g.new_ver}"
+          "%s: (link not found) `%s...%s`" % [
+            g.gem_name,
+            g.old_ver,
+            g.new_ver,
+          ]
         end
 
         if downgrade?(g.old_ver, g.new_ver, g.old_tag, g.new_tag)
@@ -26,6 +60,16 @@ class CompareLinker
 
         text
       end
+
+      private
+
+      def github_url(repo_owner, repo_name)
+        "https://github.com/#{repo_owner}/#{repo_name}"
+      end
+
+      def github_compare_url(repo_owner, repo_name, old_tag, new_tag)
+        "#{github_url(repo_owner, repo_name)}/compare/#{old_tag}...#{new_tag}"
+      end
     end
   end
 end

data/lib/compare_linker/formatter/text.rb

@@ -9,14 +9,16 @@ class CompareLinker
         text = case
         when g.owner && g.old_rev && g.new_rev
           "#{g.gem_name}: https://github.com/#{g.owner}/#{g.gem_name}/compare/#{g.old_rev}...#{g.new_rev}"
+        when g.homepage_uri && g.old_tag && g.new_tag
+          "#{g.gem_name} (#{g.homepage_uri}): https://github.com/#{g.repo_owner}/#{g.repo_name}/compare/#{g.old_tag}...#{g.new_tag}"
         when g.homepage_uri
-          "#{g.gem_name} (#{g.homepage_uri}): #{g.old_ver} => #{g.new_ver}"
+          "#{g.gem_name} (#{g.homepage_uri}): #{g.old_ver}...#{g.new_ver}"
         when g.old_tag && g.new_tag
           "#{g.gem_name}: https://github.com/#{g.repo_owner}/#{g.repo_name}/compare/#{g.old_tag}...#{g.new_tag}"
         when g.repo_owner && g.repo_name
-          "#{g.gem_name}: https://github.com/#{g.repo_owner}/#{g.repo_name} #{g.old_ver} => #{g.new_ver}"
+          "#{g.gem_name}: https://github.com/#{g.repo_owner}/#{g.repo_name} #{g.old_ver}...#{g.new_ver}"
         else
-          "#{g.gem_name} (link not found): #{g.old_ver} => #{g.new_ver}"
+          "#{g.gem_name} (link not found): #{g.old_ver}...#{g.new_ver}"
         end
 
         if downgrade?(g.old_ver, g.new_ver, g.old_tag, g.new_tag)

data/lib/compare_linker/gem_dictionary.rb

@@ -0,0 +1,32 @@
+require "yaml"
+
+class CompareLinker
+  class GemDictionary
+    attr_reader :file, :rubygems
+
+    def initialize
+      @file = File.join(__dir__, '../../data/rubygems.yml')
+    end
+
+    # Look gem info up from Dictionary
+    #
+    # @param gem_name [String]
+    # @return [Array<String>] [repo_owner, repo_name]
+    # @return [Array<NilClass>] cannot look up
+    def lookup(gem_name)
+      repo_full_name = rubygems[gem_name]
+
+      if repo_full_name
+        repo_full_name.split("/")
+      else
+        [nil, nil]
+      end
+    end
+
+    private
+
+    def rubygems
+      @rubygems ||= YAML.load(IO.read(file))
+    end
+  end
+end

data/lib/compare_linker/github_link_finder.rb

@@ -4,10 +4,11 @@ require "net/http"
 
 class CompareLinker
   class GithubLinkFinder
-    attr_reader :octokit, :repo_owner, :repo_name, :homepage_uri
+    attr_reader :octokit, :gem_dictionary, :repo_owner, :repo_name, :homepage_uri
 
-    def initialize(octokit)
+    def initialize(octokit, gem_dictionary)
       @octokit = octokit
+      @gem_dictionary = gem_dictionary
     end
 
     def find(gem_name)
@@ -23,6 +24,7 @@ class CompareLinker
       if github_url = redirect_url(github_url)
         _, @repo_owner, @repo_name = github_url.match(%r!github\.com/([^/]+)/([^/]+)!).to_a
       else
+        @repo_owner, @repo_name  = gem_dictionary.lookup(gem_info["name"])
         @homepage_uri = gem_info["homepage_uri"]
       end
 

data/lib/compare_linker/github_tag_finder.rb

@@ -1,18 +1,32 @@
 class CompareLinker
   class GithubTagFinder
-    attr_reader :octokit
+    attr_reader :octokit, :gem_name, :repo_full_name
 
-    def initialize(octokit)
+    def initialize(octokit, gem_name, repo_full_name)
       @octokit = octokit
+      @gem_name = gem_name
+      @repo_full_name = repo_full_name
     end
 
-    def find(repo_full_name, gem_version)
-      tags = octokit.tags(repo_full_name)
+    def find(gem_version)
+      tags = auto_paginate { octokit.tags(repo_full_name) }
       if tags
         tags.find { |tag|
-          tag.name == gem_version || tag.name == "v#{gem_version}"
+          tag.name == gem_version ||
+            tag.name == "v#{gem_version}" ||
+            tag.name == "#{gem_name}-#{gem_version}"
         }
       end
     end
+
+    private
+
+    def auto_paginate
+      original = octokit.auto_paginate
+      octokit.auto_paginate = true
+      yield
+    ensure
+      octokit.auto_paginate = original
+    end
   end
 end

data/lib/compare_linker/version.rb

@@ -1,3 +1,3 @@
 class CompareLinker
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/spec/lib/compare_linker/gem_dictionary_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe CompareLinker::GemDictionary do
+  describe "#lookup" do
+    context 'given a gem name included in the dictionary' do
+      subject { described_class.new.lookup('serverspec') }
+      it { is_expected.to eq %w(mizzy serverspec) }
+    end
+
+    context 'given a gem name not included in the dictionary' do
+      subject { described_class.new.lookup('not_exist') }
+      it { is_expected.to eq [nil, nil] }
+    end
+  end
+end

data/spec/lib/compare_linker/github_link_finder_spec.rb

@@ -2,8 +2,9 @@ require "spec_helper"
 
 describe CompareLinker::GithubLinkFinder do
   let(:octokit) { double.as_null_object }
+  let(:gem_dictionary) { double.as_null_object }
 
-  subject { described_class.new(octokit) }
+  subject { described_class.new(octokit, gem_dictionary) }
 
 
   describe "#find" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compare_linker
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Kensuke Nagae
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-29 00:00:00.000000000 Z
+date: 2016-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -95,11 +95,13 @@ files:
 - README.md
 - Rakefile
 - compare_linker.gemspec
+- data/rubygems.yml
 - guides/jenkins_setup_guide.md
 - lib/compare_linker.rb
 - lib/compare_linker/formatter/base.rb
 - lib/compare_linker/formatter/markdown.rb
 - lib/compare_linker/formatter/text.rb
+- lib/compare_linker/gem_dictionary.rb
 - lib/compare_linker/github_link_finder.rb
 - lib/compare_linker/github_tag_finder.rb
 - lib/compare_linker/lockfile_comparator.rb
@@ -111,6 +113,7 @@ files:
 - spec/fixtures/coffee-script-source.json
 - spec/fixtures/rails.json
 - spec/fixtures/web_translate_it.json
+- spec/lib/compare_linker/gem_dictionary_spec.rb
 - spec/lib/compare_linker/github_link_finder_spec.rb
 - spec/spec_helper.rb
 - spec/support/load_fixture.rb
@@ -134,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Create GitHub's compare view URLs for pull request
@@ -142,6 +145,7 @@ test_files:
 - spec/fixtures/coffee-script-source.json
 - spec/fixtures/rails.json
 - spec/fixtures/web_translate_it.json
+- spec/lib/compare_linker/gem_dictionary_spec.rb
 - spec/lib/compare_linker/github_link_finder_spec.rb
 - spec/spec_helper.rb
 - spec/support/load_fixture.rb