geordi 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f2ea989e784592d99136278e2e7aeca1329d56460590dd0de0c713839d007f4
-  data.tar.gz: c3c001d594fa572a4c562cb91c8796ca1f1170fbfb0168be4f5ec2efaac87556
+  metadata.gz: e775f88b224275cf01077937ba959b27666c1ae7ac18b58548a62bfa31161a12
+  data.tar.gz: 4e0efdb89bbf65b69a9753e8e05978b094915b613b1ded6ef1c1ea4716be0ea7
 SHA512:
-  metadata.gz: c516cd2e6716be0c8e487b5aea0ff741e8d4f99660ee1f9bc2c2277abe275f5b07a31ecd79392cb94c3b804c6357391077d27acd36d8511a1b9dd510baa88e49
-  data.tar.gz: be170bc924f84b7ea056a394348cef9aa24b4b89c2696ef4a400713ca03dad509e446c048217a5626390a459eafaaa52b63212d5990f6898b644acc120fb28c3
+  metadata.gz: 56146e32a18966efbe63a58074d158b888410cf19520150d175f3220be709820b7b05ed6f95df5f80993ed163ba9b59232f1d1f67c3bd43d2055e9b2d66cd812
+  data.tar.gz: e8e41bb61713a5f32dd4039cadee5b11a9f08bac20cad738e61975ea741bfd76cdf5e2d64a166579e701eda472f95f4f8ce15da27181fa0a8b11b748f5d222d3

data/.gitignore

