avalanche-cli 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/README.md

@@ -0,0 +1,60 @@
+# CLI
+
+A small command line interface library for quickly building cli apps.
+
+## Usage
+
+Add this to your Gemfile:
+
+    gem 'cli', :git => 'git://github.com/avalanche123/cli.git'
+
+Build a single command script:
+
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cli'
+
+cmd = CLI::Command.new('hello [options] NAME', {
+  :title => ['--title TITLE', String, 'Desired title']
+}, Proc.new do |opts, args|
+  raise "NAME is required" if args.empty?
+
+  puts "Hello, #{opts[:title]} #{args.first}!".gsub(/\s+/, " ")
+end)
+
+cmd.run(ARGV)
+```
+
+Build a cli application with many subcommands:
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cli'
+
+app = CLI::Application.new('app', '0.1.0')
+
+app.command('hello [options] NAME', "Says Hello", {
+  :title => ['--title TITLE', String, 'Desired title']
+}, Proc.new do |opts, args|
+  raise "NAME is required" if args.empty?
+
+  puts "Hello, #{opts[:title]} #{args.first}!".gsub(/\s+/, " ")
+end)
+
+app.run(ARGV)
+```
+
+Check it:
+
+```shell
+> /path/to/command --help
+```
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/cli.gemspec

@@ -0,0 +1,20 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'avalanche/cli/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "avalanche-cli"
+  gem.version       = Avalanche::CLI::VERSION
+  gem.authors       = ["Bulat Shakirzyanov"]
+  gem.email         = ["mallluhuct@gmail.com"]
+  gem.description   = %q{A small command line interface library for quickly building cli apps.}
+  gem.summary       = %q{A small command line interface library for quickly building cli apps.}
+  gem.homepage      = "https://github.com/avalanche123/cli"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+end

data/cli/application.rb

@@ -0,0 +1,73 @@
+module CLI
+  class Application
+    def initialize(name, version)
+      @name         = name
+      @version      = version
+      @commands     = {}
+      @opts         = OptionParser.new
+
+      @opts.program_name = @name
+
+      @opts.banner = "Usage: #{@name} [--version] [--help] command [options] [args]"
+
+      @opts.top.append("", nil, nil)
+      @opts.top.append("Available #{@name} commands are:", nil, nil)
+
+      @opts.base.append("", nil, nil)
+      @opts.base.append("Common options:", nil, nil)
+
+      @opts.on_tail("-h", "--help",    "Show this message") { print_help    }
+      @opts.on_tail('-v', '--version', "Show version")      { print_version }
+    end
+
+    def command(usage, description, options, handler)
+      parts   = usage.split(" ")
+      command = parts.shift
+
+      @opts.separator(sprintf("  %-10.10s %s", command, description))
+
+      parts.unshift("#{@name}-#{command}")
+
+      @commands[command] = Command.new(parts.join(" "), options, handler)
+    end
+
+    def run(argv)
+      if argv.empty?
+        print_help
+      end
+
+      command = @commands[argv.first]
+
+      if command.nil?
+        @opts.permute!(argv)
+        print_help
+      else
+        argv.shift
+        command.run(argv)
+      end
+    rescue OptionParser::InvalidOption => e
+      @opts.warn(e.message)
+      print_help
+    rescue Interrupt
+      exit 0
+    rescue => e
+      @opts.abort(e.message)
+    end
+
+    def to_proc
+      proc { |opts, args| run(args) }
+    end
+
+    private
+
+    def print_help
+      puts @opts
+      exit 1
+    end
+
+    def print_version
+      puts "#{@name} #{@version}"
+      exit 0
+    end
+  end
+end

data/cli/command.rb

@@ -0,0 +1,50 @@
+module CLI
+  class Command
+    def initialize(usage, options, handler)
+      parts    = usage.split(/\s+/)
+      @name    = parts.shift
+      usage    = parts.join(" ")
+      @handler = handler.to_proc
+      @options = {}
+      @opts    = OptionParser.new
+
+      @opts.program_name = @name
+
+      @opts.banner = "Usage: #{@name} #{usage}"
+
+      options.each do |name, opts|
+        @opts.on(*opts) do |v|
+          @options[name] = v
+        end
+      end
+
+      @opts.base.append("", nil, nil)
+      @opts.base.append("Additional options:", nil, nil)
+
+      @opts.on_tail("-h", "--help", "Show this message") { print_help }
+    end
+
+    def run(argv)
+      $0 = "#{@name} #{argv.join(" ")}"
+      @handler.call(@options, @opts.permute!(argv))
+    rescue OptionParser::InvalidOption => e
+      @opts.warn(e.message)
+      print_help
+    rescue Interrupt
+      exit 0
+    rescue => e
+      @opts.abort(e.message)
+    end
+
+    def to_proc
+      proc { |opts, args| run(args) }
+    end
+
+    private
+
+    def print_help
+      puts @opts
+      exit 1
+    end
+  end
+end

data/cli/version.rb

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

data/example/app

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.expand_path(File.dirname(__FILE__) + "/../lib")
+
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'avalanche/cli'
+
+app = Avalanche::CLI::Application.new('app', '0.1.0')
+
+app.command('hello [options] NAME', "Says Hello", {
+  :title => ['--title TITLE', String, 'Desired title']
+}, Proc.new do |opts, args|
+  raise "NAME is required" if args.empty?
+
+  puts "Hello, #{opts[:title]} #{args.first}!".gsub(/\s+/, " ")
+end)
+
+app.run(ARGV)

