hsume2-aka 0.1.0 → 0.2.0

data/features/aka/upgrade.feature

@@ -0,0 +1,51 @@
+Feature: Upgrade aka
+  In order to keep the aka configuration up to date
+  I want to upgrade the configuration from the command-line
+  So I don't have to do it manually
+
+  Background:
+    Given 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: Upgrade from v0 to v1
+    Given a file named ".aka.yml" with:
+    """
+    ---
+    1: !ruby/object:OpenStruct
+      table:
+        :shortcut: ls
+        :command: ls -F --color=auto
+      modifiable: true
+
+    """
+    When I run `aka upgrade`
+    Then the exit status should be 0
+    And the file ".aka.yml" should contain exactly:
+    """
+    ---
+    :version: '1'
+    :shortcuts:
+      1: !ruby/object:OpenStruct
+        table:
+          :shortcut: ls
+          :command: ls -F --color=auto
+        modifiable: true
+
+    """
+    And the stdout should contain "Upgraded"
+    And the stdout should contain ".aka.yml"
+    And the stdout should contain "Backed up to"
+    And the stdout should contain ".aka.yml.backup"
+    And the file ".aka.yml.backup" should contain exactly:
+    """
+    ---
+    1: !ruby/object:OpenStruct
+      table:
+        :shortcut: ls
+        :command: ls -F --color=auto
+      modifiable: true
+
+    """

data/lib/aka/app.rb

@@ -43,6 +43,12 @@ module Aka
         store.edit(options)
       when 'show'
         store.show(options)
+      when 'link'
+        store.link(options)
+      when 'upgrade'
+        store.upgrade(options)
+      when 'sync'
+        store.sync
       else
         store.help(command, options)
       end
@@ -60,6 +66,7 @@ module Aka
     on("-i FILE", "--input")
     on("-h", "--help")
     on("-v", "--version")
+    on("--delete")
 
     use_log_level_option
   end

data/lib/aka/configuration.rb

