codeclimate 0.0.0 → 0.0.1

data/lib/cc/cli/command.rb

@@ -0,0 +1,65 @@
+require "highline"
+require "active_support"
+require "active_support/core_ext"
+require "rainbow"
+
+module CC
+  module CLI
+    class Command
+      CODECLIMATE_YAML = ".codeclimate.yml".freeze
+
+      def initialize(args = [])
+        @args = args
+      end
+
+      def run
+        $stderr.puts "unknown command #{self.class.name.split('::').last.underscore}"
+      end
+
+      def self.command_name
+        name[/[^:]*$/].split(/(?=[A-Z])/).map(&:downcase).join('-')
+      end
+
+      def execute
+        run
+      end
+
+      def say(message)
+        terminal.say message
+      end
+
+      def warn(message)
+        terminal.say(colorize("WARNING: #{message}", :yellow))
+      end
+
+      def fatal(message)
+        $stderr.puts colorize(message, :red)
+        exit 1
+      end
+
+      def require_codeclimate_yml
+        if !filesystem.exist?(CODECLIMATE_YAML)
+          fatal("No '.codeclimate.yml' file found. Run 'codeclimate init' to generate a config file.")
+        end
+      end
+
+      private
+
+      def colorize(string, *args)
+        rainbow.wrap(string).color(*args)
+      end
+
+      def rainbow
+        @rainbow ||= Rainbow.new
+      end
+
+      def filesystem
+        @filesystem ||= CC::Analyzer::Filesystem.new(ENV['FILESYSTEM_DIR'])
+      end
+
+      def terminal
+        @terminal ||= HighLine.new($stdin, $stdout)
+      end
+    end
+  end
+end

data/lib/cc/cli/console.rb

@@ -0,0 +1,12 @@
+module CC
+  module CLI
+    class Console < Command
+
+      def run
+        require "pry"
+        binding.pry(quiet: true, prompt: Pry::SIMPLE_PROMPT, output: $stdout)
+      end
+
+    end
+  end
+end

data/lib/cc/cli/engines.rb

@@ -0,0 +1,14 @@
+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

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

@@ -0,0 +1,31 @@
+require "cc/analyzer"
+
+module CC
+  module CLI
+    module Engines
+      class Disable < EngineCommand
+        def run
+          require_codeclimate_yml
+
+          if !engine_exists?
+            say "Engine not found. Run 'codeclimate engines:list' for a list of valid engines."
+          elsif !engine_present_in_yaml?
+            say "Engine not found in .codeclimate.yml."
+          elsif !engine_enabled?
+            say "Engine already disabled."
+          else
+            disable_engine
+            update_yaml
+            say "Engine disabled."
+          end
+        end
+
+        private
+
+        def disable_engine
+          parsed_yaml.disable_engine(engine_name)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+require "cc/analyzer"
+
+module CC
+  module CLI
+    module Engines
+      class Enable < EngineCommand
+        def run
+          require_codeclimate_yml
+
+          if !engine_exists?
+            say "Engine not found. Run 'codeclimate engines:list' for a list of valid engines."
+          elsif engine_enabled?
+            say "Engine already enabled."
+            pull_docker_images
+          else
+            enable_engine
+            update_yaml
+            say "Engine added to .codeclimate.yml."
+            pull_docker_images
+          end
+        end
+
+        private
+
+        def pull_docker_images
+          Engines::Install.new.run
+        end
+
+        def enable_engine
+          parsed_yaml.enable_engine(engine_name)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+require "cc/analyzer"
+
+module CC
+  module CLI
+    module Engines
+      class EngineCommand < Command
+        include CC::Analyzer
+
+        private
+
+        def engine_name
+          @engine_name ||= @args.first
+        end
+
+        def parsed_yaml
+          @parsed_yaml ||= CC::Analyzer::Config.new(yaml_content)
+        end
+
+        def yaml_content
+          File.read(filesystem.path_for(CODECLIMATE_YAML)).freeze
+        end
+
+        def update_yaml
+          File.open(filesystem.path_for(CODECLIMATE_YAML), "w") do |f|
+            f.write(parsed_yaml.to_yaml)
+          end
+        end
+
+        def engine_present_in_yaml?
+          parsed_yaml.engine_present?(engine_name)
+        end
+
+        def engine_enabled?
+          parsed_yaml.engine_enabled?(engine_name)
+        end
+
+        def engine_exists?
+          engines_registry_list.keys.include?(engine_name)
+        end
+
+        def engines_registry_list
+          @engines_registry_list ||= CC::Analyzer::EngineRegistry.new.list
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+require "cc/analyzer"
+
+module CC
+  module CLI
+    module Engines
+      class Install < EngineCommand
+        ImagePullFailure = Class.new(StandardError)
+
+        def run
+          require_codeclimate_yml
+
+          say "Pulling docker images."
+          pull_docker_images
+        end
+
+        private
+
+        def pull_docker_images
+          engine_names.each do |name|
+            if engine_exists?(name)
+              image = engine_image(name)
+              pull_engine_image(image)
+            else
+              warn("unknown engine name: #{name}")
+            end
+          end
+        end
+
+        def engine_names
+          @engine_names ||= parsed_yaml.engine_names
+        end
+
+        def engine_exists?(engine_name)
+          engines_registry_list.keys.include?(engine_name)
+        end
+
+        def engine_image(engine_name)
+          engines_registry_list[engine_name]["image_name"]
+        end
+
+        def pull_engine_image(engine_image)
+          if !system("docker pull #{engine_image}")
+            raise ImagePullFailure, "unable to pull image #{engine_image}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+module CC
+  module CLI
+    module Engines
+      class List < EngineCommand
+        def run
+          say "Available engines:"
+          engines_registry_list.sort_by { |name, _| name }.each do |name, attributes|
+            say "- #{name}: #{attributes["description"]}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require "cc/analyzer"
+
+module CC
+  module CLI
+    module Engines
+      class Remove < EngineCommand
+        def run
+          require_codeclimate_yml
+
+          if !engine_exists?
+            say "Engine not found. Run 'codeclimate engines:list' for a list of valid engines."
+          elsif !engine_present_in_yaml?
+            say "Engine not found in .codeclimate.yml."
+          else
+            remove_engine
+            update_yaml
+            say "Engine removed from .codeclimate.yml."
+          end
+        end
+
+        private
+
+        def remove_engine
+          parsed_yaml.remove_engine(engine_name)
+        end
+      end
+    end
+  end
+end

