codeclimate 0.24.3 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5ba7e27f0c2fcc953c2f14dc15ca0055ddf4d25
-  data.tar.gz: 919f9784e1f9c9f22eb82168d6bdb8213082e8b3
+  metadata.gz: c732584b6855ac426cc7e0a19b4fb55375f7fcf5
+  data.tar.gz: 1678f0e4a32a532a7e871412e681ddaf7cc0f59a
 SHA512:
-  metadata.gz: 9069df8ef0b536687fbac616f775b8e6723820dfc36f424eb49ef31e2ffef19b34bf8ecf172bc7947344b1328a116da992feecf20ef42ca9f6b8872083051676
-  data.tar.gz: 87096921939b8b13fc5b00278cfc11d73dc74479878524712d5e955667a42ee05e3d18d9184cf99f4faa3a62d4d2900a6784277ee3c7c8dfa71f75a86c99a45c
+  metadata.gz: b091b7d2457a3aa89666baba5b3c789f1284854edc95c25a96a96571202aa3b2a35462568f8c93e924f1bced4cf90825864685d24e14988fed77a7d0a0e54afa
+  data.tar.gz: 4c2cc51abd7534ac166daffb627ce7a099118d18beb6816222d8b87060d2ed020d6a0d9283813aca5d7a556903206f9cc706dbe30fc806f79fa0c8066c700b94

data/lib/cc/analyzer.rb

@@ -15,13 +15,22 @@ module CC
     autoload :Filesystem, "cc/analyzer/filesystem"
     autoload :Formatters, "cc/analyzer/formatters"
     autoload :Issue, "cc/analyzer/issue"
+    autoload :IssueCategoryValidation, "cc/analyzer/issue_category_validation"
+    autoload :IssueCheckNamePresenceValidation, "cc/analyzer/issue_check_name_presence_validation"
+    autoload :IssueDescriptionPresenceValidation, "cc/analyzer/issue_description_presence_validation"
+    autoload :IssuePathExistenceValidation, "cc/analyzer/issue_path_existence_validation"
+    autoload :IssuePathPresenceValidation, "cc/analyzer/issue_path_presence_validation"
+    autoload :IssueRelativePathValidation, "cc/analyzer/issue_relative_path_validation"
     autoload :IssueSorter, "cc/analyzer/issue_sorter"
+    autoload :IssueTypeValidation, "cc/analyzer/issue_type_validation"
+    autoload :IssueValidator, "cc/analyzer/issue_validator"
     autoload :LocationDescription, "cc/analyzer/location_description"
     autoload :LoggingContainerListener, "cc/analyzer/logging_container_listener"
     autoload :MountedPath, "cc/analyzer/mounted_path"
     autoload :RaisingContainerListener, "cc/analyzer/raising_container_listener"
     autoload :SourceBuffer, "cc/analyzer/source_buffer"
     autoload :StatsdContainerListener, "cc/analyzer/statsd_container_listener"
+    autoload :Validation, "cc/analyzer/validation"
 
     class DummyStatsd
       def method_missing(*)

data/lib/cc/analyzer/container.rb

@@ -5,11 +5,11 @@ module CC
   module Analyzer
     class Container
       ContainerData = Struct.new(
-        :image,         # image used to create the container
-        :name,          # name given to the container when created
-        :duration,      # duration, for a finished event
-        :status,        # status, for a finished event
-        :stderr,        # stderr, for a finished event
+        :image, # image used to create the container
+        :name, # name given to the container when created
+        :duration, # duration, for a finished event
+        :status, # status, for a finished event
+        :stderr, # stderr, for a finished event
       )
       ImageRequired = Class.new(StandardError)
       Result = Struct.new(

data/lib/cc/analyzer/engine.rb

@@ -37,6 +37,11 @@ module CC
           CLI.debug("#{name} engine output: #{raw_output.strip}")
           output = EngineOutput.new(raw_output)
 
+          unless output.valid?
+            stdout_io.failed("#{name} produced invalid output: #{output.error[:message]}")
+            container.stop
+          end
+
           unless output_filter.filter?(output)
             stdout_io.write(output.to_json) || container.stop
           end

data/lib/cc/analyzer/engine_output.rb

@@ -18,15 +18,27 @@ module CC
         Issue.new(raw_output)
       end
 
+      def valid?
+        validator.valid?
+      end
+
+      def error
+        validator.error
+      end
+
       private
 
       attr_accessor :raw_output
 
       def parsed_output
-        JSON.parse(raw_output)
+        @parsed_output ||= JSON.parse(raw_output)
       rescue JSON::ParserError
         nil
       end
+
+      def validator
+        IssueValidator.new(parsed_output)
+      end
     end
   end
 end

data/lib/cc/analyzer/formatters.rb

@@ -12,7 +12,7 @@ module CC
       }.freeze
 
       def self.resolve(name)
