agen 0.1.5 → 0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dcbe6011253c346bb0abe4d9147146610cbc9fc98f7769f31b960ba20304af17
-  data.tar.gz: 5e8035ec1fb0aec32b660395ea24d6d5a8a88aa9e8cc88d0122115d6a2358150
+  metadata.gz: edd821d0314f78d537a2228181e4f1dfd0ecaceddc8d8a67bb783499911e7ccb
+  data.tar.gz: 721e0d0871630027ac23c0e08d7dd54e3e20ef26fda674fe755ebb02e0e4be48
 SHA512:
-  metadata.gz: 4ca5c06be491092c201c8dcbce7623f0a887d4fbd52e36ab9afc27281ced79fbc97ecb878fc016f4c958893e82bd6718cd08f978c2619fc7a8f59bee7e84358a
-  data.tar.gz: 6e62b98c8745005dd1c1632abdc44adef8b55c9e47cfab0318652248b6e5df125109f378b53ca549c8521b6fa07bb70554397b09bcdb63e6bfdb24342f20e30b
+  metadata.gz: f2c802aa56ab03338dbe58638a5ab5cf525c13ffef6b0a6b11e5aff39b430d4645f3116d6d49e37425df1704029148ca8df3d8d5dc4af84d0b3dff8ff8263d1c
+  data.tar.gz: d02a95bbee062a61ebe93160c03f773706e45264b09cd4cae9a2aab2c1a45c97078192b399466854e22e87d80266c6aa29e61167ce3f8b726b4a07180311a450

data/.github/workflows/main.yml

@@ -12,5 +12,7 @@ jobs:
       with:
         ruby-version: 3.0.1
         bundler-cache: true
-    - name: Run the default task
+    - name: Lint
+      run: bundle exec rake standard
+    - name: Test
       run: bundle exec rake

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## [Released]
 
+## [0.3] - 2021-06-17
+- Adds support for bash shell.
+- Adds ability to pass custom rcfile and histfile options.
+
+## [0.2.1] - 2021-05-01
+- Adds ability to modify aliases before writing them in interactive mode.
+
+## [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.

data/Gemfile.lock

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

data/README.md

@@ -4,12 +4,25 @@
 
 Generate shell aliases based on your most commonly entered commands.
 
+https://user-images.githubusercontent.com/22665228/116796045-5e5a8280-aa8e-11eb-8b4c-4408a252c143.mov
+
+
 ## 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
