salish 0.0.2.dev

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in salish.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 shitake
+
+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,77 @@
+# Salish
+
+一个类似 `commander` 的ruby的命令行工具。用于快速生成命令。支持多级子命令创建。
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'salish'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install salish
+
+## Usage
+#### 载入库并创建命令
+````
+require 'salish'
+cmd_obj = Salish.cmd
+````
+
+#### 设置版本信息
+````
+cmd_obj.version('0.0.1')
+````
+#### 编写帮助信息(可选)
+````
+cmd_obj.help do |help|
+  #设置帮助的标题
+  help.title = ''
+  #设置帮助的主体
+  help.body = ''
+  #设置帮助的尾部
+  help.footer = ''
+````
+子命令及参数的帮助会自动生成。关于帮助输出的顺序是：
+    
+    title -> body -> 子命令和参数 -> footer
+
+#### 设置option(可选、任意数目)
+````
+cmd_obj.option(options, info, <param_info>, <&block>)
+````
+options(`string`)：描述短参数及长参数，会出现在自动生成的帮助信息里。
+info(`string`)：参数的描述信息。会出现在自动生成的帮助信息里。
+param_info(`string`)：固定参数描述。格式为： `param__type:param__name` ,多个参数用 `,` 分开。
+block(`proc`)：该参数执行的相应动作。如果有固定参数，则可以通过 `do |param| ... end` 的形式来获得。`param` 为一个哈希表，键为 `param_info` 里的 `param__name`，类型为 `symbol`。
+
+#### 设置子命令(可选、任意数目)
+````
+cmd_obj.command(cmd_name, info, version)
+````
+cmd_name(`string`)：子命令名
+info(`string`)：子命令说明，该说明会出现在父命令自动生成的帮助信息里。
+version(`string`)：可选，不填写时，版本信息等同于父命令。
+
+#### 解析命令
+````
+cmd_obj.parse(ARGV)
+````
+请确保该方法最后调用。处于该方法之后添加的命令/参数等无效。
+
+### 注意事项
+1. 对于 `version`/`option`/`help` 这些方法来说，最后的返回值均为对象本身。而 `command` 会返回创建的子命令对象。
+2. 如果 `version` 的调用在 `command` 之后，创建子命令时如果不传入版本参数，这时版本信息会出错（父命令的版本信息为空字符串）。
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

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

data/lib/salish.rb

@@ -0,0 +1,17 @@
+#encoding: utf-8
+#author: shitake
+#data: 16-3-26
+
+module Salish
+  require 'salish/help'
+  require 'salish/version'
+  require 'salish/command'
+  class << self
+
+    def version_str?(ver_str)
+      /\d*\.\d*\.\d*/ === ver_str
+    end
+
+  end
+
+end

data/lib/salish/command.rb

@@ -0,0 +1,151 @@
+#encoding: utf-8
+#author: shitake
+#data: 16-3-26
+
+class Salish::Command
+
+  attr_reader :name
+  attr_reader :commands
+  attr_reader :options
+  attr_accessor :parent
+  attr_accessor :description
+
+  def initialize(name = nil)
+    raise "Error: Command Name Error(#{name})!" unless name
+    @name = name
+    @help = Salish::Help.new(self)
+    @parent = self
+    @version = ''
+    @options = []
+    @commands = []
+    @description = ''
+    help_opt = {
+        :short => '-h',
+        :long => '--help',
+        :params => nil,
+        :description => 'Print help info',
+        :callback => lambda{ puts @help.to_string }
+    }
+    @options.push(help_opt)
+  end
+
+  def version(ver_str = nil)
+    return @version unless ver_str
+    raise "Error: Version Error(#{ver_str})!" unless Salish.version_str?(ver_str)
+    @version = ver_str
+    version_opt = {
+        :short => '-v',
+        :long => '--version',
+        :params => nil,
+        :description => 'Print version info',
+        :callback => lambda{ puts @version }
+    }
+    @options.push(version_opt)
+    self
+  end
+
+  def option(flags, description, params = nil, &callback)
+    list = []
+    flags.split(',').each{|flag| list << flag.strip}
+    flags_short = list[0]
+    flags_long = list[1]
+    if params
+      list = []
+      params.split(',').each do |param|
+        param = param.split(':')
+        if param.size == 2
+          type = param[0].strip
+          name = param[1].strip
+        else
+          type = 'string'
+          name = param[0].strip
+        end
+        list << {:type => type, :name => name}
+      end
+    else
+      list = nil
+    end
+    opt = {
+        :short => flags_short,
+        :long => flags_long,
+        :params => list,
+        :description => description,
+        :callback => callback
+    }
+    @options.push(opt)
+    self
+  end
+
+  def command(name, description, version = nil)
+    cmd = Salish::Command.new(name)
+    cmd.parent = self
+    cmd.description = description
+    cmd.version(version || @version)
+    @commands.push(cmd)
+    cmd
+  end
+
+  def help(&block)
+    yield @help
+    self
+  end
+
+  def parse(arvg)
+    opt = arvg[0]
+    param = arvg[1, arvg.size] || []
+    return call_opt('long', opt, param) if /--.*/ === opt
+    return call_opt('short', opt, param) if /-.*/ === opt
+    call_cmd(opt, param)
+  end
+
+  private
+  def call_opt(type, option, params)
+    @options.each do |opt|
+      opt_name = (type == 'long' ? opt[:long] : opt[:short])
+      if option == opt_name
+        if opt[:params]
+          return opt[:callback].call(opt_set_params(opt, params))
+        else
+
+          return opt[:callback].call
+        end
+      end
+    end
+    puts "ERROR: option error (#{option}) ! You can use -h or --help to get help info."
+    exit
+  end
+
+  def opt_set_params(opt, params)
+    param = {}
+    unless opt[:params].size <= params.size
+      puts "ERROR: wrong number of arguments (#{params.size} for #{opt[:params].size}) .\n#{opt[:short]}\s#{opt[:long]}\t#{opt[:description]}"
+      exit
+    end
+    opt[:params].each_with_index do |opt_par, i|
+      case opt_par[:type]
+        when 'string'
+          param[opt_par[:name].to_sym] = params[i]
+        when 'integer'
+          param[opt_par[:name].to_sym] = params[i].to_i
+        when 'float'
+          param[opt_par[:name].to_sym] = params[i].to_f
+        when 'symbol'
+          param[opt_par[:name].to_sym] = params[i].to_sym
+        else
+          raise "Error: Param Type Error(#{opt_par[:name]}:#{opt_par[:type]})!"
+      end
+    end
+    param
+  end
+
+  def call_cmd(command, arvg)
+    @commands.each do |cmd|
+      if command == cmd.name
+        return cmd.parse(arvg)
+      end
+    end
+    puts "ERROR: command not find (#{command}) ! You can use -h or --help to get help info."
+    exit
+  end
+
+end

