codeclimate 0.29.0 → 0.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efa08f642f16f2216254aad188d1e577569710cd
-  data.tar.gz: cab24ce9e68f7cb1622d0549dc3608b8901b86c3
+  metadata.gz: a3f32cefb371cbbde1e958f6e6249101cd6aaba0
+  data.tar.gz: 63bf94a4ec496821d32a185247ab24a5b52502ba
 SHA512:
-  metadata.gz: c8e00338ff2aed40e05240529f434a6a01f6c57a0bc2e4230079d34a653da771bf9cf3fd09abe6aec7115085da49304d813dd0460903a9141a1d1abbce21c81d
-  data.tar.gz: 9f91b473418c645f5bcf1c78cd6cfd2e8f1e603165b5d9d97dbab3d974880d423b6eec6b86b1e6f22a9792933d3f30ee3ee344cd05e9d104ee7f6e2ca168716e
+  metadata.gz: b847ba8b39c19a3e5f17254271aeee4641cbc0bf95ff8c383a10ff24f354c40ad21e57de65093953cb8d334c528214c2840744d6a66018a62b1ffa8ed80c6754
+  data.tar.gz: d912d8ead585a16848ea2f06b35cc5dafdf3853fdcad8ab45aacb8db7de9446ec9e86e5de7b806d10c9bf2bafc008de8655965b01a5da8c7199d9a516fbc6825

data/config/engines.yml

@@ -1,8 +1,8 @@
 # This file lists all the engines available to be run for analysis.
 #
-# Each engine must have an `image` and `description`. The value in `image` will
-# be passed to `docker run` and so may be any value appropriate for that
-# (repo/name:tag, image id, etc).
+# Each engine must have `channels` (with a `stable` key) and `description`. The
+# values in `channels` will be passed to `docker run` and so may be any value
+# appropriate for that (repo/name:tag, image id, etc).
 #
 # When a repo has files that match the `enable_regexps`, that engine will be
 # enabled by default in the codeclimate.yml file. That file will also have in it
@@ -10,7 +10,8 @@
 # which files should be rated.
 #
 brakeman:
-  image: codeclimate/codeclimate-brakeman
+  channels:
+    stable: codeclimate/codeclimate-brakeman
   description: Static analysis tool which checks Ruby on Rails applications for security vulnerabilities.
   community: false
   upgrade_languages:
@@ -25,7 +26,8 @@ brakeman:
     - "**.rhtml"
     - "**.slim"
 bundler-audit:
-  image: codeclimate/codeclimate-bundler-audit
+  channels:
+    stable: codeclimate/codeclimate-bundler-audit
   description: Patch-level verification for Bundler.
   community: false
   upgrade_languages:
@@ -35,7 +37,8 @@ bundler-audit:
   default_ratings_paths:
     - Gemfile.lock
 csslint:
-  image: codeclimate/codeclimate-csslint
+  channels:
+    stable: codeclimate/codeclimate-csslint
   description: Automated linting of Cascading Stylesheets.
   community: false
   enable_regexps:
@@ -43,7 +46,8 @@ csslint:
   default_ratings_paths:
     - "**.css"
 coffeelint:
-  image: codeclimate/codeclimate-coffeelint
+  channels:
+    stable: codeclimate/codeclimate-coffeelint
   description: A style checker for CoffeeScript.
   community: false
   enable_regexps:
@@ -51,7 +55,8 @@ coffeelint:
   default_ratings_paths:
     - "**.coffee"
 duplication:
-  image: codeclimate/codeclimate-duplication
+  channels:
+    stable: codeclimate/codeclimate-duplication
   description: Structural duplication detection for Ruby, Python, JavaScript, and PHP.
   community: false
   enable_regexps:
@@ -77,7 +82,8 @@ duplication:
       - python
       - php
 eslint:
-  image: codeclimate/codeclimate-eslint
+  channels:
+    stable: codeclimate/codeclimate-eslint
   description: A JavaScript/JSX linting utility.
   community: false
   upgrade_languages:
@@ -89,7 +95,8 @@ eslint:
     - "**.js"
     - "**.jsx"
 gofmt:
