hsume2-aka 0.3.2 → 0.4.1

data/lib/aka/store.rb

@@ -7,9 +7,12 @@ module Aka
   class Store
     include Methadone::CLILogging
 
+    FORMAT = '3'
+
     def help(command, options)
       case command
       when nil       then command = "aka.7"
+      when 'ls'      then command = "aka.list.1"
       else command = "aka-#{command}.1"
       end
 
@@ -37,27 +40,37 @@ module Aka
     end
 
     def add(options)
-      found = configuration.shortcuts.find(options)
-
+      shortcut = Configuration::Shortcut.new({
+        :shortcut => options[:shortcut],
+        :command => options[:command],
+        :tag => options[:tag],
+        :description => options[:description],
+        :function => options[:function]
+      })
+
+      found = shortcut_manager.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|
-            configuration.shortcuts.replace(n, Configuration::Shortcut.parse(options))
+          found.each do |row|
+            [:shortcut, :command, :description, :function].each do |key|
+              row.send(:"#{key}=", options[key])
+            end
+            row.tag = options[:tag] || []
           end
-          configuration.save
+          save
           puts "Overwrote shortcut."
         end
       else
-        configuration.shortcuts.append(Configuration::Shortcut.parse(options))
-        configuration.save
+        shortcut_manager.add(shortcut)
+        save
         puts "Created shortcut."
       end
     end
 
     def list(options)
