jashmenn-git-style-binaries 0.1.4 → 0.1.5

data/README.markdown

@@ -9,6 +9,12 @@ This gem uses [`trollop`](http://trollop.rubyforge.org/) for option parsing
 
     gem install jashmenn-git-style-binaries --source=http://gems.github.com
 
+## Try it out
+
+    cd `gem env gemdir`/gems/jashmenn-git-style-binaries-0.1.4/test/fixtures
+    ./wordpress -h
+    ./wordpress help post
+
 ## Goal
 
 Lets use the imaginary `wordpress` gem. Let's say we have three different
@@ -197,6 +203,12 @@ Option parsing is done by [trollop](http://trollop.rubyforge.org/).
 documentation](http://trollop.rubyforge.org/) for information on how to setup
 the options and flags.
 
+## Callbacks
+
+Callbacks are available on the primary and subcommands. Available callbacks currently
+are before/after_run. These execute before the run block of the command parser and take
+take one argument, which is the command itself
+
 ## The `run` block
 
 To get the 'introspection' on the individual binaries every binary is `load`ed
@@ -234,6 +246,9 @@ Play with the examples in the `test/fixtures` directory.
 * A few places of really ugly code
 * A feeling that this could be done in 1/2 lines of code
 
+## Authors
+By Nate Murray and Ari Lerner
+
 ## Copyright
 
 The MIT License

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 0
 :minor: 1
-:patch: 4
+:patch: 5

data/lib/git-style-binary/command.rb

@@ -31,7 +31,7 @@ module GitStyleBinary
           version "#{version_string} (c) #{Time.now.year}"
           banner <<-EOS
 #{"SYNOPSIS".colorize(:red)}
-      #{command.full_name.colorize(:blue)} #{all_options_string}
+      #{command.full_name.colorize(:light_blue)} #{all_options_string}
 
 #{"SUBCOMMANDS".colorize(:red)}
    \#{GitStyleBinary.pretty_known_subcommands.join("\n   ")}
@@ -67,11 +67,11 @@ module GitStyleBinary
     end
 
     def run
-      GitStyleBinary.load_primary    unless is_primary?
+      GitStyleBinary.load_primary    unless is_primary?      
       GitStyleBinary.load_subcommand if is_primary? && running_subcommand?
       load_all_parser_constraints
       @opts = process_args_with_subcmd
-      call_parser_run_block
+      call_parser_run_block      
       self
     end
 
@@ -109,7 +109,10 @@ module GitStyleBinary
 
     def call_parser_run_block
       runs = GitStyleBinary.current_command.parser.runs
+      
+      parser.run_callbacks(:before_run, self)
       parser.runs.last.call(self) # ... not too happy with this
+      parser.run_callbacks(:after_run, self)      
     end
 
     def process_args_with_subcmd(args = ARGV, *a, &b)
@@ -181,6 +184,11 @@ module GitStyleBinary
       Trollop.instance_eval { @p = p }
       Trollop::die(arg, msg)
     end
+    
+    # Helper to return the option
+    def [](k)
+      opts[k]
+    end
 
   end
 

data/lib/git-style-binary/helpers/name_resolver.rb

@@ -69,7 +69,7 @@ module Helpers
       GitStyleBinary.known_commands.collect do |k,cmd| 
         next if k == basename 
         cmd.process_parser!
-        ("%-s%s%-10s" % [basename, '-', k]).colorize(:blue) + "\n       " + ("%s" % [cmd.short_desc]) + "\n"
+        ("%-s%s%-10s" % [basename, '-', k]).colorize(:light_blue) + "\n       " + ("%s" % [cmd.short_desc]) + "\n"
       end.compact.sort
     end
 

data/lib/git-style-binary/parser.rb

@@ -1,12 +1,27 @@
 module GitStyleBinary
 class Parser < Trollop::Parser
-  attr_reader :runs
+  attr_reader :runs, :callbacks
   attr_reader :short_desc
   attr_accessor :command
 
   def initialize *a, &b
     super
     @runs = []
+    setup_callbacks    
+  end
+  
+  def setup_callbacks
+    @callbacks =  {}
+    %w(run).each do |event|
+      %w(before after).each do |time|
+        @callbacks["#{time}_#{event}".to_sym] = []
+        instance_eval "def #{time}_#{event}(&block);@callbacks[:#{time}_#{event}] << block;end"
+      end
+    end
+  end
+  
+  def run_callbacks(at, from)
+    @callbacks[at].each {|c| c.call(from) }
   end
 
   def banner      s=nil; @banner     = s if s; @banner     end
@@ -175,7 +190,7 @@ class Parser < Trollop::Parser
 
   def colorize_known_words(txt)
     txt = txt.gsub(/^([A-Z]+\s*)$/, '\1'.colorize(:red))       # all caps words on their own line
-    txt = txt.gsub(/\b(#{bin_name})\b/, '\1'.colorize(:blue))  # the current command name
+    txt = txt.gsub(/\b(#{bin_name})\b/, '\1'.colorize(:light_blue))  # the current command name
     txt = txt.gsub(/\[([^\s]+)\]/, "[".colorize(:magenta) + '\1'.colorize(:green) + "]".colorize(:magenta)) # synopsis options
   end
 
@@ -199,6 +214,10 @@ class Parser < Trollop::Parser
   def run(&block)
     @runs << block
   end
+  
+  def action(name = :action, &block)
+    block.call(self) if block
+  end
  
 end
 end

data/test/fixtures/wordpress

@@ -5,6 +5,18 @@ require 'git-style-binary/command'
 GitStyleBinary.primary do
   version "0.0.1 (c) 2009 Nate Murray - local"
   opt :test_primary, "test an option on the primary", :type => String
+  
+  action do
+    @categories = ["sports", "news"]
+  end
+  
+  before_run do |cmd|
+    puts "before_run command #{cmd}"
+  end
+  
+  after_run do |cmd|
+    puts "after_run command #{cmd}"
+  end
 
   run do |command|
     puts "Primary Options: #{command.opts.inspect}"

data/test/fixtures/wordpress-categories

@@ -13,5 +13,6 @@ Does something with categories
 EOS
   run do |command|
     puts "does something with categories"
+    puts @categories.join(" ")
   end
 end

data/test/git-style-binary/command_test.rb

@@ -12,5 +12,6 @@ class CommandTest < Test::Unit::TestCase
       @c.constraints << "foo"
       assert_equal @c.constraints, ["foo"]
     end
+    
   end
 end

data/test/running_binaries_test.rb

@@ -62,6 +62,45 @@ class RunningBinariesTest < Test::Unit::TestCase
     end
     should "be able to require 'primary' and run just fine"
   end
+  
+  context "when running with an action" do
+    # should be the same for both formats
+    ["wordpress-categories", "wordpress categories"].each do |bin_format|
+      context "#{bin_format}" do
+
+        context "with action block" do
+          setup { @stdout, @stderr = bin("#{bin_format}") }
+          should "have the parsed action items in the help output" do
+            output_matches /sports news/m
+          end
+        end
+      end
+    end
+  end
+  
+  context "callbacks" do
+    context "on a binary" do
+      setup { @stdout, @stderr = bin("wordpress") }
+
+      %w(before after).each do |time|
+        should "run the callback #{time}_run}" do
+          assert @stdout.match /#{time}_run command/
+        end
+      end      
+    end
+    
+    context "on help" do
+      setup { @stdout, @stderr = bin("wordpress -h") }
+
+      %w(before after).each do |time|
+        should "not run the callback #{time}_run" do
+          assert_nil @stdout.match /#{time}_run command/
+        end
+      end      
+    end
+    
+  end
+  
 
   context "when running the subcommand" do
     # should be the same for both formats

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jashmenn-git-style-binaries
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Nate Murray
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-05-08 00:00:00 -07:00
+date: 2009-05-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency