ronin 0.2.0 → 0.2.1

data/History.txt

@@ -1,3 +1,24 @@
+=== 0.2.1 / 2009-02-23
+
+* Added Ronin::UI::Verbose.
+* Require Nokogiri >= 1.2.0:
+  * Use Nokogiri::XML, instead of REXML, for XML parsing and building.
+* Renamed String#inspect to String#dump.
+  * Aliased String#inspect to String#dump.
+* Rewrote Ronin::UI::CommandLine.
+  * Removed Ronin::UI::CommandLine::Options.command.
+  * Refactored Ronin::UI::CommandLine::Command.
+    * Added Command#defaults method to give the command's variables
+      default values.
+    * Fixed a bug in Command.run.
+  * Renamed DefaultCommand to ConsoleCommand.
+  * Implement git style sub-commands.
+  * Use reverse-require to find sub-commands.
+* Refactored Ronin::UI::ParamParser.
+  * Control parameter formats and their parsers with ParamParser.recognize.
+* Rewrote the Ronin::Chars spec.
+* Updated the Ronin::UI::ParamParser spec.
+
 === 0.2.0 / 2009-02-06
 
 * Moved the HTML formatting methods into the

data/Manifest.txt

@@ -5,6 +5,16 @@ README.txt
 TODO.txt
 Rakefile
 bin/ronin
+bin/ronin-add
+bin/ronin-console
+bin/ronin-ext
+bin/ronin-help
+bin/ronin-install
+bin/ronin-ls
+bin/ronin-overlay
+bin/ronin-rm
+bin/ronin-uninstall
+bin/ronin-update
 lib/ronin.rb
 lib/ronin/config.rb
 lib/ronin/extensions.rb
@@ -125,6 +135,7 @@ lib/ronin/platform/extension.rb
 lib/ronin/platform/platform.rb
 lib/ronin/platform/ronin.rb
 lib/ronin/ui.rb
+lib/ronin/ui/verbose.rb
 lib/ronin/ui/diagnostics.rb
 lib/ronin/ui/hexdump.rb
 lib/ronin/ui/hexdump/hexdump.rb
@@ -139,15 +150,14 @@ lib/ronin/ui/command_line/exceptions/unknown_command.rb
 lib/ronin/ui/command_line/command.rb
 lib/ronin/ui/command_line/options.rb
 lib/ronin/ui/command_line/param_parser.rb
-lib/ronin/ui/command_line/commands.rb
-lib/ronin/ui/command_line/commands/default.rb
+lib/ronin/ui/command_line/commands/console.rb
 lib/ronin/ui/command_line/commands/overlay.rb
-lib/ronin/ui/command_line/commands/extension.rb
+lib/ronin/ui/command_line/commands/ext.rb
 lib/ronin/ui/command_line/commands/add.rb
 lib/ronin/ui/command_line/commands/install.rb
-lib/ronin/ui/command_line/commands/list.rb
+lib/ronin/ui/command_line/commands/ls.rb
 lib/ronin/ui/command_line/commands/update.rb
-lib/ronin/ui/command_line/commands/remove.rb
+lib/ronin/ui/command_line/commands/rm.rb
 lib/ronin/ui/command_line/commands/uninstall.rb
 lib/ronin/ui/command_line/commands/help.rb
 lib/ronin/ui/command_line/command_line.rb
@@ -192,7 +202,8 @@ spec/platform/overlay_cache_spec.rb
 spec/platform/extension_cache_spec.rb
 spec/platform/platform_spec.rb
 spec/platform/ronin_spec.rb
-spec/ui/diagnostics_spec.rb
+spec/ui/verbose_spec.rb
+spec/ui/command_line/helpers/example_command.rb
 spec/ui/command_line/param_parser_spec.rb
 spec/ronin_spec.rb
 static/overlay.xsl

data/README.txt

