hsume2-aka 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3369794f383200ea13fef6e746ac0c58b9f1f248
-  data.tar.gz: 835091cbc77b20d99c2ad3b2957d204884fae358
+  metadata.gz: 51c5a052c633b5f271d7338546077195370f2945
+  data.tar.gz: 90855456998901d7c494389a4695cbd3e1624df0
 SHA512:
-  metadata.gz: 87d76091861f959ff6deba94453faf3e8d6af4e24b256c022ec57eb4ebcc952d5dd4bf5aad166c239ea16c5b15820ece7d7809f5f181cb1337344164810ec2d0
-  data.tar.gz: 77964a52a87358e29a1d13e18fa212c5512732cd3b372d449cc3234bb737d29da0573d1d1d589d58afc313d65f8303e7fe47caf9045bce608386d4b4b1d8ae10
+  metadata.gz: 4e5fa9d33652c6522a95e3a908796c05bcb62dce5ba9274e16ab1b905c1be8f44a065a071199b5c959e2d0c93445bc68006796a45fa490ad4f5d0417994ddc6f
+  data.tar.gz: a0ff210053fb91e05f64df65f860a0f6729fbd73303bff884912f7bd23f6ced7b3606eb0a283b2bf2546a9e2e5be6f4c26500ec51eff88b633a5ab7e6041e24c

data/.gitignore

@@ -5,6 +5,7 @@ html
 tmp
 Gemfile.lock
 .bundle
+.ruby-version
 
 # output from ronn
 lib/aka/man/

data/.ruby-version.example

@@ -0,0 +1 @@
+2.0.0-p353

data/Guardfile

@@ -1,6 +1,3 @@
-# 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$})

data/README.md

@@ -10,7 +10,9 @@ aka(7) -- Manage Shell Keyboard Shortcuts
 `aka` edit <shortcut> \[options\]<br>
 `aka` remove <shortcut><br>
 `aka` list \[options\]<br>
-`aka` generate \[options\]
+`aka` link \[options\]<br>
+`aka` generate \[options\]<br>
+`aka` sync
 
 ## DESCRIPTION
 
@@ -20,10 +22,6 @@ You can replace commonly used commands with shorter, sexier keyboard shortcuts a
 
 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>
@@ -35,6 +33,10 @@ With **aka**, you can add, show, edit, remove, list keyboard shortcuts. On top o
   * `--log-level=<debug|info|warn|error|fatal>`:<br>
     Set the logging level (Default: info)
 
+## INSTALLATION
+
+    $ gem install hsume2-aka
+
 ## EXAMPLES
 
 Add a keyboard shortcut and generate the output script:
@@ -85,6 +87,30 @@ Remove a shortcut:
     $ aka remove ls
     Removes shortcut.
 
+Add a link:
+
+    $ aka link --tag os:linux --output ~/.aka.zsh
+    Saved link.
+
+Remove a link:
+
+    $ aka link --delete --tag os:linux --output ~/.aka.zsh
+    Removed link.
+
+Synchronize links:
+
+    $ aka link --tag os:linux --output ~/.aka.zsh
+    Saved link.
+    $ aka sync
+    Generated ~/.aka.zsh.
+    4 shortcut(s) excluded (#linux).
+
+Upgrade links from v0 to v1:
+
+    $ aka upgrade
+    Upgraded ~/.aka.yml.
+    Backed up to ~/.aka.yml.backup."
+
 ## ENVIRONMENT
 
   * `AKA`:<br>

data/features/aka/add.feature

@@ -21,11 +21,13 @@ Feature: Add keyboard shortcuts
     And the file ".aka.yml" should contain exactly:
     """
     ---
-    1: !ruby/object:OpenStruct
-      table:
-        :shortcut: ls
-        :command: ls -F --color=auto
-      modifiable: true
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -F --color=auto
+        modifiable: true
 
     """
 
@@ -39,13 +41,15 @@ Feature: Add keyboard shortcuts
     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
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -F --color=auto
+          :tag:
+          - os:darwin
+        modifiable: true
 
     """
 
@@ -59,14 +63,16 @@ Feature: Add keyboard shortcuts
     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
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -F --color=auto
+          :tag:
+          - A
+          - B
+        modifiable: true
 
     """
 
@@ -81,21 +87,23 @@ Feature: Add keyboard shortcuts
     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
+    :version: '1'
+    :shortcuts:
+      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
 
     """
 
@@ -112,11 +120,13 @@ Feature: Add keyboard shortcuts
     And the file ".aka.yml" should contain exactly:
     """
     ---
-    1: !ruby/object:OpenStruct
-      table:
-        :shortcut: ls
-        :command: ls -F --color=auto
-      modifiable: true
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -F --color=auto
+        modifiable: true
 
     """
 
@@ -133,11 +143,13 @@ Feature: Add keyboard shortcuts
     And the file ".aka.yml" should contain exactly:
     """
     ---
-    1: !ruby/object:OpenStruct
-      table:
-        :shortcut: ls
-        :command: ls -FG
-      modifiable: true
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -FG
+        modifiable: true
 
     """
 
@@ -151,12 +163,14 @@ Feature: Add keyboard shortcuts
     And the file ".aka.yml" should contain exactly:
     """
     ---
-    1: !ruby/object:OpenStruct
-      table:
-        :shortcut: ls
-        :command: ls -F --color=auto
-        :function: true
-      modifiable: true
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -F --color=auto
+          :function: true
+        modifiable: true
 
     """
 
@@ -170,14 +184,16 @@ Feature: Add keyboard shortcuts
     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
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -F --color=auto
+          :description: |-
+            ls
+            ls
+            ls
+        modifiable: true
 
     """

data/features/aka/edit.feature

@@ -35,19 +35,21 @@ Feature: Edit keyboard shortcuts
     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
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: lsf
+          :command: ls -F
+          :description: |-
+            1
+            2
+            3
+          :function: true
+          :tag:
+          - zsh
+          - bash
+        modifiable: true
 
     """
 
@@ -65,19 +67,21 @@ Feature: Edit keyboard shortcuts
     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
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: lsf
+          :command: ls -F
+          :description: |-
+            1
+            2
+            3
+          :function: true
+          :tag:
+          - zsh
+          - bash
+        modifiable: true
 
     """
 

data/features/aka/help.feature

@@ -29,7 +29,7 @@ Feature: Help with aka
     Then the exit status should be 0
     And the output should contain exactly:
     """
-    aka version 0.1.0
+    aka version 0.2.0
 
     """
 
@@ -78,3 +78,27 @@ Feature: Help with aka
     """
     aka-edit - Edit keyboard shortcuts
     """
+
+  Scenario: Help linking shortcuts
+    When I run `aka -h link`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    aka-link - Link keyboard shortcuts
+    """
+
+  Scenario: Help syncing shortcuts
+    When I run `aka -h sync`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    aka-sync - Synchronize keyboard shortcuts
+    """
+
+  Scenario: Help upgrading shortcuts
+    When I run `aka -h upgrade`
+    Then the exit status should be 0
+    And the output should contain:
+    """
+    aka-upgrade - Upgrade keyboard shortcuts
+    """

data/features/aka/link.feature

@@ -0,0 +1,275 @@
+Feature: Link keyboard shortcuts
+  In order to keep my shortcuts up to date
+  I want to have a tool for configuring 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: Add a link
+    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 link --tag os:darwin --output .aka.zsh`
+    Then the exit status should be 0
+    And the stdout should contain exactly:
+    """
+    Created shortcut.
+    Created shortcut.
+    Created shortcut.
+    Saved link.
+
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -F --color=auto
+          :tag:
+          - os:linux
+          :description: |-
+            ls
+            ls
+            ls
+          :function: true
+        modifiable: true
+      2: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -FG
+          :tag:
+          - os:darwin
+        modifiable: true
+      3: !ruby/object:OpenStruct
+        table:
+          :shortcut: ..
+          :command: cd ..
+        modifiable: true
+    :links:
+    - !ruby/object:OpenStruct
+      table:
+        :tag:
+        - os:darwin
+        :output: .aka.zsh
+      modifiable: true
+
+    """
+
+  Scenario: Add the same link
+    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 link --tag os:darwin --output .aka.zsh`
+    And I run `aka link --tag os:darwin --output .aka.zsh`
+    Then the exit status should be 0
+    And the stdout should contain exactly:
+    """
+    Created shortcut.
+    Created shortcut.
+    Created shortcut.
+    Saved link.
+    Saved link.
+
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -F --color=auto
+          :tag:
+          - os:linux
+          :description: |-
+            ls
+            ls
+            ls
+          :function: true
+        modifiable: true
+      2: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -FG
+          :tag:
+          - os:darwin
+        modifiable: true
+      3: !ruby/object:OpenStruct
+        table:
+          :shortcut: ..
+          :command: cd ..
+        modifiable: true
+    :links:
+    - !ruby/object:OpenStruct
+      table:
+        :tag:
+        - os:darwin
+        :output: .aka.zsh
+      modifiable: true
+
+    """
+
+  Scenario: Add a link with invalid options
+    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 link`
+    Then the exit status should not be 0
+    And the stdout should contain exactly:
+    """
+    Created shortcut.
+    Created shortcut.
+    Created shortcut.
+
+    """
+    And the stderr should contain exactly:
+    """
+    Invalid link.
+
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -F --color=auto
+          :tag:
+          - os:linux
+          :description: |-
+            ls
+            ls
+            ls
+          :function: true
+        modifiable: true
+      2: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -FG
+          :tag:
+          - os:darwin
+        modifiable: true
+      3: !ruby/object:OpenStruct
+        table:
+          :shortcut: ..
+          :command: cd ..
+        modifiable: true
+
+    """
+
+  Scenario: Remove a link
+    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 .."`
+    And I run `aka link --tag os:darwin --output .aka.zsh`
+    When I run `aka link --delete --tag os:darwin --output .aka.zsh`
+    Then the exit status should be 0
+    And the stdout should contain exactly:
+    """
+    Created shortcut.
+    Created shortcut.
+    Created shortcut.
+    Saved link.
+    Deleted link.
+
+    """
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -F --color=auto
+          :tag:
+          - os:linux
+          :description: |-
+            ls
+            ls
+            ls
+          :function: true
+        modifiable: true
+      2: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -FG
+          :tag:
+          - os:darwin
+        modifiable: true
+      3: !ruby/object:OpenStruct
+        table:
+          :shortcut: ..
+          :command: cd ..
+        modifiable: true
+
+    """
+
+  Scenario: Sync a link
+    Given a file named ".aka.zsh" should not exist
+    And 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 .."`
+    And I run `aka link --tag os:darwin --output .aka.zsh`
+    When I run `aka sync`
+    Then the exit status should be 0
+    And the stdout should contain exactly:
+    """
+    Created shortcut.
+    Created shortcut.
+    Created shortcut.
+    Saved link.
+    Generated .aka.zsh.
+
+    """
+    And the file ".aka.zsh" should contain exactly:
+    """
+    alias ..="cd .."
+    alias ls="ls -FG"
+
+    """
+
+  Scenario: List links
+    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 .."`
+    And I run `aka link --tag os:darwin --output .aka.zsh`
+    When I run `aka list`
+    Then the exit status should be 0
+    And the output should contain exactly:
+    """
+    Created shortcut.
+    Created shortcut.
+    Created shortcut.
+    Saved link.
+    #default
+    ========
+    ..                            cd ..
+
+    #os:linux
+    =========
+    ls                            ls; ls; ls
+
+    #os:darwin
+    ==========
+    ls                            ls -FG
+
+    =====
+    Links
+    =====
+
+    .aka.zsh: #os:darwin
+
+    """

data/features/aka/remove.feature

@@ -22,7 +22,9 @@ Feature: Remove keyboard shortcuts
     """
     And the file ".aka.yml" should contain exactly:
     """
-    --- {}
+    ---
+    :version: '1'
+    :shortcuts: {}
 
     """
 
@@ -39,10 +41,12 @@ Feature: Remove keyboard shortcuts
     And the file ".aka.yml" should contain exactly:
     """
     ---
-    1: !ruby/object:OpenStruct
-      table:
-        :shortcut: ls
-        :command: ls -F --color=auto
-      modifiable: true
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -F --color=auto
+        modifiable: true
 
     """