zimilar 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49c0ca0d74d35ec5a238c157ef939af258f20172
-  data.tar.gz: 708def047463c1436c0da4494475f1475cbd4f84
+  metadata.gz: 849ad80d8f0d35154c4cffc6cba8eedb72fa7a16
+  data.tar.gz: 12dc89a4b854a2ba5d64df8adc7ef5483f5884e1
 SHA512:
-  metadata.gz: bc1ad1c198101922349824eea7a6773d5ad196dba08da98866ffdd3f00226ce688ef281cd071c272abc601ef18a24951deaa2a2d93ec9a383b83595fb43583fb
-  data.tar.gz: 1858c9c65e478aedde8c4c2461e106835200ae115b81847d5a0c8e6cae108f8fc50c119448398ae7aff62404786c4bdf5a628dfdd536dbb3b26ef063312a8aee
+  metadata.gz: db09d04c3c8efb415fcf24ae98cee089e1a9496836ad89b664f727cb0e8e73d61d4827a9f50359974a4295ae683c63255400cb9e763debd0852be36d6d83cbff
+  data.tar.gz: 1f20011960973f0a2f32972c4816d6122682baa6cad671757fac870ba3a89ecb53b046aa59662ff624766a9eb6bcb515fa1fa5cb716bb68cfed7fc6a18c843e4

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in zimilar.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Konrad Lother
+
+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/README.md

@@ -0,0 +1,80 @@
+# Zimilar
+
+This small gem extends your shell (see ```Supported Shells```) to autocorrect inputs that would led in a 'command not found'. It basically parses your history file and tries to match to most suitable command found.
+
+```zimilar``` is just a small late-night hack I did and might be improved in the future. Its code is currently also not that optimized but for now, it works.
+
+I also think that it might be better to write this as a native shell function in order to not require ruby to be installed. As times pass by, this might change.
+
+
+## Supported Shells
+
+The following shells are supported by now:
+
+ - [zsh](http://www.zsh.org/)
+ - [bash](https://www.gnu.org/software/bash/bash.html)
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install zimilar
+
+Install from source:
+
+    $ git clone https://github.com/lotherk/zimilar.git
+    $ cd zimilar
+    $ rake build
+    $ gem install pkg/zimilar-VERSION.gem
+
+Or simply copy the ```bin/zimilar``` to anywhere you want. Please ensure to install its dependencies.
+
+
+## How it Works
+
+```zimilar``` parses your history file and compares the given command with all commands found in the history. It's using the [similar_text](https://github.com/seph/ruby-similar-text) gem to evaluate the matches.
+
+If ```zimilar``` finds a suitable match, it replaces your command and runs it.
+
+## Usage
+
+Please be aware of that this is a nightly hack and might, under worst circumstances, destroy all you know and love. Please do not use it without having this read.
+
+```zimilar``` doesn't correct to commands with a length less or equal than 2. This is because of most 'dangerous' commands are 2 charackters long, e.g. ```cp```, ```mv```, ```rm``` and many others.
+
+But still, use it at your own risk.
+
+### zsh
+Add the following into your .zshrc or any other file that is being ```source```ed during your login:
+
+```bash
+function command_not_found_handler() {
+  zimilar $@
+}
+```
+
+### bash
+Add the following into your .bashrc or any other file that is being ```source```ed during your login:
+
+```bash
+function command_not_found_handle {
+  zimilar $@
+}
+```
+
+
+## Example
+```
+kl@kbook:~/ $ vm
+Auto-guessed 'vim', 60.0%
+kl@kbook:~/ $
+
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/lotherk/zimilar/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/zimilar

@@ -0,0 +1,112 @@
+#!/usr/bin/env ruby
+require 'similar_text'
+
+config = {
+  :zsh => '.zsh_history',
+  :bash => '.bash_history'
+}
+
+shell = ENV['SHELL'].split("/")[-1].to_sym  # auto detect shell
+
+unless shell
+  $stderr.puts "could not guess shell, aborting."
+  exit 1
+end
+
+unless config[shell]
+  $stderr.puts "unsupported shell '#{shell}'"
+  exit 1
+end
+
+histfile = ENV['HISTFILE']
+histfile ||= ENV['HOME'] + "/" + config[shell]
+
+unless histfile
+  $stderr.puts "could not read history file '#{histfile}'"
+  exit 1
+end
+
+command = ARGV.shift
+
+# read history - maybe there's a better way?
+candidates = {}
+line_counter = 0
+File.open(histfile, "r").each_line do |elem|
+  begin
+    line_counter += 1
+    next if elem.empty?
+    line = elem
+    if elem =~ /^:/ # zsh
+      time, line = elem.split(";")
+      next unless line
+      next if line.strip == command.strip
+    end
+    cmd, arg = line.split(" ", 2);
+    next if cmd.strip == command.strip
+    next if cmd.length <= 2 # most dangerous commands on unix have a length of 2. like mv, rm, cp, ...
+
+    min = command.length - 1
+    max = command.length + 1
+    next unless cmd.length == command.length or cmd.length == min or cmd.length == max
+
+    sim = cmd.similar(command)
+    sim -= 20 if cmd.length != command.length # hm..
+    next unless sim >= 60
+
+    candidates[sim] ||= []
+    next if candidates[sim].include? cmd
+
+    candidates[sim] << cmd
+  rescue ArgumentError => ae
+    match = ae.message.match(%r{^invalid byte sequence in (.*)$})
+    if match
+     $stderr.puts "[zimilar] Couldn't parse history at line #{line_counter} due to encoding problems."
+     $stderr.puts elem
+     puts ""
+    else
+      raise
+    end
+  rescue
+    raise
+  end
+end
+
+
+
+
+candidates = Hash[candidates.sort_by { |k, v| k.to_f }.reverse.uniq]
+
+while candidates.count > 0 do
+  candidate = candidates.shift
+  sim = candidate[0]
+  cands = candidate[1]
+
+  if cands.count == 1
+    begin
+      puts "Auto-guessed '#{cands[0]}', #{sim.round(2)}%"
+      slp = case sim
+        when 0..24 then 5
+        when 25..49 then 3
+        when 50..74 then 2
+        when 75..89 then 1
+        else 0
+      end
+      sleep slp
+      error = nil
+      begin
+        exec cands[0], *ARGV
+      rescue Exception => e
+        error = e
+      end
+
+      exit 0 unless error
+    rescue
+    end
+  elsif cands.count > 1
+    # abort here, do not iterate them all.
+    puts "Multiple candidates found:"
+    puts "  " + cands.join(", ")
+    exit 1
+  end
+end
+exit 1

data/lib/zimilar.rb

@@ -0,0 +1,5 @@
+require "zimilar/version"
+
+module Zimilar
+  # Your code goes here...
+end

data/lib/zimilar/version.rb

@@ -0,0 +1,3 @@
+module Zimilar
+  VERSION = "0.0.4"
+end

data/zimilar.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'zimilar/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "zimilar"
+  spec.version       = Zimilar::VERSION
+  spec.authors       = ["Konrad Lother"]
+  spec.email         = ["konrad@corpex.de"]
+  spec.summary       = %q{This small gem extends your shell to autocorrect inputs that would led in a 'command not found'.}
+  spec.description   = %q{This small gem extends your shell to autocorrect inputs that would led in a 'command not found'.}
+  spec.homepage      = "https://github.com/lotherk/zimilar"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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"
+  spec.add_dependency "similar_text"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zimilar
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Konrad Lother
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-19 00:00:00.000000000 Z
+date: 2016-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,10 +56,20 @@ description: This small gem extends your shell to autocorrect inputs that would
   in a 'command not found'.
 email:
 - konrad@corpex.de
-executables: []
+executables:
+- zimilar
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/zimilar
+- lib/zimilar.rb
+- lib/zimilar/version.rb
+- zimilar.gemspec
 homepage: https://github.com/lotherk/zimilar
 licenses:
 - MIT
@@ -80,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: This small gem extends your shell to autocorrect inputs that would led in