geordi 2.11.0 → 3.1.0

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,9 +6,8 @@ require 'pathname'
 
 module Geordi
   class Remote
-    include Geordi::Interaction
 
-    REMOTE_DUMP_PATH = '~/dumps/dump_for_download.dump'
+    REMOTE_DUMP_PATH = '~/dumps/dump_for_download.dump'.freeze
 
     def initialize(stage)
       @stage = stage
@@ -34,8 +33,8 @@ module Geordi
     def dump(options = {})
       # 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
+        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,17 +42,17 @@ 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}"
+      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
 
     def console(options = {})
-      shell(options.merge :remote_command => Util.console_command(@config.env))
+      shell(options.merge(remote_command: Util.console_command(@config.env)))
     end
 
     def shell(options = {})
@@ -62,8 +61,8 @@ module Geordi
       remote_command = "cd #{@config.remote_root} && #{@config.shell}"
       remote_command << " -c '#{options[:remote_command]}'" if options[:remote_command]
 
-      note 'Connecting to ' + server.to_s
-      Util.system! 'ssh', "#{ @config.user(server) }@#{ server }", '-t', remote_command
+      Interaction.note 'Connecting to ' + server.to_s
+      Util.system! 'ssh', "#{@config.user(server)}@#{server}", '-t', remote_command
     end
 
   end

data/lib/geordi/util.rb

@@ -4,29 +4,28 @@ 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
       # unnecessarily slow down all commands.
       # Thus, we have this handy method here.
-      def installing_missing_gems(&block)
+      def installing_missing_gems
         yield
       rescue LoadError => error
         error.message =~ /-- (\S+)\Z/
-        $1 or raise # could not extract a gem name from the error message, re-raise the error
+        Regexp.last_match(1) || raise # could not extract a gem name from the error message, re-raise the error
 
-        gem_name = $1.strip.split('/').first
+        gem_name = Regexp.last_match(1).strip.split('/').first
         install_command = 'gem install ' + gem_name
 
         # install missing gem
-        warn 'Probably missing gem: ' + gem_name
-        prompt('Install it now?', 'y', /y|yes/) or fail 'Missing Gems.'
-        system! install_command, :show_cmd => true
+        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,14 +38,14 @@ 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/) or fail('Cancelled.')
+          Interaction.prompt('Run this now?', 'n', /y|yes/) or Interaction.fail('Cancelled.')
         end
 
         if testing?
-          puts "Util.system! #{ commands.join ', ' }"
+          puts "Util.system! #{commands.join ', '}"
         else
           # Remove Geordi's Bundler environment when running commands.
           success = if !defined?(Bundler)
@@ -59,7 +58,7 @@ module Geordi
             Bundler.clean_system(*commands)
           end
 
-          success or fail(options[:fail_message] || 'Something went wrong.')
+          success || Interaction.fail(options[:fail_message] || 'Something went wrong.')
         end
       end
 
@@ -107,7 +106,7 @@ module Geordi
       # try to guess user's favorite cli text editor
       def decide_texteditor
         %w[/usr/bin/editor vi].each do |texteditor|
-          if cmd_exists? texteditor and texteditor.start_with? '$'
+          if cmd_exists?(texteditor) && texteditor.start_with?('$')
             return ENV[texteditor[1..-1]]
           elsif cmd_exists? texteditor
             return texteditor
@@ -116,19 +115,17 @@ module Geordi
       end
 
       # check if given cmd is executable. Absolute path or command in $PATH allowed.
-      def cmd_exists? cmd
+      def cmd_exists?(cmd)
         system("which #{cmd} > /dev/null")
-        return $?.exitstatus.zero?
+        $?.exitstatus.zero?
       end
 
       def is_port_open?(port)
-        begin
-          socket = TCPSocket.new('127.0.0.1', port)
-          socket.close
-          return true
-        rescue Errno::ECONNREFUSED
-          return false
-        end
+        socket = TCPSocket.new('127.0.0.1', port)
+        socket.close
+        true
+      rescue Errno::ECONNREFUSED
+        false
       end
 
       # splint lines e.g. read from a file into lines and clean those up
@@ -161,18 +158,20 @@ module Geordi
         nil
       end
 
-      def ruby_version
-        Gem::Version.new(RUBY_VERSION)
-      end
-
       def file_containing?(file, regex)
-        File.exists?(file) and File.read(file).scan(regex).any?
+        File.exist?(file) && File.read(file).scan(regex).any?
       end
 
       def testing?
         !!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 = '2.11.0'
+  VERSION = '3.1.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 2.11.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2020-05-04 00:00:00.000000000 Z
+date: 2020-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: '1'
 description: Collection of command line tools we use in our daily work with Ruby,
   Rails and Linux at makandra.
 email:
