hk 0.0.1

data/.gitignore

@@ -0,0 +1,15 @@
+
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile ~/.gitignore_global
+
+/tmp
+*.swp
+*.rbc
+.DS_Store
+.vimrc
+.jhw-cache
+results.html
+pkg

data/.ruby-gemset

@@ -0,0 +1 @@
+hk

data/.ruby-version

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

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,60 @@
+PATH
+  remote: .
+  specs:
+    hk (0.0.1)
+      gem-man
+      gli (~> 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aruba (0.5.3)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.2.2)
+    childprocess (0.3.9)
+      ffi (~> 1.0, >= 1.0.11)
+    clean_test (1.0.0)
+      faker
+    cucumber (1.3.5)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.12.0)
+      multi_json (~> 1.7.5)
+      multi_test (>= 0.0.2)
+    diff-lcs (1.2.4)
+    faker (1.2.0)
+      i18n (~> 0.5)
+    ffi (1.9.0)
+    gem-man (0.3.0)
+    gherkin (2.12.0)
+      multi_json (~> 1.3)
+    gli (2.7.0)
+    hpricot (0.8.6)
+    i18n (0.6.4)
+    json (1.8.0)
+    multi_json (1.7.8)
+    multi_test (0.0.2)
+    mustache (0.99.4)
+    rake (10.1.0)
+    rdiscount (2.1.6)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    ronn (0.7.3)
+      hpricot (>= 0.8.2)
+      mustache (>= 0.7.0)
+      rdiscount (>= 1.5.8)
+    rspec-expectations (2.14.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba
+  clean_test
+  hk!
+  rake
+  rdoc
+  ronn

data/README.md

@@ -0,0 +1,116 @@
+hk(1) -- Simplify your access to Heroku on the command-line
+===========================================================
+
+## SYNOPSIS
+
+`hk **alias** _app_string_`
+
+`hk **any heroku invocation** _app_string_`
+
+## INSTALL
+
+    $ gem install hk
+
+## DESCRIPTION
+
+**hk** is an alias system for Heroku's command-line app that does three things:
+
+* Wrap complex or cumbersome commands and options into single-word (or single-letter) aliases (e.g. `hk logs` will do `heroku logs --tail`)
+* Derive application names from shorter-strings (e.g. `hk logs f-p` will run `heroku logs --tail --app=foo-production`)
+* Alleviates you from typing `heroku`, which is hard to type and prone to misspellings
+
+**hk** can easily be extended with whatever command aliases you would like.  It also passes through any unknown command to the underlying `heroku` command, but *does do* the app name derivation.
+
+## COMMAND ALIASING
+
+Command aliasing is fairly straightforward - a string is used to generate a more complex heroku command invocation.  You can create your own in `~/.hk/commands/commands.rb` (boilerplate which can be created via `hk init`).
+
+    desc 'Get app info'
+    arg_name Hk::ARG_NAME
+    command :info do |c|
+      c.action do |_,_,args|
+        Hk.run("apps:info",args)
+      end
+    end
+
+This code is the GLI DSL, so you can use that entire API if you want to, however the above is a minimal example.
+
+You'll note that your command now shows up if you do `hk help`.
+
+## APP NAME DERIVATION
+
+If your team is maintaining various apps on heroku, and using it for staging, it can be quite cumbersome to be constantly typing out the names of apps.  It's also somewhat dangerous to rely on the `.git/config` because it obfuscates what's going to happen behind your current directory.
+
+**hk** will derive your application name, assuming that you use a canonical naming structure that is **app_name-environment_name**.  **app_name** is a logical name for your app, e.g. "foobar".  **environment_name** is a logical name for an environment, like "staging" or "production".
+
+So, instead of typing `--app=foobar-production`, you can simply type `f-p`.  As long as you have no other app that starts with "f", and no other environment that starts with "p" (based on the output of `heroku apps`), then **hk** will derive the name.  You can add more letters to disambiguate, so if you had an app call "frob-production", you would use "fo-p" for "foobar-production" and "fr-p" for "frob-production"
+
+## OPTIONS
+
+  * `--heroku PATH_TO_HEROKU`:
+    Specify where the heroku command line app is. If omitted, will just use your path
+  * `--verbose`:
+    If specified, will output the heroku command being executed
+  * `-n`,`--no-app-derivation`:
+    If specified, will skip deriving the app and tacking on a `--app` option
+
+## EXAMPLES
+
+There are three builtin aliases (which you can disable by setting SKIP_DEFAULTS=true in your customizations file): console, logs, and psql:
+
+    hk logs f-p
+    # heroku logs --tail --app=foo-production
+
+    hk console f-p
+    # heroku run rails c --app=foo-production
+
+    hk psql f-p
+    # heroku pg:psql --app=foo-production
+
+Unknown commands will pass through, but app derivation will still take place:
+
+    hk run rake db:migrate f-s
+    # heroku run rake db:migrate --app=foo-staging
+
+You can also be explicit about where `heroku` is you don't want to rely on your PATH:
+
+    hk --heroku=/sbin/herkou logs f-p
+    # /sbin/heroku logs --tail --app=foo-production
+
+And, you can skip all the magic if you like:
+
+    hk -n --heroku=/sbin/herkou pg:info --app=hellblazer
+    # sbin/herkou pg:info --app=hellblazer
+
+Note that because this is backed by GLI, you only need to specify the command-name with enough characters to disambiguate it.  For example, given the three builtins, these two are equivalent:
+
+
+    hk logs f-p
+    hk l f-p
+
+## AUTHOR
+
+David Copeland, davec (at) naildrivin5.com
+
+## COPYRIGHT
+
+hk is copyright(c) 2012 by David Copeland, released under the Apache license.
+
+## SEE ALSO
+
+  * Source on github: https://github.com/davetron5000/hk
+
+
+[SYNOPSIS]: #SYNOPSIS "SYNOPSIS"
+[INSTALL]: #INSTALL "INSTALL"
+[DESCRIPTION]: #DESCRIPTION "DESCRIPTION"
+[COMMAND ALIASING]: #COMMAND-ALIASING "COMMAND ALIASING"
+[APP NAME DERIVATION]: #APP-NAME-DERIVATION "APP NAME DERIVATION"
+[OPTIONS]: #OPTIONS "OPTIONS"
+[EXAMPLES]: #EXAMPLES "EXAMPLES"
+[AUTHOR]: #AUTHOR "AUTHOR"
+[COPYRIGHT]: #COPYRIGHT "COPYRIGHT"
+[SEE ALSO]: #SEE-ALSO "SEE ALSO"
+
+
+[hk(1)]: hk.1.html

data/Rakefile

@@ -0,0 +1,9 @@
+$: << File.dirname(__FILE__)
+
+require 'rake/clean'
+require 'lib/rake/cucumber'
+require 'lib/rake/test'
+require 'lib/rake/man'
+require 'lib/rake/bundler'
+
+task :default => [:test,:features,:man]

data/bin/hk

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby
+require 'gli'
+require 'hk'
+
+include GLI::App
+
+program_desc 'Expedient interface to your heroku apps'
+program_long_desc %{The heroku command-line app does a lot of stuff, however it's not geared toward making common things simple.  Further, it doesn't know about environments, and it can be a pain to type app names in all the time.
+
+hk aims to make that simpler by allowing expedient access to commonly-needed commands as well as a simpler way to specify which app - and which environment - you want to operate on}
+
+preserve_argv
+
+version Hk::VERSION
+
+Hk::GlobalOptions.declare_gli_options(self)
+
+desc "Bootstrap your extensions/customizations directory"
+long_desc "You can create your own customizations and aliases for complex Heroku commands, by placing Ruby code in ~/.hk/commands.  `init` will set that up and give you basic instructions on how to do it"
+
+command :init do |c|
+  c.action do |_,_,_|
+    commands_dir = File.join(ENV["HOME"],".hk","commands")
+    FileUtils.mkdir_p commands_dir
+    filename = File.join(commands_dir,"commands.rb")
+    exit_now!("you already have commands defined in #{commands_dir.gsub(ENV['HOME'],'~')}") if File.exists?(filename)
+    File.open(filename,"w") do |file|
+      file.puts <<EOS
+# This file gets require'ed into hk directly, so you can put whatever Ruby
+# code you want here.  It follows the GLI syntax, but there are additional
+# helpers for making an hk-style command.
+
+
+desc 'Get app info'          # This shows up in `hk help`
+arg_name Hk::ARG_NAME        # This makes your usage string canonical, so just leave verbatim
+command :info do |c|         # You can also an array for multiple names
+  c.action do |_,_,args|
+    Hk.run("apps:info",args) # This will run heroku apps:info --app=<derived app name>
+  end
+end
+
+# You can add as many of these as you like
+
+SKIP_DEFAULTS=false # set this to true to NOT create the default aliases that come with hk
+                    # Useful if you aren't a Rails developer or Postgres user
+EOS
+    end
+  end
+end
+
+commands_from File.join(ENV["HOME"],".hk","commands")
+
+skip_defaults = defined?(SKIP_DEFAULTS) && SKIP_DEFAULTS == true
+unless skip_defaults
+  {
+    :logs => {
+      desc: "Tail logs for app",
+      command: "logs --tail",
+    },
+    :console => {
+      desc: "Get a rails console for app",
+      command: "run rails c",
+    },
+    :psql => {
+      desc: "Get a database console for app",
+      command: "pg:psql ",
+    }
+  }.each do |name,metadata|
+    desc metadata[:desc]
+    arg_name Hk::ARG_NAME
+    command name do |c|
+      c.action do |_,_,args|
+        Hk.run(metadata[:command],args)
+      end
+    end
+  end
+end
+
+pre do |global,command,options,args|
+  $heroku = Hk::HerokuCommand.new(global[:heroku],global[:verbose],global["no-app-derivation"])
+  true
+end
+
+on_error do |exception|
+  case exception
+  when GLI::CustomExit
+    true
+  else
+    opts = Hk::GlobalOptions.option_parser
+
+    args = opts.parse_and_get_args(ARGV)
+
+    heroku = Hk::HerokuCommand.new(opts.heroku,opts.verbose,opts.no_app_derivation)
+    heroku.run(args[0..-2].map {|_| "'#{_}'"}.join(" "),args[-1])
+    false
+  end
+end
+
+exit run(ARGV)

data/features/hk.feature

@@ -0,0 +1,52 @@
+Feature: Basic UI
+  In order to stop typing so much 
+  And mis-spelling heroku as "heroky"
+  I want a configurable shortcut app
+
+  Scenario: App has a help system
+    When I get help for "hk"
+    Then the exit status should be 0
+    And there should be an option to specify where the heroku command is
+
+  Scenario: arbitrary heroku command derives the app name
+    Given I have the heroku apps "foo-production,foo-staging,bar-production"
+    When I run the app with "blah f-p"
+    Then the heroku command-line app should be executed with the args "blah --app=foo-production"
+
+  Scenario: can avoid deriving the app name
+    Given I have the heroku apps "foo-production,foo-staging,bar-production"
+    When I run the app with "-n blah --app=f-p"
+    Then the heroku command-line app should be executed with the args "blah --app=f-p"
+
+  Scenario: logs command is helpful
+    Given I have the heroku apps "foo-production,foo-staging,bar-production"
+    When I run the app with "logs f-p"
+    Then the heroku command-line app should be executed with the args "logs --tail --app=foo-production"
+
+  Scenario: console command is helpful
+    Given I have the heroku apps "foo-production,foo-staging,bar-production"
+    When I run the app with "console f-p"
+    Then the heroku command-line app should be executed with the args "run rails c --app=foo-production"
+
+  Scenario: Can add my own commands
+    Given I have the heroku apps "foo-production,foo-staging,bar-production"
+    And I have the custom command "info" defined to run "apps:info"
+    When I run the app with "info f-p"
+    Then the heroku command-line app should be executed with the args "apps:info --app=foo-production"
+
+  Scenario: Can bootstrap the plugins
+    When I run the app with "init"
+    Then the file ".hk/commands/commands.rb" should exist in my home directory
+
+  Scenario: Won't squash existing file
+    Given I run the app with "init"
+    When I run the app with "init"
+    Then the exit status should not be 0
+    And the stderr should contain "error: you already have commands defined in ~/.hk/commands"
+
+  Scenario: Can skip the built-in aliases
+    Given my plugins specify SKIP_DEFAULTS=true
+    When I run the app with "help"
+    Then I should not see help for "logs"
+    And I should not see help for "console"
+    And I should not see help for "psql"

data/features/step_definitions/hk_steps.rb

@@ -0,0 +1,52 @@
+When /^I get help for "([^"]*)"$/ do |app_name|
+  @app_name = app_name
+  step %(I run `#{app_name} help`)
+end
+
+And /^there should be an option to specify where the heroku command is$/ do
+  step %{the output should contain "--heroku"}
+end
+
+Given(/^I have the heroku apps "(.*?)"$/) do |app_list|
+end
+
+When(/^I run the app with "(.*?)"$/) do |app_args|
+  fake_heroku = File.join(File.dirname(__FILE__),'..','support','fake_heroku.rb')
+  step %{I run `hk --heroku=#{fake_heroku} #{app_args}`}
+end
+
+Then(/^the heroku command\-line app should be executed with the args "(.*?)"$/) do |args|
+  step %{the output should contain "#{args}"}
+end
+
+Given(/^I have the custom command "(.*?)" defined to run "(.*?)"$/) do |command, args|
+  commands_file_dir = File.join(FAKE_HOME,".hk","commands")
+  FileUtils.mkdir_p commands_file_dir
+  File.open(File.join(commands_file_dir,"commands.rb"),"w") do |file|
+    file.puts <<EOS
+desc 'Get app info'
+arg_name Hk::ARG_NAME
+command "#{command}" do |c|
+  c.action do |_,_,args|
+    Hk.run("#{args}",args)
+  end
+end
+EOS
+  end
+end
+
+Then(/^the file "(.*?)" should exist in my home directory$/) do |file_name|
+  File.exists?(File.join(ENV["HOME"],file_name)).should == true
+end
+
+Given(/^my plugins specify SKIP_DEFAULTS=true$/) do
+  commands_file_dir = File.join(FAKE_HOME,".hk","commands")
+  FileUtils.mkdir_p commands_file_dir
+  File.open(File.join(commands_file_dir,"commands.rb"),"w") do |file|
+    file.puts "SKIP_DEFAULTS=true"
+  end
+end
+
+Then(/^I should not see help for "(.*?)"$/) do |arg1|
+  step %{the output should not match /#{arg1}\s+-/}
+end

data/features/support/env.rb

@@ -0,0 +1,21 @@
+require 'aruba/cucumber'
+
+ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"
+LIB_DIR = File.join(File.expand_path(File.dirname(__FILE__)),'..','..','lib')
+FAKE_HOME = "/tmp/fake_home"
+
+Before do
+  # Using "announce" causes massive warnings on 1.9.2
+  @puts = true
+  @original_rubylib = ENV['RUBYLIB']
+  ENV['RUBYLIB'] = LIB_DIR + File::PATH_SEPARATOR + ENV['RUBYLIB'].to_s
+  FileUtils.rm_rf FAKE_HOME
+  FileUtils.mkdir_p FAKE_HOME
+  @original_home = ENV['HOME']
+  ENV['HOME'] = FAKE_HOME
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+  ENV['HOME'] = @original_home
+end

data/features/support/fake_heroku.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+if ARGV[0] == "apps"
+  puts  <<-EOF
+
+===
+foo-production     blah@herokumanager.com
+foo-staging        blah@herokumanager.com
+bar-production     blah@herokumanager.com
+  EOF
+else
+  puts ARGV.join(" ")
+end

data/hk.gemspec

@@ -0,0 +1,26 @@
+# Ensure we require the local version and not one we might have installed already
+require File.join([File.dirname(__FILE__),'lib','hk','version.rb'])
+spec = Gem::Specification.new do |s| 
+  s.name = 'hk'
+  s.version = Hk::VERSION
+  s.author = 'Your Name Here'
+  s.email = 'your@email.address.com'
+  s.homepage = 'http://your.website.com'
+  s.platform = Gem::Platform::RUBY
+  s.summary = 'A description of your project'
+# Add your other files here if you make them
+  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"]
+  s.has_rdoc = false
+  s.bindir = 'bin'
+  s.executables << 'hk'
+  s.add_development_dependency('clean_test')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('aruba')
+  s.add_development_dependency('ronn')
+  s.add_runtime_dependency('gli','~> 2')
+  s.add_runtime_dependency('gem-man')
+end

data/lib/hk.rb

@@ -0,0 +1,13 @@
+require 'hk/version'
+require 'hk/global_options'
+require 'hk/heroku_runner'
+require 'hk/app_lister'
+require 'hk/app_name_deriver'
+require 'hk/heroku_command'
+module Hk
+  ARG_NAME = "app_name-environment"
+
+  def self.run(heroku_command_args,args)
+    $heroku.run(heroku_command_args,args.first)
+  end
+end

data/lib/hk/app_lister.rb

@@ -0,0 +1,11 @@
+module Hk
+  class AppLister
+    def initialize(heroku_runner)
+      @heroku_runner = heroku_runner
+    end
+
+    def list_apps
+      @heroku_runner.run_internal("apps | cut -d ' ' -f1 | grep -v '==='").split(/\n/).map(&:strip)
+    end
+  end
+end

data/lib/hk/app_name_deriver.rb

@@ -0,0 +1,35 @@
+module Hk
+  class AppNameDeriver
+    def initialize(app_lister)
+      @app_lister = app_lister
+    end
+
+    def derive(app_string)
+      app,environment = app_string.split(/\-/)
+      apps = @app_lister.list_apps
+
+      return app_string if apps.include?(app_string)
+
+      apps = apps.map { |_| _.split(/\-/)}.select { |(a,_)|
+        a =~ /^#{app}/
+      }.select { |(_,e)|
+        if e.nil? && environment.nil?
+          true
+        elsif e.nil?
+          false
+        elsif environment.nil?
+          false
+        else
+          e =~ /^#{environment}/
+        end
+      }
+      if apps.size == 1
+        apps.first.join("-")
+      elsif apps.size == 0
+        raise "No such app name matched #{app_string}"
+      else
+        raise "Ambiguous app name for #{app_string}.  Matches: #{apps.map {|_| _.join("-") }.join(',')}"
+      end
+    end
+  end
+end

data/lib/hk/global_options.rb

@@ -0,0 +1,49 @@
+module Hk
+  # Since we have to do some hacking to handle arbitrary commands,
+  # this serves as a central location for the global options that enable that.
+  class GlobalOptions
+    def self.declare_gli_options(app)
+      app.desc "Explicitly set where to find the herkou CLI app"
+      app.default_value "heroku"
+      app.arg_name "path_to_heroku"
+      app.flag :heroku
+
+      app.desc "Be verbose - show the heroku commands being run"
+      app.switch :verbose
+
+      app.desc "Do not derive the app name or append --app to the command"
+      app.switch [:n,"no-app-derivation"], negatable: false
+
+    end
+
+    def self.option_parser
+      OptionParser.new.tap { |opts|
+        class << opts
+          def heroku=(h)
+            @heroku = h
+          end
+          def heroku; @heroku || "heroku"; end
+          def verbose=(v)
+            @verbose = v
+          end
+          def verbose; @verbose; end
+          def no_app_derivation=(v)
+            @no_app_derivation = v
+          end
+          def no_app_derivation; @no_app_derivation; end
+          def parse_and_get_args(args)
+            args = args.dup
+            self.order!(args) do |unknown_option|
+              args.unshift(unknown_option)
+              break
+            end
+            args
+          end
+        end
+        opts.on("--heroku HEROKU")          { |path| opts.heroku = path }
+        opts.on("--verbose")                { opts.verbose = true }
+        opts.on("-n","--no-app-derivation") { opts.no_app_derivation = true }
+      }
+    end
+  end
+end

data/lib/hk/heroku_command.rb

@@ -0,0 +1,18 @@
+module Hk
+  class HerokuCommand
+    def initialize(path_to_heroku,verbose,no_app_derivation)
+      @heroku = Hk::HerokuRunner.new(path_to_heroku,verbose)
+      @app_name_deriver = if no_app_derivation
+                            ->(app_name_string) { app_name_string }
+                          else
+                            ->(app_name_string) {
+                              "--app=#{Hk::AppNameDeriver.new(Hk::AppLister.new(@heroku)).derive(app_name_string)}"
+                            }
+                          end
+    end
+
+    def run(heroku_args,app_name_string)
+      @heroku.("#{heroku_args} #{@app_name_deriver.(app_name_string)}")
+    end
+  end
+end

data/lib/hk/heroku_runner.rb

@@ -0,0 +1,24 @@
+module Hk
+  class HerokuRunner
+    def initialize(heroku_command,verbose)
+      @heroku_command = heroku_command
+      @verbose = verbose
+    end
+
+    def run(args)
+      command = "#{@heroku_command} #{args}"
+      puts command if @verbose
+      system(command)
+    end
+
+    def call(args)
+      run(args)
+    end
+
+    def run_internal(args)
+      command = "#{@heroku_command} #{args}"
+      puts command if @verbose
+      `#{command}`
+    end
+  end
+end

data/lib/hk/version.rb

@@ -0,0 +1,3 @@
+module Hk
+  VERSION = '0.0.1'
+end

data/lib/rake/bundler.rb

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/rake/cucumber.rb

@@ -0,0 +1,25 @@
+require 'cucumber'
+require 'cucumber/rake/task'
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+
+desc 'Run features'
+Cucumber::Rake::Task.new(:features) do |t|
+  opts = "features --format html -o #{CUKE_RESULTS} --format progress -x"
+  opts += " --tags #{ENV['TAGS']}" if ENV['TAGS']
+  t.cucumber_opts =  opts
+  t.fork = false
+end
+
+desc 'Run features tagged as work-in-progress (@wip)'
+Cucumber::Rake::Task.new('features:wip') do |t|
+  tag_opts = ' --tags ~@pending'
+  tag_opts = ' --tags @wip'
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty -x -s#{tag_opts}"
+  t.fork = false
+end
+
+task :cucumber => :features
+task 'cucumber:wip' => 'features:wip'
+task :wip => 'features:wip'

data/lib/rake/man.rb

@@ -0,0 +1,8 @@
+require 'fileutils'
+include FileUtils
+
+desc "Generate man pages and README"
+task :man do
+  sh 'ronn --markdown --roff man/hk.1.ronn'
+  mv 'man/hk.1.markdown','README.md'
+end

data/lib/rake/test.rb

@@ -0,0 +1,6 @@
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/*_test.rb']
+end
+

data/man/hk.1

@@ -0,0 +1,176 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "HK" "1" "August 2013" "" ""
+.
+.SH "NAME"
+\fBhk\fR \- Simplify your access to Heroku on the command\-line
+.
+.SH "SYNOPSIS"
+\fBhk **alias** _app_string_\fR
+.
+.P
+\fBhk **any heroku invocation** _app_string_\fR
+.
+.SH "INSTALL"
+.
+.nf
+
+$ gem install hk
+.
+.fi
+.
+.SH "DESCRIPTION"
+\fBhk\fR is an alias system for Heroku\'s command\-line app that does three things:
+.
+.IP "\(bu" 4
+Wrap complex or cumbersome commands and options into single\-word (or single\-letter) aliases (e\.g\. \fBhk logs\fR will do \fBheroku logs \-\-tail\fR)
+.
+.IP "\(bu" 4
+Derive application names from shorter\-strings (e\.g\. \fBhk logs f\-p\fR will run \fBheroku logs \-\-tail \-\-app=foo\-production\fR)
+.
+.IP "\(bu" 4
+Alleviates you from typing \fBheroku\fR, which is hard to type and prone to misspellings
+.
+.IP "" 0
+.
+.P
+\fBhk\fR can easily be extended with whatever command aliases you would like\. It also passes through any unknown command to the underlying \fBheroku\fR command, but \fIdoes do\fR the app name derivation\.
+.
+.SH "COMMAND ALIASING"
+Command aliasing is fairly straightforward \- a string is used to generate a more complex heroku command invocation\. You can create your own in \fB~/\.hk/commands/commands\.rb\fR (boilerplate which can be created via \fBhk init\fR)\.
+.
+.IP "" 4
+.
+.nf
+
+desc \'Get app info\'
+arg_name Hk::ARG_NAME
+command :info do |c|
+  c\.action do |_,_,args|
+    Hk\.run("apps:info",args)
+  end
+end
+.
+.fi
+.
+.IP "" 0
+.
+.P
+This code is the GLI DSL, so you can use that entire API if you want to, however the above is a minimal example\.
+.
+.P
+You\'ll note that your command now shows up if you do \fBhk help\fR\.
+.
+.SH "APP NAME DERIVATION"
+If your team is maintaining various apps on heroku, and using it for staging, it can be quite cumbersome to be constantly typing out the names of apps\. It\'s also somewhat dangerous to rely on the \fB\.git/config\fR because it obfuscates what\'s going to happen behind your current directory\.
+.
+.P
+\fBhk\fR will derive your application name, assuming that you use a canonical naming structure that is \fBapp_name\-environment_name\fR\. \fBapp_name\fR is a logical name for your app, e\.g\. "foobar"\. \fBenvironment_name\fR is a logical name for an environment, like "staging" or "production"\.
+.
+.P
+So, instead of typing \fB\-\-app=foobar\-production\fR, you can simply type \fBf\-p\fR\. As long as you have no other app that starts with "f", and no other environment that starts with "p" (based on the output of \fBheroku apps\fR), then \fBhk\fR will derive the name\. You can add more letters to disambiguate, so if you had an app call "frob\-production", you would use "fo\-p" for "foobar\-production" and "fr\-p" for "frob\-production"
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-\-heroku PATH_TO_HEROKU\fR
+Specify where the heroku command line app is\. If omitted, will just use your path
+.
+.TP
+\fB\-\-verbose\fR
+If specified, will output the heroku command being executed
+.
+.TP
+\fB\-n\fR,\fB\-\-no\-app\-derivation\fR
+If specified, will skip deriving the app and tacking on a \fB\-\-app\fR option
+.
+.SH "EXAMPLES"
+There are three builtin aliases (which you can disable by setting SKIP_DEFAULTS=true in your customizations file): console, logs, and psql:
+.
+.IP "" 4
+.
+.nf
+
+hk logs f\-p
+# heroku logs \-\-tail \-\-app=foo\-production
+
+hk console f\-p
+# heroku run rails c \-\-app=foo\-production
+
+hk psql f\-p
+# heroku pg:psql \-\-app=foo\-production
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Unknown commands will pass through, but app derivation will still take place:
+.
+.IP "" 4
+.
+.nf
+
+hk run rake db:migrate f\-s
+# heroku run rake db:migrate \-\-app=foo\-staging
+.
+.fi
+.
+.IP "" 0
+.
+.P
+You can also be explicit about where \fBheroku\fR is you don\'t want to rely on your PATH:
+.
+.IP "" 4
+.
+.nf
+
+hk \-\-heroku=/sbin/herkou logs f\-p
+# /sbin/heroku logs \-\-tail \-\-app=foo\-production
+.
+.fi
+.
+.IP "" 0
+.
+.P
+And, you can skip all the magic if you like:
+.
+.IP "" 4
+.
+.nf
+
+hk \-n \-\-heroku=/sbin/herkou pg:info \-\-app=hellblazer
+# sbin/herkou pg:info \-\-app=hellblazer
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Note that because this is backed by GLI, you only need to specify the command\-name with enough characters to disambiguate it\. For example, given the three builtins, these two are equivalent:
+.
+.IP "" 4
+.
+.nf
+
+hk logs f\-p
+hk l f\-p
+.
+.fi
+.
+.IP "" 0
+.
+.SH "AUTHOR"
+David Copeland, davec (at) naildrivin5\.com
+.
+.SH "COPYRIGHT"
+hk is copyright(c) 2012 by David Copeland, released under the Apache license\.
+.
+.SH "SEE ALSO"
+.
+.IP "\(bu" 4
+Source on github: https://github\.com/davetron5000/hk
+.
+.IP "" 0
+

data/man/hk.1.ronn

@@ -0,0 +1,101 @@
+hk(1) -- Simplify your access to Heroku on the command-line
+===========================================================
+
+## SYNOPSIS
+
+`hk **alias** _app_string_`
+
+`hk **any heroku invocation** _app_string_`
+
+## INSTALL
+
+    $ gem install hk
+
+## DESCRIPTION
+
+**hk** is an alias system for Heroku's command-line app that does three things:
+
+* Wrap complex or cumbersome commands and options into single-word (or single-letter) aliases (e.g. `hk logs` will do `heroku logs --tail`)
+* Derive application names from shorter-strings (e.g. `hk logs f-p` will run `heroku logs --tail --app=foo-production`)
+* Alleviates you from typing `heroku`, which is hard to type and prone to misspellings
+
+**hk** can easily be extended with whatever command aliases you would like.  It also passes through any unknown command to the underlying `heroku` command, but *does do* the app name derivation.
+
+## COMMAND ALIASING
+
+Command aliasing is fairly straightforward - a string is used to generate a more complex heroku command invocation.  You can create your own in `~/.hk/commands/commands.rb` (boilerplate which can be created via `hk init`).
+
+    desc 'Get app info'
+    arg_name Hk::ARG_NAME
+    command :info do |c|
+      c.action do |_,_,args|
+        Hk.run("apps:info",args)
+      end
+    end
+
+This code is the GLI DSL, so you can use that entire API if you want to, however the above is a minimal example.
+
+You'll note that your command now shows up if you do `hk help`.
+
+## APP NAME DERIVATION
+
+If your team is maintaining various apps on heroku, and using it for staging, it can be quite cumbersome to be constantly typing out the names of apps.  It's also somewhat dangerous to rely on the `.git/config` because it obfuscates what's going to happen behind your current directory.
+
+**hk** will derive your application name, assuming that you use a canonical naming structure that is **app_name-environment_name**.  **app_name** is a logical name for your app, e.g. "foobar".  **environment_name** is a logical name for an environment, like "staging" or "production".
+
+So, instead of typing `--app=foobar-production`, you can simply type `f-p`.  As long as you have no other app that starts with "f", and no other environment that starts with "p" (based on the output of `heroku apps`), then **hk** will derive the name.  You can add more letters to disambiguate, so if you had an app call "frob-production", you would use "fo-p" for "foobar-production" and "fr-p" for "frob-production"
+
+## OPTIONS
+
+  * `--heroku PATH_TO_HEROKU`:
+    Specify where the heroku command line app is. If omitted, will just use your path
+  * `--verbose`:
+    If specified, will output the heroku command being executed
+  * `-n`,`--no-app-derivation`:
+    If specified, will skip deriving the app and tacking on a `--app` option
+
+## EXAMPLES
+
+There are three builtin aliases (which you can disable by setting SKIP_DEFAULTS=true in your customizations file): console, logs, and psql:
+
+    hk logs f-p
+    # heroku logs --tail --app=foo-production
+
+    hk console f-p
+    # heroku run rails c --app=foo-production
+
+    hk psql f-p
+    # heroku pg:psql --app=foo-production
+
+Unknown commands will pass through, but app derivation will still take place:
+
+    hk run rake db:migrate f-s
+    # heroku run rake db:migrate --app=foo-staging
+
+You can also be explicit about where `heroku` is you don't want to rely on your PATH:
+
+    hk --heroku=/sbin/herkou logs f-p
+    # /sbin/heroku logs --tail --app=foo-production
+
+And, you can skip all the magic if you like:
+
+    hk -n --heroku=/sbin/herkou pg:info --app=hellblazer
+    # sbin/herkou pg:info --app=hellblazer
+
+Note that because this is backed by GLI, you only need to specify the command-name with enough characters to disambiguate it.  For example, given the three builtins, these two are equivalent:
+
+
+    hk logs f-p
+    hk l f-p
+
+## AUTHOR
+
+David Copeland, davec (at) naildrivin5.com
+
+## COPYRIGHT
+
+hk is copyright(c) 2012 by David Copeland, released under the Apache license.
+
+## SEE ALSO
+
+  * Source on github: https://github.com/davetron5000/hk

data/test/app_name_deriver_test.rb

@@ -0,0 +1,86 @@
+require 'test_helper'
+
+class DefaultTest < Clean::Test::TestCase
+
+  test_that "we can derive the app name when it's unambiguous" do
+    Given {
+      @existing_apps = %w(foo-production foo-staging blah-production)
+    }
+    Given :an_app_name_deriver
+    When {
+      @app_name = @app_name_deriver.derive("f-p")
+    }
+    Then {
+      assert_equal @app_name,"foo-production"
+    }
+  end
+
+  test_that "if there are no matches, we get an exception" do
+    Given {
+      @existing_apps = %w(foo-production foo-staging blah-production)
+    }
+    Given :an_app_name_deriver
+    When {
+      @code = ->() { @app_name_deriver.derive("asdfasdf") }
+    }
+    Then {
+      exception = assert_raises(RuntimeError,&@code)
+      assert_match exception.message,/No such app/
+    }
+  end
+
+  test_that "if there are multiple matches, we get an exception" do
+    Given {
+      @existing_apps = %w(foo-production foo-staging foobar-production)
+    }
+    Given :an_app_name_deriver
+    When {
+      @code = ->() { @app_name_deriver.derive("f-p") }
+    }
+    Then {
+      exception = assert_raises(RuntimeError,&@code)
+      assert_match exception.message,/Ambiguous app name/
+    }
+  end
+
+  test_that "an exact match always succeeds" do
+    Given {
+      @existing_apps = %w(foo-production foobar-production)
+    }
+    Given :an_app_name_deriver
+    When {
+      @app_name = @app_name_deriver.derive("foo-production")
+    }
+    Then {
+      assert_equal @app_name,"foo-production"
+    }
+  end
+
+  test_that "a match without the environment works" do
+    Given {
+      @existing_apps = %w(foo-production foobar)
+    }
+    Given :an_app_name_deriver
+    When {
+      @app_name = @app_name_deriver.derive("f")
+    }
+    Then {
+      assert_equal @app_name,"foobar"
+    }
+  end
+
+private
+
+  def an_app_name_deriver
+    @app_name_deriver = Hk::AppNameDeriver.new(FakeLister.new(@existing_apps))
+  end
+
+  class FakeLister
+    def initialize(apps)
+      @apps = apps
+    end
+    def list_apps(*)
+      @apps
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'test/unit'
+require 'clean_test/test_case'
+require 'hk'
+
+# Add test libraries you want to use here, e.g. mocha
+
+class Test::Unit::TestCase
+
+  # Add global extensions to the test case class here
+  
+end

metadata

@@ -0,0 +1,232 @@
+--- !ruby/object:Gem::Specification
+name: hk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Your Name Here
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clean_test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ronn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: gem-man
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: your@email.address.com
+executables:
+- !binary |-
+  aGs=
+extensions: []
+extra_rdoc_files: []
+files:
+- !binary |-
+  LmdpdGlnbm9yZQ==
+- !binary |-
+  LnJ1YnktZ2Vtc2V0
+- !binary |-
+  LnJ1YnktdmVyc2lvbg==
+- !binary |-
+  R2VtZmlsZQ==
+- !binary |-
+  R2VtZmlsZS5sb2Nr
+- !binary |-
+  UkVBRE1FLm1k
+- !binary |-
+  UmFrZWZpbGU=
+- !binary |-
+  YmluL2hr
+- !binary |-
+  ZmVhdHVyZXMvaGsuZmVhdHVyZQ==
+- !binary |-
+  ZmVhdHVyZXMvc3RlcF9kZWZpbml0aW9ucy9oa19zdGVwcy5yYg==
+- !binary |-
+  ZmVhdHVyZXMvc3VwcG9ydC9lbnYucmI=
+- !binary |-
+  ZmVhdHVyZXMvc3VwcG9ydC9mYWtlX2hlcm9rdS5yYg==
+- !binary |-
+  aGsuZ2Vtc3BlYw==
+- !binary |-
+  bGliL2hrLnJi
+- !binary |-
+  bGliL2hrL2FwcF9saXN0ZXIucmI=
+- !binary |-
+  bGliL2hrL2FwcF9uYW1lX2Rlcml2ZXIucmI=
+- !binary |-
+  bGliL2hrL2dsb2JhbF9vcHRpb25zLnJi
+- !binary |-
+  bGliL2hrL2hlcm9rdV9jb21tYW5kLnJi
+- !binary |-
+  bGliL2hrL2hlcm9rdV9ydW5uZXIucmI=
+- !binary |-
+  bGliL2hrL3ZlcnNpb24ucmI=
+- !binary |-
+  bGliL3Jha2UvYnVuZGxlci5yYg==
+- !binary |-
+  bGliL3Jha2UvY3VjdW1iZXIucmI=
+- !binary |-
+  bGliL3Jha2UvbWFuLnJi
+- !binary |-
+  bGliL3Jha2UvdGVzdC5yYg==
+- !binary |-
+  bWFuL2hrLjE=
+- !binary |-
+  bWFuL2hrLjEucm9ubg==
+- !binary |-
+  dGVzdC9hcHBfbmFtZV9kZXJpdmVyX3Rlc3QucmI=
+- !binary |-
+  dGVzdC90ZXN0X2hlbHBlci5yYg==
+homepage: http://your.website.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3261507201375033656
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3261507201375033656
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A description of your project
+test_files:
+- !binary |-
+  ZmVhdHVyZXMvaGsuZmVhdHVyZQ==
+- !binary |-
+  ZmVhdHVyZXMvc3RlcF9kZWZpbml0aW9ucy9oa19zdGVwcy5yYg==
+- !binary |-
+  ZmVhdHVyZXMvc3VwcG9ydC9lbnYucmI=
+- !binary |-
+  ZmVhdHVyZXMvc3VwcG9ydC9mYWtlX2hlcm9rdS5yYg==
+- !binary |-
+  dGVzdC9hcHBfbmFtZV9kZXJpdmVyX3Rlc3QucmI=
+- !binary |-
+  dGVzdC90ZXN0X2hlbHBlci5yYg==