agen 0.1.4 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac1f9e3386a6c2aa6a792d31040e869cd0cc2243335b0406d8636003cdd91737
-  data.tar.gz: c8465c062ca6dba68556e80a22ba7600688f7a60e237c1e2f01352c6fffd7a1e
+  metadata.gz: 567b4d1df4a054da853eb05a9476bcf9579758cac435e562842c74655e773198
+  data.tar.gz: 86e7947aac95a1fc80822158509b1d2e762a11727eca8abda0001b7de87d2115
 SHA512:
-  metadata.gz: 2ce071d533b7af081c55e7cd1f91c8326a9145c4731c2e891e84c1b93544207df5159824646a78623707afd1e0bfb5d6062bdeab65bf94cd4afd1a8da0d58d7b
-  data.tar.gz: 66138b4626cb5c8b257e5325904a9efd8d9ee8e3623bc59ec78e2b58e46e654c4b3ff90e1e702bb5b03c57c5218f9bb844330b4bf659a0184e0f1d54157b0f0a
+  metadata.gz: cbaead32095bc304c5bf657426fa66f5b7196c90715a8b8466b597fc578d2c49414f25533bc815946b6bdf20c51af877299bdc3bcba886b4d575864fca04f324
+  data.tar.gz: 1c2b2388b097b4f7a95036be7395569d81b3de1e33630a2ffa1b5c262898dbda59742a62a6d88e9d0eb615dcba2375cbf7430472aeb99a77efe03fefa61e60c5

data/CHANGELOG.md

@@ -1,10 +1,22 @@
 ## [Released]
 
-## [0.1.4] - 2021-04-24
-- Avoids most alias naming conflicts with commands that already exist (e.g. `ls`)
+## [0.2.1] - 2021-05-01
+- Adds ability to modify aliases before writing them in interactive mode.
 
-## [0.1.3] - 2021-04-24
+## [0.2.0] - 2021-04-30
+- Adds interactive mode, allowing aliases to be accepted or rejected. On by
+default.
+
+## [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.4)
+    agen (0.2.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -6,10 +6,19 @@ Generate shell aliases based on your most commonly entered commands.
 
 ## Installation & Usage
 
-Install with `gem install agen` and then run `agen` to build your aliases.
+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.
+
+```
+Usage: agen [options]
+    -n, --number=NUMBER              Number of aliases to generate
+    -a, --auto                       Aliases will be generated and applied automatically
+```
 
 Right now, this will only work with `zsh`, but support for other shells is on
-the very lengthy todo list.
+the very lengthy todo list. By default, agen reads from `.zsh_history` and
+writes to `.zshrc`.
 
 ## Development
 
@@ -23,24 +32,12 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Jonath
 
 ## 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
+* 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.
+* 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`.
 

data/lib/agen/builder.rb

@@ -2,23 +2,39 @@
 
 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
 
         # Is is possibly we could overwrite a command here still? Sure.
         # I will live with it for now.
-        if command_already_exists?(aliaz)
+        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
 
-        "alias #{aliaz}=\"#{cmd}\""
-      end
+        candidate = construct_alias(aliaz, cmd)
+        if alias_does_not_exist?(candidate)
+          aliases << aliaz
+          {alias: aliaz, full_alias: candidate, command: cmd}
+        end
+      end.compact
+    end
+
+    def construct_alias(aliaz, cmd)
+      "alias #{aliaz}=\"#{cmd}\""
+    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

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/runner.rb

@@ -4,25 +4,76 @@ 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)
+      @builder = Builder.new(commands, rcfile)
+      aliases = builder.aliases
 
+      # TODO: This could be its own class too
       File.open(rcfile, "a") do |file|
-        puts "Writing aliases to #{rcfile}:"
+        puts "Writing new aliases to #{rcfile}:\n\n"
         aliases.each do |al|
-          puts al
-          file.puts(al)
+          if auto
+            write_auto(file, al[:full_alias])
+          else
+            write_interactive(file, al)
+          end
         end
       end
     end
+
+    private
+
+    attr_reader :auto, :builder
+
+    def write_auto(file, full_alias)
+      puts full_alias
+      file.puts(full_alias)
+    end
+
+    def write_interactive(file, aliaz)
+      puts "Proposed alias: #{aliaz[:full_alias]}"
+      print "Accept? [n to reject, m to modify alias, any other key to accept]: "
+      response = gets.chomp
+      case response
+      when "n"
+        puts "Alias skipped"
+      when "m"
+        modify_alias(file, aliaz)
+      else
+        file.puts(aliaz[:full_alias])
+        puts "Alias written"
+      end
+
+      puts
+    end
+
+    def modify_alias(file, aliaz)
+      print "Enter new alias [replacing #{aliaz[:alias]}]: "
+      replacement = gets.chomp
+      if replacement == ""
+        modify_alias(file, aliaz)
+        return
+      end
+
+      file.puts(builder.construct_alias(replacement, aliaz[:command]))
+      puts "Alias written"
+    end
   end
 end

data/lib/agen/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agen
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.1
 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