geordi 9.5.1 → 9.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 506036483e1c31f8fab13388d6f92168227df95506f56ce5e28241f9ef867fc1
-  data.tar.gz: 85ef8a779e3e699865d0eb3f589fd252dd345771946daaed057e3615fcca1ca5
+  metadata.gz: 8a4dc434853c2c8af63e6ac18e69cca013d3a15316401f710c90deab74cd9bbb
+  data.tar.gz: c158a1f4c095120bfbd3ce9aacbd6bf13424994cdfd1ea5c2d5d8b613db5179e
 SHA512:
-  metadata.gz: fb8e5d65caf516ff4a4a5da1655ba5cf8001d8d0c875b68908e39e993dfbde7a3cdb4b887318192cb5bf22f5e2555a5d7796061c72fb2cf745c23c87a71c2ade
-  data.tar.gz: 9ddb734143d4162be8e6cf053f7b9aa35f7c72c69558caedcdb4ed9021b6c16b1bfd3ee84d6c13ad089b4af154d0bd0a197873355ab0dafaebc26710150f38d4
+  metadata.gz: 2260516cf299c4202fbf276c36abbee42190fb9e48b0f583b1af05a457c7676f6d23ccaee7d2bd8ddc2bcdfa923a255cae706dc5c1414c97eab1be58635ad205
+  data.tar.gz: e556b2806dea5a5badbcdad1c22faad5fb56daf95923f1c5ac88f64f1a764d18aacf4d0d683ad0f2b050cbdb131482895da3d58157992af2e11d67e75d0e75bf

data/CHANGELOG.md

@@ -10,10 +10,21 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 ### Breaking changes
 
 
-# 9.5.1 - 2023-04-26
+# 9.6.1 2023-09-22
 
 ### Compatible changes
+* `chromedriver-update` command: Retrieve chromedriver from new location 
 
+
+# 9.6.0 2023-07-24
+
+### Compatible changes
+* Add suggestions of related commands
+
+
+# 9.5.1 2023-04-26
+
+### Compatible changes
 * `cucumber` command: Support the passing of options without "=" 
 
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    geordi (9.5.1)
+    geordi (9.6.1)
       thor (~> 1)
 
 GEM

data/README.md

@@ -34,7 +34,7 @@ stored in `~/.config/geordi/global.yml`.
 
 
 ### `geordi capistrano COMMAND`
-Run a capistrano command on all deploy targets.
+Run a Capistrano command on all deploy targets.
 
 Example: `geordi capistrano deploy`
 

data/lib/geordi/COMMAND_TEMPLATE

@@ -26,6 +26,11 @@ def example
   Interaction.fail 'Option missing' unless options.opt?
 
   Interaction.success 'Done.'
+  Hint.did_you_know [
+    :update,                  # recommendation of another command
+    [:cucumber, :containing], # recommendation of another option
+    'Geordi can automatically update chromedriver before Cucumber tests. See `geordi help chromedriver-update`.', # prose
+  ]
 end
 
 # Command mappings, usually not needed

data/lib/geordi/chromedriver_updater.rb

@@ -1,9 +1,12 @@
 require 'open3'
 require 'net/http'
 require 'tempfile'
+require 'json'
+require 'fileutils'
 
 module Geordi
   class ChromedriverUpdater
+    VERSIONS_PER_MILESTONES_URL = "https://googlechromelabs.github.io/chrome-for-testing/latest-versions-per-milestone-with-downloads.json"
 
     def run(options)
       chrome_version = determine_chrome_version
@@ -11,7 +14,7 @@ module Geordi
 
       latest_chromedriver_version = latest_version(chrome_version)
       if current_chromedriver_version == latest_chromedriver_version
-        Interaction.success "No update required: Chromedriver is already on the latest version v#{latest_chromedriver_version}!" unless options[:quiet_if_matching]
+        Interaction.note "No update required. Chromedriver is already on the latest version #{latest_chromedriver_version}." unless options[:quiet_if_matching]
       else
         update_chromedriver(latest_chromedriver_version)
       end
@@ -49,8 +52,8 @@ module Geordi
 
     # Check https://groups.google.com/a/chromium.org/g/chromium-discuss/c/4BB4jmsRyv8/m/TY3FXS4HBgAJ
     # for information how chrome version numbers work
-    def major_version(full_version)
-      full_version.match(/^(\d+\.\d+\.\d+)\.\d+$/)[1]
+    def milestone_version(full_version)
+      full_version.match(/^\d+/)[0]
     end
 
     def update_chromedriver(latest_chromedriver_version)