data/example/hello

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+lib_dir = File.expand_path(File.dirname(__FILE__) + "/../lib")
+
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'avalanche/cli'
+
+cmd = Avalanche::CLI::Command.new('hello [options] NAME', {
+  :title => ['--title TITLE', String, 'Desired title']
+}, Proc.new do |opts, args|
+  raise "NAME is required" if args.empty?
+
+  puts "Hello, #{opts[:title]} #{args.first}!".gsub(/\s+/, " ")
+end)
+
+cmd.run(ARGV)

data/lib/avalanche/cli.rb

@@ -0,0 +1,4 @@
+require 'optparse'
+
+require 'avalanche/cli/application'
+require 'avalanche/cli/command'

data/lib/avalanche/cli/application.rb

@@ -0,0 +1,75 @@
+module Avalanche
+  module CLI
+    class Application
+      def initialize(name, version)
+        @name         = name
+        @version      = version
+        @commands     = {}
+        @opts         = OptionParser.new
+
+        @opts.program_name = @name
+
+        @opts.banner = "Usage: #{@name} [--version] [--help] command [options] [args]"
+
+        @opts.top.append("", nil, nil)
+        @opts.top.append("Available #{@name} commands are:", nil, nil)
+
+        @opts.base.append("", nil, nil)
+        @opts.base.append("Common options:", nil, nil)
+
+        @opts.on_tail("-h", "--help",    "Show this message") { print_help    }
+        @opts.on_tail('-v', '--version', "Show version")      { print_version }
+      end
+
+      def command(usage, description, options, handler)
+        parts   = usage.split(" ")
+        command = parts.shift
+
+        @opts.separator(sprintf("  %-10.10s %s", command, description))
+
+        parts.unshift("#{@name}-#{command}")
+
+        @commands[command] = Command.new(parts.join(" "), options, handler)
+      end
+
+      def run(argv)
+        if argv.empty?
+          print_help
+        end
+
+        command = @commands[argv.first]
+
+        if command.nil?
+          @opts.permute!(argv)
+          print_help
+        else
+          argv.shift
+          command.run(argv)
+        end
+      rescue OptionParser::InvalidOption => e
+        @opts.warn(e.message)
+        print_help
+      rescue Interrupt
+        exit 0
+      rescue => e
+        @opts.abort(e.message)
+      end
+
+      def to_proc
+        proc { |opts, args| run(args) }
+      end
+
+      private
+
+      def print_help
+        puts @opts
+        exit 1
+      end
+
+      def print_version
+        puts "#{@name} #{@version}"
+        exit 0
+      end
+    end
+  end
+end

data/lib/avalanche/cli/command.rb

@@ -0,0 +1,70 @@
+module Avalanche
+  module CLI
+    class Command
+      def initialize(usage, options, handler)
+        parts    = usage.split(/\s+/)
+        @name    = parts.shift
+        usage    = parts.join(" ")
+        @handler = handler.to_proc
+        @options = {}
+        @opts    = OptionParser.new
+
+        @opts.program_name = @name
+
+        @opts.banner = "Usage: #{@name} #{usage}"
+
+        options.each do |name, opts|
+          @opts.on(*opts) do |v|
+            @options[name] = v
+          end
+        end
+
+        @opts.base.append("", nil, nil)
+        @opts.base.append("Additional options:", nil, nil)
+
+        @opts.on_tail("-h", "--help",  "Show this message")   { print_help   }
+        @opts.on_tail("-d", "--debug", "Enable debug output") { enable_debug }
+      end
+
+      def run(argv)
+        $0 = "#{@name} #{argv.join(" ")}"
+        @handler.call(@options, @opts.permute!(argv))
+      rescue ArgumentError, OptionParser::InvalidOption => e
+        @opts.warn(e.message)
+
+        if @debug
+          puts ""
+          puts e.backtrace
+          puts ""
+        end
+
+        print_help
+      rescue Interrupt
+        exit 0
+      rescue => e
+        if @debug
+          puts ""
+          puts e.backtrace
+          puts ""
+        end
+
+        @opts.abort(e.message)
+      end
+
+      def to_proc
+        proc { |opts, args| run(args) }
+      end
+
+      private
+
+      def print_help
+        puts @opts
+        exit 1
+      end
+
+      def enable_debug
+        @debug = true
+      end
+    end
+  end
+end

data/lib/avalanche/cli/version.rb

@@ -0,0 +1,5 @@
+module Avalanche
+  module CLI
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: avalanche-cli
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Bulat Shakirzyanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A small command line interface library for quickly building cli apps.
+email:
+- mallluhuct@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- Rakefile
+- cli.gemspec
+- cli/application.rb
+- cli/command.rb
+- cli/version.rb
+- example/app
+- example/hello
+- lib/avalanche/cli.rb
+- lib/avalanche/cli/application.rb
+- lib/avalanche/cli/command.rb
+- lib/avalanche/cli/version.rb
+homepage: https://github.com/avalanche123/cli
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A small command line interface library for quickly building cli apps.
+test_files: []
+has_rdoc: