git-style-binaries 0.1.10

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

@@ -0,0 +1,223 @@
+module GitStyleBinary
+class Parser < Trollop::Parser
+  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
+  def short_desc  s=nil; @short_desc = s if s; @short_desc end
+  def name_desc   s=nil; @name_desc = s if s; @name_desc end
+
+  # Set the theme. Valid values are +:short+ or +:long+. Default +:long+
+  attr_writer :theme
+
+  def theme
+    @theme ||= :long
+  end
+ 
+  ## Adds text to the help display.
+  def text s; @order << [:text, s] end
+
+  def spec_names
+    @specs.collect{|name, spec| spec[:long]}
+  end
+
+  # should probably be somewhere else
+  def load_all_commands
+    GitStyleBinary.subcommand_names.each do |name|
+      cmd_file = GitStyleBinary.binary_filename_for(name)
+      GitStyleBinary.load_command_file(name, cmd_file)
+    end
+  end
+
+  ## Print the help message to 'stream'.
+  def educate(stream=$stdout)
+    load_all_commands
+    width # just calculate it now; otherwise we have to be careful not to
+          # call this unless the cursor's at the beginning of a line.
+    GitStyleBinary::Helpers::Pager.run_pager
+    self.send("educate_#{theme}", stream) 
+  end
+
+  def educate_long(stream=$stdout)
+    left = {}
+
+    @specs.each do |name, spec| 
+      left[name] = 
+        ((spec[:short] ? "-#{spec[:short]}, " : "") +
+        "--#{spec[:long]}" +
+        case spec[:type]
+        when :flag; ""
+        when :int; "=<i>"
+        when :ints; "=<i+>"
+        when :string; "=<s>"
+        when :strings; "=<s+>"
+        when :float; "=<f>"
+        when :floats; "=<f+>"
+        end).colorize(:red)
+    end
+
+    leftcol_width = left.values.map { |s| s.length }.max || 0
+    rightcol_start = leftcol_width + 6 # spaces
+    leftcol_start = 6
+    leftcol_spaces = " " * leftcol_start
+
+    unless @order.size > 0 && @order.first.first == :text
+
+      if @name_desc
+        stream.puts "NAME".colorize(:red)
+        stream.puts "#{leftcol_spaces}"+  colorize_known_words(eval(%Q["#{@name_desc}"])) + "\n"
+        stream.puts
+      end
+
+      if @version
+        stream.puts "VERSION".colorize(:red)
+        stream.puts "#{leftcol_spaces}#@version\n"
+      end
+ 
+      stream.puts
+
+      banner = colorize_known_words_array(wrap(eval(%Q["#{@banner}"]) + "\n", :prefix => leftcol_start)) if @banner # lazy banner
+      stream.puts banner
+
+      stream.puts
+      stream.puts "OPTIONS".colorize(:red)
+    else
+      stream.puts "#@banner\n" if @banner
+    end
+
+    @order.each do |what, opt|
+      if what == :text
+        stream.puts wrap(opt)
+        next
+      end
+
+      spec = @specs[opt]
+      stream.printf "    %-#{leftcol_width}s\n", left[opt]
+      desc = spec[:desc] + 
+        if spec[:default]
+          if spec[:desc] =~ /\.$/
+            " (Default: #{spec[:default]})"
+          else
+            " (default: #{spec[:default]})"
+          end
+        else
+          ""
+        end
+      stream.puts wrap("      %s" % [desc], :prefix => leftcol_start, :width => width - rightcol_start - 1 )
+      stream.puts
+      stream.puts
+    end
+
+  end
+
+  def educate_short(stream=$stdout)
+    left = {}
+
+    @specs.each do |name, spec| 
+      left[name] = "--#{spec[:long]}" +
+        (spec[:short] ? ", -#{spec[:short]}" : "") +
+        case spec[:type]
+        when :flag; ""
+        when :int; " <i>"
+        when :ints; " <i+>"
+        when :string; " <s>"
+        when :strings; " <s+>"
+        when :float; " <f>"
+        when :floats; " <f+>"
+        end
+    end
+
+    leftcol_width = left.values.map { |s| s.length }.max || 0
+    rightcol_start = leftcol_width + 6 # spaces
+    leftcol_start = 0
+
+    unless @order.size > 0 && @order.first.first == :text
+      stream.puts "#@version\n" if @version
+      stream.puts colorize_known_words_array(wrap(eval(%Q["#{@banner}"]) + "\n", :prefix => leftcol_start)) if @banner # jit banner
+      stream.puts "Options:"
+    else
+      stream.puts "#@banner\n" if @banner
+    end
+
+    @order.each do |what, opt|
+      if what == :text
+        stream.puts wrap(opt)
+        next
+      end
+
+      spec = @specs[opt]
+      stream.printf "  %#{leftcol_width}s:   ", left[opt]
+      desc = spec[:desc] + 
+        if spec[:default]
+          if spec[:desc] =~ /\.$/
+            " (Default: #{spec[:default]})"
+          else
+            " (default: #{spec[:default]})"
+          end
+        else
+          ""
+        end
+      stream.puts wrap(desc, :width => width - rightcol_start - 1, :prefix => rightcol_start)
+    end
+
+  end
+
+
+  def colorize_known_words_array(txts)
+    txts.collect{|txt| colorize_known_words(txt)}
+  end
+
+  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(:light_blue))  # the current command name
+    txt = txt.gsub(/\[([^\s]+)\]/, "[".colorize(:magenta) + '\1'.colorize(:green) + "]".colorize(:magenta)) # synopsis options
+  end
+
+  def consume(&block)
+    cloaker(&block).bind(self).call
+  end
+
+  def consume_all(blocks)
+    blocks.each {|b| consume(&b)}
+  end
+
+  def bin_name
+    GitStyleBinary.full_current_command_name
+  end
+
+  def all_options_string
+    # '#{spec_names.collect(&:to_s).collect{|name| "[".colorize(:magenta) + "--" + name + "]".colorize(:magenta)}.join(" ")} COMMAND [ARGS]'
+    '#{spec_names.collect(&:to_s).collect{|name| "[" + "--" + name + "]"}.join(" ")} COMMAND [ARGS]'
+  end
+
+  def run(&block)
+    @runs << block
+  end
+  
+  def action(name = :action, &block)
+    block.call(self) if block
+  end
+ 
+end
+end

