compare_linker 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82c24082c7f1e558330f73e82641d3bb89170a06
-  data.tar.gz: a1f100bf18a6bf9a1c1e3b0742334cb508b0f18b
+  metadata.gz: aef939118994b5fb0173c1ebda2ade1e4443c163
+  data.tar.gz: 023c4e1deca57013afdf6a4262e69c111f746daa
 SHA512:
-  metadata.gz: 50591bfabe3b54b10fe058e5130b3a56a971254322b5d9334b24b1caf08c824ba7a9f3931bc7c93946177e80dd5af507e1108fe2b7bee3a9194b51ca0fbdd4c7
-  data.tar.gz: be7eb5a92eb8d282309d583d6f2beffc5e736cfc52d0f1ae18e78cdc33e0226dda03ac7c74d3d10535c75c3d78386fcabfd472cd8692a3c674cccd1c6d121be1
+  metadata.gz: aac7dbc6e9270bec1b411e2155c939d1d8ffe6944b93b559b21bc97383c8374b93cc2c422721b82131f3e2db2743e3c532a3d34abc3fc3a83fc73b587cedd097
+  data.tar.gz: 4cb45a80a5cea8c4d91858380da7c0acfd19275e007e79e2d687545a67c277eac8eafde0c593b4dd2263eb1562ba38a680056fd3f7e6ce3d8b3bd667e6649a00

data/README.md

@@ -12,7 +12,7 @@
 
 Create GitHub's compare view URLs for pull request from diff of `Gemfile.lock` (and post comment to pull request).
 
-![screen shot 2014-01-27 at 2 25 14 am](https://f.cloud.github.com/assets/10515/2004469/de374152-86ae-11e3-84a0-19e2ef40b959.png)
+![screen shot 2016-10-09 at 7 53 23 pm](https://cloud.githubusercontent.com/assets/170014/19219899/fd06eab8-8e5a-11e6-95fb-3b467088a712.png)
 
 [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.
 

data/compare_linker.gemspec

@@ -21,7 +21,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "octokit"
   spec.add_dependency "httpclient"
 
+  spec.add_development_dependency "activesupport", "~> 4" # for ruby-2.[0-2].0 tests, required by factory_girl
   spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "factory_girl"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
 end

data/lib/compare_linker/formatter/base.rb

@@ -1,16 +1,40 @@
+require "ostruct"
+
 class CompareLinker
   class Formatter
     class Base
+      attr_reader :g, :downgraded
+
+      def format(gem_info)
+        @g = OpenStruct.new(gem_info)
+        @downgraded = downgrade?(g.old_ver, g.new_ver, g.old_tag, g.new_tag, g.old_rev, g.new_rev)
+        post_format
+      end
+
       private
 
-      def downgrade?(old_ver, new_ver, old_tag, new_tag)
+      def post_format
+        raise NotImplementedError
+      end
+
+      def downgrade?(old_ver, new_ver, old_tag, new_tag, old_rev, new_rev)
         Gem::Version.new(new_ver) < Gem::Version.new(old_ver) ||
-          (old_tag && new_tag && Gem::Version.new(to_ver(new_tag)) < Gem::Version.new(to_ver(old_tag)))
+          (old_tag && new_tag && Gem::Version.new(to_ver(new_tag)) < Gem::Version.new(to_ver(old_tag))) ||
+          (old_rev && new_rev && Gem::Version.new(to_ver(new_rev)) < Gem::Version.new(to_ver(old_rev)))
       end
 
       def to_ver(tag)
         return $1 if tag =~ /(\d+(?:\.\d+)+)\z/
       end
+
+      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)
+        range = downgraded ? "#{new_tag}...#{old_tag}" : "#{old_tag}...#{new_tag}"
+        "#{github_url(repo_owner, repo_name)}/compare/#{range}"
+      end
     end
   end
 end

data/lib/compare_linker/formatter/markdown.rb

@@ -1,11 +1,9 @@
-require "ostruct"
-
 class CompareLinker
   class Formatter
     class Markdown < Base
-      def format(gem_info)
-        g = OpenStruct.new(gem_info)
+      private
 
+      def post_format
         text = "* [ ] "
         text += case
         when g.owner && g.old_rev && g.new_rev
@@ -54,22 +52,9 @@ class CompareLinker
           ]
         end
 
-        if downgrade?(g.old_ver, g.new_ver, g.old_tag, g.new_tag)
-          text += " (downgrade)"
-        end
-
+        text += " (downgrade)" if downgraded
         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

@@ -1,30 +1,25 @@
-require "ostruct"
-
 class CompareLinker
   class Formatter
     class Text < Base
-      def format(gem_info)
-        g = OpenStruct.new(gem_info)
+      private
 
+      def post_format
         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}"
