codeclimate 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c3efb6cbbf82988bd5889f5205532c2f04d3059
-  data.tar.gz: e86fa7a9230c80c97701b61887b39754c028c5dc
+  metadata.gz: 4205b1614e474d25d9204cd7e22fdcb8752592c5
+  data.tar.gz: c23dcf718de6df7c4957c5b86fb824545fda2db2
 SHA512:
-  metadata.gz: 5a906af804ecd6d8c676bba731c0a424baa562ee32b37ddc21d16807a409ff37366b9e8e99b176cda66ac9c7f36fdf95976e96cdfe1bd64a1b1dcd18121b0fcc
-  data.tar.gz: 34d2b20fe51337abcbe87976e130e162ce829f0c33ff515c538e2751ccea72bbaa19f779834080c6edc5454f04c09942dedbfc84a93d21de2fd09fa3fa6d9e45
+  metadata.gz: be5215a861e099009c59b4f60450ec4f9db007023ead307c165eceb09a150709975bf4e60c7828bc4e6761a0fa0ed7381440a49db112106e2c0642048b3dec15
+  data.tar.gz: b001996f081fa00473933c00e85c716ffef13baa7d454adc7a89830f0adb479d693cf101feaff91b19be0d5eb7a8f093f253c0bb318a906c7454f4a759e5e644

data/lib/cc/analyzer.rb

@@ -10,6 +10,7 @@ module CC
     autoload :EnginesRunner, "cc/analyzer/engines_runner"
     autoload :Filesystem, "cc/analyzer/filesystem"
     autoload :Formatters, "cc/analyzer/formatters"
+    autoload :IncludePathsBuilder, "cc/analyzer/include_paths_builder"
     autoload :IssueSorter, "cc/analyzer/issue_sorter"
     autoload :LocationDescription, "cc/analyzer/location_description"
     autoload :LoggingContainerListener, "cc/analyzer/logging_container_listener"
@@ -33,5 +34,7 @@ module CC
     cattr_accessor :statsd, :logger
     self.statsd = DummyStatsd.new
     self.logger = DummyLogger.new
+
+    UnreadableFileError = Class.new(StandardError)
   end
 end

data/lib/cc/analyzer/engines_runner.rb

@@ -43,7 +43,10 @@ module CC
       end
 
       def engine_config(config)
-        config = config.merge(exclude_paths: exclude_paths)
+        config = config.merge(
+          exclude_paths: exclude_paths,
+          include_paths: include_paths
+        )
 
         # The yaml gem turns a config file string into a hash, but engines expect the string
         # So we (for now) need to turn it into a string in that one scenario.
@@ -73,6 +76,10 @@ module CC
         PathPatterns.new(@config.exclude_paths || []).expanded + gitignore_paths
       end
 
+      def include_paths
+        IncludePathsBuilder.new(@config.exclude_paths || []).build
+      end
+
       def gitignore_paths
         if File.exist?(".gitignore")
           `git ls-files --others -i -z --exclude-from .gitignore`.split("\0")

data/lib/cc/analyzer/include_paths_builder.rb

@@ -0,0 +1,147 @@
+module CC
+  module Analyzer
+    class IncludePathsBuilder
+      def self.relevant_entries(path)
+        Dir.entries(path).reject do |e|
+          %w(. .. .git).include?(e)
+        end
+      end
+
+      def initialize(cc_exclude_paths)
+        @cc_exclude_paths = cc_exclude_paths
+      end
+
+      def build
+        root = Directory.new('.', ignored_files)
+        paths = root.included_paths
+        paths.each do |path|
+          raise_on_unreadable_files(path)
+        end
+      end
+
+      protected
+
+      def ignored_files
+        Tempfile.open(".cc_gitignore") do |tmp|
+          tmp.write(File.read(".gitignore")) if File.exist?(".gitignore")
+          tmp << @cc_exclude_paths.join("\n")
+          tmp.close
+          tracked_and_ignored = `git ls-files -zi -X #{tmp.path}`.split("\0")
+          untracked_and_ignored = `git ls-files -zio -X #{tmp.path}`.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?)
+        end
+      end
+    end
+  end
+end

data/lib/cc/cli.rb

@@ -2,6 +2,7 @@ require "active_support"
 require "active_support/core_ext"
 require "cc/analyzer"
 require "cc/yaml"
+require "file_utils_ext"
 
 module CC
   module CLI

data/lib/file_utils_ext.rb

@@ -0,0 +1,7 @@
+require 'fileutils'
+
+module FileUtils
+  def self.readable_by_all?(path)
+    (File.stat(path).mode & 004) != 0
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Code Climate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -205,6 +205,7 @@ files:
 - lib/cc/analyzer/formatters/json_formatter.rb
 - lib/cc/analyzer/formatters/plain_text_formatter.rb
 - lib/cc/analyzer/formatters/spinner.rb
+- lib/cc/analyzer/include_paths_builder.rb
 - lib/cc/analyzer/issue_sorter.rb
 - lib/cc/analyzer/location_description.rb
 - lib/cc/analyzer/logging_container_listener.rb
@@ -228,6 +229,7 @@ files:
 - lib/cc/cli/runner.rb
 - lib/cc/cli/validate_config.rb
 - lib/cc/cli/version.rb
+- lib/file_utils_ext.rb
 homepage: https://codeclimate.com
 licenses:
 - MIT
@@ -248,7 +250,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Code Climate CLI