geordi 0.18.0 → 1.0.0

data/lib/geordi/capistrano_config.rb

@@ -0,0 +1,66 @@
+require 'capistrano'
+
+module Geordi
+  class CapistranoConfig
+
+    attr_accessor :root
+
+    def initialize(stage)
+      ENV['BUNDLE_BIN_PATH'] = 'Trick capistrano safeguard in deploy.rb into believing bundler is present by setting this variable.'
+
+      @stage = stage
+      @root = find_project_root!
+      load_capistrano_config
+    end
+
+    def user
+      @capistrano_config.fetch(:user)
+    end
+
+    def servers
+      @capistrano_config.find_servers(:roles => [:app])
+    end
+
+    def primary_server
+      @capistrano_config.find_servers(:roles => [:app], :only => { :primary => true }).first
+    end
+
+    def path
+      @capistrano_config.fetch(:deploy_to) + '/current'
+    end
+
+    def env
+      @capistrano_config.fetch(:rails_env, 'production')
+    end
+
+    def shell
+      @capistrano_config.fetch(:default_shell, 'bash --login')
+    end
+
+
+    private
+
+    def load_capistrano_config
+      config = ::Capistrano::Configuration.new
+      config.load('deploy')
+      config.load('config/deploy')
+      if @stage and @stage != ''
+        config[:stage] = @stage
+        config.find_and_execute_task(@stage)
+      end
+
+      @capistrano_config = config
+    end
+
+    def find_project_root!
+      current = Dir.pwd
+      until (File.exists? 'Capfile')
+        Dir.chdir '..'
+        raise 'Call me from inside a Rails project!' if current == Dir.pwd
+        current = Dir.pwd
+      end
+      current
+    end
+
+  end
+end

data/lib/geordi/cli.rb

@@ -0,0 +1,28 @@
+require 'thor'
+require 'bundler'
+require 'geordi/interaction'
+require 'geordi/util'
+
+module Geordi
+  class CLI < Thor
+    include Geordi::Interaction
+
+    # load all tasks defined in lib/geordi/commands
+    Dir[File.expand_path '../commands/*.rb', __FILE__].each do |file|
+      class_eval File.read(file), file
+    end
+
+    private
+
+    def file_containing?(file, regex)
+      File.exists?(file) and File.read(file).scan(regex).any?
+    end
+
+    # fix weird implementation of #invoke
+    def invoke_cmd(name, *args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      invoke(name, args, options)
+    end
+
+  end
+end

data/lib/geordi/commands/all_targets.rb

@@ -0,0 +1,26 @@
+desc 'all-targets COMMAND', 'Run a capistrano command on all deploy targets'
+long_desc <<-LONGDESC
+Example: `geordi all-targets deploy`
+LONGDESC
+
+def all_targets(*args)
+  targets = Dir['config/deploy/*.rb'].map { |file| File.basename(file, '.rb') }.sort
+
+  note 'Found the following deploy targets:'
+  puts targets
+  puts
+
+  print 'Continue? [yN] '
+  exit unless $stdin.gets =~ /[yes]+/
+
+  targets << nil if targets.empty? # default target
+  targets.each do |stage|
+    announce 'Target: ' + (stage || '(default)')
+
+    command = "bundle exec cap #{stage} " + args.join(' ')
+    note_cmd command
+
+    Util.system!(command, :fail_message => 'Capistrano failed. Have a look!')
+  end
+
+end

data/lib/geordi/commands/apache_site.rb

@@ -0,0 +1,22 @@
+desc 'apache-site VIRTUAL_HOST', 'Enable the given virtual host, disabling all others'
+def apache_site(*args)
+  site = args.shift
+  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
+end

data/lib/geordi/commands/bundle_install.rb

@@ -0,0 +1,7 @@
+desc 'bundle-install', 'Run bundle install if required', :hide => true
+def bundle_install
+  if File.exists?('Gemfile') and !system('bundle check > /dev/null 2>&1')
+    announce 'Bundling'
+    Util.system! 'bundle install'
+  end
+end

data/lib/geordi/commands/cleanup_directory.rb

@@ -0,0 +1,16 @@
+desc 'cleanup-directory', 'Remove unneeded files'
+def cleanup_directory
+
+  announce 'Removing tempfiles'
+  for pattern in %w[ webrat-* capybara-* tmp/webrat-* tmp/capybara-* tmp/rtex/* log/*.log ]
+    note pattern
+    puts `rm -vfR #{pattern}`
+  end
+
+  announce 'Finding recursively and removing backup files'
+  for pattern in %w[ *~ ]
+    note pattern
+    `find . -name #{pattern} -exec rm {} ';'`
+  end
+
+end

data/lib/geordi/commands/commit.rb

@@ -0,0 +1,171 @@
+desc 'commit', 'Commit using a story title from Pivotal Tracker'
+def commit
+  Gitpt.new.run
+end
+
+class Gitpt
+  include Geordi::Interaction
+  require 'yaml'
+  require 'highline'
+  require 'pivotal-tracker'
+
+  attr_reader :token, :initials, :settings_file, :deprecated_token_file,
+              :highline, :applicable_stories, :memberships
+
+  def initialize
+    @highline = HighLine.new
+    @settings_file = File.join(ENV['HOME'], '.gitpt')
+    @deprecated_token_file = File.join(ENV['HOME'], '.pt_token')
+    load_settings
+    settings_were_invalid = (not settings_valid?)
+
+    hello unless settings_valid?
+    request_settings while not settings_valid?
+    stored if settings_were_invalid
+
+    PivotalTracker::Client.use_ssl = true
+    PivotalTracker::Client.token = token
+  end
+
+  def settings_valid?
+    token and token.size > 10
+  end
+
+  def bold(string)
+    HighLine::BOLD + string + HighLine::RESET
+  end
+
+  def highlight(string)
+    bold HighLine::BLUE + string
+  end
+
+  def hello
+    highline.say HighLine::RESET
+    highline.say "Welcome to #{bold 'gitpt'}.\n\n"
+  end
+
+  def loading(message, &block)
+    print message
+    STDOUT.flush
+    yield
+    print "\r" + ' ' * message.size + "\r" # Remove loading message
+    STDOUT.flush
+  end
+
+  def stored
+    highline.say left(<<-MESSAGE)
+      Thank you. Your settings have been stored at #{highlight @settings_file}
+      You may remove that file for the wizard to reappear.
+
+      ----------------------------------------------------
+
+    MESSAGE
+  end
+
+  def request_settings
+    highline.say highlight('Your settings are missing or invalid.')
+    highline.say "Please configure your Pivotal Tracker access.\n\n"
+    token = highline.ask bold("Your API key:") + " "
+    initials = highline.ask bold("Your PT initials") + " (optional, used for highlighting your stories): "
+    highline.say "\n"
+
+    settings = { :token => token, :initials => initials }
+    File.open settings_file, 'w' do |file|
+      file.write settings.to_yaml
+    end
+    load_settings
+  end
+
+  def load_settings
+    if File.exists? settings_file
+      settings = YAML.load(File.read settings_file)
+      @initials = settings[:initials]
+      @token = settings[:token]
+    else
+      if File.exists?(deprecated_token_file)
+        highline.say left(<<-MESSAGE)
+          #{HighLine::YELLOW}You are still using #{highlight(deprecated_token_file) + HighLine::YELLOW} which will be deprecated in a future version.
+          Please migrate your settings to ~/.gitpt or remove #{deprecated_token_file} for the wizard to cast magic.
+        MESSAGE
+        @token = File.read(deprecated_token_file)
+      end
+    end
+  end
+
+  def load_projects
+    project_id_filename = '.pt_project_id'
+    if File.exists?(project_id_filename)
+      project_ids = File.read('.pt_project_id').split(/[\s]+/).map(&:to_i)
+    end
+
+    unless project_ids and project_ids.size > 0
+      highline.say left(<<-MESSAGE)
+        Sorry, I could not find a project ID in #{highlight project_id_filename} :(
+
+        Please put at least one Pivotal Tracker project id into #{project_id_filename} in this directory.
+        You may add multiple IDs, separated using white space.
+      MESSAGE
+      exit 1
+    end
+
+    loading 'Connecting to Pivotal Tracker...' do
+      projects = project_ids.collect do |project_id|
+        PivotalTracker::Project.find(project_id)
+      end
+
+      @memberships = projects.collect(&:memberships).map(&:all).flatten
+
+      @applicable_stories = projects.collect do |project|
+        project.stories.all(:state => 'started,finished,rejected')
+      end.flatten
+    end
+  end
+
+  def choose_story
+    selected_story = nil
+
+    highline.choose do |menu|
+      menu.header = "Choose a story"
+      applicable_stories.each do |story|
+        owner_name = story.owned_by
+        owner = if owner_name
+          owners = memberships.select{|member| member.name == owner_name}
+          owners.first ? owners.first.initials : '?'
+        else
+          '?'
+        end
+
+        state = story.current_state
+        if state == 'started'
+          state = HighLine::GREEN + state + HighLine::RESET
+        elsif state != 'finished'
+          state = HighLine::RED + state + HighLine::RESET
+        end
+        state += HighLine::BOLD if owner == initials
+
+        label = "(#{owner}, #{state}) #{story.name}"
+        label = bold(label) if owner == initials
+        menu.choice(label) { selected_story = story }
+      end
+      menu.hidden ''
+    end
+
+    if selected_story
+      message = highline.ask("\nAdd an optional message")
+      highline.say message
+
+      commit_message = "[##{selected_story.id}] #{selected_story.name}"
+      if message.strip != ''
+        commit_message << ' - '<< message.strip
+      end
+
+      exec('git', 'commit', '-m', commit_message)
+    end
+  end
+
+  def run
+    load_projects
+    choose_story
+  end
+
+end

data/lib/geordi/commands/console.rb

@@ -0,0 +1,24 @@
+desc 'console [TARGET]', 'Open a Rails console locally or on a Capistrano deploy target'
+long_desc <<-LONGDESC
+Open a local Rails console: `geordi console`
+
+Open a Rails console on `staging`: `geordi console staging`
+LONGDESC
+
+
+option :select_server, :default => false, :type => :boolean, :aliases => '-s'
+
+def console(target = 'development', *args)
+  require 'geordi/remote'
+
+  if target == 'development'
+    announce 'Opening a local Rails console'
+
+    Util.system! Util.console_command(target)
+
+  else
+    announce 'Opening a Rails console on ' + target
+
+    Geordi::Remote.new(target).console(options)
+  end
+end

data/lib/geordi/commands/create_database_yml.rb

@@ -0,0 +1,18 @@
+desc 'create-database-yml', '[sic]', :hide => true
+def create_database_yml
+  real_yml = 'config/database.yml'
+  sample_yml = 'config/database.sample.yml'
+
+  if File.exists?(sample_yml) and not File.exists?(real_yml)
+    announce 'Creating ' + real_yml
+
+    print 'Please enter your DB password: '
+    db_password = STDIN.gets.strip
+
+    sample = File.read(sample_yml)
+    real = sample.gsub(/password:.*$/, "password: #{db_password}")
+    File.open(real_yml, 'w') { |f| f.write(real) }
+
+    note "Created #{real_yml}."
+  end
+end

data/lib/geordi/commands/create_databases.rb

@@ -0,0 +1,16 @@
+desc 'create-databases', 'Create all databases', :hide => true
+def create_databases
+  invoke_cmd 'create_database_yml'
+  invoke_cmd 'bundle_install'
+
+  announce 'Creating databases'
+
+  if File.exists?('config/database.yml')
+    command = 'bundle exec rake db:create:all'
+    command << ' parallel:create' if file_containing?('Gemfile', /parallel_tests/)
+
+    Util.system! command
+  else
+    puts 'config/database.yml does not exist. Nothing to do.'
+  end
+end

data/lib/geordi/commands/cucumber.rb

@@ -0,0 +1,20 @@
+desc 'cucumber [FILES]', 'Run Cucumber features'
+long_desc <<-LONGDESC
+Example: `geordi cucumber features/authentication_feature:3`
+
+Runs Cucumber as you want: with `bundle exec`, `cucumber_spinner` detection,
+separate Firefox for Selenium, etc.
+LONGDESC
+
+def cucumber(*files)
+  require 'geordi/cucumber'
+
+  invoke_cmd 'bundle_install'
+
+  if File.directory?('features')
+    announce 'Running features'
+    Geordi::Cucumber.new.run(files) or fail 'Features failed.'
+  else
+    note 'Cucumber not employed.'
+  end
+end

data/lib/geordi/commands/deploy.rb

@@ -0,0 +1,65 @@
+desc 'deploy', 'Guided deployment'
+def deploy
+  ENV['PAGER'] = 'cat'
+
+  master_branch = prompt('master branch', 'master')
+  production_branch = prompt('production branch', 'production')
+  production_stage = prompt('production capistrano stage', 'production')
+
+  announce "Checking if your #{master_branch} is up to date"
+
+  diff_size = call_or_fail("git fetch && git diff #{master_branch} origin/#{master_branch} | wc -l", true)
+  changes_size = call_or_fail('git status -s | wc -l', true)
+
+  if diff_size == '0' and changes_size == '0'
+    note 'All good.'
+  else
+    fail "Your #{master_branch} is not the same as on origin or holds uncommitted changes. Fix that first."
+  end
+
+  announce "Checking what's on #{production_stage} right now..."
+
+  call_or_fail "git checkout #{production_branch} && git pull"
+
+  announce "You are about to deploy the following commits from #{master_branch} to #{production_branch}:"
+
+  call_or_fail "git log #{production_branch}..#{master_branch} --oneline"
+
+  if prompt('Go ahead with the deployment?', 'n').downcase == 'y'
+    puts
+    capistrano_call = "cap #{production_stage} deploy:migrations"
+    if file_containing?('Gemfile', /capistrano/)
+      capistrano_call = "bundle exec #{capistrano_call}"
+    end
+    call_or_fail("git merge #{master_branch} && git push && #{capistrano_call}")
+    success 'Deployment complete.'
+  else
+    fail 'Deployment cancelled.'
+  end
+
+end
+
+private
+
+def call_or_fail(command, return_output = false)
+  note_cmd command
+  if return_output
+    result = `#{command}`.to_s.strip
+    $?.success? or fail "Error while calling #{command}: #{$?}"
+  else
+    result = system(command) or fail "Error while calling #{command}: #{$?}"
+    puts
+  end
+  result
+end
+
+def prompt(message, default)
+  print "#{message}"
+  print " [#{default}]" if default
+  print ": "
+  input = $stdin.gets.strip
+  if input.empty? && default
+    input = default
+  end
+  input
+end

data/lib/geordi/commands/devserver.rb

@@ -0,0 +1,14 @@
+desc 'devserver', 'Start a development server'
+
+option :port, :aliases => '-p', :default => '3000'
+
+def devserver
+  invoke_cmd 'bundle_install'
+  require 'geordi/util'
+
+  announce 'Booting a development server'
+  note "URL: http://#{File.basename(Dir.pwd)}.vcap.me:#{options.port}"
+  puts
+
+  Util.system! Util.server_command + " -p #{options.port}"
+end

data/lib/geordi/commands/dump.rb

@@ -0,0 +1,63 @@
+desc 'dump [TARGET]', 'Handle dumps'
+long_desc <<-DESC
+When called without arguments, dumps the development database with `dumple`.
+
+    geordi dump
+
+When called with the `--load` option, sources the specified dump into the
+development database.
+
+    geordi dump -l tmp/staging.dump
+
+When called with a capistrano deploy target (e.g. `staging`), remotely dumps
+the specified target's database and downloads it to `tmp/`.
+
+    geordi dump staging
+
+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
+DESC
+
+option :load, :aliases => ['-l'], :type => :string, :desc => 'Load a dump'
+option :select_server, :default => false, :type => :boolean, :aliases => '-s'
+
+def dump(target = nil, *args)
+  require 'geordi/dump_loader'
+  require 'geordi/remote'
+
+  if target.nil?
+    if options.load
+      # validate load option
+      fail 'Missing a dump file.' if options.load == 'load'
+      File.exists?(options.load) or fail 'Could not find the given dump file: ' + options.load
+
+      loader = DumpLoader.new(options.load)
+
+      announce "Sourcing dump into the #{loader.config['database']} db"
+      loader.load
+
+      success "Your #{loader.config['database']} database has now the data of #{options.load}."
+
+    else
+      announce 'Dumping the development database'
+      Util.system! 'dumple development'
+      success 'Successfully dumped the development database.'
+    end
+
+  else
+    announce 'Dumping the database of ' + target
+    dump_path = Geordi::Remote.new(target).dump(options)
+
+    if options.load
+      loader = DumpLoader.new(dump_path)
+
+      announce "Sourcing dump into the #{loader.config['database']} db"
+      loader.load
+
+      success "Your #{loader.config['database']} database has now the data of #{target}."
+    end
+  end
+
+end

data/lib/geordi/commands/migrate.rb

@@ -0,0 +1,26 @@
+desc 'migrate', 'Migrate all databases'
+long_desc <<-LONGDESC
+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`.
+LONGDESC
+
+def migrate
+  invoke_cmd 'bundle_install'
+  announce 'Migrating'
+
+  if File.directory?('db/migrate')
+    if file_containing?('Gemfile', /parallel_tests/)
+      note 'Development and parallel test databases'
+      puts
+
+      Util.system! 'bundle exec rake db:migrate parallel:prepare'
+    else
+      invoke_cmd 'rake', 'db:migrate'
+    end
+  else
+    note 'No migrations directory found.'
+  end
+end

data/lib/geordi/commands/png_optimize.rb

@@ -0,0 +1,92 @@
+desc 'png-optimize', 'Optimize .png files'
+long_desc <<-LONGDESC
+- 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
+LONGDESC
+
+def png_optimize(*args)
+  require 'fileutils'
+
+  announce 'Optimizing .png files'
+
+  if `which pngcrush`.strip.empty?
+    fail 'You have to install pngcrush first (sudo apt-get install pngcrush)'
+  end
+
+  po = PngOptimizer.new
+  path = args[0]
+  if File.directory?(path)
+    po.batch_optimize_inplace(path)
+  elsif File.file?(path)
+    po.optimize_inplace(path)
+  else
+    fail 'Neither directory nor file: ' + path
+  end
+
+  success 'PNG optimization completed.'
+end
+
+class PngOptimizer
+
+  def ends_with?(string, suffix)
+    string[-suffix.length, suffix.length] == suffix
+  end
+
+  def optimization_default_args
+    args = ""
+    args << "-rem alla " # remove everything except transparency
+    args << "-rem text " # remove text chunks
+    args << "-reduce " # eliminate unused colors and reduce bit-depth (if possible)
+    args
+  end
+
+  def optimize_file(input_file, output_file)
+    system "pngcrush #{optimization_default_args} '#{input_file}' '#{output_file}'"
+  end
+
+  def unused_tempfile_path(original)
+    dirname = File.dirname(original)
+    basename = File.basename(original)
+    count = 0
+    begin
+      tmp_name = "#{dirname}/#{basename}_temp_#{count += 1}.png"
+    end while File.exists?(tmp_name)
+    tmp_name
+  end
+
+  def optimize_inplace(input_file)
+    temp_file = unused_tempfile_path(input_file)
+    result = optimize_file(input_file, temp_file)
+    if result
+      FileUtils.rm(input_file)
+      FileUtils.mv("#{temp_file}", "#{input_file}")
+    else
+      fail 'Error:' + $?
+    end
+  end
+
+  def batch_optimize_inplace(path)
+    # Dir[".png"] works case sensitive, so to catch all funky .png extensions we have to go the following way:
+    png_relative_paths = []
+    Dir["#{path}/*.*"].each do |file_name|
+      png_relative_paths << file_name if ends_with?(File.basename(file_name.downcase), ".png")
+    end
+    png_relative_paths.each do |png_relative_path|
+      optimize_inplace(png_relative_path)
+    end
+  end
+
+end