jsdoc-toolkit 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+test/output

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "src/jsdoc-toolkit"]
+	path = src/jsdoc-toolkit
+	url = git://github.com/gabrielg/jsdoc-toolkit-mirror.git

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 ggironda
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,19 @@
+= jsdoc-toolkit
+
+Hi. I take no credit for this other than packaging it up as a RubyGem and adding some handy Rake tasks.
+The JsDoc Toolkit homepage is here: http://code.google.com/p/jsdoc-toolkit/
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 ggironda. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "jsdoc-toolkit"
+    gem.summary = %Q{RubyGem packaged version of jsdoc-toolkit with extra rake tasks for automating doc generation}
+    gem.description = %Q{RubyGem packaged version of jsdoc-toolkit with extra rake tasks for automating doc generation}
+    gem.email = "gabriel.gironda@gmail.com"
+    gem.homepage = "http://github.com/gabrielg/jsdoc-toolkit"
+    gem.authors = ["ggironda"]
+    gem.add_development_dependency "riot"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "jsdoc-toolkit #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/jsdoc-toolkit.gemspec

@@ -0,0 +1,60 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jsdoc-toolkit}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["ggironda"]
+  s.date = %q{2009-10-06}
+  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 = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     ".gitmodules",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "jsdoc-toolkit.gemspec",
+     "lib/jsdoc-toolkit.rb",
+     "lib/jsdoc-toolkit/doc_task.rb",
+     "lib/jsdoc-toolkit/generator.rb",
+     "test/doc_task_test.rb",
+     "test/generator_test.rb",
+     "test/input/bar/foo.js",
+     "test/input/test.js",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/gabrielg/jsdoc-toolkit}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{RubyGem packaged version of jsdoc-toolkit with extra rake tasks for automating doc generation}
+  s.test_files = [
+    "test/doc_task_test.rb",
+     "test/generator_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<riot>, [">= 0"])
+    else
+      s.add_dependency(%q<riot>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<riot>, [">= 0"])
+  end
+end

data/lib/jsdoc-toolkit/doc_task.rb

@@ -0,0 +1,30 @@
+require 'rake'
+require 'jsdoc-toolkit'
+require 'jsdoc-toolkit/generator'
+require 'pathname'
+
+module JsDocToolkit
+  class DocTask
+    
+    def initialize(task_name)
+      yield(self)
+      task(task_name) { build }
+    end
+
+    def jsdoc_dir=(path)    
+      @jsdoc_dir = Pathname(caller.first.sub(/:\d+$/, "")).expand_path.parent + path
+    end
+    
+    def jsdoc_files=(path)
+      @jsdoc_files = Pathname(caller.first.sub(/:\d+$/, "")).expand_path.parent + path
+    end  
+
+  private
+
+    def build
+      generator = JsDocToolkit::Generator.new
+      generator.build(:src_dir => @jsdoc_files.expand_path.to_s, :doc_dir => @jsdoc_dir.expand_path.to_s)
+    end
+    
+  end # DocTask
+end   # JsDocToolkit

data/lib/jsdoc-toolkit/generator.rb

@@ -0,0 +1,30 @@
+require 'jsdoc-toolkit'
+require 'pathname'
+
+module JsDocToolkit
+  class Generator
+    DefaultOptions = {:recurse => "-r", :all => "-a", :template => %Q[-t=#{JsDocTemplatePath + "jsdoc"}]}
+    
+    def build(options)
+      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)
+    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))
+    end
+    
+    def merge_defaults_with_src(src_dir)
+      DefaultOptions.values + [src_dir.expand_path.to_s]
+    end
+    
+  end # Generator
+end   # JsDocToolkit

data/lib/jsdoc-toolkit.rb

@@ -0,0 +1,7 @@
+module JsDocToolkit
+  JsDocRoot = (Pathname(__FILE__).parent.parent + "src/jsdoc-toolkit/jsdoc-toolkit").expand_path
+  JsDocTemplatePath = JsDocRoot + "templates"
+  JsDocJarPath = JsDocRoot + "jsrun.jar"
+  JsDocJsPath = JsDocRoot + "app/run.js"
+
+end

data/test/doc_task_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+require 'jsdoc-toolkit/doc_task'
+
+context "a JsDocToolkit::DocTask" do
+  setup do    
+    JsDocToolkit::DocTask.new("testing:doc_task") do |doc|
+      doc.jsdoc_dir = 'output'
+      doc.jsdoc_files = 'input'
+    end
+  end
+  
+  should "add a rake task to the task list with the given name" do
+    Rake::Task["testing:doc_task"].name
+  end.equals("testing:doc_task")
+  
+  should "generate the docs when invoked" do
+    output_dir = Pathname(__FILE__).parent + "output"
+    output_dir.rmtree if output_dir.exist?
+    output_dir.mkdir
+    Rake::Task["testing:doc_task"].invoke
+    output_dir.entries.size > 2
+  end
+  
+end

data/test/generator_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+require 'jsdoc-toolkit/generator'
+
+context "a JsDocToolkit::Generator" do
+  
+  context "with valid arguments and generating docs" do
+    
+    setup do
+      output_dir = Pathname(__FILE__).parent + "output"
+      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)
+      output_dir
+    end
+    
+    should "have created files in the output dir" do
+      topic.entries.size > 2
+    end
+    
+  end # with valid arguments and generating docs
+  
+  context "with various modes of build failure" do
+    setup do
+      generator = JsDocToolkit::Generator.new      
+    end
+    
+    should "fail without java in ENV['PATH']" do
+      begin
+        original_path = ENV['PATH']
+        ENV['PATH'] = ""
+        topic.build(:src_dir => 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/)
+  
+    should "fail if src dir is not specified" do
+      topic.build(:doc_dir => Pathname("output"))    
+    end.raises(ArgumentError, /src_dir was not specified/)
+  
+    should "fail if doc dir is not specified" do
+      topic.build(:src_dir => Pathname("input"))
+    end.raises(ArgumentError, /doc_dir was not specified/)
+    
+  end # with various modes of build failure
+  
+end
+

data/test/input/bar/foo.js

@@ -0,0 +1,8 @@
+/** 
+ * @fileoverview This is another test file for the jsdoc-toolkit gem.
+ */
+
+/** 
+ * @class Foo A Foo class.
+ */
+Foo = function() {};

data/test/input/test.js

@@ -0,0 +1,8 @@
+/** 
+ * @fileoverview This is a test file for the jsdoc-toolkit gem.
+ */
+
+/** 
+ * @class Test A Test class.
+ */
+Test = function() {};

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'test/unit'
+require 'riot'
+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

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: jsdoc-toolkit
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- ggironda
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-06 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: riot
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: RubyGem packaged version of jsdoc-toolkit with extra rake tasks for automating doc generation
+email: gabriel.gironda@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- .gitmodules
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- jsdoc-toolkit.gemspec
+- lib/jsdoc-toolkit.rb
+- lib/jsdoc-toolkit/doc_task.rb
+- lib/jsdoc-toolkit/generator.rb
+- test/doc_task_test.rb
+- test/generator_test.rb
+- test/input/bar/foo.js
+- test/input/test.js
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/gabrielg/jsdoc-toolkit
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: RubyGem packaged version of jsdoc-toolkit with extra rake tasks for automating doc generation
+test_files: 
+- test/doc_task_test.rb
+- test/generator_test.rb
+- test/test_helper.rb