@@ -3,6 +3,5 @@
 .idea
 pkg/*
 .DS_Store
-.pt_project_id
 tmp
 .byebug_history

data/CHANGELOG.md

@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
@@ -7,33 +8,36 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 ## Unreleased
 
 ### Compatible changes
-
 ### Breaking changes
 
 
-## 3.1.0 2020-06-03
+## 3.2.0 2020-07-15
 
 ### Compatible changes
+- Improvement #43: `--select-server` option on `geordi shell` and `geordi console` can take the number of the server to connect to it directly and to skip the menu.
+- Add a `.geordi.yml` file to change multiple settings in the project and  `~/.config/geordi/global.yml` for global settings.
+- Deprecated the `.pt_project_id` file in favor of `.geordi.yml`.
+- Deprecated the `~/.gitpt` file in favor of `~/.config/geordi/global.yml`.
+- Add #91: Now there is an option to start cucumber without a VNC session. This is configured by the .geordi.yml file.
+- Fixed `git#staged_changes?` detection on Ruby < 2.5.
 
-- Update security-update for improved workflow (#89): Deploy staging first and ask user, if application is still running. Then deploy other stages.
 
-### Breaking changes
+## 3.1.0 2020-06-03
+
+### Compatible changes
+- Update security-update for improved workflow (#89): Deploy staging first and ask user, if application is still running. Then deploy other stages.
 
 
 ## 3.0.3 2020-05-27
 
 ### Compatible changes
-
 - Fix #98: Changing the `config/database.yml` reader from `YAML.load` to `YAML.safe_load` dropped the support for aliases. We now allow aliases and the classes `Time` and `Symbol`. If we encounter further issues with this approach a revert to `YAML.load` would be an option, too.
 
 
 ## 3.0.2 2020-05-18
 
 ### Compatible changes
-
-- Fix #95: Method change from `! *.include?` to `*.exclude?` was not valid as we do not have active support in Geordi. Affected commands where `geordi cucumber` and `geordi deploy`.
-
-### Breaking changes
+- Fix #95: Method change from `! *.include?` to `*.exclude?` was not valid as we do not have active support in Geordi. Affected commands were `geordi cucumber` and `geordi deploy`.
 
 
 ## 3.0.1 2020-05-13
@@ -45,8 +49,6 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ## 3.0.0 2020-05-04
 
-### Compatible changes
-
 ### Breaking changes
 - Remove support for Ruby 1.8.7 and Ruby 1.9.3. Bug fixes might still be backported to 2.x, but we will not add any features to 2.x anymore. Please consider to upgrade the Ruby version of your project.
 

data/Gemfile.lock

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

data/README.md

@@ -60,7 +60,7 @@ If there are no staged changes, prints a warning but will continue to create
 an empty commit.
 
 On the first execution we ask for your Pivotal Tracker API token. It will be
-stored in `~/.gitpt`.
+stored in `~/.config/geordi/global.yml`.
 
 
 ### `geordi console [TARGET]`
@@ -71,6 +71,14 @@ Open a local Rails console: `geordi console`
 
 Open a Rails console on `staging`: `geordi console staging`
 
+Lets you select the server to connect to from a menu when called with `--select-server` or the alias `-s`:
+
+    geordi console staging -s
+
+If you already know the number of the server you want to connect to, just pass it along:
+
+    geordi console staging -s2
+
 
 ### `geordi cucumber [FILES and OPTIONS]`
 
@@ -92,6 +100,12 @@ or `-d`.
 - *Options:* Any unknown option will be passed through to Cucumber,
 e.g. `--format pretty`.
 
+- *VNC:* By default, test browsers will run in a VNC session. When using a
+headless test browser anyway, you can disable VNC by putting the following
+config into `.geordi.yml` in the project root:
+
+    use_vnc: false
+
 
 ### `geordi delete-dumps [DIRECTORY]`
 
@@ -320,10 +334,14 @@ Open a shell on a Capistrano deploy target.
 
 Example: `geordi shell production`
 
-Lets you select the server to connect to when called with `--select-server`:
+Lets you select the server to connect to from a menu when called with `--select-server` or the alias `-s`:
 
     geordi shell production -s
 
+If you already know the number of the server you want to connect to, just pass it along:
+
+    geordi shell production -s2
+
 
 ### `geordi tests`
 

data/lib/geordi/commands/commit.rb

@@ -9,7 +9,7 @@ If there are no staged changes, prints a warning but will continue to create
 an empty commit.
 
 On the first execution we ask for your Pivotal Tracker API token. It will be
-stored in `~/.gitpt`.
+stored in `~/.config/geordi/global.yml`.
 LONGDESC
 
 def commit(*git_args)

data/lib/geordi/commands/console.rb

@@ -3,10 +3,18 @@ long_desc <<-LONGDESC
 Open a local Rails console: `geordi console`
 
 Open a Rails console on `staging`: `geordi console staging`
+
+Lets you select the server to connect to from a menu when called with `--select-server` or the alias `-s`:
+
+    geordi console staging -s
+
+If you already know the number of the server you want to connect to, just pass it along:
+
+    geordi console staging -s2
 LONGDESC
 
 
-option :select_server, default: false, type: :boolean, aliases: '-s'
+option :select_server, type: :string, aliases: '-s'
 
 def console(target = 'development', *_args)
   require 'geordi/remote'

data/lib/geordi/commands/cucumber.rb

@@ -15,6 +15,13 @@ or `-d`.
 
 - *Options:* Any unknown option will be passed through to Cucumber,
 e.g. `--format pretty`.
+
+- *VNC:* By default, test browsers will run in a VNC session. When using a
+headless test browser anyway, you can disable VNC by putting the following
+config into `.geordi.yml` in the project root:
+
+    use_vnc: false
+
 LONGDESC
 
 option :modified, aliases: '-m', type: :boolean,

data/lib/geordi/commands/dump.rb

@@ -21,7 +21,6 @@ dump into the development database after downloading it.
 DESC
 
 option :load, aliases: ['-l'], type: :string, desc: 'Load a dump'
-option :select_server, default: false, type: :boolean, aliases: '-s'
 
 def dump(target = nil, *_args)
   require 'geordi/dump_loader'

data/lib/geordi/commands/shell.rb

@@ -2,12 +2,16 @@ desc 'shell TARGET', 'Open a shell on a Capistrano deploy target'
 long_desc <<-LONGDESC
 Example: `geordi shell production`
 
-Lets you select the server to connect to when called with `--select-server`:
+Lets you select the server to connect to from a menu when called with `--select-server` or the alias `-s`:
 
     geordi shell production -s
+
+If you already know the number of the server you want to connect to, just pass it along:
+
+    geordi shell production -s2
 LONGDESC
 
-option :select_server, default: false, type: :boolean, aliases: '-s'
+option :select_server, type: :string, aliases: '-s'
 
 # This method has a triple 'l' because :shell is a Thor reserved word. However,
 # it can still be called with `geordi shell` :)

data/lib/geordi/cucumber.rb

@@ -5,6 +5,7 @@ require 'tempfile'
 # version of Geordi.
 require File.expand_path('interaction', __dir__)
 require File.expand_path('firefox_for_selenium', __dir__)
+require File.expand_path('settings', __dir__)
 
 module Geordi
   class Cucumber
@@ -16,10 +17,11 @@ module Geordi
 
     def run(files, cucumber_options, options = {})
       self.argv = files + cucumber_options.map { |option| option.split('=') }.flatten
+      self.settings = Geordi::Settings.new
 
       consolidate_rerun_txt_files
       show_features_to_run
-      setup_vnc
+      setup_vnc if settings.use_vnc?
 
       command = use_parallel_tests?(options) ? parallel_execution_command : serial_execution_command
       Interaction.note_cmd(command) if options[:verbose]
@@ -65,7 +67,7 @@ module Geordi
 
     private
 
-    attr_accessor :argv
+    attr_accessor :argv, :settings
 
     def serial_execution_command
       format_args = []

data/lib/geordi/gitpt.rb

@@ -3,12 +3,14 @@ class Gitpt
   require 'highline'
   require 'tracker_api'
 
-  SETTINGS_FILE_NAME = '.gitpt'.freeze
-  PROJECT_IDS_FILE_NAME = '.pt_project_id'.freeze
+  # This require-style is to prevent Ruby from loading files of a different
+  # version of Geordi.
+  require File.expand_path('settings', __dir__)
 
   def initialize
     self.highline = HighLine.new
-    self.client = build_client(read_settings)
+    self.settings = Geordi::Settings.new
+    self.client = build_client
   end
 
   def run(git_args)
@@ -24,57 +26,17 @@ No staged changes. Will create an empty commit.
 
   private
 
-  attr_accessor :highline, :client
+  attr_accessor :highline, :client, :settings
 
-  def read_settings
-    file_path = File.join(ENV['HOME'], SETTINGS_FILE_NAME)
-
-    unless File.exist?(file_path)
-      highline.say HighLine::RESET
-      highline.say "Welcome to #{bold 'gitpt'}.\n\n"
-
-      highline.say highlight('Your settings are missing or invalid.')
-      highline.say "Please configure your Pivotal Tracker access.\n\n"
-      token = highline.ask bold('Your API key:') + ' '
-      highline.say "\n"
-
-      settings = { token: token }
-      File.open(file_path, 'w') do |file|
-        file.write settings.to_yaml
-      end
-    end
-
-    YAML.load_file(file_path)
-  end
-
-  def build_client(settings)
-    TrackerApi::Client.new(token: settings.fetch(:token))
+  def build_client
+    TrackerApi::Client.new(token: settings.pivotal_tracker_api_key)
   end
 
   def load_projects
-    project_ids = read_project_ids
+    project_ids = settings.pivotal_tracker_project_ids
     project_ids.collect { |project_id| client.project(project_id) }
   end
 
-  def read_project_ids
-    file_path = PROJECT_IDS_FILE_NAME
-
-    if File.exist?(file_path)
-      project_ids = File.read('.pt_project_id').split(/[\s]+/).map(&:to_i)
-    end
-
-    if project_ids && (project_ids.size > 0)
-      project_ids
-    else
-      Geordi::Interaction.warn "Sorry, I could not find a project ID in #{file_path} :("
-      puts
-
-      puts "Please put at least one Pivotal Tracker project id into #{file_path} in this directory."
-      puts 'You may add multiple IDs, separated using white space.'
-      exit 1
-    end
-  end
-
   def applicable_stories
     projects = load_projects
     projects.collect do |project|
@@ -134,8 +96,4 @@ No staged changes. Will create an empty commit.
     HighLine::BOLD + string + HighLine::RESET
   end
 
-  def highlight(string)
-    bold HighLine::BLUE + string
-  end
-
 end

data/lib/geordi/remote.rb

@@ -34,7 +34,6 @@ module Geordi
       # Generate dump on the server
       shell options.merge({
         remote_command: "dumple #{@config.env} --for_download",
-        select_server: nil, # Dump must be generated on the primary server
       })
 
       destination_directory = File.join(@config.root, 'tmp')
@@ -56,7 +55,20 @@ module Geordi
     end
 
     def shell(options = {})
-      server = options[:select_server] ? select_server : @config.primary_server
+      server_option = options[:select_server]
+      server_number = server_option.to_i
+
+      server =  if server_option == 'select_server'
+        select_server
+      elsif server_number != 0 && server_number <= @config.servers.count
+        server_index = server_number - 1
+        @config.servers[server_index]
+      elsif server_option.nil?
+        @config.primary_server
+      else
+        Interaction.warn "Invalid server number: #{server_option}"
+        select_server
+      end
 
       remote_command = "cd #{@config.remote_root} && #{@config.shell}"
       remote_command << " -c '#{options[:remote_command]}'" if options[:remote_command]

data/lib/geordi/settings.rb

@@ -0,0 +1,155 @@
+require 'yaml'
+
+require File.expand_path('util', __dir__)
+require File.expand_path('interaction', __dir__)
+
+module Geordi
+  class Settings
+    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 ].freeze
+    ALLOWED_LOCAL_SETTINGS = %w[ use_vnc pivotal_tracker_project_ids ].freeze
+
+    def initialize
+      read_settings
+    end
+
+    # Global settings
+    def pivotal_tracker_api_key
+      @global_settings['pivotal_tracker_api_key'] || gitpt_api_key_old || inquire_pt_api_key
+    end
+
+    def pivotal_tracker_api_key=(value)
+      @global_settings['pivotal_tracker_api_key'] = value
+      save_global_settings
+    end
+
+    # Local settings
+    # They should not be changed by geordi to avoid unexpected diffs, therefore
+    # there are no setters for these settings
+    def use_vnc?
+      @local_settings.fetch('use_vnc', true)
+    end
+
+    def pivotal_tracker_project_ids
+      project_ids = @local_settings['pivotal_tracker_project_ids'] || pt_project_ids_old
+
+      case project_ids
+      when Array
+        # nothing to do
+      when String
+        project_ids = project_ids.split(/[\s]+/).map(&:to_i)
+      when Integer
+        project_ids = [project_ids]
+      else
+        project_ids = []
+      end
+
+      if project_ids.empty?
+        puts
+        Geordi::Interaction.warn "Sorry, I could not find a project ID in .geordi.yml :("
+        puts
+
+        puts "Please put at least one Pivotal Tracker project id into the .geordi.yml file in this directory, e.g."
+        puts
+        puts "pivotal_tracker_project_ids:"
+        puts "- 123456"
+        puts
+        puts 'You may add multiple IDs.'
+        exit 1
+      end
+
+      project_ids
+    end
+
+    private
+
+    def read_settings
+      global_path = GLOBAL_SETTINGS_FILE_NAME
+      local_path = LOCAL_SETTINGS_FILE_NAME
+
+      if File.exists?(global_path)
+        global_settings = YAML.safe_load(File.read(global_path))
+        check_for_invalid_keys(global_settings, ALLOWED_GLOBAL_SETTINGS, global_path)
+      end
+
+      if File.exists?(local_path)
+        local_settings = YAML.safe_load(File.read(local_path))
+        check_for_invalid_keys(local_settings, ALLOWED_LOCAL_SETTINGS, local_path)
+      end
+
+      @global_settings = global_settings || {}
+      @local_settings = local_settings || {}
+    end
+
+    def check_for_invalid_keys(settings, allowed_keys, file)
+      invalid_keys = settings.keys - allowed_keys
+      unless invalid_keys.empty?
+        Geordi::Interaction.warn "Geordi detected unknown keys in #{file}.\n"
+
+        invalid_keys.sort.each do |key|
+          puts "* #{key}"
+        end
+
+        puts "\nAllowed keys are:"
+        allowed_keys.sort.each do |key|
+          puts "* #{key}"
+        end
+        puts
+
+        exit 1
+      end
+    end
+
+    def save_global_settings
+      global_path = GLOBAL_SETTINGS_FILE_NAME
+      global_directory = File.dirname(global_path)
+      FileUtils.mkdir_p(global_directory) unless File.directory? global_directory
+      File.open(global_path, 'w') do |file|
+        file.write @global_settings.to_yaml
+      end
+    end
+
+    # deprecated
+    def gitpt_api_key_old
+      file_path = File.join(ENV['HOME'], '.gitpt')
+      if File.exist?(file_path) && !Util.testing?
+        token = YAML.load_file(file_path).fetch :token
+        self.pivotal_tracker_api_key = token
+
+        Geordi::Interaction.warn "The ~/.gitpt file is deprecated."
+        Geordi::Interaction.note "The contained setting has been moved to ~/.config/geordi/global.yml."
+        Geordi::Interaction.note "If you don't need to work with an older version of geordi you can delete ~/.gitpt now."
+
+        token
+      end
+    end
+
+    def inquire_pt_api_key
+      Geordi::Interaction.warn 'Your settings are missing or invalid.'
+      Geordi::Interaction.warn "Please configure your Pivotal Tracker access."
+      token = Geordi::Interaction.prompt 'Your API key:'
+      self.pivotal_tracker_api_key = token
+      puts
+
+      token
+    end
+
+    # deprecated
+    def pt_project_ids_old
+      if File.exist?('.pt_project_id')
+        project_ids = File.read('.pt_project_id')
+        puts # Make sure to start on a new line (e.g. when invoked after a #print)
+        Geordi::Interaction.warn "The usage of the .pt_project_id file is deprecated."
+        Geordi::Interaction.note Util.strip_heredoc(<<-INSTRUCTIONS)
+          Please remove this file from your project and add or extend the .geordi.yml file with the following content:
+            pivotal_tracker_project_ids: #{project_ids}
+        INSTRUCTIONS
+
+        project_ids
+      end
+    end
+
+  end
+end

data/lib/geordi/util.rb

@@ -93,7 +93,7 @@ module Geordi
           ENV['GEORDI_TESTING_STAGED_CHANGES'] == 'true'
         else
           statuses = `git status --porcelain`.split("\n")
-          statuses.any? { |l| l.start_with? /[A-Z]/i }
+          statuses.any? { |l| /^[A-Z]/i =~ l }
         end
       end
 

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '3.1.0'.freeze
+  VERSION = '3.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-03 00:00:00.000000000 Z
+date: 2020-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -123,6 +123,7 @@ files:
 - lib/geordi/gitpt.rb
 - lib/geordi/interaction.rb
 - lib/geordi/remote.rb
+- lib/geordi/settings.rb
 - lib/geordi/util.rb
 - lib/geordi/version.rb
 homepage: http://makandra.com
@@ -144,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Collection of command line tools we use in our daily work with Ruby, Rails