hsume2-aka 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3369794f383200ea13fef6e746ac0c58b9f1f248
+  data.tar.gz: 835091cbc77b20d99c2ad3b2957d204884fae358
+SHA512:
+  metadata.gz: 87d76091861f959ff6deba94453faf3e8d6af4e24b256c022ec57eb4ebcc952d5dd4bf5aad166c239ea16c5b15820ece7d7809f5f181cb1337344164810ec2d0
+  data.tar.gz: 77964a52a87358e29a1d13e18fa212c5512732cd3b372d449cc3234bb737d29da0573d1d1d589d58afc313d65f8303e7fe47caf9045bce608386d4b4b1d8ae10

data/.gitignore

@@ -0,0 +1,10 @@
+.DS_Store
+results.html
+pkg
+html
+tmp
+Gemfile.lock
+.bundle
+
+# output from ronn
+lib/aka/man/

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0-p247

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+bundler_args: --without guard

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :guard do
+  gem 'guard'
+  gem 'guard-cucumber'
+end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'cucumber', :cli => '--no-profile --color --format progress --strict --tags ~@interactive' do
+  watch(%r{^lib/.+\.rb$})
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2014 YOUR NAME
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,91 @@
+aka(7) -- Manage Shell Keyboard Shortcuts
+=========================================
+
+[![Build Status](https://travis-ci.org/hsume2/aka.png?branch=master)](https://travis-ci.org/hsume2/aka)
+
+## SYNOPSIS
+
+`aka` add <shortcut> <command> \[options\]<br>
+`aka` show <shortcut> \[options\]<br>
+`aka` edit <shortcut> \[options\]<br>
+`aka` remove <shortcut><br>
+`aka` list \[options\]<br>
+`aka` generate \[options\]
+
+## DESCRIPTION
+
+**aka** is an easy way to manage keyboard shortcuts in UNIX shells.
+
+You can replace commonly used commands with shorter, sexier keyboard shortcuts and, ultimately, improve your productivity!
+
+With **aka**, you can add, show, edit, remove, list keyboard shortcuts. On top of that you can tag shortcuts based on environment, tool, context, etc. Then, you can generate an appropriate output file for your environment.
+
+## INSTALLATION
+
+    $ gem install aka
+
+## OPTIONS
+
+  * `--help`:<br>
+    Show help info
+
+  * `--version`:<br>
+    Show version info
+
+  * `--log-level=<debug|info|warn|error|fatal>`:<br>
+    Set the logging level (Default: info)
+
+## EXAMPLES
+
+Add a keyboard shortcut and generate the output script:
+
+    $ aka add ls "ls -F --color=auto"
+    Created shortcut.
+    $ aka generate
+    alias ls="ls -F --color=auto"
+
+Add a keyboard shortcut for a bash/zsh function:
+
+    $ aka add psf "ps aux | grep $@" --function
+    Created shortcut.
+    $ aka generate
+    function psf {
+      ps aux | grep $@
+    }
+
+Generate to a file instead:
+
+    $ aka generate -o ~/.aka.zsh
+    Generated ~/.aka.zsh.
+
+Tag a shortcut and generate for OS X:
+
+    $ aka add ls "ls -F --color=auto" --tag os:linux
+    Created shortcut.
+    $ aka add ls "ls -FG" --tag os:darwin
+    Created shortcut.
+    $ aka generate --tag os:darwin
+    alias ls="ls -FG"
+
+Edit a shortcut:
+
+    $ aka edit ls "ls -F --color=auto" --tag os:linux
+    1 Shortcut: ls
+    2 Description:
+    3
+    4 Function (y/n): n
+    5 Tags: os:linux
+    6 Command:
+    7 ls -FG
+    /var/folders/rj/8bjyj6x92l9bxykxc_ljyqsc0000gp/T/shortcut20140222-63006-13csxr0" 7L, 87C
+    $ :wq
+
+Remove a shortcut:
+
+    $ aka remove ls
+    Removes shortcut.
+
+## ENVIRONMENT
+
+  * `AKA`:<br>
+    The file where **aka** stores everything. Default: ~/.aka.yml

data/Rakefile

@@ -0,0 +1,98 @@
+def dump_load_path
+  puts $LOAD_PATH.join("\n")
+  found = nil
+  $LOAD_PATH.each do |path|
+    if File.exists?(File.join(path,"rspec"))
+      puts "Found rspec in #{path}"
+      if File.exists?(File.join(path,"rspec","core"))
+        puts "Found core"
+        if File.exists?(File.join(path,"rspec","core","rake_task"))
+          puts "Found rake_task"
+          found = path
+        else
+          puts "!! no rake_task"
+        end
+      else
+        puts "!!! no core"
+      end
+    end
+  end
+  if found.nil?
+    puts "Didn't find rspec/core/rake_task anywhere"
+  else
+    puts "Found in #{path}"
+  end
+end
+require 'bundler'
+require 'rake/clean'
+
+require 'rake/testtask'
+
+require 'cucumber'
+require 'cucumber/rake/task'
+gem 'rdoc' # we need the installed RDoc gem, not the system one
+require 'rdoc/task'
+
+include Rake::DSL
+
+Bundler::GemHelper.install_tasks
+
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/tc_*.rb'
+end
+
+
+CUKE_RESULTS = 'results.html'
+CLEAN << CUKE_RESULTS
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x --tags ~@interactive"
+  t.fork = false
+end
+
+Rake::RDocTask.new do |rd|
+
+  rd.main = "README.rdoc"
+
+  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
+end
+
+begin
+  require 'ronn'
+
+  namespace :man do
+    directory "lib/aka/man"
+
+    Dir["man/*.ronn"].each do |ronn|
+      basename = File.basename(ronn, ".ronn")
+      roff = "lib/aka/man/#{basename}"
+
+      file roff => ["lib/aka/man", ronn] do
+        sh "#{Gem.ruby} -S ronn --roff --pipe #{ronn} > #{roff}"
+      end
+
+      file "#{roff}.txt" => roff do
+        sh "groff -Wall -mtty-char -mandoc -Tascii #{roff} | col -b > #{roff}.txt"
+      end
+
+      task :build_all_pages => "#{roff}.txt"
+    end
+
+    desc "Build the man pages"
+    task :build => "man:build_all_pages"
+
+    desc "Clean up from the built man pages"
+    task :clean do
+      rm_rf "lib/aka/man"
+    end
+  end
+
+rescue LoadError
+  namespace :man do
+    task(:build) { abort "Install the ronn gem to be able to release!" }
+    task(:clean) { abort "Install the ronn gem to be able to release!" }
+  end
+end
+
+task :default => ["man:build", :test, :features]
+

data/aka.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aka/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hsume2-aka"
+  spec.version       = Aka::VERSION
+  spec.authors       = ["Henry Hsu"]
+  spec.email         = ["hhsu@zendesk.com"]
+  spec.summary       = %q{Manage Shell Keyboard Shortcuts}
+  spec.description   = %q{Manage Shell Keyboard Shortcuts}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.files        += Dir.glob('lib/aka/man/**/*') # man/ is ignored by git
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency("bundler", "~> 1.5")
+  spec.add_development_dependency('rake', '~> 0.9.2')
+  spec.add_development_dependency('rdoc')
+  spec.add_development_dependency('aruba')
+  spec.add_development_dependency('ronn')
+  spec.add_dependency('methadone', '~> 1.3.1')
+end

data/bin/aka

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'aka.rb'
+
+Aka::App.go!

data/features/aka/add.feature

@@ -0,0 +1,183 @@
+Feature: Add keyboard shortcuts
+  In order to improve productivity
+  I want to have a tool for managing shell keyboard shortcuts
+  So I don't have to do it myself
+
+  Background:
+    Given a file named ".aka.yml" should not exist
+    And I set the AKA environment variable to the ".aka.yml" file in the working directory
+    And I set the environment variables to:
+    | variable | value |
+    | NO_MAN   | 1     |
+
+
+  Scenario: Create new shortcut
+    When I run `aka add ls "ls -F --color=auto"`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    Created shortcut.
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    1: !ruby/object:OpenStruct
+      table:
+        :shortcut: ls
+        :command: ls -F --color=auto
+      modifiable: true
+
+    """
+
+  Scenario: Create new shortcut with tag
+    When I run `aka add ls "ls -F --color=auto" -t os:darwin`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    Created shortcut.
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    1: !ruby/object:OpenStruct
+      table:
+        :shortcut: ls
+        :command: ls -F --color=auto
+        :tag:
+        - os:darwin
+      modifiable: true
+
+    """
+
+  Scenario: Create new shortcut with multiple tags
+    When I run `aka add ls "ls -F --color=auto" -t A,B`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    Created shortcut.
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    1: !ruby/object:OpenStruct
+      table:
+        :shortcut: ls
+        :command: ls -F --color=auto
+        :tag:
+        - A
+        - B
+      modifiable: true
+
+    """
+
+  Scenario: Create new shortcut with new tag
+    Given I run `aka add ls "ls -FG" -t A,B`
+    When I run `aka add ls "ls -FG" -t C`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    Created shortcut.
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    1: !ruby/object:OpenStruct
+      table:
+        :shortcut: ls
+        :command: ls -FG
+        :tag:
+        - A
+        - B
+      modifiable: true
+    2: !ruby/object:OpenStruct
+      table:
+        :shortcut: ls
+        :command: ls -FG
+        :tag:
+        - C
+      modifiable: true
+
+    """
+
+  Scenario: Don't overwrite existing shortcut
+    Given I run `aka add ls "ls -F --color=auto"`
+    When I run `aka add ls "ls -FG"`
+    Then the exit status should not be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    Shortcut "ls" exists. Pass --force to overwrite. Or provide a new --tag.
+
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    1: !ruby/object:OpenStruct
+      table:
+        :shortcut: ls
+        :command: ls -F --color=auto
+      modifiable: true
+
+    """
+
+  Scenario: Overwrite existing shortcut with force
+    Given I run `aka add ls "ls -F --color=auto"`
+    When I run `aka add ls "ls -FG" -f`
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    Overwrote shortcut.
+
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    1: !ruby/object:OpenStruct
+      table:
+        :shortcut: ls
+        :command: ls -FG
+      modifiable: true
+
+    """
+
+  Scenario: Create new shortcut as function
+    When I run `aka add ls "ls -F --color=auto" --function`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    Created shortcut.
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    1: !ruby/object:OpenStruct
+      table:
+        :shortcut: ls
+        :command: ls -F --color=auto
+        :function: true
+      modifiable: true
+
+    """
+
+  Scenario: Create new shortcut with description
+    When I run `aka add ls "ls -F --color=auto" --description "ls\nls\nls"`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    Created shortcut.
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    1: !ruby/object:OpenStruct
+      table:
+        :shortcut: ls
+        :command: ls -F --color=auto
+        :description: |-
+          ls
+          ls
+          ls
+      modifiable: true
+
+    """

data/features/aka/edit.feature

@@ -0,0 +1,91 @@
+Feature: Edit keyboard shortcuts
+  In order to improve productivity
+  I want to have a tool for managing shell keyboard shortcuts
+  So I don't have to do it myself
+
+  Background:
+    Given a file named ".aka.yml" should not exist
+    And I set the AKA environment variable to the ".aka.yml" file in the working directory
+    And I set the environment variables to:
+    | variable | value |
+    | NO_MAN   | 1     |
+
+  Scenario: Edit
+    Given I run `aka add ls "ls -F --color=auto"`
+    And a file named "input.txt" with:
+    """
+    Shortcut: lsf
+    Description:
+    1
+    2
+    3
+    Function (y/n): y
+    Tags: zsh, bash
+    Command:
+    ls -F
+    """
+    When I run `aka edit ls -i input.txt`
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    Saved shortcut.
+
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    1: !ruby/object:OpenStruct
+      table:
+        :shortcut: lsf
+        :command: ls -F
+        :description: |-
+          1
+          2
+          3
+        :function: true
+        :tag:
+        - zsh
+        - bash
+      modifiable: true
+
+    """
+
+  @interactive
+  Scenario: Edit interactively
+    Given I run `aka add ls "ls -F --color=auto"`
+    When I run `aka edit ls` interactively
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    Saved shortcut.
+
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    1: !ruby/object:OpenStruct
+      table:
+        :shortcut: lsf
+        :command: ls -F
+        :description: |-
+          1
+          2
+          3
+        :function: true
+        :tag:
+        - zsh
+        - bash
+      modifiable: true
+
+    """
+
+  Scenario: Edit: Missing shortcut
+    When I run `aka edit ls`
+    Then the exit status should not be 0
+    And the output should contain exactly:
+    """
+    Shortcut not found.
+
+    """

data/features/aka/generate.feature

@@ -0,0 +1,117 @@
+Feature: Generate commands for loading keyboard shortcuts into your shell
+  In order to improve productivity
+  I want to have a tool for managing shell keyboard shortcuts
+  So I don't have to do it myself
+
+  Background:
+    Given a file named ".aka.yml" should not exist
+    And I set the AKA environment variable to the ".aka.yml" file in the working directory
+    And I set the environment variables to:
+    | variable | value |
+    | NO_MAN   | 1     |
+
+  Scenario: Generate script to file
+    Given I run `aka add ls "ls -F --color=auto" --description "ls\nls\nls" --function --tag os:linux`
+    And I run `aka add ls "ls -FG" --tag os:darwin`
+    And I run `aka add .. "cd .."`
+    When I run `aka generate --output .aka.zsh`
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    Created shortcut.
+    Created shortcut.
+    Generated .aka.zsh.
+
+    """
+    And the file ".aka.zsh" should contain exactly:
+    """
+    alias ..="cd .."
+    alias ls="ls -FG"
+    function ls {
+      ls -F --color=auto
+    }
+
+    """
+
+  Scenario: Generate script to stdout
+    Given I run `aka add ls "ls -F --color=auto" --description "ls\nls\nls" --function --tag os:linux`
+    And I run `aka add ls "ls -FG" --tag os:darwin`
+    And I run `aka add .. "cd .."`
+    When I run `aka generate`
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    Created shortcut.
+    Created shortcut.
+    alias ..="cd .."
+    alias ls="ls -FG"
+    function ls {
+      ls -F --color=auto
+    }
+
+    """
+
+  Scenario: Generate script matching tag
+    Given I run `aka add ls "ls -F --color=auto" --description "ls\nls\nls" --function --tag os:linux`
+    And I run `aka add ls "ls -FG" --tag os:darwin`
+    And I run `aka add .. "cd .."`
+    When I run `aka generate --tag os:darwin`
+    Then the exit status should be 0
+    And the stdout should contain exactly:
+    """
+    Created shortcut.
+    Created shortcut.
+    Created shortcut.
+    alias ..="cd .."
+    alias ls="ls -FG"
+
+    """
+    And the stderr should contain exactly:
+    """
+    1 shortcut(s) excluded (#os:linux).
+
+    """
+
+  Scenario: Generate script with function
+    Given I run `aka add ls "ls -F --color=auto" --function`
+    When I run `aka generate --output .aka2.zsh`
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    Generated .aka2.zsh.
+
+    """
+    And the file ".aka2.zsh" should contain exactly:
+    """
+    function ls {
+      ls -F --color=auto
+    }
+
+    """
+
+  Scenario: Generate script shortcuts before functions
+    Given I run `aka add ls "ls -F --color=auto" --function`
+    And I run `aka add sc "script/console"`
+    And I run `aka add sg "script/generate"`
+    When I run `aka generate --output .aka.zsh`
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    Created shortcut.
+    Created shortcut.
+    Generated .aka.zsh.
+
+    """
+    And the file ".aka.zsh" should contain exactly:
+    """
+    alias sc="script/console"
+    alias sg="script/generate"
+    function ls {
+      ls -F --color=auto
+    }
+
+    """