hsume2-aka 0.1.0

data/lib/aka/store.rb

@@ -0,0 +1,372 @@
+require 'yaml'
+require 'ostruct'
+require 'tempfile'
+require 'methadone'
+
+module Aka
+  class Store
+    include Methadone::CLILogging
+
+    def help(command, options)
+      case command
+      when nil       then command = "aka.7"
+      else command = "aka-#{command}.1"
+      end
+
+      manpages = %w(
+        aka-add.1
+        aka-edit.1
+        aka-generate.1
+        aka-list.1
+        aka-remove.1
+        aka-show.1
+        aka.7)
+
+      exit unless manpages.include?(command)
+
+      root = File.expand_path("../man", __FILE__)
+
+      if !ENV['NO_MAN'] && Aka::App.which("man") && root !~ %r{^file:/.+!/META-INF/jruby.home/.+}
+        Kernel.exec "man #{root}/#{command}"
+      else
+        puts File.read("#{root}/#{command}.txt")
+        exit
+      end
+    end
+
+    def add(options)
+      found = find(options)
+
+      if found.length > 0
+        unless options[:force]
+          abort %{Shortcut "#{options[:shortcut]}" exists. Pass --force to overwrite. Or provide a new --tag.}
+        else
+          found.each do |n, row|
+            replace(n, options)
+          end
+          save
+          puts "Overwrote shortcut."
+        end
+      else
+        append(options)
+        save
+        puts "Created shortcut."
+      end
+    end
+
+    def list(options)
+      excluded = match_shortcuts_by_tag(options[:tag] || []) do |tag, rows|
+        puts %{##{tag}}
+        puts ''.ljust(tag.length + 1, '=')
+        rows.each do |row|
+          list_output(row)
+        end
+        puts
+      end
+
+      excluded_output(excluded)
+    end
+
+    def remove(options)
+      found = find(options)
+
+      if found.length > 0
+        found.each do |n, row|
+          delete(n)
+        end
+
+        save
+
+        puts "Removed shortcut."
+      else
+        abort %{No shortcut "#{options[:shortcut]}". Aborting.}
+      end
+    end
+
+    def matches_tag?(row, tag)
+      return true unless row.tag
+
+      if tag =~ /^~(.+)/
+        !row.tag.include?($1)
+      else
+        row.tag && row.tag.include?(tag)
+      end
+    end
+
+    def generate(options)
+      scripts = []
+      functions = []
+
+      excluded = match_shortcuts_by_tag(options[:tag] || []) do |tag, rows|
+        rows.each do |row|
+          unless row.function
+            scripts << generate_output(row)
+          else
+            functions << generate_output(row)
+          end
+        end
+      end
+
+      if options[:output]
+        File.open(options[:output], 'w+') do |f|
+          scripts.each do |script|
+            f.puts script
+          end
+
+          functions.each do |function|
+            f.puts function
+          end
+        end
+
+        puts "Generated #{options[:output]}."
+      else
+        scripts.each do |script|
+          puts script
+        end
+
+        functions.each do |function|
+          puts function
+        end
+      end
+
+      excluded_output(excluded)
+    end
+
+    def edit(options)
+      result = nil
+
+      found = find(options)
+
+      index, row = found.first
+
+      unless row
+        abort "Shortcut not found."
+      end
+
+      if options[:input]
+        result = File.read(options[:input])
+      else
+        file = Tempfile.new('shortcut')
+        begin
+          file.open
+          if row.tag
+            tags = %{ #{row.tag.join(', ')}}
+          else
+            tags = ''
+          end
+          file.write(<<-EOS.gsub(/^            /, '')
+            Keyword: #{row.shortcut}
+            Description:
+            #{row.description}
+            Function (y/n): #{row.function ? 'y' : 'n'}
+            Tags:#{tags}
+            Command:
+            #{row.command}
+          EOS
+          )
+          file.close
+          editor = ENV['EDITOR'] || 'vim'
+          system(%[#{editor} #{file.path}])
+          debug("Editing exited with code: #{$?.exitstatus}.")
+          if $?.exitstatus == 0
+            file.open
+            file.rewind
+            result = file.read.strip
+          end
+        ensure
+          file.unlink
+        end
+      end
+
+      if result
+        parse_row_txt(row, result)
+        shortcuts[index] = row
+        save
+        puts "Saved shortcut."
+      else
+      end
+    end
+
+    def show(options)
+      found = find(options)
+
+      _, row = found.first
+
+      if row
+        puts show_output(row)
+      else
+        abort "Shortcut not found."
+      end
+    end
+
+    private
+
+    def shortcuts
+      @shortcuts ||= begin
+        if File.exist?(aka_yml)
+          YAML::load_file(aka_yml)
+        else
+          {}
+        end
+      end
+    end
+
+    def find(options)
+      if options[:tag]
+        shortcuts.select do |_, row|
+          next unless row.shortcut == options[:shortcut]
+
+          options[:tag].find do |tag|
+            row.tag && row.tag.include?(tag)
+          end
+        end
+      else
+        shortcuts.select do |_, row|
+          row.shortcut == options[:shortcut]
+        end
+      end
+    end
+
+    def append(options)
+      shortcuts[count + 1] = row(options)
+    end
+
+    def replace(index, options)
+      shortcuts[index] = row(options)
+    end
+
+    def delete(index)
+      shortcuts.delete(index)
+    end
+
+    def count
+      result, _ = shortcuts.max { |(n, _)| n }
+      result || 0
+    end
+
+    def row(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 save
+      File.open(aka_yml, 'w+') do |f|
+        f.write shortcuts.to_yaml
+      end
+    end
+
+    def aka_yml
+      ENV['AKA'] || File.expand_path('~/.aka.yml')
+    end
+
+    def shortcuts_by_tag
+      shortcuts.inject({ :default => [] }) do |acc, (_, row)|
+        if row.tag
+          row.tag.each do |tag|
+            acc[tag] ||= []
+            acc[tag] << row
+          end
+        else
+          acc[:default] << row
+        end
+        acc
+      end
+    end
+
+    def match_shortcuts_by_tag(tags, &blk)
+      excluded = { :tags => [], :shortcuts => 0 }
+
+      shortcuts_by_tag.each do |tag, rows|
+        next if rows.empty?
+        unless tag == :default || tags.empty? || tags.include?(tag)
+          excluded[:tags] << tag
+          excluded[:shortcuts] += rows.length
+          next
+        end
+
+        yield(tag, rows)
+      end
+
+      excluded
+    end
+
+    def excluded_output(excluded)
+      return if excluded[:tags].empty?
+
+      tags = excluded[:tags].map { |t| '#' + t }.join(', ')
+      $stderr.puts "#{excluded[:shortcuts]} shortcut(s) excluded (#{tags})."
+    end
+
+    def list_output(row)
+      if row.function
+        description = row.description || row.command
+      else
+        description = row.command
+      end
+
+      if description
+        description = description.split("\n").map(&:strip).join("; ")
+
+        if description.length > 70
+          description = description[0...66] + ' ...'
+        end
+      end
+
+      puts "#{row.shortcut.ljust(20)}          #{description.ljust(70).strip}"
+    end
+
+    def 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
+
+    def parse_row_txt(row, txt)
+      if txt =~ /^Shortcut:(.+)$/
+        row.shortcut = $1.strip
+      end
+      if txt =~ %r{^Description:(.+)\nFunction \(y/n\)}m
+        row.description = $1.strip if $1.strip.length > 0
+      end
+      if txt =~ %r{^Function \(y/n\):\s*(y|n)}m
+        row.function = ($1.strip == 'y')
+      end
+      if txt =~ /^Tags:(.+)$/
+        row.tag = $1.strip.split(',').map(&:strip)
+      end
+      if txt =~ /^Command:(.+)$/m
+        row.command = $1.strip
+      end
+    end
+
+    def show_output(row)
+      if row.tag
+        tags = %{ #{row.tag.map { |t| "##{t}"}.join(', ')}}
+      else
+        tags = ''
+      end
+      <<-EOS.gsub(/^        /, '')
+        Shortcut: #{row.shortcut}
+        Description:
+        #{row.description}
+        Function: #{row.function ? 'y' : 'n'}
+        Tags:#{tags}
+        Command:
+        #{row.command}
+      EOS
+    end
+  end
+end

data/lib/aka/version.rb

@@ -0,0 +1,3 @@
+module Aka
+  VERSION = "0.1.0"
+end

data/lib/aka.rb

@@ -0,0 +1,6 @@
+require "aka/store"
+require "aka/version"
+require "aka/app"
+
+module Aka
+end

data/man/aka-add.1.ronn

@@ -0,0 +1,32 @@
+aka-add(1) -- 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)`

data/man/aka-edit.1.ronn

@@ -0,0 +1,67 @@
+aka-edit(1) -- 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):
+
+  * `Shortcut: <shortcut>`<br>
+    Where <shortcut> is the string to change the <shortcut> cut.
+
+  * `Description: <description>`<br>
+    Where <description> is one or more lines of text.
+
+  * `Function (y/n): <y|n>`<br>
+    Where <y|n> is either `y` or `n`.
+
+  * `Tags: <tags>`<br>
+    Where <tags> is a comma-separated list of tags for the shortcut.
+
+  * `Command: <command>`<br>
+    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`:<br>
+    The editor **aka** will use in interactive mode. Default: vim
+
+## SEE ALSO
+
+`aka(7)`, `aka-show(1)`

data/man/aka-generate.1.ronn

@@ -0,0 +1,51 @@
+aka-generate(1) -- Generate commands for loading keyboard shortcuts into your shell
+===================================================================================
+
+## SYNOPSIS
+
+`aka generate` [`-t` <tag1>[,<tag2>...]]
+               [`-o` <output>]
+
+## DESCRIPTION
+
+This command generates commands for loading keyboard shortcuts in `aka(7)` into your shell.
+
+This command can be performed with or without tag filtering.
+
+By default, the commands are generated to `STDOUT`.
+
+## 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 generate the commands to.
+
+## EXAMPLES
+
+Generate for all shortcuts:
+
+    $ aka generate
+    alias ..="cd .."
+    alias ls="ls -FG"
+    function ls {
+      ls -F --color=auto
+    }
+
+Generate for shortcuts matching `--tag os:darwin`:
+
+    $ aka generate -t os:darwin
+    alias ..="cd .."
+    alias ls="ls -FG"
+
+    2 shortcut(s) excluded (#os:linux, #os:windows).
+
+Generate to file:
+
+    $ aka generate -o ~/.aka.zsh
+    Generated ~/.aka.zsh.
+
+## SEE ALSO
+
+`aka(7)`, `aka-show(1)`

data/man/aka-list.1.ronn

@@ -0,0 +1,51 @@
+aka-list(1) -- List keyboard shortcuts
+======================================
+
+## SYNOPSIS
+
+`aka list` [`-t` <tag1>[,<tag2>...]]
+
+## DESCRIPTION
+
+This command lists keyboard shortcuts in `aka(7)`.
+
+This command can be performed with or without tag filtering.
+
+## 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.
+
+## EXAMPLES
+
+List all shortcuts:
+
+    $ aka list
+    #default
+    ========
+    ..                            cd ..
+
+    #os:linux
+    =========
+    ls                            ls; ls; ls
+
+    #os:darwin
+    ==========
+    ls                            ls -FG
+
+List shortcuts matching `--tag os:darwin`:
+
+    $ aka list -t os:darwin
+    #default
+    ========
+    ..                            cd ..
+
+    #os:darwin
+    ==========
+    ls                            ls -FG
+
+    2 shortcut(s) excluded (#os:linux, #os:windows).
+
+## SEE ALSO
+
+`aka(7)`, `aka-show(1)`

data/man/aka-remove.1.ronn

@@ -0,0 +1,21 @@
+aka-remove(1) -- Remove keyboard shortcuts
+==========================================
+
+## SYNOPSIS
+
+`aka remove` <shortcut>
+
+## DESCRIPTION
+
+This command removes a keyboard shortcut from `aka(7)`.
+
+## EXAMPLES
+
+Remove a shortcut:
+
+    $ aka remove ls
+    Removed shortcut.
+
+## SEE ALSO
+
+`aka(7)`, `aka-show(1)`

data/man/aka-show.1.ronn

@@ -0,0 +1,27 @@
+aka-show(1) -- Show keyboard shortcuts
+=====================================
+
+## SYNOPSIS
+
+`aka show` <shortcut>
+
+## DESCRIPTION
+
+This command show a keyboard shortcut in `aka(7)`.
+
+## EXAMPLES
+
+    $ aka add psf "ps aux | grep $@" --function
+    Created shortcut.
+    $ aka show psf
+    Keyword: psf
+    Description:
+
+    Function: y
+    Tags:
+    Script:
+    ps aux | grep $@
+
+## SEE ALSO
+
+`aka(7)`, `aka-add(1)`