Adding relaxed-rubocop and fixing styling issues (#15)

Graham Jenson · kigster · commit 169108ba1639 · 2019-11-26T13:33:23.000-08:00
* [Fix] styling hecks

* fixed

* Restoring comment Alignment for easy comprehension

* run buildifier
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,3 +1,7 @@
+AllCops:
+  Exclude:
+    - bazel-*/**/*
+    - examples/**/*
 
 inherit_gem:
   relaxed-rubocop: .rubocop.yml
diff --git a/Gemfile b/Gemfile
@@ -2,4 +2,5 @@
 
 source 'https://rubygems.org'
 
+gem 'relaxed-rubocop'
 gem 'rubocop', '~> 0.76.0', require: false
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -7,6 +7,7 @@ GEM
     parser (2.6.0.0)
       ast (~> 2.4.0)
     rainbow (3.0.0)
+    relaxed-rubocop (2.4)
     rubocop (0.76.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -21,7 +22,8 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  relaxed-rubocop
   rubocop (~> 0.76.0)
 
 BUNDLED WITH
-   1.9
+   1.17.3
diff --git a/examples/bin/show_version.rb b/examples/bin/show_version.rb
diff --git a/examples/lib/foo.rb b/examples/lib/foo.rb
diff --git a/examples/lib/foo/bar.rb b/examples/lib/foo/bar.rb
diff --git a/examples/lib/foo/version.rb b/examples/lib/foo/version.rb
diff --git a/examples/simple_script/BUILD b/examples/simple_script/BUILD
@@ -16,15 +16,13 @@ ruby_binary(
     ],
 )
 
-
 ruby_test(
     name = "default_test",
     srcs = ["script_spec.rb"],
     main = "script_spec.rb",
-    rubyopt = ["-rrspec/autorun"], # require autorun because it is needed
+    rubyopt = ["-rrspec/autorun"],  # require autorun because it is needed
     deps = [
         "//lib:foo",
         "@bundle//:libs",
     ],
 )
-
diff --git a/examples/simple_script/lib/BUILD b/examples/simple_script/lib/BUILD
@@ -8,4 +8,4 @@ load(
 ruby_library(
     name = "foo",
     srcs = ["foo.rb"],
-)
+)
diff --git a/examples/simple_script/lib/foo.rb b/examples/simple_script/lib/foo.rb
@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Foo
-	def self.aha
-		return "aha"
-	end
+  def self.aha
+    "aha"
+  end
 end
diff --git a/examples/simple_script/script.rb b/examples/simple_script/script.rb
@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'openssl'
 require 'lib/foo'
 
-def oss_rand()
-	return "#{OpenSSL::BN.rand(512)}"
+def oss_rand
+  OpenSSL::BN.rand(512).to_s
 end
 
-puts Foo.aha() + " " + oss_rand()
+puts Foo.aha + " " + oss_rand
diff --git a/examples/simple_script/script_spec.rb b/examples/simple_script/script_spec.rb
@@ -34,6 +34,6 @@
 
 describe OSSRand do
   it begin
-    expect(oss_rand()).to be String
+    expect(oss_rand).to be String
   end
 end
diff --git a/examples/spec/foo/version_spec.rb b/examples/spec/foo/version_spec.rb
diff --git a/ruby/private/bundle/bundle.bzl b/ruby/private/bundle/bundle.bzl
@@ -13,68 +13,73 @@ def _get_bundler_lib_label(repository_ctx, ruby_sdk):
     return Label("%s//:bundler/lib" % ruby_sdk)
 
 def bundle_install_impl(ctx):
-  ctx.symlink(ctx.attr.gemfile, "Gemfile")
-  ctx.symlink(ctx.attr.gemfile_lock, "Gemfile.lock")
-  ctx.symlink(ctx.attr._create_bundle_build_file, "create_bundle_build_file.rb")
-  if ctx.attr.gemspec:
-    ctx.symlink(ctx.attr.gemspec, ctx.path(ctx.attr.gemspec).basename)
+    ctx.symlink(ctx.attr.gemfile, "Gemfile")
+    ctx.symlink(ctx.attr.gemfile_lock, "Gemfile.lock")
+    ctx.symlink(ctx.attr._create_bundle_build_file, "create_bundle_build_file.rb")
 
-  ruby = _get_interpreter_label(ctx, ctx.attr.ruby_sdk)
-  bundler = _get_bundler_label(ctx, ctx.attr.ruby_sdk)
+    # TODO(kig) Make Gemspec reference from Gemfile actually work
+    if ctx.attr.gemspec:
+        ctx.symlink(ctx.attr.gemspec, ctx.path(ctx.attr.gemspec).basename)
 
-  # Install the Gems into the workspace
-  args = [
-      'env', '-i',                                              # remove all environment variables
-      ctx.path(ruby),                                           # ruby
-      '--disable-gems',                                         # prevent the addition of gem installation directories to the default load path
-      '-I', ctx.path(bundler).dirname.dirname.get_child('lib'), # Used to tell Ruby where to load the library scripts
-      ctx.path(bundler),                                        # execute bundler
-      'install',                                                # install
-      '--deployment',                                           # In deployment mode, Bundler will 'roll-out' the bundle for production or CI use.
-      '--standalone',                                           # Makes a bundle that can work without depending on Rubygems or Bundler at runtime.
-      '--frozen',                                               # Do not allow the Gemfile.lock to be updated after this install.
-      '--binstubs=bin',                                         # Creates a directory and place any executables from the gem there.
-      '--path=lib',                                             # The location to install the specified gems to.
-  ]
-  result = ctx.execute(args, quiet=False)
+    ruby = _get_interpreter_label(ctx, ctx.attr.ruby_sdk)
+    bundler = _get_bundler_label(ctx, ctx.attr.ruby_sdk)
 
-  if result.return_code:
-    fail("Failed to install gems: %s%s" % (result.stdout, result.stderr))
+    # Install the Gems into the workspace
+    args = [
+        "env",
+        "-i",  # remove all environment variables
+        ctx.path(ruby),  # ruby
+        "--disable-gems",  # prevent the addition of gem installation directories to the default load path
+        "-I",  # Used to tell Ruby where to load the library scripts
+        ctx.path(bundler).dirname.dirname.get_child("lib"),
+        ctx.path(bundler),  # run
+        "install",  #   > bundle install
+        "--deployment",  # In the deployment mode, gems are dumped to --path and frozen; also .bundle/config file is created
+        "--standalone",  # Makes a bundle that can work without depending on Rubygems or Bundler at runtime.
+        "--frozen",  # Do not allow the Gemfile.lock to be updated after this install.
+        "--binstubs=bin",  # Creates a directory and place any executables from the gem there.
+        "--path=lib",  # The location to install the specified gems to.
+    ]
+    result = ctx.execute(args, quiet = False)
 
-  # exclude any specified files
-  exclude = []
-  for gem, globs in ctx.attr.excludes.items():
-    expanded = ["lib/ruby/*/gems/%s-*/%s" % (gem, glob) for glob in globs]
-    exclude.extend(expanded)
+    if result.return_code:
+        fail("Failed to install gems: %s%s" % (result.stdout, result.stderr))
 
-  # Create the BUILD file to expose the gems to the WORKSPACE
-  args = [
-      'env', '-i',                                              # remove all environment variables
-      ctx.path(ruby),                                           # ruby
-      '--disable-gems',                                         # prevent the addition of gem installation directories to the default load path
-      '-I', ctx.path(bundler).dirname.dirname.get_child('lib'), # Used to tell Ruby where to load the library scripts
-      'create_bundle_build_file.rb',
-      'BUILD.bazel',
-      'Gemfile.lock',
-      ctx.name,
-      repr(exclude),
-      RULES_RUBY_WORKSPACE_NAME,
+    # exclude any specified files
+    exclude = []
+    for gem, globs in ctx.attr.excludes.items():
+        expanded = ["lib/ruby/*/gems/%s-*/%s" % (gem, glob) for glob in globs]
+        exclude.extend(expanded)
 
-  ]
-  result = ctx.execute(args, quiet=False)
+    # Create the BUILD file to expose the gems to the WORKSPACE
+    args = [
+        "env",
+        "-i",  # remove all environment variables
+        ctx.path(ruby),  # ruby interpreter
+        "--disable-gems",  # prevent the addition of gem installation directories to the default load path
+        "-I",  # -I lib (adds this folder to $LOAD_PATH where ruby searchesf for things)
+        ctx.path(bundler).dirname.dirname.get_child("lib"),
+        "create_bundle_build_file.rb",  # The template used to created bundle file
+        "BUILD.bazel",  # Bazel build file (can be empty)
+        "Gemfile.lock",  # Gemfile.lock where we list all direct and transitive dependencies
+        ctx.name,  # Name of the target
+        repr(exclude),
+        RULES_RUBY_WORKSPACE_NAME,
+    ]
+    result = ctx.execute(args, quiet = False)
 
-  if result.return_code:
-    fail("Failed to create build file: %s%s" % (result.stdout, result.stderr))
+    if result.return_code:
+        fail("Failed to create build file: %s%s" % (result.stdout, result.stderr))
 
-    ctx.template(
-        "BUILD.bazel",
-        ctx.attr._buildfile_template,
-        substitutions = {
-            "{repo_name}": ctx.name,
-            "{exclude}": repr(exclude),
-            "{workspace_name}": RULES_RUBY_WORKSPACE_NAME,
-        },
-    )
+        ctx.template(
+            "BUILD.bazel",
+            ctx.attr._buildfile_template,
+            substitutions = {
+                "{repo_name}": ctx.name,
+                "{exclude}": repr(exclude),
+                "{workspace_name}": RULES_RUBY_WORKSPACE_NAME,
+            },
+        )
 
 bundle_install = repository_rule(
     implementation = bundle_install_impl,
@@ -94,12 +99,11 @@ bundle_install = repository_rule(
         "excludes": attr.string_list_dict(
             doc = "List of glob patterns per gem to be excluded from the library",
         ),
-
         "_create_bundle_build_file": attr.label(
             default = "%s//ruby/private/bundle:create_bundle_build_file.rb" % (
-                RULES_RUBY_WORKSPACE_NAME),
+                RULES_RUBY_WORKSPACE_NAME
+            ),
             doc = "Creates the BUILD file",
-
             allow_single_file = True,
         ),
     },
diff --git a/ruby/private/tools/deps.bzl b/ruby/private/tools/deps.bzl
@@ -5,13 +5,13 @@ load(
 )
 
 def _transitive_srcs(deps):
-  return struct(
-      srcs = [d[RubyLibrary].transitive_ruby_srcs for d in deps if RubyLibrary in d],
-      incpaths = [d[RubyLibrary].ruby_incpaths for d in deps if RubyLibrary in d],
-      rubyopt = [d[RubyLibrary].rubyopt for d in deps if RubyLibrary in d],
-      data_files = [d[DefaultInfo].data_runfiles.files for d in deps],
-      default_files = [d[DefaultInfo].default_runfiles.files for d in deps],
-   )
+    return struct(
+        srcs = [d[RubyLibrary].transitive_ruby_srcs for d in deps if RubyLibrary in d],
+        incpaths = [d[RubyLibrary].ruby_incpaths for d in deps if RubyLibrary in d],
+        rubyopt = [d[RubyLibrary].rubyopt for d in deps if RubyLibrary in d],
+        data_files = [d[DefaultInfo].data_runfiles.files for d in deps],
+        default_files = [d[DefaultInfo].default_runfiles.files for d in deps],
+    )
 
 def transitive_deps(ctx, extra_files = [], extra_deps = []):
     """Calculates transitive sets of args.

Original file line number	Diff line number	Diff line change
`@@ -2,4 +2,5 @@`
`2`	`2`
`3`	`3`	`source 'https://rubygems.org'`
`4`	`4`
	`5`	`+gem 'relaxed-rubocop'`
`5`	`6`	`gem 'rubocop', '~> 0.76.0', require: false`