geordi 11.1.0 → 11.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 310a3633bce8944bb4c56987a2d12cf2ed69013ef978e91f48063acba801c634
-  data.tar.gz: f5e53286619679e6b5c3f0e2439e5c7589ed7c2e2866c0078b51f056658cc3dd
+  metadata.gz: 34d65d80999ddc674119d4be0c198c4aa43e0a7198555aae13f7d0ed529b17a9
+  data.tar.gz: 0e23774900617e49f7ec4a0f49ff41979414aef2cbb1e98ebcf8e32b50094a55
 SHA512:
-  metadata.gz: 692cd04428cdbc217969425a9c3fcc1ea62f95f0a0692aabec218afdb1b804c1e705a181f387c6ba581c5e3dc25acdb5a0485565571c73d7f33d4521629ce300
-  data.tar.gz: 8f9c32e800de8532265c3b302bfd821c0a24295c55bfac166ddb1390a2a0e93fb15e6028d1a63526ec0fc8268b1a617687152d8a72055c75a0546f45fec292c4
+  metadata.gz: 326546035b14d2708c5d1ab4829a4cb51359ff3e8b90a07b6a3245a860d1e121fcfbeea29cacb2a853cbdc7b2a9e6b0ef53219696cabb589c73f4785a732cb74
+  data.tar.gz: 3b8c91f822d01b5b4d2a7f825e19d90eca6b92b58d01a7d24e7b87d38ad02faa16a01451a810cefe9fef01c85a695c7f6638cd8ad660db2106a95765a449385f

data/CHANGELOG.md

@@ -4,15 +4,23 @@ 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).
 
 ## Unreleased
+### Compatible changes
+### Breaking changes
+
+
+## 11.2.0 2024-11-22
 
 ### Compatible changes
+* Add support for default branches other than "master" (e.g. "main"). Will read
+  this information from `origin`.
+* `geordi branch` will not fail if it can't determine local branches.
+* Improved Linear issue menu: now includes the issue id, truncates long issue
+  titles and puts metadata last
 
-### Breaking changes
 
 ## 11.1.0 2024-11-20
 
 ### Compatible changes
-
 * Skip `yarn install` for other package managers:
   * Before: Check for a `package.json`
   * After: Check for a `yarn.lock`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    geordi (11.1.0)
+    geordi (11.2.0)
       thor (~> 1)
 
 GEM
@@ -119,4 +119,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   2.3.25
+   2.3.26

data/README.md

@@ -32,7 +32,7 @@ On the first execution we ask for your Linear API token. It will be
 stored in `~/.config/geordi/global.yml`.
 
 **Options**
-- `-m, [--from-master], [--no-from-master]`: Branch from master instead of the current branch
+- `-m, --from-main, [--from-master], [--no-from-master]`: Branch from master instead of the current branch
 
 
 ### `geordi capistrano COMMAND`
@@ -142,7 +142,8 @@ before it does it.** There are different scenarios where this command is handy:
   be skipped.
 
 Calling the command without arguments will infer the target stage from the
-current branch and fall back to master/staging.
+current branch and fall back to master/staging. (Will use the actual main branch
+of the repository, e.g. "main" instead of "master".)
 
 Finds available Capistrano stages by their prefix, e.g. `geordi deploy p` will
 deploy production, `geordi deploy mak` will deploy a `makandra` stage if there
@@ -267,29 +268,20 @@ variable like this: `PARALLEL_TEST_PROCESSORS=6 geordi rspec`
 Support for performing security updates.
 
 Preparation for security update: `geordi security-update`. Checks out production
-and pulls.
+and pulls, and will tell each step before performing it.
 
-After performing the update: `geordi security-update finish`. Switches branches,
-pulls, pushes and deploys as required by our workflow.
-
-This command tells what it will do before it does it. In detail:
+Part two after performing the update: `geordi security-update finish`. Switches
+branches, pulls, pushes and deploys as required by our workflow. This as well
+will tell each step before performing it. In detail:
 
 1. Ask user if tests are green
-
 2. Push production
-
 3. Check out master and pull
-
 4. Merge production and push in master
-
 5. Deploy staging, if there is a staging environment
-
 6. Ask user if deployment log is okay and staging application is still running
-
 7. Deploy other stages
-
 8. Ask user if deployment log is okay and application is still running on all stages
-
 9. Inform user about the next (manual) steps
 
 

data/lib/geordi/commands/branch.rb

@@ -6,7 +6,7 @@ On the first execution we ask for your Linear API token. It will be
 stored in `~/.config/geordi/global.yml`.
 LONGDESC
 
-option :from_master, aliases: '-m', type: :boolean, desc: 'Branch from master instead of the current branch'
+option :from_master, aliases: %w[-m --from-main], type: :boolean, desc: 'Branch from master instead of the current branch'
 
 def branch
   require 'geordi/gitlinear'

data/lib/geordi/commands/deploy.rb

@@ -19,7 +19,8 @@ before it does it.** There are different scenarios where this command is handy:
   be skipped.
 
 Calling the command without arguments will infer the target stage from the