-        FORMATTERS[name.to_sym] or raise Formatter::InvalidFormatterError, "'#{name}' is not a valid formatter. Valid options are: #{FORMATTERS.keys.join(', ')}"
+        FORMATTERS[name.to_sym] or raise Formatter::InvalidFormatterError, "'#{name}' is not a valid formatter. Valid options are: #{FORMATTERS.keys.join(", ")}"
       end
     end
   end

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

@@ -20,7 +20,7 @@ module CC
           when "warning"
             warnings << json
           else
-            raise "Invalid type found: #{json['type']}"
+            raise "Invalid type found: #{json["type"]}"
           end
         end
 
@@ -28,7 +28,7 @@ module CC
           puts
 
           issues_by_path.each do |path, file_issues|
-            puts colorize("== #{path} (#{pluralize(file_issues.size, 'issue')}) ==", :yellow)
+            puts colorize("== #{path} (#{pluralize(file_issues.size, "issue")}) ==", :yellow)
 
             IssueSorter.new(file_issues).by_location.each do |issue|
               if (location = issue["location"])
@@ -37,15 +37,15 @@ module CC
               end
 
               print(issue["description"])
-              print(colorize(" [#{issue['engine_name']}]", "#333333"))
+              print(colorize(" [#{issue["engine_name"]}]", "#333333"))
               puts
             end
             puts
           end
 
-          print(colorize("Analysis complete! Found #{pluralize(issues.size, 'issue')}", :green))
+          print(colorize("Analysis complete! Found #{pluralize(issues.size, "issue")}", :green))
           if warnings.size > 0
-            print(colorize(" and #{pluralize(warnings.size, 'warning')}", :green))
+            print(colorize(" and #{pluralize(warnings.size, "warning")}", :green))
           end
           puts(colorize(".", :green))
         end

data/lib/cc/analyzer/issue_category_validation.rb

@@ -0,0 +1,30 @@
+module CC
+  module Analyzer
+    class IssueCategoryValidation < Validation
+      CATEGORIES = [
+        "Bug Risk".freeze,
+        "Clarity".freeze,
+        "Compatibility".freeze,
+        "Complexity".freeze,
+        "Duplication".freeze,
+        "Performance".freeze,
+        "Security".freeze,
+        "Style".freeze,
+      ].freeze
+
+      def valid?
+        object["categories"].present? && no_invalid_categories?
+      end
+
+      def message
+        "Category must be at least one of #{CATEGORIES.join(", ")}"
+      end
+
+      private
+
+      def no_invalid_categories?
+        (CATEGORIES | object["categories"]) == CATEGORIES
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_check_name_presence_validation.rb

@@ -0,0 +1,13 @@
+module CC
+  module Analyzer
+    class IssueCheckNamePresenceValidation < Validation
+      def valid?
+        object["check_name"].present?
+      end
+
+      def message
+        "Check name must be present"
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_description_presence_validation.rb

@@ -0,0 +1,13 @@
+module CC
+  module Analyzer
+    class IssueDescriptionPresenceValidation < Validation
+      def valid?
+        object["description"].present?
+      end
+
+      def message
+        "Description must be present"
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_path_existence_validation.rb

@@ -0,0 +1,19 @@
+module CC
+  module Analyzer
+    class IssuePathExistenceValidation < Validation
+      def valid?
+        File.exist?(path)
+      end
+
+      def message
+        "File does not exist: '#{path}'"
+      end
+
+      private
+
+      def path
+        object.fetch("location", {}).fetch("path", "")
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_path_presence_validation.rb

@@ -0,0 +1,19 @@
+module CC
+  module Analyzer
+    class IssuePathPresenceValidation < Validation
+      def valid?
+        path.present?
+      end
+
+      def message
+        "Path must be present"
+      end
+
+      private
+
+      def path
+        object.fetch("location", {})["path"]
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_relative_path_validation.rb

@@ -0,0 +1,19 @@
+module CC
+  module Analyzer
+    class IssueRelativePathValidation < Validation
+      def valid?
+        path && !path.start_with?("/")
+      end
+
+      def message
+        "Path must be relative"
+      end
+
+      private
+
+      def path
+        object.fetch("location", {})["path"]
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_type_validation.rb

@@ -0,0 +1,19 @@
+module CC
+  module Analyzer
+    class IssueTypeValidation < Validation
+      def valid?
+        type && type.casecmp("issue").zero?
+      end
+
+      def message
+        "Type must be 'issue' but was '#{type}'"
+      end
+
+      private
+
+      def type
+        object["type"]
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validator.rb

