mcli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8525a628284d643fb3483ac0ecd460520968aa74
+  data.tar.gz: 6fb3670630b6ba42e2a8c39d2b16c89677fea286
+SHA512:
+  metadata.gz: 33d8b44f87b79c4a05f5e1e2315ecb006980d4e70391bd8149b6bd57aecf207b057283cd4c6524718f94a289b150b901d4498e869aed2b1ab6c46cade7b8d87e
+  data.tar.gz: c1dd2a0e0062c087e8303c38ee39887a59a185572437e94d33b4e6660d9322c281511956542c65e7afe0cef59c9bfdceaa8f924e2ff1e7860851d484a40dcc06

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mcli.gemspec
+gemspec
+
+gem 'pry'
+gem 'aruba'
+gem 'simplecov',
+  git: 'git@github.com:thomas07vt/simplecov.git',
+  branch: 'issues/624/refuse_coverage_drop_on_failed_test'
+gem 'codecov', :require => false, :group => :test
+

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 John Thomas
+
+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,207 @@
+# MCLI
+[![codecov](https://codecov.io/gh/thomas07vt/mcli/branch/master/graph/badge.svg)](https://codecov.io/gh/thomas07vt/mcli)
+
+Creating command line tools is a :cake: . This gem is basically a wrapper around the ruby ```OptionParser``` class. It turns your ruby objects into parsers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mcli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mcli
+
+## Usage
+
+1. Require MCLI
+
+```ruby
+require 'mcli'
+```
+
+2. Create a ```MCLI::Command``` subclass
+
+```ruby
+class MyCommand < MCLI::Command
+end
+```
+
+3. Call the Command Runner
+
+```ruby
+MCLI.run
+```
+
+### Examples
+
+#### Arguments
+
+```ruby
+#args.rb
+```
+```ruby
+#!/usr/bin/env ruby
+require 'mcli'
+
+class Args < MCLI::Command
+  register_as :args
+
+  def run
+    puts "The passed args are: #{args.inspect}"
+  end
+end
+
+MCLI.run
+```
+
+```bash
+$ ./args.rb args first second
+The passed args are: ["first", "second"]
+```
+
+##### Options with aliases
+
+```ruby
+#options.rb
+```
+```ruby
+#!/usr/bin/env ruby
+require 'mcli'
+
+class Options < MCLI::Command
+  register_as :options
+  option :say, alias: :s
+
+  def run
+    puts "Saying: #{options[:say]}"
+  end
+end
+
+MCLI.run
+```
+
+```bash
+$ ./options.rb options --say 'hello'
+Saying: hello
+$ ./options.rb options -s 'hello'
+Saying: hello
+```
+
+##### Options with defaults
+
+```ruby
+#options.rb
+```
+```ruby
+#!/usr/bin/env ruby
+require 'mcli'
+
+class Options < MCLI::Command
+  register_as :options
+  option :say, alias: :s, default: 'hello'
+
+  def run
+    puts "Saying: #{options[:say]}"
+  end
+end
+
+MCLI.run
+```
+
+```bash
+$ ./options.rb options --say hi
+Saying: hi
+$ ./options.rb options -s hi
+Saying: hi
+$ ./options.rb options
+Saying: hello
+```
+
+##### Required Options
+
+```ruby
+#options.rb
+```
+```ruby
+#!/usr/bin/env ruby
+require 'mcli'
+
+class Options < MCLI::Command
+  register_as :options
+  option :say, alias: :s, required: true
+
+  def run
+    puts "Saying: #{options[:say]}"
+  end
+end
+
+MCLI.run
+```
+
+```bash
+$ ./options.rb options --say hi
+Saying: hi
+$ ./options.rb options -s hi
+Saying: hi
+$ ./options.rb options
+mcli/lib/mcli/command.rb:25:in `block in parse': missing argument:  (OptionParser::MissingArgument)
+  mcli/lib/mcli/command.rb:23:in `map'
+  mcli/lib/mcli/command.rb:23:in `parse'
+  mcli/lib/mcli/command.rb:62:in `block in call'
+  mcli/lib/mcli/command.rb:60:in `tap'
+  mcli/lib/mcli/command.rb:60:in `call'
+  mcli/lib/mcli.rb:17:in `run'
+  from options.rb `<main>'
+
+```
+
+##### Boolean Options
+
+```ruby
+#options.rb
+```
+```ruby
+#!/usr/bin/env ruby
+require 'mcli'
+
+class Options < MCLI::Command
+  register_as :options
+  option :heads, alias: :h, boolean: true
+
+  def run
+    puts "Heads: #{options[:heads]}"
+  end
+end
+
+MCLI.run
+```
+
+```bash
+$ ./options.rb options --heads
+Heads: true
+$ ./options.rb options --no-heads
+Heads: false
+```
+
+## 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/thomas07vt/mcli.
+
+
+## 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 "mcli"
+
+# 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/mcli

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'mcli'
+
+MCLI.run
+

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/lib/mcli.rb

@@ -0,0 +1,20 @@
+require 'optparse'
+require 'mcli/version'
+require 'mcli/help_error'
+require 'mcli/command_group'
+require 'mcli/command'
+require 'mcli/command/option'
+require 'mcli/null_command'
+
+module MCLI
+  class << self
+    def run
+      command = ARGV.shift
+
+      CommandGroup.commands.fetch(command.to_s.to_sym) do |command|
+        ARGV.unshift(command)
+        NullCommand
+      end.call
+    end
+  end
+end

data/lib/mcli/command.rb

@@ -0,0 +1,71 @@
+class MCLI::Command
+  attr_reader :args
+
+  def initialize(args=[])
+    @args = args
+  end
+
+  def parse
+    @options = {}
+
+    self.class.options.each do |option|
+      @options[option.name] = option.default if option.default
+
+      parser.on(*option.to_args) do |o|
+        @options[option.name] = o
+      end
+    end
+
+    parser.parse!
+
+    self.class.options
+      .select { |option| option.required == true }
+      .map do |required_option|
+        if @options[required_option.name].nil?
+          raise OptionParser::MissingArgument
+        end
+      end
+  end
+
+  def options
+    @options ||= {}
+  end
+
+  def parser
+    @parser ||= create_parser
+  end
+
+  def create_parser
+    OptionParser.new.tap do |parser|
+      parser.on("-h", "--help", "Help") do
+        raise MCLI::HelpError.new
+      end
+    end
+  end
+
+  class << self
+    def option(option_name, opts={})
+      options << Option.new(option_name, opts)
+    end
+
+    def options
+      @options ||= []
+    end
+
+    def register_as(command_name)
+      MCLI::CommandGroup.register(command_name, self)
+    end
+
+    def call
+      new(ARGV).tap do |command|
+        begin
+          command.parse
+          command.run
+        rescue MCLI::HelpError
+          command.help
+        end
+      end
+    end
+  end
+end
+

data/lib/mcli/command/option.rb

@@ -0,0 +1,34 @@
+# @private
+class MCLI::Command::Option
+  attr_reader :name, :alias, :default, :required, :type, :boolean
+
+  def initialize(name, options={})
+    opts = default_options.merge(options)
+
+    @name     = name.to_sym
+    @alias    = opts[:alias].to_s if opts[:alias]
+    @default  = opts[:default]
+    @required = opts[:required]
+    @type     = opts[:type]
+    @boolean  = opts[:boolean]
+  end
+
+  def to_args
+    [].tap do |args|
+      args << "-#{@alias}"                   if @alias
+      args << "--#{@name} #{@name.upcase}"   if @required && !@boolean
+      args << "--#{@name} [#{@name.upcase}]" if !@required && !@boolean
+      args << "--[no-]#{@name}"              if @boolean
+    end
+  end
+
+  private
+
+  def default_options
+    {
+      required: false,
+      boolean: false
+    }
+  end
+end
+

data/lib/mcli/command_group.rb

@@ -0,0 +1,16 @@
+class MCLI::CommandGroup
+  class << self
+    def register(command_name, command_klass)
+      commands[command_name] = command_klass
+    end
+
+    def commands
+      @commands ||= {}
+    end
+
+    def clear
+      @commands = {}
+    end
+  end
+end
+

data/lib/mcli/help_error.rb

@@ -0,0 +1 @@
+class MCLI::HelpError < StandardError; end

data/lib/mcli/null_command.rb

@@ -0,0 +1,19 @@
+class MCLI::NullCommand < MCLI::Command
+  option :version, alias: 'v', boolean: true
+
+  def run
+    if options[:version]
+      puts MCLI::VERSION
+    else
+      help
+    end
+  end
+
+  def help
+    puts help_message
+  end
+
+  def help_message
+    "No command passed\n#{parser.to_s}"
+  end
+end

data/lib/mcli/version.rb

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

data/mcli.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mcli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mcli"
+  spec.version       = MCLI::VERSION
+  spec.authors       = ["John Thomas"]
+  spec.email         = ["thomas07@vt.edu"]
+
+  spec.summary       = %q{Create CLI tools using ruby objects with a nice API}
+  spec.homepage      = "https://github.com/thomas07vt/mcli"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/mcli}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: mcli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Thomas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+description: 
+email:
+- thomas07@vt.edu
+executables:
+- mcli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/mcli
+- bin/setup
+- lib/mcli.rb
+- lib/mcli/command.rb
+- lib/mcli/command/option.rb
+- lib/mcli/command_group.rb
+- lib/mcli/help_error.rb
+- lib/mcli/null_command.rb
+- lib/mcli/version.rb
+- mcli.gemspec
+homepage: https://github.com/thomas07vt/mcli
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Create CLI tools using ruby objects with a nice API
+test_files: []