@@ -59,36 +59,24 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- bin/b
-- bin/cap-all
-- bin/console-for
-- bin/cuc
-- bin/cuc-show
-- bin/cuc-vnc-setup
-- bin/deploy-to-production
-- bin/dump-for
-- bin/dumple
-- bin/geordi
-- bin/gitpt
-- bin/launchy_browser
-- bin/load-dump
-- bin/migrate-all
-- bin/rs
-- bin/run_tests
-- bin/shell-for
-- bin/tests
-- features/commit.feature
-- features/console.feature
-- features/cucumber.feature
-- features/deploy.feature
-- features/dump.feature
-- features/firefox.feature
-- features/server.feature
-- features/setup.feature
-- features/shell.feature
-- features/support/env.rb
-- features/support/step_definitions/aruba_backport_steps.rb
-- features/support/step_definitions/miscellaneous_steps.rb
+- exe/b
+- exe/cap-all
+- exe/console-for
+- exe/cuc
+- exe/cuc-show
+- exe/cuc-vnc-setup
+- exe/deploy-to-production
+- exe/dump-for
+- exe/dumple
+- exe/geordi
+- exe/gitpt
+- exe/launchy_browser
+- exe/load-dump
+- exe/migrate-all
+- exe/rs
+- exe/run_tests
+- exe/shell-for
+- exe/tests
 - geordi.gemspec
 - lib/geordi.rb
 - lib/geordi/COMMAND_TEMPLATE
@@ -149,14 +137,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+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

data/features/commit.feature

@@ -1,17 +0,0 @@
-@ruby>=1.9
-Feature: Creating a git commit from a Pivotal Tracker story
-
-  Scenario: Extra arguments are forwarded to "git commit"
-    Given I have staged changes
-
-    When I run `geordi commit --extra-option` interactively
-      # No optional message
-      And I type ""
-    Then the output should contain "Util.system! git, commit, --allow-empty, -m, [#12] Test Story, --extra-option"
-
-
-  Scenario: With no staged changes, a warning is printed
-    When I run `geordi commit --allow-empty` interactively
-      # No optional message
-      And I type ""
-    Then the output should contain "> No staged changes. Will create an empty commit."

data/features/console.feature

@@ -1,7 +0,0 @@
-Feature: The console command
-  Most aspects of connection to a server are tested in shell feature.
-
-  Scenario: Opening a local Rails console
-    When I run `geordi console`
-    Then the output should contain "# Opening a local Rails console"
-      And the output should contain "Util.system! bundle exec rails console -e development"

data/features/cucumber.feature