+    -r, --rcfile=RCFILE              Path to shell rc file
+    -h, --histfile=HISTFILE          Path to shell history file
+```
 
-Right now, this will only work with `zsh`, but support for other shells is on
-the very lengthy todo list.
+Right now, this will only work with `zsh` or `bash`, but you can specify unique shell config files using the `-r` and `-h` options (though there is no guarantee that your history file will be read properly). By default, agen reads from `.zsh_history` and
+writes to `.zshrc`.
 
 ## Development
 
@@ -23,19 +36,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Jonath
 
 ## Roadmap
 
-* CLI will let you specify number of aliases you want to create.
-* 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 raise user friendly errors if you specify shell configuration files that don't exist.
 * CLI will let you specify "meta" vs "full" commands.
-  - Full command would be `git checkout branch-name`, meta command would be
-      `git checkout`.
+  - Full command would be `git checkout branch-name`, meta command would be `git checkout`.
 
 ## License
 

data/lib/agen.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 require_relative "agen/version"
+require_relative "agen/base_options"
+require_relative "agen/bash_options"
+require_relative "agen/zsh_options"
+require_relative "agen/shell"
 require_relative "agen/cli"
 require_relative "agen/builder"
 require_relative "agen/finder"

data/lib/agen/base_options.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Agen
+  class BaseOptions
+    def initialize(options)
+      @options = options
+    end
+
+    def set_histfile
+      # handle not set here
+      if !defined?(self.class::HISTFILE)
+        puts "Please specify shell history file with -h option. See agen --help."
+        return false
+      end
+
+      options.tap do |opts|
+        opts[:histfile] = self.class::HISTFILE
+      end
+    end
+
+    def set_rcfile
+      if !defined?(self.class::RCFILE)
+        puts "Please specify shell rc file with -r option. See agen --help."
+        return false
+      end
+
+      options.tap do |opts|
+        opts[:rcfile] = self.class::RCFILE
+      end
+    end
+
+    private
+
+    attr_reader :options
+  end
+end

data/lib/agen/bash_options.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Agen
+  class BashOptions < BaseOptions
+    HISTFILE = "#{Dir.home}/.bash_history"
+    RCFILE = "#{Dir.home}/.bashrc"
+  end
+end

data/lib/agen/builder.rb

@@ -2,27 +2,35 @@
 
 module Agen
   class Builder
-    def initialize(commands, rcfile = Runner::DEFAULT_RCFILE)
+    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
 
-        candidate = "alias #{aliaz}=\"#{cmd}\""
-        candidate if alias_does_not_exist?(candidate)
+        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)

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,32 @@ 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
+
+        opts.on("-rRCFILE", "--rcfile=RCFILE", String, "Path to shell rc file") do |r|
+          options[:rcfile] = r
+        end
+
+        opts.on("-hHISTFILE", "--histfile=HISTFILE", String, "Path to shell history file") do |h|
+          options[:histfile] = h
+        end
+      end.parse!
+
+      options = Shell.new(options).add_options
+      return unless options
+
+      Runner.new(**options).run
     end
   end
 end

data/lib/agen/finder.rb

@@ -14,7 +14,8 @@ module Agen
         .each_with_object(Hash.new(0)) do |line, commands|
         cmd = line.split(";").last.delete("\n")
         commands[cmd] += 1 if cmd != ""
-      rescue
+      rescue => e
+        puts e
       end
         .sort_by { |k, v| -v }
         .to_h

data/lib/agen/runner.rb

@@ -2,27 +2,78 @@
 
 module Agen
   class Runner
-    DEFAULT_HISTFILE = "#{Dir.home}/.zsh_history"
-    DEFAULT_RCFILE = "#{Dir.home}/.zshrc"
+    DEFAULT_HISTFILE = ZshOptions::HISTFILE
+    DEFAULT_RCFILE = ZshOptions::RCFILE
+    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, rcfile).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 new 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/shell.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Agen
+  class Shell
+    def initialize(options)
+      @options = options
+    end
+
+    def add_options
+      if !@options[:histfile]
+        @options = opts_klass.set_histfile
+      end
+
+      if @options && !@options[:rcfile]
+        @options = opts_klass.set_rcfile
+      end
+
+      @options
+    end
+
+    private
+
+    def bash?
+      @_bash ||= shell.match?(/bash/)
+    end
+
+    def opts_klass
+      @_opts_klass ||= if bash?
+        BashOptions
+      elsif zsh?
+        ZshOptions
+      else
+        BaseOptions
+      end.new(@options)
+    end
+
+    def shell
+      @_shell ||= ENV["SHELL"]
+    end
+
+    def zsh?
+      @_zsh ||= shell.match?(/zsh/)
+    end
+  end
+end

data/lib/agen/version.rb

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

data/lib/agen/zsh_options.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Agen
+  class ZshOptions < BaseOptions
+    HISTFILE = "#{Dir.home}/.zsh_history"
+    RCFILE = "#{Dir.home}/.zshrc"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: agen
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: '0.3'
 platform: ruby
 authors:
 - Jonathan Thom
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-25 00:00:00.000000000 Z
+date: 2021-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -75,11 +75,15 @@ files:
 - bin/setup
 - exe/agen
 - lib/agen.rb
+- lib/agen/base_options.rb
+- lib/agen/bash_options.rb
 - lib/agen/builder.rb
 - lib/agen/cli.rb
 - lib/agen/finder.rb
 - lib/agen/runner.rb
+- lib/agen/shell.rb
 - lib/agen/version.rb
+- lib/agen/zsh_options.rb
 homepage: https://github.com/JonathanWThom/agen
 licenses:
 - MIT