data/lib/cc/cli/help.rb

@@ -0,0 +1,36 @@
+require "rainbow"
+
+module CC
+  module CLI
+    class Help < Command
+      def run
+        say "Usage: codeclimate COMMAND ...\n\nAvailable commands:\n"
+        commands.each do |command|
+          say "    #{command}"
+        end
+      end
+
+      private
+
+      def commands
+        [
+          "analyze [-f format]",
+          "console",
+          "engines:disable #{underline('engine_name')}",
+          "engines:enable #{underline('engine_name')}",
+          "engines:install",
+          "engines:list",
+          "engines:remove #{underline('engine_name')}",
+          "help",
+          "init",
+          "validate-config",
+          "version"
+        ].freeze
+      end
+
+      def underline(string)
+        return Rainbow.new.wrap(string).underline
+      end
+    end
+  end
+end

data/lib/cc/cli/init.rb

@@ -0,0 +1,53 @@
+module CC
+  module CLI
+    class Init < Command
+      include CC::Analyzer
+
+      def run
+        if filesystem.exist?(CODECLIMATE_YAML)
+          say "Config file .codeclimate.yml already present.\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."
+        end
+      end
+
+      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["ratings"]["paths"] |= engine_config["default_ratings_paths"]
+        end
+
+        if filesystem.exist?("vendor")
+          config["exclude_paths"] = ["vendor/**/*"]
+        end
+
+        File.write(filesystem.path_for(CODECLIMATE_YAML), config.to_yaml)
+      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
+      end
+
+      def eligible_engines
+        CC::Analyzer::EngineRegistry.new.list.each_with_object({}) do |(engine_name, config), result|
+          if engine_eligible?(config)
+            result[engine_name] = config
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cc/cli/runner.rb

@@ -0,0 +1,60 @@
+require "active_support"
+require "active_support/core_ext"
+
+module CC
+  module CLI
+    class Runner
+
+      def self.run(argv)
+        new(argv).run
+      rescue => ex
+        $stderr.puts("error: (#{ex.class}) #{ex.message}")
+
+        if ENV["CODECLIMATE_DEBUG"]
+          $stderr.puts("backtrace: #{ex.backtrace.join("\n\t")}")
+        end
+      end
+
+      def initialize(args)
+        @args = args
+      end
+
+      def run
+        if command_class
+          command = command_class.new(command_arguments)
+          command.execute
+        else
+          command_not_found
+        end
+      end
+
+      def command_not_found
+        $stderr.puts "unknown command #{command}"
+        exit 1
+      end
+
+      def command_class
+        CLI.const_get(command_name)
+      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
+      end
+
+    end
+  end
+end