win_alias 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d18367849840c3235aa2650542dacc28a6ef85670b5dcb26fff8a963c4560e7
+  data.tar.gz: cb53fe0224aa1b726f1feea84379096610f64277df90b0235e721f141b14b8cd
+SHA512:
+  metadata.gz: 44f1711bb42d603cee89d42caeca0acfb1e64f2526af8653a41a955f5da438e4e3ae9f4df4b36dfb8bc8a9ad96229c4a6a1a7b6cd3b12b952e921645086141a5
+  data.tar.gz: a28e2e50cc92fb775db45bf269b8f07e70a31d6a145d43604d6862c57440fc80e3dbcb85b00ae468849e4840f17f54aea55c144c902283845afa870b53029b84

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at bblack@digitalglobe.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in win_alias.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 bj002440
+
+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,89 @@
+# WinAlias
+
+WinAlias provides a simple CLI tool to add aliases to your windows environment just like Unix using your PATH environment and batch scripts. This is in very early development and is not intended to do anything more advanced than what is advertised. It is purely for convenience.
+
+## Installation
+
+  $ gem install win_alias
+
+## Usage
+
+In order to use WinAlias, be sure to add the following path to your system or user path:
+
+- `C:\Users\<UserName>\win-alias\bin`
+
+Once the path is in your system you can add aliases and use them anywhere in cmd or any other Windows shell.
+
+IMPORTANT NOTE: If you do not add the bin directory to your PATH youself, win-alias will attempt to add it the first time it runs. This may cause issues with PATHS over 1024 characters on older Windows versions. Be sure to check your PATH if you rely on the automatic adding of the bin path. Just in case, your original PATH variable will be backed up into `C:\Users\<UserName>\win-alias\path_backup.txt`
+
+### Add alias
+
+You can add aliases using any of the examples shown below. If your command includes flags, use the `-c` or `--cmd` argument followed by your command in quotes to avoid collisions with the flags win-alias expects.
+
+```
+# Alias dir to ls
+win-alias ls dir
+
+# Now run ls
+ls
+
+# Alias ll to "ls -l"
+# Notice how --cmd is used to avoid win-alias treating -l as a flag to itself
+win-alias ll --cmd "ls -l"
+
+# Now run ll
+ll
+```
+
+### Edit alias
+
+You can also have win-alias open the generated script up into your systems text editor after it is created. This allows you to more easily generate much larger aliased scripts without having to rely entirely on passing the script in via the command line. To do this just add the __-e__ flag to the win-alias command.
+
+Additionally it is possible to edit existing aliases easily via the CLI. To do this, use the following command: `win-alias <alias-name> -e`
+NOTE: If you pass additional arguments the alias will be overwritten before being edited, so if you wish to edit only, please use -e only.
+
+```
+# Create an alias called ll and open it in a text editor after it is created
+win-alias ll "ls -lh" -e
+
+# Open an existing alias called ll for editing.
+# win-alias ll -e
+```
+
+### Delete alias
+
+```
+win-alias ll -d
+```
+
+### List aliases
+
+```
+win-alias -l
+```
+
+### Help
+
+Run the win-alias command with no arguments to display the help menu
+
+```
+win-alias
+```
+
+## 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 tags, 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]/win_alias. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the WinAlias project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/win_alias/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "win_alias"
+
+# 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/bin/win-alias

@@ -0,0 +1,3 @@
+#!/usr/bin/ruby
+
+require 'win_alias/cli'

data/lib/win_alias.rb

@@ -0,0 +1,3 @@
+require_relative 'win_alias/version'
+require_relative 'win_alias/util'
+require_relative 'win_alias/alias'

data/lib/win_alias/alias.rb

@@ -0,0 +1,34 @@
+module WinAlias
+  class Alias
+    include BBLib::Effortless
+
+    attr_str :name, required: true, arg_at: 0
+    attr_str :command, required: true, arg_at: 1
+    attr_bool :temp, default: false
+    attr_bool :echo_off, default: true
+
+    def self.delete!(name)
+      path = File.join(WinAlias.path, "#{name}.bat")
+      return true unless File.exist?(path)
+      FileUtils.rm(path)
+      !File.exist?(path)
+    end
+
+    def self.list
+      BBLib.scan_dir(WinAlias.path, '*.bat').map { |f| f.file_name(false) }.sort
+    end
+
+    def path
+      File.join(WinAlias.path, "#{name}.bat")
+    end
+
+    def build_command
+      (echo_off? ? "@ECHO OFF\n" : '') + command
+    end
+
+    def save
+      build_command.to_file(path, mode: 'w')
+    end
+
+  end
+end

data/lib/win_alias/cli.rb

