realiaser 0.0.1

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+gemspec
+gem 'rake'
+gem 'rspec'
+
+group :test do
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    Realiaser (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    multi_json (1.3.7)
+    rake (0.9.2.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.0)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  Realiaser!
+  rake
+  rspec
+  simplecov

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Paul McKellar
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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,65 @@
+Realiaser
+====================
+
+Realiaser is a game which helps you memorize your shell aliases.
+
+If you are like me, you have a lot of shell aliases but don't want to spend much time memorizing them. This gem helps remind you that you have defined an alias by telling you everytime you write a command where you should have used an alias.
+
+I defined the point system to work as follows. +1 pt for every command executed which was executed properly. -50 for every time I forget to use an alias.
+
+This is a pretty small library, only a two hour hack, but I've already started using more of my aliases because of the positive feedback loop it provides.
+
+Features
+---------------------
+
+* Tells if you your last command should have used an alias.
+* Keeps track of your score.
+* Keeps track of your last successful command and unsuccessful command.
+* Doesn't modify your ENV in any way.
+
+Installation
+---------------------
+
+There are two parts to the installation. The library and integrating it with your shell.
+
+```script
+# install the gem (sudo is optional)
+sudo gem install realiaser
+
+# the ruby script needs to be able to access aliases defined in the shell conf
+alias > ~/.alias.cache
+```
+
+This is the hard part. You need to change your right shell prompt.
+
+```
+function last_command() {
+  echo `history -1 | cut -d ' ' -f 3-20 | realiaser`
+}
+
+RPROMPT='%{$fg[$NCOLOR]%}%p $(last_command)%{$reset_color%}'
+````
+
+I have new aliases and it doesn't notice them.
+---------------------
+
+The ruby script can't see aliases in the environment.
+
+```script
+alias > ~/.alias.cache
+```
+
+
+Update
+---------------------
+
+```script
+gem update realiaser
+````
+
+Questions
+---------------------
+
+Q: Isn't this going to slow down my CLI?
+
+A: Running Ruby on every command isn't ideal, but it turns out that it didn't slow me down at all.

data/bin/realiaser

@@ -0,0 +1,23 @@
+directory_name = File.dirname(__FILE__)
+
+require File.join(directory_name, '../lib/alias_line.rb')
+require File.join(directory_name, '../lib/alias_suggestor.rb')
+require File.join(directory_name, '../lib/command_success_counter.rb')
+
+csc = Realiased::CommandSuccessCounter.new
+
+path = File.expand_path("~/.alias.cache")
+suggestor = Realiased::AliasSuggestor.new(path)
+
+input = ARGF.read.strip
+suggested = suggestor.suggest(input)
+
+if suggested.nil?
+  csc.correct!(input)
+  csc.append_command(input, true)
+  puts "#{csc.score}"
+else
+  csc.mistake!(input)
+  csc.append_command(input, false)
+  puts "#{suggested} (#{csc.score})"
+end

data/lib/alias_line.rb

@@ -0,0 +1,27 @@
+module Realiased
+class AliasLine
+
+  attr_accessor :shell_alias, :shell_command, :alias_line
+
+  def initialize(alias_line)
+    @alias_line = alias_line
+    splits = @alias_line.split('=')
+    @shell_command = splits.first.strip
+    @shell_alias = splits.last.strip.gsub("'",'')
+  end
+
+  def valid?
+    !nocorrect? && !transpose?
+  end
+
+private
+
+  def transpose?
+    ["ls"].include?(@shell_alias)
+  end
+
+  def nocorrect?
+    @alias_line.scan("nocorrect") != []
+  end
+end
+end

data/lib/alias_suggestor.rb

@@ -0,0 +1,20 @@
+module Realiased
+
+class AliasSuggestor
+  attr_accessor :alias_lines
+
+  def initialize(path)
+    @alias_lines = {}
+    File.new(path,'r').each do |line|
+      alias_line = AliasLine.new(line)
+      next unless alias_line.valid?
+      @alias_lines[alias_line.shell_alias] = alias_line.shell_command
+    end
+  end
+
+  def suggest(command)
+    @alias_lines[command]
+  end
+end
+
+end

data/lib/command_success_counter.rb

@@ -0,0 +1,124 @@
+module Realiased
+
+class CommandSuccessCounter
+
+  require 'fileutils'
+  require 'yaml'
+
+  @@default_file_location = "~/.realiaser_success_metrics"
+  @@history_file = "~/.realiaser_history"
+
+  @@positive_points = 1
+  @@negative_points = 50
+
+  def initialize
+    if !file_exists?
+      @data = {}
+      self.write
+    else
+      self.load
+    end
+    set_defaults!
+  end
+
+  def score
+    @data[:score]
+  end
+
+  def high_score
+    @data[:high_score]
+  end
+
+  def high_score_at
+    @data[:high_score_at]
+  end
+
+  def data
+    @data
+  end
+
+  def correct!(last_line)
+    if @data[:last_line] != last_line
+      @data[:last_line] = last_line
+      @data[:score] = @data[:score] + @@positive_points
+      mark_high_score
+      self.write
+    end
+  end
+
+  def mistake!(last_line)
+    if @data[:last_line] != last_line
+      @data[:last_line] = last_line
+      @data[:mistaken_command] = last_line
+      @data[:score] = [@data[:score] - @@negative_points, 0].max
+      self.write
+    end
+  end
+
+  def append_command(command, increment)
+    if increment
+      history_file << "#{command}:#{@@positive_points}:#{score}\n"
+    else
+      history_file << "#{command}:#{@@negative_points}:#{score}\n"
+    end
+    history_file.close
+  end
+
+protected
+
+  def mark_high_score
+    return unless high_score?
+    @data[:high_score] = score
+    @data[:high_score_at] = Time.now
+  end
+
+  def high_score?
+    score > high_score
+  end
+
+  def set_defaults!
+    @data[:score] ||= 0
+    @data[:high_score] ||= 0
+    @data[:high_score_at] ||= Time.now
+  end
+
+  def history_file
+    File.new(history_path, 'a')
+  end
+
+  def load
+    @data = YAML.load(File.new(path, 'r').read)
+    unless @data.instance_of?(Hash)
+      @data = {}
+    end
+  end
+
+  def write
+    file = File.new(path, 'w')
+    file << @data.to_yaml
+    file.close
+  end
+
+  def history_path
+    File.expand_path(@@history_file)
+  end
+
+  def self.path
+    File.expand_path(@@default_file_location)
+  end
+
+  def path
+    self.class.path
+  end
+
+  def touch
+    FileUtils.touch(path)
+  end
+
+  def file_exists?
+    File.exists?(path)
+  end
+
+end
+
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: realiaser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paul McKellar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-30 00:00:00.000000000Z
+dependencies: []
+description: Adds a feedback look and gamifies your shell usage to help you learn
+  your aliases.
+email: paul.mckellar@gmail.com
+executables:
+- realiaser
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/alias_line.rb
+- lib/alias_suggestor.rb
+- lib/command_success_counter.rb
+- bin/realiaser
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- Readme.md
+- Realiaser-0.0.1.gem
+homepage: https://github.com/paulmars/realiaser
+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: Realiaser is a game which helps you memorize your shell aliases.
+test_files: []