+          "#{g.gem_name}: #{github_compare_url(g.owner, g.gem_name, 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}"
+          "#{g.gem_name} (#{g.homepage_uri}): #{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}"
         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}"
+          "#{g.gem_name}: #{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}"
+          "#{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}"
         end
 
-        if downgrade?(g.old_ver, g.new_ver, g.old_tag, g.new_tag)
-          text += " (downgrade)"
-        end
-
+        text += " (downgrade)" if downgraded
         text
       end
     end

data/lib/compare_linker/lockfile_comparator.rb

@@ -13,6 +13,7 @@ class CompareLinker
             old_rev = old_spec.source.options["revision"]
             new_rev = new_spec.source.options["revision"]
             if old_rev && new_rev && (old_rev != new_rev)
+              # This section may be unnecessary?
               _, owner, gem_name = old_spec.source.uri.match(/github\.com\/([^\/]+)\/([^.]+)/).to_a
               updated_gems[old_spec.name] = {
                 owner: owner,

data/lib/compare_linker/version.rb

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

data/spec/factories/gem_info.rb

@@ -0,0 +1,172 @@
+FactoryGirl.define do
+  factory :gem_info, class: Hash do
+    factory :g_owner__old_rev__new_rev do
+      defaults = {
+        owner: 'masutaka',
+        gem_name: 'compare_linker',
+      }
+
+      factory :g_upgrade__owner__old_rev__new_rev do
+        initialize_with do
+          defaults.merge(
+            old_rev: '1.1.1',
+            new_rev: '1.1.2'
+          )
+        end
+      end
+
+      factory :g_downgrade__owner__old_rev__new_rev do
+        initialize_with do
+          defaults.merge(
+            old_rev: '1.1.2',
+            new_rev: '1.1.1'
+          )
+        end
+      end
+    end
+
+    factory :g_homepage_uri__old_tag__new_tag do
+      defaults = {
+        owner:        nil,
+        gem_name:     'serverspec',
+        homepage_uri: 'http://serverspec.org/',
+        repo_owner:   'mizzy',
+        repo_name:    'serverspec',
+      }
+
+      factory :g_upgrade__homepage_uri__old_tag__new_tag do
+        initialize_with do
+          defaults.merge(
+            old_ver: '2.24.0',
+            new_ver: '2.24.1',
+            old_tag: 'v2.24.0',
+            new_tag: 'v2.24.1'
+          )
+        end
+      end
+
+      factory :g_downgrade__homepage_uri__old_tag__new_tag do
+        initialize_with do
+          defaults.merge(
+            old_ver: '2.24.1',
+            new_ver: '2.24.0',
+            old_tag: 'v2.24.1',
+            new_tag: 'v2.24.0'
+          )
+        end
+      end
+    end
+
+    factory :g_homepage_uri do
+      defaults = {
+        owner:        nil,
+        gem_name:     'mixlib-shellout',
+        homepage_uri: 'https://www.chef.io/',
+      }
+
+      factory :g_upgrade__homepage_uri do
+        initialize_with do
+          defaults.merge(
+            old_ver: '2.1.0',
+            new_ver: '2.2.1'
+          )
+        end
+      end
+
+      factory :g_downgrade__homepage_uri do
+        initialize_with do
+          defaults.merge(
+            old_ver: '2.2.1',
+            new_ver: '2.1.0'
+          )
+        end
+      end
+    end
+
+    factory :g_old_tag__new_tag do
+      defaults = {
+        owner:        nil,
+        gem_name:     'chef',
+        homepage_uri: nil,
+        repo_owner:   'chef',
+        repo_name:    'chef',
+      }
+
+      factory :g_upgrade__old_tag__new_tag do
+        initialize_with do
+          defaults.merge(
+            old_ver: '12.4.1',
+            new_ver: '12.4.3',
+            old_tag: '12.4.1',
+            new_tag: '12.4.3'
+          )
+        end
+      end
+
+      factory :g_downgrade__old_tag__new_tag do
+        initialize_with do
+          defaults.merge(
+            old_ver: '12.4.3',
+            new_ver: '12.4.1',
+            old_tag: '12.4.3',
+            new_tag: '12.4.1'
+          )
+        end
+      end
+    end
+
+    factory :g_repo_owner__repo_name do
+      defaults = {
+        owner:        nil,
+        gem_name:     'sfl',
+        homepage_uri: nil,
+        repo_owner:   'ujihisa',
+        repo_name:    'spawn-for-legacy',
+      }
+
+      factory :g_upgrade__repo_owner__repo_name do
+        initialize_with do
+          defaults.merge(
+            old_ver: '2.2',
+            new_ver: '2.3'
+          )
+        end
+      end
+
+      factory :g_downgrade__repo_owner__repo_name do
+        initialize_with do
+          defaults.merge(
+            old_ver: '2.3',
+            new_ver: '2.2'
+          )
+        end
+      end
+    end
+
+    factory :g_else do
+      defaults = {
+        owner:        nil,
+        gem_name:     'json',
+        homepage_uri: nil,
+      }
+
+      factory :g_upgrade__else do
+        initialize_with do
+          defaults.merge(
+            old_ver: '1.8.1',
+            new_ver: '1.8.2'
+          )
+        end
+      end
+
+      factory :g_downgrade__else do
+        initialize_with do
+          defaults.merge(
+            old_ver: '1.8.2',
+            new_ver: '1.8.1'
+          )
+        end
+      end
+    end
+  end
+end

data/spec/lib/compare_linker/formatter/markdown_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe CompareLinker::Formatter::Markdown do
+  describe '#format' do
+    subject { described_class.new.format(gem_info) }
+
+    context 'given upgrade (normal)' do
+      context 'given owner && old_rev && new_rev' do
+        # This spec may be unnecessary.
+        let(:gem_info) { build(:g_upgrade__owner__old_rev__new_rev) }
+        it { is_expected.to eq '* [ ] [compare_linker](https://github.com/masutaka/compare_linker): [`1.1.1...1.1.2`](https://github.com/masutaka/compare_linker/compare/1.1.1...1.1.2)' }
+      end
+
+      context 'given homepage_uri && old_tag && new_tag' do
+        let(:gem_info) { build(:g_upgrade__homepage_uri__old_tag__new_tag) }
+        it { is_expected.to eq '* [ ] [serverspec](https://github.com/mizzy/serverspec): [`2.24.0...2.24.1`](https://github.com/mizzy/serverspec/compare/v2.24.0...v2.24.1)' }
+      end
+
+      context 'given homepage_uri' do
+        let(:gem_info) { build(:g_upgrade__homepage_uri) }
+        it { is_expected.to eq '* [ ] [mixlib-shellout](https://www.chef.io/): `2.1.0...2.2.1`' }
+      end
+
+      context 'given old_tag && new_tag' do
+        let(:gem_info) { build(:g_upgrade__old_tag__new_tag) }
+        it { is_expected.to eq '* [ ] [chef](https://github.com/chef/chef): [`12.4.1...12.4.3`](https://github.com/chef/chef/compare/12.4.1...12.4.3)' }
+      end
+
+      context 'given repo_owner && repo_name' do
+        let(:gem_info) { build(:g_upgrade__repo_owner__repo_name) }
+        it { is_expected.to eq '* [ ] [sfl](https://github.com/ujihisa/spawn-for-legacy): `2.2...2.3`' }
+      end
+
+      context 'given else' do
+        let(:gem_info) { build(:g_upgrade__else) }
+        it { is_expected.to eq '* [ ] json: (link not found) `1.8.1...1.8.2`' }
+      end
+    end
+
+    context 'given downgrade' do
+      context 'given owner && old_rev && new_rev' do
+        # This spec may be unnecessary.
+        let(:gem_info) { build(:g_downgrade__owner__old_rev__new_rev) }
+        it { is_expected.to eq '* [ ] [compare_linker](https://github.com/masutaka/compare_linker): [`1.1.2...1.1.1`](https://github.com/masutaka/compare_linker/compare/1.1.1...1.1.2) (downgrade)' }
+      end
+
+      context 'given homepage_uri && old_tag && new_tag' do
+        let(:gem_info) { build(:g_downgrade__homepage_uri__old_tag__new_tag) }
+        it { is_expected.to eq '* [ ] [serverspec](https://github.com/mizzy/serverspec): [`2.24.1...2.24.0`](https://github.com/mizzy/serverspec/compare/v2.24.0...v2.24.1) (downgrade)' }
+      end
+
+      context 'given homepage_uri' do
+        let(:gem_info) { build(:g_downgrade__homepage_uri) }
+        it { is_expected.to eq '* [ ] [mixlib-shellout](https://www.chef.io/): `2.2.1...2.1.0` (downgrade)' }
+      end
+
+      context 'given old_tag && new_tag' do
+        let(:gem_info) { build(:g_downgrade__old_tag__new_tag) }
+        it { is_expected.to eq '* [ ] [chef](https://github.com/chef/chef): [`12.4.3...12.4.1`](https://github.com/chef/chef/compare/12.4.1...12.4.3) (downgrade)' }
+      end
+
+      context 'given repo_owner && repo_name' do
+        let(:gem_info) { build(:g_downgrade__repo_owner__repo_name) }
+        it { is_expected.to eq '* [ ] [sfl](https://github.com/ujihisa/spawn-for-legacy): `2.3...2.2` (downgrade)' }
+      end
+
+      context 'given else' do
+        let(:gem_info) { build(:g_downgrade__else) }
+        it { is_expected.to eq '* [ ] json: (link not found) `1.8.2...1.8.1` (downgrade)' }
+      end
+    end
+  end
+end

data/spec/lib/compare_linker/formatter/text_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe CompareLinker::Formatter::Text do
+  describe '#format' do
+    subject { described_class.new.format(gem_info) }
+
+    context 'given upgrade (normal)' do
+      context 'given owner && old_rev && new_rev' do
+        # This spec may be unnecessary.
+        let(:gem_info) { build(:g_upgrade__owner__old_rev__new_rev) }
+        it { is_expected.to eq 'compare_linker: https://github.com/masutaka/compare_linker/compare/1.1.1...1.1.2' }
+      end
+
+      context 'given homepage_uri && old_tag && new_tag' do
+        let(:gem_info) { build(:g_upgrade__homepage_uri__old_tag__new_tag) }
+        it { is_expected.to eq 'serverspec (http://serverspec.org/): https://github.com/mizzy/serverspec/compare/v2.24.0...v2.24.1' }
+      end
+
+      context 'given homepage_uri' do
+        let(:gem_info) { build(:g_upgrade__homepage_uri) }
+        it { is_expected.to eq 'mixlib-shellout (https://www.chef.io/): 2.1.0...2.2.1' }
+      end
+
+      context 'given old_tag && new_tag' do
+        let(:gem_info) { build(:g_upgrade__old_tag__new_tag) }
+        it { is_expected.to eq 'chef: https://github.com/chef/chef/compare/12.4.1...12.4.3' }
+      end
+
+      context 'given repo_owner && repo_name' do
+        let(:gem_info) { build(:g_upgrade__repo_owner__repo_name) }
+        it { is_expected.to eq 'sfl: https://github.com/ujihisa/spawn-for-legacy 2.2...2.3' }
+      end
+
+      context 'given else' do
+        let(:gem_info) { build(:g_upgrade__else) }
+        it { is_expected.to eq 'json (link not found): 1.8.1...1.8.2' }
+      end
+    end
+
+    context 'given downgrade' do
+      context 'given owner && old_rev && new_rev' do
+        # This spec may be unnecessary.
+        let(:gem_info) { build(:g_downgrade__owner__old_rev__new_rev) }
+        it { is_expected.to eq 'compare_linker: https://github.com/masutaka/compare_linker/compare/1.1.1...1.1.2 (downgrade)' }
+      end
+
+      context 'given homepage_uri && old_tag && new_tag' do
+        let(:gem_info) { build(:g_downgrade__homepage_uri__old_tag__new_tag) }
+        it { is_expected.to eq 'serverspec (http://serverspec.org/): https://github.com/mizzy/serverspec/compare/v2.24.0...v2.24.1 (downgrade)' }
+      end
+
+      context 'given homepage_uri' do
+        let(:gem_info) { build(:g_downgrade__homepage_uri) }
+        it { is_expected.to eq 'mixlib-shellout (https://www.chef.io/): 2.2.1...2.1.0 (downgrade)' }
+      end
+
+      context 'given old_tag && new_tag' do
+        let(:gem_info) { build(:g_downgrade__old_tag__new_tag) }
+        it { is_expected.to eq 'chef: https://github.com/chef/chef/compare/12.4.1...12.4.3 (downgrade)' }
+      end
+
+      context 'given repo_owner && repo_name' do
+        let(:gem_info) { build(:g_downgrade__repo_owner__repo_name) }
+        it { is_expected.to eq 'sfl: https://github.com/ujihisa/spawn-for-legacy 2.3...2.2 (downgrade)' }
+      end
+
+      context 'given else' do
+        let(:gem_info) { build(:g_downgrade__else) }
+        it { is_expected.to eq 'json (link not found): 1.8.2...1.8.1 (downgrade)' }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,11 +1,16 @@
+require 'compare_linker'
+require 'factory_girl'
 require 'rspec'
-require "compare_linker"
-
 
 Dir["#{__dir__}/support/**/*.rb"].each do |f|
   require f
 end
 
 RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
   config.include LoadFixtureHelper
+
+  config.before(:suite) do
+    FactoryGirl.find_definitions
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: compare_linker
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Kensuke Nagae
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-09 00:00:00.000000000 Z
+date: 2016-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  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
@@ -110,9 +138,12 @@ files:
 - lib/compare_linker/webhook_payload.rb
 - payload.rb
 - runner.rb
+- spec/factories/gem_info.rb
 - spec/fixtures/coffee-script-source.json
 - spec/fixtures/rails.json
 - spec/fixtures/web_translate_it.json
+- spec/lib/compare_linker/formatter/markdown_spec.rb
+- spec/lib/compare_linker/formatter/text_spec.rb
 - spec/lib/compare_linker/gem_dictionary_spec.rb
 - spec/lib/compare_linker/github_link_finder_spec.rb
 - spec/spec_helper.rb
@@ -142,9 +173,12 @@ signing_key:
 specification_version: 4
 summary: Create GitHub's compare view URLs for pull request
 test_files:
+- spec/factories/gem_info.rb
 - spec/fixtures/coffee-script-source.json
 - spec/fixtures/rails.json
 - spec/fixtures/web_translate_it.json
+- spec/lib/compare_linker/formatter/markdown_spec.rb
+- spec/lib/compare_linker/formatter/text_spec.rb
 - spec/lib/compare_linker/gem_dictionary_spec.rb
 - spec/lib/compare_linker/github_link_finder_spec.rb
 - spec/spec_helper.rb