@@ -0,0 +1,62 @@
+require 'bblib'
+require 'bblib/cli'
+
+require_relative '../win_alias'
+
+BBLib.color_logs = true
+BBLib.logger.level = :debug if ARGV.include?('-v') || ARGV.include?('--verbose')
+BBLib.logger.level = :fatal if ARGV.include?('-q') || ARGV.include?('--quiet')
+
+BBLib.logger.formatter = proc do |severity, datetime, progname, msg|
+  msg = msg.to_s.to_color(severity) if BBLib.color_logs && severity.to_s.downcase != 'info'
+  if msg.is_a?(Exception)
+    msg = msg.inspect + "\n\t" + msg.backtrace.join("\n\t")
+  end
+  "#{msg.to_s.chomp}\n"
+end
+
+module WinAlias
+  parser = BBLib::OptsParser.new do |pars|
+    pars.usage "Usage: win-alias <alias> [command...] [options...]\n\n\tCreate an alias: win-alias <alias> [command...]\n\tEdit an alias:   win-alias <alias> -e\n\tDelete an alias: win-alias <alias> -d\n"
+    pars.string('-c', '--cmd', '--command', desc: 'The command to alias. If not provided, all unrecognized arguments are treated as the command.')
+    pars.toggle('-d', '--delete', desc: 'Deletes the provided alias instead of creating one')
+    pars.toggle('-l', '--list', desc: 'List all known aliases')
+    pars.toggle('-y', '--yes-to-all', desc: 'Yes to any prompts. This is mostly useful to avoid the overwrite prompt if an alias already exists.')
+    pars.command(position: 0, name: :alias)
+    pars.toggle('-e', '--edit', desc: 'Open up the alias script in your text editor after it is created.')
+    pars.untoggle('--echo', desc: 'Do not disable echo in the aliased command. By default it is enabled.')
+  end
+
+  opts = parser.parse
+  add_to_path
+
+  if opts[:delete]
+    if Alias.delete!(opts.alias)
+      info "All aliases matching #{opts.alias} have been removed."
+    else
+      warn "Failed to delete #{opts.alias}. Could be a permissions issue."
+    end
+  elsif opts.list? || opts.alias == '-l' || opts.alias == '--list'
+    puts "\t- " + Alias.list.join("\n\t- ")
+  elsif opts.alias.nil? || opts.alias == '-h' || opts.alias == '--help'
+    puts parser.help
+  elsif opts.edit? && (opts.cmd.nil? || opts.cmd.empty?) && opts.arguments.empty?
+    BBLib::Console.edit_file(Alias.new(opts.alias, opts.cmd).path)
+  else
+
+    if Alias.list.include?(opts.alias) && !opts.yes_to_all?
+      exit(2) unless BBLib::Console.confirm?("There is already an alias named #{opts.alias}. Do you want to overwrite it?")
+    end
+
+    if opts.cmd && opts.cmd.empty? || opts.cmd.nil?
+      opts.cmd = opts.arguments.size == 1 ? opts.arguments.first : opts.arguments.map do |arg|
+        arg.include?(' ') ? "\"#{arg.gsub('"', '\\"')}\"" : arg
+      end.join(' ')
+    end
+    als = Alias.new(opts.alias, opts.cmd, echo_off: opts.echo)
+    if als.save
+      BBLib::Console.edit_file(als.path) if opts.edit?
+      puts BBLib::Console.colorize("Created alias for #{opts.alias}", :light_green)
+    end
+  end
+end

data/lib/win_alias/util.rb

@@ -0,0 +1,36 @@
+module WinAlias
+  [:debug, :info, :warn, :error, :fatal].each do |severity|
+    define_singleton_method(severity) do |message|
+      BBLib.logger.send(severity, message)
+    end
+  end
+
+  def self.base_path
+    ENV['WIN_ALIAS_HOME'] || File.join(Dir.home, 'win_alias')
+  end
+
+  def self.path
+    File.join(base_path, 'bin')
+  end
+
+  def self.in_path?
+    ENV['PATH'].include?(path)
+  end
+
+  def self.add_to_path
+    return true if in_path?
+    warn("About to add win-alias/bin to PATH. A backup of your paths will be saved @ #{File.join(base_path, 'path_backup.txt')} in case something goes wrong.")
+    error("NOTE: It is recommdned you verify your PATH in another shell after this is run. Some versions of Windows can cause the PATH to be truncated at 1024 characters.")
+    backup_path_variable
+    ENV['PATH'] = ENV['PATH'] + ";#{path}"
+    `setx /M PATH "#{ENV['PATH']}"`
+    in_path?
+  end
+
+  def self.backup_path_variable
+    backup = File.join(base_path, 'path_backup.txt')
+    lines = File.exist?(backup) ? File.read(backup).split("\n") : []
+    lines += ENV['PATH'].split(';')
+    lines.uniq.join("\n").to_file(backup, mode: 'w')
+  end
+end

data/lib/win_alias/version.rb

@@ -0,0 +1,3 @@
+module WinAlias
+  VERSION = '0.1.1'.freeze
+end

data/win_alias.gemspec

@@ -0,0 +1,38 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "win_alias/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "win_alias"
+  spec.version       = WinAlias::VERSION
+  spec.authors       = ["bblack16"]
+  spec.email         = ["d2sm10@hotmail.com"]
+
+  spec.summary       = %q{CLI to easily create aliases in a Windows environment.}
+  spec.description   = %q{Manage simple bat scripts to easily generate aliases in Windows.}
+  spec.homepage      = "https://github.com/bblack16/win-alias"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = ['win-alias']
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency 'bblib', '~> 2.0', '>= 2.0.3'
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: win_alias
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- bblack16
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bblib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+description: Manage simple bat scripts to easily generate aliases in Windows.
+email:
+- d2sm10@hotmail.com
+executables:
+- win-alias
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/win-alias
+- lib/win_alias.rb
+- lib/win_alias/alias.rb
+- lib/win_alias/cli.rb
+- lib/win_alias/util.rb
+- lib/win_alias/version.rb
+- win_alias.gemspec
+homepage: https://github.com/bblack16/win-alias
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: CLI to easily create aliases in a Windows environment.
+test_files: []