clin 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: be4386269225e68a69c419a0a4a90668f5da8287
-  data.tar.gz: 0a33c686511f6a0498fe40276c936b6574fbe497
+  metadata.gz: 398c6c91b940d2efda70f9879e2743ae5c16c33c
+  data.tar.gz: b36c46118f12f7322ced5a53fe519f0402a45a19
 SHA512:
-  metadata.gz: 2878f163e2974a9a3c93e9f565e9b5fdaf5ec91bcced8856b95b7045f45eca8427da8a22631f1741da582982ab1c575e19c6115cee4dd8078a69a08f217cf41d
-  data.tar.gz: eba57a52877c4ea5fca71571ab1a534459f173d9715028774b76a6be8fb9e7721b077fdc8371839ba770a43dfde17bd34fd7bf2c71e2001e88c6898be7458fab
+  metadata.gz: 9759baa328947f0dbf9247f0e96997f6e060c28bb35dbd98b18daa3aff46b928f595fb80fa34b9fd7072fad59cd1b186540fdadb81abed0e7b5a3114ebfec28f
+  data.tar.gz: 5fcd4a5a2a05a86488d65b62737e21d87b1c8878a0c4306f6b855c78319bc0cede1d0b2de75df313913607991f695a794be703838373596e558410462725778f

data/.lint-ci.yml

@@ -0,0 +1,2 @@
+linters:
+  - rubocop

data/.simplecov

@@ -0,0 +1,5 @@
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter '/examples/'
+end

data/.travis.yml

@@ -9,5 +9,13 @@ gemfile:
 
 matrix:
 
+after_success:
+  - ruby benchmarks/bench.rb
+
 notifications:
   email: false
