geordi 0.18.0 → 1.0.0

data/lib/geordi/firefox_for_selenium.rb

@@ -1,15 +1,17 @@
 require 'pathname'
+require 'tempfile'
 
 module Geordi
   module FirefoxForSelenium
+    include Geordi::Interaction
 
     FIREFOX_FOR_SELENIUM_BASE_PATH = Pathname.new('~/bin/firefoxes').expand_path
     FIREFOX_FOR_SELENIUM_PROFILE_NAME = 'firefox-for-selenium'
     DEFAULT_FIREFOX_VERSION = "5.0.1"
     VERSION_SPECIFICATION_FILE = Pathname.new(".firefox-version")
 
-    def self.install
-      Installer.new.run
+    def self.install(version)
+      Installer.new(version).run
     end
 
     def self.path_from_config
@@ -33,6 +35,7 @@ module Geordi
 
 
     class PathFromConfig
+      include Geordi::Interaction
 
       def run
         unless system_firefox
@@ -57,23 +60,26 @@ module Geordi
       end
 
       def default_version
-        puts "No firefox version given, defaulting to #{DEFAULT_FIREFOX_VERSION}."
-        puts "Specify a version by putting it in a file named \"#{VERSION_SPECIFICATION_FILE}\"."
+        warn "No firefox version given, defaulting to #{DEFAULT_FIREFOX_VERSION}."
+        note "Specify a version by putting it in a file named \"#{VERSION_SPECIFICATION_FILE}\"."
         puts
         DEFAULT_FIREFOX_VERSION
       end
 
       def validate_install
         unless FirefoxForSelenium.binary(@version).exist?
-          puts "Firefox #{@version} not found."
-          puts "Install it with"
-          puts "  setup-firefox-for-selenium #{@version}"
-          puts
-          puts "If you want to use your system firefox and not see this message, add"
-          puts "a \".firefox-version\" file with the content \"system\"."
-          puts
-          puts "Press ENTER to continue or press CTRL+C to abort."
-          $stdin.gets
+          note "Firefox #{@version} not found."
+
+          puts left(<<-INSTRUCTIONS)
+          Install it with
+            geordi setup_firefox_for_selenium #{@version}
+
+          If you want to use your system firefox and not see this message, add
+          a .firefox-version file with the content "system".
+
+          INSTRUCTIONS
+
+          wait "Press ENTER to continue or press CTRL+C to abort."
         end
       end
 
@@ -85,9 +91,13 @@ module Geordi
 
 
     class Installer
+      include Geordi::Interaction
+
+      def initialize(version)
+        @version = version
+      end
 
       def run
-        parse_version
         say_hello
         check_if_run_before
         download_firefox
@@ -108,12 +118,6 @@ module Geordi
         execute_command("PATH=#{path}:$PATH firefox #{args}")
       end
 
-      def die(message)
-        puts message
-        puts
-        exit(1)
-      end
-
       def path
         FirefoxForSelenium.path(@version)
       end
@@ -130,64 +134,71 @@ module Geordi
         FirefoxForSelenium.binary(@version, "firefox-original")
       end
 
-      def parse_version
-        @version = ARGV.pop
-        @version or die("Usage: setup_firefox_for_selenium VERSION")
-      end
-
       def say_hello
         execute_command('clear')
-        puts "Whenever Firefox updates, Selenium breaks. This is annoying."
-        puts "This script will help you create an unchanging version of Firefox for your Selenium tests."
-        puts
-        puts "In particular, this new copy of Firefox will have the following properties:"
-        puts
-        puts "- It won't update itself with a newer version"
-        puts "- It can co-exist with your regular Firefox installation (which you can update at will)"
-        puts "- It will use a profile separate from the one you use for regular Firefox browsing"
-        puts "- It will not try to re-use existing Firefox windows"
-        puts "- It will automatically be used for your Selenium scenarios if you run your Cucumber using the cuc binary from the geordi gem."
-        puts "- It will live in #{path}"
-        puts
-        puts "Press ENTER when you're ready to begin."
-        gets
+
+        puts left(<<-HELLO)
+        Whenever Firefox updates, Selenium breaks. This is annoying. This
+        script will help you create an unchanging version of Firefox for your
+        Selenium tests.
+
+        In particular, this new copy of Firefox will have the following
+        properties:
+
+        - It won't update itself with a newer version
+        - It can co-exist with your regular Firefox installation (which you can
+          update at will)
+        - It will use a profile separate from the one you use for regular
+          Firefox browsing
+        - It will not try to re-use existing Firefox windows
+        - It will automatically be used for your Selenium scenarios if you run
+          your Cucumber using the cuc binary from the geordi gem.
+        - It will live in #{path}
+
+        HELLO
+
+        wait "Press ENTER when you're ready to begin."
       end
 
       def check_if_run_before
         if original_binary.exist?