-      excluded = configuration.shortcuts.match_by_tag(options[:tag] || []) do |tag, rows|
+      excluded = shortcut_manager.match_by_tag(options[:tag] || []) do |tag, rows|
         puts %{##{tag}}
         puts ''.ljust(tag.length + 1, '=')
         rows.each do |row|
@@ -66,14 +79,16 @@ module Aka
         puts
       end
 
-      if configuration.links.any?
+      if link_manager.any?
         puts "====="
         puts "Links"
         puts "====="
         puts
 
-        configuration.links.each do |index, link|
+        index = 1
+        link_manager.each do |link|
           puts "[#{index}] #{link.output}: #{link.tag.map { |tag| "##{tag}" }.join(', ')}"
+          index += 1
         end
       end
 
@@ -81,14 +96,14 @@ module Aka
     end
 
     def remove(options)
-      found = configuration.shortcuts.find(options)
+      found = shortcut_manager.find(options)
 
       if found.length > 0
-        found.each do |n, row|
-          configuration.shortcuts.delete(n)
+        found.each do |shortcut|
+          shortcut_manager.remove(shortcut)
         end
 
-        configuration.save
+        save
 
         puts "Removed shortcut."
       else
@@ -97,27 +112,38 @@ module Aka
     end
 
     def generate(options)
-      excluded = configuration.shortcuts.generate(options)
+      excluded = shortcut_manager.generate(options)
 
       excluded_output(excluded)
     end
 
     def link(options)
-      configuration.links.add(options)
-      configuration.save
+      unless options[:tag] && options[:output]
+        abort("Invalid link.")
+      end
+
+      new_link = Configuration::Link.new({
+        :tag => options[:tag],
+        :output => options[:output]
+      })
+
+      link_manager.add(new_link)
+      save
       puts "Saved link."
     end
 
     def unlink(key)
-      configuration.links.delete(key)
-      configuration.save
+      link_manager.remove(key)
+      save
       puts "Deleted link."
     end
 
     def sync(match)
-      configuration.links.each do |index, config|
+      index = 0
+      link_manager.each do |config|
+        index += 1
         next if match && match != index
-        excluded = configuration.shortcuts.generate(config.marshal_dump)
+        excluded = shortcut_manager.generate({ :tag => config.tag, :output => config.output })
         excluded_output(excluded)
       end
     end
@@ -125,9 +151,7 @@ module Aka
     def edit(options)
       result = nil
 
-      found = configuration.shortcuts.find(options)
-
-      index, row = found.first
+      row = shortcut_manager.find(options).first
 
       unless row
         abort "Shortcut not found."
@@ -170,17 +194,14 @@ module Aka
 
       if result
         parse_row_txt(row, result)
-        configuration.shortcuts.replace(index, row)
-        configuration.save
+        save
         puts "Saved shortcut."
       else
       end
     end
 
     def show(options)
-      found = configuration.shortcuts.find(options)
-
-      _, row = found.first
+      row = shortcut_manager.find(options).first
 
       if row
         puts show_output(row)
@@ -190,17 +211,54 @@ module Aka
     end
 
     def upgrade(options)
-      configuration.upgrade
+      configuration
+
+      if !@version
+        Upgrader::FromV0ToV1.run(aka_db)
+      elsif @version == '1'
+        Upgrader::FromV1ToV2.run(aka_db)
+      elsif @version == '2'
+        Upgrader::FromV2ToV3.run(aka_db)
+      end
+    end
+
+    def save
+      File.open(aka_db, 'w+') do |f|
+        f.write configuration.encode
+      end
     end
 
     private
 
     def configuration
-      @configuration ||= Configuration.new
+      @configuration ||= begin
+        if File.exist?(aka_db)
+          begin
+            Configuration.decode(File.read(aka_db))
+          rescue Protobuf::InvalidWireType => e
+            YAML::load_file(aka_db).tap do |result|
+              if result[:version]
+                @version = result[:version]
+              end
+            end
+            Configuration.new(:version => @version)
+          end
+        else
+          Configuration.new(:version => FORMAT)
+        end
+      end
+    end
+
+    def shortcut_manager
+      @shortcuts ||= ShortcutManager.new(configuration.shortcuts)
+    end
+
+    def link_manager
+      @link_manager ||= LinkManager.new(configuration.links)
     end
 
-    def shortcuts
-      configuration.shortcuts.all
+    def aka_db
+      ENV['AKA'] || File.expand_path('~/.aka.db')
     end
 
     def excluded_output(excluded)
@@ -211,11 +269,7 @@ module Aka
     end
 
     def list_output(row)
-      if row.function
-        description = row.description || row.command
-      else
-        description = row.command
-      end
+      description = row.description.length > 0 ? row.description : row.command
 
       if description
         description = description.split("\n").map(&:strip).join("; ")
@@ -240,7 +294,6 @@ module Aka
       end
       if txt =~ /^Tags:(.*)$/
         row.tag = $1.strip.split(',').map(&:strip)
-        row.delete_field('tag') if row.tag.empty?
       end
       if txt =~ /^Command:(.*)$/m
         row.command = $1.strip

data/lib/aka/upgrader.rb

@@ -1,27 +1,27 @@
 module Aka
   module Upgrader
     module FromV0ToV1
-      def self.run(aka_yml)
-        v0 = YAML::load_file(aka_yml)
+      def self.run(aka_db)
+        v0 = YAML::load_file(aka_db)
 
         current = {
           :version => '1',
           :shortcuts => v0
         }
 
-        FileUtils.cp(aka_yml, "#{aka_yml}.backup")
-        puts "Backed up to #{aka_yml}.backup."
+        FileUtils.cp(aka_db, "#{aka_db}.backup")
+        puts "Backed up to #{aka_db}.backup."
 
-        File.open(aka_yml, 'w+') do |f|
+        File.open(aka_db, 'w+') do |f|
           f.write current.to_yaml
         end
-        puts "Upgraded #{aka_yml}."
+        puts "Upgraded #{aka_db}."
       end
     end
 
     module FromV1ToV2
-      def self.run(aka_yml)
-        v1 = YAML::load_file(aka_yml)
+      def self.run(aka_db)
+        v1 = YAML::load_file(aka_db)
 
         v2 = v1.merge(:version => '2')
         links = v2.delete(:links)
@@ -34,13 +34,46 @@ module Aka
           end
         end
 
-        FileUtils.cp(aka_yml, "#{aka_yml}.backup")
-        puts "Backed up to #{aka_yml}.backup."
+        FileUtils.cp(aka_db, "#{aka_db}.backup")
+        puts "Backed up to #{aka_db}.backup."
 
-        File.open(aka_yml, 'w+') do |f|
+        File.open(aka_db, 'w+') do |f|
           f.write v2.to_yaml
         end
-        puts "Upgraded #{aka_yml}."
+        puts "Upgraded #{aka_db}."
+      end
+    end
+
+    module FromV2ToV3
+      def self.run(aka_db)
+        v2 = YAML::load_file(aka_db)
+
+        v3 = Configuration.new(:version => '3')
+
+        v2[:shortcuts].each do |_, shortcut|
+          v3.shortcuts << Configuration::Shortcut.new({
+            :shortcut => shortcut[:shortcut],
+            :command => shortcut[:command],
+            :tag => shortcut[:tag],
+            :description => shortcut[:description],
+            :function => shortcut[:function]
+          })
+        end
+
+        (v2[:links] || {}).each do |_, link|
+          v3.links << Configuration::Link.new({
+            :tag => link[:tag],
+            :output => link[:output]
+          })
+        end
+
+        FileUtils.cp(aka_db, "#{aka_db}.backup")
+        puts "Backed up to #{aka_db}.backup."
+
+        File.open(aka_db, 'w+') do |f|
+          f.write v3.encode
+        end
+        puts "Upgraded #{aka_db}."
       end
     end
   end

data/lib/aka/version.rb

@@ -1,3 +1,3 @@
 module Aka
-  VERSION = "0.3.2"
+  VERSION = "0.4.1"
 end

data/lib/aka.rb

@@ -1,6 +1,7 @@
-require "aka/shortcuts"
-require "aka/links"
-require "aka/configuration"
+require 'aka/configuration.pb'
+require "aka/shortcut"
+require "aka/shortcut_manager"
+require "aka/link_manager"
 require "aka/upgrader"
 require "aka/store"
 require "aka/version"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hsume2-aka
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.1
 platform: ruby
 authors:
 - Henry Hsu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-14 00:00:00.000000000 Z
+date: 2016-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,41 +39,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.9.2
 - !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: aruba
+  name: methadone
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.3.1
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
-  name: ronn
+  name: protobuf
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -81,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: methadone
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: '4.0'
 description: Manage Shell Keyboard Shortcuts
 email:
 - hhsu@zendesk.com
@@ -102,32 +88,17 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".ruby-version.example"
-- ".travis.yml"
-- Gemfile
-- Guardfile
 - LICENSE.txt
 - README.md
-- Rakefile
-- aka.gemspec
 - bin/aka
-- features/aka/add.feature
-- 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
+- bin/build
+- bin/postinstall
+- bin/postremove
 - lib/aka.rb
 - lib/aka/app.rb
-- lib/aka/configuration.rb
-- lib/aka/links.rb
-- lib/aka/man/.gitkeep
+- lib/aka/configuration.pb.rb
+- lib/aka/configuration.proto
+- lib/aka/link_manager.rb
 - lib/aka/man/aka-add.1
 - lib/aka/man/aka-add.1.txt
 - lib/aka/man/aka-edit.1
@@ -148,21 +119,11 @@ files:
 - lib/aka/man/aka-upgrade.1.txt
 - lib/aka/man/aka.7
 - lib/aka/man/aka.7.txt
-- lib/aka/shortcuts.rb
+- lib/aka/shortcut.rb
+- lib/aka/shortcut_manager.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
 homepage: ''
 licenses:
 - MIT
@@ -183,20 +144,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Manage Shell Keyboard Shortcuts
-test_files:
-- features/aka/add.feature
-- 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
+test_files: []

data/.gitignore

@@ -1,11 +0,0 @@
-.DS_Store
-results.html
-pkg
-html
-tmp
-Gemfile.lock
-.bundle
-.ruby-version
-
-# output from ronn
-lib/aka/man/

data/.ruby-version.example

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

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - "ruby-2.1.1"
-bundler_args: --without guard

data/Gemfile

@@ -1,8 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec
-
-group :guard do
-  gem 'guard'
-  gem 'guard-cucumber'
-end

data/Guardfile

@@ -1,6 +0,0 @@
-guard 'cucumber', :cli => '--no-profile --color --format progress --strict --tags ~@interactive' do
-  watch(%r{^lib/.+\.rb$})
-  watch(%r{^features/.+\.feature$})
-  watch(%r{^features/support/.+$})          { 'features' }
-  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
-end

data/Rakefile

@@ -1,98 +0,0 @@
-def dump_load_path
-  puts $LOAD_PATH.join("\n")
-  found = nil
-  $LOAD_PATH.each do |path|
-    if File.exists?(File.join(path,"rspec"))
-      puts "Found rspec in #{path}"
-      if File.exists?(File.join(path,"rspec","core"))
-        puts "Found core"
-        if File.exists?(File.join(path,"rspec","core","rake_task"))
-          puts "Found rake_task"
-          found = path
-        else
-          puts "!! no rake_task"
-        end
-      else
-        puts "!!! no core"
-      end
-    end
-  end
-  if found.nil?
-    puts "Didn't find rspec/core/rake_task anywhere"
-  else
-    puts "Found in #{path}"
-  end
-end
-require 'bundler'
-require 'rake/clean'
-
-require 'rake/testtask'
-
-require 'cucumber'
-require 'cucumber/rake/task'
-gem 'rdoc' # we need the installed RDoc gem, not the system one
-require 'rdoc/task'
-
-include Rake::DSL
-
-Bundler::GemHelper.install_tasks
-
-
-Rake::TestTask.new do |t|
-  t.pattern = 'test/tc_*.rb'
-end
-
-
-CUKE_RESULTS = 'results.html'
-CLEAN << CUKE_RESULTS
-Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "features --format html -o #{CUKE_RESULTS} --format pretty --no-source -x --tags ~@interactive"
-  t.fork = false
-end
-
-Rake::RDocTask.new do |rd|
-
-  rd.main = "README.rdoc"
-
-  rd.rdoc_files.include("README.rdoc","lib/**/*.rb","bin/**/*")
-end
-
-begin
-  require 'ronn'
-
-  namespace :man do
-    directory "lib/aka/man"
-
-    Dir["man/*.ronn"].each do |ronn|
-      basename = File.basename(ronn, ".ronn")
-      roff = "lib/aka/man/#{basename}"
-
-      file roff => ["lib/aka/man", ronn] do
-        sh "#{Gem.ruby} -S ronn --roff --pipe #{ronn} > #{roff}"
-      end
-
-      file "#{roff}.txt" => roff do
-        sh "groff -Wall -mtty-char -mandoc -Tascii #{roff} | col -b > #{roff}.txt"
-      end
-
-      task :build_all_pages => "#{roff}.txt"
-    end
-
-    desc "Build the man pages"
-    task :build => "man:build_all_pages"
-
-    desc "Clean up from the built man pages"
-    task :clean do
-      rm_rf "lib/aka/man"
-    end
-  end
-
-rescue LoadError
-  namespace :man do
-    task(:build) { abort "Install the ronn gem to be able to release!" }
-    task(:clean) { abort "Install the ronn gem to be able to release!" }
-  end
-end
-
-task :default => ["man:build", :test, :features]
-

data/aka.gemspec

@@ -1,28 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'aka/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "hsume2-aka"
-  spec.version       = Aka::VERSION
-  spec.authors       = ["Henry Hsu"]
-  spec.email         = ["hhsu@zendesk.com"]
-  spec.summary       = %q{Manage Shell Keyboard Shortcuts}
-  spec.description   = %q{Manage Shell Keyboard Shortcuts}
-  spec.homepage      = ""
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.files        += Dir.glob('lib/aka/man/**/*') # man/ is ignored by git
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency("bundler", "~> 1.5")
-  spec.add_development_dependency('rake', '~> 0.9.2')
-  spec.add_development_dependency('rdoc')
-  spec.add_development_dependency('aruba')
-  spec.add_development_dependency('ronn')
-  spec.add_dependency('methadone', '~> 1.3.1')
-end