jsdoc-toolkit 0.1.4 → 0.2.0

data/VERSION

@@ -1 +1 @@
-0.1.4
+0.2.0

data/jsdoc-toolkit.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{jsdoc-toolkit}
-  s.version = "0.1.4"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["ggironda"]
-  s.date = %q{2009-10-08}
+  s.date = %q{2009-10-11}
   s.description = %q{RubyGem packaged version of jsdoc-toolkit with extra rake tasks for automating doc generation}
   s.email = %q{gabriel.gironda@gmail.com}
   s.extra_rdoc_files = [
@@ -139,6 +139,7 @@ Gem::Specification.new do |s|
      "test/generator_test.rb",
      "test/input/bar/foo.js",
      "test/input/test.js",
+     "test/other_input/qhat.js",
      "test/test_helper.rb"
   ]
   s.homepage = %q{http://github.com/gabrielg/jsdoc-toolkit}

data/lib/jsdoc-toolkit/doc_task.rb

@@ -5,8 +5,10 @@ require 'pathname'
 
 module JsDocToolkit
   class DocTask
+    attr_reader :jsdoc_files
     
     def initialize(task_name)
+      @jsdoc_files = []
       yield(self)
       task(task_name) { build }
     end
@@ -14,16 +16,12 @@ module JsDocToolkit
     def jsdoc_dir=(path)    
       @jsdoc_dir = Pathname(path)
     end
-    
-    def jsdoc_files=(path)
-      @jsdoc_files = Pathname(path)
-    end  
 
   private
 
     def build
       generator = JsDocToolkit::Generator.new
-      generator.build(:src_dir => @jsdoc_files.to_s, :doc_dir => @jsdoc_dir.to_s)
+      generator.build(:src_files => @jsdoc_files, :doc_dir => @jsdoc_dir.to_s)
     end
     
   end # DocTask

data/lib/jsdoc-toolkit/generator.rb

@@ -7,24 +7,22 @@ module JsDocToolkit
                       :verbose => "-v", :unique => "-u"}
     
     def build(options)
+      src_files, doc_dir = Array(options[:src_files]), Pathname(options[:doc_dir].to_s)
       raise RuntimeError, "java was not found in your PATH." if `which java 2>/dev/null`.strip.empty?
-      raise ArgumentError, ":src_dir was not specified" unless options[:src_dir]
-      raise ArgumentError, ":doc_dir was not specified" unless options[:doc_dir]
-      
-      src_dir, doc_dir = Pathname(options[:src_dir]), Pathname(options[:doc_dir])
-      raise ArgumentError, ":src_dir does not exist" unless src_dir.exist?
-      raise ArgumentError, ":doc_dir does not exist" unless doc_dir.exist?
-      run_jsdoc(src_dir, doc_dir)
+      raise ArgumentError, ":src_files was not specified or was empty" if src_files.empty?
+      raise ArgumentError, ":doc_dir was not specified or does not exist" unless options[:doc_dir] && doc_dir.exist?
+
+      run_jsdoc(src_files, doc_dir)
     end
   
   private
   
