codeclimate 0.52.0 → 0.53.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d83cd6e525dbc1a18755503ca3f652599563026
-  data.tar.gz: 581cc10d9542e2b98fb80128398d33893e2de277
+  metadata.gz: 8670c3a5508dcd9868790f63702f25a2bff79ee6
+  data.tar.gz: 5f5837ffb7b352a3eb22e5a6bf2387851770a04b
 SHA512:
-  metadata.gz: b257f5be556a50cfcca7dffc573ae7a2a3604ac0fde1cb76de9b9bdc4a6a32afbb196c1978d6129c48d37ad10f3c23ccd733ae1027d06624deacb85799f594f4
-  data.tar.gz: 654fdc42ca2c65207b713bf3308ba85d7d35fc382f7fe3e20b89b441ed2e36b70c84adc6fa0bba414c2ff421e02f39f46c9f1bb3491051a044f0ddec013dc8e6
+  metadata.gz: 1a7bd69ebf91c8d13a07514c672d6ca57c3db70487f64c3835b8d401647dfe18322330ca08e4f4c8b43b5094b24feff9e046d81f6363c935d5503382a52003dd
+  data.tar.gz: bc155b1de0bdf5912d198415b0f28047df84c25516fd09749746e3b5e135ea2d03742a86b7191f7e443866ada3222e26861f90f19ca987619c9a716062e6b148

data/lib/cc/cli.rb

@@ -11,6 +11,7 @@ require "cc/cli/console"
 require "cc/cli/engines"
 require "cc/cli/help"
 require "cc/cli/init"
+require "cc/cli/output"
 require "cc/cli/prepare"
 require "cc/cli/runner"
 require "cc/cli/test"

data/lib/cc/cli/command.rb

@@ -2,10 +2,13 @@ require "highline"
 require "active_support"
 require "active_support/core_ext"
 require "rainbow"
+require "cc/cli/output"
 
 module CC
   module CLI
     class Command
+      include CC::CLI::Output
+
       CODECLIMATE_YAML = ".codeclimate.yml".freeze
       NAMESPACE = name.split("::")[0..-2].join("::").freeze
 
@@ -70,23 +73,6 @@ module CC
         run
       end
 
-      def success(message)
-        terminal.say colorize(message, :green)
-      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
         unless filesystem.exist?(CODECLIMATE_YAML)
           fatal("No '.codeclimate.yml' file found. Run 'codeclimate init' to generate a config file.")
@@ -95,24 +81,12 @@ module CC
 
       private
 
-      def colorize(string, *args)
-        rainbow.wrap(string).color(*args)
-      end
-
-      def rainbow
-        @rainbow ||= Rainbow.new
-      end
-
       def filesystem
         @filesystem ||= CC::Analyzer::Filesystem.new(
           CC::Analyzer::MountedPath.code.container_path,
         )
       end
 
-      def terminal
-        @terminal ||= HighLine.new($stdin, $stdout)
-      end
-
       def engine_registry
         @engine_registry ||= CC::Analyzer::EngineRegistry.new
       end

data/lib/cc/cli/file_store.rb

@@ -0,0 +1,42 @@
+require "fileutils"
+require "yaml"
+
+module CC
+  module CLI
+    class FileStore
+      # This class is not supposed to be directly used. It should be sublcassed
+      # and a few constants need to be defined on the sublass to be usable.
+      #
+      # FILE_NAME is the name of the file this class wraps.
+
+      def initialize
+        load_data
+      end
+
+      def save
+        return false unless File.exist? self.class::FILE_NAME
+
+        File.open(self.class::FILE_NAME, "w") do |f|
+          YAML.dump data, f
+        end
+
+        true
+      end
+
+      private
+
+      attr_reader :data
+
+      def load_data
+        @data =
+          if File.exist? self.class::FILE_NAME
+            File.open(self.class::FILE_NAME, "r:bom|utf-8") do |f|
+              YAML.safe_load(f, [Time], [], false, self.class::FILE_NAME) || {}
+            end
+          else
+            {}
+          end
+      end
+    end
+  end
+end

data/lib/cc/cli/global_cache.rb

@@ -0,0 +1,47 @@
+require "cc/cli/file_store"
+
+module CC
+  module CLI
+    class GlobalCache < FileStore
+      FILE_NAME = "/cache.yml".freeze
+
+      # Cache entries
+
+      def last_version_check
+        data["last-version-check"] || Time.at(0)
+      end
+
+      def last_version_check=(value)
+        data["last-version-check"] =
+          if value.is_a? Time
+            value
+          else
+            Time.at(0)
+          end
+        save
+        value
+      end
+
+      def latest_version
+        data["latest-version"]
+      end
+
+      def latest_version=(value)
+        data["latest-version"] = value
+        save
+        value
+      end
+
+      def outdated
+        data["outdated"] == true
+      end
+      alias outdated? outdated
+
+      def outdated=(value)
+        data["outdated"] = value == true
+        save
+        value
+      end
+    end
+  end
+end

data/lib/cc/cli/global_config.rb

@@ -0,0 +1,35 @@
+require "cc/cli/file_store"
+require "uuid"
+
+module CC
+  module CLI
+    class GlobalConfig < FileStore
+      FILE_NAME = "/config.yml".freeze
+
+      DEFAULT_CONFIG = {
+        "check-version" => true,
+      }.freeze
+
+      # Config entries
+
+      def check_version
+        data["check-version"]
+      end
+      alias check_version? check_version
+
+      def check_version=(value)
+        data["check-version"] = value == true
+      end
+
+      def uuid
+        data["uuid"] ||= UUID.new.generate
+      end
+
+      private
+
+      def load_data
+        @data = DEFAULT_CONFIG.merge(super)
+      end
+    end
+  end
+end

