hsume2-aka 0.1.0 → 0.2.0

data/lib/aka/shortcuts.rb

@@ -0,0 +1,121 @@
+module Aka
+  class Shortcuts
+    def initialize(shortcuts)
+      @shortcuts = shortcuts.dup
+    end
+
+    def append(shortcut)
+      @shortcuts[count + 1] = shortcut
+    end
+
+    def replace(index, shortcut)
+      @shortcuts[index] = shortcut
+    end
+
+    def delete(index)
+      @shortcuts.delete(index)
+    end
+
+    def count
+      result, _ = @shortcuts.max { |(n, _)| n }
+      result || 0
+    end
+
+    def all
+      @shortcuts.dup
+    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 generate(options)
+      scripts = []
+      functions = []
+
+      excluded = match_by_tag(options[:tag] || []) do |tag, rows|
+        rows.each do |row|
+          unless row.function
+            scripts << Configuration::Shortcut.generate_output(row)
+          else
+            functions << Configuration::Shortcut.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
+    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 match_by_tag(tags, &blk)
+      excluded = { :tags => [], :shortcuts => 0 }
+
+      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 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
+  end
+end

data/lib/aka/store.rb

@@ -20,6 +20,9 @@ module Aka
         aka-list.1
         aka-remove.1
         aka-show.1
+        aka-link.1
+        aka-sync.1
+        aka-upgrade.1
         aka.7)
 
       exit unless manpages.include?(command)
@@ -35,27 +38,27 @@ module Aka
     end
 
     def add(options)
-      found = find(options)
+      found = configuration.shortcuts.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)
+            configuration.shortcuts.replace(n, Configuration::Shortcut.parse(options))
           end
-          save
+          configuration.save
           puts "Overwrote shortcut."
         end
       else
-        append(options)
-        save
+        configuration.shortcuts.append(Configuration::Shortcut.parse(options))
+        configuration.save
         puts "Created shortcut."
       end
     end
 
     def list(options)
-      excluded = match_shortcuts_by_tag(options[:tag] || []) do |tag, rows|
+      excluded = configuration.shortcuts.match_by_tag(options[:tag] || []) do |tag, rows|
         puts %{##{tag}}
         puts ''.ljust(tag.length + 1, '=')
         rows.each do |row|
@@ -64,18 +67,29 @@ module Aka
         puts
       end
 
+      if configuration.links.any?
+        puts "====="
+        puts "Links"
+        puts "====="
+        puts
+
+        configuration.links.each do |link|
+          puts "#{link.output}: #{link.tag.map { |tag| "##{tag}" }.join(', ')}"
+        end
+      end
+
       excluded_output(excluded)
     end
 
     def remove(options)
-      found = find(options)
+      found = configuration.shortcuts.find(options)
 
       if found.length > 0
         found.each do |n, row|
-          delete(n)
+          configuration.shortcuts.delete(n)
         end
 
-        save
+        configuration.save
 
         puts "Removed shortcut."
       else
@@ -83,59 +97,35 @@ module Aka
       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 = configuration.shortcuts.generate(options)
 
-      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
+      excluded_output(excluded)
+    end
 
-        puts "Generated #{options[:output]}."
+    def link(options)
+      unless options[:delete]
+        configuration.links.add(options)
+        configuration.save
+        puts "Saved link."
       else
-        scripts.each do |script|
-          puts script
-        end
-
-        functions.each do |function|
-          puts function
-        end
+        configuration.links.delete(options)
+        configuration.save
+        puts "Deleted link."
       end
+    end
 
-      excluded_output(excluded)
+    def sync
+      configuration.links.each do |config|
+        excluded = configuration.shortcuts.generate(config)
+        excluded_output(excluded)
+      end
     end
 
     def edit(options)
       result = nil
 
-      found = find(options)
+      found = configuration.shortcuts.find(options)
 
       index, row = found.first
 
@@ -180,15 +170,15 @@ module Aka
 
       if result
         parse_row_txt(row, result)
-        shortcuts[index] = row
-        save
+        configuration.shortcuts.replace(index, row)
+        configuration.save
         puts "Saved shortcut."
       else
       end
     end
 
     def show(options)
-      found = find(options)
+      found = configuration.shortcuts.find(options)
 
       _, row = found.first
 
@@ -199,100 +189,18 @@ module Aka
       end
     end
 
-    private
-
-    def shortcuts
-      @shortcuts ||= begin
-        if File.exist?(aka_yml)
-          YAML::load_file(aka_yml)
-        else
-          {}
-        end
-      end
+    def upgrade(options)
+      configuration.upgrade
     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
+    private
 
-    def aka_yml
-      ENV['AKA'] || File.expand_path('~/.aka.yml')
+    def configuration
+      @configuration ||= Configuration.new
     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
+    def shortcuts
+      configuration.shortcuts.all
     end
 
     def excluded_output(excluded)
@@ -320,20 +228,6 @@ module Aka
       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

data/lib/aka/upgrader.rb

@@ -0,0 +1,23 @@
+module Aka
+  module Upgrader
+    module FromV0
+      def self.run(aka_yml)
+        v0 = YAML::load_file(aka_yml)
+
+        current = {
+          :version => Aka::Configuration::FORMAT,
+          :shortcuts => v0
+        }
+
+        FileUtils.cp(aka_yml, "#{aka_yml}.backup")
+
+        File.open(aka_yml, 'w+') do |f|
+          f.write current.to_yaml
+        end
+
+        puts "Upgraded #{aka_yml}."
+        puts "Backed up to #{aka_yml}.backup."
+      end
+    end
+  end
+end

data/lib/aka/version.rb

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

data/lib/aka.rb

@@ -1,3 +1,7 @@
+require "aka/shortcuts"
+require "aka/links"
+require "aka/configuration"
+require "aka/upgrader"
 require "aka/store"
 require "aka/version"
 require "aka/app"

data/man/aka-link.1.ronn

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

data/man/aka-sync.1.ronn

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

data/man/aka-upgrade.1.ronn

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

data/man/aka.7.ronn

@@ -8,7 +8,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
 
@@ -79,6 +81,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>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hsume2-aka
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Henry Hsu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-26 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,7 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
-- .ruby-version
+- .ruby-version.example
 - .travis.yml
 - Gemfile
 - Guardfile
@@ -116,21 +116,31 @@ files:
 - features/aka/edit.feature
 - features/aka/generate.feature
 - features/aka/help.feature
+- features/aka/link.feature
 - features/aka/list.feature
 - features/aka/remove.feature
 - features/aka/show.feature
+- features/aka/upgrade.feature
 - features/step_definitions/aka_steps.rb
 - features/support/env.rb
 - lib/aka.rb
 - lib/aka/app.rb
+- lib/aka/configuration.rb
+- lib/aka/links.rb
+- lib/aka/man/.gitkeep
+- lib/aka/shortcuts.rb
 - lib/aka/store.rb
+- lib/aka/upgrader.rb
 - lib/aka/version.rb
 - man/aka-add.1.ronn
 - man/aka-edit.1.ronn
 - man/aka-generate.1.ronn
+- man/aka-link.1.ronn
 - man/aka-list.1.ronn
 - man/aka-remove.1.ronn
 - man/aka-show.1.ronn
+- man/aka-sync.1.ronn
+- man/aka-upgrade.1.ronn
 - man/aka.7.ronn
 - test/tc_something.rb
 - lib/aka/man/aka-add.1
@@ -139,12 +149,18 @@ files:
 - lib/aka/man/aka-edit.1.txt
 - lib/aka/man/aka-generate.1
 - lib/aka/man/aka-generate.1.txt
+- lib/aka/man/aka-link.1
+- lib/aka/man/aka-link.1.txt
 - lib/aka/man/aka-list.1
 - lib/aka/man/aka-list.1.txt
 - lib/aka/man/aka-remove.1
 - lib/aka/man/aka-remove.1.txt
 - lib/aka/man/aka-show.1
 - lib/aka/man/aka-show.1.txt
+- lib/aka/man/aka-sync.1
+- lib/aka/man/aka-sync.1.txt
+- lib/aka/man/aka-upgrade.1
+- lib/aka/man/aka-upgrade.1.txt
 - lib/aka/man/aka.7
 - lib/aka/man/aka.7.txt
 homepage: ''
@@ -176,9 +192,11 @@ test_files:
 - features/aka/edit.feature
 - features/aka/generate.feature
 - features/aka/help.feature
+- features/aka/link.feature
 - features/aka/list.feature
 - features/aka/remove.feature
 - features/aka/show.feature
+- features/aka/upgrade.feature
 - features/step_definitions/aka_steps.rb
 - features/support/env.rb
 - test/tc_something.rb

data/.ruby-version

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