cli_tool 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4420b2da040b6b7fb8f05664834fd7cc0d33cf14
+  data.tar.gz: 3ade50f54e87003b8111a9812c6d31502c598103
+SHA512:
+  metadata.gz: 65f885c50ac8668a209e9ef99197b78de9afce9932f225503b3f82cb4a11e756fc284fb326c41c4e000379e3ece271cbe9f1367bbe5397c3613d37f01119e58e
+  data.tar.gz: db5e0aae0a5c47c6966f241bb92b29751e5c8e240c9da7aee4d197d71a2b225a8d148e6015a562af4740a834c433279f88e93a5ea95b93bcbe464e6df08c725e

data/.gitignore

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

data/.pryrc

@@ -0,0 +1,4 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cli_tool'

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Kelly Becker
+
+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,107 @@
+# CliTool
+
+Have trouble with advanced command line options, software dependency presence validation, handling inputs, confirmations and colorizing? Then this gem is for you. It provides you with some modules you can include to add those specific features.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cli_tool'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cli_tool
+
+## Usage
+
+**To include the GetoptLong option parser:**
+
+``` ruby
+include CliTool::OptionParser
+```
+
+You can then define command line arguments using the following class method.
+
+```ruby
+class New
+  include CliTool::OptionParser
+
+  options {
+    :log => :required,
+    [:other, :alias] => {
+      :dependency => :optional, # Valid values are :none, :optional and :required.
+      :short      => :o,        # The short arg this would be '-o'
+      :default    => 'default value'
+    }
+  }
+```
+
+These are then returned as GetoptLong array syntax. So to use in GetoptLong:
+
+```ruby
+GetoptLong(*New.options).each |option, value|
+  puts option
+  # => :other
+  puts value
+  # => 'default value'
+end
+```
+
+**To include the software dependency module**
+
+```ruby
+include CliTool::SoftwareDependencies
+```
+
+You can then have you application check that dependencies are accessible in your $PATH on startup by using the following class method.
+
+```ruby
+class New
+  include CliTool::SoftwareDependencies
+
+  software(:git, :ls, :cp, :mysqld, ...)
+end
+```
+
+If the executable cannot be found in the $PATH then it will throw `CliTool::MissingDependencies`.
+
+**To include the input, confirm and colorized_puts tool**
+
+```ruby
+include CliTool::StdinOut
+```
+
+You can then make use of the methods as follows.
+
+```ruby
+include CliTool::StdinOut
+
+puts("My normal message", :red)
+puts("My normal message", [:red, :purple_bg, :bold])
+
+input("What is your name?", :red)
+input("What is your name?", [:red, :purple_bg, :bold])
+
+confirm("Do you really want to do that?", :red)
+confirm("Do you really want to do that?", [:red, :purple_bg, :bold])
+```
+
+The available options for the methods are.
+
+`puts(message, color = :reset, sleep_in_seconds = nil)`
+`input(message, color = :reset, timeout_in_seconds = nil, default_value_for_timeout = nil)`
+`confirm(message, color = :reset, default_value = :n, timeout_in_seconds = nil)`
+
+The only required values are message.
+
+## 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/cli_tool.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cli_tool/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cli_tool"
+  spec.version       = CliTool::VERSION
+  spec.authors       = ["Kelly Becker"]
+  spec.email         = ["kellylsbkr@gmail.com"]
+  spec.description   = %q{Have trouble with advanced command line options, software dependency presence validation, handling inputs, confirmations and colorizing? Then this gem is for you. It provides you with some modules you can include to add those specific features.}
+  spec.summary       = %q{Tools to help with writing command line applications}
+  spec.homepage      = "http://kellybecker.me"
+  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"
+  spec.add_development_dependency "pry"
+end

data/lib/cli_tool/option_parser.rb

@@ -0,0 +1,94 @@
+require 'getoptlong'
+
+module CliTool
+  module OptionParser
+
+    # Use to add the methods below to any class
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      # Map for symbol types
+      GOL_MAP = {
+        :none     => GetoptLong::NO_ARGUMENT,
+        :optional => GetoptLong::OPTIONAL_ARGUMENT,
+        :required => GetoptLong::REQUIRED_ARGUMENT
+      }
+
+      # Create the options array
+      def options(opts = nil)
+        @@options ||= []
+
+        # If no options were passed then return
+        return @@options.uniq unless opts
+
+        _create_attrs_(opts)
+        @@options = @@options.concat(_create_gola_(opts)).uniq
+      end
+
+      private
+
+      def _create_attrs_(opts)
+
+        # Get the option keys for attr creation
+        keys = opts.keys
+
+        # "symlink" the additional names to the original method
+        keys.each do |key|
+          default = nil
+          key = [key] unless key.is_a?(Array)
+          key.each_with_index do |k, i|
+            if i < 1
+              default = k.to_sym
+              attr_accessor(k.to_sym)
+            else
+              define_method("#{k}=", Proc.new { |x| send(default, x) })
+            end
+          end
+        end
+      end
+
+      def _create_gola_(opts)
+        gola = []
+
+        # Loop through the options to create
+        # the GetoptLong configuration array
+        opts.each do |opt, details|
+
+          short = nil
+          dependency = :none
+
+          # If we have extended details determine them
+          if details.is_a?(Hash)
+            short = details[:short]
+            dependency = details[:dependency]
+          else
+            dependency ||= details
+          end
+
+          # Prepare the GetoptLong Array option
+          golao  = []
+          golao << short if short
+          golao << GOL_MAP[dependency.to_sym]
+
+          # If the option has aliases then create
+          # additional GetoptLong Array options
+          if opt.is_a?(Array)
+            opt.each do |key|
+              golaot = golao.dup
+              golaot.unshift(key)
+              gola << golaot
+            end
+          else
+            golao.unshift(opt)
+            gola << golao
+          end
+        end
+
+        gola
+      end
+    end
+  end
+end

