Version updates

nebhale · nebhale · commit 43fbd1d695d7 · 2014-04-04T15:17:31.000+01:00
This change updates the versions of Rubocop and Yard.  As with most
Rubocop updates, code needed to be changed, and was.
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -1,9 +1,9 @@
 ---
 AllCops:
-  Includes:
+  Include:
     - Rakefile
     - rakelib/**
-  Excludes:
+  Exclude:
     - build/**
     - vendor/**
 ClassLength:
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -31,7 +31,7 @@ GEM
     rspec-mocks (3.0.0.beta2)
       rspec-support (= 3.0.0.beta2)
     rspec-support (3.0.0.beta2)
-    rubocop (0.19.1)
+    rubocop (0.20.0)
       json (>= 1.7.7, < 2)
       parser (~> 2.1.7)
       powerpack (~> 0.0.6)
@@ -55,7 +55,7 @@ GEM
     webmock (1.17.4)
       addressable (>= 2.2.7)
       crack (>= 0.3.2)
-    yard (0.8.7.3)
+    yard (0.8.7.4)
 
 PLATFORMS
   ruby
diff --git a/java-buildpack.iml b/java-buildpack.iml
@@ -289,7 +289,7 @@
     <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.0.0.beta2, rbenv: 1.9.3-p545) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.0.0.beta2, rbenv: 1.9.3-p545) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.0.0.beta2, rbenv: 1.9.3-p545) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="rubocop (v0.19.1, rbenv: 1.9.3-p545) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rubocop (v0.20.0, rbenv: 1.9.3-p545) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-debug-base19x (v0.11.30.pre15, rbenv: 1.9.3-p545) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-debug-ide (v0.4.22, rbenv: 1.9.3-p545) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="ruby-progressbar (v1.4.2, rbenv: 1.9.3-p545) [gem]" level="application" />
@@ -300,7 +300,7 @@
     <orderEntry type="library" scope="PROVIDED" name="slop (v3.5.0, rbenv: 1.9.3-p545) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="tee (v1.0.0, rbenv: 1.9.3-p545) [gem]" level="application" />
     <orderEntry type="library" scope="PROVIDED" name="webmock (v1.17.4, rbenv: 1.9.3-p545) [gem]" level="application" />
-    <orderEntry type="library" scope="PROVIDED" name="yard (v0.8.7.3, rbenv: 1.9.3-p545) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="yard (v0.8.7.4, rbenv: 1.9.3-p545) [gem]" level="application" />
   </component>
   <component name="RModuleSettingsStorage">
     <LOAD_PATH number="2" string0="$MODULE_DIR$/lib" string1="$MODULE_DIR$/spec" />
diff --git a/lib/java_buildpack/buildpack.rb b/lib/java_buildpack/buildpack.rb
@@ -93,7 +93,9 @@ def release
 
     BUILDPACK_MESSAGE = '-----> Java Buildpack Version: %s'.freeze
 
-    LOAD_ROOT = Pathname.new(__FILE__).dirname + '..'
+    LOAD_ROOT = (Pathname.new(__FILE__).dirname + '..').freeze
+
+    private_constant :BUILDPACK_MESSAGE, :LOAD_ROOT
 
     def initialize(app_dir, application)
       @logger            = Logging::LoggerFactory.instance.get_logger Buildpack
diff --git a/lib/java_buildpack/buildpack_version.rb b/lib/java_buildpack/buildpack_version.rb
@@ -63,6 +63,8 @@ def to_s(human_readable = true)
 
     GIT_DIR = (Pathname.new(__FILE__).dirname + '../../.git').freeze
 
+    private_constant :GIT_DIR
+
     def git(command)
       `git --git-dir=#{GIT_DIR} #{command}`.chomp if git? && git_dir?
     end
diff --git a/lib/java_buildpack/component/droplet.rb b/lib/java_buildpack/component/droplet.rb
@@ -104,6 +104,8 @@ def copy_resources(target_directory = @sandbox)
 
       RESOURCES_DIRECTORY = Pathname.new(File.expand_path('../../../../resources', __FILE__)).freeze
 
+      private_constant :RESOURCES_DIRECTORY
+
       def in?(path, root)
         path.ascend do |parent|
           return true if parent == root
diff --git a/lib/java_buildpack/container/java_main.rb b/lib/java_buildpack/container/java_main.rb
@@ -57,6 +57,8 @@ def release
 
       CLASS_PATH_PROPERTY = 'Class-Path'.freeze
 
+      private_constant :ARGUMENTS_PROPERTY, :CLASS_PATH_PROPERTY
+
       def arguments
         @configuration[ARGUMENTS_PROPERTY]
       end
diff --git a/lib/java_buildpack/container/ratpack.rb b/lib/java_buildpack/container/ratpack.rb
@@ -31,14 +31,17 @@ def initialize(context)
         super(context)
       end
 
+      # (see JavaBuildpack::Component::BaseComponent#detect)
       def detect
         JavaBuildpack::Util::RatpackUtils.is?(@application) ? id(version) : nil
       end
 
+      # (see JavaBuildpack::Component::BaseComponent#compile)
       def compile
         @droplet.additional_libraries.link_to lib_dir
       end
 
+      # (see JavaBuildpack::Component::BaseComponent#release)
       def release
         @droplet.java_opts.add_system_property 'ratpack.port', '$PORT'
 
@@ -53,6 +56,8 @@ def release
 
       RATPACK_CORE_FILE_PATTERN = 'lib/ratpack-core-*.jar'.freeze
 
+      private_constant :RATPACK_CORE_FILE_PATTERN
+
       def id(version)
         "#{Ratpack.to_s.dash_case}=#{version}"
       end
diff --git a/lib/java_buildpack/container/tomcat/tomcat_redis_store.rb b/lib/java_buildpack/container/tomcat/tomcat_redis_store.rb
@@ -63,6 +63,9 @@ def supports?
 
       REDIS_STORE_CLASS_NAME = 'com.gopivotal.manager.redis.RedisStore'.freeze
 
+      private_constant :FILTER, :FLUSH_VALVE_CLASS_NAME, :KEY_HOST_NAME, :KEY_PASSWORD, :KEY_PORT,
+                       :PERSISTENT_MANAGER_CLASS_NAME, :REDIS_STORE_CLASS_NAME
+
       def add_manager(context)
         manager = context.add_element 'Manager', 'className' => PERSISTENT_MANAGER_CLASS_NAME
         add_store manager
diff --git a/lib/java_buildpack/framework/app_dynamics_agent.rb b/lib/java_buildpack/framework/app_dynamics_agent.rb
@@ -60,6 +60,8 @@ def supports?
 
       FILTER = /app-dynamics/.freeze
 
+      private_constant :FILTER
+
       def application_name
         @application.details['application_name']
       end
diff --git a/lib/java_buildpack/framework/java_opts.rb b/lib/java_buildpack/framework/java_opts.rb
@@ -50,6 +50,8 @@ def release
 
       ENVIRONMENT_VARIABLE = 'JAVA_OPTS'.freeze
 
+      private_constant :CONFIGURATION_PROPERTY, :ENVIRONMENT_PROPERTY, :ENVIRONMENT_VARIABLE
+
       def memory_option?(option)
         option =~ /-Xms/ || option =~ /-Xmx/ || option =~ /-XX:MaxMetaspaceSize/ || option =~ /-XX:MaxPermSize/ ||
           option =~ /-Xss/ || option =~ /-XX:MetaspaceSize/ || option =~ /-XX:PermSize/
diff --git a/lib/java_buildpack/framework/new_relic_agent.rb b/lib/java_buildpack/framework/new_relic_agent.rb
@@ -53,6 +53,8 @@ def supports?
 
       FILTER = /newrelic/.freeze
 
+      private_constant :FILTER
+
       def application_name
         @application.details['application_name']
       end
diff --git a/lib/java_buildpack/framework/spring_auto_reconfiguration/web_xml_modifier.rb b/lib/java_buildpack/framework/spring_auto_reconfiguration/web_xml_modifier.rb
@@ -97,6 +97,11 @@ def to_s
 
       DISPATCHER_SERVLET = 'DispatcherServlet'.freeze
 
+      private_constant :CONTEXT_CLASS, :CONTEXT_CLASS_ANNOTATION, :CONTEXT_CONFIG_LOCATION,
+                       :CONTEXT_INITIALIZER_ADDITIONAL, :CONTEXT_INITIALIZER_CLASSES, :CONTEXT_LOADER_LISTENER,
+                       :CONTEXT_LOCATION_ADDITIONAL_ANNOTATION, :CONTEXT_LOCATION_ADDITIONAL_XML,
+                       :CONTEXT_LOCATION_DEFAULT, :DISPATCHER_SERVLET
+
       def additional_context_config_location(root, param_type)
         annotation_application_context?(root, param_type) ? CONTEXT_LOCATION_ADDITIONAL_ANNOTATION : CONTEXT_LOCATION_ADDITIONAL_XML
       end
diff --git a/lib/java_buildpack/framework/spring_insight.rb b/lib/java_buildpack/framework/spring_insight.rb
@@ -73,6 +73,8 @@ def id(version)
 
       FILTER = /insight/.freeze
 
+      private_constant :AGENT_DOWNLOAD_URI_SUFFIX, :FILTER
+
       def add_agent_configuration
         @droplet.java_opts
         .add_system_property('agent.http.protocol', 'http')
diff --git a/lib/java_buildpack/jre/memory/memory_range.rb b/lib/java_buildpack/jre/memory/memory_range.rb
@@ -36,13 +36,13 @@ class MemoryRange
       # @param [MemorySize, nil] ceiling the upper bound of the range
       def initialize(value, ceiling = nil)
         if value.is_a? String
-          fail "Invalid combination of parameter types #{value.class} and #{ceiling.class}" unless ceiling.nil?
+          fail "Invalid combination of parameter types #{value.class} and #{ceiling.class}" if ceiling
           lower_bound, upper_bound = get_bounds(value)
           @floor                   = create_memory_size lower_bound
           @ceiling                 = upper_bound ? create_memory_size(upper_bound) : nil
         else
           validate_memory_size value
-          validate_memory_size ceiling unless ceiling.nil?
+          validate_memory_size ceiling if ceiling
           @floor   = value
           @ceiling = ceiling
         end
@@ -52,9 +52,7 @@ def initialize(value, ceiling = nil)
       # Determines whether or not this range is bounded. Reads better than testing for a +nil+ ceiling.
       #
       # @return [Boolean] +true+ if and only if this range is bounded
-      def bounded?
-        !@ceiling.nil?
-      end
+      alias_method :bounded?, :ceiling
 
       # Determines whether a given memory size falls in this range.
       #
@@ -74,7 +72,7 @@ def constrain(size)
         if size < @floor
           @floor
         else
-          !@ceiling.nil? && size > @ceiling ? @ceiling : size
+          @ceiling && size > @ceiling ? @ceiling : size
         end
       end
 
@@ -112,7 +110,9 @@ def to_s
 
       private
 
-      RANGE_SEPARATOR = '..'
+      RANGE_SEPARATOR = '..'.freeze
+
+      private_constant :RANGE_SEPARATOR
 
       def get_bounds(range)
         if range.index(RANGE_SEPARATOR)
diff --git a/lib/java_buildpack/jre/memory/memory_size.rb b/lib/java_buildpack/jre/memory/memory_size.rb
@@ -126,15 +126,17 @@ def /(other)
         fail "Cannot divide a MemorySize by an instance of #{other.class}"
       end
 
-      protected
-
       # @!attribute [r] bytes
       # @return [Numeric] the size in bytes of this memory size
       attr_reader :bytes
 
+      protected :bytes
+
       private
 
-      KILO = 1024
+      KILO = 1024.freeze
+
+      private_constant :KILO
 
       def memory_size_operation(other)
         fail "Invalid parameter: instance of #{other.class} is not a MemorySize" unless other.is_a? MemorySize
@@ -152,11 +154,8 @@ def from_numeric(n)
         MemorySize.new("#{n}B")
       end
 
-      public
-
       # Zero byte memory size
-      ZERO = MemorySize.new('0B')
-
+      ZERO = MemorySize.new('0B').freeze
     end
 
   end
diff --git a/lib/java_buildpack/jre/memory/openjdk_memory_heuristic_factory.rb b/lib/java_buildpack/jre/memory/openjdk_memory_heuristic_factory.rb
@@ -43,6 +43,8 @@ def create_memory_heuristic(sizes, heuristics, version)
 
         VALID_TYPES = %w(heap stack native).freeze
 
+        private_constant :VALID_TYPES
+
         JAVA_OPTS = {
           'heap'      => ->(v) { %W(-Xmx#{v} -Xms#{v}) },
           'metaspace' => ->(v) { %W(-XX:MaxMetaspaceSize=#{v} -XX:MetaspaceSize=#{v}) },
diff --git a/lib/java_buildpack/jre/memory/stack_memory_bucket.rb b/lib/java_buildpack/jre/memory/stack_memory_bucket.rb
@@ -43,10 +43,10 @@ def default_size
         range.floor == 0 ? JVM_DEFAULT_STACK_SIZE : range.floor
       end
 
-      private
-
       JVM_DEFAULT_STACK_SIZE = MemorySize.new('1M').freeze
 
+      private_constant :JVM_DEFAULT_STACK_SIZE
+
     end
 
   end
diff --git a/lib/java_buildpack/jre/memory/weight_balancing_memory_heuristic.rb b/lib/java_buildpack/jre/memory/weight_balancing_memory_heuristic.rb
@@ -62,11 +62,13 @@ def resolve
 
       private
 
-      NATIVE_MEMORY_WARNING_FACTOR = 3
+      NATIVE_MEMORY_WARNING_FACTOR = 3.freeze
 
-      TOTAL_MEMORY_WARNING_FACTOR = 0.8
+      TOTAL_MEMORY_WARNING_FACTOR = 0.8.freeze
 
-      CLOSE_TO_DEFAULT_FACTOR = 0.1
+      CLOSE_TO_DEFAULT_FACTOR = 0.1.freeze
+
+      private_constant :NATIVE_MEMORY_WARNING_FACTOR, :TOTAL_MEMORY_WARNING_FACTOR, :CLOSE_TO_DEFAULT_FACTOR
 
       def allocate_lower_bounds(buckets)
         buckets.each_value do |bucket|
diff --git a/lib/java_buildpack/jre/open_jdk_like.rb b/lib/java_buildpack/jre/open_jdk_like.rb
@@ -63,6 +63,8 @@ def release
 
       KEY_MEMORY_SIZES = 'memory_sizes'.freeze
 
+      private_constant :KEY_MEMORY_HEURISTICS, :KEY_MEMORY_SIZES
+
       def killjava
         @droplet.sandbox + 'bin/killjava.sh'
       end
diff --git a/lib/java_buildpack/repository/configured_item.rb b/lib/java_buildpack/repository/configured_item.rb
@@ -56,6 +56,8 @@ def find_item(component_name, configuration, &version_validator)
 
         KEY_VERSION = 'version'.freeze
 
+        private_constant :KEY_REPOSITORY_ROOT, :KEY_VERSION
+
         def index(repository_root)
           RepositoryIndex.new(repository_root)
         end
diff --git a/lib/java_buildpack/repository/repository_index.rb b/lib/java_buildpack/repository/repository_index.rb
@@ -57,7 +57,9 @@ def find_item(version)
 
       private
 
-      INDEX_PATH = '/index.yml'
+      INDEX_PATH = '/index.yml'.freeze
+
+      private_constant :INDEX_PATH
 
       def architecture
         `uname -m`.strip
diff --git a/lib/java_buildpack/repository/version_resolver.rb b/lib/java_buildpack/repository/version_resolver.rb
@@ -51,7 +51,9 @@ def resolve(candidate_version, versions)
 
         private
 
-        TOKENIZED_WILDCARD = JavaBuildpack::Util::TokenizedVersion.new('+')
+        TOKENIZED_WILDCARD = JavaBuildpack::Util::TokenizedVersion.new('+').freeze
+
+        private_constant :TOKENIZED_WILDCARD
 
         def safe_candidate_version(candidate_version)
           if candidate_version.nil?
diff --git a/lib/java_buildpack/util/cache/download_cache.rb b/lib/java_buildpack/util/cache/download_cache.rb
@@ -76,7 +76,7 @@ def evict(uri)
 
         private
 
-        FAILURE_LIMIT = 5
+        FAILURE_LIMIT = 5.freeze
 
         HTTP_ERRORS = [
           EOFError,
@@ -100,7 +100,9 @@ def evict(uri)
           Timeout::Error
         ].freeze
 
-        TIMEOUT_SECONDS = 10
+        TIMEOUT_SECONDS = 10.freeze
+
+        private_constant :FAILURE_LIMIT, :HTTP_ERRORS, :TIMEOUT_SECONDS
 
         def attempt(http, request, cached_file)
           downloaded = false
diff --git a/lib/java_buildpack/util/class_file_utils.rb b/lib/java_buildpack/util/class_file_utils.rb
@@ -35,10 +35,10 @@ def class_files(application)
           (application.root + CLASS_FILE_PATTERN).glob.reject { |path| path.directory? }.sort
         end
 
-        private
-
         CLASS_FILE_PATTERN = '**/*.class'.freeze
 
