travis 1.11.0 → 1.12.0

data/lib/travis/cli/login.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'travis/cli'
 require 'travis/tools/github'
 require 'json'
@@ -7,16 +9,17 @@ module Travis
     class Login < ApiCommand
       skip :authenticate
 
-      description "authenticates against the API and stores the token"
+      description 'authenticates against the API and stores the token'
       on('-g', '--github-token TOKEN', 'identify by GitHub token')
-      on('-T', '--auto-token',         'try to figure out who you are automatically (might send another apps token to Travis, token will not be stored)')
+      on('-T', '--auto-token',
+         'try to figure out who you are automatically (might send another apps token to Travis, token will not be stored)')
       on('--list-github-token',        'instead of actually logging in, list found GitHub tokens')
       on('--skip-token-check',         'don\'t verify the token with github')
 
       attr_accessor :user_login
 
       def list_token
-        github.after_tokens = proc { }
+        github.after_tokens = proc {}
         github.each_token do |token|
           say token
         end
@@ -26,7 +29,10 @@ module Travis
         session.access_token = nil
         github.with_token do |token|
           endpoint_config['access_token'] = github_auth(token)
-          error("user mismatch: logged in as %p instead of %p" % [user.login, user_login]) if user_login and user.login != user_login
+          if user_login && (user.login != user_login)
+            error(format('user mismatch: logged in as %p instead of %p', user.login,
+                         user_login))
+          end
           unless user.correct_scopes?
             error(
               "#{user.login} has not granted Travis CI the required permissions. " \
@@ -37,9 +43,9 @@ module Travis
           success("Successfully logged in as #{user.login}!")
         end
 
-        unless session.access_token
-          raise Travis::Client::GitHubLoginFailed, "all GitHub tokens given were invalid"
-        end
+        return if session.access_token
+
+        raise Travis::Client::GitHubLoginFailed, 'all GitHub tokens given were invalid'
       end
 
       def run
@@ -58,15 +64,15 @@ module Travis
             g.drop_token    = !list_github_token
             g.login_header  = proc { login_header }
             g.debug         = proc { |log| debug(log) }
-            g.after_tokens  = proc { g.explode = true and error("no suitable github token found") }
+            g.after_tokens  = proc { g.explode = true and error('no suitable github token found') }
           end
         end
       end
 
       def login_header
-        say "GitHub deprecated its Authorizations API exchanging a password for a token."
-        say "Please visit https://github.blog/2020-07-30-token-authentication-requirements-for-api-and-git-operations for more information."
-        say "Try running with #{color("--github-token", :info)} or #{color("--auto-token", :info)} ."
+        say 'GitHub deprecated its Authorizations API exchanging a password for a token.'
+        say 'Please visit https://github.blog/2020-07-30-token-authentication-requirements-for-api-and-git-operations for more information.'
+        say "Try running with #{color('--github-token', :info)} or #{color('--auto-token', :info)} ."
       end
     end
   end

data/lib/travis/cli/logout.rb

@@ -1,14 +1,16 @@
+# frozen_string_literal: true
+
 require 'travis/cli'
 
 module Travis
   module CLI
     class Logout < ApiCommand
-      description "deletes the stored API token"
+      description 'deletes the stored API token'
 
       def run
         session.logout
         endpoint_config.delete('access_token')
-        success("Successfully logged out!")
+        success('Successfully logged out!')
       end
     end
   end

data/lib/travis/cli/logs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'travis/cli'
 require 'travis/tools/safe_string'
 require 'travis/tools/system'
@@ -6,8 +8,12 @@ module Travis
   module CLI
     class Logs < RepoCommand
       attr_accessor :delete, :reason
-      description "streams test logs"
-      on('-d', '--delete [REASON]', 'remove logs') { |c, reason| c.delete, c.reason = true, reason }
+
+      description 'streams test logs'
+      on('-d', '--delete [REASON]', 'remove logs') do |c, reason|
+        c.delete = true
+        c.reason = reason
+      end
       on('-f', '--force', 'do not ask user to confirm deleting the logs')
       on('--[no-]stream', 'only print current logs, do not stream')
 
@@ -25,17 +31,19 @@ module Travis
 
       def delete_log(job)
         unless force?
-          error "not deleting logs without --force" unless interactive?
-          error "aborted" unless danger_zone? "Do you really want to delete the build log for #{color(job.inspect_info, :underline)}?"
+          error 'not deleting logs without --force' unless interactive?
+          error 'aborted' unless danger_zone? "Do you really want to delete the build log for #{color(job.inspect_info,
+                                                                                                      :underline)}?"
         end
 
