Merge pull request #92 from envato/ci

Fix the CI build: Rubocop fixes

.github/workflows/ci.yml

@@ -7,17 +7,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['2.5', '2.6', '2.7', '3.0']
+        ruby: ['2.5', '2.6', '2.7', '3.0', '3.1']
     runs-on: ubuntu-latest
-
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
-    - name: Install dependencies
-      run: bundle install
-    - name: Run tests
-      run: bundle exec rake
+        bundler-cache: true
+    - run: bundle exec rake --trace

.rubocop.yml

@@ -2,18 +2,19 @@
 AllCops:
   Exclude:
     - 'spike/*.rb'
+    - 'vendor/**/*'
   NewCops: enable
   TargetRubyVersion: 2.5
 
 Gemspec/RequiredRubyVersion:
   Enabled: false
 
-Metrics/BlockLength:
+Layout/LineLength:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
 
-Metrics/LineLength:
+Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'

lib/unwrappr/cli.rb

@@ -29,8 +29,7 @@ class CLI < Clamp::Command
       exit(0)
     end
 
-    subcommand 'all', 'run bundle update, push to GitHub, '\
-                      'create a pr and annotate changes' do
+    subcommand 'all', 'run bundle update, push to GitHub, create a pr and annotate changes' do
       option ['-R', '--recursive'],
              :flag,
              'Recurse into subdirectories',

lib/unwrappr/github/client.rb

@@ -60,20 +60,7 @@ def annotate_pull_request(pr_number, lock_files)
         end
 
         def git_client
-          @git_client ||= Octokit::Client.new(access_token: github_token)
-        end
-
-        def github_token
-          @github_token ||= ENV.fetch('GITHUB_TOKEN')
-        rescue KeyError
-          raise %(
-Missing environment variable GITHUB_TOKEN.
-See https://github.com/settings/tokens to set up personal access tokens.
-Add to the environment:
-
-    export GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-
-            )
+          @git_client ||= Octokit::Client.new(access_token: Octokit.access_token_from_environment)
         end
       end
     end

lib/unwrappr/octokit.rb

@@ -3,6 +3,19 @@
 # Wrapper around octokit
 module Octokit
   def self.client
-    @client ||= Client.new(access_token: ENV['GITHUB_TOKEN'])
+    @client ||= Client.new(access_token: access_token_from_environment)
+  end
+
+  def self.access_token_from_environment
+    ENV.fetch('GITHUB_TOKEN') do
+      raise <<~MESSAGE
+        Missing environment variable GITHUB_TOKEN.
+        See https://github.com/settings/tokens to set up personal access tokens.
+        Add to the environment:
+
+            export GITHUB_TOKEN=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+
+      MESSAGE
+    end
   end
 end

lib/unwrappr/researchers/github_repo.rb

@@ -13,8 +13,8 @@ class GithubRepo
                               }ix.freeze
 
       def research(_gem_change, gem_change_info)
-        repo = match_repo(gem_change_info, :source_code_uri) ||
-               match_repo(gem_change_info, :homepage_uri)
+        repo = match_repo(gem_change_info, 'source_code_uri') ||
+               match_repo(gem_change_info, 'homepage_uri')
         gem_change_info.merge(github_repo: repo)
       end
 

lib/unwrappr/ruby_gems.rb

@@ -18,7 +18,7 @@ def gem_info(name, version)
       def parse(response, name)
         case response.status
         when 200
-          JSON.parse(response.body, object_class: OpenStruct)
+          JSON.parse(response.body)
         when 404
           nil
         else
@@ -27,8 +27,7 @@ def parse(response, name)
       end
 
       def error_message(response:, name:)
-        "Rubygems response for #{name}: "\
-          "HTTP #{response.status}: #{response.body}"
+        "Rubygems response for #{name}: HTTP #{response.status}: #{response.body}"
       end
     end
   end

lib/unwrappr/writers/project_links.rb

@@ -24,13 +24,11 @@ def write
       private
 
       def change_log
-        link_or_strikethrough('change-log',
-                              ruby_gems_info&.changelog_uri)
+        link_or_strikethrough('change-log', ruby_gems_info('changelog_uri'))
       end
 
       def source_code
-        link_or_strikethrough('source-code',
-                              ruby_gems_info&.source_code_uri)
+        link_or_strikethrough('source-code', ruby_gems_info('source_code_uri'))
       end
 
       GEM_DIFF_URL_TEMPLATE = 'https://my.diffend.io/gems/%s/%s/%s'
@@ -46,8 +44,8 @@ def gem_diff
         link_or_strikethrough('gem-diff', gem_diff_url)
       end
 
-      def ruby_gems_info
-        @gem_change_info[:ruby_gems]
+      def ruby_gems_info(*args)
+        @gem_change_info.dig(:ruby_gems, *args)
       end
 
       def link_or_strikethrough(text, url)

lib/unwrappr/writers/security_vulnerabilities.rb

@@ -85,12 +85,7 @@ def cve_url(id)
       end
 
       def cvss_v2(advisory)
-        # rubocop:disable Style/GuardClause
-        if advisory.cvss_v2
-          "CVSS V2: [#{advisory.cvss_v2} #{advisory.criticality}]"\
-            "(#{cvss_v2_url(advisory.cve_id)})"
-        end
-        # rubocop:enable Style/GuardClause
+        "CVSS V2: [#{advisory.cvss_v2} #{advisory.criticality}](#{cvss_v2_url(advisory.cve_id)})" if advisory.cvss_v2
       end
 
       def cvss_v2_url(id)

lib/unwrappr/writers/title.rb