-current branch and fall back to master/staging.
+current branch and fall back to master/staging. (Will use the actual main branch
+of the repository, e.g. "main" instead of "master".)
 
 Finds available Capistrano stages by their prefix, e.g. `geordi deploy p` will
 deploy production, `geordi deploy mak` will deploy a `makandra` stage if there
@@ -37,7 +38,7 @@ option :current_branch, aliases: '-c', type: :boolean,
 
 def deploy(target_stage = nil)
   # Set/Infer default values
-  branch_stage_map = { 'master' => 'staging', 'production' => 'production' }
+  branch_stage_map = { 'master' => 'staging', 'main' => 'staging', 'production' => 'production' }
   if target_stage && !Util.deploy_targets.include?(target_stage)
     # Target stage autocompletion from available stages
     target_stage = Util.deploy_targets.find { |t| t.start_with? target_stage }
@@ -58,7 +59,10 @@ def deploy(target_stage = nil)
     source_branch = target_branch = Util.current_branch
   else
     source_branch = Interaction.prompt 'Source branch:', Util.current_branch
-    target_branch = Interaction.prompt 'Deploy branch:', branch_stage_map.invert.fetch(target_stage, 'master')
+
+    deploy_branch = 'production' if target_stage == 'production'
+    deploy_branch ||= Util.git_default_branch
+    target_branch = Interaction.prompt 'Deploy branch:', deploy_branch
   end
 
   merge_needed = (source_branch != target_branch)

data/lib/geordi/commands/security_update.rb

@@ -1,33 +1,16 @@
 desc 'security-update [STEP]', 'Support for performing security updates'
 long_desc <<-LONGDESC
 Preparation for security update: `geordi security-update`. Checks out production
-and pulls.
+and pulls, and will tell each step before performing it.
 
-After performing the update: `geordi security-update finish`. Switches branches,
-pulls, pushes and deploys as required by our workflow.
-
-This command tells what it will do before it does it. In detail:
-
-1. Ask user if tests are green
-
-2. Push production
-
-3. Check out master and pull
-
-4. Merge production and push in master
-
-5. Deploy staging, if there is a staging environment
-
-6. Ask user if deployment log is okay and staging application is still running
-
-7. Deploy other stages
-
-8. Ask user if deployment log is okay and application is still running on all stages
-
-9. Inform user about the next (manual) steps
+Part two after performing the update: `geordi security-update finish`. Switches
+branches, pulls, pushes and deploys as required by our workflow. This as well
+will tell each step before performing it.
 LONGDESC
 
 def security_update(step = 'prepare')
+  master = Util.git_default_branch
+
   case step
   when 'prepare'
     Interaction.announce 'Preparing for security update'
@@ -56,11 +39,11 @@ def security_update(step = 'prepare')
     Interaction.note 'Working directory clean.'
     Interaction.prompt('Have you successfully run all tests?', 'n', /y|yes/) || Interaction.fail('Please run tests first.')
 
-    Interaction.note 'About to: push production, checkout & pull master, merge production, push master.'
+    Interaction.note "About to: push production, checkout & pull #{master}, merge production, push #{master}."
     Interaction.prompt('Continue?', 'n', /y|yes/) || Interaction.fail('Cancelled.')
 
     Util.run!('git push', show_cmd: true)
-    Util.run!('git checkout master', show_cmd: true)
+    Util.run!("git checkout #{master}", show_cmd: true)
     Util.run!('git pull', show_cmd: true)
     Util.run!('git merge production', show_cmd: true)
     Util.run!('git push', show_cmd: true)
@@ -106,5 +89,7 @@ def security_update(step = 'prepare')
     puts
     Interaction.note 'Now send an email to customer and project lead, informing them about the update.'
     Interaction.note 'Do not forget to make a joblog on a security budget, if available.'
+  else
+    Interaction.fail "Unsupported step #{step.inspect}"
   end
 end

data/lib/geordi/gitlinear.rb

@@ -31,11 +31,12 @@ module Geordi
       matching_local_branch = local_branches.find { |branch_name| branch_name == issue['branchName'] }
       matching_local_branch ||= local_branches.find { |branch_name| branch_name.include? issue['identifier'].to_s }
 
-      if matching_local_branch.nil?
-        Util.run! ['git', 'checkout', 'master'] if from_master
-        Util.run! ['git', 'checkout', '-b', issue['branchName']]
-      else
+      if matching_local_branch
         Util.run! ['git', 'checkout', matching_local_branch]
+      else
+        default_branch = Util.git_default_branch
+        Util.run! ['git', 'checkout', default_branch] if from_master
+        Util.run! ['git', 'checkout', '-b', issue['branchName']]
       end
     end
 
@@ -51,11 +52,7 @@ module Geordi
           `git branch --format="%(refname:short)"`
         end
 
-        if branch_list_string.strip.empty?
-          Interaction.fail 'Could not determine local Git branches.'
-        end
-
-        branch_list_string.split("\n")
+        branch_list_string.strip.split("\n")
       end
     end
 
