codeclimate 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bfaf5724cae591ae825c0be10218f072c65939e
-  data.tar.gz: 03a588c5411b86d2e796efc4bfa78d08134f6d9d
+  metadata.gz: ed633d34c37b17d582f70edcf4e105f66125b66f
+  data.tar.gz: 196920672b0465ed7ad5b36c073eb6ed26f7721e
 SHA512:
-  metadata.gz: 95ce4e1916df7d699aca2bac7e4a6c30160a7c47fd9003a5b1ca2bbe2e269fc49f3871ad003b6188b7ff085edc7e2131a57feb296eba4ab3f7c7bb39453afea5
-  data.tar.gz: e9a307e4e88493b6429d6785cc4b1573ebb5a9c3341008e501cecc24bf0e5d3bd5c14904c2182dffea99e41901a68d42b4fdac2aafc6ec7d96dbe7242d708a88
+  metadata.gz: ed1f6e059f66b75db9c2ca1ec7a7f68de47344060addd304579a3403bee95410f5b6baac4d6520b9549d34234c9458103e4348cc89d640ec636ed88cfccf022a
+  data.tar.gz: 547ec662b6daac3235675a42b83677f6ba9e716bc05046c32f5ef4d33e9f1ec795a3bb52a8e52759d3672978cfd1f1b72ceb8830844b7a7f91bc82f2a465ccbb

data/lib/cc/analyzer/config.rb

@@ -2,8 +2,8 @@ require "yaml"
 
 module CC
   module Analyzer
+    # TODO: replace each use of this with CC::Yaml and remove it
     class Config
-
       def initialize(config_body)
         @config = YAML.safe_load(config_body) || {"engines"=> {} }
         @config["engines"] ||= {}

data/lib/cc/analyzer/engine.rb

@@ -8,11 +8,11 @@ module CC
 
       TIMEOUT = 15 * 60 # 15m
 
-      def initialize(name, metadata, code_path, config_json, label)
+      def initialize(name, metadata, code_path, config, label)
         @name = name
         @metadata = metadata
         @code_path = code_path
-        @config_json = config_json
+        @config = config
         @label = label.to_s
       end
 
@@ -102,7 +102,7 @@ module CC
 
       def config_file
         path = File.join("/tmp/cc", SecureRandom.uuid)
-        File.write(path, @config_json)
+        File.write(path, @config.to_json)
         path
       end
 
@@ -115,13 +115,7 @@ module CC
       end
 
       def output_filter
-        @output_filter ||= EngineOutputFilter.new(config)
-      end
-
-      def config
-        # N.B. there is no expected scenario where this would fail so a
-        # parser-error rescue has been omitted intentionally
-        JSON.parse(@config_json)
+        @output_filter ||= EngineOutputFilter.new(@config)
       end
 
       CommandFailure = Class.new(StandardError)

data/lib/cc/analyzer/engine_registry.rb

@@ -3,18 +3,29 @@ require "safe_yaml"
 module CC
   module Analyzer
     class EngineRegistry
-      def initialize
+      def initialize(dev_mode = false)
         @path = File.expand_path("../../../../config/engines.yml", __FILE__)
         @config = YAML.safe_load_file(@path)
+        @dev_mode = dev_mode
       end
 
       def [](engine_name)
-        @config[engine_name]
+        if dev_mode?
+          { "image" => "codeclimate/codeclimate-#{engine_name}:latest" }
+        else
+          @config[engine_name]
+        end
       end
 
       def list
         @config
       end
+
+      private
+
+      def dev_mode?
+        @dev_mode
+      end
     end
   end
 end

data/lib/cc/analyzer/engines_runner.rb