-        warn "deleting log for #{color(job.inspect_info, [:bold, :info])}"
+        warn "deleting log for #{color(job.inspect_info, %i[bold info])}"
         job.delete_log(reason || {})
       end
 
       def display_log(job)
-        info "displaying logs for #{color(job.inspect_info, [:bold, :info])}"
+        info "displaying logs for #{color(job.inspect_info, %i[bold info])}"
         return print_log(job.log.body) unless stream?
+
         job.log.body { |part| print_log(part) }
       ensure
         print "\e[0m" if interactive?
@@ -47,19 +55,20 @@ module Travis
 
       private
 
-        def job(number)
-          number = last_build.number + number if number.start_with? '.'
-          job    = super(number) || build(number) || branch(number)
-          job    = job.jobs.first if job.respond_to? :jobs
-          job
-        end
+      def job(number)
+        number = last_build.number + number if number.start_with? '.'
+        job    = super(number) || build(number) || branch(number)
+        job    = job.jobs.first if job.respond_to? :jobs
+        job
+      end
 
-        def check_websocket
-          require 'websocket-native' if stream?
-        rescue LoadError => e
-          raise e if e.respond_to?(:path) and e.path != 'websocket-native'
-          info "speed up log streaming by installing the websocket-native gem"
-        end
+      def check_websocket
+        require 'websocket-native' if stream?
+      rescue LoadError => e
+        raise e if e.respond_to?(:path) && (e.path != 'websocket-native')
+
+        info 'speed up log streaming by installing the websocket-native gem'
+      end
     end
   end
-end
+end

data/lib/travis/cli/monitor.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'travis/cli'
 require 'travis/tools/notification'
 
@@ -9,10 +11,10 @@ module Travis
 
       on('-r', '--repo SLUG', 'monitor given repository (can be used more than once)') do |c, slug|
         c.repos << slug
-        c.send(:error, "SLUG should be of the form OWNER/REPO") unless slug.split('/').compact.size == 2
+        c.send(:error, 'SLUG should be of the form OWNER/REPO') unless slug.split('/').compact.size == 2
       end
 
-      types = Tools::Notification::DEFAULT.map(&:to_s).join(", ")
+      types = Tools::Notification::DEFAULT.map(&:to_s).join(', ')
       on('-n', '--[no-]notify [TYPE]', "send out desktop notifications (optional type: #{types})") do |c, type|
         c.setup_notification(type)
       end
@@ -75,6 +77,7 @@ module Travis
 
       def monitor?(entity)
         return true if all?
+
         entity.pull_request? ? pull? : push?
       end
 
@@ -84,26 +87,26 @@ module Travis
           color(entity.inspect_info, [entity.color, :bold]),
           color(entity.state, entity.color),
           color(entity.commit.subject, entity.color)
-        ].join(" ")
+        ].join(' ')
         notification.notify(entity.repository.slug, [
           entity.class.name[/[^:]+$/],
           entity.number,
-          entity.state + ":",
+          "#{entity.state}:",
           entity.commit.subject
-        ].join(" "))
+        ].join(' '))
       end
 
       def handle_event(event)
         entity = event.job          || event.build
         time   = entity.finished_at || entity.started_at
         display(entity, time) if monitor? entity
-      rescue Travis::Client::Error => error
-        raise error if explode?
+      rescue Travis::Client::Error => e
+        raise e if explode?
       end
 
       def run
         listen(*repos) do |listener|
-          listener.on_connect { say description, "Monitoring #{"builds for " if builds?}%s:" }
+          listener.on_connect { say description, "Monitoring #{'builds for ' if builds?}%s:" }
           listener.on(*events) { |e| handle_event(e) }
         end
       end

data/lib/travis/cli/open.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'travis/cli'
 require 'launchy'
 
 module Travis
   module CLI
     class Open < RepoCommand
-      description "opens a build or job in the browser"
+      description 'opens a build or job in the browser'
 
       on('-g', '--github', 'Open the corresponding project, compare view or pull request on GitHub')
       on('-p', '--print',  'Print out the URL instead of opening it in a browser')
