geordi 5.2.2 → 6.0.0.pre.rc1

data/lib/geordi/docker.rb

@@ -1,6 +1,7 @@
 require 'geordi/interaction'
 require 'geordi/cucumber'
 require 'yaml'
+require 'open3'
 
 module Geordi
   class Docker
@@ -28,13 +29,61 @@ module Geordi
     end
 
     def vnc
-      Cucumber.new.launch_vnc_viewer('::5967')
+      check_installation_and_config
+      launch_vnc_viewer('::5967')
+    end
+
+    def setup_vnc
+      `clear`
+      Interaction.note 'This script will help you install a VNC viewer.'
+      Interaction.note 'Please open a second shell to execute instructions.'
+      Interaction.prompt 'Continue ...'
+
+      Interaction.announce 'Setup VNC viewer'
+      vnc_viewer_installed = system('which vncviewer > /dev/null 2>&1')
+      if vnc_viewer_installed
+        Interaction.success 'It appears you already have a VNC viewer installed. Good job!'
+      else
+        puts 'Please run:'
+        Interaction.note_cmd 'sudo apt-get install xtightvncviewer'
+        Interaction.prompt 'Continue ...'
+      end
+
+      puts
+      puts Util.strip_heredoc <<-TEXT
+    Done. You can view the VNC window with `geordi docker vnc`.
+      TEXT
+
+      Interaction.success 'Happy cuking!'
     end
 
     private
 
+    def launch_vnc_viewer(source)
+      fail('VNC viewer not found. Install it with `geordi docker vnc --setup`.') unless command_exists?('vncviewer')
+
+      fork do
+        error = capture_stderr do
+          system("vncviewer #{source}")
+        end
+        unless $?.success?
+          if $?.exitstatus == 127
+            fail('VNC viewer not found. Install it with `geordi docker vnc --setup`.')
+          else
+            fail("VNC viewer could not be opened: #{error}")
+          end
+        end
+      end
+      exit 0
+    end
+
     def attach_to_running_shell
