agen 0.1.6 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f90fceac9fed45a59113e45eb28e8eef96f7552b487d4ccc90f037765bdd96d3
-  data.tar.gz: 60e5528277c8cd195d43e67bf4653d70ddddb9cd93d1109c623e4d5ded9c546f
+  metadata.gz: 3fff6346fa930fe70a1f586b9bb6d0441f3cce432e799f11722eb61da51fc6a4
+  data.tar.gz: ccb5265d8550cfb15d152d8a1044aefee4596199571e218c6b9fa12117e3d8de
 SHA512:
-  metadata.gz: 138b4c4c646a0b62b1665c057fa5dd659c13643fe751c2909c281c9f5446ca23ab2c67a8c51dc967ba38fb43ef1b8f4017e7d019337cbe378f27bd2f89b7119b
-  data.tar.gz: 43ad014f35c326d08f2c242680eaccd36e55a4bb14c316ab5cf8c6136fa82ed4956c15d3ab88d18670a2403e46f7f57aee103bb9c60ad111e83645e6d253a281
+  metadata.gz: 607ad6a1cc1c7dd89bead3464dd0b0fa047c9eace831aaa26c0d4bc779b14973a26e45690636486885de4cdbdfc707a546ec7019a8ef927a3fa5860d8cf65fe7
+  data.tar.gz: 9c4bf033685b91a936892f3a761943b0584903e8306d545d7fd0ce3ad72d060255e2bd76c4de675456fbb30e0274431a7e0905d7fc7177cd7a8e70dd89321ba1

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,19 @@
 ## [Released]
 
+## [0.3.1] - 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.
 

data/Gemfile.lock

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

data/README.md

@@ -4,13 +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. Use
-`agen -h` to see available options.
+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]
+    -v, --version                    Version
+    -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
+    -s, --shell-history=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. By default, agen reads from `.zsh_history` and
+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
@@ -25,18 +37,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Jonath
 
 ## 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 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

@@ -14,11 +14,31 @@ module Agen
       OptionParser.new do |opts|
         opts.banner = "Usage: agen [options]"
 
+        opts.on("-v", "--version", String, "Version") do |v|
+          puts Agen::VERSION
+          return false
+        end
+
         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("-sHISTFILE", "--shell-history=HISTFILE", String, "Path to shell history file") do |s|
+          options[:histfile] = s
+        end
       end.parse!
 
+      options = Shell.new(options).add_options
+      return unless options
+
       Runner.new(**options).run
     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,29 +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, number: DEFAULT_NUMBER)
+    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(limit: @number)
-      aliases = Builder.new(commands, rcfile).aliases
+      @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.6"
+  VERSION = "0.3.1"
 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.6
+  version: 0.3.1
 platform: ruby
 authors:
 - Jonathan Thom
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-26 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