-          puts "This version seems to be already installed."
+          note 'This version seems to be already installed.'
           puts
-          puts "Press ENTER to continue anyway or press CTRL+C to abort."
-          gets
+          wait 'Press ENTER to continue anyway or press CTRL+C to abort.'
         end
       end
 
       def download_firefox
         path.mkpath
-        puts "Please download an old version of Firefox from #{download_url} and unpack it to #{path}."
-        puts "Don't create an extra #{path.join("firefox")} directory."
-        puts
-        puts "Press ENTER when you're done."
-        gets
+
+        puts left(<<-INSTRUCTION)
+        Please download an old version of Firefox from: #{download_url}
+        Unpack it with: tar xvjf firefox-#{@version}.tar.bz2 -C #{path} --strip-components=1
+        Now #{path.join('firefox')} should be the firefox binary, not a directory.
+
+        INSTRUCTION
+        wait "Press ENTER when you're done."
+
         File.file?(binary) or raise "Could not find #{binary}"
       end
 
       def create_separate_profile
-        puts "Creating a separate profile named '#{FIREFOX_FOR_SELENIUM_PROFILE_NAME}' so your own profile will be safe..."
-        # don't use the patched firefox binary for this, we don't want to give a -p parameter here
+        note "Creating a separate profile named '#{FIREFOX_FOR_SELENIUM_PROFILE_NAME}' so your own profile will be safe..."
+        # don't use the patched firefox binary for this, we don't want to give
+        # a -p option here
         execute_command("PATH=#{path}:$PATH firefox -no-remote -CreateProfile #{FIREFOX_FOR_SELENIUM_PROFILE_NAME}")
         puts
       end
 
       def patch_old_firefox
-        puts "Patching #{binary} so it uses the new profile and never re-uses windows from other Firefoxes..."
+        note "Patching #{binary} so it uses the new profile and never re-uses windows from other Firefoxes..."
         execute_command("mv #{binary} #{original_binary}")
         execute_command("mv #{binary}-bin #{original_binary}-bin")
         patched_binary = Tempfile.new('firefox')
-        patched_binary.write <<eos
-#!/usr/bin/env ruby
-exec('#{original_binary}', '-no-remote', '-P', '#{FIREFOX_FOR_SELENIUM_PROFILE_NAME}', *ARGV)
-eos
+        patched_binary.write left(<<-PATCH)
+          #!/usr/bin/env ruby
+          exec('#{original_binary}', '-no-remote', '-P', '#{FIREFOX_FOR_SELENIUM_PROFILE_NAME}', *ARGV)
+          PATCH
         patched_binary.close
         execute_command("mv #{patched_binary.path} #{binary}")
         execute_command("chmod +x #{binary}")
@@ -195,30 +206,38 @@ eos
       end
 
       def configure_old_firefox
