codeclimate 0.45.0 → 0.46.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d44dd1c05b63256236f2262283aa00f4c1c629ac
-  data.tar.gz: 7cff0c14c73e7cb501c2038ba8d9e998d8ce42bf
+  metadata.gz: a022d2dd262f4b69810a0039df68c2c35cbce1b1
+  data.tar.gz: c91433584f2f30204f7e91ff73eee620acf238de
 SHA512:
-  metadata.gz: 8381828b97b80d0400010a2d57c4093bd270a883a01ef66e8c8d7dbb75cfac91170ea1e356d535e7d20e9a294513f010a227a791a690e5231c0228e9b1c96a80
-  data.tar.gz: 38ca8a4dbc3eff1f78c14f1f5d1ffe87b42a5550afee622478aa68594cc561d0622b9e6314730bf3e4ed0c5e2f9865c1a19e92b857878adce621754b80d0629d
+  metadata.gz: 8647501044a5a159e06b1c3b708a0fbb33c6c1aa6b18a6743923ebb5516406e229042b252a52f611239c34bad8c4bbf5a77c6d3b3e3ad2c17d5c967fa8279184
+  data.tar.gz: 4a60df0d24f319050ddef3610bd12071cd318db1508f34e2593c09ba9ab9ac3d5d73aabacd909b8ebe6297729581e5f21c0bc54c93308b7ca51a634536b66024

data/lib/cc/cli.rb

@@ -5,20 +5,20 @@ require "cc/analyzer"
 require "cc/workspace"
 require "cc/yaml"
 
+require "cc/cli/analyze"
+require "cc/cli/command"
+require "cc/cli/console"
+require "cc/cli/engines"
+require "cc/cli/help"
+require "cc/cli/init"
+require "cc/cli/prepare"
+require "cc/cli/runner"
+require "cc/cli/test"
+require "cc/cli/validate_config"
+require "cc/cli/version"
+
 module CC
   module CLI
-    autoload :Analyze, "cc/cli/analyze"
-    autoload :Command, "cc/cli/command"
-    autoload :Console, "cc/cli/console"
-    autoload :Engines, "cc/cli/engines"
-    autoload :Help, "cc/cli/help"
-    autoload :Init, "cc/cli/init"
-    autoload :Prepare, "cc/cli/prepare"
-    autoload :Runner, "cc/cli/runner"
-    autoload :Test, "cc/cli/test"
-    autoload :ValidateConfig, "cc/cli/validate_config"
-    autoload :Version, "cc/cli/version"
-
     def self.debug?
       ENV["CODECLIMATE_DEBUG"]
     end

data/lib/cc/cli/analyze.rb

@@ -1,6 +1,17 @@
+require "cc/cli/command"
+
 module CC
   module CLI
     class Analyze < Command
+      ARGUMENT_LIST = "[-f format] [-e engine[:channel]] [path]".freeze
+      SHORT_HELP = "Run analysis with the given arguments".freeze
+      HELP = "#{SHORT_HELP}\n" \
+        "\n" \
+        "    -f <format>, --format <format>   Format of output. Possible values: #{CC::Analyzer::Formatters::FORMATTERS.keys.join ", "}\n" \
+        "    -e <engine[:channel]>            Engine to run. Can be specified multiple times.\n" \
+        "    --dev                            Run in development mode. Engines installed locally that are not in the manifest will be run.\n" \
+        "    path                             Path to check. Can be specified multiple times.".freeze
+
       include CC::Analyzer
 
       def initialize(_args = [])

data/lib/cc/cli/command.rb

@@ -7,6 +7,50 @@ module CC
   module CLI
     class Command
       CODECLIMATE_YAML = ".codeclimate.yml".freeze
+      NAMESPACE = name.split("::")[0..-2].join("::").freeze
+
+      def self.abstract!
+        @abstract = true
+      end
+
+      def self.abstract?
+        @abstract == true
+      end
+
+      def self.all
+        @@subclasses.reject(&:abstract?)
+      end
+
+      def self.[](name)
+        all.find { |command| command.name == "#{NAMESPACE}::#{name}" || command.command_name == name }
+      end
+
+      # rubocop: disable Style/ClassVars
+      def self.inherited(subclass)
+        @@subclasses ||= []
+        @@subclasses << subclass
+      end
+      # rubocop: enable Style/ClassVars
+
+      def self.synopsis
+        "#{command_name} #{self::ARGUMENT_LIST if const_defined?(:ARGUMENT_LIST)}".strip
+      end
+
+      def self.short_help
+        if const_defined? :SHORT_HELP
+          self::SHORT_HELP
+        else
+          ""
+        end
+      end
+
+      def self.help
+        if const_defined? :HELP
+          self::HELP
+        else
+          short_help
+        end
+      end
 
       def initialize(args = [])
         @args = args
