agen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: acebf067e22c29311b6a91e2b24e5e8c3f822e24ec8d0a3b5221721e8c147b6a
+  data.tar.gz: 55129b76da51036069bfbc0890af80ef6b0d2ff57479666cd92d833327e81263
+SHA512:
+  metadata.gz: 385c8d66a02051d68bce4de28b3c81c8fb106c509e2f2bfa14825dd4440b21399f3060ddee26a78ba6e5e3638a34429d1c992cb04d12939b9bad935ef00373d0
+  data.tar.gz: 433e67ddc92ac47d02c9618a1741bde74e3c8bd0f8621f1f4488270ea6d30a69f2664fd40c14eb97f70ae2f578e97c9180a969c66a5bae869d3b1fdf9c59df15

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+        bundler-cache: true
+    - name: Run the default task
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.tool-versions

@@ -0,0 +1 @@
+Ruby 3.0.1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-04-24
+
+- Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in agen.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,62 @@
+PATH
+  remote: .
+  specs:
+    agen (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.20.1)
+    parser (3.0.1.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.12.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-performance (1.10.1)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.0.5)
+      rubocop (= 1.12.1)
+      rubocop-performance (= 1.10.1)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  agen!
+  rake
+  rspec
+  standard
+
+BUNDLED WITH
+   2.2.16

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jonathan Thom
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,61 @@
+# Agen
+
+Generate shell aliases based on commonly entered commands.
+
+## 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:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install agen
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/agen.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "standard/rake"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
+
+task default: :spec

data/agen.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "lib/agen/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "agen"
+  spec.version = Agen::VERSION
+  spec.authors = ["Jonathan Thom"]
+  spec.email = ["jonathanthom@hey.com"]
+
+  spec.summary = "Generate shell aliases based on commonly entered commands."
+  spec.homepage = "https://github.com/JonathanWThom/agen"
+  spec.license = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/JonathanWThom/agen/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "standard"
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "agen"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/agen

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

data/lib/agen.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative "agen/version"
+require_relative "agen/cli"
+require_relative "agen/builder"
+require_relative "agen/finder"
+require_relative "agen/runner"
+
+module Agen
+  class Error < StandardError; end
+end

data/lib/agen/builder.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Agen
+  class Builder
+    def initialize(commands)
+      @commands = commands
+    end
+
+    def aliases
+      @commands.map do |cmd|
+        aliaz = cmd.scan(/\b\w/).join
+        "alias #{aliaz}=\"#{cmd}\""
+      end
+    end
+  end
+end

data/lib/agen/cli.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Agen
+  class CLI
+    def initialize(args = [])
+      @args = args
+    end
+
+    def run
+      # TODO: Parse args/options
+      Runner.new.run
+    end
+  end
+end

data/lib/agen/finder.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Agen
+  class Finder
+    def initialize(histfile)
+      @histfile = histfile
+    end
+
+    def commands(limit = 5)
+      File.readlines(@histfile).reverse.each_with_object(Hash.new(0)) do |line, commands|
+        commands[line.split(";").last.delete("\n")] += 1
+      end.sort_by { |k, v| -v }.to_h.keys.first(limit)
+    end
+  end
+end

data/lib/agen/runner.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Agen
+  class Runner
+    DEFAULT_HISTFILE = "#{Dir.home}/.zsh_history"
+    DEFAULT_RCFILE = "#{Dir.home}/.zshrc"
+
+    attr_reader :histfile, :rcfile
+
+    def initialize(histfile: DEFAULT_HISTFILE, rcfile: DEFAULT_RCFILE)
+      @histfile = histfile
+      @rcfile = rcfile
+    end
+
+    def run
+      commands = Finder.new(histfile).commands
+      aliases = Builder.new(commands).aliases
+
+      File.open(rcfile, "a") do |file|
+        aliases.each do |al|
+          file.puts(al)
+        end
+      end
+    end
+  end
+end

data/lib/agen/version.rb

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

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: agen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Thom
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- jonathanthom@hey.com
+executables:
+- agen
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".tool-versions"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- agen.gemspec
+- bin/console
+- bin/setup
+- exe/agen
+- lib/agen.rb
+- lib/agen/builder.rb
+- lib/agen/cli.rb
+- lib/agen/finder.rb
+- lib/agen/runner.rb
+- lib/agen/version.rb
+homepage: https://github.com/JonathanWThom/agen
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/JonathanWThom/agen
+  source_code_uri: https://github.com/JonathanWThom/agen
+  changelog_uri: https://github.com/JonathanWThom/agen/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Generate shell aliases based on commonly entered commands.
+test_files: []