data/lib/cc/cli/output.rb

@@ -0,0 +1,34 @@
+module CC
+  module CLI
+    module Output
+      def success(message)
+        terminal.say colorize(message, :green)
+      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 colorize(string, *args)
+        rainbow.wrap(string).color(*args)
+      end
+
+      def rainbow
+        @rainbow ||= Rainbow.new
+      end
+
+      def terminal
+        @terminal ||= HighLine.new($stdin, $stdout)
+      end
+    end
+  end
+end

data/lib/cc/cli/runner.rb

@@ -1,5 +1,6 @@
 require "active_support"
 require "active_support/core_ext"
+require "cc/cli/version_checker"
 
 module CC
   module CLI
@@ -17,6 +18,8 @@ module CC
       end
 
       def run
+        VersionChecker.new.check if check_version?
+
         if command_class
           command = command_class.new(command_arguments)
           command.execute
@@ -56,6 +59,17 @@ module CC
           command_name
         end
       end
+
+      private
+
+      def check_version?
+        if ARGV.first == "--no-check-version"
+          ARGV.shift
+          false
+        else
+          true
+        end
+      end
     end
   end
 end

data/lib/cc/cli/version.rb

@@ -7,8 +7,6 @@ module CC
         say version
       end
 
-      private
-
       def version
         path = File.expand_path("../../../../VERSION", __FILE__)
         @version ||= File.read(path)

data/lib/cc/cli/version_checker.rb

@@ -0,0 +1,105 @@
+require "cc/cli/global_config"
+require "cc/cli/global_cache"
+
+module CC
+  module CLI
+    class VersionChecker
+      include CC::CLI::Output
+
+      VERSION_CHECK_TIMEOUT = 60 * 60 # 1 Hour in seconds
+      DEFAULT_VERSIONS_URL = "https://versions.codeclimate.com".freeze
+
+      def check
+        return unless global_config.check_version?
+
+        print_new_version_message if outdated?
+
+        global_config.save
+      rescue => error
+        CLI.debug(error)
+      end
+
+      private
+
+      def version_check_is_due?
+        Time.now > global_cache.last_version_check + VERSION_CHECK_TIMEOUT
+      end
+
+      def outdated?
+        if version_check_is_due?
+          api_response["outdated"] == true
+        else
+          global_cache.outdated?
+        end
+      end
+
+      def latest_version
+        if version_check_is_due?
+          api_response["latest"]
+        else
+          global_cache.latest_version
+        end
+      end
+
+      def print_new_version_message
+        warn "A new version (v#{latest_version}) is available"
+      end
+
+      def api_response
+        @api_response ||=
+          begin
+            cache! JSON.parse(api_response_body)
+          rescue JSON::ParserError => error
+            CLI.debug(error)
+            # We don't know so use cached values or pretend all is peachy. We'll
+            # try again next time.
+            {
+              "latest" => global_cache.latest_version || version,
+              "outdated" => global_cache.outdated || false,
+            }
+          end
+      end
+
+      def api_response_body
+        if http_response.is_a? Net::HTTPSuccess
+          http_response.body
+        else
+          raise Net::HTTPFatalError.new("HTTP Error", http_response)
+        end
+      rescue Net::HTTPFatalError => error
+        CLI.debug(error)
+        ""
+      end
+
+      def http_response
+        @http_response ||=
+          begin
+            uri = URI.parse(ENV.fetch("CODECLIMATE_VERSIONS_URL", DEFAULT_VERSIONS_URL))
+            uri.query = { version: version, uid: global_config.uuid }.to_query
+            Net::HTTP.start(uri.host, uri.port, open_timeout: 5, read_timeout: 5, ssl_timeout: 5, use_ssl: uri.scheme == "https") do |http|
+              http.request_get(uri)
+            end
+          end
+      end
+
+      def cache!(data)
+        global_cache.latest_version = data["latest"]
+        global_cache.outdated = data["outdated"] == true
+        global_cache.last_version_check = Time.now
+        data
+      end
+
+      def version
+        @version ||= Version.new.version
+      end
+
+      def global_config
+        @global_config ||= GlobalConfig.new
+      end
+
+      def global_cache
+        @global_cache ||= GlobalCache.new
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeclimate
 version: !ruby/object:Gem::Version
-  version: 0.52.0
+  version: 0.53.0
 platform: ruby
 authors:
 - Code Climate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-14 00:00:00.000000000 Z
+date: 2017-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -146,6 +146,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
 description: Code Climate command line tool
 email: hello@codeclimate.com
 executables:
@@ -219,14 +233,19 @@ files:
 - lib/cc/cli/engines/install.rb
 - lib/cc/cli/engines/list.rb
 - lib/cc/cli/engines/remove.rb
+- lib/cc/cli/file_store.rb
+- lib/cc/cli/global_cache.rb
+- lib/cc/cli/global_config.rb
 - lib/cc/cli/help.rb
 - lib/cc/cli/init.rb
+- lib/cc/cli/output.rb
 - lib/cc/cli/prepare.rb
 - lib/cc/cli/runner.rb
 - lib/cc/cli/test.rb
 - lib/cc/cli/upgrade_config_generator.rb
 - lib/cc/cli/validate_config.rb
 - lib/cc/cli/version.rb
+- lib/cc/cli/version_checker.rb
 - lib/cc/resolv.rb
 - lib/cc/workspace.rb
 - lib/cc/workspace/exclusion.rb