data/test/fixtures/flickr

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + "/../../lib")
+VERSION="0.0.2" # just to test it
+require 'git-style-binary/command'

data/test/fixtures/flickr-download

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + "/../../lib")
+require 'git-style-binary/command'
+
+GitStyleBinary.command do
+  short_desc "download a flickr image"
+  banner <<-EOS
+SYNOPSIS
+      #{command.full_name} #{all_options_string} url 
+
+Downloads an image from flickr
+
+EOS
+  run do |command|
+    puts "would download: #{command.argv.inspect}"
+  end
+end

data/test/fixtures/wordpress

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + "/../../lib")
+
+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}"
+  end
+end
+
+# OR
+
+# require 'git-style-binary/primary'
+# command = GitStyleBinary::primary("wordpress") do
+#   version "#{$0} 0.0.1 (c) 2009 Nate Murray"
+#   banner <<-EOS
+# usage: #{$0} #{all_options.collect(:&to_s).join(" ")} COMMAND [ARGS]
+#
+# The wordpress subcommands commands are:
+# {subcommand_names.pretty_print}
+#
+# See 'wordpress help COMMAND' for more information on a specific command.
+# EOS
+#   opt :verbose,  "verbose", :default => false
+#   opt :dry,      "dry run", :default => false
+#   opt :test_global, "a basic global string option", :type => String
+# end

data/test/fixtures/wordpress-categories

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + "/../../lib")
+require 'git-style-binary/command'
+
+GitStyleBinary.command do
+  short_desc "do something with categories"
+  banner <<-EOS
+SYNOPSIS
+      #{command.full_name} #{all_options_string}
+
+Does something with categories
+
+EOS
+  run do |command|
+    puts "does something with categories"
+    puts @categories.join(" ")
+  end
+end

