wip-runner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbc3644fecc21fa0f02ddb63c48f2d1d90b2e239
+  data.tar.gz: 600819ca5fd024e601afe9d6badc02f69627e2f3
+SHA512:
+  metadata.gz: 4fca4438f06d1c8d9cc9c8c6018f65f67aee88c46be720c8a38b17a39fdca3733b68755c1b6f1a3572b3500ae9fab2de82ca49fdddafb0a9a2b46d6b29590c15
+  data.tar.gz: 00f94a5c728be4acf4e5cd29754da119ecac54e715912cc88306039bb70d1b05b376d3e28c82f1b4bf312fed2a7f10dc62f39fd6e9342f917a3ecd8215999076

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+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. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Corey Innis
+
+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,45 @@
+# wip-runner...
+
+- A generic CLI (loads context-based commands)
+- A library for building such commands
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wip-runner'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wip-runner
+
+## Usage as CLI
+
+``` bash
+wip-runner help
+```
+
+## Usage as Library
+
+TODO
+
+## 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. Run `bundle exec wip-runner` to use the gem in this directory, ignoring other installed copies of this gem.
+
+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/[coreyti]/wip-runner. 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](http://opensource.org/licenses/MIT).

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 "wip/runner"
+
+# 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

data/bin/setup

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

data/exe/wip-runner

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "wip/runner"
+WIP::Runner::CLI.new.run(ARGV)

data/lib/wip/runner/cli/help.rb

@@ -0,0 +1,27 @@
+module WIP
+  module Runner
+    class CLI::Help < Command
+      overview 'Prints help messages'
+      argument :command, { overview: 'Command name' }
+
+      def execute(params, config)
+        command_parser(params).help
+      rescue InvalidCommand => e
+        print_error(e)
+      end
+
+      def validate!(args)
+        true
+      end
+
+      private
+
+      def command_parser(params)
+        command    = params.command
+        return CLI::Parser.new(@io) if command.nil?
+
+        Commands.locate(command).new(@io).parser
+      end
+    end
+  end
+end

data/lib/wip/runner/cli/version.rb

@@ -0,0 +1,11 @@
+module WIP
+  module Runner
+    class CLI::Version < Command
+      overview 'Prints version information'
+
+      def execute(params, options)
+        @io.say "#{WIP::Runner::CLI.signature} version #{WIP::Runner::CLI.namespace::VERSION}"
+      end
+    end
+  end
+end

data/lib/wip/runner/cli.rb

@@ -0,0 +1,117 @@
+require 'highline'
+
+module WIP
+  module Runner
+    class CLI
+      class << self
+        def signature=(value)
+          @signature = value
+        end
+
+        def signature
+          @signature || 'wip-runner'
+        end
+
+        def namespace=(value)
+          @namespace = value
+        end
+
+        def namespace
+          @namespace || WIP::Runner
+        end
+      end
+
+      def initialize(io = HighLine.new)
+        @io     = io
+        @parser = Parser.new(io)
+
+        trap('INT')  { quit }
+        trap('TERM') { quit }
+      end
+
+      def quit
+        exit
+      end
+
+      def run(args = [])
+        recipient = (command(args) || @parser)
+        recipient.run(args)
+      rescue InvalidCommand => e
+        @io.say(e.message)
+        @io.newline
+        @parser.help
+      end
+
+      private
+
+      def command(args)
+        handler = Commands.locate(args.shift)
+        handler.nil? ? nil : handler.new(@io)
+      end
+
+      class Parser
+        def initialize(io)
+          @io = io
+        end
+
+        def run(args)
+          return help if args.empty?
+          options.parse!(args)
+        end
+
+        def help
+          @io.say(options.help)
+        end
+
+        private
+
+        def options
+          @options ||= OptionParser.new do |parser|
+            parser.banner = "Usage: #{WIP::Runner::CLI.signature} <command> [options]"
+
+            parser.separator ''
+            parser.separator 'Commands:'
+
+            explicit.each do |command|
+              display(parser, command)
+            end
+            if explicit.length > 0 && implicit.length > 0
+              parser.separator [parser.summary_indent, '---'].join
+            end
+            implicit.each do |command|
+              display(parser, command)
+            end
+
+            parser.separator ''
+            parser.separator 'Options:'
+
+            parser.on_tail '-h', '--help', 'Prints help messages' do
+              @io.say(parser)
+            end
+          end
+        end
+
+        def display(parser, command)
+          signature = command.signature
+          overview  = command.overview
+          padding   = ' ' * (parser.summary_width - signature.length + 1)
+          parser.separator [parser.summary_indent, signature, padding, overview].join
+        end
+
+        # ---
+
+        def namespace
+          WIP::Runner::CLI.namespace
+        end
+
+        def implicit
+          @implicit ||= Commands.within(WIP::Runner::Commands.implicit)
+        end
+
+        def explicit
+          @explicit ||= Commands.within(WIP::Runner::Commands.explicit)
+        end
+      end
+    end
+  end
+end

data/lib/wip/runner/command.rb

@@ -0,0 +1,103 @@
+module WIP
+  module Runner
+    class Command
+      class << self
+        def signature
+          @signature ||= begin
+            ns    = Commands.name
+            parts = self.name
+              .sub(/^.*(CLI|Commands)::/, '')
+              .split('::')
+            parts.map { |part| part.gsub(/([A-Z])/, "-\\1").sub(/^-/, '') }
+              .join(' ')
+              .downcase
+          end
+        end
+
+        def overview(value = nil)
+          @overview = value unless value.nil?
+          @overview
+        end
+
+        def commands
+          @commands ||= Commands.within(self)
+        end
+
+        def argument(name, definition)
+          arguments[name] = Options.new(definition)
+        end
+
+        def arguments(value = nil)
+          @arguments ||= {}
+        end
+
+        # TODO: test multi-options
+        def options(&block)
+          @options ||= []
+          @options << block if block_given?
+          @options
+        end
+
+        def workflow(&block)
+          Workflow.define(&block)
+        end
+      end
+
+      attr_reader :parser # TODO(?)... :arguments, :options
+
+      def initialize(io)
+        @io     = io
+        @parser = WIP::Runner::Parser.new(@io, self.class)
+      end
+
+      def run(argv = [])
+        parser.run(argv) do |command, arguments, options|
+          if command.nil?
+            if options.help
+              parser.help
+              return
+            end
+
+            validate!(arguments)
+            execute(arguments, options)
+          else
+            delegate(command, argv)
+          end
+        end
+      rescue OptionParser::InvalidOption, InvalidArguments, InvalidCommand => e
+        print_error(e)
+      end
+
+      protected
+
+      def execute(arguments, options)
+        raise NotImplementedError
+      end
+
+      def validate!(arguments)
+        unless parser.arguments.empty? || parser.config.no_validate
+          if parser.arguments.keys.any? { |key| arguments[key].nil? }
+            lines = []
+            arguments.each_pair do |key, value|
+              lines << "  - #{key} ... (missing)" if value.nil?
+            end
+            raise InvalidArguments, %Q{\n#{lines.join("\n")}}
+          end
+        end
+      end
+
+      private
+
+      def delegate(command, argv)
+        target = Commands.locate(command, self.class).new(@io)
+        target.run(argv)
+      end
+
+      def print_error(e)
+        @io.say(e.message.capitalize)
+        @io.newline
+        parser.help
+      end
+    end
+  end
+end

data/lib/wip/runner/commands.rb

@@ -0,0 +1,47 @@
+module WIP
+  module Runner
+    module Commands
+      class << self
+        def locate(name, namespace = nil)
+          return nil if name.nil? || name.match(/^-/)
+
+          command    = name.split('-').map(&:capitalize).join
+          namespaces = namespace ? [namespace] : [explicit, implicit]
+          namespaces.each do |ns|
+            return ns.const_get(command) if ns && ns.const_defined?(command)
+          end
+          raise InvalidCommand, name
+        end
+
+        def within(namespace)
+          return [] if namespace.nil?
+
+          namespace.constants
+            .collect { |const|
+              namespace.const_get(const)
+            }
+            .select { |command|
+              command < Command # is a subclass of
+            }
+        end
+
+        def implicit
+          WIP::Runner::CLI
+        end
+
+        def explicit
+          @explicit ||= begin
+            namespace.const_get(:Commands) if namespace.const_defined?(:Commands)
+          end
+        end
+
+        def namespace
+          WIP::Runner::CLI.namespace
+        end
+      end
+    end
+  end
+end
+
+# NOTE: Commands are responsible for requiring sub-commands.
+Dir[File.expand_path('../commands/*.rb', __FILE__)].each { |f| require(f) }

data/lib/wip/runner/errors.rb

@@ -0,0 +1,24 @@
+module WIP
+  # TODO: consider...
+  #
+  # - OptionParser::ParseError:: errors on parsing
+  #   - OptionParser::AmbiguousArgument
+  #   - OptionParser::InvalidArgument
+  #   - OptionParser::MissingArgument
+  #   - OptionParser::NeedlessArgument
+  #   - OptionParser::AmbiguousOption
+  #   - OptionParser::InvalidOption
+   module Runner
+    class Error < StandardError
+      def message
+        prefix = self.class.name.split('::').last
+          .gsub(/([A-Z])/, " \\1")
+          .strip
+          .capitalize
+        "#{prefix}: #{super}".sub(/\s\n/, "\n")
+      end
+    end
+    class InvalidArguments < Error; end
+    class InvalidCommand   < Error; end
+  end
+end

data/lib/wip/runner/options.rb

@@ -0,0 +1,7 @@
+require 'ostruct'
+
+module WIP
+  module Runner
+    class Options < OpenStruct ; end
+  end
+end

data/lib/wip/runner/parser.rb

@@ -0,0 +1,93 @@
+module WIP
+  module Runner
+    class Parser
+      attr_reader :config
+
+      def initialize(io, command)
+        @io      = io
+        @command = command
+        @config  = WIP::Runner::Options.new
+      end
+
+      def run(argv)
+        unless commands.empty?
+          command = argv.shift
+          raise InvalidCommand, '(missing)' if command.nil?
+          yield(command, nil, nil)
+        else
+          remaining = options.parse!(argv)
+
+          @args = WIP::Runner::Options.new.tap do |opts|
+            arguments.keys.each_with_index do |key, index|
+              opts[key] = remaining[index]
+            end
+          end
+
+          yield(nil, @args, @config)
+        end
+      end
+
+      def help
+        @io.say(options.help)
+      end
+
+      def options
+        @options ||= OptionParser.new do |parser|
+          @config.help        = false
+          @config.no_validate = false
+
+          parser.banner = "Usage: #{WIP::Runner::CLI.signature} #{heading}"
+
+          section(parser, 'Commands:', commands)
+          section(parser, 'Arguments:', arguments)
+
+          parser.separator ''
+          parser.separator 'Options:'
+
+          @command.options.each do |block|
+            block.call(parser, @config)
+          end
+
+          parser.on_tail '-h', '--help', 'Prints help messages' do
+            @config.help = true
+          end
+        end
+      end
+
+      def arguments
+        @command.arguments
+      end
+
+      private
+
+      def commands
+        {}.tap do |result|
+          @command.commands.each do |command|
+            result[command.signature.split(' ').last.intern] = { overview: command.overview }
+          end
+        end
+      end
+
+      def heading
+        sections = [].tap do |result|
+          result << '<command>'   unless commands.empty?
+          result << '<arguments>' unless commands.empty? && arguments.empty?
+        end
+
+        [@command.signature, sections, '[options]'].flatten.join(' ')
+      end
+
+      def section(parser, heading, pairs)
+        unless pairs.empty?
+          parser.separator ''
+          parser.separator heading
+
+          pairs.each do |name, details|
+            padding = ' ' * (parser.summary_width - name.length + 1)
+            parser.separator [parser.summary_indent, name, padding, details[:overview]].join('')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wip/runner/shell/handlers/base.rb

@@ -0,0 +1,46 @@
+require 'open3'
+
+module WIP
+  module Runner
+    module Shell
+      module Handlers
+        class Base
+          def initialize(content, &block)
+            @content = clean(content)
+            instance_exec(&block) if block_given?
+          end
+
+          def description
+            raise NotImplementedError
+          end
+
+          def execute(io, env, &block)
+            raise NotImplementedError
+          end
+
+          def type
+            @type ||= self.class.name.split('::').last
+          end
+
+          protected
+
+          def executable
+            @executable ||= begin
+              content = @content.gsub(/"/, '\"').gsub(/\$/, "\\$")
+              %Q{bash -c "#{content}"}
+            end
+          end
+
+          private
+
+          def clean(string)
+            return if string.nil?
+
+            indent = (string.scan(/^[ \t]*(?=\S)/).min || '').size
+            string.gsub(/^[ \t]{#{indent}}/, '').strip
+          end
+        end
+      end
+    end
+  end
+end