command_line_helper 0.0.1

data/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in command_line_helper.gemspec
+gemspec
+
+group :development do
+  gem "guard"
+  gem "guard-bundler"
+  gem "guard-rspec"
+  gem "rb-fchange", :require => false
+  gem "rb-fsevent", :require => false
+  gem "rb-inotify", :require => false
+  gem "terminal-notifier-guard"
+end
+
+group :test do
+  gem "ci_reporter"
+  gem "rake"
+  gem "rspec"
+  gem "simplecov", :require => false
+  gem "simplecov-rcov"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Juan C. Müller
+
+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,70 @@
+# CommandLineHelper
+
+This helps other gems with their common CLI chores.
+
+At the moment, it generates a nice help output based on `options_possible` defined in the
+class that includes `CommandLineHelper::HelpText`.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'command_line_helper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install command_line_helper
+
+## Usage
+
+```ruby
+require 'command_line_helper'
+
+class CLI
+  include CommandLineHelper::HelpText
+
+  def do_something
+    puts help_info
+  end
+
+  private
+
+  def options_possible
+    [
+      ['--foo', '-f', GetoptLong::REQUIRED_ARGUMENT, "This option foo takes an argument"],
+      ['--bar', '-f', GetoptLong::NO_ARGUMENT, "This option bar does not take an argument"]
+    ]
+  end
+
+  def version_info
+    "This is version BLAH of this amazing package. (c) Someone Somewhere Today."
+  end
+
+end
+
+CLI.new.do_something
+```
+
+```bash
+$ ruby ./cli.rb
+Usage: cli.rb [options]
+  [--foo|-f argument], [--bar|-f]
+
+  Options:
+    --foo, -f   This option foo takes an argument
+    --bar, -f   This option bar does not take an argument
+
+This is version BLAH of this amazing package. (c) Someone Somewhere Today.
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,23 @@
+#!/usr/bin/env rake
+
+$:.push File.expand_path("../lib", __FILE__)
+
+require "rspec/core/rake_task"
+require "command_line_helper/version"
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = "spec/**/*_spec.rb"
+  spec.rspec_opts = ["--backtrace --format CI::Reporter::RSpec"]
+end
+
+desc "Clean backup and swap files, and artifacts"
+task :clean do
+  require "fileutils"
+  Dir["{pkg/*,**/*~,**/.*.sw?,coverage/**,spec/reports/**}"].each do |file|
+    rm_rf file
+  end
+end
+
+desc "Run rspec by default"
+task :default => :spec

data/command_line_helper.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/command_line_helper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Juan C. Müller"]
+  gem.email         = ["jcmuller@gmail.com"]
+  gem.description   = %q{Helper for CLI apps.}
+  gem.summary       = %q{This library provides a module that helps with some common CLI tasks (mainly showing help texts and options)}
+  gem.homepage      = ""
+
+  gem.files         = Dir["lib/**/*"] +
+    %w(command_line_helper.gemspec Gemfile LICENSE Rakefile README.md)
+  gem.executables   = []
+  gem.test_files    = Dir["spec/**/*"]
+  gem.name          = "command_line_helper"
+  gem.require_paths = ["lib"]
+  gem.version       = CommandLineHelper::VERSION
+
+  gem.add_dependency("activesupport")
+end

data/lib/command_line_helper.rb

@@ -0,0 +1,8 @@
+require "rubygems"
+require "getoptlong"
+
+module CommandLineHelper
+  autoload :HelpText, 'command_line_helper/help_text'
+  autoload :ProgramName, 'command_line_helper/program_name'
+  autoload :VERSION, 'command_line_helper/version'
+end

data/lib/command_line_helper.rb~

@@ -0,0 +1,8 @@
+require "rubygems"
+require "getoptlong"
+
+module CommandLineHelper
+  autoload :Help, 'command_line_helper/help'
+  autoload :ProgramName, 'command_line_helper/program_name'
+  autoload :VERSION, 'command_line_helper/version'
+end

data/lib/command_line_helper/base.rb~

@@ -0,0 +1,70 @@
+# TODO Check for definition of options_possible
+require 'active_support/concern'
+
+module CommandLineHelper
+  # Depends on:
+  # * version_info (simply defined to return __PACKAGE__::VERSION)
+  # * options_possible
+  #     [ ['--option', '-o', GetoptLong::OPTION_TYPE, 'Helpful message'], ... ]
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def program_name
+      @program_name = File.basename($0)
+    end
+  end
+
+  # Help information that is constructed from the options_possible defined
+  #
+  # Returns the help text
+  def help_info
+    <<-EOH
+Usage: #{program_name} [options]
+  #{short_hand_options}
+
+  Options:
+#{option_details}
+#{version_info}
+    EOH
+  end
+
+  def version_info
+    VERSION
+  end
+
+  def program_name
+    self.class.program_name
+  end
+
+  private
+
+  def options_possible
+    raise %{Must override this with something like [ ['--option', '-o', GetoptLong::OPTION_TYPE, 'Helpful message'], ... ]}
+  end
+
+  def option_details
+    <<-EOO
+#{options_possible.map{ |o| expand_option(o) }.join("\n")}
+    EOO
+  end
+
+  def expand_option(option)
+    sprintf("    %-#{longest_width + 6}s %s", option.first(2).join(', '), option[3])
+  end
+
+  def longest_width
+    @max_width ||= options_possible.map{ |o| o[0] }.max{ |a, b| a.length <=> b.length }.length
+  end
+
+  def short_hand_options
+    "[#{options_possible.map{ |o| short_hand_option(o)}.join('], [')}]"
+  end
+
+  def short_hand_option(option)
+    if option[2] == GetoptLong::REQUIRED_ARGUMENT
+      [option[0], option[1]].join('|') << " argument"
+    else
+      [option[0], option[1]].join('|')
+    end
+  end
+end

data/lib/command_line_helper/help.rb~

@@ -0,0 +1,67 @@
+# TODO Check for definition of options_possible
+require 'active_support/concern'
+
+module CommandLineHelper
+  # Depends on:
+  # * version_info (simply defined to return __PACKAGE__::VERSION)
+  # * options_possible
+  #     [ ['--option', '-o', GetoptLong::OPTION_TYPE, 'Helpful message'], ... ]
+  module Help
+    extend ActiveSupport::Concern
+
+    included do
+      include CommandLineHelper::ProgramName
+    end
+
+    # Help information that is constructed from the options_possible defined
+    #
+    # Returns the help text
+    def help_info
+      <<-EOH
+Usage: #{program_name} [options]
+  #{short_hand_options}
+
+  Options:
+#{option_details}
+#{version_info}
+      EOH
+    end
+
+    def version_info
+      VERSION
+    end
+
+    private
+
+    def options_possible
+      raise %{Must override this with something like [ ['--option', '-o', GetoptLong::OPTION_TYPE, 'Helpful message'], ... ]}
+    end
+
+    def option_details
+      <<-EOO
+#{options_possible.map{ |o| expand_option(o) }.join("\n")}
+      EOO
+    end
+
+    def expand_option(option)
+      sprintf("    %-#{longest_width + 6}s %s", option.first(2).join(', '), option[3])
+    end
+
+    def longest_width
+      @max_width ||= options_possible.map{ |o| o[0] }.max{ |a, b| a.length <=> b.length }.length
+    end
+
+    def short_hand_options
+      "[#{options_possible.map{ |o| short_hand_option(o)}.join('], [')}]"
+    end
+
+    def short_hand_option(option)
+      if option[2] == GetoptLong::REQUIRED_ARGUMENT
+        [option[0], option[1]].join('|') << " argument"
+      else
+        [option[0], option[1]].join('|')
+      end
+    end
+
+  end
+end

data/lib/command_line_helper/help_text.rb

@@ -0,0 +1,67 @@
+# TODO Check for definition of options_possible
+require 'active_support/concern'
+
+module CommandLineHelper
+  # Depends on:
+  # * version_info (simply defined to return __PACKAGE__::VERSION)
+  # * options_possible
+  #     [ ['--option', '-o', GetoptLong::OPTION_TYPE, 'Helpful message'], ... ]
+  module HelpText
+    extend ActiveSupport::Concern
+
+    included do
+      include CommandLineHelper::ProgramName
+    end
+
+    # Help information that is constructed from the options_possible defined
+    #
+    # Returns the help text
+    def help_info
+      <<-EOH
+Usage: #{program_name} [options]
+  #{short_hand_options}
+
+  Options:
+#{option_details}
+#{version_info}
+      EOH
+    end
+
+    def version_info
+      VERSION
+    end
+
+    private
+
+    def options_possible
+      raise %{Must override this with something like [ ['--option', '-o', GetoptLong::OPTION_TYPE, 'Helpful message'], ... ]}
+    end
+
+    def option_details
+      <<-EOO
+#{options_possible.map{ |o| expand_option(o) }.join("\n")}
+      EOO
+    end
+
+    def expand_option(option)
+      sprintf("    %-#{longest_width + 6}s %s", option.first(2).join(', '), option[3])
+    end
+
+    def longest_width
+      @max_width ||= options_possible.map{ |o| o[0] }.max{ |a, b| a.length <=> b.length }.length
+    end
+
+    def short_hand_options
+      "[#{options_possible.map{ |o| short_hand_option(o)}.join('], [')}]"
+    end
+
+    def short_hand_option(option)
+      if option[2] == GetoptLong::REQUIRED_ARGUMENT
+        [option[0], option[1]].join('|') << " argument"
+      else
+        [option[0], option[1]].join('|')
+      end
+    end
+
+  end
+end

data/lib/command_line_helper/helper.rb~

@@ -0,0 +1,59 @@
+# TODO Check for definition of options_possible
+#require 'active_support/concern'
+
+module CommandLineHelper
+  module Helper
+    # Provides:
+    #     * Requires on options_possible to be defined and return an array of the form:
+    #       [ ['--option', '-o', GetoptLong::OPTION_TYPE, 'Helpful message'], ... ]
+    #   - help_info
+    #   - program_name
+    #   - short_hand_options (used inside help_info)
+    #   - option_details (used inside help_info)
+    #   - longest_width
+    #   - expand_option
+    #
+    #
+    def help_info
+      <<-EOH
+Usage: #{program_name} [options]
+  #{short_hand_options}
+
+  Options:
+#{option_details}
+#{version_info}
+      EOH
+    end
+
+    def program_name
+      @@program_name = File.basename($0)
+    end
+
+    def short_hand_options
+      "[#{options_possible.map{ |o| short_hand_option(o)}.join('], [')}]"
+    end
+
+    def short_hand_option(option)
+      if option[2] == GetoptLong::REQUIRED_ARGUMENT
+        [option[0], option[1]].join('|') << " argument"
+      else
+        [option[0], option[1]].join('|')
+      end
+    end
+
+    def option_details
+      <<-EOO
+#{options_possible.map{ |o| expand_option(o) }.join("\n")}
+      EOO
+    end
+
+    def longest_width
+      @max_width ||= options_possible.map{ |o| o[0] }.max{ |a, b| a.length <=> b.length }.length
+    end
+
+    def expand_option(option)
+      sprintf("    %-#{longest_width + 6}s %s", option.first(2).join(', '), option[3])
+    end
+
+  end
+end