@@ -62,39 +65,68 @@ module Geordi
       Interaction.success "Chromedriver updated to v#{determine_chromedriver_version}."
     end
 
-    def download_chromedriver(latest_version)
-      uri = URI("https://chromedriver.storage.googleapis.com/#{latest_version}/chromedriver_linux64.zip")
-      response = Net::HTTP.get_response(uri)
-
-      if response.is_a?(Net::HTTPSuccess)
-        file = Tempfile.new(['chromedriver', '.zip'])
+    def download_chromedriver(version)
+      fetch_response(chromedriver_url(version), "Could not download chromedriver v#{version}.") do |response|
+        file = Tempfile.new(%w[chromedriver .zip])
         file.write(response.body)
 
         file
-      else
-        Interaction.fail("Could not download chromedriver v#{latest_version}.")
       end
     end
 
-    def latest_version(chrome_version)
-      return @latest_version if @latest_version
-
-      uri = URI("https://chromedriver.storage.googleapis.com/LATEST_RELEASE_#{major_version(chrome_version)}")
+    def fetch_response(url, error_message)
+      uri = URI(url)
       response = Net::HTTP.get_response(uri)
 
       if response.is_a?(Net::HTTPSuccess)
-        @latest_version = response.body.to_s
+        yield(response)
       else
-        Interaction.fail("Could not download the chromedriver v#{chrome_version}.")
+        Interaction.fail(error_message)
+      end
+    end
+
+    def chromedriver_url(chrome_version)
+        chromedriver_per_platform = chromedriver_download_data.dig("milestones", milestone_version(chrome_version), "downloads", "chromedriver")
+        chromedriver = chromedriver_per_platform&.find do |chromedriver|
+          chromedriver["platform"] == "linux64"
+        end
+
+        if chromedriver && chromedriver["url"]
+          chromedriver["url"]
+        else
+          Interaction.fail("Could not find chromedriver download url for Chrome version v#{chrome_version}.")
+        end
+    end
+
+    def chromedriver_download_data
+      return @chromedriver_download_data if @chromedriver_download_data
+
+      fetch_response(VERSIONS_PER_MILESTONES_URL, "Could not find chromedriver download data") do |response|
+        begin
+          chromedriver_download_data = JSON.parse(response.body)
+        rescue JSON::ParserError
+          Interaction.fail("Could not parse chromedriver download data.")
+        end
+        @chromedriver_download_data = chromedriver_download_data
       end
     end
 
+    def latest_version(chrome_version)
+      latest_version = chromedriver_download_data.dig("milestones", milestone_version(chrome_version), "version")
+      latest_version || Interaction.fail("Could not find matching chromedriver for Chrome v#{chrome_version}.")
+    end
+
     def unzip(zip, output_dir)
       _stdout_str, _error_str, status = Open3.capture3('unzip', '-d', output_dir, '-o', zip.path)
 
       unless status.success?
         Interaction.fail("Could not unzip #{zip.path}.")
       end
+
+      # the archive contains a folder in which the relevant files are located. These files must be moved to ~/bin.
+      FileUtils.mv("#{output_dir}/chromedriver-linux64/chromedriver", output_dir)
+      FileUtils.mv("#{output_dir}/chromedriver-linux64//LICENSE.chromedriver", output_dir)
+      FileUtils.rm_rf("#{output_dir}/chromedriver-linux64")
     end
   end
 end

data/lib/geordi/cli.rb

@@ -2,6 +2,7 @@ require 'thor'
 require 'bundler'
 require 'geordi/interaction'
 require 'geordi/util'
+require 'geordi/hint'
 
 module Geordi
   class CLI < Thor

data/lib/geordi/commands/branch.rb

@@ -11,4 +11,9 @@ option :from_master, aliases: '-m', type: :boolean, desc: 'Branch from master in
 def branch
   require 'geordi/gitpt'
   Gitpt.new.run_branch(from_master: options.from_master)
+
+  Hint.did_you_know [
+    :commit,
+    [:branch, :from_master],
+  ]
 end

data/lib/geordi/commands/capistrano.rb

@@ -1,4 +1,4 @@
-desc 'capistrano COMMAND', 'Run a capistrano command on all deploy targets'
+desc 'capistrano COMMAND', 'Run a Capistrano command on all deploy targets'
 long_desc <<-LONGDESC
 Example: `geordi capistrano deploy`
 LONGDESC

data/lib/geordi/commands/clean.rb

@@ -12,4 +12,8 @@ def clean
     Interaction.note pattern
     `find . -name #{pattern} -exec rm {} ';'`
   end