data/test/fixtures/wordpress-list

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + "/../../lib")
+require 'git-style-binary/command'
+
+GitStyleBinary.command do
+  short_desc "list blog postings"
+  banner <<-EOS
+SYNOPSIS 
+      #{command.full_name} #{all_options_string}
+
+Lists the posts on the blog
+
+EOS
+  run do |command|
+    puts "listing blog posts"
+  end
+end
+

data/test/fixtures/wordpress-post

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + "/../../lib")
+require 'git-style-binary/command'
+
+GitStyleBinary.command do
+  short_desc "create a blog post"
+  banner <<-EOS
+SYNOPSIS
+      #{command.full_name} #{all_options_string} {content|STDIN} 
+
+EOS
+  opt :blog,     "short name of the blog to use", :default => 'default'
+  opt :category, "tag/category. specify multiple times for multiple categories", :type => String, :multi => true
+  opt :title,    "title for the post", :required => true, :type => String
+  opt :type,     "type of the content [html|xhtml|text]", :default => 'html', :type => String
+
+  run do |command|
+    command.die :type, "type must be one of [html|xhtml|text]" unless command.opts[:type] =~ /^(x?html|text)$/i
+
+    puts "Subcommand name:     #{command.name.inspect}"
+    puts "Options:             #{command.opts.inspect}"
+    puts "Remaining arguments: #{command.argv.inspect}"
+  end
+end
+
+

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

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + "/../test_helper.rb"
+require 'git-style-binary/command'
+
+class CommandTest < Test::Unit::TestCase
+  context "cmd" do
+    setup do
+      @c = GitStyleBinary::Command.new
+    end
+
+    should "be able to easily work with constraints" do
+      assert_equal @c.constraints, []
+      @c.constraints << "foo"
+      assert_equal @c.constraints, ["foo"]
+    end
+    
+  end
+end

data/test/git_style_binary_test.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + "/test_helper.rb"
+
+class GitStyleBinariesTest < Test::Unit::TestCase
+  context "parsing basenames" do
+    should "accurately parse basenames" do
+      assert_equal "wordpress", GitStyleBinary.basename("bin/wordpress")
+      assert_equal "wordpress", GitStyleBinary.basename("bin/wordpress-post")
+      assert_equal "wordpress", GitStyleBinary.basename("wordpress-post")
+    end
+
+    should "get the current command name" do
+      # doesn't really apply any more b/c it calls 'current' which is never the
+      # current when your running rake_test_loader.rb
+      # 
+      # assert_equal "wordpress",  GitStyleBinary.current_command_name("bin/wordpress", ["--help"])
+      # assert_equal "post", GitStyleBinary.current_command_name("bin/wordpress-post", ["--help"])
+      # assert_equal "post", GitStyleBinary.current_command_name("bin/wordpress post", ["--help"])
+      #assert_equal "post", GitStyleBinary.current_command_name("bin/wordpress post", [])
+    end
+  end
+end

data/test/running_binaries_test.rb

