Merge pull request square#35 from square/segiddins/use-terrapin

segiddins · web-flow · commit d52796a0bf08 · 2019-01-17T11:30:10.000-08:00
Update to use Terrapin instead of Cocaine
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
+*:lock
 *.gem
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,10 +1,9 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  Include:
-    - Rakefile
+  TargetRubyVersion: 2.2
 
-Style/FileName:
+Naming/FileName:
   Exclude:
     - 'bin/git-fastclone'
     - 'lib/git-fastclone.rb'
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -1,19 +1,36 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-03-29 21:03:41 -0700 using RuboCop version 0.35.1.
+# on 2019-01-17 09:51:29 -0800 using RuboCop version 0.63.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 1
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - 'spec/git_fastclone_runner_spec.rb'
+
 # Offense count: 5
 Metrics/AbcSize:
   Max: 25
 
+# Offense count: 4
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 216
+
 # Offense count: 1
 Metrics/CyclomaticComplexity:
   Max: 7
 
 # Offense count: 1
 Metrics/PerceivedComplexity:
   Max: 8
+
+# Offense count: 6
+# Configuration parameters: .
+# SupportedStyles: inline, group
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
diff --git a/.travis.yml b/.travis.yml
@@ -2,4 +2,7 @@ language:
   ruby
 
 rvm:
+  - 2.1.3
   - 2.2
+  - 2.3.1
+  - 2.6.0
diff --git a/Gemfile b/Gemfile
@@ -1,12 +1,13 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 group :development do
   gem 'bundler'
   gem 'rake'
-  gem 'rubocop'
+  gem 'rubocop', install_if: -> { RUBY_VERSION >= '2.3' }
 end
 
 gem 'rspec'
-gem 'logger'
 
 gemspec
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,33 +1,22 @@
 PATH
   remote: .
   specs:
-    git-fastclone (1.1.2)
-      cocaine
+    git-fastclone (1.2.0)
       colorize
+      terrapin (~> 0.6.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.0.1)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
     ast (2.4.0)
-    climate_control (0.0.3)
-      activesupport (>= 3.0)
-    cocaine (0.5.8)
-      climate_control (>= 0.0.3, < 1.0)
+    climate_control (0.2.0)
     colorize (0.8.1)
-    concurrent-ruby (1.0.4)
     diff-lcs (1.2.5)
-    i18n (0.7.0)
-    logger (1.2.8)
-    minitest (5.10.1)
-    parallel (1.12.1)
-    parser (2.5.0.5)
+    jaro_winkler (1.5.2)
+    parallel (1.13.0)
+    parser (2.6.0.0)
       ast (~> 2.4.0)
-    powerpack (0.1.1)
+    powerpack (0.1.2)
     rainbow (3.0.0)
     rake (10.4.2)
     rspec (3.4.0)
@@ -43,29 +32,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.4.0)
     rspec-support (3.4.1)
