alias_metrics 0.1

data/.gitignore

@@ -0,0 +1,2 @@
+tmp
+*.gem

data/.rspec

@@ -0,0 +1,2 @@
+--format Fuubar
+--color

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+group :development do
+  gem 'rspec', '~> 2.0'
+  gem 'fuubar', "~> 1.0.0"
+  gem "rake", "~> 0.9.2.2"
+end
+

data/Gemfile.lock

@@ -0,0 +1,27 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    fuubar (1.0.0)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.2.0)
+      ruby-progressbar (~> 0.0.10)
+    rake (0.9.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-instafail (0.2.2)
+    rspec-mocks (2.8.0)
+    ruby-progressbar (0.0.10)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fuubar (~> 1.0.0)
+  rake (~> 0.9.2.2)
+  rspec (~> 2.0)

data/README

@@ -0,0 +1,49 @@
+This tool is to visualize alias usage to parse command history. You can evaluate whether you use alias efficiently or not.
+* It can show reduced types and more redusable types
+* It can show how degree you use each alias
+
+The visabliable shell scripts is the followings:
+* zsh (${HOME}/.zsh-history)
+
+
+How to use:
+
+$ alias | alias_metrics
+
+
+Case Study:
+
+$ alias | alias_metrics
+>>
+
+You reduce 10.25% types (29814 / 290970)
+
+If you use alias all, you can reduce more 3.98% types (11575 / 290970)
+
+
+
+ You often forget the following alias
+
+ alias   #used   #forgot forgot rate(%)  command
+
+ g       9       1530    99.42   git
+
+ _       0       210     100.00  sudo
+
+ gco     24      197     89.14   git checkout
+
+ ga      516     190     26.91   git add
+
+ ...
+<<
+I regist alias g=`git`, but I often forgot to use this alias. This result show I typed "git" 1530 times. So I can reduce 1530 * 2 = 3060 types by typing "g" instead of "git".
+
+
+Todo:
+
+* It can parse other shell scrpt(bash, csh, etc...)
+* Add the function that recommends alias that can reduce your types by setting it
+* Add the function that show Gold Standard
+* Acceleration
+
+

data/Rakefile

@@ -0,0 +1,11 @@
+begin
+    require 'rspec/core/rake_task'
+
+      RSpec::Core::RakeTask.new(:spec) do |t|
+            t.ruby_opts = '-w'
+              end
+
+        task :default => :spec
+rescue LoadError
+    raise 'RSpec could not be loaded. Run `bundle install` to get all development dependencies.'
+end

data/alias_metrics.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |spec|
+  spec.name        = 'alias_metrics'
+  spec.version     = '0.1'
+  spec.summary     = "This tool is to visualize alias usage to parse command history. You can evaluate whether you use alias efficiently or not."
+  spec.author      = ["Kohei Tomita"]
+  spec.email       = "tommy.fmale@gmail.com"
+  spec.executables = %w(alias_metrics)
+  spec.files       = `git ls-files`.split("\n") rescue ''
+  spec.homepage    = "https://github.com/tomity/alias_metrics"
+  spec.add_development_dependency 'rspec', '~> 2.0'
+  spec.add_development_dependency 'fuubar', "~> 1.0.0"
+  spec.add_development_dependency "rake", "~> 0.9.2.2"
+end

data/bin/alias_metrics

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+lib = File.dirname(__FILE__) + '/../lib/'
+$:.unshift lib unless $:.include?(lib)
+require "alias_metrics"
+
+@alias_list = AliasList.load_from_stdin
+@history = CommandHistory.load_from_zsh_history(@alias_list)
+command_length_all = @history.commands.map{|command| command.size}.inject(0){|partial_sum, size| partial_sum + size}
+shorten_count = @history.shorten_count
+shorten_rate = shorten_count.to_f / command_length_all
+shortenable_count_all = @history.shortenables.values.inject(0){|partial_sum, shortenable| partial_sum + shortenable.count * [0, (shortenable.command.size - shortenable.alias.size)].max }
+shortenable_rate = shortenable_count_all.to_f / command_length_all
+
+puts "You reduce #{sprintf("%0.2f", shorten_rate * 100)}% types (#{shorten_count} types/ #{command_length_all} types)"
+puts "If you use alias all, you can reduce more #{sprintf("%0.2f", shortenable_rate * 100)}% types (#{shortenable_count_all} types / #{command_length_all} types)"
+puts
+
+puts "You often forget the following alias"
+puts "alias\t#used\t#forgot\tforgot rate(%)\tcommand"
+keys = @history.shortenables.keys.sort{|a, b| @history.shortenables[a].count <=> @history.shortenables[b].count }.reverse
+keys.each do |key|
+  shortenable = @history.shortenables[key]
+  alias_usage = @history.alias_usages[shortenable.alias]
+  forgot_rate = shortenable.count.to_f / (alias_usage.count + shortenable.count)
+  puts "#{shortenable.alias}\t#{alias_usage.count}\t#{shortenable.count}\t#{sprintf("%0.2f", forgot_rate*100)}\t#{shortenable.command}"
+end
+

data/lib/alias_metrics.rb

@@ -0,0 +1,4 @@
+require "alias_metrics/alias_list.rb"
+require "alias_metrics/alias_usage.rb"
+require "alias_metrics/command_history.rb"
+require "alias_metrics/shortenable.rb"

data/lib/alias_metrics/alias_list.rb

@@ -0,0 +1,89 @@
+class AliasList
+  attr_accessor :alias_hash
+
+  def self.load_from_lines(lines)
+    alias_hash = Hash::new
+    lines.each do |line|
+      key, value = separate_key_value_from_alias_line(line)
+      alias_hash[key] = value
+    end
+    AliasList.new(alias_hash)
+  end
+
+  def self.load_from_stdin
+    alias_hash = Hash::new
+    STDIN.each do |line|
+      line.chomp!
+      key, value = separate_key_value_from_alias_line(line)
+      alias_hash[key] = value
+    end
+    AliasList.new(alias_hash)
+  end
+
+  #NOTE: Since #command >> #alias, this process do fastly
+  def expand_command(command)
+   @alias_hash.each_pair do |key, value|
+     if used_subcommand?(command, key)
+       command = command.sub(key, value)
+     end
+   end
+   command
+  end
+
+  #NOTE: Since #command >> #alias, this process do fastly
+  def applied_alias(command)
+   ret = []
+   @alias_hash.each_pair do |key, value|
+     if used_subcommand?(command, key)
+       command = command.sub(key, value)
+       ret << [key, value]
+     end
+   end
+   ret
+  end
+
+  #NOTE: Since #command >> #alias, this process do fastly
+  def shortenable?(command)
+    @alias_hash.values.each do |value|
+      if used_subcommand?(command, value)
+        return true
+      end
+    end
+    false
+  end
+
+  def shortenable_alias(command)
+   ret = []
+   @alias_hash.each_pair do |key, value|
+     if used_subcommand?(command, value)
+       ret << [key, value]
+     end
+   end
+   ret
+  end
+
+  private
+
+  def initialize(alias_hash)
+    @alias_hash = alias_hash.freeze
+  end
+
+  def self.separate_key_value_from_alias_line(line)
+    key, value = line.split(/=/)
+    value = remove_single_quotes(value)
+    [key, value]
+  end
+
+  def self.remove_single_quotes(value)
+    if value[0, 1] == "'" and value[-1, 1] == "'"
+      value = value[1..-2]
+    end
+    value
+  end
+
+  def used_subcommand?(command, alias_)
+    command == alias_ || command.start_with?(alias_+ " ")
+  end
+end
+
+

data/lib/alias_metrics/alias_usage.rb

@@ -0,0 +1,13 @@
+
+class AliasUsage
+  attr_accessor :alias
+  attr_accessor :command
+  attr_accessor :count
+
+  def initialize(alias_, command)
+    self.alias = alias_.freeze
+    self.command = command.freeze
+    self.count = 0
+  end
+
+end

data/lib/alias_metrics/command_history.rb

@@ -0,0 +1,79 @@
+class CommandHistory
+  attr_accessor :commands
+  attr_accessor :shorten_count
+  attr_accessor :shortenables
+  attr_accessor :alias_usages
+  attr_accessor :alias_list
+
+  ZSH_HISTORY_FILE = "#{ENV["HOME"]}/.zsh_history"
+
+  def initialize(commands, alias_list)
+    self.alias_list = alias_list
+    self.commands = []
+    self.shorten_count = 0
+    self.shortenables = Hash.new
+    self.alias_usages = Hash.new
+    alias_list.alias_hash.each_pair do |alias_, value|
+      self.alias_usages[alias_] = AliasUsage.new(alias_, value)
+      self.shortenables[value] = Shortenable.new(alias_, value)
+    end
+
+    commands.each do |command|
+      update_shortenables(command)
+      update_alias_usages(command)
+      command_expanded = self.alias_list.expand_command(command)
+      self.shorten_count += [0, command_expanded.length - command.length].max
+      self.commands << command_expanded
+    end
+    self.alias_list     = self.alias_list.freeze
+    self.commands       = self.commands.freeze
+    self.shorten_count = self.shorten_count.freeze
+    self.shortenables    = self.shortenables.freeze
+    self.alias_usages   = self.alias_usages.freeze
+  end
+
+  def self.load_from_zsh_history(alias_list, history_file = ZSH_HISTORY_FILE)
+    commands = []
+    open(history_file) do |fh|
+      fh.each do |line|
+        line.chomp!
+        next if line == ""
+        begin
+          command = parse_command_by_zsh_history_line(line)
+          commands << command if command
+        rescue ArgumentError #invalid byte sequence in UTF-8
+          #do nothing
+        end
+      end
+    end
+    CommandHistory.new(commands, alias_list)
+  end
+
+  private
+
+  def self.parse_command_by_zsh_history_line(line)
+    command = line.split(/;/)[1]
+    return command
+  end
+
+  def update_shortenables(command)
+    if alias_list.shortenable?(command)
+      shortenable_alias_list = alias_list.shortenable_alias(command)
+      shortenable_alias_list.each do |alias_, extension|
+        self.shortenables[extension].count += 1 if shortenable?(alias_, extension)
+      end
+    end
+  end
+
+  def update_alias_usages(command)
+    applied_alias = self.alias_list.applied_alias(command)
+    applied_alias.each do |alias_, value|
+      self.alias_usages[alias_].count += 1
+    end
+  end
+
+  def shortenable?(alias_, command)
+    command.size > alias_.size
+  end
+
+end

data/lib/alias_metrics/shortenable.rb

@@ -0,0 +1,11 @@
+class Shortenable
+  attr_accessor :command
+  attr_accessor :alias
+  attr_accessor :count
+
+  def initialize(alias_, command)
+    self.alias = alias_.freeze
+    self.command = command.freeze
+    self.count = 0
+  end
+end

data/spec/alias_list_spec.rb

@@ -0,0 +1,50 @@
+require "alias_metrics"
+
+describe AliasList do
+  before do
+    @alias_list = AliasList.load_from_lines(["l='ls -la'", "sl=ls", "grhh='git reset --hard HEAD\^'"])
+  end
+  describe "expand_command" do
+    it "should output `ls -la` for the command `l` " do
+      @alias_list.expand_command("l").should == "ls -la"
+    end
+
+    it "should output `ls -la -h` for the command `l -h` " do
+      @alias_list.expand_command("l -h").should == "ls -la -h"
+    end
+
+    it "should output `ls` for the command `sl` " do
+      @alias_list.expand_command("sl").should == "ls"
+    end
+
+    it "should output `ls -l` for the command `sl -l` " do
+      @alias_list.expand_command("sl -l").should == "ls -l"
+    end
+
+    it "should output `slope` for the command `slope` because this command is slope, but is not sl" do
+      @alias_list.expand_command("slope").should == "slope"
+    end
+  end
+
+  describe "shortenable" do
+    it "should output `ls -la` is shortenable" do
+      @alias_list.shortenable?("ls -la").should == true
+    end
+
+    it "should output `ls -la -h` for the command `l -h` " do
+      @alias_list.shortenable?("ls -la -h").should == true
+    end
+
+    it "should output `git reset --hard` is not shortenable" do
+      @alias_list.shortenable?("git reset --hard").should == false
+    end
+
+    it "should output `git HEAD\^ --hard` is not shortenable" do #Is this specification correct?
+      @alias_list.shortenable?("git reset HEAD\^ --hard").should == false
+    end
+  end
+
+end
+
+
+

data/spec/command_history_spec.rb

@@ -0,0 +1,70 @@
+require "alias_metrics"
+
+describe CommandHistory do
+  before do
+    @alias_list = AliasList.load_from_lines(["l='ls -la'", "ga=git add", "run-help=man"])
+    @history = CommandHistory.new(["l", "l -h", "ls -la", "ls -la -h", "man"], @alias_list)
+  end
+
+  it "can get the number of commands" do
+    @history.commands.size.should == 5
+  end
+
+  it "can count the number of chars shorten" do
+    @history.shorten_count.should == 10 #becaulse (`ls -la` => `l`) * 2
+  end
+
+  it "should be count is 2 when ls -la" do
+    shortenable = @history.shortenables["ls -la"]
+    shortenable.alias.should == "l"
+    shortenable.command.should == "ls -la"
+    shortenable.count.should == 2
+  end
+
+  it "should be count is 0 when git add" do
+    shortenable = @history.shortenables["git add"]
+    shortenable.alias.should == "ga"
+    shortenable.command.should == "git add"
+    shortenable.count.should == 0
+  end
+
+  it "should be count is 0 when ls -la because run-help is longer than man" do
+    shortenable = @history.shortenables["man"]
+    shortenable.alias.should == "run-help"
+    shortenable.command.should == "man"
+    shortenable.count.should == 0
+  end
+
+  it "should be alias usage is 2 when l" do
+    alias_usage = @history.alias_usages["l"]
+    alias_usage.alias.should == "l"
+    alias_usage.command.should == "ls -la"
+    alias_usage.count.should == 2
+  end
+
+  it "should be alias usage is 0 when ga" do
+    alias_usage = @history.alias_usages["ga"]
+    alias_usage.alias.should == "ga"
+    alias_usage.command.should == "git add"
+    alias_usage.count.should == 0
+  end
+
+  it "should be alias usage is 0 when run-help" do
+    alias_usage = @history.alias_usages["run-help"]
+    alias_usage.alias.should == "run-help"
+    alias_usage.command.should == "man"
+    alias_usage.count.should == 0
+  end
+
+  it "can load from ~/.zsh_history" do
+    CommandHistory.load_from_zsh_history(@alias_list)
+  end
+
+  it "should store expanded commands" do
+    @history.commands[0].should == "ls -la"
+    @history.commands[1].should == "ls -la -h"
+    @history.commands[2].should == "ls -la"
+    @history.commands[3].should == "ls -la -h"
+    @history.commands[4].should == "man"
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: alias_metrics
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Kohei Tomita
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2152591180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152591180
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: &2152590180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *2152590180
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2152608520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *2152608520
+description: 
+email: tommy.fmale@gmail.com
+executables:
+- alias_metrics
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- alias_metrics.gemspec
+- bin/alias_metrics
+- gems/alias_metrics-0.1.gem
+- lib/alias_metrics.rb
+- lib/alias_metrics/alias_list.rb
+- lib/alias_metrics/alias_usage.rb
+- lib/alias_metrics/command_history.rb
+- lib/alias_metrics/shortenable.rb
+- spec/alias_list_spec.rb
+- spec/command_history_spec.rb
+homepage: https://github.com/tomity/alias_metrics
+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: This tool is to visualize alias usage to parse command history. You can evaluate
+  whether you use alias efficiently or not.
+test_files: []