-  image: codeclimate/codeclimate-gofmt
+  channels:
+    stable: codeclimate/codeclimate-gofmt
   description: Checks the formatting of Go programs.
   community: true
   enable_regexps:
@@ -97,7 +104,8 @@ gofmt:
   default_ratings_paths:
     - "**.go"
 golint:
-  image: codeclimate/codeclimate-golint
+  channels:
+    stable: codeclimate/codeclimate-golint
   description: A linter for Go.
   community: true
   enable_regexps:
@@ -105,7 +113,8 @@ golint:
   default_ratings_paths:
     - "**.go"
 govet:
-  image: codeclimate/codeclimate-govet
+  channels:
+    stable: codeclimate/codeclimate-govet
   description: Reports suspicious constructs in Go programs.
   community: true
   enable_regexps:
@@ -113,20 +122,23 @@ govet:
   default_ratings_paths:
     - "**.go"
 fixme:
-  image: codeclimate/codeclimate-fixme
+  channels:
+    stable: codeclimate/codeclimate-fixme
   description: Finds FIXME, TODO, HACK, etc. comments.
   community: false
   enable_regexps:
     - .+
   default_ratings_paths: []
 foodcritic:
-  image: codeclimate/codeclimate-foodcritic
+  channels:
+    stable: codeclimate/codeclimate-foodcritic
   description: Lint tool for Chef cookbooks.
   community: true
   enable_regexps:
   default_ratings_paths:
 gnu-complexity:
-  image: codeclimate/codeclimate-gnu-complexity
+  channels:
+    stable: codeclimate/codeclimate-gnu-complexity
   description: Checks complexity of C code
   community: true
   enable_regexps:
@@ -134,7 +146,8 @@ gnu-complexity:
   default_ratings_paths:
     - "**.c"
 haxe-checkstyle:
-  image: codeclimate/codeclimate-haxe-checkstyle
+  channels:
+    stable: codeclimate/codeclimate-haxe-checkstyle
   description: Checkstyle is a development library to help developers write Haxe code that adheres to a coding standard.
   community: true
   enable_regexps:
@@ -142,7 +155,8 @@ haxe-checkstyle:
   default_ratings_paths:
     - "**.hx"
 hlint:
-  image: codeclimate/codeclimate-hlint
+  channels:
+    stable: codeclimate/codeclimate-hlint
   description: Linter for Haskell programs.
   community: true
   enable_regexps:
@@ -150,7 +164,8 @@ hlint:
   default_ratings_paths:
     - "**.hs"
 kibit:
-  image: codeclimate/codeclimate-kibit
+  channels:
+    stable: codeclimate/codeclimate-kibit
   description: Static code analyzer for Clojure, ClojureScript, cljx and other Clojure variants.
   community: true
   enable_regexps:
@@ -162,7 +177,8 @@ kibit:
     - "**.cljc"
     - "**.cljs"
 markdownlint:
-  image: codeclimate/codeclimate-markdownlint
+  channels:
+    stable: codeclimate/codeclimate-markdownlint
   description: Flags style issues within Markdown files.
   community: true
   enable_regexps:
@@ -172,20 +188,23 @@ markdownlint:
     - "**.markdown"
     - "**.md"
 nodesecurity:
-  image: codeclimate/codeclimate-nodesecurity
+  channels:
+    stable: codeclimate/codeclimate-nodesecurity
   description: Security tool for Node.js dependencies.
   community: true
   enable_regexps:
   default_ratings_paths:
 pep8:
-  image: codeclimate/codeclimate-pep8
+  channels:
+    stable: codeclimate/codeclimate-pep8
   description: Static analysis tool to check Python code against the style conventions outlined in PEP-8.
   community: false
   enable_regexps:
   default_ratings_paths:
     - "**.py"
 phan:
-  image: codeclimate/codeclimate-phan
+  channels:
+    stable: codeclimate/codeclimate-phan
   description: Phan is a static analyzer for PHP.
   community: true
   enable_regexps:
