batcave 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+.*.swp

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gem "clamp"

data/Gemfile.lock

@@ -0,0 +1,10 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    clamp (0.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  clamp

data/README.md

@@ -0,0 +1,28 @@
+# batcave
+
+Wikipedia on "Batcave" uses:
+
+> Upon his initial foray into crime-fighting, Wayne used the caves as a sanctum
+> and to store his then-minimal equipment. As time went on, Wayne found the place
+> ideal to create a stronghold for his war against crime, and has incorporated a
+> plethora of equipment as well as expanding the cave for specific uses.
+
+As in coding, you start with some minimal tools and gradually find better
+tools, better flows, etc.
+
+This project is an experiment to try and make batcave construction possible.
+
+Maybe, for example, I'm writing an HTTP library in Ruby, and I want to:
+
+* run whatever services I need to test this code (like a webserver)
+* run tests whenever I modify the code.
+* make sure all methods have docstrings (with YARD)
+* have some useful debugging tools.
+
+But new projects should be easier:
+
+* create a 'go' project with a layout that works well with 'goinstall'
+* create a 'ruby' project with a standard layout, Gemfile, gemspec, etc
+* etc.
+
+Release management should be easier, too. 

data/batcave.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |spec|
+  files = %x{git ls-files}.split("\n")
+
+  spec.name = "batcave"
+  spec.version = "0.0.1"
+  spec.summary = "Experiments in tools, boilerplatery, debugging, etc."
+  spec.summary = spec.description
+  spec.add_dependency("clamp")
+  spec.files = files
+  spec.bindir = "bin"
+  spec.executables << "dk"
+
+  spec.author = "Jordan Sissel"
+  spec.email = "jls@semicomplete.com"
+  spec.homepage = "https://github.com/jordansissel/batcave"
+end
+

data/bin/dk

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "clamp"
+
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+require "batcave/main"
+BatCave::Main.run

data/lib/batcave/command/add.rb

@@ -0,0 +1,63 @@
+require "clamp"
+require "batcave/namespace"
+require "batcave/support/git"
+require "fileutils"
+
+class BatCave::Command::Add < Clamp::Command
+  include BatCave::Support::Git
+
+  option ["-n", "--name"], "NAME",
+    "the application or library name", :attribute_name => :name
+
+  parameter "THING",
+    "The thing to add to your batcave", :attribute_name => :thing
+
+  def execute
+    # TODO(sissel): Move this stuff into a proper batcave library
+
+    found = false
+    # look for the 'thing/' or if it's a directory try 'thing/self/'
+    [ @thing, File.join(@thing, "self") ].each do |thing|
+      path = File.join(BatCave::THINGSDIR, thing)
+      config = File.join(path, "THING")
+      if File.exists?(config)
+        found = true
+        use(path)
+        break
+      end
+    end
+
+    if !found
+      puts "Could not find any thing '#{@thing}'"
+    end
+  end # def execute
+
+  def use(dir)
+    config = File.join(dir, "THING")
+    paths = Dir.glob(File.join(dir, "**", "*"))
+
+    paths.each do |path|
+      next if path == config # skip the 'THING' file
+      localpath = File.join(project_root, path[dir.length + 1 .. -1])
+
+      if localpath.include?("{name}")
+        if @name.nil?
+          raise "Path requires '--name' flag to be set: #{localpath.inspect}"
+        end
+        localpath.gsub!("{name}", @name)
+      end
+
+      # Replace '{...}' in localpath
+
+      # TODO(sissel): if this is a directory, create it.
+      # TODO(sissel): if this a file, copy it.
+      if File.directory?(path)
+        FileUtils.mkdir_p(localpath) unless File.directory?(localpath)
+      else
+        localdir = File.dirname(localpath)
+        FileUtils.mkdir_p(localdir) unless File.directory?(localdir)
+        FileUtils.cp(path, localpath)
+      end
+    end
+  end
+end

data/lib/batcave/command/update.rb

@@ -0,0 +1,8 @@
+require "clamp"
+require "batcave/namespace"
+
+class BatCave::Command::Update < Clamp::Command
+  def execute
+    p :Updating
+  end
+end

data/lib/batcave/main.rb

@@ -0,0 +1,13 @@
+require "clamp"
+require "batcave/namespace"
+require "batcave/command/add"
+require "batcave/command/update"
+
+class BatCave::Main < Clamp::Command
+  # Add something to your bat cave. 
+  subcommand "add", "Add something to your batcave", BatCave::Command::Add
+
+  # Update the batcave from upstream. This will keep you updated with
+  # the latest in gadgets and useful tools.
+  subcommand "update", "Update the things in your bat cave.", BatCave::Command::Update
+end

data/lib/batcave/namespace.rb

@@ -0,0 +1,5 @@
+module BatCave
+  module Command; end
+  module Support; end # TODO(sissel): Support is a shitty namespace name.
+  THINGSDIR = File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "things"))
+end