-        puts "This script will now open the patched copy of Firefox."
-        puts
-        puts "Please perform the following steps manually:"
-        puts
-        puts "- Disable the default browser check when Firefox launches"
-        puts "- Check that the version number is correct (#{@version})"
-        puts "- Disable all automatic updates under Edit / Preferences / Advanced / Update (do this quickly or Firefox will already have updated)"
-        puts "- You should not see your bookmarks, addons, plugins from your regular Firefox profile"
-        puts
-        puts "Press ENTER when you're ready to open Firefox and perform these steps."
-        gets
+        puts left(<<-INSTRUCTION)
+        You will now have to do some manual configuration.
+
+        This script will open the patched copy of Firefox when you press ENTER.
+        Please perform the following steps manually:
+
+        - Disable the default browser check when Firefox launches
+        - Check that the version number is correct (#{@version})
+        - You should not see your bookmarks, add-ons, plugins from your regular
+          Firefox profile
+        - Disable all automatic updates under Edit / Preferences / Advanced /
+          Update (do this quickly or Firefox will already have updated)
+
+        INSTRUCTION
+
+        wait 'Open the patched copy of Firefox with ENTER.'
         run_firefox_for_selenium
       end
 
       def kkthxbb
-        puts "Congratulations, you're done!"
-        puts
-        puts "Your patched copy of Firefox will be used when you run Cucumber using the cuc binary that comes with the geordi gem."
-        puts "If you prefer to run Cucumber on your own, you must call it like this:"
-        puts
-        puts "    PATH=#{path}:$PATH cucumber"
-        puts
-        puts "Enjoy!"
-        puts
+        success "Congratulations, you're done!"
+
+        puts left(<<-INSTRUCTION)
+
+        Your patched copy of Firefox will be used when you run Cucumber using
+        the cucumber script that comes with the geordi gem. If you prefer to run
+        Cucumber on your own, you must call it like this:
+
+          PATH=#{path}:$PATH cucumber
+
+        Enjoy!
+        INSTRUCTION
       end
 
     end

data/lib/geordi/interaction.rb

@@ -0,0 +1,47 @@
+module Geordi
+  module Interaction
+
+    def announce(text)
+      message = "\n# #{text}"
+      puts "\e[4;34m#{message}\e[0m" # blue underline
+    end
+
+    def note(text)
+      puts '> ' + text
+    end
+
+    def warn(text)
+      message = "> #{text}"
+      puts "\e[33m#{message}\e[0m" # yellow
+    end
+
+    def note_cmd(text)
+      message = "> #{text}"
+      puts "\e[35m#{message}\e[0m" # pink
+    end
+
+    def fail(text)
+      message = "\nx #{text}"
+      puts "\e[31m#{message}\e[0m" # red
+      exit(1)
+    end
+
+    def success(text)
+      message = "\n> #{text}"
+      puts "\e[32m#{message}\e[0m" # green
+    end
+
+    def wait(text)
+      message = "#{text}"
+      puts "\e[36m#{message}\e[0m" # cyan
+      $stdin.gets
+    end
+
+    def left(string)
+      leading_whitespace = (string.match(/\A( +)[^ ]+/) || [])[1]
+      string.gsub! /^#{leading_whitespace}/, '' if leading_whitespace
+      string
+    end
+
+  end
+end

data/lib/geordi/remote.rb

@@ -0,0 +1,66 @@
+require 'geordi/capistrano_config'
+require 'geordi/interaction'
+require 'geordi/util'
+require 'highline/import'
+require 'pathname'
+
+module Geordi
+  class Remote
+    include Geordi::Interaction
+
+    REMOTE_DUMP_PATH = '~/dumps/dump_for_download.dump'
+
+    def initialize(stage)
+      @stage = stage
+      @config = CapistranoConfig.new(stage)
+    end
+
+    def select_server
+      selected_server = choose do |menu|
+        @config.servers.each do |server|
+          menu.choice(server) { server }
+        end
+
+        # Default to the first listed server (by convention, the first server
+        # in the deploy files is the primary one).
+        menu.default = '1'
+        menu.prompt = 'Connect to? [1] '
+      end
+
+      puts
+      selected_server
+    end
+
+    def dump(options = {})
+      shell(options.merge :remote_command => "dumple #{@config.env} --for_download")
+
+      destination_directory = File.join(@config.root, 'tmp')
+      FileUtils.mkdir_p destination_directory
+      destination_path = File.join(destination_directory, "#{@stage}.dump")
+      relative_destination = Pathname.new(destination_path).relative_path_from Pathname.new(@config.root)
+
+      puts
+      note "Downloading remote dump to #{relative_destination} ..."
+      Util.system! "scp #{@config.user}@#{@config.primary_server}:#{REMOTE_DUMP_PATH} #{destination_path}"
+
+      success "Dumped the #{@stage} database to #{relative_destination}."
+
+      destination_path
+    end
+
+    def console(options = {})
+      shell(options.merge :remote_command => Util.console_command(@config.env))
+    end
+
+    def shell(options = {})
+      server = options[:select_server] ? select_server : @config.primary_server
+
+      remote_command = "cd #{@config.path} && #{@config.shell}"
+      remote_command << " -c '#{options[:remote_command]}'" if options[:remote_command]
+
+      note 'Connecting to ' + server.to_s
+      Util.system! 'ssh', "#{@config.user}@#{server}", '-t', remote_command
+    end
+
+  end
+end

data/lib/geordi/util.rb

@@ -0,0 +1,60 @@
+require 'geordi/interaction'
+
+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)
+        yield
+      rescue LoadError => e
+        gem_name = e.message.split('--').last.strip
+        install_command = 'gem install ' + gem_name
+
+        # install missing gem
+        warn 'Probably missing gem: ' + gem_name
+        wait 'Auto-install it?'
+        system! install_command, :show_cmd => true
+
+        # retry
+        Gem.clear_paths
+        note 'Trying again ...'
+        require gem_name
+        retry
+      end
+
+      # Run a command with a clean environment.
+      # Print an error message and exit if the command fails.
+      #
+      # Options: show_cmd, fail_message
+      def system!(*commands)
+        options = commands.last.is_a?(Hash) ? commands.pop : {}
+        note_cmd commands.join(' ') if options[:show_cmd]
+
+        # Remove Geordi's Bundler environment when running commands.
+        Bundler.clean_system(*commands) or fail(options[:fail_message] || 'Something went wrong.')
+      end
+
+      def console_command(environment)
+        if File.exists?('script/console')
+          'script/console ' + environment # Rails 2
+        else
+          'bundle exec rails console ' + environment
+        end
+      end
+
+      def server_command
+        if File.exists?('script/server')
+          'script/server' # Rails 2
+        else
+          'bundle exec rails server' # Rails 3+
+        end
+      end
+
+    end
+  end
+end

data/lib/geordi/version.rb

@@ -1,3 +1,3 @@
 module Geordi
-  VERSION = '0.18.0'
+  VERSION = '1.0.0'
 end

data/lib/geordi.rb

@@ -0,0 +1 @@
+require 'geordi/cli'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: geordi
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Henning Koch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-04 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies: []
 description: Collection of command line tools we use in our daily work with Ruby,
   Rails and Linux at makandra.
@@ -26,16 +26,13 @@ executables:
 - deploy-to-production
 - dump-for
 - dumple
+- geordi
 - gitpt
-- install-gems-remotely
-- install-gems-remotely.sh
 - launchy_browser
 - load-dump
 - migrate-all
 - optimize-png
-- power-deploy
 - power-rake
-- remotify-local-branch
 - remove-executable-flags
 - rs
 - run_tests
@@ -45,7 +42,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
+- .ruby-version
 - Gemfile
 - LICENSE
 - README.md
@@ -61,16 +59,13 @@ files:
 - bin/deploy-to-production
 - bin/dump-for
 - bin/dumple
+- bin/geordi
 - bin/gitpt
-- bin/install-gems-remotely
-- bin/install-gems-remotely.sh
 - bin/launchy_browser
 - bin/load-dump
 - bin/migrate-all
 - bin/optimize-png
-- bin/power-deploy
 - bin/power-rake
-- bin/remotify-local-branch
 - bin/remove-executable-flags
 - bin/rs
 - bin/run_tests
@@ -78,29 +73,68 @@ files:
 - bin/shell-for
 - bin/tests
 - geordi.gemspec
+- lib/geordi.rb
+- lib/geordi/COMMAND_TEMPLATE
 - lib/geordi/capistrano.rb