data/lib/cli_tool/software_dependencies.rb

@@ -0,0 +1,38 @@
+module CliTool
+  class MissingDependencies < StandardError; end;
+
+  module SoftwareDependencies
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      # Create the options array
+      def software(*soft)
+        @@software ||= []
+
+        # If no software dependencies were passed then return
+        return @@software.uniq unless soft
+
+        # Find missing software
+        missing = []
+        soft.each do |app|
+          %x{which #{app}}
+          missing << app unless $?.success?
+        end
+
+        # Raise if there were any missing software's
+        unless missing.empty?
+          missing = missing.join(', ')
+          raise CliTool::MissingDependencies,
+            %{The required software packages "#{missing}" could not be found in your $PATH.}
+        end
+
+        # Append to the software list
+        @@software = @@software.concat(soft).uniq
+      end
+    end
+  end
+end

data/lib/cli_tool/stdin_out.rb

@@ -0,0 +1,127 @@
+require 'timeout'
+
+module CliTool
+  module StdinOut
+    class MissingInput < StandardError; end;
+
+    ANSI_COLORS = {
+      :reset         => 0,
+      :bold          => 1,
+      :italic        => 3,
+      :underline     => 4,
+      :inverse       => 7,
+      :strike        => 9,
+      :bold_off      => 22,
+      :italic_off    => 23,
+      :underline_off => 24,
+      :inverse_off   => 27,
+      :strike_off    => 29,
+      :black         => 30,
+      :red           => 31,
+      :green         => 32,
+      :yellow        => 33,
+      :blue          => 34,
+      :magenta       => 35,
+      :purple        => 35,
+      :cyan          => 36,
+      :white         => 37,
+      :default       => 39,
+      :black_bg      => 40,
+      :red_bg        => 41,
+      :green_bg      => 42,
+      :yellow_bg     => 43,
+      :blue_bg       => 44,
+      :magenta_bg    => 45,
+      :purple_bg     => 45,
+      :cyan_bg       => 46,
+      :white_bg      => 47,
+      :default_bg    => 49
+    }
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.__send__(:include, ClassMethods)
+    end
+
+    module ClassMethods
+
+      # Handle putsing of information (supports color and sleeps)
+      def puts(text, color = :reset, timer = nil)
+
+        # Process information for ANSI color codes
+        super(_colorize_(text, color))
+
+        # Sleep after displaying the message
+        if timer
+          puts(_colorize_("Sleeping for #{timer} seconds...", color))
+          sleep(timer)
+        end
+      end
+
+      def input(message = '', color = :reset, timer = nil, default = nil)
+
+        # Prompt for input
+        puts(message, color)
+
+        # Get the input from the CLI
+        gets = Proc.new do
+          STDIN.gets.strip
+        end
+
+        # Handle timing out
+        result = begin
+          if timer
+            Timeout::timeout(timer, &gets)
+          else
+            gets.call
+          end
+        rescue Timeout::Error # Verify that this is correct?
+          default
+        end
+
+        result
+      end
+
+      def confirm(message, color = :reset, default = :n, timer = nil)
+
+        # Handle the default value
+        default = "#{default}".downcase[0..0].to_sym
+
+        # Get the prompt
+        prompt = if default == :y
+           'Y/n'
+        else
+          'y/N'
+        end
+
+        begin
+          # Prompt for answer
+          result = input("#{message} [#{prompt}]", color, timer).strip
+          result = result.empty? ? default : result.downcase[0..0].to_sym
+          raise MissingInput unless [:y, :n].include?(result)
+        rescue MissingInput
+          puts "Sorry that input was not accepted", :red
+          retry
+        end
+
+        result
+      end
+
+      private
+
+      def _colorize_(text, *color)
+
+        # Determine what to colors we should use
+        color = [:reset] if color.empty?
+        color = color.flatten
+
+        # Prepare the colorizing prefix for the text
+        prefix = color.inject('') do |o, c|
+          ANSI_COLORS[c] ? o << "\e[#{ANSI_COLORS[c]}m" : o
+        end
+
+        "#{prefix}#{text}\e[0m" # Add color
+      end
+    end
+  end
+end

data/lib/cli_tool/version.rb

@@ -0,0 +1,3 @@
+module CliTool
+  VERSION = "0.0.1"
+end

data/lib/cli_tool.rb

@@ -0,0 +1,8 @@
+require "cli_tool/version"
+require "cli_tool/stdin_out"
+require "cli_tool/option_parser"
+require "cli_tool/software_dependencies"
+
+module CliTool
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: cli_tool
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Kelly Becker
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-03 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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Have trouble with advanced command line options, software dependency
+  presence validation, handling inputs, confirmations and colorizing? Then this gem
+  is for you. It provides you with some modules you can include to add those specific
+  features.
+email:
+- kellylsbkr@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .pryrc
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cli_tool.gemspec
+- lib/cli_tool.rb
+- lib/cli_tool/option_parser.rb
+- lib/cli_tool/software_dependencies.rb
+- lib/cli_tool/stdin_out.rb
+- lib/cli_tool/version.rb
+homepage: http://kellybecker.me
+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.2
+signing_key: 
+specification_version: 4
+summary: Tools to help with writing command line applications
+test_files: []