mercenary 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 467dae27c989bd4d07318b1965e6e28930f90aeb
-  data.tar.gz: be71811e5f88c21cc07105822a0d77874893617f
+  metadata.gz: 3f441ca546550e0899b4f6aa2135994f482d5d29
+  data.tar.gz: d5d7fd3ecd26cf8065b78fd51575c0fe197b9557
 SHA512:
-  metadata.gz: bf722d831a506ee191a2609b3420e132f50ddd4d00f87cc3686376767321a77af4310c0f71e481c1138d610b0780395e6b73fda297829b9a8ad8d3846e4160cc
-  data.tar.gz: c9080a9dbcdda0da115f5d22b511bb20d6e7ce1fe08611076c81c007f69dcd72b96c8a2d6fde4b5694c6ee76c9878cba30f23b9507e1528e8a44a48965c4f9e0
+  metadata.gz: bd7eaa27cbe85b82a1997eb6b73b429707c5a63c38e1f09b144eed56f04e819e35759e2b3a7d65bb4c977d87998e7d174544f023c2aa4a0e4f32362f5b9dcf9f
+  data.tar.gz: dbf6c19a22daf82dffd6ca7007d9fea7e32e18fe170da8c972779db8e2e76826956028d90febc845b75c79f11377817da42683d3db3291d4faf22440c47b27ff

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+script: "bundle exec rspec"
+notification:
+  recipients:
+    - mercenary@jekyllrb.com
+  email:
+    on_success: change
+    on_failure: change

data/README.md

@@ -1,6 +1,8 @@
 # Mercenary
 
