geordi 2.10.1 → 3.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e80ce0bcf572c2bcd331b2127371b3969c1b6ac02be617cdb6abb05686e6730
-  data.tar.gz: 270104330ccc177602ce0190508fb8079e166720e91d7c39e75e16cab880db60
+  metadata.gz: b149c149a52f1e02ca3573aa238d31d5a1fb9a018f2bdea2a19498d75282650e
+  data.tar.gz: 5bd2b8ddf0190307b93fab2081434fe05a7207c3b5105ec566eeb211d82532d0
 SHA512:
-  metadata.gz: f40138a830731675086cea816f8f21dfb0db4a4d93456def9077cf74d4297be5503af8698739ba9add26529308805cc560e0bf55d0fa5d9c064dabc42d60a98d
-  data.tar.gz: 8c139434e23cc7ef57a8779f2a3dfab60e3d42991e11c221672b26964003d84e7b3bf41d08332a3992ebf0512e00888584b87355f225e4f5e882d3599cb5665d
+  metadata.gz: 6a607dcb1475b70f9053c4fe950f8ee6fa2d657b0c6771b514c3356ac28c8f2704be396cfc2f19b8990edd3dc67dfdc7dad1a92344947c23fa30e72cf7a4564c
+  data.tar.gz: d499c7936be74a6eb30f14287b0af2fd44dd89e6bc2dd4db772e6b7a0450f8013df200604027a95fd4808a32f3b860760876e40e0af5b7d9427c1c3cb8646e6f

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 .DS_Store
 .pt_project_id
 tmp
+.byebug_history

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.0.0

data/.travis.yml

@@ -1,8 +1,13 @@
 language: ruby
 
 rvm:
-  - '1.8.7'
-  - '2.6.3'
+  - '2.0.0'
+  - '2.1.10'
+  - '2.2.10'
+  - '2.3.8'
+  - '2.4.10'
+  - '2.5.8'
+  - '2.6.6'
 
 gemfile:
   - 'Gemfile'
@@ -10,6 +15,7 @@ gemfile:
 dist: trusty
 
 install:
+  - gem install bundler:1.17.3
   # Replace default Travis CI bundler script with a version that doesn't
   # explode when lockfile doesn't match recently bumped version
   - bundle install --no-deployment --jobs=3 --retry=3 --path=${BUNDLE_PATH:-vendor/bundle}

data/CHANGELOG.md

@@ -5,7 +5,53 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 
 ## Unreleased
+
+### Compatible changes
+
+### Breaking changes
+
+
+## 3.0.3 2020-05-27
+
+### Compatible changes
+
+- Fix #98: Changing the `config/database.yml` reader from `YAML.load` to `YAML.safe_load` dropped the support for aliases. We now allow aliases and the classes `Time` and `Symbol`. If we encounter further issues with this approach a revert to `YAML.load` would be an option, too.
+
+
+## 3.0.2 2020-05-18
+
+### Compatible changes
+
+- Fix #95: Method change from `! *.include?` to `*.exclude?` was not valid as we do not have active support in Geordi. Affected commands where `geordi cucumber` and `geordi deploy`.
+
+### Breaking changes
+
+
+## 3.0.1 2020-05-13
+
+### Compatible changes
+- Fix #93: Using `$CHILDSTATUS` instead of `$?` did not work properly. This affected commands like `geordi drop-databases` to fail.
+- Fix #92: Geordi fail messages were converted to exceptions by accident. Now they are printed as red error message without the backtrace again.
+
+
+## 3.0.0 2020-05-04
+
 ### Compatible changes