@@ -0,0 +1,80 @@
+require "securerandom"
+
+module CC
+  module Analyzer
+    class EnginesRunner
+      InvalidEngineName = Class.new(StandardError)
+      NoEnabledEngines = Class.new(StandardError)
+
+      def initialize(registry, formatter, source_dir, config, container_label = nil)
+        @registry = registry
+        @formatter = formatter
+        @source_dir = source_dir
+        @config = config
+        @container_label = container_label
+      end
+
+      def run
+        raise NoEnabledEngines if engines.empty?
+
+        Analyzer.logger.info("running #{engines.size} engines")
+
+        @formatter.started
+
+        engines.each { |engine| run_engine(engine) }
+
+        @formatter.finished
+      ensure
+        @formatter.close
+      end
+
+      private
+
+      def run_engine(engine)
+        Analyzer.logger.info("starting engine #{engine.name}")
+
+        Analyzer.statsd.time("engines.time") do
+          Analyzer.statsd.time("engines.names.#{engine.name}.time") do
+            @formatter.engine_running(engine) do
+              engine.run(@formatter)
+            end
+          end
+        end
+
+        Analyzer.logger.info("finished engine #{engine.name}")
+      end
+
+      def engines
+        @engines ||= enabled_engines.map do |name, config|
+          metadata = registry_lookup(name)
+          label = @container_label || SecureRandom.uuid
+          engine_config = config.merge!(exclude_paths: exclude_paths)
+
+          Engine.new(name, metadata, @source_dir, engine_config, label)
+        end
+      end
+
+      def enabled_engines
+        {}.tap do |ret|
+          @config.engines.each do |name, config|
+            if config.enabled?
+              ret[name] = config
+            end
+          end
+        end
+      end
+
+      def registry_lookup(engine_name)
+        if (metadata = @registry[engine_name])
+          metadata
+        else
+          raise InvalidEngineName, "unknown engine name: #{engine_name}"
+        end
+      end
+
+      def exclude_paths
+        PathPatterns.new(@config.exclude_paths || []).expanded
+      end
+    end
+  end
+end

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

@@ -22,6 +22,9 @@ module CC
         def finished
         end
 
+        def close
+        end
+
         def failed(output)
         end
 

data/lib/cc/analyzer/path_patterns.rb

@@ -0,0 +1,26 @@
+module CC
+  module Analyzer
+    class PathPatterns
+      def initialize(patterns, root = Dir.pwd)
+        @patterns = patterns
+        @root = root
+      end
+
+      def expanded
+        @expanded ||= expand
+      end
+
+      private
+
+      def expand
+        results = Dir.chdir(@root) do
+          @patterns.flat_map do |pattern|
+            Dir.glob(pattern)
+          end
+        end
+
+        results.sort.uniq
+      end
+    end
+  end
+end

data/lib/cc/analyzer.rb

@@ -5,23 +5,31 @@ module CC
     autoload :Engine,             "cc/analyzer/engine"
     autoload :EngineClient,       "cc/analyzer/engine_client"
     autoload :EngineOutputFilter, "cc/analyzer/engine_output_filter"
-    autoload :EngineProcess,      "cc/analyzer/engine_process"
     autoload :EngineRegistry,     "cc/analyzer/engine_registry"
+    autoload :EnginesRunner,      "cc/analyzer/engines_runner"
     autoload :Filesystem,         "cc/analyzer/filesystem"
     autoload :Formatters,         "cc/analyzer/formatters"
     autoload :IssueSorter,        "cc/analyzer/issue_sorter"
     autoload :LocationDescription,"cc/analyzer/location_description"
     autoload :NullConfig,         "cc/analyzer/null_config"
+    autoload :PathPatterns,       "cc/analyzer/path_patterns"
     autoload :SourceBuffer,       "cc/analyzer/source_buffer"
     autoload :UnitName,           "cc/analyzer/unit_name"
 
     class DummyStatsd
-      def method_missing(*args)
+      def method_missing(*)
         yield if block_given?
       end
     end
 
-    cattr_accessor :statsd
+    class DummyLogger
+      def method_missing(*)
+        yield if block_given?
+      end
+    end
+
+    cattr_accessor :statsd, :logger
     self.statsd = DummyStatsd.new
