jashmenn-git-style-binaries 0.1.3

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

@@ -0,0 +1,196 @@
+require 'git-style-binary'
+
+module GitStyleBinary
+  def self.command(&block)
+    returning Command.new(:constraints => [block]) do |c|
+      c.name ||= (GitStyleBinary.name_of_command_being_loaded || GitStyleBinary.current_command_name)
+      GitStyleBinary.known_commands[c.name] = c
+
+      if !GitStyleBinary.current_command || GitStyleBinary.current_command.is_primary?
+        GitStyleBinary.current_command = c
+      end
+    end
+  end
+
+  def self.primary(&block)
+    returning Primary.new(:constraints => [block]) do |c|
+      c.name ||= (GitStyleBinary.name_of_command_being_loaded || GitStyleBinary.current_command_name)
+      GitStyleBinary.known_commands[c.name] = c
+
+      GitStyleBinary.primary_command = c unless GitStyleBinary.primary_command
+      GitStyleBinary.current_command = c unless GitStyleBinary.current_command
+    end
+  end
+
+  class Command
+    class << self
+      def defaults
+        lambda do
+          name_desc "#{command.full_name}\#{command.short_desc ? ' - ' + command.short_desc : ''}" # eval jit
+          version_string = defined?(VERSION) ? VERSION : "0.0.1"
+          version "#{version_string} (c) #{Time.now.year}"
+          banner <<-EOS
+#{"SYNOPSIS".colorize(:red)}
+      #{command.full_name.colorize(:blue)} #{all_options_string}
+
+#{"SUBCOMMANDS".colorize(:red)}
+   \#{GitStyleBinary.pretty_known_subcommands.join("\n   ")}
+
+  See '#{command.full_name} help COMMAND' for more information on a specific command.
+        EOS
+
+          opt :verbose,  "verbose", :default => false
+        end
+      end
+    end
+
+    attr_reader :constraints
+    attr_reader :opts
+    attr_accessor :name
+
+    def initialize(o={})
+      o.each do |k,v|
+        eval "@#{k.to_s}= v"
+      end
+    end
+
+    def parser
+      @parser ||= begin 
+                    p = Parser.new
+                    p.command = self
+                    p
+                  end
+    end
+
+    def constraints
+      @constraints ||= []
+    end
+
+    def run
+      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
+      self
+    end
+
+    def running_subcommand?
+      GitStyleBinary.valid_subcommand?(GitStyleBinary.current_command_name)
+    end
+
+    def load_all_parser_constraints
+      @loaded_all_parser_constraints ||= begin
+        load_parser_default_constraints
+        load_parser_primary_constraints
+        load_parser_local_constraints
+        true
+      end
+    end
+
+    def load_parser_default_constraints
+      parser.consume_all([self.class.defaults])
+    end
+
+    def load_parser_primary_constraints
+      parser.consume_all(GitStyleBinary.primary_command.constraints)
+    end
+
+    def load_parser_local_constraints 
+      cur = GitStyleBinary.current_command # see, why isn't 'this' current_command?
+
+      unless self.is_primary? && cur == self
+        # TODO TODO - the key lies in this function. figure out when you hav emore engergy
+        # soo UGLY. see #process_parser! unify with that method
+        # parser.consume_all(constraints) rescue ArgumentError
+        parser.consume_all(cur.constraints)
+      end
+    end
+
+    def call_parser_run_block
+      runs = GitStyleBinary.current_command.parser.runs
+      parser.runs.last.call(self) # ... not too happy with this
+    end
+
+    def process_args_with_subcmd(args = ARGV, *a, &b)
+      cmd = GitStyleBinary.current_command_name
+      vals = process_args(args, *a, &b)
+      parser.leftovers.shift if parser.leftovers[0] == cmd
+      vals
+    end
+
+    # TOOooootally ugly! why? bc load_parser_local_constraints doesn't work
+    # when loading the indivdual commands because it depends on
+    # #current_command. This really sucks and is UGLY. 
+    # the todo is to put in 'load_all_parser_constraints' and this works
+    def process_parser!
+      # load_all_parser_constraints
+
+      load_parser_default_constraints
+      load_parser_primary_constraints
+      # load_parser_local_constraints
+      parser.consume_all(constraints)
+
+      # hack
+      parser.consume { 
+        opt :version, "Print version and exit" if @version unless @specs[:version] || @long["version"]
+        opt :help, "Show this message" unless @specs[:help] || @long["help"]
+        resolve_default_short_options
+      } # hack
+    end
+
+    def process_args(args = ARGV, *a, &b)
+      p = parser
+      begin
+        vals = p.parse args
+        args.clear
+        p.leftovers.each { |l| args << l }
+        vals # ugly todo
+      rescue Trollop::CommandlineError => e
+        $stderr.puts "Error: #{e.message}."
+        $stderr.puts "Try --help for help."
+        exit(-1)
+      rescue Trollop::HelpNeeded
+        p.educate
+        exit
+      rescue Trollop::VersionNeeded
+        puts p.version
+        exit
+      end
+    end
+
+    def is_primary?
+      false
+    end
+
+    def argv
+      parser.leftovers
+    end
+
+    def short_desc 
+      parser.short_desc
+    end
+
+    def full_name
+      # ugly, should be is_primary?
+      GitStyleBinary.primary_name == name ? GitStyleBinary.primary_name : GitStyleBinary.primary_name + "-" + name
+    end
+
+    def die arg, msg=nil
+      p = parser # create local copy
+      Trollop.instance_eval { @p = p }
+      Trollop::die(arg, msg)
+    end
+
+  end
+
+  class Primary < Command
+    def is_primary?
+      true
+    end
+    def primary
+      self
+    end
+  end
+
+end

