geordi 3.0.0 → 3.2.0

data/lib/geordi/gitpt.rb

@@ -1,19 +1,20 @@
 class Gitpt
-  include Geordi::Interaction
   require 'yaml'
   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)
-    warn <<-WARNING unless Geordi::Util.staged_changes?
+    Geordi::Interaction.warn <<-WARNING unless Geordi::Util.staged_changes?
 No staged changes. Will create an empty commit.
     WARNING
 
@@ -25,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
-      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|
@@ -135,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/interaction.rb

@@ -3,6 +3,8 @@
 module Geordi
   module Interaction
 
+    module_function
+
     # Start your command by `announce`-ing what you're about to do
     def announce(text)
       message = "\n# #{text}"
@@ -42,12 +44,6 @@ module Geordi
       puts "\e[32m#{message}\e[0m" # green
     end
 
-    def strip_heredoc(string)
-      leading_whitespace = (string.match(/\A( +)[^ ]+/) || [])[1]
-      string.gsub! /^#{leading_whitespace}/, '' if leading_whitespace
-      string
-    end
-
     # Returns the user's input.
     # If agreement_regex is given, returns whether the input matches the regex.
     def prompt(text, default = nil, agreement_regex = nil)

data/lib/geordi/remote.rb

@@ -6,7 +6,6 @@ require 'pathname'
 
 module Geordi
   class Remote
-    include Geordi::Interaction
 
     REMOTE_DUMP_PATH = '~/dumps/dump_for_download.dump'.freeze
 
@@ -35,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')
@@ -43,11 +41,11 @@ module Geordi
       destination_path = File.join(destination_directory, "#{@stage}.dump")
       relative_destination = Pathname.new(destination_path).relative_path_from Pathname.new(@config.root)
 
-      note "Downloading remote dump to #{relative_destination} ..."
+      Interaction.note "Downloading remote dump to #{relative_destination} ..."
       server = @config.primary_server
       Util.system! "scp -C #{@config.user(server)}@#{server}:#{REMOTE_DUMP_PATH} #{destination_path}"
 
-      success "Dumped the #{@stage} database to #{relative_destination}."
+      Interaction.success "Dumped the #{@stage} database to #{relative_destination}."
 
       destination_path
     end
@@ -57,12 +55,25 @@ 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]
 
-      note 'Connecting to ' + server.to_s
+      Interaction.note 'Connecting to ' + server.to_s
       Util.system! 'ssh', "#{@config.user(server)}@#{server}", '-t', remote_command
     end
 

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

@@ -4,7 +4,6 @@ require 'socket'
 module Geordi
   class Util
     class << self
-      include Geordi::Interaction
 
       # Geordi commands sometimes require external gems. However, we don't want
       # all employed gems as runtime dependencies because that would
@@ -20,13 +19,13 @@ module Geordi
         install_command = 'gem install ' + gem_name
 
         # install missing gem
-        warn 'Probably missing gem: ' + gem_name
-        prompt('Install it now?', 'y', /y|yes/) || raise('Missing Gems.')
+        Interaction.warn 'Probably missing gem: ' + gem_name
+        Interaction.prompt('Install it now?', 'y', /y|yes/) || Interaction.fail('Missing Gems.')
         system! install_command, show_cmd: true
 
         # retry
         Gem.clear_paths
-        note 'Retrying ...'
+        Interaction.note 'Retrying ...'
         require gem_name
         retry
       end
@@ -39,10 +38,10 @@ module Geordi
       # @option fail_message: The text to print on command failure
       def system!(*commands)
         options = commands.last.is_a?(Hash) ? commands.pop : {}
-        note_cmd commands.join(' ') if options[:show_cmd]
+        Interaction.note_cmd commands.join(' ') if options[:show_cmd]
 
         if options[:confirm]
-          prompt('Run this now?', 'n', /y|yes/) || raise('Cancelled.')
+          Interaction.prompt('Run this now?', 'n', /y|yes/) or Interaction.fail('Cancelled.')
         end
 
         if testing?
@@ -59,7 +58,7 @@ module Geordi
             Bundler.clean_system(*commands)
           end
 
-          success || raise(options[:fail_message] || 'Something went wrong.')
+          success || Interaction.fail(options[:fail_message] || 'Something went wrong.')
         end
       end
 
@@ -94,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
 
@@ -118,7 +117,7 @@ module Geordi
       # check if given cmd is executable. Absolute path or command in $PATH allowed.
       def cmd_exists?(cmd)
         system("which #{cmd} > /dev/null")
-        $CHILD_STATUS.exitstatus.zero?
+        $?.exitstatus.zero?
       end
 
       def is_port_open?(port)
@@ -167,6 +166,12 @@ module Geordi
         !!ENV['GEORDI_TESTING']
       end
 
+      def strip_heredoc(string)
+        leading_whitespace = (string.match(/\A( +)[^ ]+/) || [])[1]
+        string.gsub! /^#{leading_whitespace}/, '' if leading_whitespace
+        string
+      end
+
       private
 
       def bundle_list

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '3.0.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.0.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-04 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.0.8
+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