data/lib/salish/help.rb

@@ -0,0 +1,60 @@
+#encoding: utf-8
+#author: shitake
+#data: 16-3-27
+
+class Salish::Help
+
+  attr_writer :title
+  attr_writer :body
+  attr_writer :footer
+
+  def initialize(obj)
+    @obj = obj
+    @title = @obj.name
+    @body = ''
+    @footer = ''
+  end
+
+  def title
+    @title != '' ? "#{@title}\n\n" : ''
+  end
+
+  def body
+    @body != '' ? "#{@body}\n\n" : ''
+  end
+
+  def footer
+    @footer != '' ? "#{@footer}\n\n" : ''
+  end
+
+  def parameters
+
+    if @obj.commands != []
+      obj = @obj.commands.max_by{ |o| o.name.size }
+      @commands = "command:\n"
+      @obj.commands.each do |cmd|
+        space = "\s" * (obj.name.size + 6 - cmd.name.size)
+        @commands += "\s\s#{cmd.name}#{space}\s#{cmd.description}\n"
+      end
+    else
+      @commands = ''
+    end
+    if @obj.options != []
+      obj = @obj.options.max_by{ |o| (o[:short] + o[:long]).size }
+      size = (obj[:short] + obj[:long]).size
+      @options = "option:\n"
+      @obj.options.each do |opt|
+        space = "\s" * (size + 10 - ("\s\s" + opt[:short] + "\s" + opt[:long]).size)
+        @options += "\s\s#{opt[:short]}\s#{opt[:long]}#{space}\s#{opt[:description]}\n"
+      end
+    else
+      @options = ''
+    end
+    @commands + @options != '' ? "#{@commands}\n#{@options}\n" : ''
+  end
+
+  def to_string
+    title + body + parameters + footer
+  end
+
+end

data/lib/salish/version.rb

@@ -0,0 +1,4 @@
+module Salish
+  VERSION = '0.0.2.dev'
+end
+

data/salish.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'salish/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "salish"
+  spec.version       = Salish::VERSION
+  spec.authors       = ["shitake"]
+  spec.email         = ["z1522716486@hotmail.com"]
+  spec.description   = %q{Ruby command-line tool kit}
+  spec.summary       = %q{A Ruby command-line tool kit. Support for multiple subcommands created.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end
+

data/test/cmd_test.rb

@@ -0,0 +1,36 @@
+#encoding: utf-8
+#author: shitake
+#data: 16-3-26
+
+require "../lib/salish.rb"
+
+cmd = Salish::Command.new('test')
+cmd.version('1.0.1')
+
+cmd.help do |h|
+  h.body = '这是一个控制台命令的测试命令。你可以通过-h或者--help来查看帮助！'
+  h.footer = \
+  "用例:\n"\
+  "  载入模块:\n\trequire 'salish'\n"\
+  "  创建根命令:\n\tcmd = Salish.cmd\n"\
+  "  设置版本:\n\tcmd.version('1.1.1')\n"\
+  "  添加参数:\n\tcmd.option('-a, --add', '添加文件', 'string:path'){|param| puts '文件路径',param[:path] }\n"
+end
+
+cmd.option('-a, --add', '<s:path> 从指定路径载入文件。', 'string:path, string:file_name') do |param|
+  puts '文件路径：',param
+end
+
+cmd.option('-l, --list', '列出现有文件'){ puts "index.html\s\sconf.txt" }
+
+push = cmd.command('push', '上传文件')
+push.option('-a, --all', '是否上传全部') { puts '所有文件都已上传！' }
+
+#短参数测试
+cmd.parse(%w(-v))
+#长参数测试
+cmd.parse(%w'--add ssss sddsds')
+#帮助信息输出测试
+cmd.parse(%w(-h))
+#子命令测试
+cmd.parse(%w'push -h')

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: salish
+version: !ruby/object:Gem::Version
+  version: 0.0.2.dev
+  prerelease: 6
+platform: ruby
+authors:
+- shitake
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-26 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: Ruby command-line tool kit
+email:
+- z1522716486@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .idea/.name
+- .idea/encodings.xml
+- .idea/misc.xml
+- .idea/modules.xml
+- .idea/salish.iml
+- .idea/vcs.xml
+- .idea/workspace.xml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/salish.rb
+- lib/salish/command.rb
+- lib/salish/help.rb
+- lib/salish/version.rb
+- salish.gemspec
+- test/cmd_test.rb
+homepage: ''
+licenses:
+- MIT
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A Ruby command-line tool kit. Support for multiple subcommands created.
+test_files:
+- test/cmd_test.rb