agen 0.1.1 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 49b4f1125783920bc7b25522ff96b7ef31f606b901ac192c024931bd0aa20fc5
-  data.tar.gz: b4777fa42d27ec416573a867565563427b216422f12522f964645d32f1fd0ef8
+  metadata.gz: f90fceac9fed45a59113e45eb28e8eef96f7552b487d4ccc90f037765bdd96d3
+  data.tar.gz: 60e5528277c8cd195d43e67bf4653d70ddddb9cd93d1109c623e4d5ded9c546f
 SHA512:
-  metadata.gz: cdf675badd54139d2f548cccb525ab228ab68236abac838e69de9d993cc848f8d15e6ed4b9cec30434d1d39e2eaace17b2e86ae8d8104dbfddd6df13924ac861
-  data.tar.gz: 4247034d929c40541592da4bb6232d464560aef83f2fe97541851e3b701c03eba5737b84579c48e9564471be872471f8f0f671d0de5baf0cb56d52721ada4067
+  metadata.gz: 138b4c4c646a0b62b1665c057fa5dd659c13643fe751c2909c281c9f5446ca23ab2c67a8c51dc967ba38fb43ef1b8f4017e7d019337cbe378f27bd2f89b7119b
+  data.tar.gz: 43ad014f35c326d08f2c242680eaccd36e55a4bb14c316ab5cf8c6136fa82ed4956c15d3ab88d18670a2403e46f7f57aee103bb9c60ad111e83645e6d253a281

data/.github/workflows/main.yml

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

data/CHANGELOG.md

@@ -1,5 +1,12 @@
-## [Unreleased]
+## [Released]
 
-## [0.1.0] - 2021-04-24
+## [0.1.6] - 2021-04-25
+- Adds ability to specify number of aliases to generate.
 
-- Initial release
+## [0.1.5] - 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.
+    - 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.1)
+    agen (0.1.6)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,50 +1,17 @@
 # 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. Use
+`agen -h` to see available options.
 
-    $ 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. By default, agen reads from `.zsh_history` and
+writes to `.zshrc`.
 
 ## Development
 
@@ -54,7 +21,22 @@ 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 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/cli.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "optparse"
+
 module Agen
   class CLI
     def initialize(args = [])
@@ -7,8 +9,17 @@ module Agen
     end
 
     def run
-      # TODO: Parse args/options
-      Runner.new.run
+      options = {}
+
+      OptionParser.new do |opts|
+        opts.banner = "Usage: agen [options]"
+
+        opts.on("-nNUMBER", "--number=NUMBER", Integer, "Number of aliases to generate") do |n|
+          options[:number] = n
+        end
+      end.parse!
+
+      Runner.new(**options).run
     end
   end
 end

data/lib/agen/finder.rb

@@ -2,20 +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|
-        begin
-          cmd = line.split(";").last.delete("\n")
-          if cmd != ""
-            commands[line.split(";").last.delete("\n")] += 1
-          end
-        rescue
-        end
-      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

@@ -4,20 +4,24 @@ module Agen
   class Runner
     DEFAULT_HISTFILE = "#{Dir.home}/.zsh_history"
     DEFAULT_RCFILE = "#{Dir.home}/.zshrc"
+    DEFAULT_NUMBER = 5
 
     attr_reader :histfile, :rcfile
 
-    def initialize(histfile: DEFAULT_HISTFILE, rcfile: DEFAULT_RCFILE)
+    def initialize(histfile: DEFAULT_HISTFILE, rcfile: DEFAULT_RCFILE, number: DEFAULT_NUMBER)
       @histfile = histfile
       @rcfile = rcfile
+      @number = number
     end
 
     def run
-      commands = Finder.new(histfile).commands
-      aliases = Builder.new(commands).aliases
+      commands = Finder.new(histfile).commands(limit: @number)
+      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.1"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agen
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.6
 platform: ruby
 authors:
 - Jonathan Thom
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2021-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -103,7 +103,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.15
 signing_key:
 specification_version: 4
 summary: Generate shell aliases based on commonly entered commands.