@@ -1,3 +1,5 @@
+* Log info to Terminal. [tobie]
+
* Better error message formatting (nitpicking, really!). [tobie]
* Fix missing descriptions. [tobie]
CHANGELOG
@@ -4,7 +4,7 @@ require 'lib/pdoc'
desc "Builds the documentation"
task :build_doc do
source = File.expand_path(File.join(File.dirname(__FILE__), "test", "fixtures", "ajax.js"))
- PDoc::Runner.new(source).render
+ PDoc::Runner.new(source).run
end
desc "Empties output directory"
Rakefile
@@ -1,17 +1,58 @@
module PDoc
class Runner
- def initialize(source)
- @generator = Generators::Html::Website
- @parser_output = parse(source)
+ def initialize(source_file, output_directory = OUTPUT_DIR)
+ @source_file = source_file
+ @output_directory = output_directory
+ @generator = Generators::Html::Website
+ @parser = Parser.new(source)
end
- def parse(source)
- string = File.open(source){ |f| f.read }
- Parser.new(string).parse
+ def source
+ File.open(@source_file){ |f| f.read }
end
- def render(output = OUTPUT_DIR)
- @generator.new(@parser_output).render(output)
+ def parse
+ log "Parsing source file: #{@source_file}."
+ start_time = Time.new
+ @parser_output = @parser.parse
+ log "Parsing completed in #{Time.new - start_time} seconds."
+ end
+
+ def render
+ log "Generating documentation to: #{@output_directory}."
+ start_time = Time.new
+ @generator.new(@parser_output).render(@output_directory)
+ log "Documentation generated in #{Time.new - start_time} seconds."
+ end
+
+ def run
+ puts "\n"
+ parse
+ render
+ log summary
+ end
+
+ def summary
+ <<-EOS
+
+ Summary:
+ Sections: #{@parser_output.sections.length}
+ Utilities: #{@parser_output.utilities.length}
+ Namespaces: #{@parser_output.namespaces.length}
+ Mixins: #{@parser_output.mixins.length}
+ Classes: #{@parser_output.klasses.length}
+ Constructor methods: #{@parser_output.constructors.length}
+ Constants: #{@parser_output.constants.length}
+ Class methods: #{@parser_output.klass_methods.length}
+ Instance methods: #{@parser_output.instance_methods.length}
+ Class properties: #{@parser_output.klass_properties.length}
+ Instance properties: #{@parser_output.instance_properties.length}
+
+ EOS
+ end
+
+ def log(message)
+ puts " #{message}"
end
end
end
\ No newline at end of file
lib/pdoc/runner.rb
cb562280a38df7b8f83c1a2662a27ba0ce63a1e6
Tobie Langel
tobie.langel@gmail.com
http://github.com/tobie/pdoc/commit/cac8c95951a4f7a08e5532f072807018e7ed1d43
cac8c95951a4f7a08e5532f072807018e7ed1d43
2008-04-14T16:46:11-07:00
2008-04-14T16:46:11-07:00
Log info to Terminal.
99886a91bca2b513785c52f21d8daee1572986fd
Tobie Langel
tobie.langel@gmail.com