codeclimate 0.6.4 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6ca89f86ce098c983198f10de1ff0233da75971
-  data.tar.gz: 8cb4b963e927bc4ac671cbc155e36d8ac01ed009
+  metadata.gz: c8c9b1ea7e082d3aebf1ec60122ce302cc362105
+  data.tar.gz: 8145118b8fc245b9ef21e53d951b40a52ebc58bd
 SHA512:
-  metadata.gz: 7caa45a9423eb8dbdadc83028abec571c2955410085d5479bbf3689c50e429b229ad9410b4670b52dc4c18f96595bcdc64274a6cead415a6fa44d349089b471d
-  data.tar.gz: db25ad93de68cc95525bb9871a329662040f14fafe91e6aefe7f2f1139cbd59f0a403bd4638ae04dd106f3f81d6dca17be342fffff5bc721d98c15704a8aa7f0
+  metadata.gz: f57d7240b23377320fefd642a71db3fee4f1a88a4cbff30661623a90bb622d20505dc857e4e820fe10ec16ee4bb33749fae2a99286745592f8c2d770b719c70b
+  data.tar.gz: eb6c644256a56ebe17f1b44fa8785247e7b3b354cc634bc86618677c1f30fbbf37a40c86a70897f229f3fc7739b0a77f053e52f4f60abed88e5561deddd811ba

data/config/engines.yml

@@ -13,6 +13,21 @@ 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:
+    - "**.rb"
+duplication:
+  image: codeclimate/codeclimate-duplication
+  description: Find similar structures in your code
+  community: false
+  default_config:
+    languages:
+      - ruby
+  upgrade_languages:
+    - Ruby
   enable_regexps:
     - \.rb$
   default_ratings_paths:
@@ -53,6 +68,8 @@ eslint:
   image: codeclimate/codeclimate-eslint
   description: A JavaScript/JSX linting utility
   community: false
+  upgrade_languages:
+    - JavaScript
   enable_regexps:
     - \.js$
     - \.jsx$
@@ -85,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$
@@ -105,6 +126,8 @@ phpmd:
   image: codeclimate/codeclimate-phpmd
   description: PHP Mess Detector
   community: false
+  upgrade_languages:
+    - PHP
   enable_regexps:
     - \.php$
     - \.module$

data/lib/cc/cli/config.rb

@@ -0,0 +1,38 @@
+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 do |path|
+          if path.ends_with?("/")
+            "#{path}**/*"
+          else
+            path
+          end
+        end
+      end
+
+      private
+
+      attr_reader :config
+    end
+  end
+end

data/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

data/lib/cc/cli/init.rb

@@ -1,36 +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 = { "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"]
+        config_generator.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(config_generator.exclude_paths)
         filesystem.write_path(CODECLIMATE_YAML, config.to_yaml)
       end
 
@@ -47,7 +49,7 @@ module CC
       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
@@ -55,30 +57,19 @@ module CC
         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 engines_enabled?
+        unless @engines_enabled.nil?
+          return @engines_enabled
         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
+        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
-        @eligible_engines ||= engine_registry.list.each_with_object({}) do |(engine_name, config), result|
-          if engine_eligible?(config)
-            result[engine_name] = config
-          end
-        end
+      def config_generator
+        @config_generator ||= ConfigGenerator.for(filesystem, engine_registry, upgrade?)
       end
     end
   end

data/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.0
 platform: ruby
 authors:
 - Code Climate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-01 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -218,6 +218,8 @@ files:
 - lib/cc/cli.rb
 - lib/cc/cli/analyze.rb
 - lib/cc/cli/command.rb
+- lib/cc/cli/config.rb
+- lib/cc/cli/config_generator.rb
 - lib/cc/cli/console.rb
 - lib/cc/cli/engines.rb
 - lib/cc/cli/engines/disable.rb
@@ -229,6 +231,7 @@ files:
 - lib/cc/cli/help.rb
 - lib/cc/cli/init.rb
 - lib/cc/cli/runner.rb
+- lib/cc/cli/upgrade_config_generator.rb
 - lib/cc/cli/validate_config.rb
 - lib/cc/cli/version.rb
 - lib/file_utils_ext.rb
@@ -252,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Code Climate CLI