@@ -12,7 +14,7 @@ module Travis
       def run(number = nil)
         url = url_for(number)
         if print?
-          say url, "web view: %s"
+          say url, 'web view: %s'
         else
           Launchy.open(url)
         end
@@ -20,20 +22,21 @@ module Travis
 
       private
 
-        def url_for(number)
-          return repo_url unless number
-          entity = job(number) || build(number)
-          error "could not find job or build #{repository.slug}##{number}" unless entity
-          github ? entity.commit.compare_url : "#{repo_url}/#{entity.class.many}/#{entity.id}"
-        end
+      def url_for(number)
+        return repo_url unless number
 
-        def repo_url
-          "https://#{host}/#{slug}"
-        end
+        entity = job(number) || build(number)
+        error "could not find job or build #{repository.slug}##{number}" unless entity
+        github ? entity.commit.compare_url : "#{repo_url}/#{entity.class.many}/#{entity.id}"
+      end
 
-        def host
-          github ? "github.com" : session.config['host']
-        end
+      def repo_url
+        "https://#{host}/#{slug}"
+      end
+
+      def host
+        github ? 'github.com' : session.config['host']
+      end
     end
   end
 end

data/lib/travis/cli/parser.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'travis/cli'
 require 'optparse'
 

data/lib/travis/cli/pubkey.rb

@@ -1,13 +1,15 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require 'travis/cli'
 
 module Travis
   module CLI
     class Pubkey < RepoCommand
       attr_accessor :key_format
+
       description "prints out a repository's public key"
-      on('-p', '--pem', 'encode in format used by pem') { |c,_| c.key_format = :pem }
-      on('-f', '--fingerprint', 'display fingerprint')  { |c,_| c.key_format = :fingerprint }
+      on('-p', '--pem', 'encode in format used by pem') { |c, _| c.key_format = :pem }
+      on('-f', '--fingerprint', 'display fingerprint')  { |c, _| c.key_format = :fingerprint }
 
       def run
         error "#{key_format} format not supported by #{api_endpoint}" unless key
@@ -16,15 +18,15 @@ module Travis
 
       private
 
-        def key
-          key = repository.public_key
-          case self.key_format ||= :ssh
-          when :fingerprint then key.fingerprint
-          when :pem         then key.to_s
-          when :ssh         then key.to_ssh
-          else raise "unknown format #{key_format}"
-          end
+      def key
+        key = repository.public_key
+        case self.key_format ||= :ssh
+        when :fingerprint then key.fingerprint
+        when :pem         then key.to_s
+        when :ssh         then key.to_ssh
+        else raise "unknown format #{key_format}"
         end
+      end
     end
   end
 end

data/lib/travis/cli/raw.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'travis/cli'
-require 'pp'
 
 module Travis
   module CLI
     class Raw < ApiCommand
-      description "makes an (authenticated) API call and prints out the result"
+      description 'makes an (authenticated) API call and prints out the result'
 
       skip :authenticate
       on('--[no-]json', 'display as json')
@@ -13,7 +14,7 @@ module Travis
         reply = session.get_raw(resource)
         json? ? say(reply.to_json) : pp(reply)
       rescue Travis::Client::NotFound
-        error "resource not found"
+        error 'resource not found'
       end
     end
   end

data/lib/travis/cli/repo_command.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'travis/cli'
 require 'yaml'
 
@@ -9,7 +11,7 @@ module Travis
       on('-g', '--github-token TOKEN', 'identify by GitHub token')
       on('-r', '--repo SLUG', 'repository to use (will try to detect from current git clone)') do |c, slug|
         c.slug = slug
-        c.error "SLUG should be of the form OWNER/REPO" unless slug.split('/').compact.size == 2
+        c.error 'SLUG should be of the form OWNER/REPO' unless slug.split('/').compact.size == 2
       end
       on('-R', '--store-repo SLUG', 'like --repo, but remembers value for current directory') do |c, slug|
         c.slug = slug
@@ -17,12 +19,15 @@ module Travis
       end
 
       attr_accessor :slug
+
       abstract
 
       def setup
         setup_enterprise