-- lib/geordi/cuc.rb
+- lib/geordi/capistrano_config.rb
+- lib/geordi/cli.rb
+- lib/geordi/commands/all_targets.rb
+- lib/geordi/commands/apache_site.rb
+- lib/geordi/commands/bundle_install.rb
+- lib/geordi/commands/cleanup_directory.rb
+- lib/geordi/commands/commit.rb
+- lib/geordi/commands/console.rb
+- lib/geordi/commands/create_database_yml.rb
+- lib/geordi/commands/create_databases.rb
+- lib/geordi/commands/cucumber.rb
+- lib/geordi/commands/deploy.rb
+- lib/geordi/commands/devserver.rb
+- lib/geordi/commands/dump.rb
+- lib/geordi/commands/migrate.rb
+- lib/geordi/commands/png_optimize.rb
+- lib/geordi/commands/rake.rb
+- lib/geordi/commands/remove_executable_flags.rb
+- lib/geordi/commands/rspec.rb
+- lib/geordi/commands/security_update.rb
+- lib/geordi/commands/setup.rb
+- lib/geordi/commands/setup_firefox_for_selenium.rb
+- lib/geordi/commands/setup_vnc.rb
+- lib/geordi/commands/shell.rb
+- lib/geordi/commands/test.rb
+- lib/geordi/commands/unit.rb
+- lib/geordi/commands/update.rb
+- lib/geordi/commands/version.rb
+- lib/geordi/commands/vnc_show.rb
+- lib/geordi/commands/with_firefox_for_selenium.rb
+- lib/geordi/commands/with_rake.rb
+- lib/geordi/cucumber.rb
 - lib/geordi/dump_loader.rb
 - lib/geordi/firefox_for_selenium.rb
-- lib/geordi/gitpt.rb
+- lib/geordi/interaction.rb
+- lib/geordi/remote.rb
 - lib/geordi/run_tests.rb
+- lib/geordi/util.rb
 - lib/geordi/version.rb
 homepage: http://makandra.com
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: ! "\n    ********************************************\n\n    geordi
+  1.0.0 moves most of the scripts to\n    the `geordi` binary. Run `geordi` and\n
+  \   `geordi help <cmd>` for further information.\n\n    Tip: Create an alias for
+  geordi for quick \n    access. Add this to your ~/.bashrc:\n\n      alias g=\"geordi\"\n\n
+  \   ********************************************\n\n"
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []

data/bin/install-gems-remotely

@@ -1,18 +0,0 @@
-#!/usr/bin/env ruby
-
-
-warn <<EOWARNING
-
-********************************************************
-install-gems-remotely is deprecated
------------------------------------
-
-Gems should be automatically installed when deploying.
-If they aren't: See http://gembundler.com/deploying.html
-********************************************************
-
-EOWARNING
-
-# sorry
-path = Gem.bin_path('geordi', 'install-gems-remotely.sh')
-exec path, *ARGV

data/bin/install-gems-remotely.sh

@@ -1,16 +0,0 @@
-#!/bin/sh
-if [ -z "$1" ]; then
-  echo "Please specify the remote server name"
-  exit 1
-fi
-mkdir -p tmp
-if ls vendor/gems/*/*.gemspec > /dev/null 2>&1; then
-  tar cf tmp/gemfiles_for_remote_install Gemfile Gemfile.lock vendor/gems
-else
-  tar cf tmp/gemfiles_for_remote_install Gemfile Gemfile.lock
-fi
-scp tmp/gemfiles_for_remote_install $1:~
-stty_orig=`stty -g`
-stty -echo
-ssh -t $1 "mkdir /tmp/install_gems; mv gemfiles_for_remote_install /tmp/install_gems; cd /tmp/install_gems; tar xf gemfiles_for_remote_install; bundle install; rm -rf /tmp/install_gems"
-stty $stty_orig

data/bin/power-deploy

@@ -1,18 +0,0 @@
-#!/usr/bin/env ruby
-
-warn <<EOWARNING 
-
-**********************************************************************
-power-deploy is deprecated
---------------------------
-
-You should simply use "cap deploy:migrations"
-
-If that does not do what you want, you should fix your deploy scripts.
-See http://makandracards.com/makandra/1176
-**********************************************************************
-
-EOWARNING
-
-stage = ARGV[0]
-exec "cap #{stage} deploy && cap #{stage} deploy:migrate && cap #{stage} deploy:restart"

data/bin/remotify-local-branch

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-
-puts
-puts "  Deprecation Notification: This script does nothing."
-puts
-puts "  Pushing a new branch and tracking it immediately with plain git is so easy now."
-puts "  https://makandracards.com/makandra/7895-git-push-a-new-branch-and-track-it-immediately"
-puts
-puts "  Simple use the git command"
-puts
-puts "    git push -u"
-puts