@@ -197,7 +216,8 @@ phan:
     - "**.module"
     - "**.inc"
 phpcodesniffer:
-  image: codeclimate/codeclimate-phpcodesniffer
+  channels:
+    stable: codeclimate/codeclimate-phpcodesniffer
   description: Detects violations of a defined set of coding standards in PHP.
   community: false
   enable_regexps:
@@ -206,7 +226,8 @@ phpcodesniffer:
     - "**.module"
     - "**.inc"
 phpmd:
-  image: codeclimate/codeclimate-phpmd
+  channels:
+    stable: codeclimate/codeclimate-phpmd
   description: A PHP static analysis tool.
   community: false
   upgrade_languages:
@@ -220,7 +241,8 @@ phpmd:
     - "**.module"
     - "**.inc"
 radon:
-  image: codeclimate/codeclimate-radon
+  channels:
+    stable: codeclimate/codeclimate-radon
   description: Python tool used to compute Cyclomatic Complexity.
   community: false
   upgrade_languages:
@@ -230,7 +252,8 @@ radon:
   default_ratings_paths:
     - "**.py"
 reek:
-  image: codeclimate/codeclimate-reek
+  channels:
+    stable: codeclimate/codeclimate-reek
   description: "Reek examines Ruby classes, modules, and methods and reports any code smells it finds."
   community: true
   upgrade_languages:
@@ -240,13 +263,15 @@ reek:
   default_ratings_paths:
     - "**.rb"
 requiresafe:
-  image: codeclimate/codeclimate-nodesecurity
+  channels:
+    stable: codeclimate/codeclimate-nodesecurity
   description: Security tool for Node.js dependencies.
   community: true
   enable_regexps:
   default_ratings_paths:
 rubocop:
-  image: codeclimate/codeclimate-rubocop
+  channels:
+    stable: codeclimate/codeclimate-rubocop
   description: A Ruby static code analyzer, based on the community Ruby style guide.
   community: false
   upgrade_languages:
@@ -256,28 +281,32 @@ rubocop:
   default_ratings_paths:
     - "**.rb"
 rubocop-v35:
-  image: codeclimate/codeclimate-rubocop:v35
+  channels:
+    stable: codeclimate/codeclimate-rubocop:v35
   description: A Ruby static code analyzer, based on the community Ruby style guide. Version 0.35.1 of RuboCop.
   community: false
   enable_regexps:
   default_ratings_paths:
     - "**.rb"
 rubymotion:
-  image: codeclimate/codeclimate-rubymotion
+  channels:
+    stable: codeclimate/codeclimate-rubymotion
   description: Rubymotion-specific rubocop checks.
   community: true
   enable_regexps:
   default_ratings_paths:
     - "**.rb"
 scss-lint:
-  image: codeclimate/codeclimate-scss-lint
+  channels:
+    stable: codeclimate/codeclimate-scss-lint
   description: Configurable tool for writing clean and consistent SCSS.
   community: true
   enable_regexps:
   default_ratings_paths:
     - "**.scss"
 shellcheck:
-  image: codeclimate/codeclimate-shellcheck
+  channels:
+    stable: codeclimate/codeclimate-shellcheck
   description: A static analysis tool for shell scripts.
   community: true
   enable_regexps:
@@ -285,7 +314,8 @@ shellcheck:
   default_ratings_paths:
     - "**.sh"
 tailor:
-  image: codeclimate/codeclimate-tailor
+  channels:
+    stable: codeclimate/codeclimate-tailor
   description: Cross-platform static analyzer and linter for Swift.
   community: true
   enable_regexps:
@@ -293,14 +323,16 @@ tailor:
   default_ratings_paths:
     - "**.swift"
 watson:
-  image: codeclimate/codeclimate-watson
+  channels:
+    stable: codeclimate/codeclimate-watson
   description: A young Ember Doctor to help you fix your code.
   community: true
   enable_regexps:
   default_ratings_paths:
     - "app/**"
 vint:
-  image: codeclimate/codeclimate-vint
+  channels:
+    stable: codeclimate/codeclimate-vint
   description: Fast and Highly Extensible Vim script Language Lint implemented by Python.
   community: true
   enable_regexps:

