codeunion 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 52ea6972b9909f54b51efc7492a367c1a52b390e
-  data.tar.gz: b107ddbc578eb45603bbac1f1aa804938508f48b
+  metadata.gz: 6501d0e9cfb4ee5627e21baa3a9afc82308b3bd5
+  data.tar.gz: 0a2a9c950509570e6a5c0888580bb2a1efae34e8
 SHA512:
-  metadata.gz: cfa18400fa8db69c0d40157fc8f1f2bd28b8475e0875278abf50585f50f8ae6c67dae18db445b8997da2abb2dfc881ca24d9097e88b1a358b070ab2730211ef3
-  data.tar.gz: 0ad6a777f8a1949284c155c49b73cca2185ce251068ef437fac55c953f45d6182fcf253bf6b1ca1d371decbdd93d4440b6680b19c6b0bdcc3f68f3ca711f6395
+  metadata.gz: 952ecd7fd62f6f64fb7fe4c9a622077ca2d9af7a3d37161e6e41694f2cbcae9261853ed3a073ee7172514a0faaf02905a8c5e7f3234f18e603017320b719594f
+  data.tar.gz: 086239d08ac7c5465ce95b527c190960bf2812ea792ee2fb930eaeecc274f4a29eb870e8e78306bfdc8c5f98ec654a617e71b328205448ed5c7b276a0d10c1ff

data/README.md

@@ -21,18 +21,98 @@ $ rbenv rehash
 after you install the gem.  This is required for rbenv to pick up any new
 executables installed by a gem, including ours.
 
+## Getting Started
+
+Once you've installed the gem, you will be able to run the `codeunion` command:
+
+```shell-session
+$ codeunion
+```
+
+To run a particular subcommand, add it to the `codeunion` base command. For example, to use the search command you would run:
+
+```shell-session
+$ codeunion search [your search query]
+```
+
+You can see a help window for any subcommand by appending a `-h` or `--help` flag:
+
+```shell-session
+$ codeunion search -h
+Usage: codeunion search [options] <terms>
+
+Options:
+-c, --category   CATEGORY        Display config variable NAME
+-h, --help                       Print this help message
+```
+
 ## Subcommands
 
-The command-line tool is organized into subcommands, a la git.  If we were to
-run this command, for example
+#### Config
+
+Read and write configuration for the CodeUnion command-line tool.
+
+Example usage:
 
 ```shell-session
-$ codeunion waffles
+# Set the feedback.repository value
+$ codeunion config feedback.repository codeunion/feedback-requests-web-fundamentals
+
+# Get the feedback.repository value
+$ codeunion config feedback.repository
+codeunion/feedback-requests-web-fundamentals
 ```
 
-the CodeUnion tool would look for an executable named `codeunion-waffles`.  If
-the executable exists, the tool will run it.  If it doesn't exist, we would see
-a `CommandNotFound` error.
+#### Feedback
+
+Request feedback on your code.
+
+Feedback requests require a URL for a _specific commit_ or a _pull request_.
+
+Example usage:
+
+```shell-session
+$ codeunion feedback request https://github.com/codeunion/overheard-server/commit/0edb7866809620013d4a3c2d3b5bea57b12bf255
+```
+
+Run `codeunion feedback -h` for more information.
+
+#### Search
+
+Search the repositories in the CodeUnion curriculum.
+
+Example usage:
+
+```shell-session
+$ codeunion search html
+  Project: social-wall
+  Your First Web Application
+  https://github.com/codeunion/social-wall
+  tags:
+  Excerpt: HTML templating and ERB - Deploying an application to Heroku
+  The following video tutorials are all based...
+
+  [...]
+```
+
+You can narrow your searches by category with the `--category` flag.
+
+
+```shell-session
+$ codeunion search html --category example
+```
+
+Or you can use the alias commands to narrow your search to either `projects` or `examples`.
+
+```shell-session
+$ codeunion examples html
+```
+
+...and...
+
+```shell-session
+$ codeunion projects html
+```
 
 ## Development
 
@@ -46,3 +126,16 @@ make unit-test    # Runs the unit tests against all ruby versions. Thread-safe.
 make feature-test # Runs the feature tests against all ruby versions. Not-thread-safe.
 make test         # Runs unit and feature tests against all ruby versions
 ```
+
+### How Subcommands Work
+
+The command-line tool is organized into subcommands, a la git.  If we were to
+run this command, for example
+
+```shell-session
+$ codeunion waffles
+```
+
+the CodeUnion tool would look for an executable named `codeunion-waffles`.  If
+the executable exists, the tool will run it.  If it doesn't exist, we would see
+a `CommandNotFound` error.

data/bin/codeunion

@@ -9,9 +9,53 @@ bin_file = Pathname.new(__FILE__).realpath
 $LOAD_PATH.unshift File.expand_path("../../lib", bin_file)
 
 # Add our gem-specific "libexec" directory to the PATH
-ENV["PATH"] += ":" + File.expand_path("../../libexec", bin_file)
+subcmd_dir = File.expand_path("../../libexec", bin_file)
+ENV["PATH"] += ":" + subcmd_dir
+
+# Find all available subcommands
+subcmd_prefix = "codeunion-"
+subcmd_files  = Pathname.glob(File.join(subcmd_dir, subcmd_prefix + "*"))
+
+SUBCOMMANDS = subcmd_files.map do |path|
+  path.basename.to_s[/#{subcmd_prefix}(.+)/, 1]
+end
 
 require "codeunion/command/main"
+require "optparse"
+
+description = <<HELP
+The CodeUnion command-line tool is meant to be used in conjunction with CodeUnion's curriculum.
+
+Think of it as your "learning sherpa."
+HELP
+
+parser = OptionParser.new do |opts|
+  opts.instance_exec do
+    self.banner = "Usage: codeunion <command>"
+
+    separator ""
+    separator description
+
+    separator ""
+    separator "Commands:"
+    separator SUBCOMMANDS.map { |subcmd| summary_indent + subcmd }
+
+    separator ""
+    separator "Options:"
+
+    on_tail("-h", "--help", "Print this help message") do
+      puts self
+      exit
+    end
+  end
+end
+
+parser.order!
+
+if ARGV.empty?
+  puts parser
+  exit
+end
 
 options = {
   :command_name => ARGV.first,

data/lib/codeunion/version.rb

@@ -1,3 +1,3 @@
 module CodeUnion
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeunion
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Jesse Farmer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2015-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -229,4 +229,3 @@ test_files:
 - test/unit/feedback_request_test.rb
 - test/unit/fixtures/sample_config
 - test/unit/search_test.rb
-has_rdoc: