Additional Rubocop Changes

This change makes additional Rubocop source code updates.  It seems
wide-spread, but all changes are individually trivial.

Author: nebhale

.idea/dictionaries/bhale.xml

@@ -1,30 +1,33 @@
 ---
+require: rubocop-rspec
+
 AllCops:
   Include:
     - Rakefile
     - rakelib/**/*
   Exclude:
     - build/**/*
-    - vendor/**/*
-AbcSize:
-  Max: 18
-ClassLength:
+Metrics/AbcSize:
+ Max: 18
+Metrics/ClassLength:
   Max: 200
-CyclomaticComplexity:
+Metrics/CyclomaticComplexity:
   Max: 10
-Documentation:
+Metrics/LineLength:
+  Max: 120
+Metrics/MethodLength:
+  Max: 17
+Metrics/ParameterLists:
+  Max: 6
+Metrics/PerceivedComplexity:
+  Max: 10
+RSpec/FilePath:
   Enabled: false
-EmptyLinesAroundModuleBody:
+Style/Documentation:
   Enabled: false
-EmptyLinesAroundClassBody:
+Style/EmptyLinesAroundClassBody:
   Enabled: false
-MultilineOperationIndentation:
+Style/EmptyLinesAroundModuleBody:
   Enabled: false
-LineLength:
+Style/MultilineOperationIndentation:
   Enabled: false
-MethodLength:
-  Max: 25
-ParameterLists:
-  Max: 6
-PerceivedComplexity:
-  Max: 10

.idea/misc.xml

@@ -6,6 +6,7 @@ group :development do
   gem 'redcarpet'
   gem 'rspec'
   gem 'rubocop'
+  gem 'rubocop-rspec'
   gem 'rubyzip'
   gem 'simplecov'
   gem 'tee'

.rubocop.yml

@@ -37,6 +37,7 @@ GEM
       powerpack (~> 0.0.6)
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
+    rubocop-rspec (1.2.1)
     ruby-progressbar (1.7.0)
     rubyzip (1.1.6)
     safe_yaml (1.0.4)
@@ -61,6 +62,7 @@ DEPENDENCIES
   redcarpet
   rspec
   rubocop
+  rubocop-rspec
   rubyzip
   simplecov
   tee

Gemfile

@@ -21,7 +21,7 @@ RSpec::Core::RakeTask.new
 CLEAN.include 'coverage'
 
 require 'rubocop/rake_task'
-RuboCop::RakeTask.new
+RuboCop::RakeTask.new { |t| t.requires << 'rubocop-rspec' }
 
 require 'yard'
 YARD::Rake::YardocTask.new
@@ -39,7 +39,7 @@ require 'rakelib/stage_buildpack_task'
 require 'rakelib/package_task'
 Package::DependencyCacheTask.new
 Package::StageBuildpackTask.new(Dir['bin/**/*', 'config/**/*', 'lib/**/*', 'resources/**/*']
-                                .reject { |f| File.directory? f })
+                                  .reject { |f| File.directory? f })
 Package::PackageTask.new
 
 task default: %w(rubocop check_api_doc spec)

Gemfile.lock

@@ -271,7 +271,7 @@
     <orderEntry type="library" scope="PROVIDED" name="addressable (v2.3.6, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ast (v2.0.0, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="astrolabe (v1.3.0, rbenv: 1.9.3-p551) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.7.7, rbenv: 1.9.3-p551) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.7.8, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="codeclimate-test-reporter (v0.4.3, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="crack (v0.4.2, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.2.5, rbenv: 1.9.3-p551) [gem]" level="application" />
