boson 0.2.3 → 0.2.4

data/CHANGELOG.rdoc

@@ -0,0 +1,76 @@
+== 0.2.4
+* Tests use bacon and pass on all major ruby versions
+* Fixed bug for 1.8.7 and super (#10)
+* Added commandline pipes with '+'
+* Fixed bug when requiring rubygems in a library
+* Fixed bug in sort pipe for 1.9.2
+* Got rid of jeweler in Rakefile and $LOAD_PATH meddling
+* Refactored BinRunner's error handling
+
+== 0.2.3
+* Added improved support and additional attributes for user pipe options
+* Added :pipes global command option
+* Added json + yaml parsing to get()
+* Added underscore searching to option values
+* Added build_install() command
+* Added :usage_options commandline option
+
+== 0.2.2
+* Renamed Boson::Command#description to #desc. Delete your index at ~/.boson/config/index.marshal.
+* Renamed Boson::Command#global_options to #option_command. Update your configs.
+* Bug fix for Windows and indexing (#4)
+* Added system wide Boson commands at /etc/boson (#2)
+* Added Boson::Command#config for plugins to set/get via @config
+* Added option_command and unload options to BinRunner
+* Added special option parsing characters: - and --
+* Added special :output_class key for global render_options
+* Added :delete_options global option
+* Fixed --no variant for single letter booleans
+* Fixed MethodInspector parsing arguments with special characters
+* Allow global -p to work even in failures
+* Allow -hv to default to verbose help
+* Boson::OptionParser tweaks
+
+== 0.2.1
+* Added local libraries: Bosonfile and under local repositories
+* Added config method attribute.
+* Added default_option and global_options command attributes.
+* Added OptionParser.parse and OptionParser.usage for scripting use.
+* Improved auto-rendering from commandline.
+* Removed library reload.
+* Better docs.
+
+== 0.2.0
+* Command options
+** Added custom global and render options for commands.
+** Added pipe and filter option commands.
+** Add global query option.
+* Options
+** Users can define custom option types.
+** Added hash option type.
+** Any option can be a boolean with :bool_default attribute.
+** Adding * aliasing to relevant options.
+* Made Boson::Scientist.commandify for use outside Boson.
+* Any command can have a default option.
+* Directories are namespaced automatically.
+* Solidified library module callback methods.
+* Added support for Windows home.
+* Improved ModuleLibrary to handle class or module class methods.
+* Better search and sort integration with Hirb.
+* Better docs.
+* Fixed number of bugs.
+* query_fields option for searching libraries and commands is deprecated. Specifying query
+  fields is now done by prefixing a query with ':'. For example:
+  bash> boson commands library_type:gem
+  # instead of
+  bash> boson commands gem --query_fields=library_type
+
+== 0.1.0
+* First real release
+* Plenty of fixes to make it ruby 1.9 ready.
+* Added more documentation
+* BinRunner tweaks and bug fixes
+* Other miscellaneous bug fixes
+
+== 0.0.1
+* An initial release for others to play with.

data/README.rdoc

@@ -1,9 +1,9 @@
+To read a linkable version of this README, {see here}[http://tagaholic.me/boson/doc/].
+
 == Description
 A command/task framework similar to rake and thor that opens your ruby universe to the commandline
 and irb. For my libraries that use this, see {irbfiles}[http://github.com/cldwalker/irbfiles].
-Works with Ruby 1.8.6 and 1.9.1.
-
-Note: To read a linkable version of this README, {see here}[http://tagaholic.me/boson/doc/].
+Works with all major ruby versions.
 
 == Features
 * Simple organization: Commands are just methods on an object (default is main) and command libraries are just modules.
@@ -161,8 +161,8 @@ My {tagging obsession}[http://github.com/cldwalker/tag-tree] from the ruby conso
 
 == Acknowledgements
 Boson stands on the shoulders of these people and their ideas:
-* Yehuda Katz for inspiring me with Thor's power and elegant design
-* Yehuda Katz and Daniel Berger for an awesome option parser (Boson::OptionParser)
+* Yehuda Katz for inspiring me with Thor and its awesome option parser (Boson::OptionParser).
+* Daniel Berger for his original work on thor's awesome option parser.
 * Dave Thomas for scraping a method's comments (Boson::CommentInspector)
 * Mauricio Fernandez for scraping a method's arguments (Boson::ArgumentInspector)
-* Chris Wanstrath for inspiring Boson's libraries with Rip's packages.
+* Chris Wanstrath for inspiring Boson's libraries with Rip's packages.

data/Rakefile

@@ -1,52 +1,35 @@
 require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-begin
-  require 'rcov/rcovtask'
+require 'fileutils'
 
-  Rcov::RcovTask.new do |t|
-    t.libs << 'test'
-    t.test_files = FileList['test/**/*_test.rb']
-    t.rcov_opts = ["-T -x '/Library/Ruby/*'"]
-    t.verbose = true
-  end
-rescue LoadError
-  puts "Rcov not available. Install it for rcov-related tasks with: sudo gem install rcov"
+def gemspec
+  @gemspec ||= eval(File.read('gemspec'), binding, 'gemspec')
 end
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |s|
-    s.name = "boson"
-    s.description = "A command/task framework similar to rake and thor that opens your ruby universe to the commandline and irb."
-    s.summary =  "Boson provides users with the power to turn any ruby method into a full-fledged commandline tool. Boson achieves this with powerful options (borrowed from thor) and views (thanks to hirb). Some other unique features that differentiate it from rake and thor include being accessible from irb and the commandline, being able to write boson commands in non-dsl ruby and toggling a pretty view of a command's output without additional view code."
-    s.email = "gabriel.horner@gmail.com"
-    s.homepage = "http://tagaholic.me/boson/"
-    s.authors = ["Gabriel Horner"]
-    s.has_rdoc = true
-    s.rubyforge_project = 'tagaholic'
-    s.add_dependency 'hirb', '>= 0.2.10'
-    s.add_dependency 'alias', '>= 0.2.1'
-    s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
-    s.files = FileList["Rakefile", "VERSION.yml", "README.rdoc", "LICENSE.txt", "{bin,lib,test}/**/*"]
-  end
+desc "Build the gem"
+task :gem=>:gemspec do
+  sh "gem build gemspec"
+  FileUtils.mkdir_p 'pkg'
+  FileUtils.mv "#{gemspec.name}-#{gemspec.version}.gem", 'pkg'
+end
+
+desc "Install the gem locally"
+task :install => :gem do
+  sh %{gem install pkg/#{gemspec.name}-#{gemspec.version}}
+end
 
-rescue LoadError
-  puts "Jeweler not available. Install it for jeweler-related tasks with: sudo gem install jeweler"
+desc "Generate the gemspec"
+task :generate do
+  puts gemspec.to_ruby
 end
 
-Rake::TestTask.new do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+desc "Validate the gemspec"
+task :gemspec do
+  gemspec.validate
 end
 
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'test'
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+desc 'Run tests'
+task :test do |t|
+  sh 'bacon -q -Ilib -I. test/*_test.rb'
 end
 
-task :default => :test
+task :default => :test

data/gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require 'rubygems' unless Object.const_defined?(:Gem)
+require File.dirname(__FILE__) + "/lib/boson/version"
+ 
+Gem::Specification.new do |s|
+  s.name        = "boson"
+  s.version     = Boson::VERSION
+  s.authors     = ["Gabriel Horner"]
+  s.email       = "gabriel.horner@gmail.com"
+  s.homepage    = "http://tagaholic.me/boson/"
+  s.summary = "A command/task framework similar to rake and thor that opens your ruby universe to the commandline and irb."
+  s.description =  "Boson provides users with the power to turn any ruby method into a full-fledged commandline tool. Boson achieves this with powerful options (borrowed from thor) and views (thanks to hirb). Some other unique features that differentiate it from rake and thor include being accessible from irb and the commandline, being able to write boson commands in non-dsl ruby and toggling a pretty view of a command's output without additional view code."
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project = 'tagaholic'
+  s.add_dependency 'hirb', '>= 0.2.10'
+  s.add_dependency 'alias', '>= 0.2.1'
+  s.files = Dir.glob(%w[{lib,test}/**/*.rb bin/* [A-Z]*.{txt,rdoc} ext/**/*.{rb,c}]) + %w{Rakefile gemspec}
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE.txt"]
+end

data/lib/boson.rb

@@ -1,11 +1,10 @@
-$:.unshift File.dirname(__FILE__) unless $:.include? File.expand_path(File.dirname(__FILE__))
 %w{hirb alias}.each {|e| require e }
 %w{runner runners/console_runner repo manager loader inspector library}.each {|e| require "boson/#{e}" }
 %w{argument method comment}.each {|e| require "boson/inspectors/#{e}_inspector" }
 # order of library subclasses matters
 %w{module file gem require local_file}.each {|e| require "boson/libraries/#{e}_library" }
 (%w{namespace view command util commands option_parser options} +
-  %w{index repo_index scientist option_command pipe pipes}).each {|e| require "boson/#{e}" }
+  %w{index repo_index scientist option_command pipe pipes version}).each {|e| require "boson/#{e}" }
 
 # This module stores the libraries, commands, repos and main object used throughout Boson.
 #
@@ -20,6 +19,7 @@ $:.unshift File.dirname(__FILE__) unless $:.include? File.expand_path(File.dirna
 module Boson
   # Module which is extended by Boson.main_object to give it command functionality.
   module Universe; include Commands::Namespace; end
+  NAMESPACE = '.' # Delimits namespace from command
   extend self
   # The object which holds and executes all command functionality
   attr_accessor :main_object
@@ -82,7 +82,7 @@ module Boson
 
   # Invoke command string even with namespaces
   def full_invoke(cmd, args) #:nodoc:
-    command, subcommand = cmd.include?('.') ? cmd.split('.', 2) : [cmd, nil]
+    command, subcommand = cmd.include?(NAMESPACE) ? cmd.split(NAMESPACE, 2) : [cmd, nil]
     dispatcher = subcommand ? Boson.invoke(command) : Boson.main_object
     dispatcher.send(subcommand || command, *args)
   end
@@ -93,4 +93,4 @@ module Boson
   end
 end
 
-Boson.main_object = self
+Boson.main_object = self

data/lib/boson/command.rb

@@ -20,7 +20,7 @@ module Boson
     # Finds a command, namespaced or not and aliased or not. If found returns the
     # command object, otherwise returns nil.
     def self.find(command, commands=Boson.commands)
-      command, subcommand = command.to_s.split('.', 2)
+      command, subcommand = command.to_s.split(NAMESPACE, 2)
       is_namespace_command = lambda {|current_command|
         [current_command.name, current_command.alias].include?(subcommand) &&
         current_command.library && (current_command.library.namespace == command)
@@ -133,7 +133,7 @@ module Boson
     def file_string_and_method_for_args(lib)
       if !lib.is_a?(ModuleLibrary) && (klass_method = (lib.class_commands || {})[@name])
         if RUBY_VERSION >= '1.9'
-          klass, meth = klass_method.split('.', 2)
+          klass, meth = klass_method.split(NAMESPACE, 2)
           if (meth_locations = MethodInspector.find_method_locations_for_19(klass, meth))
             file_string = File.read meth_locations[0]
           end

data/lib/boson/commands/core.rb

@@ -69,7 +69,7 @@ module Boson::Commands::Core #:nodoc:
       puts "\nLOCAL OPTIONS"
       cmd.option_parser.print_usage_table options[:render_options].dup.merge(:local=>true)
     end
-    if options[:verbose]
+    if options[:verbose] && cmd.render_option_parser
       puts "\nGLOBAL OPTIONS"
       cmd.render_option_parser.print_usage_table options[:render_options].dup
     end

data/lib/boson/commands/web_core.rb

@@ -2,18 +2,21 @@ module Boson::Commands::WebCore
   extend self
 
   def config #:nodoc:
-    descriptions = {
-      :install=>"Installs a library by url. Library should then be loaded with load_library.",
-      :browser=>"Opens urls in a browser on a Mac", :get=>"Gets the body of a url", :post=>'Posts to url',
-      :build_url=>"Builds a url, escaping the given params"
+    commands = {
+      'get'=>{ :desc=>"Gets the body of a url", :args=>[['url'],['options', {}]]},
+      'post'=>{ :desc=>'Posts to a url', :args=>[['url'],['options', {}]]},
+      'build_url'=>{ :desc=>"Builds a url, escaping the given params", :args=>[['url'],['params']]},
+      'browser'=>{ :desc=>"Opens urls in a browser on a Mac"},
+      'install'=>{ :desc=>"Installs a library by url. Library should then be loaded with load_library.",
+        :args=>[['url'],['options', {}]],
+        :options=> { :name=>{:type=>:string, :desc=>"Library name to save to"},
+          :force=>{:type=>:boolean, :desc=>'Overwrites an existing library'},
+          :default=>{:type=>:boolean, :desc=>'Adds library as a default library to main config file'},
+          :module_wrap=>{:type=>:boolean, :desc=>"Wraps a module around install using library name"},
+          :method_wrap=>{:type=>:boolean, :desc=>"Wraps a method and module around installed library using library name"}}
+      }
     }
-    commands = descriptions.inject({}) {|h,(k,v)| h[k.to_s] = {:desc=>v}; h}
-    commands['install'][:options] = {:name=>{:type=>:string, :desc=>"Library name to save to"},
-      :force=>{:type=>:boolean, :desc=>'Overwrites an existing library'},
-      :default=>{:type=>:boolean, :desc=>'Adds library as a default library to main config file'},
-      :module_wrap=>{:type=>:boolean, :desc=>"Wraps a module around install using library name"},
-      :method_wrap=>{:type=>:boolean, :desc=>"Wraps a method and module around installed library using library name"}}
-    commands['install'][:args] = [['url'],['options', {}]]
+
     {:library_file=>File.expand_path(__FILE__), :commands=>commands, :namespace=>false}
   end
 
@@ -39,7 +42,8 @@ module Boson::Commands::WebCore
   end
 
   def_which_requires(:post, 'uri', 'net/http') do |url, options|
-    Net::HTTP.post_form(URI.parse(url), options)
+    options ||= {}
+    (res = Net::HTTP.post_form(URI.parse(url), options)) && res.body
   end
 
   def install(url, options={}) #:nodoc:

data/lib/boson/manager.rb

@@ -77,7 +77,7 @@ module Boson
       end
 
       def load_dependencies(lib, options={})
-        lib_dependencies[lib] = (lib.dependencies || []).map do |e|
+        lib_dependencies[lib] = Array(lib.dependencies).map do |e|
           next if loaded?(e)
           load_once(e, options.merge(:dependency=>true)) ||
             raise(LoaderError, "Can't load dependency #{e}")

data/lib/boson/pipes.rb

@@ -44,9 +44,9 @@ module Boson
       sort_lambda = lambda {}
       if object[0].is_a?(Hash)
         sort = sort.to_i if sort.to_s[/^\d+$/]
-        sort_lambda = (object.all? {|e| e[sort].respond_to?(:<=>) } ? lambda {|e| e[sort] } : lambda {|e| e[sort].to_s })
+        sort_lambda = untouched_sort?(object.map {|e| e[sort] }) ? lambda {|e| e[sort] } : lambda {|e| e[sort].to_s }
       else
-        sort_lambda = object.all? {|e| e.send(sort).respond_to?(:<=>) } ? lambda {|e| e.send(sort) || ''} :
+        sort_lambda = untouched_sort?(object.map {|e| e.send(sort) }) ? lambda {|e| e.send(sort) || ''} :
           lambda {|e| e.send(sort).to_s }
       end
       object.sort_by &sort_lambda
@@ -54,6 +54,10 @@ module Boson
       $stderr.puts "Sort failed with nonexistant method '#{sort}'"
     end
 
+    def untouched_sort?(values) #:nodoc:
+      values.all? {|e| e.respond_to?(:<=>) } && values.map {|e| e.class }.uniq.size == 1
+    end
+
     # Reverse an object
     def reverse_sort_pipe(object, extra=nil)
       object.reverse

data/lib/boson/repo_index.rb

@@ -99,7 +99,7 @@ module Boson
 
     def find_library(command, object=false)
       read
-      namespace_command = command.split('.')[0]
+      namespace_command = command.split(NAMESPACE)[0]
       if (lib = @libraries.find {|e| e.namespace == namespace_command })
         object ? lib : lib.name
       elsif (cmd = Command.find(command, @commands))

data/lib/boson/runner.rb

@@ -56,9 +56,9 @@ module Boson
         {:verbose=>@options[:verbose]}
       end
 
-      def autoload_command(cmd)
+      def autoload_command(cmd, opts={:verbose=>verbose?})
         Index.read
-        (lib = Index.find_library(cmd)) && Manager.load(lib, :verbose=>verbose?)
+        (lib = Index.find_library(cmd)) && Manager.load(lib, opts)
         lib
       end
 

data/lib/boson/runners/bin_runner.rb

@@ -34,6 +34,7 @@ module Boson
   class BinRunner < Runner
     GLOBAL_OPTIONS =  {
       :verbose=>{:type=>:boolean, :desc=>"Verbose description of loading libraries, errors or help"},
+      :version=>{:type=>:boolean, :desc=>"Prints the current version"},
       :index=>{:type=>:array, :desc=>"Libraries to index. Libraries must be passed with '='.",
         :bool_default=>nil, :values=>all_libraries, :regexp=>true, :enum=>false},
       :execute=>{:type=>:string, :desc=>"Executes given arguments as a one line script"},
@@ -47,44 +48,61 @@ module Boson
       :option_commands=>{:type=>:boolean, :desc=>"Toggles on all commands to be defined as option commands" }
     } #:nodoc:
 
+    PIPE = '+'
+
     class <<self
       attr_accessor :command
 
       # Starts, processes and ends a commandline request.
       def start(args=ARGV)
         @command, @options, @args = parse_args(args)
+        return puts("boson #{Boson::VERSION}") if @options[:version]
         return print_usage if args.empty? || (@command.nil? && !@options[:console] && !@options[:execute])
         return ConsoleRunner.bin_start(@options[:console], @options[:load]) if @options[:console]
         init
-        View.toggle_pager if @options[:pager_toggle]
 
         if @options[:help]
+          autoload_command @command
           Boson.invoke(:usage, @command, :verbose=>@options[:verbose])
         elsif @options[:execute]
+          define_autoloader
           Boson.main_object.instance_eval @options[:execute]
         else
           execute_command
         end
+      rescue NoMethodError
+        print_error_message no_method_error_message
       rescue
-        is_invalid_command = lambda {|command| !Boson.can_invoke?(command[/\w+/]) ||
-          (Boson.can_invoke?(command[/\w+/]) && command.include?('.') && $!.is_a?(NoMethodError)) }
-        print_error_message @command.to_s[/\w+/] && is_invalid_command.call(@command) ?
-          "Error: Command '#{@command}' not found" : "Error: #{$!.message}"
+        print_error_message default_error_message
       end
 
-      # Loads the given command.
+      def no_method_error_message #:nodoc:
+        @command = @command.to_s
+        if $!.backtrace.grep(/`(invoke|full_invoke)'$/).empty? ||
+          !$!.message[/undefined method `(\w+\.)?#{@command.split(NAMESPACE)[-1]}'/]
+            default_error_message
+        else
+          @command.to_s[/\w+/] &&
+            (!(Index.read && Index.find_command(@command[/\w+/])) || @command.include?(NAMESPACE)) ?
+            "Error: Command '#{@command}' not found" : default_error_message
+        end
+      end
+
+      # Loads libraries and handles non-critical options
       def init
         Runner.in_shell = true
         Command.all_option_commands = true if @options[:option_commands]
         super
-        Index.update(:verbose=>true, :libraries=>@options[:index]) if @options.key?(:index)
-        if @options[:load]
-          Manager.load @options[:load], load_options
-        elsif @options[:execute]
-          define_autoloader
-        else
-          load_command_by_index
+
+        if @options.key?(:index)
+          Index.update(:verbose=>true, :libraries=>@options[:index])
+          @index_updated = true
+        elsif !@options[:help] && @command && Boson.can_invoke?(@command)
+          Index.update(:verbose=>@options[:verbose])
+          @index_updated = true
         end
+        Manager.load @options[:load], load_options if @options[:load]
+        View.toggle_pager if @options[:pager_toggle]
       end
 
       # Hash of global options passed in from commandline
@@ -92,17 +110,27 @@ module Boson
         @options ||= {}
       end
 
+      # Commands to executed, in order given by user
+      def commands
+        @commands ||= @all_args.map {|e| e[0]}
+      end
       #:stopdoc:
       def print_error_message(message)
         message += "\nOriginal error: #{$!}\n" + $!.backtrace.slice(0,10).map {|e| "  " + e }.join("\n") if options[:verbose]
         $stderr.puts message
       end
 
-      def load_command_by_index
-        Index.update(:verbose=>@options[:verbose]) if !@options.key?(:index) && Boson.can_invoke?(@command) && !@options[:help]
-        if !Boson.can_invoke?(@command, false) && ((lib = Index.find_library(@command)) ||
-          (Index.update(:verbose=>@options[:verbose]) && (lib = Index.find_library(@command))))
-          Manager.load lib, load_options
+      def default_error_message
+        "Error: #{$!.message}"
+      end
+
+      def autoload_command(cmd)
+        if !Boson.can_invoke?(cmd, false)
+          unless @index_updated
+            Index.update(:verbose=>@options[:verbose])
+            @index_updated = true
+          end
+          super(cmd, load_options)
         end
       end
 
@@ -112,24 +140,39 @@ module Boson
       end
 
       def execute_command
-        begin
-          output = Boson.full_invoke(@command, @args)
-        rescue ArgumentError
-          raise unless $!.message[/wrong number of arguments/] &&
-            # Throw out errors that aren't external or from option_command
-            ($!.backtrace.first[/boson/].nil? || $!.backtrace.first[/boson\/option_command.rb/])
-          print_error_message "'#{@command}' was called incorrectly."
-          Boson.invoke(:usage, @command, :one_line=>true)
-          return
-        end
+        output = @all_args.inject(nil) {|acc, (cmd,*args)|
+          begin
+            @command = cmd # for external errors
+            autoload_command cmd
+            args = translate_args(args, acc)
+            Boson.full_invoke(cmd, args)
+          rescue ArgumentError
+            if $!.class == OptionCommand::CommandArgumentError || ($!.message[/wrong number of arguments/] &&
+              (cmd_obj = Command.find(cmd)) && cmd_obj.arg_size != args.size)
+              print_error_message "'#{cmd}' was called incorrectly."
+              Boson.invoke(:usage, cmd, :one_line=>true)
+              return
+            else
+              raise
+            end
+          end
+        }
         render_output output
       end
 
+      def translate_args(args, piped)
+        args.unshift piped if piped
+        args
+      end
+
       def parse_args(args)
+        @all_args = Util.split_array_by(args, PIPE)
+        args = @all_args[0]
         @option_parser = OptionParser.new(GLOBAL_OPTIONS)
         options = @option_parser.parse(args.dup, :opts_before_args=>true)
         new_args = @option_parser.non_opts
-        [new_args.shift, options, new_args]
+        @all_args[0] = new_args
+        [new_args[0], options, new_args[1..-1]]
       end
 
       def render_output(output)