codeclimate 0.14.2 → 0.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72cddaaaf2d406b672e5dcf23810a2c3c12d5bf1
-  data.tar.gz: 8d59b60cd8907a9ac2f797c355aaf74cc8c28e1e
+  metadata.gz: 10bc38c06b10a955c8f01ebb2275e7940b8c79c4
+  data.tar.gz: ed11b6c4343ab1a54a70b63d08b474700735d905
 SHA512:
-  metadata.gz: dcae9739365b050502e5dbeded10610040236b0f9c8ca84b5a5559955f28c34101be489363874bd469748ec61218365f8cfd4fa0b89e6f67dfba122ae72b6609
-  data.tar.gz: ffa9d0a75f6fdd2e615e5c1dc02b156c03f35e3f723d40845b9063f4016dbc4d09435fb0c43603cbeaf7cd9905378106bca83fb28409e0b630d8204a0c45ebb0
+  metadata.gz: 626e8011b55617172497200db09a1bf25401ad70805d17fe850d1ff1a67ab223cb294ea6a80fa46dc2502bc68ef91cb8d04fa547899a1b4c1ba408e64e507ebe
+  data.tar.gz: 0a99283ef527994d1ba32e29d84331549afd06c38cc3f580c6f0c8650c640b73b5a3c95e2c27689763b5a1e99e2b07a88d603271a9e24bb832fbba0dd8000fbe

data/config/engines.yml

@@ -18,8 +18,12 @@ brakeman:
   enable_regexps:
     - ^script\/rails$
   default_ratings_paths:
-    - "app/**"
+    - "Gemfile.lock"
+    - "**.erb"
+    - "**.haml"
     - "**.rb"
+    - "**.rhtml"
+    - "**.slim"
 bundler-audit:
   image: codeclimate/codeclimate-bundler-audit
   description: Patch-level verification for Bundler.

data/config/eslint/.eslintrc

@@ -245,3 +245,9 @@ rules:
   yoda:
   - 0
   - never
+env:
+  browser: true
+  node: true
+  jquery: true
+  amd: true
+  commonjs: true

data/lib/cc/analyzer.rb

@@ -16,6 +16,7 @@ module CC
     autoload :LocationDescription, "cc/analyzer/location_description"
     autoload :LoggingContainerListener, "cc/analyzer/logging_container_listener"
     autoload :PathPatterns, "cc/analyzer/path_patterns"
+    autoload :PathMinimizer, "cc/analyzer/path_minimizer"
     autoload :RaisingContainerListener, "cc/analyzer/raising_container_listener"
     autoload :SourceBuffer, "cc/analyzer/source_buffer"
     autoload :StatsdContainerListener, "cc/analyzer/statsd_container_listener"

data/lib/cc/analyzer/container.rb

@@ -60,6 +60,7 @@ module CC
           duration = timeout
           @listener.timed_out(container_data(duration: duration))
         else
+          sleep 0.01 until !t_out.alive? && !t_err.alive?
           duration = ((Time.now - started) * 1000).round
           @listener.finished(container_data(duration: duration, status: status))
         end

data/lib/cc/analyzer/engine_output_filter.rb

@@ -30,9 +30,21 @@ module CC
       end
 
       def ignore_issue?(json)
+        check_disabled?(json) || ignore_fingerprint?(json)
+      end
+
+      def check_disabled?(json)
         !check_config(json["check_name"]).fetch("enabled", true)
       end
 
+      def ignore_fingerprint?(json)
+        if (fingerprint = json["fingerprint"])
+          @config.fetch("exclude_fingerprints", []).include?(fingerprint)
+        else
+          false
+        end
+      end
+
       def check_config(check_name)
         @checks ||= @config.fetch("checks", {})
         @checks.fetch(check_name, {})

data/lib/cc/analyzer/engines_config_builder.rb

@@ -29,6 +29,8 @@ module CC
 
       private
 
+      attr_reader :include_paths
+
       def engine_config(raw_engine_config)
         config = raw_engine_config.merge(
           exclude_paths: exclude_paths,
@@ -55,9 +57,7 @@ module CC
       end
 
       def include_paths
-        IncludePathsBuilder.new(
-          @config.exclude_paths || [], @requested_paths
-        ).build
+        IncludePathsBuilder.new(exclude_paths, Array(@requested_paths)).build
       end
 
       def exclude_paths

data/lib/cc/analyzer/engines_runner.rb

@@ -47,7 +47,7 @@ module CC
           config: @config,
           container_label: @container_label,
           source_dir: @source_dir,
-          requested_paths: @requested_paths,
+          requested_paths: requested_paths,
         ).run
       end
 

data/lib/cc/analyzer/include_paths_builder.rb

@@ -1,13 +1,11 @@
 require "file_utils_ext"
+require "cc/analyzer/path_minimizer"
+require "cc/analyzer/path_filter"
 
 module CC
   module Analyzer
     class IncludePathsBuilder
-      def self.relevant_entries(path)
-        Dir.entries(path).reject do |e|
-          %w(. .. .git).include?(e) || File.symlink?(File.join(path, e))
-        end
-      end
+      IGNORE_PATHS = [".", "..", ".git"].freeze
 
       attr_reader :cc_include_paths
 
@@ -17,152 +15,47 @@ module CC
       end
 
       def build
-        if cc_include_paths.any?
-          paths = filter_by_cc_includes
-        else
-          root = Directory.new(".", ignored_files)
-          paths = root.included_paths
-        end
-
-        paths.each do |path|
-          raise_on_unreadable_files(path)
-        end
+        PathMinimizer.new(paths_filter.paths).minimize.uniq
       end
 
-      protected
+      private
+
+      def paths_filter
+        @_paths =
+          PathFilter.new(include_paths).
+          reject_paths(ignored_files).
+          raise_if_any_unreadable_files.
+          reject_unreadable_paths.
+          select_readable_files.
+          reject_symlinks
+      end
 
-      def filter_by_cc_includes
-        paths = []
-        cc_include_paths.each do |path|
-          if File.directory?(path)
-            root = Directory.new(path, ignored_files)
-            paths += root.included_paths
-          elsif !ignored_files.include?(path)
-            paths << path
+      def include_paths
+        if @cc_include_paths.empty?
+          all_paths
+        else
+          @cc_include_paths.flat_map do |path|
+            PathEntries.new(path).entries
           end
         end
-        paths.uniq
+      end
+
+      def all_paths
+        Dir.glob("*", File::FNM_DOTMATCH).
+          reject { |path| IncludePathsBuilder::IGNORE_PATHS.include?(path) }.
+          flat_map { |path| PathEntries.new(path).entries }
       end
 
       def ignored_files
+        return @_ignored_files if @_ignored_files
+
         Tempfile.open(".cc_gitignore") do |tmp|
           tmp.write(File.read(".gitignore")) if File.file?(".gitignore")
           tmp << @cc_exclude_paths.join("\n")
           tmp.close
           tracked_and_ignored = `git ls-files -zi -X #{tmp.path} 2>/dev/null`.split("\0")
           untracked_and_ignored = `git ls-files -zio -X #{tmp.path} 2>/dev/null`.split("\0")
