Add default_config key with nested values

BlakeWilliams · BlakeWilliams · commit a6046a2546b3 · 2015-10-01T14:21:51.000-04:00
This adds the `default_config` option which is used to add default
configuration options to an engine. This also marks the duplication
engine as a default engine when ruby files are present.
diff --git a/.codeclimate.yml b/.codeclimate.yml
@@ -2,11 +2,12 @@
 engines:
   rubocop:
     enabled: true
-  bundler-audit:
+  duplication:
     enabled: true
+    config:
+      languages:
+      - ruby
 ratings:
   paths:
   - "**.rb"
-exclude_paths:
-- config/**/*
-- spec/**/*
+exclude_paths: []
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    codeclimate (0.6.4)
+    codeclimate (0.6.3)
       activesupport (~> 4.2, >= 4.2.1)
       codeclimate-yaml (~> 0.2.3)
       faraday (~> 0.9.1)
@@ -49,7 +49,7 @@ GEM
       metaclass (~> 0.0.1)
     multipart-post (2.0.0)
     posix-spawn (0.3.11)
-    pry (0.10.1)
+    pry (0.10.2)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
@@ -76,6 +76,3 @@ DEPENDENCIES
   minitest-reporters
   mocha
   rack-test
-
-BUNDLED WITH
-   1.10.6
diff --git a/config/engines.yml b/config/engines.yml
@@ -17,6 +17,17 @@ rubocop:
     - \.rb$
   default_ratings_paths:
     - "**.rb"
+duplication:
+  image: codeclimate/codeclimate-duplication
+  description: Find similar structures in your code
+  community: false
+  default_config:
+    languages:
+      - ruby
+  enable_regexps:
+    - \.rb$
+  default_ratings_paths:
+    - "**.rb"
 gofmt:
   image: codeclimate/codeclimate-gofmt
   description: gofmt
diff --git a/lib/cc/cli/config.rb b/lib/cc/cli/config.rb
@@ -0,0 +1,32 @@
+module CC
+  module CLI
+    class Config
+      delegate :to_yaml, to: :config
+      def initialize
+        @config = {
+          "engines" => {},
+          "ratings" => { "paths" => [] }
+        }
+      end
+
+      def add_engine(engine_name, engine_config)
+        config["engines"][engine_name] = { "enabled" => true }
+
+        if engine_config["default_config"].present?
+          config["engines"][engine_name]["config"] = engine_config["default_config"]
+        end
+
+        config["ratings"]["paths"] |= engine_config["default_ratings_paths"]
+      end
+
+      def add_exclude_paths(paths)
+        config["exclude_paths"] ||= []
+        config["exclude_paths"] += paths.map { |path| "#{path}/**/*" }
+      end
+
+      private
+
+      attr_reader :config
+    end
+  end
+end
diff --git a/lib/cc/cli/init.rb b/lib/cc/cli/init.rb
@@ -1,3 +1,5 @@
+require 'cc/cli/config'
+
 module CC
   module CLI
     class Init < Command
@@ -18,19 +20,13 @@ def run
       private
 
       def create_codeclimate_yaml
-        config = { "engines" => {} }
-        eligible_engines.each do |engine_name, engine_config|
-          config["engines"][engine_name] = {
-            "enabled" => true
-          }
-          config["ratings"] ||= {}
-          config["ratings"]["paths"] ||= []
+        config = CC::CLI::Config.new
 
-          config["ratings"]["paths"] |= engine_config["default_ratings_paths"]
+        eligible_engines.each do |(engine_name, engine_config)|
+          config.add_engine(engine_name, engine_config)
         end
 
-        config["exclude_paths"] = exclude_paths(AUTO_EXCLUDE_PATHS)
-
+        config.add_exclude_paths(auto_exclude_paths)
         filesystem.write_path(CODECLIMATE_YAML, config.to_yaml)
       end
 
@@ -55,28 +51,27 @@ def available_configs
         all_paths.reject { |path| ['.', '..'].include?(File.basename(path)) }
       end
 
-      def exclude_paths(paths)
-        expanded_paths = []
-        paths.each do |dir|
-          if filesystem.exist?(dir)
-            expanded_paths << "#{dir}/**/*"
-          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) }
         end
-        expanded_paths
       end
 
-      def engine_eligible?(engine)
-        !engine["community"] &&
-          engine["enable_regexps"].present? &&
-          filesystem.any? do |path|
-            engine["enable_regexps"].any? { |re| Regexp.new(re).match(path) }
-          end
+      def auto_exclude_paths
+        AUTO_EXCLUDE_PATHS.select { |path| filesystem.exist?(path) }
       end
 
       def eligible_engines
-        @eligible_engines ||= engine_registry.list.each_with_object({}) do |(engine_name, config), result|
+        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[engine_name] = config
+            result[name] = config
           end
         end
       end
diff --git a/spec/cc/cli/config_spec.rb b/spec/cc/cli/config_spec.rb
@@ -0,0 +1,48 @@
+require "spec_helper"
+require "cc/cli/config"
+
+module CC::CLI
+  describe CC::CLI::Config do
+    describe "#add_engine" do
+      it "enables the passed in engine" do
+        config = CC::CLI::Config.new()
+        engine_config = {
+          "default_ratings_paths" => ["foo"]
+        }
+
+        config.add_engine("foo", engine_config)
+
+        engine = YAML.load(config.to_yaml)["engines"]["foo"]
+        engine.must_equal({ "enabled" => true })
+      end
+
+      it "copies over default configuration" do
+        config = CC::CLI::Config.new()
+        engine_config = {
+          "default_config" => { "awesome" => true },
+          "default_ratings_paths" => ["foo"]
+        }
+
+        config.add_engine("foo", engine_config)
+
+        engine = YAML.load(config.to_yaml)["engines"]["foo"]
+        engine.must_equal({
+          "enabled" => true,
+          "config" => {
+            "awesome" => true
+          }
+        })
+      end
+    end
+
+    describe "#add_exclude_paths" do
+      it "adds exclude paths to config with glob" do
+        config = CC::CLI::Config.new()
+        config.add_exclude_paths(["foo"])
+
+        exclude_paths = YAML.load(config.to_yaml)["exclude_paths"]
+        exclude_paths.must_equal(["foo/**/*"])
+      end
+    end
+  end
+end
diff --git a/spec/cc/cli/init_spec.rb b/spec/cc/cli/init_spec.rb
@@ -36,7 +36,11 @@ module CC::CLI
               "engines" => {
                 "rubocop" => { "enabled"=>true },
                 "eslint" => { "enabled"=>true },
-                "csslint"=> { "enabled"=>true },
+                "csslint" => { "enabled"=>true },
+                "duplication" => {
+                  "enabled" => true,
+                  "config" => { "languages" => ["ruby"] }
+                }
               },
               "ratings" => { "paths" => ["**.rb", "**.js", "**.jsx", "**.css"] },
               "exclude_paths" => ["config/**/*", "spec/**/*", "vendor/**/*"],