+
+  Hint.did_you_know [
+    :remove_executable_flags
+  ]
 end

data/lib/geordi/commands/commit.rb

@@ -11,4 +11,8 @@ LONGDESC
 def commit(*git_args)
   require 'geordi/gitpt'
   Gitpt.new.run_commit(git_args)
+
+  Hint.did_you_know [
+    :branch
+  ]
 end

data/lib/geordi/commands/console.rb

@@ -15,6 +15,11 @@ option :select_server, type: :string, aliases: '-s', banner: '[SERVER_NUMBER]',
 def console(target = 'development', *_args)
   require 'geordi/remote'
 
+  Hint.did_you_know [
+    :shelll,
+    [:console, :select_server],
+  ]
+
   if target == 'development'
     invoke_geordi 'bundle_install'
     invoke_geordi 'yarn_install'

data/lib/geordi/commands/cucumber.rb

@@ -72,6 +72,13 @@ def cucumber(*args)
 
     Interaction.success 'Features green.'
 
+    Hint.did_you_know [
+      :rspec,
+      [:cucumber, :modified],
+      [:cucumber, :containing],
+      [:cucumber, :debug],
+      'Geordi can automatically update chromedriver before Cucumber tests. See `geordi help chromedriver-update`.'
+    ]
   else
     Interaction.note 'Cucumber not employed.'
   end

data/lib/geordi/commands/delete_dumps.rb

@@ -38,4 +38,9 @@ def delete_dumps(*locations)
     deletable_dumps.each &File.method(:delete)
     Interaction.success 'Done.'
   end
+
+  Hint.did_you_know [
+    :clean,
+    :drop_databases
+  ]
 end

data/lib/geordi/commands/deploy.rb

@@ -108,6 +108,11 @@ def deploy(target_stage = nil)
     Util.run!(capistrano_call, show_cmd: true)
 
     Interaction.success 'Deployment complete.'
+
+    Hint.did_you_know [
+      :capistrano,
+      :security_update
+    ]
   else
     Util.run!("git checkout #{source_branch}")
     Interaction.fail 'Deployment cancelled.'

data/lib/geordi/commands/drop_databases.rb

@@ -47,4 +47,8 @@ def drop_databases
   cleaner = DBCleaner.new(extra_flags)
   cleaner.clean_mysql unless options.postgres_only
   cleaner.clean_postgres unless options.mysql_only
+
+  Hint.did_you_know [
+    :delete_dumps
+  ]
 end

data/lib/geordi/commands/dump.rb

@@ -68,4 +68,11 @@ def dump(target = nil, *_args)
       Interaction.success "Your #{loader.config['database']} database has now the data of #{target}#{database_label}."
     end
   end
+
+  Hint.did_you_know [
+    :delete_dumps,
+    :drop_databases,
+    :migrate,
+    'Geordi can load a dump directly into the local database if passed a Capistrano stage and the option -l. See `geordi help dump`.'
+  ]
 end

data/lib/geordi/commands/rake.rb

@@ -22,4 +22,8 @@ def rake(*args)
       Util.run!(command, show_cmd: true)
     end
   end
+
+  Hint.did_you_know [
+    :capistrano
+  ]
 end

data/lib/geordi/commands/remove_executable_flags.rb

@@ -12,4 +12,8 @@ def remove_executable_flags
   end
 
   Interaction.success 'Done.'
+
+  Hint.did_you_know [
+    :clean
+  ]
 end

data/lib/geordi/commands/rspec.rb

@@ -45,6 +45,10 @@ def rspec(*files)
 
       puts
       Util.run!(command.join(' '), fail_message: 'Specs failed.')
+
+      Hint.did_you_know [
+        :cucumber
+      ]
     end
   else
     Interaction.note 'RSpec not employed.'

data/lib/geordi/commands/server.rb

@@ -6,6 +6,10 @@ option :public, aliases: '-P', type: :boolean,
   desc: 'Make the server accessible from the local network'
 
 def server(port = nil)
+  Hint.did_you_know [
+    [:server, :public]
+  ]
+
   invoke_geordi 'bundle_install'
   invoke_geordi 'yarn_install'
   require 'geordi/util'

data/lib/geordi/commands/setup.rb

@@ -27,6 +27,10 @@ def setup
 
   Interaction.success 'Successfully set up the project.'
 
+  Hint.did_you_know [
+    :update
+  ] unless options.dump || options.test
+
   invoke_geordi 'dump', options.dump, load: true if options.dump
   invoke_geordi 'tests' if options.test
 end