-        error "Can't figure out GitHub repo name. Ensure you're in the repo directory, or specify the repo name via the -r option (e.g. travis <command> -r <owner>/<repo>)" unless self.slug ||= find_slug
-        error "GitHub repo name is invalid, it should be of the form 'owner/repo'" unless self.slug.include?("/")
+        unless self.slug ||= find_slug
+          error "Can't figure out GitHub repo name. Ensure you're in the repo directory, or specify the repo name via the -r option (e.g. travis <command> -r <owner>/<repo>)"
+        end
+        error "GitHub repo name is invalid, it should be of the form 'owner/repo'" unless self.slug.include?('/')
         self.api_endpoint = detect_api_endpoint
         super
         repository.load # makes sure we actually have access to the repo
@@ -36,140 +41,146 @@ module Travis
 
       private
 
-        def build(number_or_id)
-          return super if number_or_id.is_a? Integer
-          repository.build(number_or_id)
-        end
+      def build(number_or_id)
+        return super if number_or_id.is_a? Integer
 
-        def job(number_or_id)
-          return super if number_or_id.is_a? Integer
-          repository.job(number_or_id)
-        end
+        repository.build(number_or_id)
+      end
 
-        def branch(name)
-          repository.branch(name)
-        end
+      def job(number_or_id)
+        return super if number_or_id.is_a? Integer
 
-        def last_build
-          repository.last_build or error("no build yet for #{slug}")
-        end
+        repository.job(number_or_id)
+      end
 
-        def detected_endpoint?
-          !explicit_api_endpoint?
-        end
+      def branch(name)
+        repository.branch(name)
+      end
 
-        def find_slug
-          load_slug || begin
-            slug = detect_slug
-            interactive? ? store_slug(slug) : slug if slug
-          end
-        end
+      def last_build
+        repository.last_build or error("no build yet for #{slug}")
+      end
+
+      def detected_endpoint?
+        !explicit_api_endpoint?
+      end
 
-        def detect_slug
-          git_head    = `git name-rev --name-only HEAD 2>#{IO::NULL}`.chomp
-          git_remote  = `git config --get branch.#{git_head}.remote 2>#{IO::NULL}`.chomp
-          git_remote  = 'origin' if git_remote.empty?
-          git_info    = `git ls-remote --get-url #{git_remote} 2>#{IO::NULL}`.chomp
-
-          if parse_remote(git_info) =~ GIT_REGEX
-            detected_slug = $1
-            if interactive?
-              if agree("Detected repository as #{color(detected_slug, :info)}, is this correct? ") { |q| q.default = 'yes' }
-                detected_slug
-              else
-                ask("Repository slug (owner/name): ") { |q| q.default = detected_slug }
-              end
-            else
-              info "detected repository as #{color(detected_slug, :bold)}"
-              detected_slug
-            end
+      def find_slug
+        load_slug || begin
+          slug = detect_slug
+          if slug
+            interactive? ? store_slug(slug) : slug
           end
         end
+      end
+
+      def detect_slug
+        git_head    = `git name-rev --name-only HEAD 2>#{IO::NULL}`.chomp
+        git_remote  = `git config --get branch.#{git_head}.remote 2>#{IO::NULL}`.chomp
+        git_remote  = 'origin' if git_remote.empty?
+        git_info    = `git ls-remote --get-url #{git_remote} 2>#{IO::NULL}`.chomp
+
+        return unless parse_remote(git_info) =~ GIT_REGEX
 
-        def parse_remote(url)
-          if url =~ /^git@[^:]+:/
-            path = url.split(':').last
-            path = "/#{path}" unless path.start_with?('/')
-            path
+        detected_slug = ::Regexp.last_match(1)
+        if interactive?
+          if agree("Detected repository as #{color(detected_slug, :info)}, is this correct? ") do |q|
+               q.default = 'yes'
+             end
+            detected_slug
           else
-            URI.parse(url).path
+            ask('Repository slug (owner/name): ') { |q| q.default = detected_slug }
           end
+        else
+          info "detected repository as #{color(detected_slug, :bold)}"
+          detected_slug
         end
+      end
 
-        def load_slug
-          stored = `git config --get travis.slug`.chomp
-          stored unless stored.empty?
+      def parse_remote(url)
+        if url =~ /^git@[^:]+:/
+          path = url.split(':').last
+          path = "/#{path}" unless path.start_with?('/')
+          path
+        else
+          URI.parse(url).path
         end
+      end
 
-        def store_slug(value)
-          `git config travis.slug #{value}` if value
-          value
-        end
+      def load_slug
+        stored = `git config --get travis.slug`.chomp
+        stored unless stored.empty?
+      end
 