-    def run_jsdoc(src_dir, doc_dir)
-      system("java", "-jar", JsDocJarPath, JsDocJsPath, %Q[-d=#{doc_dir.expand_path}], *merge_defaults_with_src(src_dir))
+    def run_jsdoc(src_files, doc_dir)
+      system("java", "-jar", JsDocJarPath, JsDocJsPath, %Q[-d=#{doc_dir.expand_path}], *merge_defaults_with_src(src_files))
     end
     
-    def merge_defaults_with_src(src_dir)
-      DefaultOptions.values + [src_dir.to_s]
+    def merge_defaults_with_src(src_files)
+      DefaultOptions.values + src_files
     end
     
   end # Generator

data/test/doc_task_test.rb

@@ -5,7 +5,7 @@ context "a JsDocToolkit::DocTask" do
   setup do    
     JsDocToolkit::DocTask.new("testing:doc_task") do |doc|
       doc.jsdoc_dir = 'output'
-      doc.jsdoc_files = 'input'
+      doc.jsdoc_files << 'input'
     end
   end
   
@@ -14,10 +14,13 @@ context "a JsDocToolkit::DocTask" do
   end.equals("testing:doc_task")
   
   should "generate the docs when invoked" do
-    output_dir = Pathname(__FILE__).parent + "output"
+    cur_dir = Dir.pwd
+    Dir.chdir(Pathname(__FILE__).parent)
+    output_dir = Pathname("output").expand_path
     output_dir.rmtree if output_dir.exist?
     output_dir.mkdir
     Rake::Task["testing:doc_task"].invoke
+    Dir.chdir(cur_dir)
     output_dir.entries.size > 2
   end
   

data/test/generator_test.rb

@@ -6,11 +6,14 @@ context "a JsDocToolkit::Generator" do
   context "with valid arguments and generating docs" do
     
     setup do
-      output_dir = Pathname(__FILE__).parent + "output"
+      cur_dir = Dir.pwd
+      Dir.chdir(Pathname(__FILE__).parent)
+      output_dir = Pathname("output").expand_path
       output_dir.rmtree if output_dir.exist?
       output_dir.mkdir
       generator = JsDocToolkit::Generator.new
-      generator.build(:src_dir => Pathname(__FILE__).parent + "input", :doc_dir => output_dir)
+      generator.build(:src_files => [Pathname(__FILE__).parent + "input", Pathname(__FILE__).parent + "other_input"], :doc_dir => output_dir)
+      Dir.chdir(cur_dir)
       output_dir
     end
     
@@ -29,26 +32,22 @@ context "a JsDocToolkit::Generator" do
       begin
         original_path = ENV['PATH']
         ENV['PATH'] = ""
-        topic.build(:src_dir => Pathname("input"), :doc_dir => Pathname("output"))
+        topic.build(:src_files => Pathname("input"), :doc_dir => Pathname("output"))
       ensure
         ENV['PATH'] = original_path
       end
     end.raises(RuntimeError, /java was not found/)
   
-    should "fail if src dir does not exist" do
-      topic.build(:src_dir => Pathname("bzzzzzzzzzzzt"), :doc_dir => Pathname("output"))    
-    end.raises(ArgumentError, /src_dir does not exist/)
-  
     should "fail if doc dir does not exist" do
-      topic.build(:src_dir => Pathname(__FILE__).parent + "input", :doc_dir => Pathname("bzzzzzzzt"))
-    end.raises(ArgumentError, /doc_dir does not exist/)
+      topic.build(:src_files => Pathname(__FILE__).parent + "input", :doc_dir => Pathname("bzzzzzzzt"))
+    end.raises(ArgumentError, /doc_dir was not specified or does not exist/)
   
-    should "fail if src dir is not specified" do
+    should "fail if src files is not specified" do
       topic.build(:doc_dir => Pathname("output"))    
-    end.raises(ArgumentError, /src_dir was not specified/)
+    end.raises(ArgumentError, /src_files was not specified/)
   
     should "fail if doc dir is not specified" do
-      topic.build(:src_dir => Pathname("input"))
+      topic.build(:src_files => Pathname("input"))
     end.raises(ArgumentError, /doc_dir was not specified/)
     
   end # with various modes of build failure

data/test/test_helper.rb

@@ -4,8 +4,4 @@ require 'pathname'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'jsdoc-toolkit'
-
-at_exit do
-  Riot.report
-end
+require 'jsdoc-toolkit'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jsdoc-toolkit
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors: 
 - ggironda
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-08 00:00:00 -05:00
+date: 2009-10-11 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -154,6 +154,7 @@ files:
 - test/generator_test.rb
 - test/input/bar/foo.js
 - test/input/test.js
+- test/other_input/qhat.js
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/gabrielg/jsdoc-toolkit