data/lib/batcave/support/git.rb

@@ -0,0 +1,11 @@
+require "batcave/namespace"
+
+module BatCave::Support::Git
+  def project_root
+    root = %x{git rev-parse --show-toplevel}.chomp
+    if $?.exitstatus != 0
+      raise "'git rev-parse --show-toplevel' failed. No project root found. Is this in a git clone?"
+    end
+    return root
+  end # def project_root
+end # class BatCave::Support::Git

data/things/go/self/src/{name}/{name}.go

@@ -0,0 +1,10 @@
+package main
+
+import (
+  "fmt"
+)
+
+func main() {
+  fmt.Println("Hello world")
+}
+

data/things/ruby/self/Gemfile

@@ -0,0 +1 @@
+source :rubygems

data/things/ruby/self/THING

@@ -0,0 +1 @@
+boilerplate = [ "Gemfile" ]

data/things/ruby/self/test/all.rb

@@ -0,0 +1,24 @@
+require "rubygems"
+require "minitest/spec"
+require "minitest/autorun"
+
+# Get coverage report
+require "simplecov"
+SimpleCov.start
+
+# Add '../lib' to the require path.
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+
+def use(path)
+  puts "Loading tests from #{path}"
+  require File.expand_path(path)
+end
+
+dirname = File.dirname(__FILE__)
+use File.join(dirname, "docs.rb")
+
+# Load tests from ./*/**/*.rb (usually ./libraryname/....)
+glob = File.join(dirname, "*", "**", "*.rb")
+Dir.glob(glob).each do |path|
+  use path
+end

data/things/ruby/self/test/docs.rb

@@ -0,0 +1,40 @@
+require "rubygems"                                                                                               
+require "yard"                                                                                                   
+require File.join(File.expand_path(File.dirname(__FILE__)), "testing")
+
+describe "documentation tests" do
+  before do
+    # Use YARD to parse all ruby files found in '../lib'
+    libdir = File.join(File.dirname(__FILE__), "..", "lib")
+    YARD::Registry.load(Dir.glob(File.join(libdir, "**", "*.rb")))
+    @registry = YARD::Registry.all
+  end
+
+  test "All classes, methods, modules, and constants must be documented" do
+    # Note, the 'find the undocumented things' code here is 
+    # copied mostly from: YARD 0.7.5's lib/yard/cli/stats.rb
+    #
+    # Find all undocumented classes, modules, and constants
+    undocumented = @registry.select do |o| 
+      [:class, :module, :constant].include?(o.type) && o.docstring.blank?
+    end
+
+    # Find all undocumented methods
+    methods = @registry.select { |m| m.type == :method }
+    methods.reject! { |m| m.is_alias? || !m.is_explicit? }
+    undocumented += methods.select do |m| 
+      m.docstring.blank? && !m.overridden_method
+    end
+
+    if (undocumented.length > 0)
+      message = ["The following are not documented"]
+      undocumented.each do |o|
+        message << "* #{o.type.to_s} #{o.to_s} <#{o.file}:#{o.line}>"
+      end
+
+      flunk(message.join("\n"))
+    else
+      pass
+    end
+  end
+end

data/things/ruby/self/test/testing.rb

@@ -0,0 +1,14 @@
+require "rubygems"
+require "minitest/spec"
+
+# Add '../lib' to the require path.
+$: << File.join(File.dirname(__FILE__), "..", "lib")
+
+# I don't really like monkeypatching, but whatever, this is probably better
+# than overriding the 'describe' method.
+class MiniTest::Spec
+  class << self
+    # 'it' sounds wrong, call it 'test'
+    alias :test :it
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: batcave
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jordan Sissel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: clamp
+  requirement: &17501600 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *17501600
+description: 
+email: jls@semicomplete.com
+executables:
+- dk
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- batcave.gemspec
+- bin/dk
+- lib/batcave/command/add.rb
+- lib/batcave/command/update.rb
+- lib/batcave/main.rb
+- lib/batcave/namespace.rb
+- lib/batcave/support/git.rb
+- things/go/self/THING
+- things/go/self/src/{name}/{name}.go
+- things/ruby/self/Gemfile
+- things/ruby/self/THING
+- things/ruby/self/test/all.rb
+- things/ruby/self/test/docs.rb
+- things/ruby/self/test/testing.rb
+homepage: https://github.com/jordansissel/batcave
+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.10
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []
+has_rdoc: