hsume2-aka 0.1.0

data/features/aka/help.feature

@@ -0,0 +1,80 @@
+Feature: Help with aka
+  In order to learn how to use aka
+  I want to view help info in the command-line
+  So I don't have to scour the web for information
+
+  Background:
+    Given I set the environment variables to:
+    | variable | value |
+    | NO_MAN   | 1     |
+
+  Scenario: Run aka
+    When I run `aka`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    aka - Manage Shell Keyboard Shortcuts
+    """
+
+  Scenario: Get help
+    When I run `aka --help`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    aka - Manage Shell Keyboard Shortcuts
+    """
+
+  Scenario: Get version
+    When I run `aka --version`
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    aka version 0.1.0
+
+    """
+
+  Scenario: Help creating new shortcut
+    When I run `aka -h add`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    aka-add - Add keyboard shortcuts
+    """
+
+  Scenario: Help listing shortcuts
+    When I run `aka -h list`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    aka-list - List keyboard shortcuts
+    """
+
+  Scenario: Help generating shortcuts
+    When I run `aka -h generate`
+    Then the exit status should be 0
+    And the output should contain "aka-generate"
+    And the output should contain "Generate  commands for loading keyboard shortcuts into"
+
+  Scenario: Help removing shortcuts
+    When I run `aka -h remove`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    aka-remove - Remove keyboard shortcuts
+    """
+
+  Scenario: Help showing shortcuts
+    When I run `aka -h show`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    aka-show - Show keyboard shortcuts
+    """
+
+  Scenario: Help editing shortcuts
+    When I run `aka -h edit`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    aka-edit - Edit keyboard shortcuts
+    """

data/features/aka/list.feature

@@ -0,0 +1,62 @@
+Feature: List 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: List shortcuts
+    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 list`
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    Created shortcut.
+    Created shortcut.
+    #default
+    ========
+    ..                            cd ..
+
+    #os:linux
+    =========
+    ls                            ls; ls; ls
+
+    #os:darwin
+    ==========
+    ls                            ls -FG
+
+
+    """
+
+  Scenario: List shortcuts 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 ..." --tag os:windows`
+    And I run `aka add .. "cd .."`
+    When I run `aka list --tag os:darwin`
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    Created shortcut.
+    Created shortcut.
+    Created shortcut.
+    #default
+    ========
+    ..                            cd ..
+
+    #os:darwin
+    ==========
+    ls                            ls -FG
+
+    2 shortcut(s) excluded (#os:linux, #os:windows).
+
+    """

data/features/aka/remove.feature

@@ -0,0 +1,48 @@
+Feature: Remove 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: Remove shortcut
+    Given I run `aka add ls "ls -F --color=auto"`
+    When I run `aka remove ls`
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    Removed shortcut.
+
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    --- {}
+
+    """
+
+  Scenario: Remove missing shortcut
+    Given I run `aka add ls "ls -F --color=auto"`
+    When I run `aka remove ..`
+    Then the exit status should not be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    No shortcut "..". Aborting.
+
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    1: !ruby/object:OpenStruct
+      table:
+        :shortcut: ls
+        :command: ls -F --color=auto
+      modifiable: true
+
+    """

data/features/aka/show.feature

@@ -0,0 +1,38 @@
+Feature: Show 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: Show shortcut
+    Given I run `aka add ls "ls -F --color=auto" --function --description "1\n2" --tag osx`
+    When I run `aka show ls`
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    Shortcut: ls
+    Description:
+    1
+    2
+    Function: y
+    Tags: #osx
+    Command:
+    ls -F --color=auto
+
+    """
+
+  Scenario: Show missing shortcut
+    When I run `aka show ls`
+    Then the exit status should not be 0
+    And the output should contain exactly:
+    """
+    Shortcut not found.
+
+    """

data/features/step_definitions/aka_steps.rb

@@ -0,0 +1,3 @@
+Given(/^I set the AKA environment variable to the "(.*?)" file in the working directory$/) do |file_name|
+  set_env('AKA', File.expand_path(File.join(File.dirname(__FILE__), '../../tmp/aruba', file_name)))
+end

data/features/support/env.rb

@@ -0,0 +1,80 @@
+require 'aruba/cucumber'
+require 'methadone/cucumber'
+require 'aruba/in_process'
+
+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')
+
+require 'aka.rb'
+
+class Main
+  def initialize(argv, stdin = STDIN, stdout = STDOUT, stderr = STDERR, kernel = Kernel)
+    @argv, @stdin, @stdout, @stderr, @kernel = argv, stdin, stdout, stderr, kernel
+  end
+
+  def execute!
+    original_file = $0
+    original_argv = ::ARGV.dup
+    original_stderr = $original_stderr = $stderr
+    original_stdin = $original_stdin = $stdin
+    original_stdout = $stdout
+
+    Aruba::Api.class_eval do
+      def announcer
+        Aruba::Api::Announcer.new(self,
+          :stdout => $original_stdin,
+          :stderr => $original_stderr,
+          :dir => @announce_dir,
+          :cmd => @announce_cmd,
+          :env => @announce_env)
+      end
+    end
+
+    begin
+      $0 = File.expand_path(File.dirname(__FILE__) + '/../../bin/aka')
+
+      ::ARGV.clear
+      ::ARGV.push(*@argv)
+
+      $stderr = @stderr
+      $stdin = @stdin
+      $stdout = @stdout
+
+      if defined?(Aka::App)
+        Aka::App.send(:reset!)
+        load 'aka/app.rb'
+      end
+
+      Aka::App.change_logger(Methadone::CLILogger.new(@stdout, @stderr))
+
+      Aka::App.go!
+    rescue SystemExit => e
+      @kernel.exit(e.status)
+    ensure
+      $0 = original_file
+
+      ::ARGV.clear
+      ::ARGV.push(*original_argv)
+
+      $stderr = original_stderr
+      $stdin = original_stdin
+      $stdout = original_stdout
+
+      Aka::App.change_logger(Methadone::CLILogger.new($stdout, $stderr))
+    end
+  end
+end
+
+Aruba::InProcess.main_class = Main
+Aruba.process = Aruba::InProcess
+
+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
+end
+
+After do
+  ENV['RUBYLIB'] = @original_rubylib
+end

data/lib/aka/app.rb

@@ -0,0 +1,66 @@
+require 'optparse'
+require 'methadone'
+
+module Aka
+  class App
+    include Methadone::Main
+    include Methadone::CLILogging
+
+    def self.which(executable)
+      if File.file?(executable) && File.executable?(executable)
+        executable
+      elsif ENV['PATH']
+        path = ENV['PATH'].split(File::PATH_SEPARATOR).find do |p|
+          File.executable?(File.join(p, executable))
+        end
+        path && File.expand_path(executable, path)
+      end
+    end
+
+    main do |command, shortcut, script|
+      if options[:version]
+        puts "aka version #{Aka::VERSION}"
+        exit
+      end
+
+      options['shortcut'] = options[:shortcut] = shortcut
+      options['command'] = options[:command] = script
+
+      store = Aka::Store.new
+
+      store.help(command, options) and exit if options[:help]
+
+      case command
+      when 'add'
+        store.add(options)
+      when 'list'
+        store.list(options)
+      when 'remove'
+        store.remove(options)
+      when 'generate'
+        store.generate(options)
+      when 'edit'
+        store.edit(options)
+      when 'show'
+        store.show(options)
+      else
+        store.help(command, options)
+      end
+    end
+
+    arg :command, :optional
+    arg :shortcut, :optional
+    arg :script, :optional
+
+    on("-t TAG", '--tag', Array)
+    on("-f", '--force')
+    on("-F", "--function")
+    on("-d DESCRIPTION", "--description")
+    on("-o FILE", "--output")
+    on("-i FILE", "--input")
+    on("-h", "--help")
+    on("-v", "--version")
+
+    use_log_level_option
+  end
+end

data/lib/aka/man/aka-add.1

@@ -0,0 +1,34 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "AKA\-ADD" "1" "February 2014" "" ""
+.
+.SH "NAME"
+\fBaka\-add\fR \- Add keyboard shortcuts
+.
+.SH "SYNOPSIS"
+\fBaka add\fR \fIshortcut\fR \fIcommand\fR [\fB\-d\fR \fIdescription\fR] [\fB\-t\fR \fItag1\fR[,\fItag2\fR\.\.\.]] [\fB\-F\fR] [\fB\-f\fR]
+.
+.SH "DESCRIPTION"
+This command adds a keyboard shortcut to \fBaka(7)\fR\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-d <description>\fR
+Provide a description for the shortcut\.
+.
+.TP
+\fB\-t\fR \fItag1\fR[,\fItag2\fR\.\.\.]
+A comma\-separated list of tags for the shortcut\.
+.
+.TP
+\fB\-F\fR
+Create the shortcut as a shell function\.
+.
+.TP
+\fB\-f\fR
+Ovewrite an existing shortcut if a shortcut exists with the same \fIshortcut\fR\.
+.
+.SH "SEE ALSO"
+\fBaka(7)\fR, \fBaka\-show(1)\fR

data/lib/aka/man/aka-add.1.txt

@@ -0,0 +1,31 @@
+AKA-ADD(1)							    AKA-ADD(1)
+
+
+
+NAME
+       aka-add - Add keyboard shortcuts
+
+SYNOPSIS
+       aka add shortcut command [-d description] [-t tag1[,tag2...]] [-F] [-f]
+
+DESCRIPTION
+       This command adds a keyboard shortcut to aka(7).
+
+OPTIONS
+       -d <description>
+	      Provide a description for the shortcut.
+
+       -t tag1[,tag2...]
+	      A comma-separated list of tags for the shortcut.
+
+       -F     Create the shortcut as a shell function.
+
+       -f     Ovewrite an existing shortcut if a shortcut exists with the same
+	      shortcut.
+
+SEE ALSO
+       aka(7), aka-show(1)
+
+
+
+				 February 2014			    AKA-ADD(1)

data/lib/aka/man/aka-edit.1

@@ -0,0 +1,96 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "AKA\-EDIT" "1" "February 2014" "" ""
+.
+.SH "NAME"
+\fBaka\-edit\fR \- Edit keyboard shortcuts
+.
+.SH "SYNOPSIS"
+\fBaka edit\fR \fIshortcut\fR [\fB\-i\fR input]
+.
+.SH "DESCRIPTION"
+This command edits a keyboard shortcut in \fBaka(7)\fR\.
+.
+.P
+The command can be performed interactively or via an input file\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-i <input>\fR
+Update the shortcut with an input file\. See the "FORMAT" section for more details\.
+.
+.SH "FORMAT"
+The format should include the following sections (in order):
+.
+.IP "\(bu" 4
+\fBShortcut: <shortcut>\fR
+.
+.br
+Where \fIshortcut\fR is the string to change the \fIshortcut\fR cut\.
+.
+.IP "\(bu" 4
+\fBDescription: <description>\fR
+.
+.br
+Where \fIdescription\fR is one or more lines of text\.
+.
+.IP "\(bu" 4
+\fBFunction (y/n): <y|n>\fR
+.
+.br
+Where \fIy|n\fR is either \fBy\fR or \fBn\fR\.
+.
+.IP "\(bu" 4
+\fBTags: <tags>\fR
+.
+.br
+Where \fItags\fR is a comma\-separated list of tags for the shortcut\.
+.
+.IP "\(bu" 4
+\fBCommand: <command>\fR
+.
+.br
+Where \fIcommand\fR is one or more lines of text\.
+.
+.IP "" 0
+.
+.SH "INTERACTIVE MODE"
+When the command enters the interactive mode, it shows the \fIshortcut\fR in the expected \fBFORMAT\fR in an interactive editor\.
+.
+.SH "EXAMPLES"
+Edit a shortcut where \fBinput\.txt\fR is:
+.
+.IP "" 4
+.
+.nf
+
+Shortcut: lsf
+Description:
+1
+2
+3
+Function (y/n): y
+Tags: zsh, bash
+Command:
+ls \-F
+
+$ aka edit lsf \-i input\.txt
+Saved shortcut\.
+.
+.fi
+.
+.IP "" 0
+.
+.SH "ENVIRONMENT"
+.
+.TP
+\fBEDITOR\fR:
+.
+.br
+The editor \fBaka\fR will use in interactive mode\. Default: vim
+
+.
+.SH "SEE ALSO"
+\fBaka(7)\fR, \fBaka\-show(1)\fR

data/lib/aka/man/aka-edit.1.txt

@@ -0,0 +1,75 @@
+AKA-EDIT(1)							   AKA-EDIT(1)
+
+
+
+NAME
+       aka-edit - Edit keyboard shortcuts
+
+SYNOPSIS
+       aka edit shortcut [-i input]
+
+DESCRIPTION
+       This command edits a keyboard shortcut in aka(7).
+
+       The command can be performed interactively or via an input file.
+
+OPTIONS
+       -i <input>
+	      Update the shortcut with an input file. See the "FORMAT" section
+	      for more details.
+
+FORMAT
+       The format should include the following sections (in order):
+
+       o   Shortcut: <shortcut>
+	   Where shortcut is the string to change the shortcut cut.
+
+       o   Description: <description>
+	   Where description is one or more lines of text.
+
+       o   Function (y/n): <y|n>
+	   Where y|n is either y or n.
+
+       o   Tags: <tags>
+	   Where tags is a comma-separated list of tags for the shortcut.
+
+       o   Command: <command>
+	   Where command is one or more lines of text.
+
+
+
+INTERACTIVE MODE
+       When the command enters the interactive mode, it shows the shortcut  in
+       the expected FORMAT in an interactive editor.
+
+EXAMPLES
+       Edit a shortcut where input.txt is:
+
+
+
+	   Shortcut: lsf
+	   Description:
+	   1
+	   2
+	   3
+	   Function (y/n): y
+	   Tags: zsh, bash
+	   Command:
+	   ls -F
+
+	   $ aka edit lsf -i input.txt
+	   Saved shortcut.
+
+
+
+ENVIRONMENT
+       EDITOR:
+	      The editor aka will use in interactive mode. Default: vim
+
+
+SEE ALSO
+       aka(7), aka-show(1)
+
+
+
+				 February 2014			   AKA-EDIT(1)

data/lib/aka/man/aka-generate.1

@@ -0,0 +1,81 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "AKA\-GENERATE" "1" "February 2014" "" ""
+.
+.SH "NAME"
+\fBaka\-generate\fR \- Generate commands for loading keyboard shortcuts into your shell
+.
+.SH "SYNOPSIS"
+\fBaka generate\fR [\fB\-t\fR \fItag1\fR[,\fItag2\fR\.\.\.]] [\fB\-o\fR \fIoutput\fR]
+.
+.SH "DESCRIPTION"
+This command generates commands for loading keyboard shortcuts in \fBaka(7)\fR into your shell\.
+.
+.P
+This command can be performed with or without tag filtering\.
+.
+.P
+By default, the commands are generated to \fBSTDOUT\fR\.
+.
+.SH "OPTIONS"
+.
+.TP
+\fB\-t\fR \fItag1\fR[,\fItag2\fR\.\.\.]
+A comma\-separated list of tags to filter with\. Shortcuts tagged with \fItag1\fR[,\fItag2\fR\.\.\.] will be included\. Shortcuts tagged with other tags are excluded\. Shortcuts with no tags are always included\.
+.
+.TP
+\fB\-o <output>\fR
+The location to generate the commands to\.
+.
+.SH "EXAMPLES"
+Generate for all shortcuts:
+.
+.IP "" 4
+.
+.nf
+
+$ aka generate
+alias \.\.="cd \.\."
+alias ls="ls \-FG"
+function ls {
+  ls \-F \-\-color=auto
+}
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Generate for shortcuts matching \fB\-\-tag os:darwin\fR:
+.
+.IP "" 4
+.
+.nf
+
+$ aka generate \-t os:darwin
+alias \.\.="cd \.\."
+alias ls="ls \-FG"
+
+2 shortcut(s) excluded (#os:linux, #os:windows)\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Generate to file:
+.
+.IP "" 4
+.
+.nf
+
+$ aka generate \-o ~/\.aka\.zsh
+Generated ~/\.aka\.zsh\.
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+\fBaka(7)\fR, \fBaka\-show(1)\fR