-        def repo_config
-          config['repos'] ||= {}
-          config['repos'][slug] ||= {}
-        end
+      def store_slug(value)
+        `git config travis.slug #{value}` if value
+        value
+      end
 
-        def detect_api_endpoint
-          if explicit_api_endpoint? or enterprise?
-            repo_config['endpoint'] = api_endpoint
-          elsif ENV['TRAVIS_ENDPOINT']
-            ENV['TRAVIS_ENDPOINT']
-          elsif config['default_endpoint'] and config['default_endpoint'] !~ TRAVIS
-            repo_config['endpoint'] ||= config['default_endpoint']
-          else
-            repo_config['endpoint'] ||= begin
-              load_gh
-              GH.head("/repos/#{slug}")
-              Travis::Client::ORG_URI
-            rescue GH::Error
-              Travis::Client::COM_URI
-            end
-          end
-        end
+      def repo_config
+        config['repos'] ||= {}
+        config['repos'][slug] ||= {}
+      end
 
-        def travis_config
-          @travis_config ||= begin
-            payload = YAML.load_file(travis_yaml)
-            payload.respond_to?(:to_hash) ? payload.to_hash : {}
+      def detect_api_endpoint
+        if explicit_api_endpoint? || enterprise?
+          repo_config['endpoint'] = api_endpoint
+        elsif ENV['TRAVIS_ENDPOINT']
+          ENV['TRAVIS_ENDPOINT']
+        elsif config['default_endpoint'] && config['default_endpoint'] !~ (TRAVIS)
+          repo_config['endpoint'] ||= config['default_endpoint']
+        else
+          repo_config['endpoint'] ||= begin
+            load_gh
+            GH.head("/repos/#{slug}")
+            Travis::Client::ORG_URI
+          rescue GH::Error
+            Travis::Client::COM_URI
           end
         end
+      end
 
-        def travis_yaml(dir = Dir.pwd)
-          path = File.expand_path('.travis.yml', dir)
-          if File.exist? path
-            path
-          else
-            parent = File.expand_path('..', dir)
-            error "no .travis.yml found" if parent == dir
-            travis_yaml(parent)
-          end
+      def travis_config
+        @travis_config ||= begin
+          payload = YAML.load_file(travis_yaml)
+          payload.respond_to?(:to_hash) ? payload.to_hash : {}
         end
+      end
 
-        def confirm_and_save_travis_config(confirm = true, file = travis_yaml)
-          if confirm
-            ans = ask [
-              nil,
-              color("Overwrite the config file #{travis_yaml} with the content below?", [:info, :yellow]),
-              color("This reformats the existing file.", [:info, :red]),
-              travis_config.to_yaml,
-              color("(y/N)", [:info, :yellow])
-            ].join("\n\n")
-            proceed = ans =~ /^y/i
-          else
-            proceed = true
-          end
-
-          save_travis_config if proceed
+      def travis_yaml(dir = Dir.pwd)
+        path = File.expand_path('.travis.yml', dir)
+        if File.exist? path
+          path
+        else
+          parent = File.expand_path('..', dir)
+          error 'no .travis.yml found' if parent == dir
+          travis_yaml(parent)
         end
+      end
 
-        def save_travis_config(file = travis_yaml)
-          yaml = travis_config.to_yaml
-          yaml.gsub! /^(\s+)('on'|true):/, "\\1on:"
-          yaml.gsub! /\A---\s*\n/, ''
-          File.write(file, yaml)
-        end
+      def confirm_and_save_travis_config(confirm = true, _file = travis_yaml)
+        if confirm
+          ans = ask [
+            nil,
+            color("Overwrite the config file #{travis_yaml} with the content below?", %i[info yellow]),
+            color('This reformats the existing file.', %i[info red]),
+            travis_config.to_yaml,
+            color('(y/N)', %i[info yellow])
+          ].join("\n\n")
+          proceed = ans =~ /^y/i
+        else
+          proceed = true
+        end
+
+        save_travis_config if proceed
+      end
+
+      def save_travis_config(file = travis_yaml)
+        yaml = travis_config.to_yaml
+        yaml.gsub!(/^(\s+)('on'|true):/, '\\1on:')
+        yaml.gsub!(/\A---\s*\n/, '')
+        File.write(file, yaml)
+      end
     end
   end
 end