cli-forge 0.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+coverage/
+tmp/
+.DS_Store
+Gemfile.lock

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--order random
+--require spec_helper

data/.simplecov

@@ -0,0 +1,3 @@
+SimpleCov.start do
+  add_filter "/spec/"
+end

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+bundler_args: --without debugging development
+script: bundle exec rake spec:ci
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-18mode
+  - jruby-19mode
+  - ree

data/Gemfile

@@ -0,0 +1,61 @@
+source "https://rubygems.org"
+
+gemspec
+
+# No gem would be complete without rake tasks - http://rake.rubyforge.org/
+# MIT License - http://rake.rubyforge.org/files/MIT-LICENSE.html
+gem "rake", "~> 10.0"
+
+group :test do
+  # Our preferred unit testing library - https://www.relishapp.com/rspec
+  # MIT License - https://github.com/rspec/rspec/blob/master/License.txt
+  gem "rspec", "~> 2.13"
+
+  # The preferred code mutation library.
+  # MIT License - https://github.com/mbj/mutant/blob/master/LICENSE
+  gem "mutant", ">= 0.2.20", "< 1.0.0", :platforms => :ruby_19
+
+  # Cover all the things - https://github.com/colszowka/simplecov
+  # MIT License - https://github.com/colszowka/simplecov/blob/master/LICENSE
+  gem "simplecov", "~> 0.7"
+
+  # Code coverage in badge form - https://coveralls.io/
+  # MIT License - https://github.com/lemurheavy/coveralls-ruby/blob/master/LICENSE
+  gem "coveralls", "~> 0.6"
+end
+
+group :debugging do
+  # A REPL like IRB, but much better - http://pryrepl.org/
+  # MIT License - https://github.com/pry/pry/blob/master/LICENSE
+  gem "pry", "~> 0.9"
+
+  # Don't leave home without a debugger!
+  # Two Clause BSD License - https://github.com/cldwalker/debugger/blob/master/LICENSE
+  gem "debugger", "~> 1.3", :platforms => :mri
+end
+
+group :development do
+  # A generic file system event handler; spin it up and see the tests fly
+  # MIT License - https://github.com/guard/guard/blob/master/LICENSE
+  gem "guard", "~> 1.6"
+
+  # Guard configuration to manage Gemfile updates
+  # MIT License - https://github.com/guard/guard-bundler/blob/master/LICENSE
+  gem "guard-bundler", "~> 1.0"
+
+  # Guard configuration to manage our spork drb environments
+  # MIT License - https://github.com/guard/guard-spork/blob/master/LICENSE
+  gem "guard-spork", "~> 1.5"
+
+  # Guard configuration & hooks for rspec
+  # MIT License - https://github.com/guard/guard-rspec/blob/master/LICENSE
+  gem "guard-rspec", "~> 2.4"
+
+  # Growl notification protocol gem - give us fancy warnings when things go awry
+  # MIT License - https://github.com/snaka/ruby_gntp/blob/master/lib/ruby_gntp.rb
+  gem "ruby_gntp", "~> 0.3"
+
+  # FS event hooks for OS X
+  # MIT License - https://github.com/thibaudgg/rb-fsevent/blob/master/LICENSE
+  gem "rb-fsevent", "~> 0.9", :require => RUBY_PLATFORM.include?("darwin") && "rb-fsevent"
+end

data/Guardfile

@@ -0,0 +1,35 @@
+# Touching any of these files should cause the entire test suite to reload.
+GLOBAL_SPEC_FILES = [
+  ".rspec",
+  %r{^spec/.*_helper\.rb$},
+  %r{^spec/common/.*\.rb$},
+  "lib/cli_forge.rb",
+  "lib/cli_forge/autoload_convention.rb",
+]
+
+def specs_for_path(path)
+  ["spec/unit/#{path}_spec.rb", Dir["spec/unit/#{path}/**/*_spec.rb"]].flatten
+end
+
+guard "bundler" do
+  watch("Gemfile")
+  watch(/^.+\.gemspec/)
+end
+
+guard "spork", rspec_port: 2733 do
+  watch("Gemfile")
+  watch("Gemfile.lock")
+
+  GLOBAL_SPEC_FILES.each do |pattern|
+    watch(pattern) { :rspec }
+  end
+end
+
+guard "rspec", cli: "--drb --drb-port 2733" do
+  GLOBAL_SPEC_FILES.each do |pattern|
+    watch(pattern) { "spec" }
+  end
+
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$}) { |m| specs_for_path(m[1]) }
+end

