codeclimate 0.34.1 → 0.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 09bdad891652bd89f270e26df216f02a54b90282
-  data.tar.gz: ae6ffeb5a2f68a94feaddba40717d7adf3f3d769
+  metadata.gz: 1fc6f49738750affec64ab80ccf8307efec1b9d2
+  data.tar.gz: f1f7e789e916727190cc0059761f50640a2b955f
 SHA512:
-  metadata.gz: c8687f50572834f310debab0e055edffdfacebe3878b8a7ed513ce0dacd9c8c29c0adac4bb0b51722419913badecc207b43a5e97c4250ae90d9ca33a83b7559e
-  data.tar.gz: d4796bb93590cab63a6d816a26120dc0dd575b690bb9a89419c7a354858180fa58c366cb10352516dec3c9699231c55184c824606fafcc4292f33eb67357765f
+  metadata.gz: 56e5a24c670d7ea80026c73e21ebc7afb4518760a3951bb3256b5eeb3265ced74d24f0323421849d26640355bbf8ad7859dca1fc936f6ea2caf7140aba0a96ca
+  data.tar.gz: cce1f4745d9b8a85e556ba66cdefef80c1fca52abcb735c61b194866359de988e77276c63a9cb544fd7fc000e191f97c82597a53836ec6229f9cff37e41241bd

data/lib/cc/analyzer.rb

@@ -15,17 +15,8 @@ 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 :IssueLocationFormatValidation, "cc/analyzer/issue_location_format_validation"
-    autoload :IssueOtherLocationsFormatValidation, "cc/analyzer/issue_other_locations_format_validation"
-    autoload :IssuePathExistenceValidation, "cc/analyzer/issue_path_existence_validation"
-    autoload :IssuePathIsFileValidation, "cc/analyzer/issue_path_is_file_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 :IssueValidations, "cc/analyzer/issue_validations"
     autoload :IssueValidator, "cc/analyzer/issue_validator"
     autoload :LocationDescription, "cc/analyzer/location_description"
     autoload :LoggingContainerListener, "cc/analyzer/logging_container_listener"
@@ -35,7 +26,6 @@ module CC
     autoload :SourceExtractor, "cc/analyzer/source_extractor"
     autoload :SourceFingerprint, "cc/analyzer/source_fingerprint"
     autoload :StatsdContainerListener, "cc/analyzer/statsd_container_listener"
-    autoload :Validation, "cc/analyzer/validation"
 
     class DummyStatsd
       def method_missing(*)

data/lib/cc/analyzer/issue_validations.rb

@@ -0,0 +1,24 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      autoload :CategoryValidation, "cc/analyzer/issue_validations/category_validation"
+      autoload :CheckNamePresenceValidation, "cc/analyzer/issue_validations/check_name_presence_validation"
+      autoload :ContentValidation, "cc/analyzer/issue_validations/content_validation"
+      autoload :DescriptionPresenceValidation, "cc/analyzer/issue_validations/description_presence_validation"
+      autoload :LocationFormatValidation, "cc/analyzer/issue_validations/location_format_validation"
+      autoload :OtherLocationsFormatValidation, "cc/analyzer/issue_validations/other_locations_format_validation"
+      autoload :PathExistenceValidation, "cc/analyzer/issue_validations/path_existence_validation"
+      autoload :PathIsFileValidation, "cc/analyzer/issue_validations/path_is_file_validation"
+      autoload :PathPresenceValidation, "cc/analyzer/issue_validations/path_presence_validation"
+      autoload :RelativePathValidation, "cc/analyzer/issue_validations/relative_path_validation"
+      autoload :TypeValidation, "cc/analyzer/issue_validations/type_validation"
+      autoload :Validation, "cc/analyzer/issue_validations/validation"
+
+      def self.validations
+        constants.sort.map(&method(:const_get)).select do |klass|
+          klass.is_a?(Class) && klass.superclass == Validation
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/category_validation.rb

@@ -0,0 +1,32 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class CategoryValidation < 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
+end

data/lib/cc/analyzer/issue_validations/check_name_presence_validation.rb

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

data/lib/cc/analyzer/issue_validations/content_validation.rb

@@ -0,0 +1,25 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class ContentValidation < Validation
+        def valid?
+          !has_content? || (content.is_a?(Hash) && content["body"].is_a?(String))
+        end
+
+        def message
+          "Content must be a hash containing a 'body' key with string contents"
+        end
+
+        private
+
+        def has_content?
+          object.key?("content")
+        end
+
+        def content
+          object["content"]
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/description_presence_validation.rb

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

