agen 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: df67e0e93c7d387a143caea30f6227dcbe30b3adcb6aab2ef1c820a4acd1dbba
-  data.tar.gz: dc330d76655aefdf9f0ceaafa5d421426e4883d422c5cfe48347609e3734acdc
+  metadata.gz: 774809f0ab3f7e1b8bab9f9209f71f2e616f5da62edf2bf74f8f47f15d82b5ad
+  data.tar.gz: 20e8af719cc7093968b107a32d98963febb0b03e1c9dddda3a111e1170cded9a
 SHA512:
-  metadata.gz: 1739ef52ab785d37134f7f91bbcc3875997086fe53f4e142afe35770e5fb28075a24dc9727eee7b986ceecc36f6f206cd84690cee5f10065eb44817de77db9c5
-  data.tar.gz: c05fab9189e7300f4915a293ee8b55d5a6a1e41a91003e786d46ad76bfc7f2c31ca1b2933524f45d0e1d537bdec3bd70604d863372eaec95a290e4995af5cba7
+  metadata.gz: 66e2e642b09fc276d27ad922f219be8431c2dc2014726227189c1d2a2cb28960a061cb2da11d45fddc9dce5ff292bb70136b71fd8ebd0ca36f9f015385048686
+  data.tar.gz: 1b6beea0fb2a953cd710dc02974ce50aa1198234807cc776e1a5dfd0010dad241f9dbc160c89456b455749381601d9e5d0e03ab198997590068e48cec650cdae

data/.github/workflows/main.yml

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

data/CHANGELOG.md

@@ -1,5 +1,18 @@
-## [Unreleased]
+## [Released]
 
-## [0.1.0] - 2021-04-24
+## [0.2.0] - 2021-04-30
+- Fix: Ensures the same aliases is not built for multiple commands in the same run.
 
-- Initial release
+## [0.1.7] - 2021-04-26
+- Fix: Ensures the same aliases is not built for multiple commands in the same run.
+
+## [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.3)
+    agen (0.2.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,50 +1,24 @@
 # 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`.
+Generate shell aliases based on your most commonly entered commands.
 
-## Installation
+## Installation & Usage
 
-Add this line to your application's Gemfile:
+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.
 
-```ruby
-gem 'agen'
+```
+Usage: agen [options]
+    -n, --number=NUMBER              Number of aliases to generate
+    -a, --auto                       Aliases will be generated and applied automatically
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ 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 +28,18 @@ 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 support any (or most common) shells, and will find history and rc
+   file dynamically.
+* CLI will let you specific which history file to read from, 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,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,21 @@ 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
+
+        opts.on("-a", "--auto", "Aliases will be generated and applied automatically") do |a|
+          options[:auto] = a
+        end
+      end.parse!
+
+      Runner.new(**options).run
     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/runner.rb

@@ -4,25 +4,59 @@ 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,
+      auto: false
+    )
       @histfile = histfile
       @rcfile = rcfile
+      @number = number
+      @auto = auto
     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)
+          if auto
+            write_auto(file, al)
+          else
+            write_interactive(file, al)
+          end
         end
       end
     end
+
+    private
+
+    attr_reader :auto
+
+    def write_auto(file, aliaz)
+      puts aliaz
+      file.puts(aliaz)
+    end
+
+    def write_interactive(file, aliaz)
+      puts "Proposed alias: #{aliaz}"
+      print "Accept? [n to reject, any other key to accept]: "
+      response = gets.chomp
+      if response != "n"
+        file.puts(aliaz)
+        puts "Alias written"
+      else
+        puts "Alias skipped"
+      end
+
+      puts
+    end
   end
 end

data/lib/agen/version.rb

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

metadata

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