-          tracked_and_ignored + untracked_and_ignored
-        end
-      end
-
-      def raise_on_unreadable_files(path)
-        if File.directory?(path)
-          raise_on_unreadable_files_in_directory(path)
-        elsif !FileUtils.readable_by_all?(path)
-          raise CC::Analyzer::UnreadableFileError, "Can't read #{path}"
-        end
-      end
-
-      def raise_on_unreadable_files_in_directory(path)
-        IncludePathsBuilder.relevant_entries(path).each do |entry|
-          sub_path = File.join(path, entry)
-          raise_on_unreadable_files(sub_path)
-        end
-      end
-
-      class Directory
-        def initialize(path, excluded_files)
-          @path = path
-          @excluded_files = ensure_hashified(excluded_files)
-        end
-
-        def all_included?
-          readable_by_all? &&
-            files_all_included? &&
-            subdirectories_all_included?
-        end
-
-        def included_paths
-          if all_included?
-            [@path + "/"]
-          elsif readable_by_all?
-            result = []
-            result += included_file_entries
-            result += included_subdirectory_results
-            result
-          else
-            []
-          end
-        end
-
-        protected
-
-        def ensure_hashified(obj)
-          if obj.is_a?(Array)
-            obj.each_with_object({}) do |included, result|
-              result[included] = true
-            end
-          else
-            obj
-          end
-        end
-
-        def files_all_included?
-          file_entries.none? { |e| @excluded_files[e] }
-        end
-
-        def file_entries
-          @file_entries ||= relevant_full_entries.reject do |e|
-            File.directory?(e)
-          end
-        end
-
-        def full_entry(entry)
-          if @path == "."
-            entry
-          else
-            File.join(@path, entry)
-          end
-        end
-
-        def included_file_entries
-          file_entries.reject { |file_entry| @excluded_files[file_entry] }
-        end
-
-        def included_subdirectory_results
-          subdirectories.each_with_object([]) do |subdirectory, result|
-            result.concat(subdirectory.included_paths)
-          end
-        end
-
-        def readable_by_all?
-          FileUtils.readable_by_all?(@path)
-        end
-
-        def relevant_full_entries
-          unless @relevant_full_entries
-            raw_entries = IncludePathsBuilder.relevant_entries(@path)
-            @relevant_full_entries = raw_entries.map do |e|
-              full_entry(e)
-            end
-          end
-          @relevant_full_entries
-        end
-
-        def subdirectories
-          unless @subdirectories
-            entries = relevant_full_entries.select do |e|
-              File.directory?(e)
-            end
-            @subdirectories = entries.map do |e|
-              Directory.new(e, @excluded_files)
-            end
-          end
-          @subdirectories
-        end
-
-        def subdirectories_all_included?
-          subdirectories.all?(&:all_included?)
+          @_ignored_files = tracked_and_ignored + untracked_and_ignored
         end
       end
     end

data/lib/cc/analyzer/issue_sorter.rb

@@ -16,13 +16,13 @@ module CC
 
         case
         when location["lines"]
-          location["lines"]["begin"].to_i
+          [location["lines"]["begin"].to_i]
         when location["positions"] && location["positions"]["begin"]["line"]
-          location["positions"]["begin"]["line"].to_i + location["positions"]["begin"]["column"].to_i
+          [location["positions"]["begin"]["line"].to_i, location["positions"]["begin"]["column"].to_i]
         when location["positions"] && location["positions"]["begin"]["offset"]
-          location["positions"]["begin"]["offset"].to_i + 1_000_000_000 # push offsets to end of list
+          [1_000_000_000] # push offsets to end of list
         else
-          0 # whole-file issues are first
+          [0] # whole-file issues are first
         end
       end
     end

data/lib/cc/analyzer/path_entries.rb

@@ -0,0 +1,27 @@
+module CC
+  module Analyzer
+    class PathEntries
+      def initialize(initial_path)
+        @initial_path = initial_path.gsub(%r{/$}, "")
+      end
+
+      def entries
+        if File.directory?(initial_path)
+          all_entries.reject do |path|
+            path.end_with?("/.") || path.start_with?(".git/")
+          end
+        else
+          initial_path
+        end
+      end
+
+      private
+
+      attr_reader :initial_path
+
+      def all_entries
+        Dir.glob("#{initial_path}/**/*", File::FNM_DOTMATCH).push(initial_path)
+      end
+    end
+  end
+end

data/lib/cc/analyzer/path_filter.rb

@@ -0,0 +1,60 @@
+module CC
+  module Analyzer
+    class PathFilter
+      attr_reader :paths
+
+      def initialize(paths)
+        @paths = paths
+      end
+
+      def raise_if_any_unreadable_files
+        paths.each do |path|
+          if !File.directory?(path) && !FileUtils.readable_by_all?(path)
+            raise CC::Analyzer::UnreadableFileError, "Can't read #{path}"
+          end
+        end
+
+        self
+      end
+
+      def reject_unreadable_paths
+        @paths = paths - unreadable_path_entries
+        self
+      end
+
+      def reject_paths(ignore_paths)
+        @paths = paths - ignore_paths
+        self
+      end
+
+      def select_readable_files
+        @paths = paths.select { |path| FileUtils.readable_by_all?(path) }
+        self
+      end
+
+      def reject_symlinks
+        @paths = paths.reject { |path| File.symlink?(path) }
+        self
+      end
+
+      def reject_globs(globs)
+        patterns = PathPatterns.new(globs)
+        @paths = paths.reject { |path| patterns.match?(pathpatterns.match?(path)) }
+        self
+      end
+
+      private
+
+      def unreadable_path_entries
+        @_unreadable_path_entries ||=
+          unreadable_paths.flat_map { |path| PathEntries.new(path).entries }
+      end
+
+      def unreadable_paths
+        paths.select do |path|
+          File.directory?(path) && !FileUtils.readable_by_all?(path)
+        end
+      end
+    end
+  end
+end

data/lib/cc/analyzer/path_minimizer.rb

@@ -0,0 +1,84 @@
+require "cc/analyzer/path_entries"
+require "cc/analyzer/include_paths_builder"
+
+module CC
+  module Analyzer
+    class PathMinimizer
+      def initialize(paths)
+        @paths = paths
+        @to_remove = []
+      end
+
+      def minimize
+        if diff.empty?
+          ["./"]
+        else
+          filtered_paths
+        end
+      end
+
+      private
+
+      attr_reader :paths
+
+      def diff
+        @_diff ||=
+          (all_files - paths).
+          reject { |path| File.symlink?(path) }.
+          flat_map { |path| build_entry_combinations(path) }
+      end
+
+      def filtered_paths
+        filtered_paths = @paths - paths_to_remove
+        filtered_paths.map { |path| add_trailing_slash(path) }
+      end
+
+      def paths_to_remove
+        @paths.reduce([]) do |to_remove, path|
+          if File.directory?(path)
+            to_remove + removable_paths_for(path)
+          else
+            to_remove
+          end
+        end
+      end
+
+      def removable_paths_for(path)
+        file_paths = PathEntries.new(path).entries
+
+        if all_paths_match?(file_paths)
+          file_paths - [path]
+        else
+          [path]
+        end
+      end
+
+      def all_paths_match?(paths)
+        paths.all? { |path| @paths.include?(path) }
+      end
+
+      def add_trailing_slash(path)
+        if File.directory?(path) && !path.end_with?("/")
+          "#{path}/"
+        else
+          path
+        end
+      end
+
+      def build_entry_combinations(path)
+        split = path.split("/")
+
+        0.upto(split.length - 1).map do |n|
+          split[0..n].join("/")
+        end
+      end
+
+      def all_files
+        @_all_files ||=
+          Dir.glob("*", File::FNM_DOTMATCH).
+          reject { |path| IncludePathsBuilder::IGNORE_PATHS.include?(path) }.
+          flat_map { |path| PathEntries.new(path).entries }
+      end
+    end
+  end
+end

data/lib/cc/analyzer/path_patterns.rb

@@ -6,6 +6,10 @@ module CC
         @root = root
       end
 
+      def match?(path)
+        expanded.include?(path)
+      end
+
       def expanded
         @expanded ||= expand
       end
@@ -15,25 +19,28 @@ module CC
       def expand
         results = Dir.chdir(@root) do
           @patterns.flat_map do |pattern|
