agen 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43ec40b6400566c0adf7aed5269f7993406411cf1037168bb9ce08b5470d780b
-  data.tar.gz: 2d14004d0980aac0df863d338d57b578fcfa6ad05c9be420284749a25e0fd955
+  metadata.gz: 88c5c183242fa63c57940eba901e982778e930921fdaf8eda8ba2c64a23801f0
+  data.tar.gz: 262a494cd57ad6d3ee4474eee51a686a94309084222b5fc4b128be7ce35e5f40
 SHA512:
-  metadata.gz: a29757826256b1216ff6a64bf55a7319e8387b316d6f348fb8b331ec03e019d32b6ef6b9333a13e4009581746b826717860f620970a68014d64f334080f1f726
-  data.tar.gz: da2af239a0df07715433ba9699ac5e2f55cf0041a14aee9c5967b967624f9112cf0ddbe456d8d57c1cb615e5eb61b6ec264f4ba2e65d607a8f1ec5161370c709
+  metadata.gz: d994611c28f6f086450a4baf40e842cff15108cedaeba542710827ec77499f41086bcc1f334866873c1f3ef167588885ede145de26afb60eb30f6644036ba0ca
+  data.tar.gz: d553d15e0420538459819547d86faa117244833080ad27dc35177d776a2e37a2996c047042acdd0aa5d426da02df1060e0413f9cc5c09590b24a9b3a50804f52

data/.github/workflows/main.yml

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

data/CHANGELOG.md

@@ -1,5 +1,15 @@
-## [Unreleased]
+## [Released]
 
-## [0.1.0] - 2021-04-24
+## [0.1.7] - 2021-04-26
+- Fix: Ensures the same aliases is not built for multiple commands in the same run.
 
-- Initial release
+## [0.1.6] - 2021-04-25
+- Adds ability to specify number of aliases to generate.
+
+## [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.2)
+    agen (0.1.7)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,50 +1,18 @@
 # 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. Then
+be sure to `source ~/.zshrc` before using the new 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 +22,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/exe/agen

@@ -1,7 +1,5 @@
 #!/usr/bin/env ruby
 
-$LOAD_PATH.unshift("#{__dir__}/../lib")
-
 require "agen"
 
 Agen::CLI.new(ARGV).run

data/lib/agen/builder.rb

@@ -2,15 +2,48 @@
 
 module Agen
   class Builder
-    def initialize(commands)
+    def initialize(commands, rcfile = Runner::DEFAULT_RCFILE)
       @commands = commands
+      @rcfile = rcfile
     end
 
     def aliases
+      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) || aliases.include?(aliaz)
+          # We could improve to look more like the original command, but again, works for now.
+          aliaz += aliaz[-1]
+        end
+
+        candidate = "alias #{aliaz}=\"#{cmd}\""
+        if alias_does_not_exist?(candidate)
+          aliases << aliaz
+          candidate
+        end
+      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,22 @@ 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 aliases to #{rcfile}:"
+        puts "Writing new aliases to #{rcfile}:"
         aliases.each do |al|
           puts al
           file.puts(al)

data/lib/agen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agen
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Jonathan Thom
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-24 00:00:00.000000000 Z
+date: 2021-04-27 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.