data/lib/geordi/commands/shell.rb

@@ -15,6 +15,10 @@ option :select_server, type: :string, aliases: '-s', banner: '[SERVER_NUMBER]',
 def shelll(target, *_args)
   require 'geordi/remote'
 
+  Hint.did_you_know [
+    :console
+  ]
+
   Interaction.announce 'Opening a shell on ' + target
   Geordi::Remote.new(target).shell(options)
 end

data/lib/geordi/commands/tests.rb

@@ -35,4 +35,8 @@ def tests(*args)
 
     Interaction.success 'Successfully ran tests.'
   end
+
+  Hint.did_you_know [
+    :deploy
+  ]
 end

data/lib/geordi/commands/update.rb

@@ -27,7 +27,12 @@ def update
 
     Interaction.success 'Successfully updated the project.'
 
+    Hint.did_you_know [
+      :setup
+    ] unless options.dump || options.test
+
     invoke_geordi 'dump', options.dump, load: true if options.dump
     invoke_geordi 'tests' if options.test
   end
+
 end

data/lib/geordi/hint.rb

@@ -0,0 +1,48 @@
+# Use the methods in this file to hint at other geordi features
+require File.expand_path('settings', __dir__)
+
+module Geordi
+  class Hint
+    class << self
+
+      def did_you_know(hints)
+        settings_probability =  Settings.new.hint_probability
+        default_probability = (Util.testing? ? 0 : 10) # Percent
+        should_print_hint = Random.new.rand(100) <= (settings_probability || default_probability)
+
+        generated_hints = hints.map(&method(:generate))
+        if generated_hints.any? && should_print_hint
+          puts
+          puts generated_hints.sample
+          puts 'You can configure the probability for these hints by setting hint_probability to a unitless percent number in ~/.config/geordi/global.yml' unless settings_probability
+        end
+
+        generated_hints
+      end
+
+      private
+
+      def generate(hint)
+        if hint.is_a?(Symbol)
+          command = Geordi::CLI.commands[hint.to_s]
+          description = downcase_first_letter(command.description)
+          "Did you know? `geordi #{command.name}` can #{description}."
+        elsif hint.is_a?(Array)
+          command = Geordi::CLI.commands[hint[0].to_s]
+          option = command.options[hint[1]]
+          banner = option.banner.nil? ? '' : " #{option.banner}"
+          description = downcase_first_letter(option.description)
+          "Did you know? `geordi #{command.name} #{option.aliases.first}#{banner}` can #{description}."
+        elsif hint.is_a?(String)
+          "Did you know? #{hint}"
+        else
+          raise "Unsupported hint input #{hint.inspect}"
+        end
+      end
+
+      def downcase_first_letter(str)
+        str[0].downcase + str[1..-1]
+      end
+    end
+  end
+end

data/lib/geordi/settings.rb

@@ -8,7 +8,7 @@ module Geordi
     GLOBAL_SETTINGS_FILE_NAME = Util.testing? ? './tmp/global_settings.yml'.freeze : File.join(ENV['HOME'], '.config/geordi/global.yml').freeze
     LOCAL_SETTINGS_FILE_NAME = Util.testing? ? './tmp/local_settings.yml'.freeze : './.geordi.yml'.freeze
 
-    ALLOWED_GLOBAL_SETTINGS = %w[ pivotal_tracker_api_key auto_update_chromedriver pivotal_tracker_project_ids git_initials].freeze
+    ALLOWED_GLOBAL_SETTINGS = %w[ pivotal_tracker_api_key auto_update_chromedriver pivotal_tracker_project_ids git_initials hint_probability ].freeze
     ALLOWED_LOCAL_SETTINGS = %w[ pivotal_tracker_project_ids ].freeze
 
     SETTINGS_WARNED = 'GEORDI_INVALID_SETTINGS_WARNED'
@@ -27,6 +27,10 @@ module Geordi
       save_global_settings
     end
 
+    def hint_probability
+      @global_settings['hint_probability']
+    end
+
     def git_initials
       @global_settings['git_initials']
     end

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '9.5.1'.freeze
+  VERSION = '9.6.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 9.5.1
+  version: 9.6.1
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-26 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -88,6 +88,7 @@ files:
 - lib/geordi/db_cleaner.rb
 - lib/geordi/dump_loader.rb
 - lib/geordi/gitpt.rb
+- lib/geordi/hint.rb
 - lib/geordi/interaction.rb
 - lib/geordi/remote.rb
 - lib/geordi/settings.rb
@@ -116,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Collection of command line tools we use in our daily work with Ruby, Rails