Adding RuboCop to pre-commit hook to pretty format

Konstantin Gredeskoul · Konstantin Gredeskoul · commit 2cf08558881d · 2019-11-25T18:21:10.000-08:00
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
-/bazel-*
+**/bazel-*
+**/.idea
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,2 @@
+inherit_gem:
+  relaxed-rubocop: .rubocop.yml
diff --git a/bin/deps b/bin/deps
@@ -0,0 +1,11 @@
+# vim: ft=shell
+
+export BashMatic="${HOME}/.bashmatic"
+
+[[ -s ${BashMatic}/init.sh ]] || {
+  rm -rf "${BashMatic}" 2>/dev/null
+  git clone https://github.com/kigster/bashmatic "${BashMatic}" 2>&1 1>/dev/null
+}
+
+source "${BashMatic}/init.sh"
+
diff --git a/bin/post-commit b/bin/post-commit
@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+[[ -x bin/deps ]] && source bin/deps
+[[ -x bin/setup ]] && source bin/setup
+
+[[ -z ${BashMatic} ]] && { 
+  echo "Failed to initialize BASH library."
+  exit 1
+}
+
+set +e
+
+info "Running Rubocop, please wait..."
+rubocop -F -D 
+code=$?
+
+if [[ ${code} -ne 0 ]]; then
+  run::set-next show-output-on
+  run "rubocop -a -D -P"
+  
+  run::set-next abort-on-error
+  run "rubocop -D -P"
+fi
+  
+success "RuboCop ran successfully."
diff --git a/bin/setup b/bin/setup
@@ -0,0 +1,26 @@
+#!/usr/bin/env bash
+
+[[ -x bin/deps ]] && source bin/deps
+
+[[ -z ${BashMatic} ]] && { 
+  echo "Failed to initialize BASH library."
+  exit 1
+}
+
+# abort on error
+run::set-all abort-on-error
+
+# install rubocop
+lib::gem::install relaxed-rubocop
+lib::gem::install rubocop
+
+[[ -f .rubocop.yml ]] || {
+  info "Setting up .rubocop.yml file..."
+  echo "
+inherit_gem:
+  relaxed-rubocop: .rubocop.yml
+" > .rubocop.yml
+}
+
+
+
diff --git a/examples/Gemfile b/examples/Gemfile
@@ -2,6 +2,6 @@
 
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gem 'rspec', '~> 3.7.0'
diff --git a/examples/bin/show_version.rb b/examples/bin/show_version.rb
@@ -1,6 +1,9 @@
 #!/usr/bin/ruby
+# frozen_string_literal: true
 
 require 'foo'
 
 bar = Foo::Bar.new
+
 puts Foo::VERSION
+puts bar.inspect
diff --git a/examples/lib/foo.rb b/examples/lib/foo.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Foo
   require 'foo/bar'
   require 'foo/version'
diff --git a/examples/lib/foo/bar.rb b/examples/lib/foo/bar.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'openssl'
 
 module Foo
diff --git a/examples/lib/foo/version.rb b/examples/lib/foo/version.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Foo
   VERSION = "0.0.1"
 end
diff --git a/examples/spec/foo/version_spec.rb b/examples/spec/foo/version_spec.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative '../spec_helper'
 require 'foo/version'
 
diff --git a/examples/spec/spec_helper.rb b/examples/spec/spec_helper.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
@@ -11,7 +13,7 @@
 
   config.warnings = true
   config.filter_run_when_matching :focus
-  #config.disable_monkey_patching!
+  # config.disable_monkey_patching!
   config.order = :random
   Kernel.srand config.seed
 end
diff --git a/ruby/private/bundle/create_bundle_build_file.rb b/ruby/private/bundle/create_bundle_build_file.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 TEMPLATE = 'load(
   "{workspace_name}//ruby:defs.bzl",
   "ruby_library",
@@ -61,53 +63,51 @@
 require "bundler"
 
 def create_bundle_build_file(build_out_file, lock_file, repo_name, excludes, workspace_name)
-	# TODO: properly calculate path/ruby version here
-	# ruby_version = RUBY_VERSION # doesnt work because verion is 2.5.5 path is 2.5.0
-	ruby_version = "*"
+  # TODO: properly calculate path/ruby version here
+  # ruby_version = RUBY_VERSION # doesnt work because verion is 2.5.5 path is 2.5.0
+  ruby_version = "*"
 