+
+### Breaking changes
+- Remove support for Ruby 1.8.7 and Ruby 1.9.3. Bug fixes might still be backported to 2.x, but we will not add any features to 2.x anymore. Please consider to upgrade the Ruby version of your project.
+
+
+## 2.11.0 2020-05-04
+
+### Compatible changes
+- Added the possibility to change the Rails root for the capistrano config via the environment variable `RAILS_ROOT`. This allows you as a gem developer to run a command like `RAILS_ROOT=~/Projects/my-blog geordi console staging` whereas `geordi` uses the capistrano config from `my-blog`. Otherwise you would need to follow the instructions of [this card](https://makandracards.com/makandra/46617-how-to-use-a-local-gem-in-your-gemfile) to test changes in the gem locally.
+- Bug fix for "no staged changes" even if there are changes present (#83).
+- Fixed deprecation warning for `Thor exit with status 0 on errors` (#84).
+- Replaced `Bundler.with_unbundled_env` with `Bundler.with_original_env` (#77). This is a better replacement than 42cd1c4.
+- Add deprecation warning `Deprecation warning: Ruby 1.8.7 and 1.9.3 support will be dropped in Geordi 3.x.` to Geordi 2.
+- Fix error `thor requires Ruby version >= 2.0.0` for Ruby 1.8.7 and 1.9.3 (https://github.com/makandra/geordi/issues/79#issuecomment-598664191).
+
 ### Breaking changes
 
 

data/Gemfile

@@ -8,8 +8,5 @@ gem 'rspec-mocks'
 gem 'highline'
 gem 'parallel_tests'
 gem 'launchy'
-
-if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('1.8.7')
-  gem 'pry'
-  gem 'tracker_api'
-end
+gem 'pry'
+gem 'tracker_api'

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    geordi (2.10.1)
-      thor (>= 0.18.0)
+    geordi (3.0.3)
+      thor (~> 1)
 
 GEM
   remote: http://rubygems.org/
@@ -34,10 +34,10 @@ GEM
       thread_safe (~> 0.3, >= 0.3.1)
     diff-lcs (1.2.5)
     equalizer (0.0.11)
-    excon (0.67.0)
-    faraday (0.17.0)
+    excon (0.73.0)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    faraday_middleware (0.13.1)
+    faraday_middleware (0.14.0)
       faraday (>= 0.7.4, < 1.0)
     gherkin (2.12.2)
       multi_json (~> 1.3)
@@ -45,17 +45,17 @@ GEM
     ice_nine (0.11.2)
     launchy (2.4.3)
       addressable (~> 2.3)
-    method_source (0.9.2)
-    mimemagic (0.3.3)
+    method_source (1.0.0)
+    mimemagic (0.3.4)
     multi_json (1.13.1)
     multi_test (0.1.2)
     multipart-post (2.1.1)
     parallel (0.5.16)
     parallel_tests (0.6.18)
       parallel
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rake (10.5.0)
     representable (3.0.4)
       declarative (< 0.1.0)

data/README.md

@@ -378,6 +378,14 @@ browser, as opposed to opening it within the VNC window.
 Contributing
 ============
 
+* Run the tests for the oldest supported ruby version with `bundle exec rake`. Ensure that all other ruby versions in the `travis.yml` pass as well after pushing your feature branch and triggering the travis build.
+* Update this `README`. The whole `geordi` section is auto-generated
+  by `rake readme`.
+* Document your changes in the `CHANGELOG.md` file.
+
+Adding a new command
+---------------
+
 Copy `lib/geordi/COMMAND_TEMPLATE` to `lib/geordi/commands/your_command` and
 edit it to do what you need it to do. Usually, it is hard to automatedly test
 Geordi commands, so make sure you've manually tested it. You can do so by
@@ -385,9 +393,6 @@ calling your local geordi like so (adjust paths to your needs):
 
     # @option -I: add directory to load path
     ruby -I ../geordi/lib ../geordi/bin/geordi <command>
-
-Don't forget to update this README. The whole `geordi` section is auto-generated
-by `rake readme`. Also remember to add your changes to the CHANGELOG.
-
-Geordi is (partially) tested with Cucumber and Aruba. Run `bundle exec rake` to test the gem against you current Ruby
-version. The `travis.yml` contains all Ruby versions the gem is and needs to be tested with.
+    
+    # with debugger
+    ruby -r byebug -I ../geordi/lib ../geordi/bin/geordi <command>

data/Rakefile

@@ -2,18 +2,14 @@ require 'bundler'
 Bundler::GemHelper.install_tasks
 
 desc 'Default: Run all tests'
-task :default => :features
+task default: :features
 
 task :features do
-  if Gem::Version.new(RUBY_VERSION) > Gem::Version.new('1.8.7')
-    system 'bundle exec cucumber'
-  else
-    system 'bundle exec cucumber --tags "~@ruby>=1.9"'
-  end
+  system 'bundle exec cucumber'
 end
 
 task :readme do
-  require File.expand_path('../lib/geordi/cli', __FILE__)
+  require File.expand_path('lib/geordi/cli', __dir__)
 
   readme = File.read('README.md')
   geordi_section_regex = /
@@ -43,9 +39,9 @@ For details on commands, e.g. supported options, you may always run
 
   Geordi::CLI.all_commands.sort.each do |_, command|
     unless command.hidden?
-      geordi_section << "### `geordi #{ command.usage }`\n\n"
-      geordi_section << "#{ command.description.sub /(\.)?$/, '.' }\n\n"
-      geordi_section << "#{ command.long_description.strip }\n\n" if command.long_description
+      geordi_section << "### `geordi #{command.usage}`\n\n"
+      geordi_section << "#{command.description.sub /(\.)?$/, '.'}\n\n"
+      geordi_section << "#{command.long_description.strip}\n\n" if command.long_description
       geordi_section << "\n"
     end
   end

data/geordi.gemspec

@@ -1,28 +1,31 @@
-# -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "geordi/version"
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'geordi/version'
 
-Gem::Specification.new do |s|
-  s.name        = "geordi"
-  s.version     = Geordi::VERSION
-  s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Henning Koch"]
-  s.email       = ["henning.koch@makandra.de"]
-  s.homepage    = "http://makandra.com"
-  s.summary     = 'Collection of command line tools we use in our daily work with Ruby, Rails and Linux at makandra.'
-  s.description = 'Collection of command line tools we use in our daily work with Ruby, Rails and Linux at makandra.'
-  s.license     = 'MIT'
+Gem::Specification.new do |spec|
+  spec.name = 'geordi'
+  spec.version = Geordi::VERSION
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.authors = ['Henning Koch']
+  spec.email = ['henning.koch@makandra.de']
 
-  s.rubyforge_project = "geordi"
+  spec.summary = 'Collection of command line tools we use in our daily work with Ruby, Rails and Linux at makandra.'
+  spec.description = 'Collection of command line tools we use in our daily work with Ruby, Rails and Linux at makandra.'
+  spec.homepage = 'http://makandra.com'
+  spec.license = 'MIT'
 
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r(^exe/)) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
 
-  s.add_runtime_dependency 'thor', '>= 0.18.0'
+  spec.add_runtime_dependency 'thor', '~> 1'
 
-  s.post_install_message = <<-ATTENTION
+  spec.post_install_message = <<-ATTENTION
 * Binary `geordi` installed
   ATTENTION
 end

data/lib/geordi/COMMAND_TEMPLATE

@@ -15,17 +15,15 @@ by `rake update_readme`. Thus, please format descriptions in a way that's reader
 friendly both in Markdown and the console.
 LONGDESC
 
-option :opt, :type => :boolean, :aliases => '-o', :banner => 'VALUE_NAME',
-       :desc => 'If set, VALUE_NAME will be used for something'
+option :opt, type: :boolean, aliases: '-o', banner: 'VALUE_NAME', desc: 'If set, VALUE_NAME will be used for something'
 
 def example
   # Invoke other commands like this:
-  invoke_cmd 'other_command', 'argument', :an => 'option'
+  invoke_cmd 'other_command', 'argument', an: 'option'
 
-  fail 'Option missing' unless options.opt?
+  Interaction.fail 'Option missing' unless options.opt?
 
-  # For formatted output, see geordi/interaction.rb
-  success 'Done.'
+  Interaction.success 'Done.'
 end
 
 # Command mappings, usually not needed

data/lib/geordi/capistrano_config.rb

@@ -10,8 +10,8 @@ module Geordi
     end
 
     def user(server)
-      cap2user = deploy_info[ /^\s*set\s*:user,\s*['"](.*?)['"]/, 1 ]
-      cap2user || deploy_info[ /^\s*server\s*['"]#{ server }['"],.*user.{1,4}['"](.*?)['"]/m, 1 ]
+      cap2user = deploy_info[/^\s*set\s*:user,\s*['"](.*?)['"]/, 1]
+      cap2user || deploy_info[/^\s*server\s*['"]#{server}['"],.*user.{1,4}['"](.*?)['"]/m, 1]
     end
 
     def servers
@@ -26,11 +26,11 @@ module Geordi
     end
 
     def remote_root
-      File.join deploy_info[ /^\s*set\s*:deploy_to,\s*['"](.*?)['"]/, 1 ], 'current'
+      File.join deploy_info[/^\s*set\s*:deploy_to,\s*['"](.*?)['"]/, 1], 'current'
     end
 
     def env
-      deploy_info[ /^\s*set\s*:rails_env,\s*['"](.*?)['"]/, 1 ]
+      deploy_info[/^\s*set\s*:rails_env,\s*['"](.*?)['"]/, 1]
     end
 
     def shell
@@ -45,26 +45,29 @@ module Geordi
       self.deploy_info = ''
 
       if stage
-        deploy_info << File.read(File.join root, "config/deploy/#{ stage }.rb")
+        deploy_info << File.read(File.join(root, "config/deploy/#{stage}.rb"))
         deploy_info << "\n"
       end
 
-      deploy_info << File.read(File.join root, 'config/deploy.rb')
+      deploy_info << File.read(File.join(root, 'config/deploy.rb'))
     end
 
     def find_project_root!
-      current = Dir.pwd
-      until File.exists?('Capfile')
-        Dir.chdir '..'
-        raise <<-ERROR if current == Dir.pwd
-Could not locate Capfile.
-
-Are you calling me from within a Rails project?
-Maybe Capistrano is not installed in this project.
-        ERROR
-
-        current = Dir.pwd
+      current = ENV['RAILS_ROOT'] || Dir.pwd
+
+      until File.exist?(File.join(current, 'Capfile'))
+        if current == '/' || current == '/home' || !File.directory?(current)
+          raise <<-ERROR
+  Could not locate Capfile.
+
+  Are you calling me from within a Rails project?
+  Maybe Capistrano is not installed in this project.
+          ERROR
+        else
+          current = File.dirname(current)
+        end
       end
+
       current
     end
 

data/lib/geordi/chromedriver_updater.rb

@@ -4,14 +4,13 @@ require 'tempfile'
 
 module Geordi
   class ChromedriverUpdater
-    include Geordi::Interaction
 
     def run
       chrome_version = determine_chrome_version
       chromedriver_version = determine_chromedriver_version
 
       if skip_update?(chrome_version, chromedriver_version)
-        warn("No update required, you are using for both executables the same version #{chrome_version}!")
+        Interaction.warn("No update required, you are using for both executables the same version #{chrome_version}!")
       else
         chromedriver_zip = download_chromedriver(chrome_version)
         unzip(chromedriver_zip, File.expand_path('~/bin'))
@@ -19,7 +18,7 @@ module Geordi
         chromedriver_zip.unlink
 
         # We need to determine the version again, as it could be nil in case no chromedriver was installed before
-        note "Chromedriver updated to version #{determine_chromedriver_version}"
+        Interaction.note "Chromedriver updated to version #{determine_chromedriver_version}"
       end
     end
 
@@ -27,12 +26,12 @@ module Geordi
 
     def determine_chrome_version
       stdout_str, _error_str, status = Open3.capture3('google-chrome', '--version')
-      chrome_version = if !stdout_str.nil?
+      chrome_version = unless stdout_str.nil?
         stdout_str[/\AGoogle Chrome (\d+)/, 1]
       end
 
       if !status.success? || chrome_version.nil?
-        fail('Could not determine the current Google Chrome version')
+        Interaction.fail('Could not determine the current Google Chrome version')
       else
         chrome_version.to_i
       end
@@ -42,12 +41,12 @@ module Geordi
       return unless Open3.capture2('which chromedriver')[1].success?
 
       stdout_str, _error_str, status = Open3.capture3('chromedriver', '-v')
-      chromedriver_version = if !stdout_str.nil?
+      chromedriver_version = unless stdout_str.nil?
         stdout_str[/\AChromeDriver (\d+)/, 1]
       end
 
       if !status.success? || chromedriver_version.nil?
-        fail('Could not determine the current chromedriver version')
+        Interaction.fail('Could not determine the current chromedriver version')
       else
         chromedriver_version.to_i
       end
@@ -69,7 +68,7 @@ module Geordi
 
         file
       else
-        fail("Could not download chromedriver version #{latest_version}")
+        Interaction.fail("Could not download chromedriver version #{latest_version}")
       end
     end
 
@@ -80,7 +79,7 @@ module Geordi
       if response.is_a?(Net::HTTPSuccess)
         response.body.to_s
       else
-        fail("Could not find the latest version for Google Chrome version #{chrome_version}")
+        Interaction.fail("Could not find the latest version for Google Chrome version #{chrome_version}")
       end
     end
 
@@ -88,7 +87,7 @@ module Geordi
       _stdout_str, _error_str, status = Open3.capture3('unzip', '-d', output_dir, '-o', zip.path)
 
       unless status.success?
-        fail("Could not unzip #{zip.path}")
+        Interaction.fail("Could not unzip #{zip.path}")
       end
     end
   end