-      running_containers = execute(:`, 'docker-compose ps').split("\n")
+      # The command line output of docker-compose ps changes depending on the container name length, this is
+      # caused by the varying terminal length and results in the longer outputs, e.g the container name and id
+      # to be cut after x characters and the rest being placed in the line below.
+
+      stdout_str, _error_str = execute(:capture, {'COLUMNS' => '400'}, 'docker-compose ps')
+      running_containers = stdout_str.split("\n")
       if (main_container_line = running_containers.grep(/_main_run/).first)
         container_name = main_container_line.split(' ').first
         execute(:exec, 'docker', 'exec', '-it', container_name, 'bash')
@@ -54,13 +103,17 @@ module Geordi
     def execute(kind, *args)
       if ENV['GEORDI_TESTING']
         puts "Stubbed run #{args.join(' ')}"
-        if kind == :`
+        if kind == :` || kind == :capture
           mock_parse(*args)
         else
           mock_run(*args)
         end
       else
-        send(kind, *args)
+        if kind == :capture
+          Open3.capture2(*args)
+        else
+          send(kind, *args)
+        end
       end
     end
 
@@ -112,5 +165,19 @@ module Geordi
         []
       end
     end
+
+    def capture_stderr
+      old_stderr = $stderr.dup
+      io = Tempfile.new('cuc')
+      $stderr.reopen(io)
+      yield
+      io.rewind
+      io.read
+    ensure
+      io.close
+      io.unlink
+      $stderr.reopen(old_stderr)
+    end
+
   end
 end

data/lib/geordi/dump_loader.rb

@@ -57,7 +57,7 @@ module Geordi
       Interaction.note 'Source file: ' + dump_file
 
       source_command = send("#{config['adapter']}_command")
-      Util.run! source_command, fail_message: "An error occured loading #{File.basename(dump_file)}"
+      Util.run! source_command, fail_message: "An error occurred loading #{File.basename(dump_file)}"
     end
 
   end

data/lib/geordi/gitpt.rb

@@ -1,99 +1,185 @@
-class Gitpt
-  require 'yaml'
-  require 'highline'
-  require 'tracker_api'
-
-  # 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.settings = Geordi::Settings.new
-    self.client = build_client
-  end
+require 'yaml'
+require 'highline'
+require 'tracker_api'
+
+module Geordi
+  class Gitpt
+
+    # This require-style is to prevent Ruby from loading files of a different
+    # version of Geordi.
+    require File.expand_path('settings', __dir__)
 
-  def run(git_args)
-    Geordi::Interaction.warn <<-WARNING unless Geordi::Util.staged_changes?
+    def initialize
+      self.highline = HighLine.new
+      self.settings = Settings.new
+      self.client = build_client
+    end
+
+    def run_commit(git_args)
+      Interaction.warn <<-WARNING unless Util.staged_changes?
 No staged changes. Will create an empty commit.
-    WARNING
+      WARNING
 
-    story = choose_story
-    if story
-      create_commit "[##{story.id}] #{story.name}", *git_args
+      story = choose_story
+      if story
+        create_commit "[##{story.id}] #{story.name}", *git_args
+      end
     end
-  end
 
-  private
+    def run_branch
+      story = choose_story || Interaction.fail('No story selected.')
 
-  attr_accessor :highline, :client, :settings
+      normalized_story_name = normalize_string(story.name)
 
-  def build_client
-    TrackerApi::Client.new(token: settings.pivotal_tracker_api_key)
-  end
+      branch_list_string = if Util.testing?
+        ENV['GEORDI_TESTING_GIT_BRANCHES'] || ''
+      else
+        `git branch --format="%(refname:short)"`
+      end
 
-  def load_projects
-    project_ids = settings.pivotal_tracker_project_ids
-    project_ids.collect { |project_id| client.project(project_id) }
-  end
+      if branch_list_string.nil? || branch_list_string.strip.empty?
+        Interaction.fail 'Could not determine local git branches.'
+      end
 
-  def applicable_stories
-    projects = load_projects
-    projects.collect do |project|
-      project.stories(filter: 'state:started,finished,rejected')
-    end.flatten
-  end
+      new_branch_name = "#{git_user_initials}/#{normalized_story_name}-#{story.id}"
 
-  def choose_story
-    if Geordi::Util.testing?
-      return OpenStruct.new(id: 12, name: 'Test Story')
+      local_branches = branch_list_string.split("\n")
+      branch_name = local_branches.find { |branch_name| branch_name == new_branch_name }
+      branch_name ||= local_branches.find { |branch_name| branch_name.include? story.id.to_s }
+
+      if branch_name.present?
+        checkout_branch branch_name, new_branch: false
+      else
+        checkout_branch new_branch_name, new_branch: true
+      end
+    end
+
+    private
+
+    attr_accessor :highline, :client, :settings
+
+    def build_client
+      TrackerApi::Client.new(token: settings.pivotal_tracker_api_key)
     end
 
-    loading_message = 'Connecting to Pivotal Tracker ...'
-    print(loading_message)
-    stories = applicable_stories
-    reset_loading_message = "\r#{' ' * (loading_message.length + stories.length)}\r"
+    def load_projects
+      project_ids = settings.pivotal_tracker_project_ids
+      project_ids.collect do |project_id|
+        begin
+          client.project(project_id)
+        rescue TrackerApi::Errors::ClientError
+          puts # Start a new line
+          Geordi::Interaction.warn "Could not access project #{project_id}. Skipping."
+        end
+      end.compact
+    end
+
+    def applicable_stories
+      if Util.testing?
+        return ENV['GEORDI_TESTING_NO_PT_STORIES'] == 'true' ? [] : [OpenStruct.new(id: 12, name: 'Test Story')]
+      end
 
-    highline.choose do |menu|
-      menu.header = 'Choose a story'
+      projects = load_projects
+      projects.collect do |project|
+        project.stories(filter: 'state:started,finished,rejected', fields: ':default,owners(id,name)')
+      end.flatten
+    end
 
-      stories.each do |story|
-        print '.' # Progress
+    def choose_story
+      loading_message = 'Connecting to Pivotal Tracker ...'
+      print(loading_message)
+      stories = applicable_stories
+      reset_loading_message = "\r#{' ' * (loading_message.length + stories.length)}\r"
 
-        state = story.current_state
-        owners = story.owners
-        owner_is_me = owners.collect(&:id).include?(client.me.id)
+      Geordi::Interaction.fail('No stories to offer.') if stories.empty?
 
-        if state == 'started'
-          state = HighLine::GREEN + state + HighLine::RESET
-        elsif state != 'finished'
-          state = HighLine::RED + state + HighLine::RESET
+      if Util.testing?
+        return stories[0]
+      end
+
+      my_id = client.me.id
+
+      highline.choose do |menu|
+        menu.header = 'Choose a story'
+
+        stories.each do |story|
+          print '.' # Progress
+
+          state = story.current_state
+          owners = story.owners
+          owner_is_me = owners.collect(&:id).include?(my_id)
+
+          if state == 'started'
+            state = HighLine::GREEN + state + HighLine::RESET
+          elsif state != 'finished'
+            state = HighLine::RED + state + HighLine::RESET
+          end
+
+          state += HighLine::BOLD if owner_is_me
+
+          label = "(#{owners.collect(&:name).join(', ')}, #{state}) #{story.name}"
+          label = bold(label) if owner_is_me
+
+          menu.choice(label) { return story }
         end
 
-        state += HighLine::BOLD if owner_is_me
+        menu.hidden ''
+        print reset_loading_message # Once menu is build
+      end
+
+      nil # Return nothing
+    end
 
-        label = "(#{owners.collect(&:name).join(', ')}, #{state}) #{story.name}"
-        label = bold(label) if owner_is_me
+    def create_commit(message, *git_args)
+      extra = highline.ask("\nAdd an optional message").strip
+      message << ' - ' << extra if extra != ''
 
-        menu.choice(label) { return story }
+      Util.run!(['git', 'commit', '--allow-empty', '-m', message, *git_args])
+    end
+
+    def bold(string)
+      HighLine::BOLD + string + HighLine::RESET
+    end
+
+    def checkout_branch(name, new_branch: false)
+      if new_branch
+        Util.run! ['git', 'checkout', 'master']
+        Util.run! ['git', 'checkout', '-b', name]
+      else
+        Util.run! ['git', 'checkout', name]
       end
+    end
 
-      menu.hidden ''
-      print reset_loading_message # Once menu is build
+    def normalize_string(name)
+      name.gsub!('ä', 'ae')
+      name.gsub!('ö', 'oe')
+      name.gsub!('ü', 'ue')
+      name.gsub!('ß', 'ss')
+      name.tr!('^A-Za-z0-9_ ', '')
+      name.squeeze! ' '
+      name.gsub!(' ', '-')
+      name.downcase!
+      name
     end
 
-    nil # Return nothing
-  end
+    def git_user_initials
+      stdout_str = if Util.testing?
+        ENV['GEORDI_TESTING_GIT_USERNAME']
+      else
+        `git config user.name`
+      end
 
-  def create_commit(message, *git_args)
-    extra = highline.ask("\nAdd an optional message").strip
-    message << ' - ' << extra if extra != ''
+      git_user_initials = unless stdout_str.nil?
+        stdout_str.strip.split(' ').map(&:chars).map(&:first).join.downcase
+      end
 
-    Geordi::Util.run!(['git', 'commit', '--allow-empty', '-m', message, *git_args])
-  end
+      git_user_initials = Interaction.prompt 'Enter your initals:', git_user_initials
 
-  def bold(string)
-    HighLine::BOLD + string + HighLine::RESET
+      if git_user_initials.nil?
+        Interaction.fail('Could not determine the git user\'s initials.')
+      else
+        git_user_initials
+      end
+    end
   end
-
 end

data/lib/geordi/interaction.rb

@@ -11,8 +11,9 @@ module Geordi
       puts "\e[4;34m#{message}\e[0m" # blue underline
     end
 
-    # Any hints, comments, infos or explanations should be `note`d. Please do
-    # not print any output (data, file contents, lists) with `note`.
+    # Any meta information, i.e. hints, comments, infos or explanations should
+    # be printed with `note`.
+    # Please do not use it for command output (data, file contents, lists etc).
     def note(text)
       puts '> ' + text
     end
@@ -38,7 +39,8 @@ module Geordi
       exit(1)
     end
 
-    # When you're done, inform the user with a `success` and a short message
+    # When you're done, inform the user with a `success` and a short message. It
+    # should be a sentence (i.e. ending with [.!?]).
     def success(text)
       message = "\n> #{text}"
       puts "\e[32m#{message}\e[0m" # green

data/lib/geordi/remote.rb

@@ -3,6 +3,7 @@ require 'geordi/interaction'
 require 'geordi/util'
 require 'highline/import'
 require 'pathname'
+require 'fileutils'
 
 module Geordi
   class Remote
@@ -59,7 +60,7 @@ module Geordi
       server_option = options[:select_server]
       server_number = server_option.to_i
 
-      server =  if server_option == 'select_server'
+      server = if server_option == 'select_server'
         select_server
       elsif server_number != 0 && server_number <= @config.servers.count
         server_index = server_number - 1

data/lib/geordi/settings.rb

@@ -8,8 +8,10 @@ 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 ].freeze
-    ALLOWED_LOCAL_SETTINGS = %w[ use_vnc pivotal_tracker_project_ids ].freeze
+    ALLOWED_GLOBAL_SETTINGS = %w[ pivotal_tracker_api_key auto_update_chromedriver pivotal_tracker_project_ids ].freeze
+    ALLOWED_LOCAL_SETTINGS = %w[ pivotal_tracker_project_ids ].freeze
+
+    SETTINGS_WARNED = 'GEORDI_INVALID_SETTINGS_WARNED'
 
     def initialize
       read_settings
@@ -34,26 +36,14 @@ module Geordi
       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
+      local_project_ids = @local_settings['pivotal_tracker_project_ids'] || pt_project_ids_old
+      global_project_ids = @global_settings['pivotal_tracker_project_ids']
 
-      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
+      local_project_ids = array_wrap_project_ids(local_project_ids)
+      global_project_ids = array_wrap_project_ids(global_project_ids)
+
+      project_ids = local_project_ids | global_project_ids
 
       if project_ids.empty?
         puts
@@ -78,14 +68,20 @@ module Geordi
       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)
+      global_settings = if File.exists?(global_path)
+        YAML.safe_load(File.read(global_path))
+      end
+      local_settings = if File.exists?(local_path)
+        YAML.safe_load(File.read(local_path))
       end
 
-      if File.exists?(local_path)
-        local_settings = YAML.safe_load(File.read(local_path))
+      # Prevent duplicate warnings caused by another instance of Settings
+      unless ENV[SETTINGS_WARNED]
+        check_for_invalid_keys(global_settings, ALLOWED_GLOBAL_SETTINGS, global_path)
         check_for_invalid_keys(local_settings, ALLOWED_LOCAL_SETTINGS, local_path)
+        Interaction.warn "Unsupported config file \".firefox-version\". Please remove it." if File.exists?('.firefox-version')
+
+        ENV[SETTINGS_WARNED] = 'true'
       end
 
       @global_settings = global_settings || {}
@@ -93,21 +89,12 @@ module Geordi
     end
 
     def check_for_invalid_keys(settings, allowed_keys, file)
+      return if settings.nil?
+
       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
+        Interaction.warn "Unknown settings in #{file}: #{invalid_keys.join(", ")}"
+        Interaction.note "Supported settings in #{file} are: #{allowed_keys.join(", ")}"
       end
     end
 
@@ -160,5 +147,18 @@ module Geordi
       end
     end
 
+    def array_wrap_project_ids(project_ids)
+      case project_ids
+      when Array
+        project_ids
+      when String
+        project_ids.split(/[\s]+/).map(&:to_i)
+      when Integer
+        [project_ids]
+      else
+        []
+      end
+    end
+
   end
 end