@@ -17,7 +61,9 @@ module CC
       end
 
       def self.command_name
-        name[/[^:]*$/].split(/(?=[A-Z])/).map(&:downcase).join("-")
+        name.gsub(/^#{NAMESPACE}::/, "").split("::").map do |part|
+          part.split(/(?=[A-Z])/).map(&:downcase).join("-")
+        end.join(":")
       end
 
       def execute

data/lib/cc/cli/console.rb

@@ -1,6 +1,8 @@
 module CC
   module CLI
     class Console < Command
+      SHORT_HELP = "Open a ruby console for the CLI. Useful for developing against the CLI.".freeze
+
       def run
         require "pry"
         binding.pry(quiet: true, prompt: Pry::SIMPLE_PROMPT, output: $stdout)

data/lib/cc/cli/engines.rb

@@ -1,14 +1,8 @@
 require "cc/analyzer"
 
-module CC
-  module CLI
-    module Engines
-      autoload :Disable, "cc/cli/engines/disable"
-      autoload :Enable, "cc/cli/engines/enable"
-      autoload :EngineCommand, "cc/cli/engines/engine_command"
-      autoload :Install, "cc/cli/engines/install"
-      autoload :List, "cc/cli/engines/list"
-      autoload :Remove, "cc/cli/engines/remove"
-    end
-  end
-end
+require "cc/cli/engines/disable"
+require "cc/cli/engines/enable"
+require "cc/cli/engines/engine_command"
+require "cc/cli/engines/install"
+require "cc/cli/engines/list"
+require "cc/cli/engines/remove"

data/lib/cc/cli/engines/disable.rb

@@ -1,9 +1,16 @@
 require "cc/analyzer"
+require "cc/cli/engines/engine_command"
 
 module CC
   module CLI
     module Engines
       class Disable < EngineCommand
+        ARGUMENT_LIST = "<engine_name>".freeze
+        SHORT_HELP = "Disable an engine in your codeclimate.yml.".freeze
+        HELP = "#{SHORT_HELP}\n" \
+          "\n"\
+          "    <engine_name>    Engine to disable in your codeclimate.yml".freeze
+
         def run
           require_codeclimate_yml
 

data/lib/cc/cli/engines/enable.rb

@@ -4,6 +4,12 @@ module CC
   module CLI
     module Engines
       class Enable < EngineCommand
+        ARGUMENT_LIST = "<engine_name>".freeze
+        SHORT_HELP = "Enable an engine in your codeclimate.yml.".freeze
+        HELP = "#{SHORT_HELP}\n" \
+          "\n"\
+          "    <engine_name>    Engine to enable in your codeclimate.yml".freeze
+
         def run
           require_codeclimate_yml
 

data/lib/cc/cli/engines/engine_command.rb

@@ -6,6 +6,8 @@ module CC
       class EngineCommand < Command
         include CC::Analyzer
 
+        abstract!
+
         private
 
         def engine_name

data/lib/cc/cli/engines/install.rb

@@ -2,6 +2,8 @@ module CC
   module CLI
     module Engines
       class Install < EngineCommand
+        SHORT_HELP = "Pull the latest images for enabled engines in your codeclimate.yml.".freeze
+
         ImagePullFailure = Class.new(StandardError)
 
         def run

data/lib/cc/cli/engines/list.rb

@@ -2,6 +2,8 @@ module CC
   module CLI
     module Engines
       class List < EngineCommand
+        SHORT_HELP = "List all available engines".freeze
+
         def run
           say "Available engines:"
           engine_registry_list.sort_by { |name, _| name }.each do |name, attributes|

data/lib/cc/cli/engines/remove.rb

@@ -4,6 +4,12 @@ module CC
   module CLI
     module Engines
       class Remove < EngineCommand
+        ARGUMENT_LIST = "<engine_name>".freeze
+        SHORT_HELP = "Remove an engine from your codeclimate.yml.".freeze
+        HELP = "#{SHORT_HELP} This command deletes the config rather than setting it to disabled.\n" \
+          "\n"\
+          "    <engine_name>    Engine to remove from your codeclimate.yml".freeze
+
         def run
           require_codeclimate_yml
 

data/lib/cc/cli/help.rb

@@ -3,34 +3,45 @@ require "rainbow"
 module CC
   module CLI
     class Help < Command
+      ARGUMENT_LIST = "[command]".freeze
+      SHORT_HELP = "Display help information.".freeze
+      HELP = "#{SHORT_HELP}\n" \
+        "\n" \
+        "    no arguments   Show help summary for all commands.\n" \
+        "    [command]      Show help for specific commands. Can be specified multiple times.".freeze
+
       def run
-        say "Usage: codeclimate COMMAND ...\n\nAvailable commands:\n"
-        commands.each do |command|
-          say "    #{command}"
+        if @args.any?
+          @args.each do |command|
+            show_help(command)
+          end
+        else
+          show_help_summary
         end
       end
 
       private
 
-      def commands
-        [
-          "analyze [-f format] [-e engine(:channel)] [path]",
-          "console",
-          "engines:disable #{underline("engine_name")}",
-          "engines:enable #{underline("engine_name")}",
-          "engines:install",
-          "engines:list",
-          "engines:remove #{underline("engine_name")}",
-          "prepare",
-          "help",
-          "init",
-          "validate-config",
-          "version",
-        ].freeze
+      def show_help(command_name)
+        command = Command[command_name]
+        say "Usage: codeclimate #{command.synopsis}\n"
+        say "\n"
+        say "#{command.help}\n"
+        say "\n\n"
       end
 
-      def underline(string)
-        Rainbow.new.wrap(string).underline
+      def show_help_summary
+        short_helps =
+          Command.all.sort_by(&:command_name).map do |command|
+            [command.synopsis, command.short_help]
+          end.compact.to_h
+
+        longest_command_length = short_helps.keys.map(&:length).max
+
+        say "Usage: codeclimate COMMAND ...\n\nAvailable commands:\n"
+        short_helps.each do |command, help|
+          say format("    %-#{longest_command_length}s    %s\n", command, help)
+        end
       end
     end
   end

data/lib/cc/cli/init.rb

@@ -7,6 +7,12 @@ module CC
     class Init < Command
       include CC::Analyzer
 
+      ARGUMENT_LIST = "[--upgrade]".freeze
+      SHORT_HELP = "Generate a configuration based on the contents of your repo.".freeze
+      HELP = "#{SHORT_HELP}\n" \
+        "\n" \
+        "    --upgrade    Upgrade a Code Climate Classic configuration".freeze
+
       def run
         if !upgrade? && filesystem.exist?(CODECLIMATE_YAML)
           warn "Config file .codeclimate.yml already present.\nTry running 'validate-config' to check configuration."

data/lib/cc/cli/prepare.rb

@@ -10,6 +10,12 @@ require "uri"
 module CC
   module CLI
     class Prepare < Command
+      ARGUMENT_LIST = "[--allow-internal-ips]".freeze
+      SHORT_HELP = "Run the commands in your prepare step.".freeze
+      HELP = "#{SHORT_HELP}\n" \
+        "\n" \
+        "    --allow-internal-ips    Allow fetching from internal IPs.".freeze
+
       InternalHostError = Class.new(StandardError)
       FetchError = Class.new(StandardError)
 

data/lib/cc/cli/runner.rb

@@ -31,25 +31,30 @@ module CC
       end
 
       def command_class
-        CLI.const_get(command_name)
+        command_const = Command[command]
+        if command_const.abstract?
+          nil
+        else
+          command_const
+        end
       rescue NameError
         nil
       end
 
-      def command_name
-        case command
-        when nil, "-h", "-?", "--help" then "Help"
-        when "-v", "--version" then "Version"
-        else command.sub(":", "::").underscore.camelize
-        end
-      end
-
       def command_arguments
         @args[1..-1]
       end
 
       def command
-        @args.first
+        command_name = @args.first
+        case command_name
+        when nil, "-h", "-?", "--help"
+          "help"
+        when "-v", "--version"
+          "version"
+        else
+          command_name
+        end
       end
     end
   end

data/lib/cc/cli/test.rb

@@ -1,4 +1,5 @@
 require "cc/yaml"
+require "tmpdir"
 
 module CC
   module CLI
@@ -68,6 +69,12 @@ module CC
     end
 
     class Test < Command
+      ARGUMENT_LIST = "<engine_name>".freeze
+      SHORT_HELP = "Test an engine.".freeze
+      HELP = "Validate that an engine is behaving correctly.\n" \
+        "\n"\
+        "    <engine_name>    Engine to test".freeze
+
       def run
         @engine_name = @args.first
 

data/lib/cc/cli/validate_config.rb

@@ -3,6 +3,8 @@ require "cc/yaml"
 module CC
   module CLI
     class ValidateConfig < Command
+      SHORT_HELP = "Validate your .codeclimate.yml.".freeze
+
       include CC::Analyzer
       include CC::Yaml
 

data/lib/cc/cli/version.rb

@@ -1,6 +1,8 @@
 module CC
   module CLI
     class Version < Command
+      SHORT_HELP = "Display the CLI version.".freeze
+
       def run
         say version
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate
 version: !ruby/object:Gem::Version
-  version: 0.45.0
+  version: 0.46.0
 platform: ruby
 authors:
 - Code Climate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-27 00:00:00.000000000 Z
+date: 2017-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -253,7 +253,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Code Climate CLI