agen 0.1.0 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acebf067e22c29311b6a91e2b24e5e8c3f822e24ec8d0a3b5221721e8c147b6a
-  data.tar.gz: 55129b76da51036069bfbc0890af80ef6b0d2ff57479666cd92d833327e81263
+  metadata.gz: dcbe6011253c346bb0abe4d9147146610cbc9fc98f7769f31b960ba20304af17
+  data.tar.gz: 5e8035ec1fb0aec32b660395ea24d6d5a8a88aa9e8cc88d0122115d6a2358150
 SHA512:
-  metadata.gz: 385c8d66a02051d68bce4de28b3c81c8fb106c509e2f2bfa14825dd4440b21399f3060ddee26a78ba6e5e3638a34429d1c992cb04d12939b9bad935ef00373d0
-  data.tar.gz: 433e67ddc92ac47d02c9618a1741bde74e3c8bd0f8621f1f4488270ea6d30a69f2664fd40c14eb97f70ae2f578e97c9180a969c66a5bae869d3b1fdf9c59df15
+  metadata.gz: 4ca5c06be491092c201c8dcbce7623f0a887d4fbd52e36ab9afc27281ced79fbc97ecb878fc016f4c958893e82bd6718cd08f978c2619fc7a8f59bee7e84358a
+  data.tar.gz: 6e62b98c8745005dd1c1632abdc44adef8b55c9e47cfab0318652248b6e5df125109f378b53ca549c8521b6fa07bb70554397b09bcdb63e6bfdb24342f20e30b

data/.github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: Ruby
+name: Build
 
 on: [push,pull_request]
 

data/CHANGELOG.md

@@ -1,5 +1,9 @@
-## [Unreleased]
+## [Released]
 
-## [0.1.0] - 2021-04-24
+## [0.1.5] - 2021-04-24
 
-- Initial release
+- Initial release that anyone should reasonably use.
+    - Support for .zshrc/.zsh_history.
+    - Automatically writes top 5 aliases for commands 6 characters or longer.
+    - Avoids most alias naming conflicts with commands that already exist (e.g. `ls`).
+    - Avoids duplicating aliases that have already been written.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    agen (0.1.0)
+    agen (0.1.5)
 
 GEM
   remote: https://rubygems.org/
@@ -49,6 +49,7 @@ GEM
     unicode-display_width (2.0.0)
 
 PLATFORMS
+  ruby
   x86_64-darwin-20
   x86_64-linux
 

data/README.md

@@ -1,50 +1,15 @@
 # Agen
 