data/MIT-LICENSE.md

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Ian MacLeod <ian@nevir.net>
+==============================================
+
+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,30 @@
+CLI Forge [![Gem Version](https://badge.fury.io/rb/cli-forge.png)](https://rubygems.org/gems/cli-forge) [![Build Status](https://secure.travis-ci.org/nevir/cli-forge.png?branch=master)](http://travis-ci.org/nevir/cli-forge) [![Coverage Status](https://coveralls.io/repos/nevir/cli-forge/badge.png?branch=master)](https://coveralls.io/r/nevir/cli-forge) [![Code Climate](https://codeclimate.com/github/nevir/cli-forge.png)](https://codeclimate.com/github/nevir/cli-forge) [![Dependency Status](https://gemnasium.com/nevir/cli-forge.png)](https://gemnasium.com/nevir/cli-forge)
+=========
+
+Beat your CLI tool suites into submission!
+
+* Create CLI tools that are easily extended (`git style args` -> `git-style args`)
+
+* A help system that is friendly to you _and_ your users.
+
+* That warm fuzzy feeling of being able to support plugin commands written in
+  any language.
+
+
+Ok... How Do I?
+===============
+
+Let's start with the most basic example:
+
+```ruby
+#!/usr/bin/env ruby
+require "cli-forge"
+
+CLIForge.start
+```
+
+
+License
+=======
+
+[CLI Forge is MIT Licensed](MIT-LICENSE.md).

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+PROJECT_PATH = File.expand_path("..", __FILE__)
+Dir["#{PROJECT_PATH}/tasks/**/*.rake"].each do |path|
+  load path
+end
+
+$LOAD_PATH.unshift File.join(PROJECT_PATH, "lib")
+
+
+desc "Run the full test suite"
+task :default => [:spec, :"spec:mutate"]

data/cli-forge.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path("../lib/cli_forge/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "cli-forge"
+  gem.version     = CLIForge::VERSION
+  gem.homepage    = "http://github.com/nevir/cli-forge"
+  gem.summary     = "Beat your CLI tool suites into submission!"
+  gem.description = "A library for building CLI tools that are intended to be easily extensible (git style)"
+  gem.author      = "Ian MacLeod"
+  gem.email       = "ian@nevir.net"
+
+  gem.platform = Gem::Platform::RUBY
+
+  gem.files         = `git ls-files`.split($/)
+  gem.require_paths = ["lib"]
+end

data/lib/cli-forge.rb

@@ -0,0 +1 @@
+require "cli_forge"

data/lib/cli_forge.rb

@@ -0,0 +1,5 @@
+require "cli_forge/autoload_convention"
+
+module CLIForge
+  extend CLIForge::AutoloadConvention
+end

data/lib/cli_forge/autoload_convention.rb

@@ -0,0 +1,29 @@
+# Autoload Convention
+# ===================
+# We adhere to a strict convention for the constants in this library:
+#
+# `Camel::Caps::BasedConstants` map to their underscore variants of
+# `camel/caps/based_constants`.
+#
+# Each autoloadable parent module/class only needs to to `extend` the
+# `AutoloadConvention` to bootstrap this behavior.
+module CLIForge
+  module AutoloadConvention
+
+    # `autoload` is dead, and we don't want to deal with its removal in 2.0,
+    # so here's a thread-unsafe poor man's solution.
+    def const_missing(sym)
+      full_sym   = "#{self.name}::#{sym}"
+      path_parts = full_sym.split("::").map { |part|
+        part.gsub(/([^A-Z])([A-Z]+)/, "\\1_\\2").downcase
+      }
+
+      require File.join(*path_parts)
+
+      # Make sure that we don't get stuck in an endless loop.  `const_get` calls
+      # into `const_missing`, so we can't use that.
+      eval "defined?(#{full_sym}) ? #{full_sym} : super"
+    end
+
+  end
+end

data/lib/cli_forge/version.rb

@@ -0,0 +1,3 @@
+module CLIForge
+  VERSION = "0.0.0"
+end

data/spec/fixtures/autoload_convention/allcaps.rb

@@ -0,0 +1,5 @@
+module Fixtures; end
+
+module Fixtures::AutoloadConvention
+  ALLCAPS = :yelling
+end

data/spec/fixtures/autoload_convention/mismatched.rb

@@ -0,0 +1 @@
+module WrongConstant; end

data/spec/fixtures/autoload_convention/multi_token.rb

@@ -0,0 +1,5 @@
+module Fixtures; end
+
+module Fixtures::AutoloadConvention
+  MultiToken = :multi
+end

data/spec/fixtures/autoload_convention/single.rb

@@ -0,0 +1,5 @@
+module Fixtures; end
+
+module Fixtures::AutoloadConvention
+  Single = :single_and_stuff
+end

data/spec/fixtures/autoload_convention/string.rb

@@ -0,0 +1,5 @@
+module Fixtures; end
+
+module Fixtures::AutoloadConvention
+  String = "I am a string!"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,73 @@
+begin
+  require "spork"
+  require "spork/ext/ruby-debug"
+rescue LoadError
+  # No spork? No problem!
+  module Spork
+    def self.prefork
+      yield
+    end
+
+    def self.each_run
+      yield
+    end
+  end
+end
+
+Spork.prefork do
+  # Allow requires relative to the spec dir
+  SPEC_ROOT = File.expand_path("..", __FILE__)
+  $LOAD_PATH << SPEC_ROOT
+
+  require "rspec"
+  require "timeout"
+
+  # Load our spec environment (random to avoid dependency ordering)
+  Dir[File.join(SPEC_ROOT, "common", "*.rb")].shuffle.each do |helper|
+    require "common/#{File.basename(helper, ".rb")}"
+  end
+
+  RSpec.configure do |config|
+    config.treat_symbols_as_metadata_keys_with_true_values = true
+
+    # We enforce expect(...) style syntax to avoid mucking around in Core
+    config.expect_with :rspec do |c|
+      c.syntax = :expect
+    end
+
+    # Time out specs (particularly useful for mutant)
+    config.around(:each) do |spec|
+      timeout(0.5) { spec.run }
+    end
+
+    # Be verbose about warnings
+    config.around(:each) do |spec|
+      old_verbose = $VERBOSE
+      # Or not at all if we are in mutation testing
+      $VERBOSE = ENV["MUTATION"] ? nil : 2
+
+      spec.run
+
+      $VERBOSE = old_verbose
+    end
+  end
+end
+
+Spork.each_run do
+  # The rspec test runner executes the specs in a separate process; plus it's nice to have this
+  # generic flag for cases where you want coverage running with guard.
+  if ENV["COVERAGE"]
+    require "simplecov"
+
+    if ENV["CONTINUOUS_INTEGRATION"]
+      require "coveralls"
+      Coveralls.wear!
+    end
+  end
+
+  # Because we're an autoloading lib, just require the root up front.
+  #
+  # Must be loaded _after_ `simplecov`, otherwise it won't pick up on requires.
+  require "cli_forge"
+end
+

data/spec/unit/cli_forge/autoload_convention/const_missing_spec.rb

@@ -0,0 +1,49 @@
+describe CLIForge::AutoloadConvention, "#const_missing" do
+
+  let(:namespace) {
+    mod = Module.new do
+      class << self
+        def name
+          "Fixtures::AutoloadConvention"
+        end
+        alias_method :inspect, :name
+      end
+    end
+    mod.extend subject
+
+    mod
+  }
+
+  it "should raise a LoadError when referencing an unknown constant" do
+    expect { namespace::Foo }.to raise_error(LoadError)
+  end
+
+  it "should raise a NameError when the file exists, but the wrong constant is defined" do
+    expect { namespace::Mismatched }.to raise_error(NameError)
+  end
+
+  it "should load single-token files" do
+    namespace.should_receive(:require).with("fixtures/autoload_convention/single").and_call_original
+
+    expect(namespace::Single).to eq(:single_and_stuff)
+  end
+
+  it "should load multi-token files" do
+    namespace.should_receive(:require).with("fixtures/autoload_convention/multi_token").and_call_original
+
+    expect(namespace::MultiToken).to eq(:multi)
+  end
+
+  it "shouldn't split ACRONYMS" do
+    namespace.should_receive(:require).with("fixtures/autoload_convention/allcaps").and_call_original
+
+    expect(namespace::ALLCAPS).to eq(:yelling)
+  end
+
+  it "shouldn't pick up constants in parent namespaces" do
+    namespace.should_receive(:require).with("fixtures/autoload_convention/string").and_call_original
+
+    expect(namespace::String).to eq("I am a string!")
+  end
+
+end

data/tasks/console.rake

@@ -0,0 +1,7 @@
+desc "Boot up a console w/ cli-forge preloaded"
+task :console do
+  require "cli-forge"
+  require "pry"
+
+  Pry.start
+end

data/tasks/spec.rake

@@ -0,0 +1,5 @@
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec) do |task|
+  # No special configuration yet.
+end

data/tasks/spec/ci.rake

@@ -0,0 +1,20 @@
+namespace :spec do
+
+  desc "Run the tests in CI mode"
+  task :ci do
+    prev = ENV["CONTINUOUS_INTEGRATION"]
+    ENV["CONTINUOUS_INTEGRATION"] = "yes"
+
+    # Simplecov doesn't support 1.8
+    unless RUBY_VERSION.start_with? "1.8"
+      Rake::Task["spec:coverage"].execute
+    else
+      Rake::Task["spec"].execute
+    end
+
+    Rake::Task["spec:mutate"].execute
+
+    ENV["CONTINUOUS_INTEGRATION"] = prev
+  end
+
+end

data/tasks/spec/coverage.rake

@@ -0,0 +1,17 @@
+namespace :spec do
+
+  desc "Run tests with code coverage"
+  task :coverage do
+    prev = ENV["COVERAGE"]
+    ENV["COVERAGE"] = "yes"
+
+    Rake::Task["spec"].execute
+
+    if RUBY_PLATFORM.include? "darwin"
+      `open #{File.join(PROJECT_PATH, "coverage", "index.html")}`
+    end
+
+    ENV["COVERAGE"] = prev
+  end
+
+end

data/tasks/spec/mutate.rake

@@ -0,0 +1,50 @@
+namespace :spec do
+
+  def mutant_supported?
+    return false unless RUBY_VERSION.start_with?("1.9")
+
+    begin
+      return false unless RUBY_ENGINE == "ruby" || RUBY_ENGINE == "rbx"
+    rescue NameError
+      return false
+    end
+
+    true
+  end
+
+  desc "Runs tests with code mutation"
+  task :mutate, [:focus_on] do |t, args|
+    next unless mutant_supported?
+
+    require "cli_forge"
+    require "mutant"
+
+    # You can focus on a particular symbol/method by passing it to the task:
+    # rake spec:mutate[AutoloadConvention#const_missing], for example.
+    if args.focus_on
+      matcher = Mutant::Matcher.from_string("::CLIForge::#{args.focus_on}")
+    else
+      matcher = Mutant::Matcher::ObjectSpace.new(/\ACLIForge(::|#|\.).+\Z/)
+    end
+
+    # Mutant doesn't have a public scripting API yet; so we're cheating.
+    config = {}
+    def config.method_missing(sym)
+      self[sym]
+    end
+
+    config.merge!(
+      :strategy => Mutant::Strategy::Rspec::DM2.new(config),
+      :killer   => Mutant::Killer::Rspec,
+      :matcher  => matcher,
+      :filter   => Mutant::Mutation::Filter::ALL,
+      :reporter => Mutant::Reporter::CLI.new(config)
+    )
+
+    ENV["MUTATION"] = "yes"
+    if Mutant::Runner.run(config).fail?
+      exit 1
+    end
+  end
+
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: cli-forge
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Ian MacLeod
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-02 00:00:00.000000000 Z
+dependencies: []
+description: A library for building CLI tools that are intended to be easily extensible
+  (git style)
+email: ian@nevir.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .simplecov
+- .travis.yml
+- Gemfile
+- Guardfile
+- MIT-LICENSE.md
+- README.md
+- Rakefile
+- cli-forge.gemspec
+- lib/cli-forge.rb
+- lib/cli_forge.rb
+- lib/cli_forge/autoload_convention.rb
+- lib/cli_forge/version.rb
+- spec/fixtures/autoload_convention/allcaps.rb
+- spec/fixtures/autoload_convention/mismatched.rb
+- spec/fixtures/autoload_convention/multi_token.rb
+- spec/fixtures/autoload_convention/single.rb
+- spec/fixtures/autoload_convention/string.rb
+- spec/spec_helper.rb
+- spec/unit/cli_forge/autoload_convention/const_missing_spec.rb
+- tasks/console.rake
+- tasks/spec.rake
+- tasks/spec/ci.rake
+- tasks/spec/coverage.rake
+- tasks/spec/mutate.rake
+homepage: http://github.com/nevir/cli-forge
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Beat your CLI tool suites into submission!
+test_files: []