geordi 5.3.0 → 5.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 693551524b9b50f70e2daf649cd8184cc197b1576153beaf675ebaae01a88e84
-  data.tar.gz: 915a4c3e1449f0883e31bd828a850354db26bcdcf57523ffdf28ade6e51bee1e
+  metadata.gz: 87cda39f50721b8821dc5042de4a4ead24b4f8a27d5601bcb1742aa5f1a7cd00
+  data.tar.gz: baf33c3c575963062318374024cfae1071dd1002aaebbdd1c353cc7dc8c4c0c0
 SHA512:
-  metadata.gz: bcbd43ffb224b54a7ba553c6bbcab6931d06b15df4a5e2e3eb9a93fe019187df47174bb2b61030a54d2408fb80235a1937eae7ff0a0f3c17e58756d3cbfc94b0
-  data.tar.gz: 03ef92df5d677f51ee70bec10bf035034824980b5c16c15c38e587de5b2a2cf683ddbce64067695e566fc9ee207d26af6f1986d909210b9fda61d9570bb91add
+  metadata.gz: 0a66597a85f305bf90bf01ec56f0141ad4c3a7fcbd4d21032e8a7f64b2b5fece841e37084c8f783d7f8b9269e484d4cd7d6b35523435b032d67e472125c14043
+  data.tar.gz: 74954d6cf80dc9dea5b3f8d233fa2f2c2cb0c65fb229c385b96cb202f667dfdab14a1fd32212f3a168658cbeacbe4a279300a6a6fbcb9eee44f91a85b5da241f

data/CHANGELOG.md

@@ -1,14 +1,26 @@
 # 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).
 
+
 ## Unreleased
 
 ### Compatible changes
+
 ### Breaking changes
 
+
+## 5.4.0 2021-02-01
+
+### Compatible changes
+* Add `geordi branch` command that checks out a feature branch based on a story from Pivotal Tracker
+* Faster MySQL dumping with [`--single-transaction` and `--quick`](https://dev.mysql.com/doc/refman/5.7/en/mysqldump.html#option_mysqldump_single-transaction)
+* Allow pivotal tracker ids in the global config file
+* Fix missing require for `Fileutils` in the dump load command (#145)
+* Document `PARALLEL_TEST_PROCESSORS`
+
+
 ## 5.3.0 2021-02-01
 
 ### Compatible changes

data/README.md

@@ -25,6 +25,15 @@ You can always run `geordi help <command>` to quickly look up command help.
 Enable the given virtual host, disabling all others.
 
 
+### `geordi branch`
+Check out a feature branch based on a story from Pivotal Tracker.
+
+Example: `geordi branch`
+
+On the first execution we ask for your Pivotal Tracker API token. It will be
+stored in `~/.config/geordi/global.yml`.
+
+
 ### `geordi capistrano COMMAND`
 Run a capistrano command on all deploy targets.
 
@@ -100,6 +109,9 @@ sign, i.e. have each option a contiguous string.
 headless test browser anyway, you can disable VNC by setting `use_vnc: false`
 in `.geordi.yml` in the project root.
 
+- In order to limit processes in a parallel run, you can set an environment
+  variable like this: `PARALLEL_TEST_PROCESSORS=6 geordi cucumber`
+
 **Options**
 - `-m, [--modified], [--no-modified]`: Run all modified features
 - `-c, [--containing=STRING]`: Run all features that contain STRING
@@ -281,7 +293,10 @@ Run RSpec.
 
 Example: `geordi rspec spec/models/user_spec.rb:13`
 
-Runs RSpec with RSpec 1/2 support, parallel_tests detection and `bundle exec`.
+Runs RSpec with version 1/2 support, parallel_tests detection and `bundle exec`.
+
+In order to limit processes in a parallel run, you can set an environment
+variable like this: `PARALLEL_TEST_PROCESSORS=6 geordi rspec`
 
 
 ### `geordi security-update [STEP]`

data/exe/dumple

@@ -78,6 +78,13 @@ begin
     command << " -p\"#{config['password']}\""
     command << " #{config['database']}"
     command << " -r #{dump_path}"
+    # Using a transaction to allow concurrent request while creating a dump.
+    # This works only reliable for InnoDB tables.
+    # More details: https://dev.mysql.com/doc/refman/5.7/en/mysqldump.html#option_mysqldump_single-transaction
+    command << ' --single-transaction'
+    # Disable buffering in memory to avoid a memory overflow for large tables
+    # More details https://dev.mysql.com/doc/refman/5.7/en/mysqldump.html#option_mysqldump_quick
+    command << ' --quick'
     if port
       command << " -h#{host || '127.0.0.1'} -P#{port}"
     else

data/lib/geordi/commands/branch.rb

@@ -0,0 +1,12 @@
+desc 'branch', 'Check out a feature branch based on a story from Pivotal Tracker'
+long_desc <<-LONGDESC
+Example: `geordi branch`
+
+On the first execution we ask for your Pivotal Tracker API token. It will be
+stored in `~/.config/geordi/global.yml`.
+LONGDESC
+
+def branch
+  require 'geordi/gitpt'
+  Gitpt.new.run_branch
+end

data/lib/geordi/commands/commit.rb

@@ -10,5 +10,5 @@ LONGDESC
 
 def commit(*git_args)
   require 'geordi/gitpt'
-  Gitpt.new.run(git_args)
+  Gitpt.new.run_commit(git_args)
 end

data/lib/geordi/commands/cucumber.rb

@@ -20,6 +20,9 @@ sign, i.e. have each option a contiguous string.
 - *VNC:* By default, test browsers will run in a VNC session. When using a
 headless test browser anyway, you can disable VNC by setting `use_vnc: false`
 in `.geordi.yml` in the project root.
+
+- In order to limit processes in a parallel run, you can set an environment
+  variable like this: `PARALLEL_TEST_PROCESSORS=6 geordi cucumber`
 LONGDESC
 
 option :modified, aliases: '-m', type: :boolean,

data/lib/geordi/commands/dump.rb

@@ -57,6 +57,9 @@ def dump(target = nil, *_args)
       Interaction.announce "Sourcing dump into the #{loader.config['database']} db"
       loader.load
 
+      Util.run! "rm #{dump_path}"
+      Interaction.note "Dump file removed"
+
       Interaction.success "Your #{loader.config['database']} database has now the data of #{target}#{database_label}."
     end
   end

data/lib/geordi/commands/rspec.rb

@@ -2,7 +2,10 @@ desc 'rspec [FILES]', 'Run RSpec'
 long_desc <<-LONGDESC
 Example: `geordi rspec spec/models/user_spec.rb:13`
 
-Runs RSpec with RSpec 1/2 support, parallel_tests detection and `bundle exec`.
+Runs RSpec with version 1/2 support, parallel_tests detection and `bundle exec`.
+
+In order to limit processes in a parallel run, you can set an environment
+variable like this: `PARALLEL_TEST_PROCESSORS=6 geordi rspec`
 LONGDESC
 
 def rspec(*files)

data/lib/geordi/dump_loader.rb

@@ -57,11 +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)}"
-
-      Interaction.announce 'Clean up'
-      Interaction.note 'Removing: ' + dump_file
-      Util.run!("rm #{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,170 @@
-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}"
+
+      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
+
+    def load_projects
+      project_ids = settings.pivotal_tracker_project_ids
+      project_ids.collect { |project_id| client.project(project_id) }
+    end
 
