kommand 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e728a399b1bbe6ae3294871c2f3186f6e866c675
+  data.tar.gz: 692bbc295236b95010345f8638aae5ed036506f4
+SHA512:
+  metadata.gz: 2fb412fdc3e080cbc595c7c455fcba65fb68cef6de77c5c7f58b7f45228552cdfeabf2f95a7591b082f8eef4fd94136278ed9eb69edb2ce1655f18396bf84e4f
+  data.tar.gz: 841eb474194955c825122df2a6d97871563f456403c9e0bd60e3f1bf90b6e4cfca50411f378b6f8133b8db8067f6ccaaf82ab37c834d98097ce69fd604cc003d

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+*.swp
+mkmf.log

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Mark Rebec
+
+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,29 @@
+# Kommand
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kommand'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kommand
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/kommand/fork )
+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 a new Pull Request

data/Rakefile

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

data/bin/kommand

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+#
+# Kommand
+#
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require 'kommand/kli'
+
+Kommand::KLI.start(*ARGV)

data/kommand.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kommand/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kommand"
+  spec.version       = Kommand::VERSION
+  spec.authors       = ["Mark Rebec"]
+  spec.email         = ["mark@markrebec.com"]
+  spec.summary       = %q{Simple object-oriented interface for building CLI commands with subcommands.}
+  spec.description   = %q{Simple object-oriented interface for building CLI commands with subcommands.}
+  spec.homepage      = "https://github.com/markrebec/kommand"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_dependency "activesupport"
+  spec.add_dependency "inkjet"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/kommand/cli.rb

@@ -0,0 +1,116 @@
+require 'active_support/inflector'
+require 'kommand'
+require 'kommand/scripts'
+require 'kommand/commands'
+
+module Kommand
+  class CLI
+    include Scripts::Script
+
+    def self.inherited(sub)
+      sub.send :valid_argument, Scripts::Argument.new("-v, --verbose", :valid => [], :summary => "Output additional information from command executions to STDOUT")
+      sub.send :valid_argument, Scripts::Argument.new("-d, --debug", :valid => [], :summary => "Output full backtraces for exceptions and errors")
+    end
+
+    valid_argument Scripts::Argument.new("-v, --verbose", :valid => [], :summary => "Output additional information from command executions to STDOUT")
+    valid_argument Scripts::Argument.new("-d, --debug", :valid => [], :summary => "Output full backtraces for exceptions and errors")
+
+    def self.verbose?
+      user_arguments.map(&:key).include?("-v")
+    end
+
+    def self.debug?
+      user_arguments.map(&:key).include?("-d")
+    end
+
+    def self.exec(cmd)
+      if verbose?
+        system cmd
+      else
+        `#{cmd}`
+      end
+    end
+    
+    def self.add_arguments(*args)
+      keep = []
+      args.each_with_index do |arg,a|
+        if Commands::exists?(arg)
+          begin
+            @command = Commands::command(arg)
+            @command.set_arguments(*args.slice(a+1,args.length-a))
+          rescue Scripts::InvalidArgument => e
+            puts e.message
+            Commands::command(arg).usage
+            exit 1
+          end
+          break
+        end
+
+        keep << arg
+      end
+      super(*keep)
+    end
+
+    def self.binary=(bin)
+      @binary = bin
+    end
+
+    def self.binary
+      @binary ||= Kommand.kommand
+    end
+
+    def self.command_name
+      binary
+    end
+
+    def self.version=(ver)
+      @version = ver
+    end
+
+    def self.version
+      @version ||= VERSION
+    end
+
+    def self.usage
+      puts "#{binary} v#{version}"
+      puts
+      puts "usage: #{binary} #{valid_arguments.to_s} <command> [<args>]"
+      unless valid_arguments.empty?
+        puts
+        puts "Arguments:"
+        puts valid_arguments.to_help
+      end
+      puts
+      puts "The available #{binary} commands are:"
+      
+      Commands::commands.each do |cmd|
+        print "   %-#{Commands::commands.sort { |a,b| a.command_name.length <=> b.command_name.length }.last.command_name.length + 2}s" % cmd.command_name
+        puts "# #{cmd.command_summary}"
+      end
+
+      puts
+      puts "See `#{binary} help <command>` for more information on a specific command."
+    end
+    
+    def self.start(*args)
+      args = args[0] if args.length == 1 && args.first.is_a?(Array)
+      begin
+        set_arguments(*args)
+      rescue Scripts::InvalidArgument => e
+        puts e.message
+        return
+      rescue Exception => e
+        usage
+        return
+      end
+
+      if @command.nil?
+        usage
+        return
+      end
+
+      @command.run
+    end
+  
+  end
+end