@@ -64,42 +61,36 @@ module Geordi
         return dummy_issue_for_testing
       end
 
-      loading_message = 'Connecting to Linear ...'
-      print(loading_message)
       issues = fetch_linear_issues
-      reset_loading_message = "\r#{' ' * (loading_message.length + issues.length)}\r"
-
       if issues.empty?
-        print reset_loading_message
         Geordi::Interaction.fail('No issues to offer.')
       end
+      issues.sort_by! { |i| -i.dig('state', 'position') }
 
       highline.choose do |menu|
-        menu.header = 'Choose an issue'
+        max_label_length = 60
+        menu.header = 'Choose a started issue (ordered by state)'
 
         issues.each do |issue|
+          id = issue['identifier']
+          title = issue['title']
           state = issue['state']['name']
-          if issue['assignee']
-            assignee = issue['assignee']['name']
-            assignee_is_me = issue['assignee']['isMe']
-          else
-            assignee = "unassigned"
-            assignee_is_me = false
-          end
-
-          state += HighLine::BOLD if assignee_is_me
+          assignee = issue.dig('assignee', 'displayName') || 'unassigned'
 
-          label = "(#{assignee}, #{state}) #{issue['title']}"
-          label = bold(label) if assignee_is_me
+          label = "[#{id}] #{title}"
+          label = "#{label[0..(max_label_length - 5)]} ..." if label.length > max_label_length
+          label = HighLine::BLUE + HighLine::BOLD + label + HighLine::RESET if issue.dig('assignee', 'isMe')
+          label = "#{label} (#{assignee} / #{state})"
 
           menu.choice(label) { return issue }
         end
 
         menu.hidden('') { Interaction.fail('No issue selected.') }
-        print reset_loading_message # Once menu is build
       end
 
-      nil # Return nothing
+      # Selecting an issue will return that issue. If we ever get here, return
+      # nothing
+      nil
     end
 
     def dummy_issue_for_testing
@@ -143,11 +134,12 @@ module Geordi
               url
               branchName
               assignee {
-                name
+                displayName
                 isMe
               }
               state {
-               name
+                name
+                position
              }
             }
           }
@@ -159,7 +151,10 @@ module Geordi
 
     def query_api(attributes, variables)
       uri = URI(API_ENDPOINT)
+      loading_message = "Connecting to #{uri.host} ... "
+      clear_loading_message = "\r#{' ' * loading_message.length}\r"
 
+      print(loading_message)
       https = Net::HTTP.new(uri.host, uri.port)
       https.use_ssl = true
 
@@ -172,6 +167,7 @@ module Geordi
       request['Authorization'] = settings.linear_api_key
 
       response = https.request(request)
+      print clear_loading_message
 
       parsed_response = JSON.parse(response.body)[0]
       if parsed_response.key?('errors')
@@ -181,8 +177,5 @@ module Geordi
       end
     end
 
-    def bold(string)
-      HighLine::BOLD + string + HighLine::RESET
-    end
   end
 end

data/lib/geordi/interaction.rb

@@ -57,6 +57,8 @@ module Geordi
       input = default if input.empty? && default
 
       agreement_regex ? !!(input =~ agreement_regex) : input
+    rescue Interrupt
+      fail 'Cancelled.'
     end
 
   end

data/lib/geordi/settings.rb

@@ -62,8 +62,8 @@ module Geordi
 
       if team_ids.empty?
         Geordi::Interaction.warn 'No team id found.'
-        Interaction.note 'Please open a team in Linear, open the command menu with CTRL + K and choose'
-        Interaction.note "\"Copy model UUID\". Store that team id in #{LOCAL_SETTINGS_FILE_NAME}:"
+        puts 'Please open a team in Linear, open the command menu with CTRL + K and choose'
+        puts "\"Copy model UUID\". Store that team id in #{LOCAL_SETTINGS_FILE_NAME}:"
         puts 'linear_team_ids: abc-123-123-abc, def-456-456-def'
         exit 1
       end

data/lib/geordi/util.rb

@@ -116,7 +116,7 @@ module Geordi
 
       def current_branch
         if testing?
-          'master'
+          git_default_branch
         else
           `git rev-parse --abbrev-ref HEAD`.strip
         end
@@ -217,6 +217,18 @@ module Geordi
       def rspec_path?(path)
         %r{(^|\/)spec|_spec\.rb($|:)}.match?(path)
       end
+
+      def git_default_branch
+        default_branch = if testing?
+          ENV['GEORDI_TESTING_DEFAULT_BRANCH']
+        else
+          head_symref = `git ls-remote --symref origin HEAD`
+          head_symref[%r{\Aref: refs/heads/(\S+)\sHEAD}, 1]
+        end
+
+        default_branch || 'master'
+      end
+
     end
   end
 end

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '11.1.0'.freeze
+  VERSION = '11.2.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 11.1.0
+  version: 11.2.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -117,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Collection of command line tools we use in our daily work with Ruby, Rails