@@ -0,0 +1,224 @@
+require File.dirname(__FILE__) + "/test_helper.rb"
+
+THIS_YEAR=Time.now.year # todo
+
+class RunningBinariesTest < Test::Unit::TestCase
+  include RunsBinaryFixtures
+
+  context "when running primary" do
+    ["wordpress -h", "wordpress help"].each do |format|
+      context "and getting help as a '#{format}'" do
+        setup { @stdout, @stderr = bin(format) }
+
+        should "have the command name and short description" do
+          unless format == "wordpress -h" # doesn't apply to wordpress -h
+            output_matches /NAME\n\s*wordpress\-help \- get help for a specific command/m
+          end
+        end
+
+        should "have a local (not default) version string" do
+          output_matches /0\.0\.1 \(c\) 2009 Nate Murray - local/
+        end
+
+        should "get a list of subcommands" do
+          output_matches /subcommands/mi
+        end
+
+        should "have subcommand short descriptions" do
+          output_matches /post\s*create a blog post/
+          output_matches /categories\s*do something with categories/
+          output_matches /help\s*get help for a specific command/
+          output_matches /list\s*list blog postings/
+        end
+
+        should "have a usage" do
+          output_matches /SYNOPSIS/i
+          output_matches /wordpress(\-help)? \[/
+        end
+
+        should "be able to ask for help about help"
+      end
+    end
+
+    context "and getting help as subcommand" do
+      # ["wordpress -h", "wordpress help"].each do |format|
+      ["wordpress help"].each do |format|
+        context "'#{format}'" do
+          should "get help on subcommand post"
+        end
+      end
+    end
+
+    context "with no options" do
+      setup { @stdout, @stderr = bin("wordpress") }
+
+      should "output the options" do
+        output_matches /Primary Options:/
+      end
+
+      should "have the test_primary option" do
+        output_matches /test_primary=>nil/
+      end
+    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
+    ["wordpress-post", "wordpress post"].each do |bin_format|
+      context "#{bin_format}" do
+
+        context "with no options" do
+          setup { @stdout, @stderr = bin("#{bin_format}") }
+          should "fail because title is required" do
+            output_matches /Error: option 'title' must be specified.\s*Try --help for help/m
+          end
+        end
+
+        context "with options" do
+          setup { @stdout, @stderr = bin("#{bin_format} --title='glendale'") }
+          should "be running the subcommand's run block" do
+            output_matches /Subcommand name/
+          end
+          should "have some default options" do
+            output_matches /version=>false/
+            output_matches /help=>false/
+          end
+          should "have some primary options" do
+            output_matches /test_primary=>nil/
+          end
+          should "have some local options" do
+            output_matches /title=>"glendale"/
+            output_matches /type=>"html"/
+          end
+        end
+
+        context "testing die statements" do
+          setup { @stdout, @stderr = bin("#{bin_format} --title='glendale' --type=yaml") }
+
+          should "die on invalid options"  do
+            output_matches /argument \-\-type type must be one of \[html\|xhtml\|text\]/
+          end
+        end
+
+      end # end bin_format
+    end # end #each
+  end
+
+  ["wordpress help post", "wordpress post -h"].each do |format| 
+    context "when calling '#{format}'" do
+      
+      setup { @stdout, @stderr = bin(format) }
+      should "have a description" do
+        output_matches /create a blog post/
+      end
+
+      should "have the proper usage line" do
+        output_matches /SYNOPSIS\n\s*wordpress\-post/m
+        output_matches /\[--title\]/
+      end
+
+      should "have option flags" do
+        output_matches /\-\-title(.*)<s>/
+      end
+
+      should "have primary option flags" do
+        output_matches /\-\-test-primary(.*)<s>/
+      end
+
+      should "have default option flags" do
+        output_matches /\-\-verbose/
+      end
+
+      should "have trollop default option flags" do
+        output_matches /\-e, \-\-version/
+      end
+
+      should "have the correct binary name and short description" do
+        output_matches /NAME\n\s*wordpress\-post \- create a blog post/m
+      end
+
+      should "have a the primaries version string" do
+         output_matches /0\.0\.1 \(c\) 2009 Nate Murray - local/
+      end
+
+      should "have options" do
+        output_matches /Options/i
+
+        output_matches /\-b, \-\-blog=<s>/
+        output_matches /short name of the blog to use/
+
+        output_matches /-i, \-\-title=<s>/
+        output_matches /title for the post/
+      end
+
+    end
+  end
+
+  context "when running a bare primary" do
+    ["flickr -h", "flickr help"].each do |format|
+      context format do
+        setup { @stdout, @stderr = bin(format) }
+
+        should "have the name and short description" do
+          unless format == "flickr -h" # hmm
+            output_matches /NAME\n\s*flickr\-help \- get help for a specific command/m
+          end
+        end
+
+        should "have a local (not default) version string" do
+          output_matches /0\.0\.2 \(c\) 2009/
+        end
+      end
+    end
+    ["flickr-download -h", "flickr download -h"].each do |format|
+      context format do
+       setup { @stdout, @stderr = bin(format) }
+
+       should "match on usage" do
+         output_matches /SYNOPSIS\n\s*flickr\-download/m
+       end
+      end
+    end
+  end
+
+end