data/lib/kommand/commands/command.rb

@@ -0,0 +1,90 @@
+module Kommand
+  module Commands
+    module Command
+      def self.included(base)
+        Commands::commands << base # Keep track of all commands
+
+        base.send :include, Scripts::Script
+        base.send :extend, ClassMethods
+        base.send :include, InstanceMethods
+      end
+
+      module ClassMethods
+        def command_name(n=nil)
+          @command_name = n unless n.nil?
+          return @command_name unless @command_name.nil?
+          self.name.underscore.split("/").last
+        end
+        
+        def command_summary(summary=nil)
+          @command_summary = summary unless summary.nil?
+          @command_summary
+        end
+        alias_method :summary, :command_summary
+
+        def usage
+          puts "usage: #{::Kommand.kommand} #{command_name} #{valid_arguments.to_s}"
+        end
+
+        def run
+          begin
+            @command ||= new
+            before_hooks.each { |block| @command.instance_eval(&block) }
+            @command.run
+            after_hooks.each { |block| @command.instance_eval(&block) }
+          rescue Exception => e
+            puts e.message
+            puts e.backtrace if ::Kommand::CLI.debug?
+            @command.usage if e.is_a?(Scripts::InvalidArgument)
+            return
+          end
+        end
+
+        def append_after_hook(&block)
+          @after_hooks ||= []
+          @after_hooks << block
+        end
+        alias_method :after_hook, :append_after_hook
+
+        def prepend_after_hook(&block)
+          @after_hooks ||= []
+          @after_hooks.unshift block
+        end
+
+        def after_hooks
+          @after_hooks ||= []
+          @after_hooks
+        end
+
+        def append_before_hook(&block)
+          @before_hooks ||= []
+          @before_hooks << block
+        end
+        alias_method :before_hook, :append_before_hook
+
+        def prepend_before_hook(&block)
+          @before_hooks ||= []
+          @before_hooks.unshift block
+        end
+
+        def before_hooks
+          @before_hooks ||= []
+          @before_hooks
+        end
+
+        def to_arg
+          Scripts::Argument.new(command_name, :summary => command_summary)
+        end
+      end
+
+      module InstanceMethods
+        %w(command_name command_summary usage).each do |method|
+          define_method method do |*args|
+            self.class.send method, *args
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/kommand/commands/help.rb

@@ -0,0 +1,45 @@
+module Kommand
+  module Commands
+    class Help
+      include Command
+
+      command_summary "Provides help and usage examples"
+
+      valid_arguments *Commands::commands.map(&:to_arg)
+      validate_arguments false
+
+      def self.usage
+        puts <<USAGE
+usage: #{::Kommand.kommand} #{command_name} <command>
+      
+The available commands are:
+USAGE
+        
+        Commands::commands.select { |cmd| cmd != self}.each do |cmd|
+          print "   %-#{Commands::commands.sort { |a,b| a.command_name.length <=> b.command_name.length }.last.command_name.length + 2}s" % cmd.command_name
+          puts "# #{cmd.command_summary}"
+        end
+      end
+
+      def run
+        if arguments.empty?
+          usage
+          return
+        end
+
+        begin
+          cmd = Commands::commands.select { |cmd| cmd.command_name == arguments.first.key.underscore }.first
+          raise if cmd.nil?
+
+          puts cmd.command_summary
+          puts
+          print "    "
+          cmd.usage
+        rescue
+          puts "Invalid Command: #{arguments.first.key.underscore}"
+          usage
+        end
+      end
+    end
+  end
+end