-Generate shell aliases based on commonly entered commands.
+[![Build](https://github.com/JonathanWThom/agen/actions/workflows/main.yml/badge.svg)](https://github.com/JonathanWThom/agen/actions/workflows/main.yml)
 
-## Roadmap
-
-1. CLI will read 5 most common full commands from .zsh_history file, and create
-   an alias for them in the .zshrc file.
-   - It should not create aliases out of old aliases.
-   - It should handle a very short or shell history without many different
-      commands.
-   - It should output progress for very long/slow shell histories.
-   - It should not create the same alias for two different commands in the same
-       session.
-   - It should not create an alias that is longer than the original command.
-1. CLI will let you see proposed aliases and accept/decline them interactively.
-   OR, in "auto mode", commands will be added automatically (as in 1).
-1. CLI should have helpful output for `-h/--help`.
-1. CLI will let you specify number of aliases you want to create.
-1. CLI will support any (or most common) shells, and will find history and rc
-   file dynamically.
-1. CLI will let you specific which history file to read form, and which file to output aliases to.
-1. CLI will let you interactively modify proposed aliases.
-1. CLI will let you "ignore" commands you don't want to alias, forever.
-1. CLI will let you specify "meta" vs "full" commands.
-  - Full command would be `git checkout branch-name`, meta command would be
-      `git checkout`.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'agen'
-```
-
-And then execute:
+Generate shell aliases based on your most commonly entered commands.
 
-    $ bundle install
+## Installation & Usage
 
-Or install it yourself as:
+Install with `gem install agen` and then run `agen` to build your aliases.
 
-    $ gem install agen
-
-## Usage
-
-TODO: Write usage instructions here
+Right now, this will only work with `zsh`, but support for other shells is on
+the very lengthy todo list.
 
 ## Development
 
@@ -54,7 +19,23 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/agen.
+Bug reports and pull requests are welcome on GitHub at https://github.com/JonathanWThom/agen.
+
+## Roadmap
+
+* CLI will let you specify number of aliases you want to create.
+* CLI will let you see proposed aliases and accept/decline them interactively.
+   OR, in "auto mode", commands will be added automatically (as in 1). Auto
+   should be default?
+* CLI should have helpful output for `-h/--help`.
+* CLI will support any (or most common) shells, and will find history and rc
+   file dynamically.
+* CLI will let you specific which history file to read form, and which file to output aliases to.
+* CLI will let you interactively modify proposed aliases.
+* CLI will let you "ignore" commands you don't want to alias, forever.
+* CLI will let you specify "meta" vs "full" commands.
+  - Full command would be `git checkout branch-name`, meta command would be
+      `git checkout`.
 
 ## License
 

data/lib/agen/builder.rb

@@ -2,15 +2,44 @@
 
 module Agen
   class Builder
-    def initialize(commands)
+    def initialize(commands, rcfile = Runner::DEFAULT_RCFILE)
       @commands = commands
+      @rcfile = rcfile
     end
 
     def aliases
       @commands.map do |cmd|
         aliaz = cmd.scan(/\b\w/).join
-        "alias #{aliaz}=\"#{cmd}\""
+
+        # Is is possibly we could overwrite a command here still? Sure.
+        # I will live with it for now.
+        if command_already_exists?(aliaz)
+          # We could improve to look more like the original command, but again, works for now.
+          aliaz += aliaz[-1]
+        end
+
+        candidate = "alias #{aliaz}=\"#{cmd}\""
+        candidate if alias_does_not_exist?(candidate)
+      end.compact
+    end
+
+    private
+
+    def alias_does_not_exist?(aliaz)
+      File.readlines(@rcfile).none? { |line| line.include?(aliaz) }
+    end
+
+    # Shoutout to Stack Overflow: https://stackoverflow.com/a/5471032
+    def command_already_exists?(cmd)
+      exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+      ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
+        exts.each do |ext|
+          exe = File.join(path, "#{cmd}#{ext}")
+          return true if File.executable?(exe) && !File.directory?(exe)
+        end
       end
+
+      false
     end
   end
 end

data/lib/agen/finder.rb

@@ -2,14 +2,31 @@
 
 module Agen
   class Finder
+    LIMIT = 5
+    MIN_CHARS = 6
+
     def initialize(histfile)
       @histfile = histfile
     end
 
-    def commands(limit = 5)
-      File.readlines(@histfile).reverse.each_with_object(Hash.new(0)) do |line, commands|
-        commands[line.split(";").last.delete("\n")] += 1
-      end.sort_by { |k, v| -v }.to_h.keys.first(limit)
+    def commands(limit: LIMIT, min_chars: MIN_CHARS)
+      lines
+        .each_with_object(Hash.new(0)) do |line, commands|
+        cmd = line.split(";").last.delete("\n")
+        commands[cmd] += 1 if cmd != ""
+      rescue
+      end
+        .sort_by { |k, v| -v }
+        .to_h
+        .keys
+        .select { |cmd| cmd.length >= min_chars }
+        .first(limit)
+    end
+
+    private
+
+    def lines
+      File.readlines(@histfile).reverse
     end
   end
 end

data/lib/agen/runner.rb

@@ -14,10 +14,12 @@ module Agen
 
     def run
       commands = Finder.new(histfile).commands
-      aliases = Builder.new(commands).aliases
+      aliases = Builder.new(commands, rcfile).aliases
 
       File.open(rcfile, "a") do |file|
+        puts "Writing new aliases to #{rcfile}:"
         aliases.each do |al|
+          puts al
           file.puts(al)
         end
       end

data/lib/agen/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Agen
-  VERSION = "0.1.0"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agen
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.5
 platform: ruby
 authors:
 - Jonathan Thom
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2021-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake