sprout 1.0.17.pre → 1.0.18.pre

data/lib/sprout/rdoc_parser.rb

@@ -0,0 +1,91 @@
+require 'rdoc/rdoc'
+
+module Sprout
+
+  class RDocParser
+
+    def parse content
+    end
+
+    def parse_from_caller_string caller_string
+      class_name, file_name, line_number = parse_caller_string caller_string
+      rdoc_description_for class_name, file_name, line_number
+    end
+
+    private
+
+    ##
+    # NOTE: Don't forget that this string *sometimes* contains a colon on Windows...
+    def parse_caller_string caller_string
+      sections = caller_string.split(' ')
+      parts = sections.first.split(':')
+      file_name   = parts.shift
+      line_number = parts.shift
+      class_name  = class_name_from_caller_string caller_string
+      #puts ">> class_name: #{class_name} file_name: #{file_name} line_number: #{line_number}"
+      [class_name, file_name, line_number]
+    end
+
+    def class_name_from_caller_string caller_string
+      parts   = caller_string.split(' ')
+      long    = parts.pop
+      matched = long.match /<class:([\w:]+)>/
+      matched[1] unless matched.nil?
+    end
+
+    def rdoc_description_for class_name, file_name, line_number
+      rendered = rendered_rdoc file_name
+    end
+
+    def rendered_rdoc file
+      @rendered_rdoc ||= render_rdoc file
+    end
+
+    def render_rdoc file
+      rdoc = RDoc::RDoc.new
+      puts "==================================="
+      puts ">> generating rdoc for: #{file}"
+
+      rdoc.document [ file, "--format=xml", "--output=temp" ]
+      {}
+    end
+
+    def render_rdoc_from_files
+      # This works to some extent...
+      #rdoc test/fixtures/examples/echo_inputs.rb --fmt=xml --op=tmp --all -q
+      # But the following does not do the same thing:
+      #response = rdoc.document [ file, '--fmt=xml', '--op=tmp', '--all', '-q' ]
+      
+      options           = RDoc::Options.new
+      options.files     = FileList[ file ]
+      options.formatter = 'markup'
+      options.op_dir    = './tmp'
+      options.verbosity = 0
+
+      rdoc.options      = options
+
+      #rdoc.stats        = RDoc::Stats.new 1, options.verbosity
+      #response = rdoc.document []
+      
+      response = rdoc.parse_files [ file ]
+      render_rdoc_toplevel response
+    end
+
+    def render_rdoc_toplevel toplevel
+      puts ">> toplevel: #{toplevel}"
+      toplevel.each do |file|
+        puts ">> file: #{file.name}"
+        puts ">> pretty: #{file.pretty_print}"
+      end
+
+      toplevel
+    end
+
+    def render_rdoc_bak file
+      rdoc = RDoc::RDoc.new
+      rdoc.options = RDoc::Options.new
+      rdoc.parse_files [file]
+    end
+  end
+end
+

data/lib/sprout/version.rb

@@ -6,7 +6,7 @@ module Sprout
     module VERSION #:nodoc:
       MAJOR = 1
       MINOR = 0
-      TINY  = 17
+      TINY  = 18
       RELEASE = 'pre'
 
       STRING = [MAJOR, MINOR, TINY, RELEASE].join('.')

data/sprout.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "sprout" 
   s.require_path              = ['lib']
-  s.files                     = FileList['**/**/*'].exclude /.git|.svn|.DS_Store|rdoc|.coverage|coverage|tmp|pkg/
+  s.files                     = FileList['**/**/*'].exclude /.git|.svn|.DS_Store/
   s.executables               = ['sprout', 'sprout-library', 'sprout-tool', 'sprout-generator', 'sprout-class']
   s.add_bundler_dependencies
 end

data/test/unit/rdoc_parser_test.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'test/fixtures/examples/echo_inputs'
+
+class ExecutableOptionParserTest < Test::Unit::TestCase
+  include SproutTestCase
+
+  context "a new RDoc parser" do
+
+    setup do
+      @parser = Sprout::RDocParser.new
+    end
+
+  end
+end
+

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 17
+  - 18
   - pre
-  version: 1.0.17.pre
+  version: 1.0.18.pre
 platform: ruby
 authors: 
 - Luke Bayes
@@ -243,6 +243,7 @@ files:
 - lib/sprout/platform.rb
 - lib/sprout/process_runner.rb
 - lib/sprout/progress_bar.rb
+- lib/sprout/rdoc_parser.rb
 - lib/sprout/remote_file_loader.rb
 - lib/sprout/remote_file_target.rb
 - lib/sprout/ruby_feature.rb
@@ -351,6 +352,7 @@ files:
 - test/unit/paths_param_test.rb
 - test/unit/platform_test.rb
 - test/unit/process_runner_test.rb
+- test/unit/rdoc_parser_test.rb
 - test/unit/remote_file_loader_test.rb
 - test/unit/remote_file_target_test.rb
 - test/unit/ruby_feature_test.rb