-	template_out = TEMPLATE.gsub("{workspace_name}", workspace_name)
-												 .gsub("{exclude}", excludes)
-												 .gsub("{repo_name}", repo_name)
-												 .gsub("{ruby_version}", ruby_version)
+  template_out = TEMPLATE.gsub("{workspace_name}", workspace_name)
+                         .gsub("{exclude}", excludes)
+                         .gsub("{repo_name}", repo_name)
+                         .gsub("{ruby_version}", ruby_version)
 
+  # Append to the end specific gem libraries and dependencies
+  bundle = Bundler::LockfileParser.new(Bundler.read_file(lock_file))
+
+  bundle.specs.each { |spec|
+    deps = spec.dependencies.map(&:name)
+    deps += [":bundler_setup"]
+    template_out += GEM_TEMPLATE.gsub("{exclude}", excludes)
+                                .gsub("{name}", spec.name)
+                                .gsub("{version}", spec.version.to_s)
+                                .gsub("{deps}", deps.to_s)
+                                .gsub("{repo_name}", repo_name)
+                                .gsub("{ruby_version}", ruby_version)
+  }
 
+  # Append collection of all gems
+  template_out += ALL_TEMPLATE.gsub("{repo_name}", repo_name)
+                              .gsub("{deps}", ([":bundler_setup"] + bundle.specs.map(&:name)).to_s)
 