data/lib/cc/analyzer/engine.rb

@@ -52,6 +52,11 @@ module CC
         container.run(container_options).tap do |result|
           CLI.debug("#{name} engine stderr: #{result.stderr}")
         end
+      rescue Container::ImageRequired
+        # Provide a clearer message given the context we have
+        message = "Unable to find an image for #{name}:#{@config["channel"]}."
+        message << " Available channels: #{@metadata["channels"].keys.inspect}."
+        raise Container::ImageRequired, message
       ensure
         delete_config_file
       end

data/lib/cc/analyzer/engines_config_builder.rb

@@ -3,6 +3,19 @@ require "securerandom"
 module CC
   module Analyzer
     class EnginesConfigBuilder
+      class RegistryAdapter < SimpleDelegator
+        # Calling this is guarded by Registry#key?(name) so we can assume
+        # metadata itself will be present. We own the YAML loaded into the
+        # registry, so we can also assume the "channels" key will be present. We
+        # can't assume it will have a key for the given channel, but the nil
+        # value for the returned image key will trigger the desired error
+        # handling.
+        def fetch(name, channel)
+          metadata = self[name]
+          metadata.merge("image" => metadata["channels"][channel])
+        end
+      end
+
       Result = Struct.new(
         :name,
         :registry_entry,
@@ -12,7 +25,7 @@ module CC
       )
 
       def initialize(registry:, config:, container_label:, source_dir:, requested_paths:)
-        @registry = registry
+        @registry = RegistryAdapter.new(registry)
         @config = config
         @container_label = container_label
         @requested_paths = requested_paths
@@ -23,7 +36,8 @@ module CC
         names_and_raw_engine_configs.map do |name, raw_engine_config|
           label = @container_label || SecureRandom.uuid
           engine_config = engine_config(raw_engine_config)
-          Result.new(name, @registry[name], @source_dir, engine_config, label)
+          engine_metadata = @registry.fetch(name, raw_engine_config.channel)
+          Result.new(name, engine_metadata, @source_dir, engine_config, label)
         end
       end
 

data/lib/cc/analyzer/formatters.rb

@@ -2,11 +2,13 @@ module CC
   module Analyzer
     module Formatters
       autoload :Formatter, "cc/analyzer/formatters/formatter"
+      autoload :HTMLFormatter, "cc/analyzer/formatters/html_formatter"
       autoload :JSONFormatter, "cc/analyzer/formatters/json_formatter"
       autoload :PlainTextFormatter, "cc/analyzer/formatters/plain_text_formatter"
       autoload :Spinner, "cc/analyzer/formatters/spinner"
 
       FORMATTERS = {
+        html: HTMLFormatter,
         json: JSONFormatter,
         text: PlainTextFormatter,
       }.freeze

data/lib/cc/analyzer/formatters/html_formatter.rb