data/lib/cc/analyzer/issue_validations/location_format_validation.rb

@@ -0,0 +1,45 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class LocationFormatValidation < Validation
+        def valid?
+          if location["lines"]
+            valid_lines?(location["lines"])
+          elsif location["positions"]
+            valid_positions?(location["positions"])
+          else
+            false
+          end
+        end
+
+        def message
+          "Location is not formatted correctly"
+        end
+
+        private
+
+        def location
+          @location ||= object.fetch("location", {})
+        end
+
+        def valid_positions?(positions)
+          positions.is_a?(Hash) &&
+            valid_position?(positions["begin"]) &&
+            valid_position?(positions["end"])
+        end
+
+        def valid_position?(position)
+          position &&
+            (
+              [position["line"], position["column"]].all? { |value| value.is_a?(Integer) } ||
+              position["offset"].is_a?(Integer)
+            )
+        end
+
+        def valid_lines?(lines)
+          lines.is_a?(Hash) && [lines["begin"], lines["end"]].all? { |value| value.is_a?(Integer) }
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/other_locations_format_validation.rb

@@ -0,0 +1,35 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class OtherLocationsFormatValidation < Validation
+        CHECKS = [
+          LocationFormatValidation,
+          PathExistenceValidation,
+          PathPresenceValidation,
+          RelativePathValidation,
+        ].freeze
+
+        def valid?
+          if object["other_locations"]
+            object["other_locations"].is_a?(Array) &&
+              object["other_locations"].all?(&method(:other_location_valid?))
+          else
+            true
+          end
+        end
+
+        def message
+          "Other locations are not formatted correctly"
+        end
+
+        private
+
+        def other_location_valid?(location)
+          CHECKS.all? do |klass|
+            klass.new("location" => location).valid?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/path_existence_validation.rb

@@ -0,0 +1,21 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class PathExistenceValidation < 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
+end

data/lib/cc/analyzer/issue_validations/path_is_file_validation.rb

@@ -0,0 +1,21 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class PathIsFileValidation < Validation
+        def valid?
+          File.file?(path)
+        end
+
+        def message
+          "Path is not a file: '#{path}'"
+        end
+
+        private
+
+        def path
+          object.fetch("location", {}).fetch("path", "")
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/path_presence_validation.rb

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

data/lib/cc/analyzer/issue_validations/relative_path_validation.rb

@@ -0,0 +1,32 @@
+require "pathname"
+
+module CC
+  module Analyzer
+    module IssueValidations
+      class RelativePathValidation < Validation
+        def valid?
+          path &&
+            !path.start_with?("/") &&
+            relative_to?(MountedPath.code.container_path)
+        end
+
+        def message
+          "Path must be relative to the project directory"
+        end
+
+        private
+
+        def relative_to?(directory)
+          expanded_base = Pathname.new(directory).expand_path.to_s
+          expanded_path = Pathname.new(path).expand_path.to_s
+
+          expanded_path.start_with?(expanded_base)
+        end
+
+        def path
+          object.fetch("location", {})["path"]
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/issue_validations/type_validation.rb

@@ -0,0 +1,21 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      class TypeValidation < 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
+end

data/lib/cc/analyzer/issue_validations/validation.rb

@@ -0,0 +1,23 @@
+module CC
+  module Analyzer
+    module IssueValidations
+      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
+end

data/lib/cc/analyzer/issue_validator.rb

@@ -1,18 +1,7 @@
 module CC
   module Analyzer
     class IssueValidator
-      CHECKS = [
-        IssueCategoryValidation,
-        IssueCheckNamePresenceValidation,
-        IssueDescriptionPresenceValidation,
-        IssueLocationFormatValidation,
-        IssueOtherLocationsFormatValidation,
-        IssuePathExistenceValidation,
-        IssuePathIsFileValidation,
-        IssuePathPresenceValidation,
-        IssueRelativePathValidation,
-        IssueTypeValidation,
-      ].freeze
+      CHECKS = IssueValidations.validations.freeze
 
       attr_reader :error
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate
 version: !ruby/object:Gem::Version
-  version: 0.34.1
+  version: 0.35.0
 platform: ruby
 authors:
 - Code Climate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-16 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -183,17 +183,20 @@ 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_location_format_validation.rb