-    rubocop (0.54.0)
+    rubocop (0.63.0)
+      jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
-      parser (>= 2.5)
+      parser (>= 2.5, != 2.5.1.1)
       powerpack (~> 0.1)
       rainbow (>= 2.2.2, < 4.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-    unicode-display_width (1.3.0)
+      unicode-display_width (~> 1.4.0)
+    ruby-progressbar (1.10.0)
+    terrapin (0.6.0)
+      climate_control (>= 0.0.3, < 1.0)
+    unicode-display_width (1.4.1)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler
   git-fastclone!
-  logger
   rake
   rspec
   rubocop
 
 BUNDLED WITH
-   1.16.1
+   1.17.3
diff --git a/README.md b/README.md
@@ -75,7 +75,7 @@ Before accepting any pull requests, we need you to sign an [Individual Contribut
 
 Acknowledgements
 ----------------
-[thoughtbot/cocaine][3] - jyurek and collaborators
+[thoughtbot/terrapin][3] - jyurek and collaborators
 
 [robolson][4]
 
@@ -104,7 +104,7 @@ License
 
 [1]: https://corner.squareup.com/2015/11/fastclone.html
 [2]: https://docs.google.com/a/squareup.com/forms/d/13WR8m5uZ2nAkJH41k7GdVBXAAbzDk00vxtEYjd6Imzg/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1
-[3]: https://github.com/thoughtbot/cocaine
+[3]: https://github.com/thoughtbot/terrapin
 [4]: https://github.com/robolson
 [5]: https://github.com/ianchesal
 [6]: https://github.com/mtauraso
diff --git a/Rakefile b/Rakefile
@@ -1,11 +1,16 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'bundler/setup'
 
-task default: %w(spec rubocop)
+task default: %w[spec]
 
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
 
-require 'rubocop/rake_task'
-RuboCop::RakeTask.new
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+  task default: :rubocop
+rescue LoadError => e
+  raise unless e.path == 'rubocop/rake_task'
+end
diff --git a/bin/git-fastclone b/bin/git-fastclone
@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 # Copyright 2015 Square Inc.
 
diff --git a/git-fastclone.gemspec b/git-fastclone.gemspec
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2015 Square Inc.
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -14,24 +16,26 @@
 
 require 'date'
 
-$:.push File.expand_path("../lib", __FILE__)
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'git-fastclone/version'
 
 Gem::Specification.new do |gem|
   gem.name          = 'git-fastclone'
   gem.version       = GitFastCloneVersion::VERSION
   gem.date          = Date.today.to_s
-  gem.summary       = %q(git-clone --recursive on steroids!)
-  gem.description   = %q(A git command that uses reference repositories and threading to quickly and recursively clone repositories with many nested submodules)
+  gem.summary       = 'git-clone --recursive on steroids!'
+  gem.description   = 'A git command that uses reference repositories and threading to quickly' \
+                      'and recursively clone repositories with many nested submodules'
   gem.authors       = ['Michael Tauraso', 'James Chang']
   gem.email         = ['mtauraso@squareup.com', 'jchang@squareup.com']
-  gem.files         = Dir['Rakefile', '{bin,lib,man,test,spec}/**/*', 'README*', 'LICENSE*'] & `git ls-files -z`.split("\0")
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = Dir['Rakefile', '{bin,lib,man,test,spec}/**/*', 'README*', 'LICENSE*'] &
+                      `git ls-files -z`.split("\0")
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
   gem.homepage      = 'http://square.github.io/git-fastclone/'
   gem.license       = 'Apache'
 
-  gem.add_runtime_dependency 'cocaine'
   gem.add_runtime_dependency 'colorize'
+  gem.add_runtime_dependency 'terrapin', '~> 0.6.0'
 end
diff --git a/lib/git-fastclone.rb b/lib/git-fastclone.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2015 Square Inc.
 
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -15,7 +17,7 @@
 require 'optparse'
 require 'fileutils'
 require 'logger'
-require 'cocaine'
+require 'terrapin'
 require 'timeout'
 
 # Contains helper module UrlHelper and execution class GitFastClone::Runner
@@ -53,7 +55,7 @@ def reference_repo_submodule_file(url, reference_dir, using_local_repo)
 
     def reference_repo_lock_file(url, reference_dir, using_local_repo)
       lock_file_name = "#{reference_repo_dir(url, reference_dir, using_local_repo)}:lock"
-      File.open(lock_file_name, File::RDWR | File::CREAT, 0644)
+      File.open(lock_file_name, File::RDWR | File::CREAT, 0o644)
     end
     module_function :reference_repo_lock_file
   end
@@ -117,7 +119,7 @@ def run
       end
 
       puts "Cloning #{path_from_git_url(url)} to #{File.join(abs_clone_path, path)}"
-      Cocaine::CommandLine.environment['GIT_ALLOW_PROTOCOL'] =
+      Terrapin::CommandLine.environment['GIT_ALLOW_PROTOCOL'] =
         ENV['GIT_ALLOW_PROTOCOL'] || DEFAULT_GIT_ALLOW_PROTOCOL
       clone(url, options[:branch], path)
     end
@@ -139,7 +141,7 @@ def parse_options
           logger.formatter = proc do |_severity, _datetime, _progname, msg|
             "#{msg}\n"
           end
-          Cocaine::CommandLine.logger = logger
+          Terrapin::CommandLine.logger = logger
         end
 
         opts.on('-c', '--color', 'Display colored output') do
@@ -172,8 +174,9 @@ def parse_inputs
 
       if Dir.exist?(path)
         msg = "Clone destination #{File.join(abs_clone_path, path)} already exists!"
-        fail msg.red if color
-        fail msg
+        raise msg.red if color
+
+        raise msg
       end
 
       self.reference_dir = ENV['REFERENCE_REPO_DIR'] || DEFAULT_REFERENCE_REPO_DIR
@@ -188,16 +191,16 @@ def clone(url, rev, src_dir)
       initial_time = Time.now
 
       with_git_mirror(url) do |mirror|
-        Cocaine::CommandLine.new('git clone', '--quiet --reference :mirror :url :path')
-          .run(mirror: mirror.to_s,
-               url: url.to_s,
-               path: File.join(abs_clone_path, src_dir).to_s)
+        Terrapin::CommandLine.new('git clone', '--quiet --reference :mirror :url :path')
+                             .run(mirror: mirror.to_s,
+                                  url: url.to_s,
+                                  path: File.join(abs_clone_path, src_dir).to_s)
       end
 
       # Only checkout if we're changing branches to a non-default branch
       if rev
         Dir.chdir(File.join(abs_clone_path, src_dir)) do
-          Cocaine::CommandLine.new('git checkout', '--quiet :rev').run(rev: rev.to_s)
+          Terrapin::CommandLine.new('git checkout', '--quiet :rev').run(rev: rev.to_s)
         end
       end
 
@@ -221,8 +224,8 @@ def update_submodules(pwd, url)
       threads = []
       submodule_url_list = []
 
-      Cocaine::CommandLine.new('cd', ':path; git submodule init 2>&1')
-        .run(path: File.join(abs_clone_path, pwd)).split("\n").each do |line|
+      Terrapin::CommandLine.new('cd', ':path; git submodule init 2>&1')
+                           .run(path: File.join(abs_clone_path, pwd)).split("\n").each do |line|
         submodule_path, submodule_url = parse_update_info(line)
         submodule_url_list << submodule_url
 
@@ -236,10 +239,10 @@ def update_submodules(pwd, url)
     def thread_update_submodule(submodule_url, submodule_path, threads, pwd)
       threads << Thread.new do
         with_git_mirror(submodule_url) do |mirror|
-          Cocaine::CommandLine.new('cd', ':dir; git submodule update --quiet --reference :mirror :path')
-            .run(dir: File.join(abs_clone_path, pwd).to_s,
-                 mirror: mirror.to_s,
-                 path: submodule_path.to_s)
+          Terrapin::CommandLine.new('cd', ':dir; git submodule update --quiet --reference :mirror :path')
+                               .run(dir: File.join(abs_clone_path, pwd).to_s,
+                                    mirror: mirror.to_s,
+                                    path: submodule_path.to_s)
         end
 
         update_submodules(File.join(pwd, submodule_path), submodule_url)
@@ -313,15 +316,14 @@ def prefetch(submodule_file)
     # that this repo has been updated on this run of fastclone
     def store_updated_repo(url, mirror, repo_name, fail_hard)
       unless Dir.exist?(mirror)
-        Cocaine::CommandLine.new('git clone', '--mirror :url :mirror')
-          .run(url: url.to_s, mirror: mirror.to_s)
+        Terrapin::CommandLine.new('git clone', '--mirror :url :mirror')
+                             .run(url: url.to_s, mirror: mirror.to_s)
       end
 
-      Cocaine::CommandLine.new('cd', ':path; git remote update --prune').run(path: mirror)
+      Terrapin::CommandLine.new('cd', ':path; git remote update --prune').run(path: mirror)
 
       reference_updated[repo_name] = true
-
-    rescue Cocaine::ExitStatusError => e
+    rescue Terrapin::ExitStatusError => e
       # To avoid corruption of the cache, if we failed to update or check out we remove
       # the cache directory entirely. This may cause the current clone to fail, but if the
       # underlying error from git is transient it will not affect future clones.
diff --git a/lib/git-fastclone/version.rb b/lib/git-fastclone/version.rb
@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 # Version string for git-fastclone
 module GitFastCloneVersion
-  VERSION = '1.1.2'.freeze
+  VERSION = '1.2.0'.freeze
 end
diff --git a/spec/git_fastclone_runner_spec.rb b/spec/git_fastclone_runner_spec.rb
diff --git a/spec/git_fastclone_url_helper_spec.rb b/spec/git_fastclone_url_helper_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb

-Original file line number
+Diff line change
   ruby
 rvm:
 +  - 2.1.3
   - 2.2
 +  - 2.3.1
 +  - 2.6.0
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`#!/usr/bin/env ruby`
	`2`	`+# frozen_string_literal: true`
`2`	`3`
`3`	`4`	`# Copyright 2015 Square Inc.`
`4`	`5`