rclid 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Y2JkMTk5NGFmMzk1ODRlOWE1YjNhY2U0MzE4MGRmYmFhOTY2MWZkMw==
+  data.tar.gz: !binary |-
+    YmEwOTc3YTZjZDhhZWEyMTVhYmVmZjQ3OGY4ZTkyYzdhMGM3ZjRhOA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MjczYjJmZTBhZTk1M2FmN2JlMmI0MTliYWE3ZjE1YmMzYjU4NTkzOWRiYjk2
+    OTA3NGZmOTljOTFlMjZjNmNlODY2YjI1MDU2NjUxMDkzZmNkYzNmZTVjYjJk
+    OWMwY2ViZTZiZjA5NzJhMTU1ZWU5M2QxOGI0MTI2MTI4MWY1NjM=
+  data.tar.gz: !binary |-
+    MTg0ZDUwNWM4OGFlNGMxNTM3NGM0YmQxZWU1Y2I5MTA4YTQ1MWJiZWY0OTg2
+    MzdiNzBlYjJhNmQ0NGYxOTNmMmU2ZWFhODJiMDgzODk2ZGM0Y2RjZjJjMGNl
+    Njc0ODRjZDg3ODhlNmNkMWQ2MGRhMWRiODk2ODU0YTEyN2UxMDc=

data/.buildpath

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<buildpath>
+	<buildpathentry kind="src" path=""/>
+	<buildpathentry kind="con" path="org.eclipse.dltk.launching.INTERPRETER_CONTAINER"/>
+</buildpath>

data/.project