@@ -288,6 +288,7 @@
     <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.1.3, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.1.2, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubocop (v0.27.1, rbenv: 1.9.3-p551) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop-rspec (v1.2.1, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.7.0, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rubyzip (v1.1.6, rbenv: 1.9.3-p551) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="safe_yaml (v1.0.4, rbenv: 1.9.3-p551) [gem]" level="application" />

Rakefile

@@ -108,11 +108,13 @@ def initialize(app_dir, application)
       immutable_java_home  = Component::ImmutableJavaHome.new mutable_java_home, app_dir
       java_opts            = Component::JavaOpts.new app_dir
 
-      instantiate_components(additional_libraries, app_dir, application, immutable_java_home, java_opts, mutable_java_home)
+      instantiate_components(additional_libraries, app_dir, application, immutable_java_home, java_opts,
+                             mutable_java_home)
     end
 
-    def instantiate_components(additional_libraries, app_dir, application, immutable_java_home, java_opts, mutable_java_home)
-      components = JavaBuildpack::Util::ConfigurationUtils.load 'components'
+    def instantiate_components(additional_libraries, app_dir, application, immutable_java_home, java_opts,
+                               mutable_java_home)
+      components  = JavaBuildpack::Util::ConfigurationUtils.load 'components'
       @jres       = instantiate(components['jres'], additional_libraries, application, mutable_java_home, java_opts,
                                 app_dir)
       @frameworks = instantiate(components['frameworks'], additional_libraries, application, immutable_java_home,

java-buildpack.iml

@@ -74,7 +74,8 @@ def to_hash
     # Creates a string representation of the version.  The string representation looks like the following:
     # +[[<VERSION> [(offline)] | ] <REMOTE>#<HASH>] | [unknown]+.  Some examples:
     #
-    # +2.1.2 (offline) | https://github.com/cloudfoundry/java-buildpack.git#12345+ (custom version number, offline buildpack)
+    # +2.1.2 (offline) | https://github.com/cloudfoundry/java-buildpack.git#12345+ (custom version number, offline
+    # buildpack)
     # +abcde | https://github.com/cloudfoundry/java-buildpack.git#abcde+ (default version number, online buildpack)
     # +https://github.com/cloudfoundry/java-buildpack#12345+ (cloned buildpack)
     # +unknown+ (un-packaged, un-cloned)

lib/java_buildpack/buildpack.rb

@@ -62,8 +62,9 @@ def compile
         fail "Method 'compile' must be defined"
       end
 
-      # Modifies the application's runtime configuration. The component is expected to transform members of the +context+
-      # (e.g. +@java_home+, +@java_opts+, etc.) in whatever way is necessary to support the function of the component.
+      # Modifies the application's runtime configuration. The component is expected to transform members of the
+      # +context+ # (e.g. +@java_home+, +@java_opts+, etc.) in whatever way is necessary to support the function of the
+      # component.
       #
       # Container components are also expected to create the command required to run the application.  These components
       # are expected to read the +context+ values and take them into account when creating the command.
@@ -76,8 +77,8 @@ def release
 
       protected
 
-      # Downloads an item with the given name and version from the given URI, then yields the resultant file to the given
-      # block.
+      # Downloads an item with the given name and version from the given URI, then yields the resultant file to the
+      # given # block.
       #
       # @param [JavaBuildpack::Util::TokenizedVersion] version
       # @param [String] uri
@@ -112,7 +113,8 @@ def download_jar(version, uri, jar_name, target_directory = @droplet.sandbox, na
       #
       # @param [String] version the version of the download
       # @param [String] uri the uri of the download
-      # @param [Pathname] target_directory the directory to expand the TAR file to.  Defaults to the component's sandbox.
+      # @param [Pathname] target_directory the directory to expand the TAR file to.  Defaults to the component's
+      #                                    sandbox.
       # @param [String] name an optional name for the download and expansion.  Defaults to +@component_name+.
       # @return [Void]
       def download_tar(version, uri, target_directory = @droplet.sandbox, name = @component_name)
@@ -127,10 +129,12 @@ def download_tar(version, uri, target_directory = @droplet.sandbox, name = @comp
       # Downloads a given ZIP file and expands it.
       #
       # @param [Boolean] strip_top_level whether to strip the top-level directory when expanding. Defaults to +true+.
-      # @param [Pathname] target_directory the directory to expand the ZIP file to.  Defaults to the component's sandbox.
+      # @param [Pathname] target_directory the directory to expand the ZIP file to.  Defaults to the component's
+      #                                    sandbox.
       # @param [String] name an optional name for the download.  Defaults to +@component_name+.
       # @return [Void]
-      def download_zip(version, uri, strip_top_level = true, target_directory = @droplet.sandbox, name = @component_name)
+      def download_zip(version, uri, strip_top_level = true, target_directory = @droplet.sandbox,
+                       name = @component_name)
         download(version, uri, name) do |file|
           with_timing "Expanding #{name} to #{target_directory.relative_path_from(@droplet.root)}" do
             if strip_top_level

lib/java_buildpack/buildpack_version.rb

@@ -60,12 +60,13 @@ class Droplet
 
       # Creates a new instance of the droplet abstraction
       #
-      # @param [AdditionalLibraries] additional_libraries     the shared +AdditionalLibraries+ instance for all components
+      # @param [AdditionalLibraries] additional_libraries     the shared +AdditionalLibraries+ instance for all
+      #                                                       components
       # @param [String] component_id                          the id of the component that will use this +Droplet+
       # @param [ImmutableJavaHome, MutableJavaHome] java_home the shared +JavaHome+ instance for all components.  If the
-      #                                                       component using this instance is a jre, then this should be
-      #                                                       an instance of +MutableJavaHome+.  Otherwise it should be an
-      #                                                       instance of +ImmutableJavaHome+.
+      #                                                       component using this instance is a jre, then this should
+      #                                                       be an instance of +MutableJavaHome+.  Otherwise it should
+      #                                                       be an instance of +ImmutableJavaHome+.
       # @param [JavaOpts] java_opts                           the shared +JavaOpts+ instance for all components
       # @param [Pathname] root                                the root of the droplet
       def initialize(additional_libraries, component_id, java_home, java_opts, root)
@@ -79,9 +80,8 @@ def initialize(additional_libraries, component_id, java_home, java_opts, root)
         sandbox_root   = buildpack_root + component_id
 
         @sandbox = JavaBuildpack::Util::FilteringPathname.new(sandbox_root, ->(path) { in?(path, sandbox_root) }, true)
-        @root    = JavaBuildpack::Util::FilteringPathname.new(root,
-                                                              ->(path) { !in?(path, buildpack_root) || in?(path, @sandbox) },
-                                                              true)
+        @root    = JavaBuildpack::Util::FilteringPathname.new(
+          root, ->(path) { !in?(path, buildpack_root) || in?(path, @sandbox) }, true)
       end
 
       # Copy resources from a components resources directory to a directory

lib/java_buildpack/component/base_component.rb

@@ -55,9 +55,9 @@ def add_system_property(key, value)
         self
       end
 
-      # Adds an option to the +JAVA_OPTS+.  Nothing is prepended to the key.  If the value is a +Pathname+, then prepends
-      # +$PWD+ to the path (relative to the droplet root) to ensure that the path is always accurate.  Otherwise, uses
-      # the value as-is.
+      # Adds an option to the +JAVA_OPTS+.  Nothing is prepended to the key.  If the value is a +Pathname+, then
+      # prepends +$PWD+ to the path (relative to the droplet root) to ensure that the path is always accurate.
+      # Otherwise, uses the value as-is.
       #
       # @param [String] key             the key of the option
       # @param [Pathname, String] value the value of the system property

lib/java_buildpack/component/droplet.rb

@@ -71,7 +71,8 @@ def download_jar(jar_name = jar_name, target_directory = @droplet.sandbox, name
 
       # Downloads a given TAR file and expands it.
       #
-      # @param [Pathname] target_directory the directory to expand the TAR file to.  Defaults to the component's sandbox.
+      # @param [Pathname] target_directory the directory to expand the TAR file to.  Defaults to the component's
+      #                                    sandbox.
       # @param [String] name an optional name for the download and expansion.  Defaults to +@component_name+.
       # @return [Void]
       def download_tar(target_directory = @droplet.sandbox, name = @component_name)
@@ -81,7 +82,8 @@ def download_tar(target_directory = @droplet.sandbox, name = @component_name)
       # Downloads a given ZIP file and expands it.
       #
       # @param [Boolean] strip_top_level whether to strip the top-level directory when expanding. Defaults to +true+.
-      # @param [Pathname] target_directory the directory to expand the ZIP file to.  Defaults to the component's sandbox.
+      # @param [Pathname] target_directory the directory to expand the ZIP file to.  Defaults to the component's
+      #                                    sandbox.
       # @param [String] name an optional name for the download.  Defaults to +@component_name+.
       # @return [Void]
       def download_zip(strip_top_level = true, target_directory = @droplet.sandbox, name = @component_name)

lib/java_buildpack/component/java_opts.rb

@@ -22,9 +22,9 @@
 module JavaBuildpack
   module Container
 
-    # Encapsulates the detect, compile, and release functionality for applications running a simple Java +main()+ method.
-    # This isn't a _container_ in the traditional sense, but contains the functionality to manage the lifecycle of Java
-    # +main()+ applications.
+    # Encapsulates the detect, compile, and release functionality for applications running a simple Java +main()+
+    # method. This isn't a _container_ in the traditional sense, but contains the functionality to manage the lifecycle
+    # of Java +main()+ applications.
     class JavaMain < JavaBuildpack::Component::BaseComponent
 
       # (see JavaBuildpack::Component::BaseComponent#detect)

lib/java_buildpack/component/versioned_dependency_component.rb

@@ -67,11 +67,13 @@ def supports?
       private
 
       def relative_groovy_files
-        JavaBuildpack::Util::GroovyUtils.groovy_files(@application).map { |gf| gf.relative_path_from(@application.root) }
+        JavaBuildpack::Util::GroovyUtils.groovy_files(@application).map do |gf|
+          gf.relative_path_from(@application.root)
+        end
       end
 
       def no_main_method(groovy_files)
-        none?(groovy_files) { |file| JavaBuildpack::Util::GroovyUtils.main_method? file } # note that this will scan comments
+        none?(groovy_files) { |file| JavaBuildpack::Util::GroovyUtils.main_method? file }
       end
 
       def no_shebang(groovy_files)

lib/java_buildpack/container/java_main.rb

@@ -33,7 +33,9 @@ def detect
       # (see JavaBuildpack::Component::BaseComponent#compile)
       def compile
         parsed_java_opts.each do |option|
-          fail "Java option '#{option}' configures a memory region.  Use JRE configuration for this instead." if memory_option? option
+          if memory_option? option
+            fail "Java option '#{option}' configures a memory region.  Use JRE configuration for this instead."
+          end
         end
       end
 

lib/java_buildpack/container/spring_boot_cli.rb

@@ -21,9 +21,9 @@
 module JavaBuildpack
   module Framework
 
-    # Encapsulates the functionality for enabling cloud auto-reconfiguration in Play applications. Note that Spring auto-
-    # reconfiguration is covered by the SpringAutoReconfiguration framework. The reconfiguration performed here is to
-    # override Play application configuration to bind a Play application to cloud resources.
+    # Encapsulates the functionality for enabling cloud auto-reconfiguration in Play applications. Note that Spring
+    # auto- reconfiguration is covered by the SpringAutoReconfiguration framework. The reconfiguration performed here is
+    # to override Play application configuration to bind a Play application to cloud resources.
     class PlayFrameworkAutoReconfiguration < JavaBuildpack::Component::VersionedDependencyComponent
 
       # (see JavaBuildpack::Component::BaseComponent#compile)

lib/java_buildpack/framework/java_opts.rb

@@ -80,13 +80,14 @@ def to_s
       private_constant :CONTEXT_INITIALIZER_CLASSES, :CONTEXT_LOADER_LISTENER, :DISPATCHER_SERVLET
 
       def augment(root, param_type)
-        classes_string = xpath(root, "#{param_type}[param-name[contains(text(), '#{CONTEXT_INITIALIZER_CLASSES}')]]/param-value/text()").first
+        classes_string = xpath(root, "#{param_type}[param-name[contains(text(),
+                               '#{CONTEXT_INITIALIZER_CLASSES}')]]/param-value/text()").first
         classes_string = create_param(root, param_type, CONTEXT_INITIALIZER_CLASSES, '') unless classes_string
 
         classes = classes_string.value.strip.split(/[,;\s]+/)
         classes = classes.concat CONTEXT_INITIALIZER_ADDITIONAL
 
-        classes_string.value = classes.join(',') # rubocop:disable UselessSetterCall
+        classes_string.value = classes.join(',') # rubocop:disable Lint/UselessSetterCall
       end
 
       def context_loader_listener?