huffshell 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+gemspec
+gem 'rspec'
+gem 'colorize'

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    huffshell (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    colorize (0.5.8)
+    diff-lcs (1.1.3)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  colorize
+  huffshell!
+  rspec

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/Readme.md

@@ -0,0 +1,34 @@
+HuffShell
+====================
+
+HuffShell is a gem for optimizing your ZSH aliases, programtically.
+
+The gems looks at your history which can be automatically stored and generates aliases based on your usage. Your history is used to determine what you use the most and generate the shortest commands based on usage.
+
+For example, you use 'git' 500 times and you use 'ls -l' 100 times. You should add aliases that are 'g' and 'll'. It could save you hundreds of keystokes.
+
+In order to do that, huffshell generates stats of your usage and gives them to you, as you might hope.
+
+Features
+---------------------
+
+* Alias suggestion based on history.
+* Examines your system for binaries and aliases and avoids reassigning them.
+* Huffman inspired symbol generation.
+* Handy gem packaging.
+* Works out of the box with oh-my-zsh.
+
+Installation
+---------------------
+
+```script
+# install it
+gem install huffman
+
+# need to be able to access this from the gem
+alias > ~/.aliases.cache
+huffshell
+
+# cleanup
+alias > ~/.aliases.cache
+```

data/bin/huffshell

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'huffshell'
+require 'pp'
+
+cs = CommandSuggestor.new
+history_filename = '~/.zsh_history'
+
+OhMyZshReader.new(history_filename).
+  shell_commands.
+  each{ |l| cs.add(l) }
+
+cs.truncate!(30)
+puts cs.to_print

data/lib/command/command_suggestion.rb

@@ -0,0 +1,42 @@
+require 'colorize'
+
+class CommandSuggestion
+  attr_accessor :wordlist
+
+  SHORT_ENOUGH = 3
+
+  def initialize(wordlist)
+    @wordlist = wordlist
+  end
+
+  def to_s
+    if exists?
+      "'#{command}' => #{abbreviation} taken :("
+    else
+      "'#{command}' => " + "#{abbreviation}".green
+    end
+  end
+
+  def abbreviation
+    wordlist.map{|w| CommandWord.suggested_letter(w) }.join.downcase
+  end
+
+private
+
+  def command
+    wordlist.join(" ")
+  end
+
+  def exists?
+    binary_checker.exist? || alias_checker.exist?(abbreviation)
+  end
+
+  def binary_checker
+    BinaryChecker.new(abbreviation)
+  end
+
+  def alias_checker
+    AliasChecker.new("~/.aliases.cache")
+  end
+
+end

data/lib/command/command_suggestor.rb

@@ -0,0 +1,24 @@
+class CommandSuggestor
+  attr_accessor :wordtree
+
+  def initialize()
+    @wordtree = WordTree.new
+  end
+
+  def add(line)
+    sl = ScriptLine.new(line)
+    return unless sl.valid?
+    wordtree.add(sl)
+  end
+
+  def truncate!(minimum)
+    wordtree.root.truncate!(minimum)
+  end
+
+  def to_print
+    wordtree.root.map do |n|
+      cs = CommandSuggestion.new(n.word_list)
+      "#{n.to_print.chomp} #{cs.to_s}"
+    end
+  end
+end

data/lib/command/command_word.rb

@@ -0,0 +1,11 @@
+class CommandWord
+  def self.clean(word)
+    word.gsub(/(\-)+/, '') #.downcase
+  end
+
+  def self.suggested_letter(word)
+    word.gsub(/(^\W)+/,"")[0].downcase
+  rescue
+    nil
+  end
+end

data/lib/huffshell.rb

@@ -0,0 +1,13 @@
+require 'readers/oh_my_zsh_reader'
+
+require 'command/command_word'
+require 'command/command_suggestor'
+require 'command/command_suggestion'
+
+require 'shell/alias_line'
+require 'shell/script_line'
+require 'shell/alias_checker'
+require 'shell/binary_checker'
+
+require 'tree/word_tree'
+require 'tree/word_tree_node'

data/lib/readers/oh_my_zsh_reader.rb

@@ -0,0 +1,35 @@
+require 'iconv' unless String.method_defined?(:encode)
+
+class OhMyZshReader
+  attr_accessor :file_name, :file_contents
+
+  def initialize(file_name)
+    @file_name = file_name
+    @file_contents = File.open(File.expand_path(file_name), 'r').read
+
+    if String.method_defined?(:encode)
+      @file_contents.encode!('UTF-8', 'UTF-8', :invalid => :replace)
+    else
+      ic = Iconv.new('UTF-8', 'UTF-8//IGNORE')
+      @file_contents = ic.iconv(@file_contents)
+    end
+  end
+
+  def shell_commands
+    filtered_lines.map {|l| l.split(";").last.strip }
+  end
+
+private
+
+  def filtered_lines
+    raw_lines(file_contents).select{|l| valid_line?(l) }
+  end
+
+  def valid_line?(line)
+    line[0] == ":"
+  end
+
+  def raw_lines(file_contents)
+    file_contents.split("\n")
+  end
+end

data/lib/shell/alias_checker.rb

@@ -0,0 +1,18 @@
+class AliasChecker
+  attr_accessor :filename, :aliases
+
+  def initialize(filename)
+    @filename = filename
+    file_contents = File.open(File.expand_path(filename), 'r').read
+    lines = file_contents.split("\n")
+    @aliases = {}
+    lines.each do |l|
+      al = AliasLine.new(l)
+      @aliases[al.alias_name] = al.command
+    end
+  end
+
+  def exist?(alias_name)
+    !!@aliases[alias_name]
+  end
+end

data/lib/shell/alias_line.rb

@@ -0,0 +1,16 @@
+class AliasLine
+  attr_accessor :line
+
+  def initialize(line)
+    @line = line
+  end
+
+  def alias_name
+    @line.split("=").first
+  end
+
+  def command
+    c = @line.split("=")[1]
+    c[1..(c.size-2)]
+  end
+end

data/lib/shell/binary_checker.rb

@@ -0,0 +1,11 @@
+class BinaryChecker
+  def initialize(command)
+    @command = command
+  end
+
+  def exist?
+    # would love something better
+    out = `command -v #{@command} >/dev/null 2>&1`
+    $?.to_s.scan("exit 0") != []
+  end
+end

data/lib/shell/script_line.rb

@@ -0,0 +1,27 @@
+class ScriptLine
+  attr_accessor :line, :words, :clean_words
+
+  def initialize(l)
+    @line = l.strip
+    @words = l.split(/[ \t]+/)
+    @clean_words = @words.map{|w| CommandWord.clean(w) }
+  end
+
+  def command
+    clean_words.first
+  end
+
+  def valid?
+    !(comment? || empty?)
+  end
+
+private
+
+  def comment?
+    @line[0] == "#"
+  end
+
+  def empty?
+    @line.size == 0
+  end
+end

data/lib/tree/word_tree.rb

@@ -0,0 +1,21 @@
+class WordTree
+  attr_accessor :root, :line_count
+
+  def initialize
+    @root = WordTreeNode.new
+    @line_count = 0
+  end
+
+  def add(line)
+    @line_count += 1
+    root.add(line, 0)
+  end
+
+  def truncate!(minimum)
+    root.truncate!(minimum)
+  end
+
+  def to_print
+    root.to_print
+  end
+end

data/lib/tree/word_tree_node.rb

@@ -0,0 +1,68 @@
+require 'colorize'
+
+class WordTreeNode
+  include Enumerable
+
+  attr_accessor :word, :cleanword, :children, :line_count, :level, :parent
+
+  def initialize(word = nil, level = 0, parent = nil)
+    @word = word
+    @cleanword = CommandWord.clean(word) if word
+    @children = {}
+    @line_count = 0
+    @level = level
+    @parent = parent
+  end
+
+  def add(line, level = 0)
+    word = line.words[level]
+    clean_word = line.clean_words[level]
+    @line_count += 1
+    return unless word
+
+    @children[word] ||= WordTreeNode.new(word, level + 1, self)
+    @children[word].add(line, level + 1)
+  end
+
+  def each &block
+    children.values.sort.each do |v|
+      block.call(v)
+      v.each do |q|
+        block.call(q)
+      end
+    end
+  end
+
+  def <=> b
+    b.line_count <=> line_count
+  end
+
+  def words
+    children.keys.uniq
+  end
+
+  def root?
+    word.nil?
+  end
+
+  def truncate!(minimum)
+    children.select!{|k, v| v.line_count >= minimum }
+    children.each{|k, v| v.truncate!(minimum) }
+  end
+
+  def word_list
+    list = [self.word]
+    node = self
+    while node = node.parent
+      next if node.word.nil?
+      list << node.word
+    end
+    list.reverse
+  end
+
+  def to_print
+    return "" if root?
+    "#{("\t" * (level - 1))}" + "#{word}".green + " #{line_count}:\n"
+  end
+
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: huffshell
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul McKellar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-18 00:00:00.000000000 Z
+dependencies: []
+description: A parser and recommendation system for your shell aliases based on your
+  shell history
+email: paul.mckellar@gmail.com
+executables:
+- huffshell
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/command/command_suggestion.rb
+- lib/command/command_suggestor.rb
+- lib/command/command_word.rb
+- lib/huffshell.rb
+- lib/readers/oh_my_zsh_reader.rb
+- lib/shell/alias_checker.rb
+- lib/shell/alias_line.rb
+- lib/shell/binary_checker.rb
+- lib/shell/script_line.rb
+- lib/tree/word_tree.rb
+- lib/tree/word_tree_node.rb
+- bin/huffshell
+- Gemfile
+- Gemfile.lock
+- Rakefile
+- Readme.md
+homepage: http://rubygems.org/gems/huffshell
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Automatic shell alias recommondations based on usage!
+test_files: []