data/lib/kommand/commands.rb

@@ -0,0 +1,19 @@
+module Kommand
+  module Commands
+    def self.commands
+      @commands ||= []
+    end
+
+    def self.exists?(cmd)
+      commands.map(&:command_name).include?(cmd.underscore.to_s)
+    end
+
+    def self.command(cmd)
+      raise "Command does not exist: #{cmd}" unless exists?(cmd)
+      commands.select { |command| command.command_name == cmd.underscore.to_s }.first
+    end
+  end
+end
+
+require 'kommand/commands/command'
+require 'kommand/commands/help'

data/lib/kommand/kli.rb

@@ -0,0 +1,6 @@
+require 'kommand/cli'
+
+module Kommand
+  class KLI < CLI
+  end
+end

data/lib/kommand/scripts/argument.rb

@@ -0,0 +1,40 @@
+module Kommand
+  module Scripts
+    class Argument
+      attr_reader :value, :valid, :summary
+
+      def value=(val)
+        raise "Invalid value for `#{key}` argument: '#{val}'" if (!@valid.nil? && !@valid.include?(val)) && (!val.nil? && !val.empty?)
+        @value = val
+      end
+
+      def key
+        @keys.is_a?(Array) ? @keys[0] : @keys
+      end
+
+      def keys
+        @keys.is_a?(Array) ? @keys : [@keys]
+      end
+
+      def name
+        keys.sort { |a,b| a.length <=> b.length }.last.gsub(/^--/, '')
+      end
+
+      protected
+
+      def initialize(keys, *args)
+        @keys = (keys.is_a?(String) && keys.match(/,?\s/) ? keys.gsub(/,?\s+/, " ").split(" ") : keys)
+        
+        val = args.slice!(0) if %w(String Symbol Integer).include?(args[0].class.name)
+
+        if args.length > 0 && args[0].is_a?(Hash)
+          opts = args.slice!(0)
+          @valid = (opts[:valid].is_a?(Array) ? opts[:valid].map(&:to_s) : [opts[:valid].to_s]) if opts.has_key?(:valid)
+          @summary = opts[:summary] if opts.has_key?(:summary)
+        end
+        
+        self.value = val
+      end
+    end
+  end
+end

data/lib/kommand/scripts/arguments.rb

@@ -0,0 +1,28 @@
+module Kommand
+  module Scripts
+    class Arguments < Array
+      
+      def to_s
+        map do |arg|
+          #if arg.valid.nil? || arg.valid.empty?
+            "[#{arg.keys.join(", ")}]"
+          #else
+          #  "[#{arg.keys.join(", ")} = (#{arg.valid.join("|")})]"
+          #end
+        end.join(" ")
+      end
+
+      def to_help
+        map do |arg|
+          "  #{"%-#{sort { |a,b| a.keys.join(", ").length <=> b.keys.join(", ").length }.last.keys.join(", ").length + 2}s" % arg.keys.join(", ")}# #{arg.summary}"
+        end.join("\n")
+      end
+
+      protected
+
+      def initialize
+        super
+      end
+    end
+  end
+end

data/lib/kommand/scripts/invalid_argument.rb

@@ -0,0 +1,6 @@
+module Kommand
+  module Scripts
+    class InvalidArgument < Exception
+    end
+  end
+end

data/lib/kommand/scripts/script.rb

