geordi 0.18.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: 9f8f98de512879778e9f1213a42f74c2d787f461
-  data.tar.gz: 0ab1a7b574cafc9c3a18d127593c72bcf1859256
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzZlZDljN2VhOThlZWI0OGJlNTYxZTE0MzU5MDQ3NmI2OGE0YjQ1ZQ==
+  data.tar.gz: !binary |-
+    NWIwNTMxMjQxOGM2MTVmY2U2YTRjNjE2NGQwOWJlNDI1MDNlMzY1Nw==
 SHA512:
-  metadata.gz: 9f3cf82b03f852d818dacec59355734952d6cf17f397987229a4472d88e6b81168ea2d9f307916ccdb78962923de470d5ddb08025883e31f1dea75a86c882b0b
-  data.tar.gz: 271ba533e5c71e28bcca8de85304ad16b1f9c13b96cc441c45a0ac7a0c04146420db4b39cb156cc625fccdaa547a83c9ced1aeb1e55096aa7f113e33d3644711
+  metadata.gz: !binary |-
+    MWQ4YjRiY2Q5MzY5NDE3NjNhYTA0OGI1YWM4M2I0NDhkZGMyNDI0MjVkZDhk
+    ZmU4NTRiZjU4NzI1MDA4ZDBiYTgyMmU5ZDZlZDBlY2NlMGE3ZWYyZDE1NTA3
+    OWRhNGY4ZjFhMjI4NWNlMjAwYWVlZjNmMzIyZDVlZjAyOGY4NmI=
+  data.tar.gz: !binary |-
+    YjI4OTA2YmY4NmM5MDFlZDQ2ZjYwZjIzMDk4ZDY5NzkyZTliYTg5ODliMzNk
+    YmVhMDc5ODczY2NjZWViNjc2OGZjZTU2NTg4N2ZkYzJlMWZiMDQxMTk1OWFj
+    M2ViZGZkNWZiZjcwOTA3ZDAxYWRlY2E0YmE1ZjA3ODUyMjJiOTk=

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/README.md

@@ -1,220 +1,309 @@
 Geordi
 ======
 
-Geordi is a collection of command line tools we use in our daily work with Ruby, Rails and Linux at [makandra](http://makandra.com/).
+Geordi is a collection of command line tools we use in our daily work with
+Ruby, Rails and Linux at [makandra](http://makandra.com/).
 
-Installing the *geordi* gem will link all included tools into your `/usr/bin`:
+Installing the `geordi` gem will install some binaries (see below):
 
-    sudo gem install geordi
+    gem install geordi
 
-Below you can find a list of all included tools.
 
+geordi
+------
 
-apache-site
------------
+The base command line utility offering most of the commands.
 
-Enables the given virtual host in `/etc/apache2/sites-available` and disables all other vhosts:
+You may abbreviate commands by typing only the first letter(s), e.g. `geordi
+dev` will boot a development server, `geordi s -t` will setup a project and run
+tests afterwards. Underscores and dashes are equivalent.
 
-    site makandra-com
+For details on commands, e.g. supported options, run `geordi help <command>`.
 
-More information at http://makandracards.com/makandra/807-shell-script-to-quickly-switch-apache-sites
+### geordi all-targets COMMAND
 
+Run a capistrano command on all deploy targets.
 
-b
--
+Example: `geordi all-targets deploy`
 
-Runs the given command under `bundle exec` if a `Gemfile` is present in your working directory. If no `Gemfile` is present just runs the given command:
 
-    b spec spec/models
+### geordi apache-site VIRTUAL_HOST
 
-More information at http://makandracards.com/makandra/684-automatically-run-bundle-exec-if-required
+Enable the given virtual host, disabling all others.
 
 
-console-for
------------
+### geordi cleanup-directory
 
-Opens a rails console remotely:
+Remove unneeded files.
 
-    console-for staging
 
-More information at http://makandracards.com/makandra/1338-console-for-opens-a-rails-console-remotely-on-a-capistrano-deployment-target
+### geordi commit
 
+Commit using a story title from Pivotal Tracker.
 
 
-cuc
------
+### geordi console [TARGET]
 
-Runs Cucumber with the arguments you want: bundle exec, cucumber_spinner detection, separate Firefox for Selenium, etc.:
+Open a Rails console locally or on a Capistrano deploy target.
 
-    cuc features/users.feature
+Open a local Rails console: `geordi console`
 
-More information at http://makandracards.com/makandra/1277-a-nicer-way-to-run-rspec-and-or-cucumber
+Open a Rails console on `staging`: `geordi console staging`
 
 
+### geordi cucumber [FILES]
 
-cleanup-directory
------------------
+Run Cucumber features.
 
-Removes unnecessary files from your project directory:
+Example: `geordi cucumber features/authentication_feature:3`
 
-    cleanup-directory
+Runs Cucumber as you want: with `bundle exec`, `cucumber_spinner` detection,
+separate Firefox for Selenium, etc.
 
-More information at http://makandracards.com/makandra/951-shell-script-to-clean-up-a-project-directory
 
+### geordi deploy
 
-deploy-to-production
--------------------
+Guided deployment.
 
-Shows the commits between your `master` and `production` branch, then merges the changes and deploys to the production Capistrano stage:
 
-    deploy-to-production
+### geordi devserver
 
-More information at https://makandracards.com/makandra/7971-shell-script-to-deploy-changes-to-production-and-not-shoot-yourself-in-the-foot
+Start a development server.
 
 
-dump-for
---------
+### geordi dump [TARGET]
 
-Dumps the database on your server for a given [Capistrano multistage](https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension) deployment target. Passing the -s option automatically sources the dump ito your development database.
+Handle dumps.
 
-    dump-for production [-s]
+When called without arguments, dumps the development database with `dumple`.
 
-More information at http://makandracards.com/makandra/1237-script-to-create-and-copy-a-production-dump-to-your-project-root
+    geordi dump
 
-     
+When called with the `--load` option, sources the specified dump into the
+development database.
 
-dumple
-------
+    geordi dump -l tmp/staging.dump
 
-Stores a timestamped database dump for the given Rails environment in `~/dumps`:
+When called with a capistrano deploy target (e.g. `staging`), remotely dumps
+the specified target's database and downloads it to `tmp/`.
 
-    dumple development
+    geordi dump staging
 
-More information at http://makandracards.com/makandra/1008-dump-your-database-with-dumple
+When called with a capistrano deploy target and the `--load` option, sources the
+dump into the development database after downloading it.
+
+    geordi dump staging -l
+
+
+### geordi help [COMMAND]
+
+Describe available commands or one specific command.
+
+
+### geordi migrate
+
+Migrate all databases.
+
+Example: `geordi migrate`
+
+If you are using `parallel_tests`, this runs migrations in your development
+environment and `rake parallel:prepare` afterwards. Otherwise, invokes `geordi rake`
+with `db:migrate`.
+
+
+### geordi png-optimize
+
+Optimize .png files.
+
+- Removes color profiles: cHRM, sRGB, gAMA, ICC, etc.
+- Eliminates unused colors and reduces bit-depth (if possible)
+- May reduce PNG file size lossless
+
+Batch-optimize all `*.png` files in a directory:
+
+    geordi png-optimize directory
+
+Batch-optimize the current directory:
+
+    geordi png-optimize .
+
+Optimize a single file:
+
+    geordi png-optimize input.png
+
+
+### geordi rake TASK
+
+Run a rake task in several Rails environments.
+
+Example: `geordi rake db:migrate`
 
+TASK is run in the following Rails environments (if present):
 
-load-dump
----------
+- development
+- test
+- cucumber
 
-Loads a database dump (e.g. created with dump-for or dumple) into you database.
 
-    load-dump [path/to/dump]
+### geordi remove-executable-flags
 
-More information at https://makandracards.com/makandra/8975-geordi-use-load-dump-script-to-source-a-database-dump-into-your-database
+Remove executable-flags from files that should not be executable.
 
 
+### geordi rspec [FILES]
 
-gitpt
------
+Run RSpec.
 
-Shell script to generate a git commit with Pivotal Tracker story ID and title. Run it from your project directory:
+Example: `geordi rspec spec/models/user_spec.rb:13`
 
-    gitpt
+Runs RSpec as you want: with RSpec 1/2 detection, `bundle exec`, rspec_spinner
+detection, etc.
 
-This lets you choose from all started, finished and rejected stories in Pivotal Tracker and commit staged changes.
-Requires the project's Pivotal Tracker ID(s) to be defined in a `.pt_project_id` file in the project's directory.
 
-More information at https://makandracards.com/makandra/1372-shell-script-to-generate-a-git-commit-with-pivotal-tracker-story-id-and-title
+### geordi security-update [step]
 
+Support for performing security updates.
 
-install-gems-remotely
----------------------
+Preparation for security update: `geordi security-update`
 
-Installs all gems in your `Gemfile.lock`, as well as vendored gems, to the given host:
+After performing the update: `geordi security-update finish`
 
-    install-gems-remotely my.server.com
+Switches branches, pulls, pushes and deploys as required by our workflow. Tells
+what it will do before it does it.
 
-More information at http://makandracards.com/makandra/692-install-a-local-gemfile-on-a-remote-server
 
+### geordi setup
 
-migrate-all
----------------------
+Setup a project for the first time.
 
-Runs `power-rake db:migrate` if parallel_tests does not exist in your `Gemfile`. Otherwise it runs the migration
-in your development environment and executes `b rake parallel:prepare` after that.
+Example: `geordi setup`
 
-    migrate-all
+Check out a repository, cd into its directory. Now let `setup` do the tiring
+work: run `bundle install`, create `database.yml`, create databases, migrate
+(all if applicable).
 
+After setting up, loads a dump into the development db when called with the
+`--dump` option:
 
-power-deploy
-------------
+    geordi setup -d staging
 
-Calls the Capistrano tasks `deploy`, `deploy:migrate` and `deploy:restart` on the given [Capistrano multistage](https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension) deployment target:
+After setting up, runs all tests when called with the `--test` option:
 
-    power-deploy staging
+    geordi setup -t
 
-This script is considered legacy and will be removed eventually. You should [fix your deploy scripts](http://makandracards.com/makandra/1176-which-capistrano-hooks-to-use-for-events-to-happen-on-both-cap-deploy-and-cap-deploy-migrations) and then use [cap deploy:migrations](http://makandracards.com/makandra/1000-deploy-and-migrate-with-a-single-capistrano-command).
+See `geordi help setup` for details.
 
 
-power-rake
-----------
+### geordi setup-firefox-for-selenium VERSION
 
-Runs the given rake task in each Rails environment in `development`, `test`, `cucumber`, `performance`, if existing:
+Install a special firefox for running Selenium tests.
 
-    power-rake db:migrate
 
-More information at http://makandracards.com/makandra/737-run-a-rake-task-in-all-environments
+### geordi setup-vnc
 
+Setup VNC for running Selenium tests there.
 
-remove-executable-flags
------------------------
 
-Recursively removes executable flags from files in the working directory that probably shouldn't have them (like Ruby, HTML, CSS, image, Rake and similar files).
+### geordi shell TARGET
 
-    remove-executable-flags
-    
-More information at http://makandracards.com/makandra/659-recursively-remove-unnecessary-execute-flags
+Open a shell on a Capistrano deploy target.
 
+Example: `geordi shell production`
 
-rs
------
+Lets you select the server to connect to when called with `--select-server`:
 
-Runs RSpec with the arguments you want: RSpec 1/2 detection, bundle exec, rspec_spinner detection, etc.:
+    geordi shell production -s
 
-    rs spec/models/user_spec.rb
 
-More information at http://makandracards.com/makandra/1277-a-nicer-way-to-run-rspec-and-or-cucumber
+### geordi tests
 
+Run all employed tests.
 
-setup-firefox-for-selenium
---------------------------
 
-Helps you create an frozen version of Firefox, so your Selenium tests will no longer break whenever Firefox updates:
+### geordi unit
 
-    setup-firefox-for-selenium
+Run Test::Unit.
 
-More information at http://makandracards.com/makandra/1575-how-to-install-a-frozen-version-of-firefox-for-your-selenium-tests
 
+### geordi update
 
-shell-for
----------
+Bring a project up to date.
 
-Opens an SSH shell on the given [Capistrano multistage](https://github.com/capistrano/capistrano/wiki/2.x-Multistage-Extension) deployment target:
+Example: `geordi update`
 
-    shell-for production
+Performs: `git pull`, `bundle install` (if necessary) and migrates (if applicable).
 
-Now it can also be called with any command to be remotely executed before loading the bash. `--no-bash` skips the bash.
+After updating, loads a dump into the development db when called with the
+`--dump` option:
 
-    shell-for staging --no-bash top
+    geordi update -d staging
 
-More information at http://makandracards.com/makandra/1209-script-to-open-an-ssh-shell-to-a-capistrano-deployment-target
+After updating, runs all tests when called with the `--test` option:
 
+    geordi update -t
 
-tests
---------------
+See `geordi help update` for details.
 
-Runs both `rs` and `cuc`. Call from any project directory:
 
-    tests
+### geordi version
+
+Print the current version of geordi.
+
+
+### geordi vnc-show
+
+Show the hidden VNC window.
+
+
+### geordi with-firefox-for-selenium COMMAND
+
+Run a command with firefox for selenium set up.
+
+Example: `geordi with-firefox-for-selenium b cucumber`
+
+Useful when you need Firefox for Selenium, but can't use the `geordi cucumber`
+command.
+
+
+### geordi with-rake
+
+Run tests with `rake`.
+
+
+b
+---
+
+Runs the given command under `bundle exec` if a `Gemfile` is present in your
+working directory. If no `Gemfile` is present just runs the given command:
+
+    b spec spec/models
+
+More information at http://makandracards.com/makandra/684-automatically-run-bundle-exec-if-required
+
+
+dumple
+------
+
+Stores a timestamped database dump for the given Rails environment in `~/dumps`:
+
+    dumple development
+
+More information at http://makandracards.com/makandra/1008-dump-your-database-with-dumple
+
 
-More information at http://makandracards.com/makandra/1277-a-nicer-way-to-run-rspec-and-or-cucumber
+launchy_browser
+---------------
 
+Used by the `geordi cucumber` command. Makes launchy open pages in the user's
+browser, as opposed to opening it within the VNC window.
 
-run_tests
----------
 
-Enables VNC and setups firefox just like "cuc", but simply runs the given command.
+Contributing
+============
 
-Useful if your project does not use "cucumber", so you can for example say
+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.
 
-  run_tests rake test:integration
+Don't forget to update this README. The whole `geordi` section is auto-generated
+by `rake update_readme`.

data/Rakefile

@@ -1,2 +1,42 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+task :update_readme do
+  require File.expand_path('../lib/geordi/cli', __FILE__)
+
+  readme = File.read('README.md')
+  geordi_section_regex = /
+    geordi\n
+    -{3,}   # 3 dashes or more
+    .*?     # anything, non-greedy
+    (?=     # stop before:
+      ^\w+\n-{3,} # the next section
+    )
+  /xm
+
+  geordi_section = <<-TEXT
+geordi
+------
+
+The base command line utility offering most of the commands.
+
+You may abbreviate commands by typing only the first letter(s), e.g. `geordi
+dev` will boot a development server, `geordi s -t` will setup a project and run
+tests afterwards. Underscores and dashes are equivalent.
+
+For details on commands, e.g. supported options, run `geordi help <command>`.
+
+  TEXT
+
+  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 << "\n"
+    end
+  end
+
+  updated_readme = readme.sub(geordi_section_regex, geordi_section)
+  File.open('README.md', 'w') { |f| f.puts updated_readme.strip }
+end

data/bin/apache-site

@@ -1,21 +1,3 @@
 #!/usr/bin/env ruby
 
-site = ARGV[0]
-old_cwd = Dir.pwd
-Dir.chdir "/etc/apache2/sites-available/"
-
-# show available sites if no site was passed as argument
-unless site
-  puts 'ERROR: Argument site is missing.'
-  puts 'Please call: apache-site my-site'
-  puts
-  puts 'Available sites:'
-  Dir.new(".").each do |file|
-    puts "- #{file}" if file != '.' && file != '..'
-  end
-  exit
-end
-
-has_default = File.exists?("default")
-exec "sudo a2dissite \*; sudo a2ensite #{"default " if has_default}#{site} && sudo apache2ctl restart"
-Dir.chdir old_cwd
+exec 'geordi', 'apache_site', *ARGV

data/bin/cap-all

@@ -1,29 +1,3 @@
 #!/usr/bin/env ruby
 
-require 'fileutils'
-
-
-targets = Dir["config/deploy/*.rb"].map { |f| File.basename(f, ".rb") }
-
-if targets.empty?
-  targets = [nil]
-end
-
-targets.each do |stage|
-
-  puts "Deploying to #{stage ? stage : 'default target'}"
-  puts "*" * 80
-
-  if stage
-    exit_code = system("bundle", "exec", "cap", stage, *ARGV)
-  else
-    exit_code = system("bundle", "exec", "cap", *ARGV)
-  end
-  unless exit_code
-    puts "*" * 80
-    puts "Capistrano failed. Have a look!"
-    exit(1)
-  end
-
-  puts
-end
+exec 'geordi', 'all_targets', *ARGV

data/bin/cleanup-directory

@@ -1,13 +1,3 @@
 #!/usr/bin/env ruby
 
-puts 'Removing:'
-for pattern in %w[ webrat-* capybara-* tmp/webrat-* tmp/capybara-* tmp/rtex/* log/*.log ]
-  puts "- #{pattern}"
-  puts `rm -vfR #{pattern}`
-end
-
-puts 'Finding recursively and removing:'
-for pattern in %w[ *~ ]
-  puts "- #{pattern}"
-  `find . -name #{pattern} -exec rm {} ';'`
-end
+exec 'geordi', 'cleanup-directory'

data/bin/console-for

@@ -1,14 +1,3 @@
 #!/usr/bin/env ruby
-require File.dirname(__FILE__) + "/../lib/geordi/capistrano"
-include Geordi::Capistrano
 
-catching_errors do
-  self.stage = ARGV.shift
-  options = { :select_server => true }
-
-  if File.exists? "#{config.root}/script/console" # => Rails 2
-    shell_for("script/console #{config.env}", options)
-  else
-    shell_for("bundle exec rails console #{config.env}", options)
-  end
-end
+exec 'geordi', 'console', *ARGV

data/bin/cuc

@@ -1,4 +1,3 @@
 #!/usr/bin/env ruby
-require File.join(File.dirname(__FILE__), '../lib/geordi/cuc')
 
-Geordi::Cucumber.new.run
+exec 'geordi', 'cucumber', *ARGV

data/bin/cuc-show

@@ -1,4 +1,3 @@
 #!/usr/bin/env ruby
-require File.join(File.dirname(__FILE__), '../lib/geordi/cuc')
 
-Geordi::Cucumber.new.launch_vnc_viewer
+exec 'geordi', 'vnc-show'