mpx 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 39087fb1774c7fd9ec0f3ca2d33d703d851820c9b832dd5602c46b80112a7487
+  data.tar.gz: 8d7186b216e9946eb648bfae8ea4cf167a44559b5d5bdca1c227487cf654070a
+SHA512:
+  metadata.gz: aff6db3225fe63108dd54ee6ff913ae604bf0b9a6efe60311077c9041a5b333f8d82411111151aa807a953568dbb53f4bd7c81c904f7c74f58f49621982d7c10
+  data.tar.gz: ddf9a1cde5a057010bb2610dd0ddfadf240650ca700f742bbbdc506334c92e33d0decd891a54951ffedf192cc52e5db6f26dcd4b79fe6461e770ed8356abf4c0

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in mpx.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    mpx (0.1.0)
+      ansi (~> 1.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    builder (3.2.3)
+    minitest (5.11.3)
+    minitest-reporters (1.3.6)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    rake (10.5.0)
+    ruby-progressbar (1.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  minitest-reporters (~> 1.3)
+  mpx!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Ethan Chan
+
+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,80 @@
+# mpx
+
+```
+A command multiplexer.
+
+The root folder MPX_ROOT is an environment variable
+which defaults to `~/.local/mpx`.
+
+The following subfolders are used:
+- `bin`     Where commands are stored.
+- `spaces`  Namespaces for each command.
+            Each command receives a subfolder with its name in `spaces`.
+            The working directory will be changed to this subfolder before
+            command execution.
+- `sets`    Aliases to sets of commands. Each file is a set,
+            containing newline-delimited commands to run.
+- `history` Newline-delimited history of each command/alias, with timestamp.
+
+The first argument is a mandatory operation, and should be one of:
+
+`help`
+
+  Prints this help text.
+
+`version`
+
+  Prints the version.
+
+`history`
+
+  Taking each subsequent argument as a command or set, the history of each
+  will be displayed in chronological order.
+
+  If no arguments are provided, the history of all commands and sets
+  will be displayed.
+
+A directive in the form of `<COMMAND/SET>:<SUBCOMMAND>` or `:<SUBCOMMAND>`
+
+  In the first form, `<COMMAND/SET>` will be taken as the command or set
+  to run with. If names clash, commands will take precedence over sets.
+  For a given set, the program will run all commands in the set file.
+
+  In the second form, the program will run with all commands.
+
+  In both forms, `<SUBCOMMAND>` will be passed as the first argument
+  to each command. All arguments after the directive will be passed directly.
+
+  If multiple commands run, they shall run in parallel,
+  and outputs will be displayed upon completion.
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mpx'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mpx
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests.
+
+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/metakirby5/mpx.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

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/mpx

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+
+require "mpx"

data/lib/mpx/cli.rb

@@ -0,0 +1,132 @@
+require 'mpx/request'
+require 'mpx/loader'
+
+module Mpx
+
+  Help = <<-EOF
+A command multiplexer.
+
+The root folder MPX_ROOT is an environment variable
+which defaults to `~/.local/mpx`.
+
+The following subfolders are used:
+- `bin`     Where commands are stored.
+- `spaces`  Namespaces for each command.
+            Each command receives a subfolder with its name in `spaces`.
+            The working directory will be changed to this subfolder before
+            command execution.
+- `sets`    Aliases to sets of commands. Each file is a set,
+            containing newline-delimited commands to run.
+- `history` Newline-delimited history of each command/alias, with timestamp.
+
+The first argument is a mandatory operation, and should be one of:
+
+`help`
+
+  Prints this help text.
+
+`version`
+
+  Prints the version.
+
+`history`
+
+  Taking each subsequent argument as a command or set, the history of each
+  will be displayed in chronological order.
+
+  If no arguments are provided, the history of all commands and sets
+  will be displayed.
+
+A directive in the form of `<COMMAND/SET>:<SUBCOMMAND>` or `:<SUBCOMMAND>`
+
+  In the first form, `<COMMAND/SET>` will be taken as the command or set
+  to run with. If names clash, commands will take precedence over sets.
+  For a given set, the program will run all commands in the set file.
+
+  In the second form, the program will run with all commands.
+
+  In both forms, `<SUBCOMMAND>` will be passed as the first argument
+  to each command. All arguments after the directive will be passed directly.
+
+  If multiple commands run, they shall run in parallel,
+  and outputs will be displayed upon completion.
+EOF
+
+  ##
+  # Command line interface.
+  class Cli
+    Usage = "Usage: #{File.basename($0)} [operation] [args...]"
+    MpxRoot = 'MPX_ROOT'
+    DefaultRoot = File.join('.local', 'mpx')
+
+    def self.start
+      op, *args = ARGV
+      case op
+      when 'help'
+        self.help
+      when 'version'
+        self.version
+      when 'history'
+        self.history(args)
+      when nil
+        self.help
+        exit 1
+      else
+        self.run(op, *args)
+      end
+    rescue => e
+      puts "Error: #{e}."
+      puts Usage
+      exit 1
+    end
+
+    def self.help
+      puts Help
+      puts
+      puts Usage
+    end
+
+    def self.version
+      puts Mpx::VERSION
+    end
+
+    def self.history(args)
+      history = Loader.new(self.root).history
+      puts history.get(*args)
+    end
+
+    def self.run(args)
+      request = Request.new(args)
+      loader = Loader.new(self.root)
+      commands = loader.load(request.name).sort
+      history = loader.history
+
+      threads = commands.map do |command|
+        Thread.new do
+          result = command.run(request.args)
+          history.write(command.name, *request.args)
+          result
+        end
+      end
+
+      threads.each do |t|
+        puts t.value
+        puts
+      end
+    end
+
+    def self.root
+      root = ENV[MpxRoot]
+      if root
+        return root
+      end
+
+      home = ENV['HOME']
+      if !home
+        raise "#{MpxRoot} and $HOME are both not set"
+      end
+
+      return File.join(home, DefaultRoot)
+    end
+  end
+end

data/lib/mpx/command.rb

@@ -0,0 +1,28 @@
+require 'open3'
+require 'fileutils'
+
+require 'mpx/result'
+
+module Mpx
+  ##
+  # Represents a command to be run.
+  class Command
+    def initialize(bin, working_directory)
+      @bin = bin
+      @working_directory = working_directory
+    end
+
+    def <=>(other)
+      return self.name <=> other.name
+    end
+
+    def name
+      return File.basename(@bin)
+    end
+
+    def run(args)
+      opened = Open3.capture2e(@bin, *args, :chdir => @working_directory)
+      return Result.new(name, *opened)
+    end
+  end
+end

data/lib/mpx/history.rb

@@ -0,0 +1,45 @@
+require 'date'
+
+module Mpx
+  ##
+  # Manages history for commands.
+  class History
+    def initialize(root)
+      @root = root
+
+      FileUtils.mkdir_p(@root)
+    end
+
+    def now
+      return DateTime.now.strftime("%d/%m/%Y %H:%M")
+    end
+
+    def all_history
+      return Dir.entries(@root)
+        .select { |f| File.file?(File.join(@root, f)) }
+    end
+
+    def get(*commands)
+      return (commands.empty? ? all_history : commands)
+        .map { |c| history_for(c) }
+        .flatten
+        .sort_by do |line|
+          time, * = line.split('$')
+          DateTime.parse(time.strip)
+        end
+    end
+
+    def history_for(command)
+      File.foreach(File.join(@root, command))
+        .map { |line| line.strip }
+    rescue
+      raise "no history for #{command}"
+    end
+
+    def write(command, *args)
+      File.open(File.join(@root, command), 'a') do |f|
+        f.puts("#{now} $ #{command} #{args.join(' ')}")
+      end
+    end
+  end
+end

data/lib/mpx/loader.rb

@@ -0,0 +1,63 @@
+require 'mpx/command'
+require 'mpx/history'
+
+module Mpx
+  ##
+  # Responsible for path manipulation.
+  class Loader
+    BinFolder = 'bin'
+    SpacesFolder = 'spaces'
+    SetsFolder = 'sets'
+    HistoryFolder = 'history'
+
+    def initialize(root)
+      @bin = File.join(root, BinFolder)
+      @spaces = File.join(root, SpacesFolder)
+      @sets = File.join(root, SetsFolder)
+      @history = History.new(File.join(root, HistoryFolder))
+    end
+
+    def load(name)
+      if name.nil?
+        return load_all
+      end
+
+      return [load_command(name)]
+    rescue
+      return load_set(name)
+    end
+
+    def load_all
+      return Dir.entries(@bin)
+        .select { |f| File.file?(File.join(@bin, f)) }
+        .map { |file| load_command(file) }
+    end
+
+    def load_command(command)
+      bin_path = File.join(@bin, command)
+      if !File.exist?(bin_path)
+        raise "no command found with name `#{command}`"
+      end
+
+      space_path = File.join(@spaces, command)
+      FileUtils.mkdir_p(space_path)
+
+      return Command.new(bin_path, space_path)
+    end
+
+    def load_set(set)
+      set_path = File.join(@sets, set)
+      if !File.exist?(set_path)
+        raise "no command or set found with name `#{set}`"
+      end
+
+      return File.foreach(set_path)
+        .uniq
+        .map { |line| load_command(line.strip) }
+    end
+
+    def history
+      @history
+    end
+  end
+end

data/lib/mpx/request.rb

@@ -0,0 +1,28 @@
+module Mpx
+  ##
+  # Extracts `<SUBCOMMAND/ALIAS>:<ARG> <ARGS>`.
+  class Request
+    def initialize(args)
+      directive, *rest = args
+      if !directive&.include? ':'
+        raise 'missing directive'
+      end
+
+      cmd, first_arg = directive.split ':', 2
+      if first_arg.empty?
+        raise 'missing first arg'
+      end
+
+      @name = cmd.empty? ? nil : cmd
+      @args = [first_arg, *rest]
+    end
+
+    def name
+      return @name
+    end
+
+    def args
+      return @args
+    end
+  end
+end

data/lib/mpx/result.rb

@@ -0,0 +1,24 @@
+require 'ansi/code'
+
+module Mpx
+  ##
+  # Represents the output of a command.
+  class Result
+    include ANSI::Code
+
+    def initialize(name, out, status)
+      @name = name
+      @out = out
+      @status = status
+    end
+
+    def to_s
+      return [cyan { @name }, @out.strip, status_string].join("\n")
+    end
+
+    def status_string
+      color = @status.exitstatus.zero? ? :green : :red
+      return send(color) { @status }
+    end
+  end
+end

data/lib/mpx/version.rb

@@ -0,0 +1,3 @@
+module Mpx
+  VERSION = "0.1.0"
+end

data/lib/mpx.rb

@@ -0,0 +1,3 @@
+require "mpx/cli"
+
+Mpx::Cli.start

data/mpx.gemspec

@@ -0,0 +1,39 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mpx/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mpx"
+  spec.version       = Mpx::VERSION
+  spec.authors       = ["Ethan Chan"]
+  spec.email         = ["metakirby5@gmail.com"]
+
+  spec.summary       = %q{A command multiplexer.}
+  spec.homepage      = "https://github.com/metakirby5/mpx"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "ansi", "~> 1.5"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "minitest-reporters", "~> 1.3"
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: mpx
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ethan Chan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+description: 
+email:
+- metakirby5@gmail.com
+executables:
+- mpx
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- exe/mpx
+- lib/mpx.rb
+- lib/mpx/cli.rb
+- lib/mpx/command.rb
+- lib/mpx/history.rb
+- lib/mpx/loader.rb
+- lib/mpx/request.rb
+- lib/mpx/result.rb
+- lib/mpx/version.rb
+- mpx.gemspec
+homepage: https://github.com/metakirby5/mpx
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/metakirby5/mpx
+  source_code_uri: https://github.com/metakirby5/mpx
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: A command multiplexer.
+test_files: []