-TODO: Write a gem description
+Lightweight and flexible library for writing command-line apps in Ruby.
+
+[![Build Status](https://secure.travis-ci.org/jekyll/mercenary.png)](https://travis-ci.org/jekyll/mercenary)
 
 ## Installation
 
@@ -18,7 +20,39 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+Mercenary.program(:jekyll) do |p|
+  p.version Jekyll::VERSION
+  p.description 'Jekyll is a blog-aware, static site generator in Ruby'
+
+  p.command(:new) do |c|
+    c.syntax "jekyll new PATH"
+    c.description "Creates a new Jekyll site scaffold in PATH"
+
+    c.action do |args, options|
+      Jekyll::Commands::New.process(args)
+    end
+  end
+
+  p.command(:import) do |c|
+    c.syntax "jekyll import <platform> [options]"
+    c.description "Import your old blog to Jekyll"
+
+    c.action do |args, options|
+      begin
+        require "jekyll-import"
+      rescue
+        msg  = "You must install the 'jekyll-import' gem before continuing.\n"
+        msg += "* Do this by running `gem install jekyll-import`.\n"
+        msg += "* Or if you need root privileges, run `sudo gem install jekyll-import`."
+        abort msg
+      end
+
+      Jekyll::Commands::Import.process(args.first, options)
+    end
+  end
+end
+```
 
 ## Contributing
 

data/lib/mercenary.rb

@@ -1,5 +1,9 @@
+lib = File.expand_path('../', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
 require "mercenary/version"
 require "optparse"
+require "logger"
 
 module Mercenary
   autoload :Command, "mercenary/command"

data/lib/mercenary/command.rb

@@ -9,6 +9,13 @@ module Mercenary
     attr_reader :map
     attr_accessor :parent
 
+    # Public: Creates a new Command
+    #
+    # name - the name of the command
+    # parent - (optional) the instancce of Mercenary::Command which you wish to
+    #          be the parent of this command
+    #
+    # Returns nothing
     def initialize(name, parent = nil)
       @name = name
       @options = []
@@ -18,46 +25,114 @@ module Mercenary
       @parent = parent
     end
 
-    def syntax(syntax)
-      @syntax = syntax
+    # Public: Sets or gets the syntax string
+    #
+    # syntax - the string which describes this command's usage syntax (optional)
+    #
+    # Returns the syntax string and sets it if an argument is present
+    def syntax(syntax = nil)
+      @syntax = syntax if syntax
+      @syntax
     end
 
-    def description(desc)
-      @description = desc
+    # Public: Sets or gets the command description
+    #
+    # description - the description of what the command does (optional)
+    #
+    # Returns the description and sets it if an argument is present
+    def description(desc = nil)
+      @description = desc if desc
+      @description
     end
 
+    # Public: Adds an option switch
+    #
+    # sym - the variable key which is used to identify the value of the switch
+    #       at runtime in the options hash
+    #
+    # Returns nothing
     def option(sym, *options)
       @options << options
       @map[options[0]] = sym
     end
 
+    # Public: Adds a subcommand
+    #
+    # cmd_name - the name of the command
+    # block    - a block accepting the new instance of Mercenary::Command to be
+    #            modified (optional)
+    #
+    # Returns nothing
     def command(cmd_name)
       cmd = Command.new(cmd_name, self)
       yield cmd
       @commands[cmd_name] = cmd
     end
 
+    # Public: Add an alias for this command's name to be attached to the parent
+    #
+    # cmd_name - the name of the alias
+    #
+    # Returns nothing
     def alias(cmd_name)
+      logger.debug "adding alias to parent for self: '#{cmd_name}'"
       @parent.commands[cmd_name] = self
     end
 
+    # Public: Add an action Proc to be executed at runtime
+    #
+    # block - the Proc to be executed at runtime
+    #
+    # Returns nothing
     def action(&block)
       @actions << block
     end
 
+    # Public: Fetch a Logger (stdlib)
+    #
+    # level - the logger level (a Logger constant, see docs for more info)
+    #
+    # Returns the instance of Logger
+    def logger(level = Logger::INFO)
+      unless @logger
+        @logger = Logger.new(STDOUT)
+        @logger.formatter = proc do |severity, datetime, progname, msg|
+          "#{ident} (#{severity}): #{msg}\n"
+        end
+      end
+
+      @logger.level = level
+      @logger
+    end
+
+    # Public: Run the command
+    #
+    # argv   - an array of string args
+    # opts   - the instance of OptionParser
+    # config - the output config hash
+    #
+    # Returns the command to be executed
     def go(argv, opts, config)
+      opts.banner = "Usage: #{syntax}"
       process_options(opts, config)
 
       if argv[0] && cmd = commands[argv[0].to_sym]
-        puts "Found #{cmd.name}"
+        logger.debug "Found subcommand '#{cmd.name}'"
         argv.shift
         cmd.go(argv, opts, config)
       else
-        puts "No additional command found, time to exec"
+        logger.debug "No additional command found, time to exec"
         self
       end
     end
 
+    # Public: Add this command's options to OptionParser and set a default
+    #         action of setting the value of the option to the inputted hash
+    #
+    # opts - instance of OptionParser
+    # config - the Hash in which the option values should be placed
+    #
+    # Returns nothing
     def process_options(opts, config)
       options.each do |o|
         opts.on(*o) do |x|
@@ -66,13 +141,29 @@ module Mercenary
       end
     end
 
+    # Public: Check if this command has a subcommand
+    #
+    # sub_command - the name of the subcommand
+    #
+    # Returns true if this command is the parent of a command of name
+    # 'sub_command' and false otherwise
+    def has_command?(sub_command)
+      commands.keys.include?(sub_command)
+    end
+
+    # Public: Identify this command
+    #
+    # Returns a string which identifies this command
     def ident
       "<Command name=#{name}>"
     end
 
-    def inspect
+    # Public: Build a string containing the command name, options and any subcommands
+    #
+    # Returns the string identifying this command, its options and its subcommands
+    def to_s
       msg = ''
-      msg += "Command #{name}\n"
+      msg += "Command: #{name}\n"
       options.each { |o| msg += "  " + o.inspect + "\n"}
       msg += "\n"
       commands.each { |k, v| msg += commands[k].inspect }

data/lib/mercenary/program.rb

@@ -1,37 +1,50 @@
 module Mercenary
   class Program < Command
-    attr_reader :version
-    attr_reader :description
     attr_reader :optparse
     attr_reader :config
 
+    # Public: Creates a new Program
+    #
+    # name - the name of the program
+    #
+    # Returns nothing
     def initialize(name)
       @config = {}
       super(name)
     end
 
-    def version(version)
-      @version = version
-    end
-
-    def description(description)
-      @description = description
+    # Public: Sets or gets the program version
+    #
+    # version - the program version (optional)
+    #
+    # Returns the version and sets it if an argument is present
+    def version(version = nil)
+      @version = version if version
+      @version
     end
 
+    # Public: Run the program
+    #
+    # argv   - an array of string args (usually ARGV)
+    #
+    # Returns nothing
     def go(argv)
-      p argv
-      puts
-      p self
+      logger.debug("Using args passed in: #{argv.inspect}")
 
       cmd = nil
 
       @optparse = OptionParser.new do |opts|
         cmd = super(argv, opts, @config)
+
+        opts.on('-v' '--version', 'Print the version') do
+          puts "#{name} #{version}"
+          abort
+        end
       end
 
       @optparse.parse!(argv)
 
-      p @config
+      logger.debug("Parsed config: #{@config.inspect}")
 
       cmd.actions.each { |a| a.call(argv, @config) }
     end

data/lib/mercenary/version.rb

@@ -1,3 +1,3 @@
 module Mercenary
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/mercenary.gemspec

@@ -6,11 +6,11 @@ require 'mercenary/version'
 Gem::Specification.new do |spec|
   spec.name          = "mercenary"
   spec.version       = Mercenary::VERSION
-  spec.authors       = ["Parker Moore", "Tom Preston-Werner"]
-  spec.email         = ["parkrmoore@gmail.com", "tom@mojombo.com"]
-  spec.description   = %q{Write better command-line apps.}
-  spec.summary       = %q{Write better command-line apps.}
-  spec.homepage      = "http://github.com/jekyll/mercenary"
+  spec.authors       = ["Tom Preston-Werner", "Parker Moore"]
+  spec.email         = ["tom@mojombo.com", "parkrmoore@gmail.com"]
+  spec.description   = %q{Lightweight and flexible library for writing command-line apps in Ruby.}
+  spec.summary       = %q{Lightweight and flexible library for writing command-line apps in Ruby.}
+  spec.homepage      = "https://github.com/jekyll/mercenary"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
 end

data/spec/command_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+describe(Mercenary::Command) do
+
+  context "a basic command" do
+    let(:command) { Mercenary::Command.new(:my_name) }
+    let(:command_with_parent) do
+      Mercenary::Command.new(
+        :i_have_parent,
+        parent
+      )
+    end
+    let(:parent)  { Mercenary::Command.new(:my_parent) }
+    let(:add_sub) do
+      Proc.new do |c|
+        c.command(:sub_command) { |p| }
+      end
+    end
+
+    it "can be created with just a name" do
+      expect(command.name).to eql(:my_name)
+    end
+
+    it "can hold a parent command" do
+      expect(command_with_parent.parent).to eql(parent)
+    end
+
+    it "can create subcommands" do
+      expect(add_sub.call(command)).to be_a(Mercenary::Command)
+      expect(add_sub.call(command).parent).to eq(command)
+    end
+
+    it "can set its syntax" do
+      syntax_string = "my_name [options]"
+      cmd = described_class.new(:my_name)
+      cmd.syntax syntax_string
+      expect(cmd.syntax).to eq(syntax_string)
+    end
+
+    it "can set its description" do
+      desc = "run all the things"
+      command.description desc
+      expect(command.description).to eq(desc)
+    end
+
+    it "can set its options" do
+      name = "show_drafts"
+      opt  = ['--drafts', 'Render posts in the _drafts folder']
+      command.option name, *opt
+      expect(command.options).to eq([opt])
+      expect(command.map).to include({opt.first => name})
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mercenary'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: mercenary
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
-- Parker Moore
 - Tom Preston-Werner
+- Parker Moore
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-06 00:00:00.000000000 Z
+date: 2013-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,15 +39,31 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Write better command-line apps.
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: Lightweight and flexible library for writing command-line apps in Ruby.
 email:
-- parkrmoore@gmail.com
 - tom@mojombo.com
+- parkrmoore@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -57,7 +73,10 @@ files:
 - lib/mercenary/program.rb
 - lib/mercenary/version.rb
 - mercenary.gemspec
-homepage: http://github.com/jekyll/mercenary
+- spec/command_spec.rb
+- spec/program_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jekyll/mercenary
 licenses:
 - MIT
 metadata: {}
@@ -80,5 +99,8 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: Write better command-line apps.
-test_files: []
+summary: Lightweight and flexible library for writing command-line apps in Ruby.
+test_files:
+- spec/command_spec.rb
+- spec/program_spec.rb
+- spec/spec_helper.rb