clik 0.1.0

data/.index

@@ -0,0 +1,69 @@
+---
+revision: 2013
+type: ruby
+sources:
+- var
+authors:
+- name: Trans
+  email: transfire@gmail.com
+organizations:
+- name: Rubyworks
+requirements:
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - build
+  development: true
+  name: ergo
+- groups:
+  - test
+  development: true
+  name: qed
+- groups:
+  - test
+  development: true
+  name: ae
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/clik
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/clik
+  label: Source Code
+- type: docs
+  uri: http://rubydoc.info/gems/clik
+  label: Documentation
+- type: wiki
+  uri: http://wiki.github.com/rubyworks/clik
+  label: User Guide
+- type: bugs
+  uri: http://github.com/rubyworks/clik/issues
+  label: Issue Tracker
+- type: mail
+  uri: http://groups.google.com/group/rubyworks-mailinglist
+  label: Mailing List
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/clik.git
+categories: []
+copyrights:
+- holder: Rubyworks
+  year: '2013'
+  license: BSD-2-Clause
+customs: []
+paths:
+  lib:
+  - lib
+created: '2013-01-01'
+summary: Command-line Interface in the Kernel
+title: CLI.K
+version: 0.1.0
+name: clik
+description: ! "CLI.K stands for Command Line Interface in the Kernel. It provides
+  a very \nsimple `cli` method for parsing command line options."
+date: '2013-03-07'

data/HISTORY.md

@@ -0,0 +1,9 @@
+# RELEASE HISTORY
+
+## 0.1.0 / 2013-02-10
+
+This is this is the first release of CLI.K. Happy releaseday!
+
+Changes:
+
+* All of them ;)

data/LICENSE.txt

@@ -0,0 +1,23 @@
+(BSD-2-Clause License)
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+
+   2. Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
+FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR  SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/NOTICE.txt

@@ -0,0 +1,22 @@
+CLI.K is based on Clap by Michel Martens
+
+Copyright (c) 2010 Michel Martens
+
+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,93 @@
+# CLI.K
+
+[Website](http://rubyworks.github.com/clik) /
+[Documentation](http://rubydoc.info/gems/clik/frames) /
+[Report Issue](http://github.com/rubyworks/clik/issues) /
+[Source Code](http://github.com/rubyworks/clik)    
+[![Build Status](https://travis-ci.org/rubyworks/clik.png)](https://travis-ci.org/rubyworks/clik)
+[![Gem Version](https://badge.fury.io/rb/clik.png)](http://badge.fury.io/rb/clik)
+
+
+## About
+
+CLI.K stands for Command Line Interface in the Kernel. It provides a very 
+simple `cli` method for parsing command line options.
+
+
+## Usage
+
+### They call it "K.I.S.S."
+
+Usage is very straightforward, although it might look a little odd at first
+glance:
+
+```ruby
+  require 'clik'
+
+  cli '-f --file'  => lambda{ |f| @file = f },
+      '-d --debug' => lambda{ $DEBUG = true },
+      '-h --help'  => lambda{ show_help }
+```
+
+There's very little to it really. The `cli` command simply maps command
+line options to procedures which are used to process them. That's it.
+
+In our example, notice that `-w` and `--whatever` are easily defined as 
+synonymous options. Simple. Then notice that the `-f/--file` option's
+procedure takes an argument, so the command line option takes an argument 
+as well. Again simple.
+
+The cli method has a few additional niceties. It can handle run-on flags,
+i.e. `-abc` is the same as `-a -b -c`. And you can pass it an alternate
+set of arguments to parse, as the first argument, to use something other 
+than the default `ARGV`.
+
+```ruby
+  argv = ['--testing']
+
+  cli argv,
+    ...
+```
+
+### You need help, no you really don't
+
+At this point, you might be wonder about help output. Clearly there are
+no descriptions given in our example. Well, guess what! It's really easy
+to print something out yourself. In fact, if you really want to *do it right*,
+create a manpage with [ronn](git://github.com/rtomayko/ronn.git) or
+[md2man](https://github.com/sunaku/md2man), and impress your friends.
+It's a much better approach then jamming all that verbiage into you command
+line options parser code.
+
+### Ask and you shell receive
+
+In addition to `cli` CLI.K include the `ask` method. This is a very simple
+command line query method.
+
+    ans = ask "Are you nice? [Y/N]"
+
+Other Ruby libraries have their own take on the #ask method, and this very
+simple implementation can just as soon be overridden. No biggy. But it's nice
+to have for simple use cases.
+
+
+## Acknowledgments
+
+We have to give credit where credit is due. This interface is the great 
+achievement of Michel Martens, who created the original [Clap](https://github.com/soveran/clap)
+library from which CLI.K evolved. Mr. Martens deserves high praise for this
+design. It's not easy to realize that this level of simplicity is all one
+really needs! Thank you, Michel!
+
+
+## Copyrights & License
+
+CLI.K is copyrighted open-source software.
+
+    Copyright (c) 2013 Rubyworks
+
+CLI.K is base on Michel Marten's Clap library.
+
+    Copyright (c) 2010 Michel Martens
+
+See LICENSE.txt and NOTICE.txt files for details.

data/demo/applique/req.rb

@@ -0,0 +1,2 @@
+require 'ae'
+require 'clik'

data/demo/clik.md

@@ -0,0 +1,25 @@
+# CLI.K
+
+CLI.K provides a kernel method.
+
+    opts = {}
+    argv = ['-x']
+
+    cli argv,
+      '-x' => lambda{ opts[:x] = true }
+
+    opts[:x].assert === true
+
+Another example,
+
+    opts = {}
+    argv = ['-w', '-f', 'hello']
+
+    cli argv,
+      '-w --whatever' => ->{ opts[:w] = true },
+      '-f --file'     => ->(f){ opts[:f] = f },
+      '-h --help'     => ->{ puts "help" }
+
+    opts[:w].assert == true
+    opts[:f].assert == 'hello'
+

data/lib/clik.rb

@@ -0,0 +1,56 @@
+module Kernel
+  private
+  #
+  # CLI is based on Clap library
+  # Copyright (c) 2010 Michel Martens
+  #
+  def cli(*args)
+    opts = args.pop
+    argv = (args.first || ARGV).dup
+    args = []
+
+    # Split option aliases.
+    opts = opts.inject({}) do |h,(k,v)|
+      k.to_s.split(/\s+/).each{|o| h[o]=v}; h
+    end
+
+    # Convert single dash flags into multiple flags.
+    argv = argv.inject([]) do |a, v|
+      if v[0,1] == '-' && v[1,1] != '-'
+        a.concat(v[1..-1].chars.map{|c| "-#{c}"})
+      else
+        a << v
+      end
+      a
+    end
+
+    while argv.any?
+      item = argv.shift
+      flag = opts[item]
+
+      if flag
+        # Work around lambda semantics in 1.8.7.
+        arity = [flag.arity, 0].max
+
+        # Raise if there are not enough parameters
+        # available for the flag.
+        if argv.size < arity
+          raise ArgumentError
+        end
+
+        # Call the lambda with N items from argv,
+        # where N is the lambda's arity.
+        flag.call(*argv.shift(arity))
+      else
+
+        # Collect the items that don't correspond to
+        # flags.
+        args << item
+      end
+    end
+
+    # TODO: should we replace the argv given with args?
+
+    args
+  end
+end

data/lib/clik.yml

@@ -0,0 +1,69 @@
+---
+revision: 2013
+type: ruby
+sources:
+- var
+authors:
+- name: Trans
+  email: transfire@gmail.com
+organizations:
+- name: Rubyworks
+requirements:
+- groups:
+  - build
+  development: true
+  name: detroit
+- groups:
+  - build
+  development: true
+  name: ergo
+- groups:
+  - test
+  development: true
+  name: qed
+- groups:
+  - test
+  development: true
+  name: ae
+conflicts: []
+alternatives: []
+resources:
+- type: home
+  uri: http://rubyworks.github.com/clik
+  label: Homepage
+- type: code
+  uri: http://github.com/rubyworks/clik
+  label: Source Code
+- type: docs
+  uri: http://rubydoc.info/gems/clik
+  label: Documentation
+- type: wiki
+  uri: http://wiki.github.com/rubyworks/clik
+  label: User Guide
+- type: bugs
+  uri: http://github.com/rubyworks/clik/issues
+  label: Issue Tracker
+- type: mail
+  uri: http://groups.google.com/group/rubyworks-mailinglist
+  label: Mailing List
+repositories:
+- name: upstream
+  scm: git
+  uri: git://github.com/rubyworks/clik.git
+categories: []
+copyrights:
+- holder: Rubyworks
+  year: '2013'
+  license: BSD-2-Clause
+customs: []
+paths:
+  lib:
+  - lib
+created: '2013-01-01'
+summary: Command-line Interface in the Kernel
+title: CLI.K
+version: 0.1.0
+name: clik
+description: ! "CLI.K stands for Command Line Interface in the Kernel. It provides
+  a very \nsimple `cli` method for parsing command line options."
+date: '2013-03-07'

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: clik
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Trans
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: detroit
+  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'
+- !ruby/object:Gem::Dependency
+  name: ergo
+  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'
+- !ruby/object:Gem::Dependency
+  name: qed
+  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'
+- !ruby/object:Gem::Dependency
+  name: ae
+  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: ! "CLI.K stands for Command Line Interface in the Kernel. It provides
+  a very \nsimple `cli` method for parsing command line options."
+email:
+- transfire@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- NOTICE.txt
+- HISTORY.md
+- README.md
+files:
+- .index
+- demo/applique/req.rb
+- demo/clik.md
+- lib/clik.yml
+- lib/clik.rb
+- LICENSE.txt
+- HISTORY.md
+- README.md
+- NOTICE.txt
+homepage: http://rubyworks.github.com/clik
+licenses:
+- BSD-2-Clause
+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.24
+signing_key: 
+specification_version: 3
+summary: Command-line Interface in the Kernel
+test_files: []
+has_rdoc: