codeclimate 0.69.0 → 0.70.0

data/lib/cc/config/validation/json.rb

@@ -0,0 +1,31 @@
+module CC
+  class Config
+    module Validation
+      class JSON < FileValidator
+        private
+
+        def validate
+          @data = ::JSON.parse(File.read(path))
+
+          return unless validate_hash_data
+
+          validate_version
+          validate_prepare
+          validate_engines("plugins")
+          validate_checks
+          validate_exclude_pattern("exclude_patterns")
+
+          warn_unrecognized_keys(%w[prepare plugins exclude_patterns version])
+        rescue ::JSON::ParserError => ex
+          errors << "Unable to parse: #{ex.message}"
+        end
+
+        def validate_version
+          unless data.key?("version")
+            warnings << %(missing 'version' key. Please add `"version": "2"`)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cc/config/validation/prepare_validator.rb

@@ -0,0 +1,40 @@
+module CC
+  class Config
+    module Validation
+      class PrepareValidator
+        include HashValidations
+
+        attr_reader :errors, :warnings
+
+        def initialize(data)
+          @data = data
+
+          @errors = []
+          @warnings = []
+
+          validate
+        end
+
+        private
+
+        attr_reader :data
+
+        def validate
+          return unless validate_key_type("fetch", Array)
+
+          data.fetch("fetch", []).each do |fetch_data|
+            validator = FetchValidator.new(fetch_data)
+            validator.errors.each do |msg|
+              errors << msg
+            end
+            validator.warnings.each do |msg|
+              warnings << msg
+            end
+          end
+
+          warn_unrecognized_keys(%w[fetch])
+        end
+      end
+    end
+  end
+end

data/lib/cc/config/validation/yaml.rb

@@ -0,0 +1,66 @@
+module CC
+  class Config
+    module Validation
+      class YAML < FileValidator
+        private
+
+        def validate
+          @data = ::YAML.safe_load(File.read(path))
+
+          return unless validate_hash_data
+
+          validate_version
+          validate_prepare
+
+          validate_one_of(%w[engines plugins])
+          validate_one_of(%w[exclude_paths exclude_patterns])
+
+          validate_engines("engines", legacy: true)
+          validate_engines("plugins")
+
+          validate_checks
+
+          validate_exclude_pattern("exclude_patterns")
+          validate_exclude_pattern("exclude_paths", legacy: true)
+
+          deprecated_key_warnings
+          warn_unrecognized_keys(%w[prepare engines plugins ratings languages exclude_paths exclude_patterns version])
+        rescue Psych::SyntaxError => ex
+          errors << "Unable to parse: #{ex.message}"
+        end
+
+        def validate_version
+          if !data.key?("version") && (data.key?("plugins") || data.key?("exclude_patterns"))
+            warnings << %(missing 'version' key. Please add `version: "2"`)
+          end
+        end
+
+        def validate_one_of(keys)
+          num = keys.map { |k| data.key?(k) }.select(&:present?).count
+          if num > 1
+            wrapped_keys = keys.map { |k| "'#{k}'" }
+            errors << "only use one of #{wrapped_keys.join(", ")}"
+          end
+        end
+
+        def deprecated_key_warnings
+          deprecate_key("engines", "plugins")
+          deprecate_key("exclude_paths", "exclude_patterns")
+          deprecate_key("languages")
+          deprecate_key("ratings")
+        end
+
+        def deprecate_key(key, new_key = nil)
+          if data.key?(key)
+            warnings <<
+              if new_key.nil?
+                "'#{key}' has been deprecated, and will not be used"
+              else
+                "'#{key}' has been deprecated, please use '#{new_key}' instead"
+              end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cc/config/yaml_adapter.rb

