tlopo-cli 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1a5668d6843437f528a5a01290e8d0122e2556bf
+  data.tar.gz: 569e1a684b49cf6a8d43a830be71463e41c13172
+SHA512:
+  metadata.gz: c3c4c6d3a2ee22eba315154bafb17c5fb59ac5b2170ed1e41e1c77d5dd92b1649654433bf564128779b08814349ac4092f0778f18e62a5b0bba9741959d91c25
+  data.tar.gz: c73e7b0a44ab46afa619f07d9bacf835c0fe066dca8abeb0ea83e1b7b0f7bcfc2a8d065781eca968d7e269f216c817f2144d42e25abf0f67a05ae1c3d41fcff5

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,35 @@
+
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.2 # Oldest version kubeclient supports
+MethodLength:
+  Enabled: false
+ClassLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/LineLength:
+  Max: 100
+Metrics/ParameterLists:
+  Max: 5
+  CountKeywordArgs: false
+Metrics/CyclomaticComplexity:
+  Max: 8
+Metrics/ModuleLength:
+  Enabled: false
+Style/MethodCallWithArgsParentheses:
+  Enabled: true
+  IgnoredMethods: [require, raise, include, attr_reader, refute, assert]
+  Exclude: [Gemfile, Rakefile, kubeclient.gemspec]
+Metrics/BlockLength:
+  Enabled: true
+  Exclude: 
+    - tlopo-cli.gemspec
+Lint/UnderscorePrefixedVariableName:
+  Enabled: false
+Security/MarshalLoad:
+  Exclude: 
+    - test/**/*
+Style/ClassVars:
+  Exclude:
+    - test/**/*

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - "2.2"
+  - "2.3.0"
+  - "2.4.0"
+sudo: false
+cache: bundler
+script: bundle exec rake $TASK
+env:
+ - TASK=test_with_coveralls

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 tlopo@ibm.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 tlopo-cli.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tiago Lopo Da Silva
+
+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,146 @@
+# tlopo-cli
+[![Gem Version](https://badge.fury.io/rb/tlopo-cli.svg)](http://badge.fury.io/rb/tlopo-cli)
+[![Build Status](https://travis-ci.org/tlopo-ruby/tlopo-cli.svg?branch=master)](https://travis-ci.org/tlopo-ruby/tlopo-cli)
+[![Code Climate](https://codeclimate.com/github/tlopo-ruby/tlopo-cli/badges/gpa.svg)](https://codeclimate.com/github/tlopo-ruby/tlopo-cli)
+[![Dependency Status](https://gemnasium.com/tlopo-ruby/tlopo-cli.svg)](https://gemnasium.com/tlopo-ruby/tlopo-cli)
+[![Coverage Status](https://coveralls.io/repos/github/tlopo-ruby/tlopo-cli/badge.svg?branch=master)](https://coveralls.io/github/tlopo-ruby/tlopo-cli?branch=master)
+
+A Library to speed up CLI apps development
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tlopo-cli'
+```
+
+And then execute:
+
+```Bash
+bundle
+```
+
+Or install it yourself as:
+
+```Bash
+gem install tlopo-cli
+```
+
+## Usage
+
+Simple usage: 
+```ruby
+require 'tlopo/cli'
+
+class Command
+  def self.run(opts)
+    puts opts
+  end
+end
+
+cfg = {
+  'name' =>  'command',
+  'banner' => "My ClI\n    Run my-cli with ARGS\nOPTIONS:\n",
+  'class' => 'Command',
+  'switches' => [{
+    'name' => 'filename',
+    'short' => '-f',
+    'long' => '--filename <Filename>',
+    'desc' => 'Sets filename'
+  }]
+}
+
+Tlopo::Cli.new(config: cfg).run 
+```
+In action: 
+```bash
+$ ruby /tmp/my-cli.rb --help
+My ClI
+    Run my-cli with ARGS
+OPTIONS:
+    -f, --filename <Filename>        Sets filename
+$ ruby /tmp/my-cli.rb  -f /etc/hosts
+{"filename"=>"/etc/hosts"}
+```
+
+You can have as many subcommands as you want, options will be parsed.
+```ruby
+require 'tlopo/cli'
+
+class Command
+  def self.run(opts)
+    puts opts
+  end
+end
+
+class SubCommand1
+  def self.run(opts)
+    puts opts
+  end
+end
+
+class SubCommand2
+  def self.run(opts)
+    puts opts
+  end
+end
+
+cfg = {
+  :globals => true, # This will include the options for each 'parent' command
+  :usage => true, # This will add _usage in opts commands/subcommands can print it  if needed
+  'name' =>  'command',
+  'banner' => "command\nOPTIONS:\n",
+  'class' => 'Command',
+  'switches' => [{ 'name' => 'arg1', 'short' => '-a', 'long' => '--arg1 <arg1>', 'desc' => 'Sets arg1'}],
+  'subcommands' => [
+    { 
+      'name' =>  'subcommand1',
+      'banner' => "Subcommand1\nOPTIONS:\n",
+      'class' => 'SubCommand1',
+      'switches' => [{ 'name' => 'arg1', 'short' => '-a', 'long' => '--arg1 <arg1>', 'desc' => 'Sets subcommand1 arg1'} ],
+      'subcommands' => [
+        { 
+          'name' =>  'subcommand2',
+          'banner' => "Subcommand2\nOPTIONS:\n",
+          'class' => 'SubCommand2',
+          'switches' => [{ 'name' => 'arg1', 'short' => '-a', 'long' => '--arg1 <arg1>', 'desc' => 'Sets subcommand2 arg1'}]
+        }
+      ]
+    }
+  ]
+}
+```
+In action: 
+```bash
+$ ruby /tmp/my-cli.rb -a 1  subcommand1 -a 2  subcommand2 -a 3
+{"arg1"=>"3", "_globals"=>{"command"=>{"class"=>"Command", "arg1"=>"1"}, "command::subcommand1"=>{"class"=>"SubCommand1", "arg1"=>"2"}}}
+```
+
+
+
+
+The configuration can also be a yaml or json file: 
+
+```ruby
+Tlopo::Cli.new(config_file: './cli-config.yml')
+```
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/kubeclient/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Test your changes with `rake test rubocop`, add new tests if needed.
+4. If you added a new functionality, add it to README
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create a new Pull Request
+
+## Tests
+
+This library is tested with Minitest.
+Please run all tests before submitting a Pull Request, and add new tests for new functionality.
+
+Running tests:
+```ruby
+rake test
+```

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'coveralls/rake/task'
+
+task default: %i[test rubocop]
+task test_with_coveralls: [:default, 'coveralls:push']
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RuboCop::RakeTask.new
+Coveralls::RakeTask.new

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'tlopo/cli'
+
+# 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/tlopo-cli

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

data/lib/tlopo/cli.rb

@@ -0,0 +1,102 @@
+require 'tlopo/cli/version'
+require 'yaml'
+require 'optparse'
+
+module Tlopo
+  # A library to speedup CLI apps development
+  class Cli
+    def initialize(opts = {})
+      msg = 'Either config or config_file must be specified'
+      raise msg unless opts[:config_file] || opts[:config]
+      raise msg if opts[:config_file] && opts[:config]
+      @cfg = YAML.safe_load(File.read(opts[:config_file])) if opts[:config_file]
+      @cfg = opts[:config] if opts[:config]
+      @globals = @cfg[:globals]
+      @usage = @cfg[:usage]
+      @cfg.delete(:globals)
+      @cfg.delete(:usage)
+    end
+
+    def run
+      validate_recursive
+      parse_recursive(@cfg, {})
+    end
+
+    private
+
+    def validate_recursive(obj = @cfg)
+      validate_command(obj)
+      obj['switches'].each { |sw| validate_switch(sw) } if obj['switches']
+      obj['subcommands'].each { |sub| validate_recursive(sub) } if obj['subcommands']
+    end
+
+    def parse_options(obj, result, key)
+      return nil if obj.nil?
+      result[key] = {} unless result[key]
+      result[key]['class'] = obj['class']
+      op = OptionParser.new do |opts|
+        opts.banner = obj['banner']
+        if obj['switches']
+          obj['switches'].each do |sw|
+            short = sw['short']
+            long = sw['long']
+            desc = sw['desc']
+            opts.on(short, long, desc) { |v| result[key][sw['name']] = v }
+          end
+        end
+      end
+      result[key]['_usage'] = op.to_s if @usage
+      op
+    end
+
+    def parse_recursive(obj, result, stack = [])
+      stack << obj['name']
+      key = stack.join('::')
+      _p = parse_options(obj, result, key)
+      _p.order! unless _p.nil?
+      subcommand = ARGV.shift
+      return invoke_class_run(result, key) if subcommand.nil?
+      command = obj['subcommands'].find { |e| e['name'] == subcommand } if obj['subcommands']
+      raise "Unknown subcommand '#{subcommand}' for [ #{stack.join(' -> ')} ]" unless command
+      parse_recursive(command, result, stack)
+    end
+
+    def invoke_class_run(result, key)
+      _class = result[key]['class']
+      opts = result[key]
+      opts.delete('class')
+      result.delete(key)
+      opts['_globals'] = result if @globals
+      Object.const_get(_class).run(opts)
+    end
+
+    def validate_command(command)
+      required = %w[name banner class]
+      optional = %w[switches subcommands]
+      required.each do |e|
+        raise "Field '#{e}' is required. received: [#{command.inspect}]" unless command[e]
+      end
+      known = required + optional
+      command.each_key do |k|
+        raise "Unknown field '#{k}', known values #{known.inspect}" unless known.include?(k)
+      end
+      begin
+        Object.const_get(command['class'])
+      rescue NameError
+        raise "Can't find class #{command['class']}, make sure it's loaded."
+      end
+    end
+
+    def validate_switch(switch)
+      required = %w[name long desc]
+      optional = ['short']
+      required.each do |e|
+        raise "Field '#{e}' is required. received: [#{switch.inspect}]" unless switch[e]
+      end
+      known = required + optional
+      switch.each_key do |k|
+        raise "Unknown field '#{k}', known values #{known.inspect}" unless known.include?(k)
+      end
+    end
+  end
+end

data/lib/tlopo/cli/version.rb

@@ -0,0 +1,5 @@
+module Tlopo
+  class Cli
+    VERSION = '0.1.0'.freeze
+  end
+end

data/tlopo-cli.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tlopo/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'tlopo-cli'
+  spec.version       = Tlopo::Cli::VERSION
+  spec.authors       = ['Tiago Lopo Da Silva']
+  spec.email         = ['tiagolopo@yahoo.com.br']
+
+  spec.summary       = 'A library to speed up CLI apps development'
+  spec.description   = 'A library to speed up CLI apps development'
+  spec.homepage      = 'https://github.com/tlopo-ruby/tlopo-cli'
+  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   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency('bundler', '~> 1.15')
+  spec.add_development_dependency('coveralls', '0.8.19')
+  spec.add_development_dependency('fakefs', '~> 0.13.0')
+  spec.add_development_dependency('minitest', '~> 5.0')
+  spec.add_development_dependency('rake', '~> 10.0')
+  spec.add_development_dependency('rubocop', '~> 0.52.1')
+  spec.add_development_dependency('simplecov', '0.12.0')
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: tlopo-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tiago Lopo Da Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.19
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.8.19
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.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: 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: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+description: A library to speed up CLI apps development
+email:
+- tiagolopo@yahoo.com.br
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/tlopo-cli
+- lib/tlopo/cli.rb
+- lib/tlopo/cli/version.rb
+- tlopo-cli.gemspec
+homepage: https://github.com/tlopo-ruby/tlopo-cli
+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.13
+signing_key: 
+specification_version: 4
+summary: A library to speed up CLI apps development
+test_files: []