-  def choose_story
-    if Geordi::Util.testing?
-      return OpenStruct.new(id: 12, name: 'Test Story')
+    def applicable_stories
+      projects = load_projects
+      projects.collect do |project|
+        project.stories(filter: 'state:started,finished,rejected')
+      end.flatten
     end
 
-    loading_message = 'Connecting to Pivotal Tracker ...'
-    print(loading_message)
-    stories = applicable_stories
-    reset_loading_message = "\r#{' ' * (loading_message.length + stories.length)}\r"
+    def choose_story
+      if Util.testing?
+        return OpenStruct.new(id: 12, name: 'Test Story')
+      end
+
+      loading_message = 'Connecting to Pivotal Tracker ...'
+      print(loading_message)
+      stories = applicable_stories
+      reset_loading_message = "\r#{' ' * (loading_message.length + stories.length)}\r"
+
+      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?(client.me.id)
 
-    highline.choose do |menu|
-      menu.header = 'Choose a story'
+          if state == 'started'
+            state = HighLine::GREEN + state + HighLine::RESET
+          elsif state != 'finished'
+            state = HighLine::RED + state + HighLine::RESET
+          end
 
-      stories.each do |story|
-        print '.' # Progress
+          state += HighLine::BOLD if owner_is_me
 
-        state = story.current_state
-        owners = story.owners
-        owner_is_me = owners.collect(&:id).include?(client.me.id)
+          label = "(#{owners.collect(&:name).join(', ')}, #{state}) #{story.name}"
+          label = bold(label) if owner_is_me
 
-        if state == 'started'
-          state = HighLine::GREEN + state + HighLine::RESET
-        elsif state != 'finished'
-          state = HighLine::RED + state + HighLine::RESET
+          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 != ''
+
+      Util.run!(['git', 'commit', '--allow-empty', '-m', message, *git_args])
+    end
 
-        menu.choice(label) { return story }
+    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/remote.rb

@@ -3,6 +3,7 @@ require 'geordi/interaction'
 require 'geordi/util'
 require 'highline/import'
 require 'pathname'
+require 'fileutils'
 
 module Geordi
   class Remote

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 ].freeze
+    ALLOWED_GLOBAL_SETTINGS = %w[ pivotal_tracker_api_key auto_update_chromedriver pivotal_tracker_project_ids ].freeze
     ALLOWED_LOCAL_SETTINGS = %w[ use_vnc pivotal_tracker_project_ids ].freeze
 
     def initialize
@@ -42,18 +42,13 @@ module Geordi
     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
@@ -160,5 +155,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

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '5.3.0'.freeze
+  VERSION = '5.4.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 5.3.0
+  version: 5.4.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-01 00:00:00.000000000 Z
+date: 2021-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -57,6 +57,7 @@ files:
 - lib/geordi/cli.rb
 - lib/geordi/commands/_setup_vnc.rb
 - lib/geordi/commands/apache_site.rb
+- lib/geordi/commands/branch.rb
 - lib/geordi/commands/bundle_install.rb
 - lib/geordi/commands/capistrano.rb
 - lib/geordi/commands/chromedriver_update.rb
@@ -118,7 +119,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Collection of command line tools we use in our daily work with Ruby, Rails