@@ -0,0 +1,108 @@
+# TODO implement OptionParser
+module Kommand
+  module Scripts
+    module Script
+      def self.included(base)
+        base.send :extend, ClassMethods
+        base.send :include, InstanceMethods
+      end
+
+      module ClassMethods
+        def run
+          @script ||= new
+          raise "You must define a `run` method for your script." unless @script.respond_to?(:run)
+          @script.run
+        end
+
+        def validate_arguments(val=nil)
+          @validate_arguments = val
+        end
+
+        def validate_arguments?
+          @validate_arguments = true if @validate_arguments.nil?
+          @validate_arguments
+        end
+
+        def valid_argument(arg)
+          @valid_args ||= Arguments.new
+          @valid_args << begin
+            if arg.is_a?(Argument)
+              arg
+            elsif arg.is_a?(Hash)
+              Argument.new(arg.keys.first.to_s, arg.values.first)
+            elsif arg.is_a?(Array)
+              Argument.new(arg[0].to_s, (arg.length > 1 ? arg[1] : []))
+            else
+              Argument.new(arg.to_s)
+            end
+          end
+          @valid_args.last
+        end
+
+        def valid_arguments(*args)
+          @valid_args ||= Arguments.new
+          return @valid_args if args.empty?
+          
+          args.each { |arg| valid_argument(arg) }
+          @valid_args
+        end
+        
+        def arguments(*args)
+          add_arguments(*args)
+        end
+
+        def user_arguments
+          arguments
+        end
+
+        def set_arguments(*args)
+          @arguments = Arguments.new
+          add_arguments(*args)
+        end
+
+        def add_arguments(*args)
+          @arguments ||= Arguments.new
+          args.each_with_index do |arg,a|
+            argk, argv = *parse_arg(arg)
+            
+            if !argument_flag?(arg) && !valid_argument?(argk) && (a > 0 && argument_flag?(args[a-1]))
+              @arguments.last.value = arg
+              next
+            end
+
+            raise InvalidArgument, "Invalid Argument: #{arg}" if validate_arguments? && !valid_argument?(argk)
+            @arguments << argument_object(argk)
+            @arguments.last.value = argv unless argv.empty?
+          end
+          @arguments
+        end
+
+        def parse_arg(arg)
+          arga = arg.split("=")
+          [arga.slice!(0), arga.join("=")]
+        end
+        
+        def valid_argument?(key)
+          valid_arguments.map(&:keys).flatten.include?(key)
+        end
+
+        def argument_flag?(arg)
+          arg.match(/\A(-)+[a-z0-9\-]=?.*\Z/i)
+        end
+
+        def argument_object(key)
+          valid_arguments.select { |varg| varg.keys.include?(key) }.first || Argument.new(key)
+        end
+      end
+
+      module InstanceMethods
+        %w(arguments valid_arguments).each do |method|
+          define_method method do |*args|
+            self.class.send method, *args
+          end
+        end
+      end
+    
+    end
+  end
+end

data/lib/kommand/scripts.rb

@@ -0,0 +1,4 @@
+require 'kommand/scripts/invalid_argument'
+require 'kommand/scripts/argument'
+require 'kommand/scripts/arguments'
+require 'kommand/scripts/script'

data/lib/kommand/version.rb

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

data/lib/kommand.rb

@@ -0,0 +1,7 @@
+require "kommand/version"
+
+module Kommand
+  def self.kommand
+    File.basename($0)
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: kommand
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mark Rebec
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: inkjet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: Simple object-oriented interface for building CLI commands with subcommands.
+email:
+- mark@markrebec.com
+executables:
+- kommand
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/kommand
+- kommand.gemspec
+- lib/kommand.rb
+- lib/kommand/cli.rb
+- lib/kommand/commands.rb
+- lib/kommand/commands/command.rb
+- lib/kommand/commands/help.rb
+- lib/kommand/kli.rb
+- lib/kommand/scripts.rb
+- lib/kommand/scripts/argument.rb
+- lib/kommand/scripts/arguments.rb
+- lib/kommand/scripts/invalid_argument.rb
+- lib/kommand/scripts/script.rb
+- lib/kommand/version.rb
+homepage: https://github.com/markrebec/kommand
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Simple object-oriented interface for building CLI commands with subcommands.
+test_files: []