agen 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df67e0e93c7d387a143caea30f6227dcbe30b3adcb6aab2ef1c820a4acd1dbba
-  data.tar.gz: dc330d76655aefdf9f0ceaafa5d421426e4883d422c5cfe48347609e3734acdc
+  metadata.gz: ac1f9e3386a6c2aa6a792d31040e869cd0cc2243335b0406d8636003cdd91737
+  data.tar.gz: c8465c062ca6dba68556e80a22ba7600688f7a60e237c1e2f01352c6fffd7a1e
 SHA512:
-  metadata.gz: 1739ef52ab785d37134f7f91bbcc3875997086fe53f4e142afe35770e5fb28075a24dc9727eee7b986ceecc36f6f206cd84690cee5f10065eb44817de77db9c5
-  data.tar.gz: c05fab9189e7300f4915a293ee8b55d5a6a1e41a91003e786d46ad76bfc7f2c31ca1b2933524f45d0e1d537bdec3bd70604d863372eaec95a290e4995af5cba7
+  metadata.gz: 2ce071d533b7af081c55e7cd1f91c8326a9145c4731c2e891e84c1b93544207df5159824646a78623707afd1e0bfb5d6062bdeab65bf94cd4afd1a8da0d58d7b
+  data.tar.gz: 66138b4626cb5c8b257e5325904a9efd8d9ee8e3623bc59ec78e2b58e46e654c4b3ff90e1e702bb5b03c57c5218f9bb844330b4bf659a0184e0f1d54157b0f0a

data/.github/workflows/main.yml

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

data/CHANGELOG.md

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    agen (0.1.3)
+    agen (0.1.4)
 
 GEM
   remote: https://rubygems.org/

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,30 @@ 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
+
+~~1. CLI will read 5 most common full commands from .zsh_history file, and create
+   an alias for them in the .zshrc file.~~
+   - [x] It should handle a very short or shell history without many different
+      commands.
+   - [x] It should not create the same alias for two different commands in the same
+       session.
+   - [x] It should not create aliases for very short commands.
+~~2. CLI should not duplicate aliases or commands that already exist on the system.~~
+3. CLI will let you see proposed aliases and accept/decline them interactively. Maybe auto should be the default?
+   OR, in "auto mode", commands will be added automatically (as in 1).
+4. CLI should have helpful output for `-h/--help`.
+5. CLI will let you specify number of aliases you want to create.
+6. CLI will support any (or most common) shells, and will find history and rc
+   file dynamically.
+7. CLI will let you specific which history file to read form, and which file to output aliases to.
+8. CLI will let you interactively modify proposed aliases.
+9. CLI will let you "ignore" commands you don't want to alias, forever.
+10. 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

@@ -9,8 +9,29 @@ module Agen
     def aliases
       @commands.map do |cmd|
         aliaz = cmd.scan(/\b\w/).join
+
+        # 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
+
         "alias #{aliaz}=\"#{cmd}\""
       end
     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

@@ -19,7 +19,7 @@ module Agen
         .sort_by { |k, v| -v }
         .to_h
         .keys
-        .select { |line| line.length >= min_chars }
+        .select { |cmd| cmd.length >= min_chars }
         .first(limit)
     end
 

data/lib/agen/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: agen
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Jonathan Thom