data/lib/git-style-binary/commands/help.rb

@@ -0,0 +1,32 @@
+module GitStyleBinary
+  module Commands
+    class Help
+      # not loving this syntax, but works for now
+      GitStyleBinary.command do
+        short_desc "get help for a specific command"
+        run do |command|
+
+          # this is slightly ugly b/c it has to muck around in the internals to
+          # get information about commands other than itself. This isn't a
+          # typical case
+          def educate_about_command(name)
+            load_all_commands
+            if GitStyleBinary.known_commands.has_key?(name)
+              cmd = GitStyleBinary.known_commands[name]
+              cmd.process_parser!
+              cmd.parser.educate
+            else
+              puts "Unknown command '#{name}'"
+            end
+          end
+
+          if command.argv.size > 0
+            command.argv.first == "help" ? educate : educate_about_command(command.argv.first)
+          else
+            educate
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+module GitStyleBinary
+module Helpers
+  module NameResolver
+
+    def basename(filename=zero)
+      File.basename(filename).match(/(.*?)(\-|$)/).captures.first
+    end
+    alias_method :primary_name, :basename
+
+    # checks the bin directory for all files starting with +basename+ and
+    # returns an array of strings specifying the subcommands
+    def subcommand_names(filename=zero)
+      subfiles = Dir[File.join(binary_directory, basename + "-*")]
+      cmds = subfiles.collect{|file| File.basename(file).sub(/^#{basename}-/, '')}.sort
+      cmds += built_in_command_names
+      cmds.uniq
+    end
+
+    def binary_directory(filename=zero)
+      File.dirname(filename)
+    end
+
+    def built_in_commands_directory
+      File.dirname(__FILE__) + "/../commands"
+    end
+
+    def built_in_command_names
+      Dir[built_in_commands_directory + "/*.rb"].collect{|f| File.basename(f.sub(/\.rb$/,''))}
+    end
+
+    def list_subcommands(filename=zero)
+      subcommand_names(filename).join(", ")
+    end
+
+    # load first from users binary directory. then load built-in commands if
+    # available
+    def binary_filename_for(name)
+      user_file = File.join(binary_directory, "#{basename}-#{name}") 
+      return user_file if File.exists?(user_file)
+      built_in = File.join(built_in_commands_directory, "#{name}.rb") 
+      return built_in if File.exists?(built_in)
+      user_file
+    end
+
+    def current_command_name(filename=zero,argv=ARGV)
+      current = File.basename(zero)
+      first_arg = ARGV[0]
+      return first_arg if valid_subcommand?(first_arg)
+      return basename if basename == current
+      current.sub(/^#{basename}-/, '')
+    end
+
+    # returns the command name with the prefix if needed
+    def full_current_command_name(filename=zero,argv=ARGV)
+      cur = current_command_name(filename, argv)
+      subcmd = cur == basename(filename) ? false : true # is this a subcmd?
+      "%s%s%s" % [basename(filename), subcmd ? "-" : "", subcmd ? current_command_name(filename, argv) : ""]
+    end
+
+    def valid_subcommand?(name)
+      subcommand_names.include?(name)
+    end
+
+    def zero
+      $0
+    end
+
+    def pretty_known_subcommands
+      GitStyleBinary.known_commands.collect do |k,cmd| 
+        next if k == basename 
+        cmd.process_parser!
+        ("%-s%-10s" % [basename, k]).colorize(:blue) + "\n       " + ("%s" % [cmd.short_desc]) + "\n"
+      end.compact.sort
+    end
+
+  end
+end
+end

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

@@ -0,0 +1,37 @@
+module GitStyleBinary
+  module Helpers
+    module Pager
+
+      # by Nathan Weizenbaum - http://nex-3.com/posts/73-git-style-automatic-paging-in-ruby
+      def run_pager
+        return if PLATFORM =~ /win32/
+        return unless STDOUT.tty?
+        STDOUT.use_color = true
+
+        read, write = IO.pipe
+
+        unless Kernel.fork # Child process
+          STDOUT.reopen(write)
+          STDERR.reopen(write) if STDERR.tty?
+          read.close
+          write.close
+          return
+        end
+
+        # Parent process, become pager
+        STDIN.reopen(read)
+        read.close
+        write.close
+
+        ENV['LESS'] = 'FSRX' # Don't page if the input is short enough
+
+        Kernel.select [STDIN] # Wait until we have input before we start the pager
+        pager = ENV['PAGER'] || 'less -erXF'
+        exec pager rescue exec "/bin/sh", "-c", pager
+      end
+
+      module_function :run_pager
+
+    end
+  end
+end

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

@@ -0,0 +1,204 @@
+module GitStyleBinary
+class Parser < Trollop::Parser
+  attr_reader :runs
+  attr_reader :short_desc
+  attr_accessor :command
+
+  def initialize *a, &b
+    super
+    @runs = []
+  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 = wrap(colorize_known_words(eval(%Q["#{@banner}"])) + "\n", :prefix => leftcol_start) if @banner # lazy banner
+      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
+
+    unless @order.size > 0 && @order.first.first == :text
+      stream.puts "#@version\n" if @version
+      stream.puts eval(%Q["#{@banner}"]) + "\n" if @banner # lazy 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(: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
+ 
+end
+end

data/lib/git-style-binary.rb

@@ -0,0 +1,74 @@
+$:.unshift(File.dirname(__FILE__))
+require 'rubygems'
+require 'trollop'
+require 'ext/core'
+require 'ext/colorize'
+require 'git-style-binary/autorunner'
+Dir[File.dirname(__FILE__) + "/git-style-binary/helpers/*.rb"].each {|f|  require f}
+
+module GitStyleBinary
+ 
+  class << self
+    include Helpers::NameResolver
+    attr_accessor :current_command
+    attr_accessor :primary_command
+    attr_writer :known_commands
+
+    # If set to false GitStyleBinary will not automatically run at exit.
+    attr_writer :run
+
+    # Automatically run at exit?
+    def run?
+      @run ||= false
+    end
+
+    def parser
+      @p ||= Parser.new
+    end
+
+    def known_commands
+      @known_commands ||= {}
+    end
+
+    def load_primary
+      unless @loaded_primary
+        @loaded_primary = true
+        primary_file = File.join(binary_directory, basename) 
+        load primary_file
+
+        if !GitStyleBinary.primary_command # you still dont have a primary load a default
+          GitStyleBinary.primary do
+            run do |command|
+              educate
+            end
+          end
+        end
+      end
+    end
+
+    def load_subcommand
+      unless @loaded_subcommand
+        @loaded_subcommand = true
+        cmd_file = GitStyleBinary.binary_filename_for(GitStyleBinary.current_command_name)
+        load cmd_file
+      end
+    end
+
+    def load_command_file(name, file)
+      self.name_of_command_being_loaded = name
+      load file
+      self.name_of_command_being_loaded = nil
+    end
+
+    # UGLY eek
+    attr_accessor :name_of_command_being_loaded
+   
+  end
+end
+
+at_exit do
+  unless $! || GitStyleBinary.run?
+    command = GitStyleBinary::AutoRunner.run
+    exit 0
+  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,30 @@
+#!/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
+
+  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,17 @@
+#!/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"
+  end
+end