@@ -0,0 +1,73 @@
+module CC
+  class Config
+    class YAMLAdapter
+      DEFAULT_PATH = ".codeclimate.yml".freeze
+
+      attr_reader :config
+
+      def self.load(path = DEFAULT_PATH)
+        new(::YAML.safe_load(File.read(path)))
+      end
+
+      def initialize(yaml = {})
+        @config = yaml || {}
+
+        upconvert_legacy_yaml!
+      end
+
+      private
+
+      def coerce_engine(data)
+        if [true, false].include?(data)
+          { "enabled" => data }
+        elsif data.is_a?(Hash)
+          data
+        else
+          {}
+        end
+      end
+
+      # Many of our plugins still expect:
+      #
+      #   { config: PATH }
+      #
+      # But we document, and hope to eventually move to:
+      #
+      #   { config: { file: PATH } }
+      #
+      # We need to munge from the latter to the former when/if we encounter it
+      def convert_to_legacy_file_config(config)
+        if config.is_a?(Hash) && config.keys.one? && config.key?("file")
+          config["file"]
+        else
+          config
+        end
+      end
+
+      def upconvert_legacy_yaml!
+        config.delete("ratings")
+
+        if config.key?("engines")
+          config["plugins"] ||= config.delete("engines")
+        end
+
+        plugins = config.fetch("plugins", {})
+        plugins.each do |engine, data|
+          plugins[engine] = coerce_engine(data)
+          if plugins.fetch(engine)["exclude_paths"]
+            plugins.fetch(engine)["exclude_patterns"] ||= Array(plugins.fetch(engine).delete("exclude_paths"))
+          end
+          if plugins.fetch(engine)["config"]
+            plugins.fetch(engine)["config"] = convert_to_legacy_file_config(
+              plugins.fetch(engine).fetch("config"),
+            )
+          end
+        end
+
+        if config.key?("exclude_paths")
+          config["exclude_patterns"] ||= Array(config.delete("exclude_paths"))
+        end
+      end
+    end
+  end
+end

data/lib/cc/engine_registry.rb

@@ -0,0 +1,74 @@
+module CC
+  class EngineRegistry
+    include Enumerable
+
+    DEFAULT_MEMORY_LIMIT = 1_024_000_000
+    DEFAULT_COMMAND = nil
+    DEFAULT_MANIFEST_PATH = File.expand_path("../../../config/engines.yml", __FILE__)
+
+    EngineDetails = Struct.new(:image, :command, :description, :memory)
+    EngineDetailsNotFoundError = Class.new(StandardError)
+
+    def initialize(path = DEFAULT_MANIFEST_PATH, prefix = "")
+      @yaml = YAML.safe_load(File.read(path))
+      @prefix = prefix
+    end
+
+    def each
+      yaml.each do |name, metadata|
+        engine = Config::Engine.new(
+          name,
+          channel: metadata.fetch("channels").keys.first,
+        )
+        engine_details = fetch_engine_details(engine)
+
+        yield(engine, engine_details)
+      end
+    end
+
+    def fetch_engine_details(engine, development: false)
+      if development
+        EngineDetails.new("codeclimate/codeclimate-#{engine.name}", nil, "")
+      else
+        metadata = yaml.fetch(engine.name)
+        channels = metadata.fetch("channels")
+
+        EngineDetails.new(
+          [prefix, channels.fetch(engine.channel)].join,
+          metadata.fetch("command", DEFAULT_COMMAND),
+          metadata.fetch("description", "(No description available)"),
+          memory_limit(metadata["minimum_memory_limit"]),
+        )
+      end
+    rescue KeyError
+      raise EngineDetailsNotFoundError, not_found_message(engine, channels)
+    end
+
+    private
+
+    attr_reader :yaml, :prefix
+
+    def memory_limit(minimum_memory_limit)
+      [
+        minimum_memory_limit.to_i,
+        default_memory_limit.to_i,
+      ].max
+    end
+
+    def default_memory_limit
+      ENV["ENGINE_MEMORY_LIMIT_BYTES"] || DEFAULT_MEMORY_LIMIT
+    end
+
+    def not_found_message(engine, available_channels)
+      if available_channels
+        # Known engine, unknown channel
+        "Channel #{engine.channel} not found" \
+          " for #{engine.name}," \
+          " available channels: #{available_channels.keys.inspect}"
+      else
+        # Unknown engine
+        "No engine named #{engine.name} found"
+      end
+    end
+  end
+end

data/lib/cc/workspace/path_tree/dir_node.rb

@@ -42,7 +42,7 @@ module CC
             children[entry.basename.to_s.dup.freeze] ||= PathTree.node_for_pathname(entry)
             children[entry.basename.to_s.dup.freeze].add(*tail)
           else
-            CLI.debug("Couldn't include because part of path doesn't exist.", path: File.join(root_path, head))
+            Analyzer.logger.debug("Couldn't include because part of path doesn't exist: #{File.join(root_path, head)}")
           end
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate
 version: !ruby/object:Gem::Version
-  version: 0.69.0
+  version: 0.70.0
 platform: ruby
 authors:
 - Code Climate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-09 00:00:00.000000000 Z
+date: 2017-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: 5.1.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: 5.1.3
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: tty-spinner
   requirement: !ruby/object:Gem::Requirement
@@ -44,20 +44,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.1.0
-- !ruby/object:Gem::Dependency
-  name: codeclimate-yaml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.13.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.13.0
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -160,51 +146,28 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
-- !ruby/object:Gem::Dependency
-  name: safe_yaml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
 description: Code Climate command line tool
 email: hello@codeclimate.com