@@ -0,0 +1,82 @@
+require "redcarpet"
+require "active_support/number_helper"
+
+module CC
+  module Analyzer
+    module Formatters
+      class HTMLFormatter < Formatter
+        class ReportTemplate
+          include ERB::Util
+          attr_accessor :template, :issues, :issues_by_path
+
+          TEMPLATE_PATH = File.expand_path(File.join(File.dirname(__FILE__), "templates/html.erb"))
+
+          def initialize(issue_count, issues_by_path)
+            @template = File.read(TEMPLATE_PATH)
+            @issues_by_path = issues_by_path
+            @issue_count = issue_count
+          end
+
+          def render
+            ERB.new(@template).result(binding)
+          end
+
+          def pluralize(number, noun)
+            "#{ActiveSupport::NumberHelper.number_to_delimited(number)} #{noun.pluralize(number)}"
+          end
+        end
+
+        def write(data)
+          json = JSON.parse(data)
+          json["engine_name"] = current_engine.name
+
+          case json["type"].downcase
+          when "issue"
+            issues << json
+          when "warning"
+            warnings << json
+          else
+            raise "Invalid type found: #{json["type"]}"
+          end
+        end
+
+        def finished
+          template = ReportTemplate.new(issues.length, issues_by_path)
+          puts template.render
+        end
+
+        def failed(_)
+          exit 1
+        end
+
+        private
+
+        def issues
+          @issues ||= []
+        end
+
+        def issues_by_path
+          issues.group_by { |i| i["location"]["path"] }.sort.each do |_, file_issues|
+            IssueSorter.new(file_issues).by_location.map do |issue|
+              source_buffer = @filesystem.source_buffer_for(issue["location"]["path"])
+              issue["location"] = LocationDescription.new(source_buffer, issue["location"], "")
+              issue["description"] = render_readup_markdown(issue["description"])
+              if issue["content"]
+                issue["content"]["body"] = render_readup_markdown(issue["content"]["body"])
+              end
+            end
+          end
+        end
+
+        def warnings
+          @warnings ||= []
+        end
+
+        def render_readup_markdown(body)
+          html = Redcarpet::Render::HTML.new(escape_html: false, link_attributes: { target: "_blank" })
+          Redcarpet::Markdown.new(html, autolink: true, fenced_code_blocks: true, tables: true).render(body)
+        end
+      end
+    end
+  end
+end

data/lib/cc/cli/analyze.rb

@@ -83,10 +83,15 @@ module CC
 
       def add_engine_options
         engine_options.each do |engine|
+          name, channel = engine.split(":", 2)
+
           if config.engines.include?(engine)
-            config.engines[engine].enabled = true
+            config.engines[name].enabled = true
+            config.engines[name].channel = channel if channel
           else
-            config.engines[engine] = CC::Yaml::Nodes::Engine.new(config.engines).with_value("enabled" => true)
+            value = { "enabled" => true }
+            value["channel"] = channel if channel
+            config.engines[name] = CC::Yaml::Nodes::Engine.new(config.engines).with_value(value)
           end
         end
       end

data/lib/cc/cli/engines/install.rb

@@ -16,8 +16,8 @@ module CC
         def pull_docker_images
           engine_names.each do |name|
             if engine_registry.exists?(name)
-              image = engine_image(name)
-              pull_engine_image(image)
+              images = engine_registry[name]["channels"].values
+              images.each { |image| pull_engine_image(image) }
             else
               warn("unknown engine name: #{name}")
             end
@@ -28,10 +28,6 @@ module CC
           @engine_names ||= parsed_yaml.engine_names
         end
 
-        def engine_image(engine_name)
-          engine_registry_list[engine_name]["image"]
-        end
-
         def pull_engine_image(engine_image)
           unless system("docker pull #{engine_image}")
             raise ImagePullFailure, "unable to pull image #{engine_image}"

data/lib/cc/cli/help.rb

@@ -14,7 +14,7 @@ module CC
 
       def commands
         [
-          "analyze [-f format] [-e engine] <path>",
+          "analyze [-f format] [-e engine(:channel)] <path>",
           "console",
           "engines:disable #{underline("engine_name")}",
           "engines:enable #{underline("engine_name")}",

data/lib/cc/cli/test.rb

@@ -234,7 +234,7 @@ module CC
       end
 
       def engine_image
-        engine_registry[@engine_name]["image"]
+        engine_registry[@engine_name]["channels"]["stable"]
       end
 
       # Stolen from ActiveSupport (where it was deprecated)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate
 version: !ruby/object:Gem::Version
-  version: 0.29.0
+  version: 0.30.0
 platform: ruby
 authors:
 - Code Climate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-20 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -132,6 +132,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: Code Climate command line tool
 email: hello@codeclimate.com
 executables:
@@ -164,6 +178,7 @@ files:
 - lib/cc/analyzer/filesystem.rb
 - lib/cc/analyzer/formatters.rb
 - lib/cc/analyzer/formatters/formatter.rb
+- lib/cc/analyzer/formatters/html_formatter.rb
 - lib/cc/analyzer/formatters/json_formatter.rb
 - lib/cc/analyzer/formatters/plain_text_formatter.rb
 - lib/cc/analyzer/formatters/spinner.rb