@@ -0,0 +1,46 @@
+module CC
+  module Analyzer
+    class IssueValidator
+      CHECKS = [
+        IssueCategoryValidation,
+        IssueCheckNamePresenceValidation,
+        IssueDescriptionPresenceValidation,
+        IssuePathExistenceValidation,
+        IssuePathPresenceValidation,
+        IssueRelativePathValidation,
+        IssueTypeValidation,
+      ].freeze
+
+      attr_reader :error
+
+      def initialize(issue)
+        @issue = issue
+      end
+
+      def valid?
+        return @valid unless @valid.nil?
+
+        if issue && invalid_messages.any?
+          @error = {
+            message: "#{invalid_messages.join("; ")}: `#{issue}`.",
+            issue: issue,
+          }
+          @valid = false
+        else
+          @valid = true
+        end
+      end
+
+      private
+
+      attr_reader :issue
+
+      def invalid_messages
+        @invalid_messages ||= CHECKS.each_with_object([]) do |check, result|
+          validator = check.new(issue)
+          result << validator.message unless validator.valid?
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/validation.rb

@@ -0,0 +1,21 @@
+module CC
+  module Analyzer
+    class Validation
+      def initialize(object)
+        @object = object
+      end
+
+      def valid?
+        raise NotImplementedError
+      end
+
+      def message
+        raise NotImplementedError
+      end
+
+      private
+
+      attr_reader :object
+    end
+  end
+end

data/lib/cc/cli/command.rb

@@ -13,7 +13,7 @@ module CC
       end
 
       def run
-        $stderr.puts "unknown command #{self.class.name.split('::').last.underscore}"
+        $stderr.puts "unknown command #{self.class.name.split("::").last.underscore}"
       end
 
       def self.command_name
@@ -59,7 +59,7 @@ module CC
 
       def filesystem
         @filesystem ||= CC::Analyzer::Filesystem.new(
-          CC::Analyzer::MountedPath.code.container_path
+          CC::Analyzer::MountedPath.code.container_path,
         )
       end
 

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

@@ -5,7 +5,7 @@ module CC
         def run
           say "Available engines:"
           engine_registry_list.sort_by { |name, _| name }.each do |name, attributes|
-            say "- #{name}: #{attributes['description']}"
+            say "- #{name}: #{attributes["description"]}"
           end
         end
       end

data/lib/cc/cli/help.rb

@@ -16,11 +16,11 @@ module CC
         [
           "analyze [-f format] [-e engine] <path>",
           "console",
-          "engines:disable #{underline('engine_name')}",
-          "engines:enable #{underline('engine_name')}",
+          "engines:disable #{underline("engine_name")}",
+          "engines:enable #{underline("engine_name")}",
           "engines:install",
           "engines:list",
-          "engines:remove #{underline('engine_name')}",
+          "engines:remove #{underline("engine_name")}",
           "help",
           "init",
           "validate-config",

data/lib/cc/cli/runner.rb

@@ -39,7 +39,7 @@ module CC
       def command_name
         case command
         when nil, "-h", "-?", "--help" then "Help"
-        when "-v", "--version"         then "Version"
+        when "-v", "--version" then "Version"
         else command.sub(":", "::").underscore.camelize
         end
       end

data/lib/cc/cli/test.rb

@@ -72,7 +72,7 @@ module CC
         @engine_name = @args.first
 
         if @engine_name.blank?
-          fatal "Usage: codeclimate test #{rainbow.wrap('engine_name').underline}"
+          fatal "Usage: codeclimate test #{rainbow.wrap("engine_name").underline}"
         end
 
         test_engine

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate
 version: !ruby/object:Gem::Version
-  version: 0.24.3
+  version: 0.25.0
 platform: ruby
 authors:
 - Code Climate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-10 00:00:00.000000000 Z
+date: 2016-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -168,13 +168,22 @@ files:
 - lib/cc/analyzer/formatters/plain_text_formatter.rb
 - lib/cc/analyzer/formatters/spinner.rb
 - lib/cc/analyzer/issue.rb
+- lib/cc/analyzer/issue_category_validation.rb
+- lib/cc/analyzer/issue_check_name_presence_validation.rb
+- lib/cc/analyzer/issue_description_presence_validation.rb
+- lib/cc/analyzer/issue_path_existence_validation.rb
+- lib/cc/analyzer/issue_path_presence_validation.rb
+- lib/cc/analyzer/issue_relative_path_validation.rb
 - lib/cc/analyzer/issue_sorter.rb
+- lib/cc/analyzer/issue_type_validation.rb
+- lib/cc/analyzer/issue_validator.rb
 - lib/cc/analyzer/location_description.rb
 - lib/cc/analyzer/logging_container_listener.rb
 - lib/cc/analyzer/mounted_path.rb
 - lib/cc/analyzer/raising_container_listener.rb
 - lib/cc/analyzer/source_buffer.rb
 - lib/cc/analyzer/statsd_container_listener.rb
+- lib/cc/analyzer/validation.rb
 - lib/cc/cli.rb
 - lib/cc/cli/analyze.rb
 - lib/cc/cli/command.rb