Merge branch 'master' of github.com:codeclimate/codeclimate into skip_required_yaml_on_engines_flag

mrb · mrb · commit fa3e5f8e46d8 · 2015-10-09T10:47:45.000-04:00
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -10,4 +10,5 @@ engines:
 ratings:
   paths:
   - "**.rb"
-exclude_paths: []
+exclude_paths:
+  - .bundle/**/*
diff --git a/.dockerignore b/.dockerignore
@@ -1 +1,2 @@
 .git
+.bundle
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -18,6 +18,10 @@ Style/ClassAndModuleChildren:
   Exclude:
     - 'spec/**/*'
 
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*'
+
 Metrics/ModuleLength:
   Exclude:
     - 'spec/**/*'
@@ -34,6 +38,9 @@ Style/DotPosition:
 Style/SignalException:
   Enabled: false
 
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+
 Metrics/AbcSize:
   Enabled: false
 
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    codeclimate (0.6.4)
+    codeclimate (0.7.0)
       activesupport (~> 4.2, >= 4.2.1)
       codeclimate-yaml (~> 0.2.3)
       faraday (~> 0.9.1)
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-0.6.4
+0.7.0
diff --git a/config/engines.yml b/config/engines.yml
@@ -13,6 +13,8 @@ rubocop:
   image: codeclimate/codeclimate-rubocop
   description: A Ruby static code analyzer, based on the community Ruby style guide.
   community: false
+  upgrade_languages:
+   - Ruby
   enable_regexps:
     - \.rb$
   default_ratings_paths:
@@ -24,6 +26,8 @@ duplication:
   default_config:
     languages:
       - ruby
+  upgrade_languages:
+    - Ruby
   enable_regexps:
     - \.rb$
   default_ratings_paths:
@@ -64,6 +68,8 @@ eslint:
   image: codeclimate/codeclimate-eslint
   description: A JavaScript/JSX linting utility
   community: false
+  upgrade_languages:
+    - JavaScript
   enable_regexps:
     - \.js$
     - \.jsx$
@@ -96,14 +102,18 @@ bundler-audit:
   image: codeclimate/codeclimate-bundler-audit
   description: Patch-level verification for Bundler
   community: false
-  enable_patterns:
-    - Gemfile.lock
+  upgrade_languages:
+    - Ruby
+  enable_regexps:
+    - Gemfile\.lock
   default_ratings_paths:
     - Gemfile.lock
 phpcodesniffer:
   image: codeclimate/codeclimate-phpcodesniffer
   description: PHP Code Sniffer
   community: false
+  upgrade_languages:
+    - PHP
   enable_regexps:
     - \.php$
     - \.module$
@@ -116,6 +126,8 @@ phpmd:
   image: codeclimate/codeclimate-phpmd
   description: PHP Mess Detector
   community: false
+  upgrade_languages:
+    - PHP
   enable_regexps:
     - \.php$
     - \.module$
diff --git a/lib/cc/cli/config.rb b/lib/cc/cli/config.rb
@@ -21,7 +21,13 @@ def add_engine(engine_name, engine_config)
 
       def add_exclude_paths(paths)
         config["exclude_paths"] ||= []
-        config["exclude_paths"] += paths.map { |path| "#{path}/**/*" }
+        config["exclude_paths"] += paths.map do |path|
+          if path.ends_with?("/")
+            "#{path}**/*"
+          else
+            path
+          end
+        end
       end
 
       private
diff --git a/lib/cc/cli/config_generator.rb b/lib/cc/cli/config_generator.rb
@@ -0,0 +1,60 @@
+module CC
+  module CLI
+    class ConfigGenerator
+      CODECLIMATE_YAML = Command::CODECLIMATE_YAML
+      AUTO_EXCLUDE_PATHS = %w(config/ db/ features/ node_modules/ script/ spec/ test/ vendor/).freeze
+
+      def self.for(filesystem, engine_registry, upgrade_requested)
+        if upgrade_requested && upgrade_needed?(filesystem)
+          UpgradeConfigGenerator.new(filesystem, engine_registry)
+        else
+          ConfigGenerator.new(filesystem, engine_registry)
+        end
+      end
+
+      def initialize(filesystem, engine_registry)
+        @filesystem = filesystem
+        @engine_registry = engine_registry
+      end
+
+      def eligible_engines
+        return @eligible_engines if @eligible_engines
+
+        engines = engine_registry.list
+        @eligible_engines = engines.each_with_object({}) do |(name, config), result|
+          if engine_eligible?(config)
+            result[name] = config
+          end
+        end
+      end
+
+      def exclude_paths
+        AUTO_EXCLUDE_PATHS.select { |path| filesystem.exist?(path) }
+      end
+
+      def post_generation_verb
+        "generated"
+      end
+
+      private
+
+      attr_reader :engine_registry, :filesystem
+
+      def self.upgrade_needed?(filesystem)
+        if filesystem.exist?(CODECLIMATE_YAML)
+          YAML.safe_load(File.read(CODECLIMATE_YAML))["languages"].present?
+        end
+      end
+
+      def engine_eligible?(engine)
+        !engine["community"] && engine["enable_regexps"].present? && files_exist?(engine)
+      end
+
+      def files_exist?(engine)
+        filesystem.any? do |path|
+          engine["enable_regexps"].any? { |re| Regexp.new(re).match(path) }
+        end
+      end
+    end
+  end
+end
diff --git a/lib/cc/cli/init.rb b/lib/cc/cli/init.rb
@@ -1,32 +1,38 @@
 require 'cc/cli/config'