@@ -68,6 +68,7 @@ of Ronin.
 == REQUIREMENTS:
 
 * {libsqlite3}[http://sqlite.org/]
+* {nokogiri}[http://nokogiri.rubyforge.org/] >= 1.2.0
 * {DataMapper}[http://datamapper.org/]:
   * dm-core >= 0.9.9
   * data_objects >= 0.9.9
@@ -106,11 +107,11 @@ of Ronin.
 
 * Update all installed Overlays:
 
-    $ ronin up
+    $ ronin update
 
 * Update a specific Overlay:
 
-    $ ronin up overlay-name
+    $ ronin update overlay-name
 
 * Uninstall an Overlay:
 

data/Rakefile

@@ -10,6 +10,7 @@ Hoe.new('ronin', Ronin::VERSION) do |p|
   p.developer('Postmodern','postmodern.mod3@gmail.com')
   p.remote_rdoc_dir = 'docs/ronin'
   p.extra_deps = [
+    ['nokogiri', '>=1.2.0'],
     ['dm-core', '>=0.9.9'],
     ['data_objects', '>=0.9.9'],
     ['do_sqlite3', '>=0.9.9'],

data/bin/ronin-add

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'ronin/ui/command_line/commands/add'
+
+Ronin::UI::CommandLine::Commands::Add.run(*ARGV)

data/bin/ronin-console

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'ronin/ui/command_line/commands/console'
+
+Ronin::UI::CommandLine::Commands::Console.run(*ARGV)

data/bin/ronin-ext

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'ronin/ui/command_line/commands/ext'
+
+Ronin::UI::CommandLine::Commands::Ext.run(*ARGV)

data/bin/ronin-help

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'ronin/ui/command_line/commands/help'
+
+Ronin::UI::CommandLine::Commands::Help.run(*ARGV)

data/bin/ronin-install

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'ronin/ui/command_line/commands/install'
+
+Ronin::UI::CommandLine::Commands::Install.run(*ARGV)

data/bin/ronin-ls

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'ronin/ui/command_line/commands/ls'
+
+Ronin::UI::CommandLine::Commands::LS.run(*ARGV)

data/bin/ronin-overlay

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'ronin/ui/command_line/commands/overlay'
+
+Ronin::UI::CommandLine::Commands::Overlay.run(*ARGV)

data/bin/ronin-rm

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'ronin/ui/command_line/commands/rm'
+
+Ronin::UI::CommandLine::Commands::RM.run(*ARGV)

data/bin/ronin-uninstall

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'ronin/ui/command_line/commands/uninstall'
+
+Ronin::UI::CommandLine::Commands::Uninstall.run(*ARGV)

data/bin/ronin-update

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'ronin/ui/command_line/commands/update'
+
+Ronin::UI::CommandLine::Commands::Update.run(*ARGV)

data/lib/ronin/extensions/string.rb

@@ -84,12 +84,12 @@ class String
   end
 
   #
-  # Inspects the string, returning a C style encoded version of the string.
+  # Dumps the string, returning a C style encoded version of the string.
   #
-  #   "hello\x00\073\x90\r\n"
+  #   "hello\x00\073\x90\r\n".dump
   #   # => "hello\0;\x90\r\n"
   #
-  def inspect
+  def dump
     c_string = ''
 
     each_byte do |b|
@@ -124,4 +124,6 @@ class String
     return "\"#{c_string}\""
   end
 
+  alias inspect dump
+
 end

data/lib/ronin/platform/extension.rb

@@ -230,7 +230,13 @@ module Ronin
       def run(&block)
         setup!
 
-        block.call(self) if block
+        if block
+          if block.arity == 1
+            block.call(self)
+          else
+            block.call()
+          end
+        end
 
         teardown!
         return self
@@ -289,7 +295,7 @@ module Ronin
       #   ext.find_file('data/test/file.xml')
       #
       #   ext.find_file('data/test/file.xml') do |file|
-      #     REXML::Document.new(open(file))
+      #     Nokogiri::XML(open(file))
       #     ...
       #   end
       #

data/lib/ronin/platform/overlay.rb

@@ -25,8 +25,8 @@ require 'ronin/platform/exceptions/extension_not_found'
 require 'ronin/platform/maintainer'
 require 'ronin/platform/extension'
 
-require 'rexml/document'
 require 'repertoire'
+require 'nokogiri'
 
 module Ronin
   module Platform
@@ -225,44 +225,28 @@ module Ronin
         @description = nil
 
         if File.file?(metadata_path)
-          doc = REXML::Document.new(open(metadata_path))
-          overlay = doc.elements['/ronin-overlay']
-
-          overlay.each_element('title[.]:first') do |title|
-            @title = title.text.strip
-          end
-
-          overlay.each_element('license[.]:first') do |license|
-            @license = license.text.strip
-          end
-
-          overlay.each_element('source[.]:first') do |source|
-            @source = source.text.strip
-          end
-
-          overlay.each_element('source-view[.]:first') do |source_view|
-            @source_view = source_view.text.strip
-          end
-
-          overlay.each_element('website[.]:first') do |website|
-            @website = website.text.strip
-          end
-
-          overlay.each_element('maintainers/maintainer') do |maintainer|
-            if (name = maintainer.text('name'))
-              name.strip!
+          doc = Nokogiri::XML(open(metadata_path))
+          overlay = doc.at('/ronin-overlay')
+
+          @title = overlay.at('title').inner_text.strip
+          @license = overlay.at('license').inner_text.strip
+          @source = overlay.at('source').inner_text.strip
+          @source_view = overlay.at('source-view').inner_text.strip
+          @website = overlay.at('website').inner_text.strip
+
+          overlay.search('maintainers/maintainer').each do |maintainer|
+            if (name = maintainer.at('name'))
+              name = name.inner_text.strip
             end
 
-            if (email = maintainer.text('email'))
-              email.strip!
+            if (email = maintainer.at('email'))
+              email = email.inner_text.strip
             end
 
             @maintainers << Maintainer.new(name,email)
           end
 
-          overlay.each_element('description[.]:first') do |description|
-            @description = description.text.strip
-          end
+          @description = overlay.search('description').inner_text.strip
         end
 
         block.call(self) if block

data/lib/ronin/ui.rb

@@ -21,8 +21,8 @@
 #++
 #
 
+require 'ronin/ui/verbose'
 require 'ronin/ui/diagnostics'
 require 'ronin/ui/hexdump'
 require 'ronin/ui/console'
 require 'ronin/ui/shell'
-

data/lib/ronin/ui/command_line.rb

@@ -21,5 +21,5 @@
 #++
 #
 
+require 'ronin/ui/command_line/command'
 require 'ronin/ui/command_line/command_line'
-require 'ronin/ui/command_line/commands'

data/lib/ronin/ui/command_line/command.rb

@@ -22,57 +22,53 @@
 #
 
 require 'ronin/ui/command_line/options'
-require 'ronin/ui/command_line/command_line'
-require 'ronin/extensions/meta'
 
 module Ronin
   module UI
     module CommandLine
       class Command
 
+        # The name of the command
+        attr_reader :name
+
         # The options for the command
         attr_reader :options
 
         #
         # Creates a new Command object.
         #
-        def initialize
-          Options.command('ronin',self.class.command_name) do |opts|
+        def initialize(name,&block)
+          @name = name.to_s
+
+          defaults()
+
+          Options.new(@name) do |opts|
             define_options(opts)
 
             @options = opts
           end
-        end
-
-        #
-        # Returns the name of the command.
-        #
-        def self.command_name
-          nil
-        end
 
-        #
-        # Returns the short names of the command.
-        #
-        def self.command_short_names
-          []
-        end
-
-        #
-        # Returns all the names of the command.
-        #
-        def self.command_names
-          ([self.command_name] + self.command_short_names).compact
+          block.call(self) if block
         end
 
         #
         # Creates a new command object and runs it with the given _args_.
         #
         def self.run(*args)
-          cmd = self.new
+          name = File.basename($0)
+          name.gsub!(/^ronin-/,'')
+
+          cmd = self.new(name)
+
+          begin
+            cmd.arguments(*(cmd.options.parse(args)))
+          rescue OptionParser::MissingArgument,
+                 OptionParser::InvalidOption => e
+            STDERR.puts e
+            exit -1
+          end
 
-          cmd.arguments(*(cmd.options.parse(args)))
-          return nil
+          return true
         end
 
         #
@@ -94,57 +90,43 @@ module Ronin
         # Returns the String form of the command.
         #
         def to_s
-          names.join(', ')
+          @name.to_s
         end
 
         protected
 
         #
-        # Registers the command with the specified _name_ and the given
-        # _short_names_.
+        # Prints the specified error _message_.
         #
-        def self.command(name,*short_names)
-          name = name.to_s
-          short_names = short_names.map { |short_name| short_name.to_s }
-
-          meta_def(:command_name) { name }
-          meta_def(:command_short_names) { short_names }
-
-          unless CommandLine.commands.include?(self)
-            # register the command
-            CommandLine.commands << self
-          end
-
-          # register the command by name
-          CommandLine.commands_by_name[name] = self
-
-          # register the command by it's short_names
-          short_names.each do |short_name|
-            CommandLine.commands_by_name[short_name] = self
-          end
-
-          return self
+        def error(message)
+          STDERR.puts "ronin: #{@name}: #{message}"
+          return false
         end
 
         #
-        # See CommandLine.error.
+        # Calls the specified _block_, then exists with the status code of 0.
         #
-        def error(message)
-          CommandLine.error("#{self.class.command_name}: #{message}")
+        def success(&block)
+          block.call
+          exit 0
         end
 
         #
-        # See CommandLine.success.
+        # Prints the given error _message_ and exits unseccessfully from the
+        # command-line utility. If a _block_ is given, it will be called before
+        # any error _message_ are printed.
         #
-        def success(&block)
-          CommandLine.success(&block)
+        def fail(message,&block)
+          block.call() if block
+
+          error(message)
+          exit -1
         end
 
         #
-        # See CommandLine.fail.
+        # Setup the command default values.
         #
-        def fail(message,&block)
-          CommandLine.fail("#{self.class.command_name}: #{message}",&block)
+        def defaults
         end
 
         #