-  # Append to the end specific gem libraries and dependencies
-	bundle = Bundler::LockfileParser.new(Bundler.read_file(lock_file))
-
-	bundle.specs.each { |spec|
-	  	deps = spec.dependencies.map{ |d| d.name }
-	  	deps += [":bundler_setup"]
-	  	template_out += GEM_TEMPLATE.gsub("{exclude}", excludes)
-	  															.gsub("{name}", spec.name)
-	  															.gsub("{version}", spec.version.to_s)
-	  															.gsub("{deps}", deps.to_s)
-																  .gsub("{repo_name}", repo_name)
-																  .gsub("{ruby_version}", ruby_version)
-	}
-
-	# Append collection of all gems
-	template_out += ALL_TEMPLATE.gsub("{repo_name}", repo_name)
-															.gsub("{deps}", ([":bundler_setup"] + bundle.specs.map{ |s| s.name }).to_s)
-
-	# Write the actual BUILD file
-	open(build_out_file, 'w') { |f|
-  	f.puts template_out
+  # Write the actual BUILD file
+  ::File.open(build_out_file, 'w') { |f|
+    f.puts template_out
   }
 end
 
 # ruby ./create_bundle_build_file.rb "BUILD.bazel" "Gemfile.lock" "repo_name" "[]" "wsp_name"
 if $0 == __FILE__
-	if ARGV.length != 5
-		fmt.Println("BUILD FILE ARGS not 5")
-		exit(1)
-	end
+  if ARGV.length != 5
+    fmt.Println("BUILD FILE ARGS not 5")
+    exit(1)
+  end
 
-	build_out_file = ARGV[0]
-	lock_file = ARGV[1]
-	repo_name = ARGV[2]
-	excludes = ARGV[3]
-	workspace_name = ARGV[4]
+  build_out_file = ARGV[0]
+  lock_file = ARGV[1]
+  repo_name = ARGV[2]
+  excludes = ARGV[3]
+  workspace_name = ARGV[4]
 
   create_bundle_build_file(build_out_file, lock_file, repo_name, excludes, workspace_name)
-end
+end
diff --git a/ruby/private/host_runtime.bzl b/ruby/private/host_runtime.bzl
@@ -128,7 +128,7 @@ ruby_host_runtime = repository_rule(
             allow_single_file = True,
         ),
         "_install_bundler": attr.label(
-            default = "%s//ruby/private:install-bundler.rb" % (
+            default = "%s//ruby/private:install_bundler.rb" % (
                 RULES_RUBY_WORKSPACE_NAME),
             allow_single_file = True,
         ),
diff --git a/ruby/private/install_bundler.rb b/ruby/private/install_bundler.rb
@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 require 'rubygems'
 require 'rubygems/name_tuple'
 require 'rubygems/package'
 require 'rubygems/remote_fetcher'
 require 'rubygems/source'
 require 'tmpdir'
 
-def unpack_gem(name, version, dest=Dir.pwd)
+def unpack_gem(name, version, dest = Dir.pwd)
   source = Gem::Source.new('https://rubygems.org')
   spec = source.fetch_spec Gem::NameTuple.new(name, version)
 
-  Dir.mktmpdir {|dir|
+  Dir.mktmpdir { |dir|
     Dir.chdir(dir) { source.download(spec) }
     downloaded = File.join(dir, "#{name}-#{version}.gem")
     Gem::Package.new(downloaded).extract_files dest
diff --git a/ruby/tests/args_check.rb b/ruby/tests/args_check.rb
@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 # Checks if args to ruby_binary rules propagate to the actual
 # ruby processes
 
-expected = %w[ foo bar baz ]
+expected = %w[foo bar baz]
 
 unless ARGV == expected
   raise "Expected ARGV to be #{expected}; got #{ARGV}"
diff --git a/ruby/tests/ext_test.rb b/ruby/tests/ext_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ruby/tests/example_ext'
 
 show_version
diff --git a/ruby/tests/include_order_check.rb b/ruby/tests/include_order_check.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Checks if require paths set by depender libraries appear earlier than
 # the ones by dependees.
 # i.e. -I options must be topologically sorted by library dependency as
@@ -10,22 +12,22 @@
 
 DEPS = [
   # siblings
-  %w[ a b ],
-  %w[ b c ],
-  %w[ c f ],
+  %w[a b],
+  %w[b c],
+  %w[c f],
 
   # parent-child pairs
-  %w[ a d ],
-  %w[ b d ],
-  %w[ c e ],
-  %w[ d e ],
-]
+  %w[a d],
+  %w[b d],
+  %w[c e],
+  %w[d e],
+].freeze
 
-actual = $LOAD_PATH.grep(%r[/somewhere/.$]).map {|path|
+actual = $LOAD_PATH.grep(%r[/somewhere/.$]).map { |path|
   path.chars.last
 }
 
-unless actual.sort == %w[ a b c d e f ]
+unless actual.sort == %w[a b c d e f]
   raise "Expect $LOAD_PATH includes somewhere/{a,b,c,d,e} but it did not"
 end
 
@@ -34,5 +36,6 @@
   j = actual.index(later)
 
   next if i < j
+
   raise "Expect #{earlier} precedes #{later} in #{actual} but did not"
 end
diff --git a/ruby/tests/load_path_in_runfiles_test.rb b/ruby/tests/load_path_in_runfiles_test.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ruby/tests/testdata/foo/g'
 require 'external/bazelruby_ruby_rules_ruby_tests_testdata_another_workspace/baz/qux/j'
 
diff --git a/ruby/tests/testdata/a.rb b/ruby/tests/testdata/a.rb
@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'd'
diff --git a/ruby/tests/testdata/another_workspace/baz/qux/j.rb b/ruby/tests/testdata/another_workspace/baz/qux/j.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'qux/k'
 
 def j
diff --git a/ruby/tests/testdata/another_workspace/baz/qux/k.rb b/ruby/tests/testdata/another_workspace/baz/qux/k.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def k
   :k
 end
diff --git a/ruby/tests/testdata/b.rb b/ruby/tests/testdata/b.rb
@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'd'
diff --git a/ruby/tests/testdata/bar/i.rb b/ruby/tests/testdata/bar/i.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 def i
   :i
 end
diff --git a/ruby/tests/testdata/c.rb b/ruby/tests/testdata/c.rb
@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'e'
diff --git a/ruby/tests/testdata/d.rb b/ruby/tests/testdata/d.rb
@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require_relative 'e'
diff --git a/ruby/tests/testdata/e.rb b/ruby/tests/testdata/e.rb
@@ -1 +1,2 @@
+# frozen_string_literal: true
 # nothing
diff --git a/ruby/tests/testdata/f.rb b/ruby/tests/testdata/f.rb
@@ -1 +1,2 @@
+# frozen_string_literal: true
 # nothing
diff --git a/ruby/tests/testdata/foo/g.rb b/ruby/tests/testdata/foo/g.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ruby/tests/testdata/foo/h'
 
 def g
diff --git a/ruby/tests/testdata/foo/h.rb b/ruby/tests/testdata/foo/h.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bar/i'
 
 module H
diff --git a/ruby/tools/init_loadpath.rb b/ruby/tools/init_loadpath.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 toolchain_root = File.dirname(__FILE__)
 list_file = File.join(toolchain_root, 'loadpath.lst')
 

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+inherit_gem:`
	`2`	`+ relaxed-rubocop: .rubocop.yml`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`module Foo`
`2`	`4`	`require 'foo/bar'`
`3`	`5`	`require 'foo/version'`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require 'openssl'`
`2`	`4`
`3`	`5`	`module Foo`