clin 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 98bdce921d4896c86ed482d8db5cf87a74b2795a
+  data.tar.gz: e025be0b4c3c5fd36f49437e21abfc1f00ef1a0c
+SHA512:
+  metadata.gz: 8a70c2a7c6e53bf8eb781b37841dc24052e8396a2b6a2e8d73d6ea9dc90525fe1e03bf2437f43aefdeaf6aef648b210d7c79fec2fd8d7a31734c5ab21da7d9c1
+  data.tar.gz: ef60cf35207752817b52bae1514c55f5db9c12e5f87ae322a17469b9039b6a37470327c6bb4e4d43d37f024c5ae5acd283ec200090c6bad5f6705739086edd49

data/.codeclimate.yml

@@ -0,0 +1,5 @@
+languages:
+  Ruby: true
+exclude_paths:
+  - "spec/*"
+  - "examples/*"

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea

data/.rubocop.yml

@@ -0,0 +1,19 @@
+Metrics/LineLength:
+  Max: 100
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+Metrics/MethodLength:
+  Description: Avoid methods longer than 25 lines of code.
+  Enabled: true
+  CountComments: false
+  Max: 25
+
+
+AllCops:
+  Exclude:
+    - 'spec/**/*'

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - '2.0'
+  - '2.1'
+  - '2.2'
+
+
+gemfile:
+  - Gemfile
+
+matrix:
+
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in clin.gemspec
+gemspec
+
+gem 'rubocop'
+group :doc do
+  gem 'yard'
+  gem 'redcarpet'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Timothee Guerin
+
+MIT License
+
+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,98 @@
+# 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)
+
+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
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'clin'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install clin
+
+Then add the following in you ruby script.
+```ruby
+require 'clin'
+```
+## Usage
+
+The [examples](examples/) folder contains various use case of Clin.
+
+### Define a command
+To define a command you must create a new class that inherit `Clin::Command`:
+
+```ruby
+class DisplayCommand < Clin::Command
+  def run
+     
+  end
+end
+```
+
+#### Specify arguments
+To specify what argument your command takes use the `.arguments` method.
+Clin will then automatically extract the arguments when parsing and pass them when creating the object.
+You can after access the arguments with @params
+```ruby
+class DisplayCommand < Clin::Command
+  arguments 'display <message>'
+  
+  def run
+    puts "Display message: #{params[:message}"
+  end
+end
+```
+
+Then calling `DisplayCommand.parse('display "Hello World!"').run` will print `Display message: Hello World!`
+
+#### Specify options
+You can also specify options using the `.option` method.
+```ruby
+class DisplayCommand < Clin::Command
+  arguments 'display <message>'
+  option :times, 'Display the message n times'
+  
+  def run
+    params[:times] ||= 1
+    params[:times].times.each do 
+        puts "Display message: #{params[:message}"
+    end
+  end
+end
+```
+
+### Dispatch to the right command
+For complex command line interface you might need several different commands(e.g. git add, git commit,etc.)
+Define each command as shown previously then use the CommandDispatcher to choose the right command.
+By default the dispatcher is going to try all the loaded commands(All subclasses of Clin::Commands)
+but it can be filter.
+```ruby
+# Suppose Git::Add and Git::Commit are Clin::Command.
+Clin::CommandDispatcher.parse('commit -m "initial commit") #=> Git::Commit<params: {message: "initial commit"}>
+```
+
+To limit filter the usage:
+```ruby
+# Suppose Git::Add, Git::Commit, Git::Push are Clin::Command.
+dispatcher = Clin::CommandDispatcher.new(Git::Commit, Git::Push)
+dispatcher.parse('commit add -A") #=> Will show the help as no command match.
+dispatcher.parse('commit -m "initial commit") #=> Git::Commit<params: {message: "initial commit"}>
+```
+## Contributing
+
+1. Fork it ( https://github.com/timcolonel/clin/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  puts 'Spec cannot be loaded!'
+end

data/clin.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'clin/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'clin'
+  spec.version = Clin::VERSION
+  spec.authors = ['Timothee Guerin']
+  spec.email = ['timothee.guerin@outlook.com']
+  spec.summary = 'Clin provide an advance way to define complex command line interface.'
+  spec.description = ''
+  spec.homepage = ''
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0")
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '>=4.0'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'faker'
+end

data/examples/dispatcher.rb

@@ -0,0 +1,76 @@
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+require 'clin'
+
+# Simple command Example
+class DisplayCommand < Clin::Command
+  arguments 'display <message>'
+
+  general_option Clin::HelpOptions
+
+  self.description = 'Display the given message'
+
+  def run
+    puts "Display: '#{params[:message]}'"
+  end
+end
+
+# Simple command Example
+class PrintCommand < Clin::Command
+  arguments 'print <message>'
+
+  general_option Clin::HelpOptions
+
+  self.description = 'Print the given message'
+
+  def run
+    puts "Print: '#{params[:message]}'"
+  end
+end
+
+Clin::CommandDispatcher.parse('display "My Message"').run
+puts
+puts '=' * 60
+puts
+Clin::CommandDispatcher.parse('print "My Message"').run
+puts
+puts '=' * 60
+puts
+begin
+  Clin::CommandDispatcher.parse('display -h').run
+rescue Clin::CommandLineError => e
+  puts e
+end
+puts
+puts '=' * 60
+puts
+begin
+  Clin::CommandDispatcher.parse('-h')
+rescue Clin::CommandLineError => e
+  puts e
+end
+
+# Output:
+#
+# $ ruby dispatcher.rb
+# Display: 'My Message'
+#
+# ============================================================
+#
+# Print: 'My Message'
+#
+# ============================================================
+#
+# Usage: command display <message> [Options]
+#
+# Options:
+#   -h, --help                       Show the help.
+#
+# Description:
+# Display the given message
+#
+#
+# ============================================================
+#
+# Usage:
+#   command display <message> [Options]
+#   command print <message> [Options]

data/examples/nested_dispatcher.rb

@@ -0,0 +1,91 @@
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+require 'clin'
+
+# Simple dispatch Example
+class DispatchCommand < Clin::Command
+  arguments 'you <args>...'
+  dispatch :args, prefix: 'you'
+  general_option Clin::HelpOptions
+
+  self.description = 'YOU print the given message'
+
+  def run
+    puts 'Should not be called'
+  end
+end
+
+# Simple command Example
+class DisplayCommand < DispatchCommand
+  arguments 'you display <message>'
+
+  general_option Clin::HelpOptions
+
+  self.description = 'Display the given message'
+
+  def run
+    puts "I Display: '#{params[:message]}'"
+  end
+end
+
+# Simple command Example
+class PrintCommand < DispatchCommand
+  arguments 'you print <message>'
+
+  general_option Clin::HelpOptions
+
+  self.description = 'Print the given message'
+
+  def run
+    puts "I Print: '#{params[:message]}'"
+  end
+end
+
+
+Clin::CommandDispatcher.parse('you display "My Message"').run
+puts
+puts '=' * 60
+puts
+Clin::CommandDispatcher.parse('you print "My Message"').run
+puts
+puts '=' * 60
+puts
+begin
+  Clin::CommandDispatcher.parse('you -h').run
+rescue Clin::CommandLineError => e
+  puts e
+end
+puts
+puts '=' * 60
+puts
+begin
+  Clin::CommandDispatcher.parse('-h')
+rescue Clin::CommandLineError => e
+  puts e
+end
+
+# Output:
+#
+# $ ruby dispatcher.rb
+# I Display: 'My Message'
+#
+# ============================================================
+#
+# I Print: 'My Message'
+#
+# ============================================================
+#
+# Usage: command you <args>... [Options]
+#
+# Options:
+#     -h, --help                       Show the help.
+#
+# Description:
+# YOU print the given message
+#
+#
+# ============================================================
+#
+# Usage:
+#   command you <args>... [Options]
+#   command you display <message> [Options]
+#   command you print <message> [Options]

data/examples/optional_argument.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+require 'clin'
+
+# Simple command Example
+class OptionalArgumentCommand < Clin::Command
+  arguments 'display [<message>]'
+
+  def run
+    puts params.fetch(:message, 'No message given')
+  end
+end
+
+OptionalArgumentCommand.parse('display "My Message"')
+puts
+puts '=' * 60
+puts
+OptionalArgumentCommand.parse('display')
+
+# $ ruby optional_argument.rb
+# My Message
+#
+# ============================================================
+#
+# No message given

data/examples/simple.rb

@@ -0,0 +1,39 @@
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+require 'clin'
+require 'clin'
+
+# Simple command Example
+class SimpleCommand < Clin::Command
+  arguments 'display <message>'
+
+  option :echo, 'Echo some text'
+  general_option Clin::HelpOptions
+
+  def run
+    puts @params[:message]
+    puts @params[:echo]
+  end
+end
+
+if __FILE__== $0
+  SimpleCommand.parse('display "My Message" --echo SOME').run
+  puts
+  puts '=' * 60
+  puts
+  begin
+    SimpleCommand.parse('').run
+  rescue Clin::HelpError => e
+    puts e
+  end
+end
+# $ ruby simple.rb
+# My Message
+# SOME
+#
+# ============================================================
+#
+#   Usage: command display <message> [Options]
+#
+# Options:
+#   -e, --echo ECHO                  Echo some text
+# -h, --help                       Show the help.

data/examples/test.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+require 'clin'

data/lib/clin/argument.rb

@@ -0,0 +1,90 @@
+require 'clin'
+
+# Command line positional argument(not option)
+class Clin::Argument
+  attr_accessor :original
+  attr_accessor :optional
+  attr_accessor :multiple
+  attr_accessor :variable
+  attr_accessor :name
+
+  def initialize(argument)
+    @original = argument
+    @optional = false
+    @multiple = false
+    @variable = false
+    argument = check_optional(argument)
+    argument = check_multiple(argument)
+    @name = check_variable(argument)
+  end
+
+  def check_optional(argument)
+    if check_between(argument, '[', ']')
+      @optional = true
+      return argument[1...-1]
+    end
+    argument
+  end
+
+  def check_multiple(argument)
+    if argument.end_with? '...'
+      @multiple = true
+      return argument[0...-3]
+    end
+    argument
+  end
+
+  def check_variable(argument)
+    if check_between(argument, '<', '>')
+      @variable = true
+      return argument[1...-1]
+    end
+    argument
+  end
+
+  # Given a list of arguments extract the list of arguments that are matched
+  def parse(argv)
+    return handle_empty if argv.empty?
+    if @multiple
+      ensure_name(argv) unless @variable
+      [argv, []]
+    else
+      ensure_name(argv[0]) unless @variable
+      [argv[0], argv[1..-1]]
+    end
+  end
+
+  private
+
+  def ensure_name(args)
+    [*args].each do |arg|
+      if arg != @name
+        fail Clin::FixedArgumentError, @name, arg
+      end
+    end
+  end
+
+  # Call when the argv is empty.
+  # Will return nil, [] if the argument is optional
+  # Will fail otherwise:
+  # * MissingArgumentError if the argument is a variable(e.g. <arg>)
+  # * FixedArgumentError if the argument is fixed(e.g. display)
+  def handle_empty
+    return nil, [] if optional
+    if @variable
+      fail Clin::MissingArgumentError, @name
+    else
+      fail Clin::FixedArgumentError, @name
+    end
+  end
+
+  def check_between(argument, start_char, end_char)
+    if argument[0] == start_char
+      if argument[-1] != end_char
+        fail Clin::Error, "Argument format error! Cannot start with #{start_char} and not end with #{end_char}"
+      end
+      return true
+    end
+    false
+  end
+end