@@ -1,261 +0,0 @@
-Feature: The cucumber command
-
-  Background:
-    Given a file named "config/cucumber.yml" with:
-    """
-    default: features
-    rerun: features
-    """
-
-
-  Scenario: Run a single feature
-    Given a file named "features/single.feature" with:
-    """
-    Feature: Running a single feature
-      Scenario: A single scenario
-    """
-
-    When I run `geordi cucumber features/single.feature`
-    Then the output should contain "# Running features"
-      And the output should contain "> Only: features/single.feature"
-      And the output should contain "Features green."
-    But the output should not contain "parallel"
-
-
-  Scenario: Multiple features are run in parallel
-    Given a file named "features/one.feature" with:
-    """
-    Feature: One
-      Scenario: One
-    """
-    And a file named "features/two.feature" with:
-    """
-    Feature: Two
-      Scenario: Two
-    """
-
-    When I run `geordi cucumber`
-    Then the output should contain "# Running features"
-      And the output should contain "> All features in features/"
-      And the output should contain "> Using parallel_tests"
-
-
-  Scenario: Rerunning tests until they pass
-    Given a file named "features/step_definitions/test_steps.rb" with:
-    """
-    Given /^this test fails$/ do
-      raise
-    end
-    """
-    And a file named "features/failing.feature" with:
-    """
-    Feature: Failing feature
-      Scenario: Failing scenario
-        And this test fails
-    """
-
-    When I run `geordi cucumber --rerun=2`
-    Then the output should contain "# Running features"
-      And the output should contain "# Rerun #1 of 2"
-      And the output should contain "# Rerun #2 of 2"
-      And the output should contain "Rerunning failed scenarios"
-      And the output should contain "Using the rerun profile"
-      And the exit status should be 1
-      And the output should contain "Features failed."
-
-
-  Scenario: A rerun should only consider the specified file
-    Note that we need a cucumber.yml to write the rerun.txt and read the rerun.txt for the reruns.
-
-    Given a file named "features/step_definitions/test_steps.rb" with:
-    """
-    Given /^this test fails$/ do
-      raise
-    end
-
-    Given /^I use puts with text "(.*)"$/ do |ann|
-      puts(ann)
-    end
-    """
-      And a file named "features/some.feature" with:
-      """
-      Feature: Failing feature
-        Scenario: Passing scenario
-          And I use puts with text "Running passing Feature"
-
-        Scenario: Failing scenario
-          And I use puts with text "Running failing Feature"
-          And this test fails
-      """
-      And an empty file named "tmp/rerun.txt"
-      And a file named "cucumber.yml" with:
-      """
-      <%
-      rerun_log = 'tmp/rerun.txt'
-      rerun_failures = File.file?(rerun_log) ? File.read(rerun_log).gsub("\n", ' ') : ''
-      log_failures = "--format=rerun --out=#{rerun_log}"
-      %>
-      default: features <%= log_failures %>
-      rerun: <%= rerun_failures %> <%= log_failures %>
-      """
-
-    When I run `geordi cucumber --rerun=1 features/some.feature`
-    Then the output should contain:
-    """
-    # Rerun #1 of 1
-    > Rerunning failed scenarios
-    > Run `geordi vnc` to view the Selenium test browsers
-
-    Using the rerun profile...
-
-    Running failing Feature
-    .F
-
-    (::) failed steps (::)
-
-     (RuntimeError)
-    features/some.feature:7:in `And this test fails'
-
-    Failing Scenarios:
-    cucumber -p rerun features/some.feature:5 # Scenario: Failing scenario
-    """
-
-
-  Scenario: Running all features in a given subfolder
-    Given a file named "features/sub/one.feature" with:
-    """
-    Feature: Testfeature
-    """
-    And a file named "features/sub/two.feature" with:
-    """
-    Feature: Testfeature
-    """
-
-    When I run `geordi cucumber features/sub`
-    Then the output should contain "> Only: features/sub/two.feature, features/sub/one.feature"
-      And the output should contain "> Using parallel_tests"
-
-
-  Scenario: Using the @solo tag
-
-    The cucumber command runs all features without the @solo tag. If any of the
-    specified .feature files contains '@solo', it boots Cucumber a second time
-    and runs only those of the features tagged with @solo.
-
-    Given a file named "features/no_solo.feature" with:
-    """
-    Feature: Test without solo tag
-      Scenario: This scenario can run in parallel
-    """
-    And a file named "features/solo.feature" with:
-    """
-    Feature: Solo test
-      @solo
-      Scenario: This scenario must NOT run in parallel
-    """
-
-    When I run `geordi cucumber --verbose features`
-    Then the output should contain "# Running @solo features"
-      And the output should match /^> .*cucumber .*--tags @solo/
-      And the output should contain "# Running features"
-      And the output should match /^> .*cucumber .*--tags \"~@solo\"/
-
-
-  Scenario: When there are no scenarios tagged @solo, the extra run is skipped
-    Given a file named "features/no_solo/one.feature" with:
-    """
-    Feature: Test without solo tag
-      Scenario: This scenario can run in parallel
-    """
-    And a file named "features/no_solo/two.feature" with:
-    """
-    Feature: A second test to provoke a parallel run
-      Scenario: Something
-    """
-    And a file named "features/solo.feature" with:
-    """
-    Feature: Solo test
-      @solo
-      Scenario: This scenario is not even run during this test
-    """
-
-    When I run `geordi cucumber features/no_solo --verbose`
-    Then the output should contain "# Running features"
-      And the output should match /^> .*features .*--tags \"~@solo\"/
-    But the output should not contain "# Running @solo features"
-
-
-  Scenario: When called with line numbers, the @solo extra run is skipped
-
-    Note that with line numbers in the passed file names, features are run
-    serially.
-
-    Given a file named "features/example.feature" with:
-    """
-    Feature: Test without solo tag
-      Scenario: Example scenario
-      Scenario: Other scenario
-    """
-
-    When I run `geordi cucumber --verbose features/example.feature:2`
-    Then the output should contain "# Running features"
-    But the output should not contain "# Running @solo features"
-      # Regression test, with line numbers grep would fail with:
-      #   grep: features/example.feature:2: No such file or directory
-      And the output should not contain "No such file or directory"
-
-
-  Scenario: It does not start the full test run when the @solo run fails
-    Given a file named "features/step_definitions/test_steps.rb" with:
-    """
-    Given 'this test fails' do
-      raise
-    end
-    """
-    And a file named "features/failing.feature" with:
-    """
-    Feature: Failing feature
-      @solo
-      Scenario: Failing scenario
-        And this test fails
-      Scenario: Other scenario
-    """
-
-    When I run `geordi cucumber`
-    Then the output should contain "# Running @solo features"
-      And the output should contain "Features failed."
-    But the output should not contain "# Running features"
-
-
-  Scenario: Specifying a firefox version to use
-    Given a file named "features/sub/one.feature" with:
-    """
-    Feature: Testfeature
-    """
-    And a file named ".firefox-version" with:
-    """
-    24.0
-    """
-
-    When I run `geordi cucumber --verbose`
-    Then the output should match /^> PATH=.*24.0:\$PATH.* features/
-
-
-  Scenario: Running all cucumber features matching a given string
-    Given a file named "features/given.feature" with "Feature: given"
-    And a file named "features/other.feature" with "Feature: other"
-
-    When I run `geordi cucumber --containing given`
-    Then the output should contain "Only: features/given.feature"
-    But the output should not contain "other.feature"
-
-
-  Scenario: Passing a format argument will skip the default format for a single run
-    Given a file named "features/single.feature" with:
-    """
-    Feature: Running a single feature
-      Scenario: A single scenario
-    """
-
-    When I run `geordi cucumber features/single.feature --format=pretty --verbose`
-    Then the output should contain "b cucumber features/single.feature --format pretty"