@@ -0,0 +1,92 @@
+module Aka
+  class Configuration
+    FORMAT = '1'
+
+    attr_reader :configuration
+
+    module Shortcut
+      def self.parse(options)
+        OpenStruct.new.tap do |row|
+          row.shortcut = options['shortcut']
+          row.command = options['command']
+          row.tag = options['tag'] if options['tag']
+          row.description = options['description'] if options['description']
+          row.function = options['function'] if options['function']
+        end
+      end
+
+      def self.generate_output(row)
+        string = if row.function
+          <<-EOS.gsub(/^          /, '')
+          function #{row.shortcut} {
+            #{row.command}
+          }
+          EOS
+        else
+          %{alias #{row.shortcut}="#{row.command.gsub(%{"}, %{\\"})}"}
+        end
+
+        string
+      end
+    end
+
+    module Link
+      def self.parse(options)
+        unless options['tag'] && options['output']
+          abort("Invalid link.")
+        end
+
+        OpenStruct.new.tap do |row|
+          row.tag = options['tag'] if options['tag']
+          row.output = options['output'] if options['output']
+        end
+      end
+    end
+
+    def initialize
+      @configuration ||= begin
+        if File.exist?(aka_yml)
+          YAML::load_file(aka_yml)
+        else
+          {}
+        end
+      end
+      @configuration[:shortcuts] ||= {}
+    end
+
+    def shortcuts
+      @shortcuts ||= Shortcuts.new(@configuration[:shortcuts])
+    end
+
+    def version
+      @configuration[:version]
+    end
+
+    def save
+      current = {
+        :version => version || FORMAT,
+        :shortcuts => shortcuts.all
+      }
+
+      current[:links] = links.all if links.any?
+
+      File.open(aka_yml, 'w+') do |f|
+        f.write current.to_yaml
+      end
+    end
+
+    def links
+      @links ||= Links.new(@configuration[:links] || [])
+    end
+
+    def upgrade
+      if !version
+        Upgrader::FromV0.run(aka_yml)
+      end
+    end
+
+    def aka_yml
+      ENV['AKA'] || File.expand_path('~/.aka.yml')
+    end
+  end
+end

data/lib/aka/links.rb

@@ -0,0 +1,29 @@
+module Aka
+  class Links
+    def initialize(links)
+      @links = links.dup
+    end
+
+    def add(link)
+      link = Configuration::Link.parse(link)
+      @links << link unless @links.include?(link)
+    end
+
+    def delete(link)
+      link = Configuration::Link.parse(link)
+      @links.delete(link)
+    end
+
+    def any?
+      @links.any?
+    end
+
+    def all
+      @links.dup
+    end
+
+    def each(&blk)
+      @links.each(&blk)
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "AKA\-LINK" "1" "March 2014" "" ""
+.
+.SH "NAME"
+\fBaka\-link\fR \- Link keyboard shortcuts
+.
+.SH "SYNOPSIS"
+\fBaka link\fR [\fB\-t\fR \fItag1\fR[,\fItag2\fR\.\.\.]] [\fB\-o\fR \fIoutput\fR] [\fB\-\-delete\fR]
+.
+.SH "DESCRIPTION"
+This command manages keyboard shortcuts links in \fBaka(7)\fR\.
+.
+.P
+After creating a link, you can easily synchronize changes to shortcuts to designated \fBoutput\fR files\.
+.
+.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 link the output to\.
+.
+.TP
+\fB\-\-delete\fR
+Delete the link with the given options\.
+.
+.SH "EXAMPLES"
+Add a link:
+.
+.IP "" 4
+.
+.nf
+
+$ aka link \-\-tag os:linux \-\-output ~/\.aka\.zsh
+Saved link\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Remove a link:
+.
+.IP "" 4
+.
+.nf
+
+$ aka link \-\-delete \-\-tag os:linux \-\-output ~/\.aka\.zsh
+Removed link\.
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+\fBaka(7)\fR, \fBaka\-sync(1)\fR

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

@@ -0,0 +1,54 @@
+AKA-LINK(1)							   AKA-LINK(1)
+
+
+
+NAME
+       aka-link - Link keyboard shortcuts
+
+SYNOPSIS
+       aka link [-t tag1[,tag2...]] [-o output] [--delete]
+
+DESCRIPTION
+       This command manages keyboard shortcuts links in aka(7).
+
+       After  creating a link, you can easily synchronize changes to shortcuts
+       to designated output files.
+
+OPTIONS
+       -t tag1[,tag2...]
+	      A comma-separated list of tags to filter with. Shortcuts	tagged
+	      with  tag1[,tag2...]  will  be  included.  Shortcuts tagged with
+	      other tags are excluded.	Shortcuts  with  no  tags  are	always
+	      included.
+
+       -o <output>
+	      The location to link the output to.
+
+       --delete
+	      Delete the link with the given options.
+
+EXAMPLES
+       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.
+
+
+
+SEE ALSO
+       aka(7), aka-sync(1)
+
+
+
+				  March 2014			   AKA-LINK(1)

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

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "AKA\-LIST" "1" "February 2014" "" ""
+.TH "AKA\-LIST" "1" "March 2014" "" ""
 .
 .SH "NAME"
 \fBaka\-list\fR \- List keyboard shortcuts

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

@@ -60,4 +60,4 @@ SEE ALSO
 
 
 
-				 February 2014			   AKA-LIST(1)
+				  March 2014			   AKA-LIST(1)

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

@@ -0,0 +1,36 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "AKA\-SYNC" "1" "March 2014" "" ""
+.
+.SH "NAME"
+\fBaka\-sync\fR \- Synchronize keyboard shortcuts
+.
+.SH "SYNOPSIS"
+\fBaka sync\fR
+.
+.SH "DESCRIPTION"
+This command manages synchronizes keyboard shortcuts links in \fBaka(7)\fR\.
+.
+.P
+Any links you\'ve created will be generated to the designated \fBoutput\fR with the given \fBtags\fR\.
+.
+.SH "EXAMPLES"
+Synchronize links:
+.
+.IP "" 4
+.
+.nf
+
+$ aka link \-\-tag os:linux \-\-output ~/\.aka\.zsh
+Saved link\.
+$ aka sync
+Generated ~/\.aka\.zsh\.
+4 shortcut(s) excluded (#linux)\.
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+\fBaka(7)\fR, \fBaka\-link(1)\fR

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

@@ -0,0 +1,35 @@
+AKA-SYNC(1)							   AKA-SYNC(1)
+
+
+
+NAME
+       aka-sync - Synchronize keyboard shortcuts
+
+SYNOPSIS
+       aka sync
+
+DESCRIPTION
+       This command manages synchronizes keyboard shortcuts links in aka(7).
+
+       Any  links  you've  created  will be generated to the designated output
+       with the given tags.
+
+EXAMPLES
+       Synchronize links:
+
+
+
+	   $ aka link --tag os:linux --output ~/.aka.zsh
+	   Saved link.
+	   $ aka sync
+	   Generated ~/.aka.zsh.
+	   4 shortcut(s) excluded (#linux).
+
+
+
+SEE ALSO
+       aka(7), aka-link(1)
+
+
+
+				  March 2014			   AKA-SYNC(1)

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

@@ -0,0 +1,31 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "AKA\-UPGRADE" "1" "March 2014" "" ""
+.
+.SH "NAME"
+\fBaka\-upgrade\fR \- Upgrade keyboard shortcuts
+.
+.SH "SYNOPSIS"
+\fBaka upgrade\fR
+.
+.SH "DESCRIPTION"
+This command manages upgrades the keyboard shortcuts format in \fBaka(7)\fR\.
+.
+.SH "EXAMPLES"
+Upgrade links from v0 to v1:
+.
+.IP "" 4
+.
+.nf
+
+$ aka upgrade
+Upgraded ~/\.aka\.yml\.
+Backed up to ~/\.aka\.yml\.backup\."
+.
+.fi
+.
+.IP "" 0
+.
+.SH "SEE ALSO"
+\fBaka(7)\fR

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

@@ -0,0 +1,30 @@
+AKA-UPGRADE(1)							AKA-UPGRADE(1)
+
+
+
+NAME
+       aka-upgrade - Upgrade keyboard shortcuts
+
+SYNOPSIS
+       aka upgrade
+
+DESCRIPTION
+       This  command manages upgrades the keyboard shortcuts format in aka(7).
+
+EXAMPLES
+       Upgrade links from v0 to v1:
+
+
+
+	   $ aka upgrade
+	   Upgraded ~/.aka.yml.
+	   Backed up to ~/.aka.yml.backup."
+
+
+
+SEE ALSO
+       aka(7)
+
+
+
+				  March 2014			AKA-UPGRADE(1)

data/lib/aka/man/aka.7

@@ -1,7 +1,7 @@
 .\" generated with Ronn/v0.7.3
 .\" http://github.com/rtomayko/ronn/tree/0.7.3
 .
-.TH "AKA" "7" "February 2014" "" ""
+.TH "AKA" "7" "March 2014" "" ""
 .
 .SH "NAME"
 \fBaka\fR \- Manage Shell Keyboard Shortcuts
@@ -22,8 +22,14 @@
 \fBaka\fR list [options]
 .
 .br
+\fBaka\fR link [options]
+.
+.br
 \fBaka\fR generate [options]
 .
+.br
+\fBaka\fR sync
+.
 .SH "DESCRIPTION"
 \fBaka\fR is an easy way to manage keyboard shortcuts in UNIX shells\.
 .
@@ -158,6 +164,66 @@ Removes shortcut\.
 .
 .IP "" 0
 .
+.P
+Add a link:
+.
+.IP "" 4
+.
+.nf
+
+$ aka link \-\-tag os:linux \-\-output ~/\.aka\.zsh
+Saved link\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Remove a link:
+.
+.IP "" 4
+.
+.nf
+
+$ aka link \-\-delete \-\-tag os:linux \-\-output ~/\.aka\.zsh
+Removed link\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Synchronize links:
+.
+.IP "" 4
+.
+.nf
+
+$ aka link \-\-tag os:linux \-\-output ~/\.aka\.zsh
+Saved link\.
+$ aka sync
+Generated ~/\.aka\.zsh\.
+4 shortcut(s) excluded (#linux)\.
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Upgrade links from v0 to v1:
+.
+.IP "" 4
+.
+.nf
+
+$ aka upgrade
+Upgraded ~/\.aka\.yml\.
+Backed up to ~/\.aka\.yml\.backup\."
+.
+.fi
+.
+.IP "" 0
+.
 .SH "ENVIRONMENT"
 .
 .TP

data/lib/aka/man/aka.7.txt

@@ -11,7 +11,9 @@ SYNOPSIS
        aka edit shortcut [options]
        aka remove shortcut
        aka list [options]
+       aka link [options]
        aka generate [options]
+       aka sync
 
 DESCRIPTION
        aka is an easy way to manage keyboard shortcuts in UNIX shells.
@@ -110,6 +112,46 @@ EXAMPLES
 
 
 
+       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:
 	      The file where aka stores everything. Default: ~/.aka.yml
@@ -118,4 +160,4 @@ ENVIRONMENT
 
 
 
-				 February 2014				AKA(7)
+				  March 2014				AKA(7)