+    self.logger = DummyLogger.new
   end
 end

data/lib/cc/cli/analyze.rb

@@ -1,11 +1,9 @@
-require "securerandom"
-
 module CC
   module CLI
     class Analyze < Command
       include CC::Analyzer
 
-      def initialize(args = [])
+      def initialize(_args = [])
         super
 
         process_args
@@ -13,23 +11,14 @@ module CC
 
       def run
         require_codeclimate_yml
-        if engines.empty?
-          fatal("No engines enabled. Add some to your .codeclimate.yml file!")
-        end
-
-        formatter.started
-
-        engines.each do |engine|
-          formatter.engine_running(engine) do
-            engine.run(formatter)
-          end
-        end
 
-        formatter.finished
-      end
+        runner = EnginesRunner.new(registry, formatter, source_dir, config)
+        runner.run
 
-      def dev_mode?
-        !!@dev_mode
+      rescue EnginesRunner::InvalidEngineName => ex
+        fatal(ex.message)
+      rescue EnginesRunner::NoEnabledEngines
+        fatal("No enabled engines. Add some to your .codeclimate.yml file!")
       end
 
       private
@@ -47,71 +36,21 @@ module CC
         fatal(e.message)
       end
 
-      def config
-        @config ||= if filesystem.exist?(CODECLIMATE_YAML)
-          config_body = filesystem.read_path(CODECLIMATE_YAML)
-          config = Config.new(config_body)
-        else
-          config = NullConfig.new
-        end
-      end
-
-      def engine_registry
-        @engine_registry ||= EngineRegistry.new
-      end
-
-      def engine_config(engine_name)
-        config.engine_config(engine_name).
-          merge!(exclude_paths: exclude_paths).to_json
-      end
-
-      def exclude_paths
-        if config.exclude_paths
-          filesystem.files_matching(config.exclude_paths)
-        else
-          []
-        end
-      end
-
-      def engines
-        @engines ||= config.engine_names.map do |engine_name|
-          entry = registry_entry(engine_name)
-          if entry.nil?
-            fatal("unknown engine name: #{engine_name}")
-          else
-            Engine.new(
-              engine_name,
-              entry,
-              path,
-              engine_config(engine_name),
-              SecureRandom.uuid
-            )
-          end
-        end.compact
+      def registry
+        EngineRegistry.new(@dev_mode)
       end
 
       def formatter
         @formatter ||= Formatters::PlainTextFormatter.new
       end
 
-      def path
-        ENV['CODE_PATH']
-      end
-
-      def registry_entry(engine_name)
-        if @dev_mode
-          dev_registry_entry(engine_name)
-        else
-          engine_registry[engine_name]
-        end
+      def source_dir
+        ENV["CODE_PATH"]
       end
 
-      def dev_registry_entry(engine_name)
-        {
-          "image"=>"codeclimate/codeclimate-#{engine_name}:latest"
-        }
+      def config
+        CC::Yaml.parse(filesystem.read_path(CODECLIMATE_YAML))
       end
-
     end
   end
 end

data/lib/cc/cli.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Code Climate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2015-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -194,6 +194,7 @@ files:
 - lib/cc/analyzer/engine.rb
 - lib/cc/analyzer/engine_output_filter.rb
 - lib/cc/analyzer/engine_registry.rb
+- lib/cc/analyzer/engines_runner.rb
 - lib/cc/analyzer/filesystem.rb
 - lib/cc/analyzer/formatters.rb
 - lib/cc/analyzer/formatters/formatter.rb
@@ -203,6 +204,7 @@ files:
 - lib/cc/analyzer/issue_sorter.rb
 - lib/cc/analyzer/location_description.rb
 - lib/cc/analyzer/null_config.rb
+- lib/cc/analyzer/path_patterns.rb
 - lib/cc/analyzer/source_buffer.rb
 - lib/cc/analyzer/unit_name.rb
 - lib/cc/cli.rb