-            # FIXME: there exists a temporary workaround whereby **-style globs
-            # are translated to **/*-style globs within cc-yaml's custom
-            # Glob#value method. It was thought that that would work correctly
-            # with Dir.glob but it turns out we have to actually invoke #value
-            # directory for this to work. We need to guard this on class (not
-            # respond_to?) because our mocking framework adds a #value method to
-            # all objects, apparently.
-            if pattern.is_a?(CC::Yaml::Nodes::Glob)
-              value = pattern.value
-            else
-              value = pattern
-            end
-
+            value = glob_value(pattern)
             Dir.glob(value)
           end
         end
 
         results.sort.uniq
       end
+
+      def glob_value(pattern)
+        # FIXME: there exists a temporary workaround whereby **-style globs
+        # are translated to **/*-style globs within cc-yaml's custom
+        # Glob#value method. It was thought that that would work correctly
+        # with Dir.glob but it turns out we have to actually invoke #value
+        # directrly for this to work. We need to guard this on class (not
+        # respond_to?) because our mocking framework adds a #value method to
+        # all objects, apparently.
+        if pattern.is_a?(CC::Yaml::Nodes::Glob)
+          pattern.value
+        else
+          pattern
+        end
+      end
     end
   end
 end

data/lib/cc/cli/command.rb

@@ -24,6 +24,10 @@ module CC
         run
       end
 
+      def success(message)
+        terminal.say colorize(message, :green)
+      end
+
       def say(message)
         terminal.say message
       end

data/lib/cc/cli/help.rb

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

data/lib/cc/cli/init.rb

@@ -9,7 +9,8 @@ module CC
 
       def run
         if !upgrade? && filesystem.exist?(CODECLIMATE_YAML)
-          fatal "Config file .codeclimate.yml already present.\nTry running 'validate-config' to check configuration."
+          warn "Config file .codeclimate.yml already present.\nTry running 'validate-config' to check configuration."
+          create_default_configs
         elsif upgrade? && engines_enabled?
           fatal "--upgrade should not be used on a .codeclimate.yml configured for the Platform.\nTry running 'validate-config' to check configuration."
         else
@@ -32,7 +33,7 @@ module CC
         end
 
         create_codeclimate_yaml
-        say "Config file .codeclimate.yml successfully #{config_generator.post_generation_verb}.\nEdit and then try running 'validate-config' to check configuration."
+        success "Config file .codeclimate.yml successfully #{config_generator.post_generation_verb}.\nEdit and then try running 'validate-config' to check configuration."
         create_default_configs
       end
 
@@ -54,7 +55,7 @@ module CC
             say "Skipping generating #{file_name} file (already exists)."
           else
             filesystem.write_path(file_name, File.read(config_path))
-            say "Config file #{file_name} successfully generated."
+            success "Config file #{file_name} successfully generated."
           end
         end
       end

data/lib/cc/cli/test.rb

@@ -163,7 +163,7 @@ module CC
       def validate_unexpected_issues(actual_issues)
         if actual_issues.any?
           say colorize("Actuals not empty after matching.", :red)
-          say
+          say "\n"
           say colorize("#{actual_issues.size} remaining:", :yellow)
           say colorize(JSON.pretty_generate(actual_issues), :yellow)
           fatal "Unexpected issue found."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate
 version: !ruby/object:Gem::Version
-  version: 0.14.2
+  version: 0.14.3
 platform: ruby
 authors:
 - Code Climate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-10 00:00:00.000000000 Z
+date: 2015-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -218,6 +218,9 @@ files:
 - lib/cc/analyzer/issue_sorter.rb
 - lib/cc/analyzer/location_description.rb
 - lib/cc/analyzer/logging_container_listener.rb
+- lib/cc/analyzer/path_entries.rb
+- lib/cc/analyzer/path_filter.rb
+- lib/cc/analyzer/path_minimizer.rb
 - lib/cc/analyzer/path_patterns.rb
 - lib/cc/analyzer/raising_container_listener.rb
 - lib/cc/analyzer/source_buffer.rb