+require 'cc/cli/config_generator'
+require 'cc/cli/upgrade_config_generator'
 
 module CC
   module CLI
     class Init < Command
       include CC::Analyzer
 
-      AUTO_EXCLUDE_PATHS = %w[config db features node_modules script spec test vendor].freeze
-
       def run
-        if filesystem.exist?(CODECLIMATE_YAML)
+        if !upgrade? && filesystem.exist?(CODECLIMATE_YAML)
           say "Config file .codeclimate.yml already present.\nTry running 'validate-config' to check configuration."
+        elsif upgrade? && engines_enabled?
+          say "--upgrade should not be used on a .codeclimate.yml configured for the Platform.\nTry running 'validate-config' to check configuration."
         else
           create_codeclimate_yaml
-          say "Config file .codeclimate.yml successfully generated.\nEdit and then try running 'validate-config' to check configuration."
+          say "Config file .codeclimate.yml successfully #{config_generator.post_generation_verb}.\nEdit and then try running 'validate-config' to check configuration."
           create_default_configs
         end
       end
 
       private
 
+      def upgrade?
+        @args.include?("--upgrade")
+      end
+
       def create_codeclimate_yaml
         config = CC::CLI::Config.new
 
-        eligible_engines.each do |(engine_name, engine_config)|
+        config_generator.eligible_engines.each do |(engine_name, engine_config)|
           config.add_engine(engine_name, engine_config)
         end
 
-        config.add_exclude_paths(auto_exclude_paths)
+        config.add_exclude_paths(config_generator.exclude_paths)
         filesystem.write_path(CODECLIMATE_YAML, config.to_yaml)
       end
 
@@ -43,37 +49,27 @@ def create_default_configs
       end
 
       def available_configs
-        all_paths = eligible_engines.flat_map do |engine_name, _|
+        all_paths = config_generator.eligible_engines.flat_map do |engine_name, _|
           engine_directory = File.expand_path("../../../../config/#{engine_name}", __FILE__)
           Dir.glob("#{engine_directory}/*", File::FNM_DOTMATCH)
         end
 
         all_paths.reject { |path| ['.', '..'].include?(File.basename(path)) }
       end
 
-      def engine_eligible?(engine)
-        !engine["community"] && engine["enable_regexps"].present? && has_files?(engine)
-      end
-
-      def has_files?(engine)
-        filesystem.any? do |path|
-          engine["enable_regexps"].any? { |re| Regexp.new(re).match(path) }
+      def engines_enabled?
+        unless @engines_enabled.nil?
+          return @engines_enabled
         end
-      end
 
-      def auto_exclude_paths
-        AUTO_EXCLUDE_PATHS.select { |path| filesystem.exist?(path) }
+        if filesystem.exist?(CODECLIMATE_YAML)
+          config = CC::Analyzer::Config.new(File.read(CODECLIMATE_YAML))
+          @engines_enabled ||= config.engine_names.any?
+        end
       end
 
-      def eligible_engines
-        return @eligible_engines if @eligible_engines
-
-        engines = engine_registry.list
-        @eligible_engines = engines.each_with_object({}) do |(name, config), result|
-          if engine_eligible?(config)
-            result[name] = config
-          end
-        end
+      def config_generator
+        @config_generator ||= ConfigGenerator.for(filesystem, engine_registry, upgrade?)
       end
     end
   end