-executables:
-- codeclimate-init
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - bin/check
 - bin/codeclimate
-- bin/codeclimate-init
 - bin/prep-release
 - bin/release
 - bin/validate-release
-- config/coffeelint/coffeelint.json
-- config/csslint/.csslintrc
 - config/engines.yml
-- config/eslint/.eslintignore
-- config/eslint/.eslintrc.yml
-- config/rubocop/.rubocop.yml
 - lib/cc/analyzer.rb
+- lib/cc/analyzer/bridge.rb
 - lib/cc/analyzer/composite_container_listener.rb
-- lib/cc/analyzer/config.rb
 - lib/cc/analyzer/container.rb
+- lib/cc/analyzer/container/result.rb
 - lib/cc/analyzer/container_listener.rb
 - lib/cc/analyzer/engine.rb
 - lib/cc/analyzer/engine_output.rb
 - lib/cc/analyzer/engine_output_filter.rb
 - lib/cc/analyzer/engine_output_overrider.rb
-- lib/cc/analyzer/engine_registry.rb
-- lib/cc/analyzer/engines_config_builder.rb
-- lib/cc/analyzer/engines_runner.rb
 - lib/cc/analyzer/filesystem.rb
 - lib/cc/analyzer/formatters.rb
 - lib/cc/analyzer/formatters/formatter.rb
@@ -231,39 +194,57 @@ files:
 - lib/cc/analyzer/issue_validator.rb
 - lib/cc/analyzer/location_description.rb
 - lib/cc/analyzer/logging_container_listener.rb
+- lib/cc/analyzer/measurement.rb
+- lib/cc/analyzer/measurement_validations.rb
+- lib/cc/analyzer/measurement_validations/name_validation.rb
+- lib/cc/analyzer/measurement_validations/type_validation.rb
+- lib/cc/analyzer/measurement_validations/validation.rb
+- lib/cc/analyzer/measurement_validations/value_validation.rb
+- lib/cc/analyzer/measurement_validator.rb
 - lib/cc/analyzer/mounted_path.rb
 - lib/cc/analyzer/raising_container_listener.rb
 - lib/cc/analyzer/source_buffer.rb
 - lib/cc/analyzer/source_extractor.rb
 - lib/cc/analyzer/source_fingerprint.rb
 - lib/cc/analyzer/statsd_container_listener.rb
+- lib/cc/analyzer/validator.rb
 - lib/cc/cli.rb
 - lib/cc/cli/analyze.rb
+- lib/cc/cli/analyze/engine_failure.rb
 - lib/cc/cli/command.rb
-- lib/cc/cli/config.rb
-- lib/cc/cli/config_generator.rb
 - lib/cc/cli/console.rb
 - lib/cc/cli/engines.rb
-- lib/cc/cli/engines/disable.rb
-- lib/cc/cli/engines/enable.rb
 - lib/cc/cli/engines/engine_command.rb
 - lib/cc/cli/engines/install.rb
 - lib/cc/cli/engines/list.rb
-- lib/cc/cli/engines/remove.rb
 - lib/cc/cli/file_store.rb
 - lib/cc/cli/global_cache.rb
 - lib/cc/cli/global_config.rb
 - lib/cc/cli/help.rb
-- lib/cc/cli/init.rb
 - lib/cc/cli/output.rb
 - lib/cc/cli/prepare.rb
-- lib/cc/cli/prepare/quality.rb
 - lib/cc/cli/runner.rb
 - lib/cc/cli/test.rb
-- lib/cc/cli/upgrade_config_generator.rb
 - lib/cc/cli/validate_config.rb
 - lib/cc/cli/version.rb
 - lib/cc/cli/version_checker.rb
+- lib/cc/config.rb
+- lib/cc/config/checks_adapter.rb
+- lib/cc/config/default_adapter.rb
+- lib/cc/config/engine.rb
+- lib/cc/config/engine_set.rb
+- lib/cc/config/json_adapter.rb
+- lib/cc/config/prepare.rb
+- lib/cc/config/validation/check_validator.rb
+- lib/cc/config/validation/engine_validator.rb
+- lib/cc/config/validation/fetch_validator.rb
+- lib/cc/config/validation/file_validator.rb
+- lib/cc/config/validation/hash_validations.rb
+- lib/cc/config/validation/json.rb
+- lib/cc/config/validation/prepare_validator.rb
+- lib/cc/config/validation/yaml.rb
+- lib/cc/config/yaml_adapter.rb
+- lib/cc/engine_registry.rb
 - lib/cc/resolv.rb
 - lib/cc/workspace.rb
 - lib/cc/workspace/exclusion.rb
@@ -290,7 +271,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Code Climate CLI