@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>rclid</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.dltk.core.scriptbuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.dltk.ruby.core.nature</nature>
+	</natures>
+</projectDescription>

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Matthieu Vachon
+
+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,75 @@
+# Rclid
+
+The name **Rclid** stands for **Rapid Command Line Interface Development** and
+is pronounced the way you like.
+
+As its name implies, the goal of this gem is to provide you with a light
+structure to create command line interfaces like a breeze.
+
+Focusing on rapid development, creating basic single command line application
+or a more complex one using composite sub commands is achieve in light speed.
+
+If you have ideas that would reduce even more development time and could
+be that this library, come discuss it with me by creating an issue on
+github.com.
+
+## Installation
+
+Install it via [rubygems](https://rubygems.org/gems/rclid)
+
+    $ gem install rclid
+
+## Usage
+
+**Rclid** is really to get started with. The simplest command line
+application is like the following (file `hello`):
+
+```ruby
+#!/usr/bin/env
+require 'rclid/base'
+
+class Hello < Rclid::Base
+  def execute()
+    puts "Hello, World!"
+  end
+end
+
+Hello.new().run()
+```
+
+This will create a command line application that will print `Hello, World!`
+in the console when `hello` is called.
+
+Until I improve this section, there is different locations where
+you can check for samples that use **Rclid**
+
+ * The samples directory contains some samples ruby files that
+   use **Rclid**. They are commented at different locations to
+   explain the features that you can use.
+
+ * [Buildozer](https://github.com/maoueh/buildozer) is using **Rclid** for its
+   command line interface. Check
+   [here](https://github.com/maoueh/buildozer/blob/master/lib/buildozer/cli/root.rb).
+
+ * [Clivers](https://github.com/maoueh/clivers) is using **Rclid** for its
+   command line interface. Check
+   [here](https://github.com/maoueh/clivers/blob/master/lib/clivers/cli/root.rb).
+
+ * My [personal bin](https://github.com/maoueh/personalbin) is on github. I use **Rclid**
+   for each command I create.
+
+## Contributing
+
+1. Fork it
+
+2. Create either a fix branch or a feature branch
+ * `git checkout -b fix-(name-here)`
+ * `git checkout -b feature-(name-here)`
+
+3. Commit your changes
+ * `git commit -am 'Message describing the fix or feature'`
+
+4. Push the branch into your repo
+ * `git push origin feature-(name-here)`
+
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |task|
+  task.test_files = FileList['test/**/test*.rb']
+end
+
+desc "Run tests"
+task :default => :test

data/lib/rclid.rb

@@ -0,0 +1,2 @@
+module Rclid
+end

data/lib/rclid/base.rb

@@ -0,0 +1,138 @@
+require 'optparse'
+
+require 'rclid/helper/string'
+
+module Rclid
+  class Base
+    @@MAX_WIDTH = 70
+
+    def initialize(arguments = ARGV, options = {})
+      @arguments = arguments
+    end
+
+    ##
+    # Specify the name of the command. Used as the default
+    # name when usage is not defined. So with this, it is
+    # possible to just specify a command name and then
+    # let base class handles the rest.
+    def name()
+      self.class.name.split("::").last().downcase()
+    end
+
+    ##
+    # Specify the description of this command.
+    # Overriding classes just need to return a
+    # string that will be output to terminal
+    # as-is. No formatting occurs.
+    def usage()
+      "Usage: #{name()} (options)"
+    end
+
+    ##
+    # Specify the description of this command.
+    # Overriding classes just need to return a
+    # string that will be formatted correctly
+    # for the terminal.
+    #
+    # Return nil if you dont want a description,
+    # this is the default.
+    def description()
+      nil
+    end
+
+    ##
+    # Specify the tail of this command.
+    # Overriding classes just need to return a
+    # string that will be formatted correctly
+    # for the terminal.
+    def tail()
+      "Available options:"
+    end
+
+    ##
+    # Specify additional arguments parse options
+    # Use OptoinParser syntax
+    def options(parser)
+      parser.on_tail("-h", "--help", "Show help") do
+        help()
+      end
+    end
+
+    ##
+    # This is the method that will be invoked to
+    # execute the cli command task.
+    def execute()
+    end
+
+    ##
+    # Show command help for this instance and exit
+    # with code 0.
+    def help()
+      puts @parser
+      exit(0)
+    end
+
+    ##
+    # Print an error message followed by the parser
+    # help.
+    def error(message)
+      puts "ERROR: #{message}"
+      puts ""
+
+      help()
+    end
+
+    def run()
+      @parser = parser()
+      @arguments = parser.parse(@arguments)
+
+      execute()
+    end
+
+    def parser()
+      return @parser if @parser
+
+      parser = OptionParser.new()
+
+      set_usage(parser)
+      set_description(parser)
+
+      options(parser)
+
+      set_tail(parser)
+      parser
+    end
+
+    def set_usage(parser)
+      parser.banner = usage()
+    end
+
+    def set_description(parser)
+      set_text(description(), parser,
+        :prepend_newline => true,
+        :max_width => @@MAX_WIDTH
+      )
+    end
+
+    def set_tail(parser)
+      set_text(tail(), parser,
+        :prepend_newline => true,
+        :max_width => @@MAX_WIDTH
+      )
+    end
+
+    def set_text(text, parser, options = {})
+      return if not text
+
+      parser.separator("") if options[:prepend_newline]
+
+      lines = text
+      lines = Helper::String::format_text(text, :max_width => options[:max_width]) if not lines.kind_of?(Array)
+      lines.each do |line|
+        parser.separator(line)
+      end
+
+      parser.separator("") if options[:append_newline]
+    end
+  end
+end

data/lib/rclid/composite.rb

@@ -0,0 +1,74 @@
+require 'rclid/base'
+
+module Rclid
+  class Composite < Base
+    def initialize(arguments = ARGV)
+      super(arguments)
+
+      @subcommands = subcommands()
+      @arguments, @command, @subarguments = split_arguments(arguments)
+
+      raise "You must provide at least one subcommand in #{self.class}" if !@subcommands || @subcommands.empty?()
+    end
+
+    ##
+    # Default implementation of description for composite
+    # commands.
+    def description()
+      lines = ["Available subcommands:", ""]
+
+      @subcommands.keys().sort().each do |key|
+        lines << "     #{key}"
+      end
+
+      lines
+    end
+
+    ##
+    # Method to be overriden in child classes to specify
+    # the map of subcommands available to the user.
+    #
+    # The key of the map is a symbol reprensenting the
+    # command name and the value is a constant representing
+    # the class to instantiate when the command name is used
+    # by the user.
+    #
+    # For example:
+    #   { :build => Namespace::Build, :destroy => Namespace::Destroy }
+    #
+    def subcommands()
+      {}
+    end
+
+    def run()
+      @parser = parser()
+      @arguments = parser.parse(@arguments)
+
+      return help() if not @command
+
+      command_class = @subcommands[@command.to_sym]
+      return error("The command #{@command} does not exist") if not command_class
+
+      command_class.new(@subarguments).run()
+    end
+
+    def split_arguments(arguments)
+      main_arguments = arguments
+      command = nil
+      sub_arguments = []
+      subcommands = @subcommands.map {|key, classname| key.to_s()}
+
+      arguments.each_index do |i|
+        if subcommands.include?(arguments[i])
+          main_arguments = arguments[0, i]
+          command = arguments[i]
+          sub_arguments = arguments[i + 1, arguments.length - i + 1]
+
+          break
+        end
+      end
+
+      return [main_arguments, command, sub_arguments]
+    end
+  end
+end

data/lib/rclid/helper/string.rb

@@ -0,0 +1,75 @@
+module Rclid
+  module Helper
+    module String
+      def self.camelize(input)
+        return nil if not input
+
+        parts = input.split(/_/).map do |part|
+          part.capitalize()
+        end
+
+        parts.join("")
+      end
+
+      def self.format_text(text, options = {})
+        tokens = tokenize(text)
+        tokens_to_lines(tokens, options)
+      end
+
+      def self.tokenize(text)
+        text.scan(/([^\s]+)|(\n\r|\n|\r)|(\s+)/).map do |word, newline, space|
+          case
+          when word
+            { :text => word, :type => :word }
+          when newline
+            { :text => newline, :type => :newline }
+          when space && space =~ /^\s*$/
+            { :text => space, :type => :space }
+          end
+        end
+      end
+
+      def self.tokens_to_lines(tokens, options = {})
+        max_width = options[:max_width] || 80;
+        indentation = options[:indentation] || ""
+        preserve_paragraphs = options[:preserve_paragraphs] == nil ? true : options[:preserve_paragraphs]
+
+        lines = []
+        buffer = indentation
+
+        newline_count = 0
+        tokens.each do |token|
+          type = token[:type]
+          if type == :newline
+            newline_count += 1
+            next
+          end
+
+          if preserve_paragraphs and newline_count > 1
+            for i in 1..newline_count
+              lines << normalize_line(buffer)
+              buffer = indentation
+            end
+          end
+
+          newline_count = 0;
+          text = type == :space ? " " : token[:text]
+          potential_width = text.length() + buffer.length()
+          if potential_width > max_width
+            lines << normalize_line(buffer)
+            buffer = indentation
+          end
+
+          buffer += text
+        end
+
+        lines << normalize_line(buffer)
+        lines
+      end
+
+      def self.normalize_line(line, options = {})
+        line.strip()
+      end
+    end
+  end
+end

data/lib/rclid/version.rb

@@ -0,0 +1,3 @@
+module Rclid
+  VERSION = "1.0.0"
+end

data/rclid.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rclid/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "rclid"
+  gem.version       = Rclid::VERSION
+  gem.authors       = ["Matthieu Vachon"]
+  gem.email         = ["matthieu.o.vachon@gmail.com"]
+  gem.summary       = "Rapid Command Line Interface Development library"
+  gem.description = <<-EOS
+    As its name implies, the goal of this gem is to provide you with a light
+    structure to create command line interfaces like a breeze.
+
+    Focusing on rapid development, creating basic single command line application
+    or a more complex one using composite subcommands is achieve in light speed.
+
+    If you have ideas that would reduce even more development time and could
+    be that this library, come discuss it with me by creating an issue on
+    github.com.
+  EOS
+
+  gem.homepage      = "https://github.com/maoueh/rclid"
+  gem.license       = "MIT"
+
+  gem.files         = `git ls-files`.split($/) - [".gitattributes", ".gitignore"]
+  gem.test_files    = gem.files.grep(%r{^(test|gem|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler", "~> 1.3"
+  gem.add_development_dependency "rake"
+end

data/samples/base/hello_world.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'rclid/base'
+
+class Hello < Rclid::Base
+  def execute()
+    name = @arguments[0] || "World!"
+
+    puts "Hello, #{name}"
+  end
+end
+
+Hello.new().run()

data/samples/composite/hello/hello.rb

@@ -0,0 +1,7 @@
+require 'rclid/base'
+
+class Hello < Rclid::Base
+  def execute()
+    puts "Hello, Subcommand!"
+  end
+end

data/samples/composite/hello/root.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'rclid/composite'
+
+require_relative 'hello'
+require_relative 'world'
+
+# You extend Rclid::Composite to create a composite command
+class Root < Rclid::Composite
+  def name()
+    # Usually, it would be your application name
+    # (like `clivers` or `nugrant` for example).
+    "composite"
+  end
+
+  def subcommands()
+    # Return the hash symbol -> Class that
+    # represents the sub commands that can
+    # be called from this composite. This is
+    # required.
+    {
+      :hello => Hello,
+      :world => World,
+    }
+  end
+
+  def options(parser)
+    super(parser)
+    parser.on_tail("-v", "--version", "Show version") do
+      version()
+    end
+  end
+
+  def version()
+    # Usually, it would be your application version
+    puts "Composite #{Rclid::VERSION}"
+    exit(0)
+  end
+end
+
+# Only the root needs to be run
+# So this lines must not be added
+# to the subcommands
+Root.new().run()

data/samples/composite/hello/world.rb

@@ -0,0 +1,9 @@
+require 'rclid/base'
+
+class World < Rclid::Base
+  def execute()
+    name = @arguments[0] || "World!"
+
+    puts "Hello, #{name}!"
+  end
+end

data/test/lib/rclid/helper/test_string.rb

@@ -0,0 +1,91 @@
+require 'test/unit'
+
+require 'rclid/helper/string'
+
+module Rclid
+  module Helper
+    class TestString < Test::Unit::TestCase
+      def test_camelize()
+        assert_equal(nil, nil)
+        assert_equal("", Helper::String.camelize(""))
+        assert_equal("Simple", Helper::String.camelize("simple"))
+        assert_equal("SimpleComplex", Helper::String.camelize("simple_complex"))
+        assert_equal("SimpleComplex", Helper::String.camelize("simple_complex"))
+      end
+
+      def test_tokenize()
+        text = "  first second "
+        tokens = Helper::String.tokenize(text)
+
+        assert_equal([
+          { :text => "  ", :type => :space},
+          { :text => "first", :type => :word},
+          { :text => " ", :type => :space},
+          { :text => "second", :type => :word},
+          { :text => " ", :type => :space}], tokens)
+      end
+
+      def test_tokenize_with_line_breaks()
+        text = <<-EOC
+          first
+            second
+          third
+        EOC
+        tokens = Helper::String.tokenize(text)
+
+        assert_equal([
+          {:text => "          ", :type => :space},
+          {:text => "first", :type => :word},
+          {:text=>"\n", :type=>:newline},
+          {:text => "            ", :type => :space},
+          {:text => "second", :type => :word},
+          {:text=>"\n", :type=>:newline},
+          {:text => "          ", :type => :space},
+          {:text => "third", :type => :word},
+          {:text=>"\n", :type=>:newline},
+        ], tokens)
+      end
+
+      def test_format_text_simple()
+        text = <<-EOC
+            Donec ornare consectetur ante non porttitor. Lorem ipsum dolor
+            sit amet, consectetur adipiscing elit. Ut consequat lacinia ero.
+        EOC
+
+        assert_equal([
+          "Donec ornare consectetur ante non",
+          "porttitor. Lorem ipsum dolor sit amet,",
+          "consectetur adipiscing elit. Ut",
+          "consequat lacinia ero."
+        ], Helper::String.format_text(text, :max_width => 40))
+      end
+
+      def test_format_text_advanced()
+        text = <<-EOC
+                  Lorem ipsum dolor sit amet,
+      consectetur adipiscing elit. Nam egestas "feugiat" quam sed vehicula. Integer placerat;
+
+      odio
+      in condimentum pretium. Nullam at porta lacus, non euismod purus.
+      Donec ornare consectetur ante non porttitor. Lorem ipsum dolor
+
+
+
+      sit amet, consectetur adipiscing elit. Ut consequat lacinia ero.
+        EOC
+
+        assert_equal([
+          "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam egestas \"feugiat\"",
+          "quam sed vehicula. Integer placerat;",
+          "",
+          "odio in condimentum pretium. Nullam at porta lacus, non euismod purus. Donec",
+          "ornare consectetur ante non porttitor. Lorem ipsum dolor",
+          "",
+          "",
+          "",
+          "sit amet, consectetur adipiscing elit. Ut consequat lacinia ero.",
+        ], Helper::String.format_text(text, :max_width => 80))
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: rclid
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Matthieu Vachon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "    As its name implies, the goal of this gem is to provide you with
+  a light\n    structure to create command line interfaces like a breeze.\n\n    Focusing
+  on rapid development, creating basic single command line application\n    or a more
+  complex one using composite subcommands is achieve in light speed.\n\n    If you
+  have ideas that would reduce even more development time and could\n    be that this
+  library, come discuss it with me by creating an issue on\n    github.com.\n"
+email:
+- matthieu.o.vachon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .buildpath
+- .project
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rclid.rb
+- lib/rclid/base.rb
+- lib/rclid/composite.rb
+- lib/rclid/helper/string.rb
+- lib/rclid/version.rb
+- rclid.gemspec
+- samples/base/hello_world.rb
+- samples/composite/hello/hello.rb
+- samples/composite/hello/root.rb
+- samples/composite/hello/world.rb
+- test/lib/rclid/helper/test_string.rb
+homepage: https://github.com/maoueh/rclid
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Rapid Command Line Interface Development library
+test_files:
+- test/lib/rclid/helper/test_string.rb