+        private_constant :CLASS_FILE_PATTERN
+
       end
 
     end
diff --git a/lib/java_buildpack/util/configuration_utils.rb b/lib/java_buildpack/util/configuration_utils.rb
@@ -53,6 +53,8 @@ def load(identifier, should_log = true)
 
         CONFIG_DIRECTORY = Pathname.new(File.expand_path('../../../config', File.dirname(__FILE__))).freeze
 
+        private_constant :CONFIG_DIRECTORY
+
         def logger
           JavaBuildpack::Logging::LoggerFactory.instance.get_logger ConfigurationUtils
         end
diff --git a/lib/java_buildpack/util/filtering_pathname.rb b/lib/java_buildpack/util/filtering_pathname.rb
@@ -141,14 +141,16 @@ def glob(flags = 0, &block)
         end
       end
 
-      protected
-
       attr_reader :pathname
 
+      protected :pathname
+
       private
 
       MUTATORS = [:chmod, :chown, :delete, :lchmod, :lchown, :make_link, :make_symlink, :mkdir, :mkpath, :rename, :rmdir, :rmtree, :taint, :unlink, :untaint].to_set.freeze
 
+      private_constant :MUTATORS
+
       def check_file_does_not_exist(file)
         fail "#{file} should not exist" if file.exist?
       end
diff --git a/lib/java_buildpack/util/format_duration.rb b/lib/java_buildpack/util/format_duration.rb
diff --git a/lib/java_buildpack/util/groovy_utils.rb b/lib/java_buildpack/util/groovy_utils.rb
diff --git a/lib/java_buildpack/util/java_main_utils.rb b/lib/java_buildpack/util/java_main_utils.rb
diff --git a/lib/java_buildpack/util/play/base.rb b/lib/java_buildpack/util/play/base.rb
diff --git a/lib/java_buildpack/util/play/post22.rb b/lib/java_buildpack/util/play/post22.rb
diff --git a/lib/java_buildpack/util/play/post22_dist.rb b/lib/java_buildpack/util/play/post22_dist.rb
diff --git a/lib/java_buildpack/util/ratpack_utils.rb b/lib/java_buildpack/util/ratpack_utils.rb
diff --git a/lib/java_buildpack/util/tokenized_version.rb b/lib/java_buildpack/util/tokenized_version.rb
diff --git a/rakelib/dependency_cache_task.rb b/rakelib/dependency_cache_task.rb
diff --git a/spec/java_buildpack/jre/memory/memory_range_spec.rb b/spec/java_buildpack/jre/memory/memory_range_spec.rb
diff --git a/spec/java_buildpack/util/format_duration_spec.rb b/spec/java_buildpack/util/format_duration_spec.rb