@@ -12,7 +12,7 @@ class << self
         def write(gem_change, gem_change_info)
           embellished_gem_name = maybe_link(
             gem_change.name,
-            gem_change_info[:ruby_gems]&.homepage_uri
+            gem_change_info.dig(:ruby_gems, 'homepage_uri')
           )
           "### #{embellished_gem_name}\n"
         end

spec/lib/unwrappr/github/client_spec.rb

@@ -95,12 +95,6 @@
     end
 
     context 'without a token' do
-      before do
-        expect(ENV).to receive(:fetch)
-          .with('GITHUB_TOKEN')
-          .and_raise(KeyError, 'key not found GITHUB_TOKEN')
-      end
-
       it 'provides useful feedback' do
         expect { make_pull_request! }.to raise_error(RuntimeError, /^Missing environment variable/)
       end

spec/lib/unwrappr/lock_file_annotator_spec.rb

@@ -20,8 +20,7 @@ module Unwrappr
     describe '#annotate' do
       subject(:annotate) { annotator.annotate }
 
-      context 'given a Gemfile.lock that changes: '\
-              'rspec-support 3.7.0 -> 3.7.1' do
+      context 'given a Gemfile.lock that changes: rspec-support 3.7.0 -> 3.7.1' do
         let(:lock_file_diff_source) { instance_double(Github::PrSource) }
         let(:annotation_sink) { instance_spy(Github::PrSink) }
         let(:base_lock_file) { <<~BASE_FILE }
@@ -97,9 +96,9 @@ module Unwrappr
         before do
           allow(::Unwrappr::RubyGems).to receive(:gem_info)
             .with('rspec-support', GemVersion.new('3.7.1'))
-            .and_return(spy(homepage_uri: 'home-uri',
-                            source_code_uri: 'source-uri',
-                            changelog_uri: 'changelog-uri'))
+            .and_return({ 'homepage_uri' => 'home-uri',
+                          'source_code_uri' => 'source-uri',
+                          'changelog_uri' => 'changelog-uri' })
           allow(lock_file_diff_source).to receive(:each_file)
             .and_yield(LockFileDiff.new(filename: 'Gemfile.lock',
                                         base_file: base_lock_file,

spec/lib/unwrappr/lock_file_comparator_spec.rb

@@ -27,7 +27,7 @@ module Unwrappr
 
     it 'calls the comparator with indexed specs versions' do
       expect(SpecVersionComparator).to receive(:perform)
-        .with({ name1: 'version1' }, name2: 'version2')
+        .with({ name1: 'version1' }, { name2: 'version2' })
 
       perform
     end

spec/lib/unwrappr/researchers/github_repo_spec.rb

@@ -24,8 +24,8 @@ module Researchers
             let(:gem_change_info) do
               {
                 ruby_gems: {
-                  source_code_uri: source_code_uri,
-                  homepage_uri: homepage_uri
+                  'source_code_uri' => source_code_uri,
+                  'homepage_uri' => homepage_uri
                 }
               }
             end

spec/lib/unwrappr/ruby_gems_spec.rb

@@ -27,7 +27,7 @@ module Unwrappr
       let(:response_body) { '{"key": "value" }' }
 
       it 'returns provided details' do
-        expect(subject.key).to eql('value')
+        expect(subject['key']).to eql('value')
       end
     end
 

spec/lib/unwrappr/writers/project_links_spec.rb

@@ -21,8 +21,10 @@ module Writers
         context 'given gem change info with urls' do
           let(:gem_change_info) do
             {
-              ruby_gems: spy(source_code_uri: 'source-uri',
-                             changelog_uri: 'changelog-uri')
+              ruby_gems: {
+                'source_code_uri' => 'source-uri',
+                'changelog_uri' => 'changelog-uri'
+              }
             }
           end
 
@@ -34,8 +36,10 @@ module Writers
         context 'given gem change info with urls for an added gem' do
           let(:gem_change_info) do
             {
-              ruby_gems: spy(source_code_uri: 'source-uri',
-                             changelog_uri: 'changelog-uri')
+              ruby_gems: {
+                'source_code_uri' => 'source-uri',
+                'changelog_uri' => 'changelog-uri'
+              }
             }
           end
           let(:base_version) { nil }
@@ -48,8 +52,10 @@ module Writers
         context 'given gem change info with urls for a removed gem' do
           let(:gem_change_info) do
             {
-              ruby_gems: spy(source_code_uri: 'source-uri',
-                             changelog_uri: 'changelog-uri')
+              ruby_gems: {
+                'source_code_uri' => 'source-uri',
+                'changelog_uri' => 'changelog-uri'
+              }
             }
           end
           let(:head_version) { nil }

spec/lib/unwrappr/writers/title_spec.rb

@@ -8,7 +8,7 @@
 
     context 'given a gem homepage URI' do
       let(:gem_change_info) { { ruby_gems: ruby_gems } }
-      let(:ruby_gems) { spy(homepage_uri: 'home-uri') }
+      let(:ruby_gems) { { 'homepage_uri' => 'home-uri' } }
 
       it { should eq "### [test-gem](home-uri)\n" }
     end

unwrappr.gemspec

@@ -56,6 +56,7 @@ Gem::Specification.new do |spec| # rubocop:disable Metrics/BlockLength:
     'changelog_uri' => "#{GITHUB_URL}/blob/HEAD/CHANGELOG.md",
     'documentation_uri' => "#{GITHUB_URL}/blob/HEAD/README.md",
     'homepage_uri' => HOMEPAGE_URL,
+    'rubygems_mfa_required' => 'true',
     'source_code_uri' => GITHUB_URL
   }
 end