diff --git a/lib/cc/cli/upgrade_config_generator.rb b/lib/cc/cli/upgrade_config_generator.rb
@@ -0,0 +1,34 @@
+require "cc/cli/config_generator"
+
+module CC
+  module CLI
+    class UpgradeConfigGenerator < ConfigGenerator
+      def exclude_paths
+        existing_yaml["exclude_paths"] || []
+      end
+
+      def post_generation_verb
+        "upgraded"
+      end
+
+      private
+
+      def engine_eligible?(engine)
+        base_eligble = super
+        if engine["upgrade_languages"].present?
+          base_eligble && (engine["upgrade_languages"] & classic_languages).any?
+        else
+          base_eligble
+        end
+      end
+
+      def classic_languages
+        @classic_languages ||= existing_yaml["languages"].reject { |_, v| !v }.map(&:first)
+      end
+
+      def existing_yaml
+        @existing_yml ||= YAML.safe_load(File.read(CODECLIMATE_YAML))
+      end
+    end
+  end
+end
diff --git a/spec/cc/cli/config_generator_spec.rb b/spec/cc/cli/config_generator_spec.rb
@@ -0,0 +1,69 @@
+require "spec_helper"
+require "cc/cli/config_generator"
+
+module CC::CLI
+  describe ConfigGenerator do
+    include Factory
+    include FileSystemHelpers
+
+    around do |test|
+      within_temp_dir { test.call }
+    end
+
+    describe "self.for" do
+      it "returns a standard generator when upgrade not requested" do
+        generator = ConfigGenerator.for(make_filesystem, engine_registry, false)
+        generator.class.must_equal ConfigGenerator
+      end
+
+      it "returns a standard generator when upgrade requested but .codeclimate.yml does not exist" do
+        generator = ConfigGenerator.for(make_filesystem, engine_registry, true)
+        generator.class.must_equal ConfigGenerator
+      end
+
+      it "returns an upgrade generator when requested" do
+        File.write(".codeclimate.yml", create_classic_yaml)
+        generator = ConfigGenerator.for(make_filesystem, engine_registry, true)
+        generator.class.must_equal UpgradeConfigGenerator
+      end
+    end
+
+    describe "#eligible_engines" do
+      it "calculates eligible_engines based on existing files" do
+        write_fixture_source_files
+
+        expected_engine_names = %w(rubocop duplication eslint csslint)
+        expected_engines = engine_registry.list.select do |name, _|
+          expected_engine_names.include?(name)
+        end
+        generator.eligible_engines.must_equal expected_engines
+      end
+
+      it "returns brakeman when Gemfile.lock exists" do
+        File.write("Gemfile.lock", "gemfile-lock-content")
+
+        expected_engines = engine_registry.list.select do |name, _|
+          "bundler-audit" == name
+        end
+        generator.eligible_engines.must_equal expected_engines
+      end
+    end
+
+    describe "#exclude_paths" do
+      it "uses AUTO_EXCLUDE_PATHS that exist locally" do
+        write_fixture_source_files
+
+        expected_paths = %w(config/ spec/ vendor/)
+        generator.exclude_paths.must_equal expected_paths
+      end
+    end
+
+    def generator
+      @generator ||= ConfigGenerator.new(make_filesystem, engine_registry)
+    end
+
+    def engine_registry
+      @engine_registry ||= CC::Analyzer::EngineRegistry.new
+    end
+  end
+end
diff --git a/spec/cc/cli/config_spec.rb b/spec/cc/cli/config_spec.rb
@@ -38,11 +38,19 @@ module CC::CLI
     describe "#add_exclude_paths" do
       it "adds exclude paths to config with glob" do
         config = CC::CLI::Config.new()
-        config.add_exclude_paths(["foo"])
+        config.add_exclude_paths(["foo/"])
 
         exclude_paths = YAML.load(config.to_yaml)["exclude_paths"]
         exclude_paths.must_equal(["foo/**/*"])
       end
+
+      it "does not glob paths that aren't directories" do
+        config = CC::CLI::Config.new()
+        config.add_exclude_paths(["foo.rb"])
+
+        exclude_paths = YAML.load(config.to_yaml)["exclude_paths"]
+        exclude_paths.must_equal(["foo.rb"])
+      end
     end
   end
 end
diff --git a/spec/cc/cli/init_spec.rb b/spec/cc/cli/init_spec.rb
diff --git a/spec/cc/cli/upgrade_config_generator_spec.rb b/spec/cc/cli/upgrade_config_generator_spec.rb
diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb
diff --git a/spec/support/factory.rb b/spec/support/factory.rb
diff --git a/spec/support/file_system_helpers.rb b/spec/support/file_system_helpers.rb