+
+
+addons:
+  code_climate:
+    repo_token: 71237749c90394bd3625b66744eaa59ff237b291cef608fba8d11474fe9e8a5b

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 0.4.0
+Features:
+    - Command line parsing is now done internally, i.e. removed optparse (#6).
+    - Added a text builder interface.
+    - Added a table builder interface.
+    - Shell interact with text builder interface
+    - Shell#say, Shell#indent, Shell#password
+    
+Bug fix:
+    - OptParse was hijacking the -v --version.
+    
 ## 0.3.0
 Features:
     - Added a shell class for any user interaction.

data/README.md

@@ -1,8 +1,9 @@
 # Clin
-[![Build Status](https://travis-ci.org/timcolonel/clin.svg?branch=master)](https://travis-ci.org/timcolonel/clin)
-[![Coverage Status](https://coveralls.io/repos/timcolonel/clin/badge.svg?branch=master)](https://coveralls.io/r/timcolonel/clin?branch=master)
-[![Code Climate](https://codeclimate.com/github/timcolonel/clin/badges/gpa.svg)](https://codeclimate.com/github/timcolonel/clin)
-[![Inline docs](http://inch-ci.org/github/timcolonel/clin.svg?branch=master)](http://inch-ci.org/github/timcolonel/clin)
+[![Gem](https://img.shields.io/gem/v/clin.svg?style=flat-square)](http://rubygems.org/gems/clin)
+[![Build Status](https://img.shields.io/travis/timcolonel/clin/master.svg?style=flat-square)](https://travis-ci.org/timcolonel/clin)
+[![Code Climate](https://img.shields.io/codeclimate/coverage/github/timcolonel/clin.svg?style=flat-square)](https://codeclimate.com/github/timcolonel/clin/coverage)
+[![Test Coverage](https://img.shields.io/codeclimate/github/timcolonel/clin.svg?style=flat-square)](https://codeclimate.com/github/timcolonel/clin)
+[![Inline docs](http://inch-ci.org/github/timcolonel/clin.svg?branch=master&style=flat-square)](http://inch-ci.org/github/timcolonel/clin)
 
 Clin is Command Line Interface library that provide an clean api for complex command configuration.
 The way Clin is design allow a command defined by the user to be called via the command line as well as directly in the code without any additional configuration

data/benchmarks/bench.rb

@@ -0,0 +1,21 @@
+require 'benchmark/ips'
+$LOAD_PATH.push File.expand_path('../..', __FILE__)
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+require 'clin'
+
+Benchmark.ips do |x|
+  x.report('simple') do
+    require 'examples/simple'
+    SimpleCommand.parse('display Some -e "Even More"')
+  end
+
+  x.report('auto_option') do
+    require 'examples/auto_option'
+    AutoOptionCommand.parse('--eko="Lorem ipsum"')
+  end
+
+  x.report('nested_dispatcher') do
+    require 'examples/nested_dispatcher'
+    DispatchCommand.parse('you display Some --verbose -e More --times 3')
+  end
+end

data/benchmarks/text_bench.rb

@@ -0,0 +1,78 @@
+require 'benchmark/ips'
+$LOAD_PATH.push File.expand_path('../..', __FILE__)
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+require 'clin'
+
+values = ['Some value 1', 'Some value 2']
+Benchmark.ips do |x|
+  x.report('Normal <<') do
+    t = ''
+    t << 'Usage:' << "\n"
+    t << '  display Message' << "\n"
+    t << '  print Message' << "\n"
+    t << '     --echo' << "\n"
+    t << '     --verbose' << "\n"
+    t << 'Description: ' << "\n"
+    t << '   This is a description' << "\n"
+    t << '' << "\n"
+    t << 'Examples:' << "\n"
+    t << 'Examples:' << "\n"
+    t << ' -display Message' << "\n"
+    t << ' -print Message' << "\n"
+    t << 'Values: ' << "\n"
+    values.each do |val|
+      t << "***#{val}" << "\n"
+    end
+    t = 'You have an error!' + "\n" << t
+  end
+
+  x.report('Normal +=') do
+    t = ''
+    t += 'Usage:' + "\n"
+    t += '  display Message' + "\n"
+    t += '  print Message' + "\n"
+    t += '     --echo' + "\n"
+    t += '     --verbose' + "\n"
+    t += 'Description: ' + "\n"
+    t += '   This is a description' + "\n"
+    t += '' + "\n"
+    t += 'Examples:' + "\n"
+    t += 'Examples:' + "\n"
+    t += ' -display Message' + "\n"
+    t += ' -print Message' + "\n"
+    t += 'Values: ' + "\n"
+    values.each do |val|
+      t += "***#{val}" + "\n"
+    end
+    t = 'You have an error!' + "\n" + t
+  end
+
+  x.report('Text builder') do
+    Clin::Text.new do |t|
+      t.line 'Usage:'
+      t.indent ' ' do
+        t.line 'display Message'
+        t.line 'print Message'
+
+        t.indent '  ' do
+          t.line '--echo'
+          t.line '--verbose'
+        end
+      end
+      t.line 'Description: '
+      t.line 'This is a description', indent: '   '
+      t.blank
+      t.line 'Examples:'
+      t.indent ' -' do
+        t.line 'display Message'
+        t.line 'print Message'
+      end
+      t.line 'Values: '
+      t.lines values, indent: '*** '
+
+      t.prefix 'You have an error!'
+    end.to_s
+  end
+
+  x.compare!
+end

data/clin.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '>= 3.0'
-  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'codeclimate-test-reporter'
   spec.add_development_dependency 'faker'
+  spec.add_development_dependency 'benchmark-ips'
 end

data/examples/reusable_options.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+require 'clin'
+
+# Reusable option definition
+class SourceOptions < Clin::GeneralOption
+  option :source, 'Set the source'
+end
+
+# Command Using reusable option
+class ReusableOptionCommand < Clin::Command
+  flag_option :verbose, 'Verbose'
+  option :echo, 'Echo'
+
+  general_option SourceOptions
+
+  def run
+    puts params
+  end
+end

data/examples/simple.rb

@@ -1,6 +1,5 @@
 $LOAD_PATH.push File.expand_path('../../lib', __FILE__)
 require 'clin'
-require 'clin'
 
 # Simple command Example
 class SimpleCommand < Clin::Command
@@ -9,6 +8,8 @@ class SimpleCommand < Clin::Command
   option :echo, 'Echo some text'
   general_option Clin::HelpOptions
 
+  description 'Simple command that print stuff!'
+
   def run
     puts @params[:message]
     puts @params[:echo]
@@ -16,5 +17,9 @@ class SimpleCommand < Clin::Command
 end
 
 # Run example:
-# SimpleCommand.parse('display "My Message" --echo SOME').run
-# SimpleCommand.parse('').run
+# SimpleCommand.parse('display "My Message" -e SOME').run
+begin
+  SimpleCommand.parse('').run
+rescue Clin::HelpError => e
+  puts e
+end

data/examples/test.rb

@@ -1,9 +1,9 @@
 $LOAD_PATH.push File.expand_path('../../lib', __FILE__)
 require 'clin'
-
+require 'io/console'
 
 shell = Clin::Shell.new
-
-choice = shell.choose('What?', %w(france usa italy germany))
-
-puts 'YOu ' + choice
+100.times.each do |i|
+  shell.say "# #{i}", indent: i
+  sleep(0.5)
+end

data/examples/text_builder.rb

@@ -0,0 +1,40 @@
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+require 'clin'
+values = ['Some value 1', 'Some value 2']
+text = Clin::Text.new do |t|
+  t.line 'Usage:'
+  t.indent 2 do
+    t.line 'display Message'
+    t.line 'print Message'
+
+    t.indent 3 do
+      t.line '--echo'
+      t.line '--verbose'
+    end
+  end
+  t.line 'Description: '
+  t.line 'This is a description', indent: 3
+  t.blank
+  t.line 'Examples:'
+  t.indent ' -' do
+    t.line 'display Message'
+    t.line 'print Message'
+  end
+  t.line 'Values: '
+  t.lines values, indent: '*** '
+end
+puts text
+
+table = Clin::Text::Table.new(border: true) do |t|
+  t.align :right, :center, :left
+  # t.column_delimiter ' - ', ' # '
+  t.header %w(First Last Email)
+
+  t.row %w(Timothee Guerin timothee.guerin@outlook.com)
+  t.row %w(Some Guy Some.Guy@outlook.com)
+
+  t.separator
+
+  t.row %w(VeryLongFirstName Guy Some.Other@outlook.com)
+end
+puts table

data/lib/clin/argument.rb

@@ -2,12 +2,29 @@ require 'clin'
 
 # Command line positional argument(not option)
 class Clin::Argument
+  # Original name specified in the command
   attr_accessor :original
+
+  # If the argument is optional
   attr_accessor :optional
+
+  # If the argument accept multiple values
   attr_accessor :multiple
+
+  # If the argument is a fixed argument(User value need to match the name)
   attr_accessor :variable
+
+  # The name extracted without the brackets and arrows.
+  # This will be the key in the params when initializing a command
   attr_accessor :name
 
+  # Create a new argument from string
+  # +argument+ will be used to deduce the name, if it's fixed, optional, accept multiple values
+  # If the argument is a simple string(e.g. install) then it will be a fixed argument
+  # For the argument to accept variable values it must be surrounded with <> (e.g. <command>)
+  # For the argument to be optional it must be surrounded with [] (e.g. [<value>])
+  # For the argument to accept multiple value it must be suffixed with ... (e.g. <commands>...)
+  # @param argument [String] argument Value
   def initialize(argument)
     @original = argument
     @optional = false
@@ -63,7 +80,7 @@ class Clin::Argument
   def ensure_fixed(args)
     [*args].each do |arg|
       next if arg == @name
-      fail Clin::FixedArgumentError, @name, arg
+      fail Clin::RequiredArgumentError, @name, arg
     end
   end
 
@@ -77,7 +94,7 @@ class Clin::Argument
     if @variable
       fail Clin::MissingArgumentError, @name
     else
-      fail Clin::FixedArgumentError, @name
+      fail Clin::RequiredArgumentError, @name
     end
   end
 

data/lib/clin/command_mixin/core.rb

@@ -121,24 +121,6 @@ module Clin::CommandMixin::Core
       @_default_priority + @_priority
     end
 
-    # Build the Option Parser object
-    # Used to parse the option
-    # Useful for regenerating the help as well.
-    def option_parser(out = {})
-      OptionParser.new do |opts|
-        opts.banner = banner
-        opts.separator ''
-        opts.separator 'Options:'
-        register_options(opts, out)
-        dispatch_doc(opts)
-        unless @description.blank?
-          opts.separator "\nDescription:"
-          opts.separator @description
-        end
-        opts.separator ''
-      end
-    end
-
     def default_commands
       subcommands.sort_by(&:priority).reverse
     end
@@ -148,5 +130,18 @@ module Clin::CommandMixin::Core
     def subcommands
       subclasses.reject(&:abstract?)
     end
+
+    def help
+      Clin::Text.new do |t|
+        t.line banner
+        t.blank
+        t.line 'Options:'
+        t.text option_help, indent: 2
+        unless description.blank?
+          t.line 'Description:'
+          t.line description, indent: 2
+        end
+      end
+    end
   end
 end

data/lib/clin/command_mixin/options.rb

@@ -6,38 +6,22 @@ module Clin::CommandMixin::Options
   extend ActiveSupport::Concern
 
   included do
-    self.options = []
+    self.specific_options = []
     self.general_options = {}
     # Trigger when a class inherit this class
     # It will clone attributes that need inheritance
     # @param subclass [Clin::Command]
     def self.inherited(subclass)
-      subclass.options = @options.clone
+      subclass.specific_options = @specific_options.clone
       subclass.general_options = @general_options.clone
       super
     end
   end
 
   module ClassMethods # :nodoc:
-    attr_accessor :options
+    attr_accessor :specific_options
     attr_accessor :general_options
 
-    # Add an option
-    # @param args list of arguments.
-    #   * First argument must be the name if no block is given.
-    #     It will set automatically read the value into the hash with  +name+ as key
-    #   * The remaining arguments are OptionsParser#on arguments
-    # ```
-    #   option :require, '-r', '--require [LIBRARY]', 'Require the library'
-    #   option '-h', '--helper', 'Show the help' do
-    #     puts opts
-    #     exit
-    #   end
-    # ```
-    def opt_option(*args, &block)
-      add_option Clin::Option.new(*args, &block)
-    end
-
     # Add an option.
     # Helper method that just create a new Clin::Option with the argument then call add_option
     # ```
@@ -85,7 +69,7 @@ module Clin::CommandMixin::Options
     # @param option [Clin::Option] option to add.
     def add_option(option)
       # Need to use += instead of << otherwise the parent class will also be changed
-      @options << option
+      @specific_options << option
     end
 
     # Add a general option
@@ -105,16 +89,17 @@ module Clin::CommandMixin::Options
 
     # To be called inside OptionParser block
     # Extract the option in the command line using the OptionParser and map it to the out map.
-    # @param opts [OptionParser]
-    # @param out [Hash] Where the options shall be extracted
-    def register_options(opts, out)
-      @options.each do |option|
-        option.register(opts, out)
+    # @return [Hash] Where the options shall be extracted
+    def option_defaults
+      out = {}
+      @specific_options.each do |option|
+        option.load_default(out)
       end
 
       @general_options.each do |_cls, option|
-        option.class.register_options(opts, out)
+        out.merge! option.class.option_defaults
       end
+      out
     end
 
     # Call #execute on each of the general options.
@@ -130,5 +115,31 @@ module Clin::CommandMixin::Options
         gopts.execute(options)
       end
     end
+
+    # Return all options
+    def options
+      specific_options + general_options.keys.map(&:options).flatten
+    end
+
+    def find_option(value)
+      find_option_by(name: value)
+    end
+
+    def find_option_by(hash)
+      key, value = hash.first
+      options.find { |x| x.send(key) == value }
+    end
+
+    def option_help
+      Clin::Text.new do |t|
+        options.each do |option|
+          t.line option.banner
+        end
+
+        general_options.each do |cls, _|
+          t.text cls.option_help
+        end
+      end
+    end
   end
 end

data/lib/clin/command_parser.rb

@@ -2,6 +2,9 @@ require 'clin'
 
 # Command parser
 class Clin::CommandParser
+  # List of errors that have occurred during the parsing
+  attr_reader :errors
+
   # Create the command parser
   # @param command_cls [Class<Clin::Command>] Command that must be matched
   # @param argv [Array<String>] List of CL arguments
@@ -11,75 +14,59 @@ class Clin::CommandParser
     argv = Shellwords.split(argv) if argv.is_a? String
     @argv = argv
     @fallback_help = fallback_help
+    @options = {}
+    @arguments = {}
+    @errors = []
+    @skipped_options = []
+  end
+
+  def params
+    out = @options.merge(@arguments)
+    out[:skipped_options] = @skipped_options if @command.skip_options?
+    out
+  end
+
+  def init_defaults
+    @options = @command.option_defaults
   end
 
   # Parse the command line.
   def parse
     argv = @argv.clone
-    error = nil
-    options = {}
-    begin
-      options.merge! parse_options(argv)
-    rescue Clin::OptionError => e
-      error = e
-    end
-    begin
-      options.merge! parse_arguments(argv)
-    rescue Clin::ArgumentError => e
-      raise e unless @fallback_help
-      error = e
-    end
+    init_defaults
+    parse_options(argv)
+    parse_arguments(argv)
 
-    return redispatch(options) if @command.redispatch?
-    obj = @command.new(options)
-    handle_error(error)
+    return redispatch(params) if @command.redispatch?
+    obj = @command.new(params)
+    validate!
     obj
   end
 
-  # Parse the options in the argv.
-  # @return [Array] the list of argv that are not options(positional arguments)
   def parse_options(argv)
-    out = {}
-    parser = @command.option_parser(out)
-    skipped = skipped_options
-    argv.reject! { |x| skipped.include?(x) }
-    begin
-      parser.parse!(argv)
-    rescue OptionParser::InvalidOption => e
-      raise Clin::OptionError, e.to_s
-    end
-    out[:skipped_options] = skipped if @command.skip_options?
-    out
+    parser = Clin::OptionParser.new(@command, argv)
+    @options.merge! parser.parse
+    @skipped_options = parser.skipped_options
+    @errors += parser.errors
+    argv.replace(parser.arguments)
+    @options
   end
 
-  # Get the options that have been skipped by options_first!
-  def skipped_options
-    return [] unless @command.skip_options?
-    argv = @argv.dup
-    skipped = []
-    parser = @command.option_parser
-    loop do
-      begin
-        parser.parse!(argv)
-        break
-      rescue OptionParser::InvalidOption => e
-        skipped << e.to_s.sub(/invalid option:\s+/, '')
-        next if argv.empty? || argv.first.start_with?('-')
-        skipped << argv.shift
-      end
-    end
-
-    skipped
+  def add_error(err)
+    @errors << err
   end
 
   # Parse the argument. The options must have been strip out first.
   def parse_arguments(argv)
-    out = {}
     @command.args.each do |arg|
       value, argv = arg.parse(argv)
-      out[arg.name.to_sym] = value
+
+      @arguments[arg.name.to_sym] = value
     end
-    out.delete_if { |_, v| v.nil? }
+    @arguments.delete_if { |_, v| v.nil? }
+    @arguments
+  rescue Clin::ArgumentError => e
+    add_error e
   end
 
   # Method called after the argument have been parsed and before creating the command
@@ -91,7 +78,7 @@ class Clin::CommandParser
     begin
       dispatcher.parse(redispatch_arguments(params))
     rescue Clin::HelpError
-      raise Clin::HelpError, @command.option_parser
+      raise Clin::HelpError, @command
     end
   end
 
@@ -105,11 +92,13 @@ class Clin::CommandParser
     args
   end
 
-  # Guard that check if there was an error and fail HelpError if there was
-  # @raise [Clin::HelpError]
-  def handle_error(error)
-    return unless error
-    fail Clin::HelpError, @command.option_parser if @fallback_help
-    fail error
+  def valid?
+    @errors.empty?
+  end
+
+  def validate!
+    return if valid?
+    fail Clin::HelpError, @command if @fallback_help
+    fail @errors.sort_by { |e| e.class.severity }.last
   end
 end

data/lib/clin/common/help_options.rb

@@ -1,5 +1,6 @@
 require 'clin'
 require 'clin/general_option'
+
 # Help option class
 # Add the help option to you command
 # ```