-- lib/cc/analyzer/issue_other_locations_format_validation.rb
-- lib/cc/analyzer/issue_path_existence_validation.rb
-- lib/cc/analyzer/issue_path_is_file_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_validations.rb
+- lib/cc/analyzer/issue_validations/category_validation.rb
+- lib/cc/analyzer/issue_validations/check_name_presence_validation.rb
+- lib/cc/analyzer/issue_validations/content_validation.rb
+- lib/cc/analyzer/issue_validations/description_presence_validation.rb
+- lib/cc/analyzer/issue_validations/location_format_validation.rb
+- lib/cc/analyzer/issue_validations/other_locations_format_validation.rb
+- lib/cc/analyzer/issue_validations/path_existence_validation.rb
+- lib/cc/analyzer/issue_validations/path_is_file_validation.rb
+- lib/cc/analyzer/issue_validations/path_presence_validation.rb
+- lib/cc/analyzer/issue_validations/relative_path_validation.rb
+- lib/cc/analyzer/issue_validations/type_validation.rb
+- lib/cc/analyzer/issue_validations/validation.rb
 - lib/cc/analyzer/issue_validator.rb
 - lib/cc/analyzer/location_description.rb
 - lib/cc/analyzer/logging_container_listener.rb
@@ -203,7 +206,6 @@ files:
 - lib/cc/analyzer/source_extractor.rb
 - lib/cc/analyzer/source_fingerprint.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

data/lib/cc/analyzer/issue_category_validation.rb

@@ -1,30 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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_location_format_validation.rb

@@ -1,43 +0,0 @@
-module CC
-  module Analyzer
-    class IssueLocationFormatValidation < Validation
-      def valid?
-        if location["lines"]
-          valid_lines?(location["lines"])
-        elsif location["positions"]
-          valid_positions?(location["positions"])
-        else
-          false
-        end
-      end
-
-      def message
-        "Location is not formatted correctly"
-      end
-
-      private
-
-      def location
-        @location ||= object.fetch("location", {})
-      end
-
-      def valid_positions?(positions)
-        positions.is_a?(Hash) &&
-          valid_position?(positions["begin"]) &&
-          valid_position?(positions["end"])
-      end
-
-      def valid_position?(position)
-        position &&
-          (
-            [position["line"], position["column"]].all? { |value| value.is_a?(Integer) } ||
-            position["offset"].is_a?(Integer)
-          )
-      end
-
-      def valid_lines?(lines)
-        lines.is_a?(Hash) && [lines["begin"], lines["end"]].all? { |value| value.is_a?(Integer) }
-      end
-    end
-  end
-end

data/lib/cc/analyzer/issue_other_locations_format_validation.rb

@@ -1,33 +0,0 @@
-module CC
-  module Analyzer
-    class IssueOtherLocationsFormatValidation < Validation
-      CHECKS = [
-        IssueLocationFormatValidation,
-        IssuePathExistenceValidation,
-        IssuePathPresenceValidation,
-        IssueRelativePathValidation,
-      ].freeze
-
-      def valid?
-        if object["other_locations"]
-          object["other_locations"].is_a?(Array) &&
-            object["other_locations"].all?(&method(:other_location_valid?))
-        else
-          true
-        end
-      end
-
-      def message
-        "Other locations are not formatted correctly"
-      end
-
-      private
-
-      def other_location_valid?(location)
-        CHECKS.all? do |klass|
-          klass.new("location" => location).valid?
-        end
-      end
-    end
-  end
-end

data/lib/cc/analyzer/issue_path_existence_validation.rb

@@ -1,19 +0,0 @@
-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_is_file_validation.rb

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

data/lib/cc/analyzer/issue_path_presence_validation.rb

@@ -1,19 +0,0 @@
-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

@@ -1,30 +0,0 @@
-require "pathname"
-
-module CC
-  module Analyzer
-    class IssueRelativePathValidation < Validation
-      def valid?
-        path &&
-          !path.start_with?("/") &&
-          relative_to?(MountedPath.code.container_path)
-      end
-
-      def message
-        "Path must be relative to the project directory"
-      end
-
-      private
-
-      def relative_to?(directory)
-        expanded_base = Pathname.new(directory).expand_path.to_s
-        expanded_path = Pathname.new(path).expand_path.to_s
-
-        expanded_path.start_with?(expanded_base)
-      end
-
-      def path
-        object.fetch("location", {})["path"]
-      end
-    end
-  end
-end

data/lib/cc/analyzer/issue_type_validation.rb

@@ -1,19 +0,0 @@
-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/validation.rb

@@ -1,21 +0,0 @@
-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