jsdoc 0.1.0

data/lib/jsdoc.rb

@@ -0,0 +1,23 @@
+class JsDoc
+  JSDOC_VERSION = '2.4.0'
+  JAVA_EXECUTABLE = 'java'
+  JSDOC_DIR_PREFIX = 'jsdoc-toolkit'
+  S = File::SEPARATOR
+  DEFAULT_JSDOC_DIR = File.expand_path(File.dirname(__FILE__) + S + JSDOC_DIR_PREFIX + '-' + JSDOC_VERSION)
+  DEFAULT_JSDOC_TEMPLATE_DIR = File.expand_path(DEFAULT_JSDOC_DIR + S + 'templates' + S + 'jsdoc')
+
+  def initialize(jsdoc_dir = DEFAULT_JSDOC_DIR, jsdoc_template_dir = DEFAULT_JSDOC_TEMPLATE_DIR)
+    @jsdoc_dir = jsdoc_dir
+    @jsdoc_template_dir = jsdoc_template_dir
+  end
+
+  def run(output_dir, *rest)
+    args = %W(-Djsdoc.dir=#{@jsdoc_dir}
+              -Djsdoc.template.dir=#{@jsdoc_template_dir}
+              -jar #{@jsdoc_dir}#{S}jsrun.jar
+              #{@jsdoc_dir}#{S}app#{S}run.js
+              -t=#{@jsdoc_template_dir}
+              -d=#{output_dir}) + rest
+    system(JAVA_EXECUTABLE, *args)
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'jsdoc-gem'
+
+class Test::Unit::TestCase
+end

data/test/test_jsdoc.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestJsdocGem < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification 
+name: jsdoc
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Aaron Hamid
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-19 00:00:00 -05:00
+default_executable: jsdoc
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: a wrapper around jsdoc
+email: aaron@incandescentsoftware.com
+executables: 
+- jsdoc
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- VERSION
+- bin/jsdoc
+- jsdoc.gemspec
+- lib/jsdoc-toolkit-2.4.0/README.txt
+- lib/jsdoc-toolkit-2.4.0/app/frame.js
+- lib/jsdoc-toolkit-2.4.0/app/frame/Chain.js
+- lib/jsdoc-toolkit-2.4.0/app/frame/Dumper.js
+- lib/jsdoc-toolkit-2.4.0/app/frame/Hash.js
+- lib/jsdoc-toolkit-2.4.0/app/frame/Link.js
+- lib/jsdoc-toolkit-2.4.0/app/frame/Namespace.js
+- lib/jsdoc-toolkit-2.4.0/app/frame/Opt.js
+- lib/jsdoc-toolkit-2.4.0/app/frame/Reflection.js
+- lib/jsdoc-toolkit-2.4.0/app/frame/String.js
+- lib/jsdoc-toolkit-2.4.0/app/frame/Testrun.js
+- lib/jsdoc-toolkit-2.4.0/app/handlers/FOODOC.js
+- lib/jsdoc-toolkit-2.4.0/app/handlers/XMLDOC.js
+- lib/jsdoc-toolkit-2.4.0/app/handlers/XMLDOC/DomReader.js
+- lib/jsdoc-toolkit-2.4.0/app/handlers/XMLDOC/XMLDoc.js
+- lib/jsdoc-toolkit-2.4.0/app/handlers/XMLDOC/XMLParse.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/DocComment.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/DocTag.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/JsDoc.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/JsPlate.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Lang.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Parser.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/PluginManager.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Symbol.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/SymbolSet.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/TextStream.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Token.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/TokenReader.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/TokenStream.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Util.js
+- lib/jsdoc-toolkit-2.4.0/app/lib/JSDOC/Walker.js
+- lib/jsdoc-toolkit-2.4.0/app/main.js
+- lib/jsdoc-toolkit-2.4.0/app/plugins/commentSrcJson.js
+- lib/jsdoc-toolkit-2.4.0/app/plugins/frameworkPrototype.js
+- lib/jsdoc-toolkit-2.4.0/app/plugins/functionCall.js
+- lib/jsdoc-toolkit-2.4.0/app/plugins/publishSrcHilite.js
+- lib/jsdoc-toolkit-2.4.0/app/plugins/symbolLink.js
+- lib/jsdoc-toolkit-2.4.0/app/plugins/tagParamConfig.js
+- lib/jsdoc-toolkit-2.4.0/app/plugins/tagSynonyms.js
+- lib/jsdoc-toolkit-2.4.0/app/run.js
+- lib/jsdoc-toolkit-2.4.0/app/t/TestDoc.js
+- lib/jsdoc-toolkit-2.4.0/app/t/runner.js
+- lib/jsdoc-toolkit-2.4.0/app/test.js
+- lib/jsdoc-toolkit-2.4.0/app/test/addon.js
+- lib/jsdoc-toolkit-2.4.0/app/test/anon_inner.js
+- lib/jsdoc-toolkit-2.4.0/app/test/augments.js
+- lib/jsdoc-toolkit-2.4.0/app/test/augments2.js
+- lib/jsdoc-toolkit-2.4.0/app/test/borrows.js
+- lib/jsdoc-toolkit-2.4.0/app/test/borrows2.js
+- lib/jsdoc-toolkit-2.4.0/app/test/config.js
+- lib/jsdoc-toolkit-2.4.0/app/test/constructs.js
+- lib/jsdoc-toolkit-2.4.0/app/test/encoding.js
+- lib/jsdoc-toolkit-2.4.0/app/test/encoding_other.js
+- lib/jsdoc-toolkit-2.4.0/app/test/event.js
+- lib/jsdoc-toolkit-2.4.0/app/test/exports.js
+- lib/jsdoc-toolkit-2.4.0/app/test/functions_anon.js
+- lib/jsdoc-toolkit-2.4.0/app/test/functions_nested.js
+- lib/jsdoc-toolkit-2.4.0/app/test/global.js
+- lib/jsdoc-toolkit-2.4.0/app/test/globals.js
+- lib/jsdoc-toolkit-2.4.0/app/test/ignore.js
+- lib/jsdoc-toolkit-2.4.0/app/test/inner.js
+- lib/jsdoc-toolkit-2.4.0/app/test/jsdoc_test.js
+- lib/jsdoc-toolkit-2.4.0/app/test/lend.js
+- lib/jsdoc-toolkit-2.4.0/app/test/memberof.js
+- lib/jsdoc-toolkit-2.4.0/app/test/memberof2.js
+- lib/jsdoc-toolkit-2.4.0/app/test/memberof3.js
+- lib/jsdoc-toolkit-2.4.0/app/test/memberof_constructor.js
+- lib/jsdoc-toolkit-2.4.0/app/test/module.js
+- lib/jsdoc-toolkit-2.4.0/app/test/multi_methods.js
+- lib/jsdoc-toolkit-2.4.0/app/test/name.js
+- lib/jsdoc-toolkit-2.4.0/app/test/namespace_nested.js
+- lib/jsdoc-toolkit-2.4.0/app/test/nocode.js
+- lib/jsdoc-toolkit-2.4.0/app/test/oblit_anon.js
+- lib/jsdoc-toolkit-2.4.0/app/test/overview.js
+- lib/jsdoc-toolkit-2.4.0/app/test/param_inline.js
+- lib/jsdoc-toolkit-2.4.0/app/test/params_optional.js
+- lib/jsdoc-toolkit-2.4.0/app/test/prototype.js
+- lib/jsdoc-toolkit-2.4.0/app/test/prototype_nested.js
+- lib/jsdoc-toolkit-2.4.0/app/test/prototype_oblit.js
+- lib/jsdoc-toolkit-2.4.0/app/test/prototype_oblit_constructor.js
+- lib/jsdoc-toolkit-2.4.0/app/test/public.js
+- lib/jsdoc-toolkit-2.4.0/app/test/scripts/code.js
+- lib/jsdoc-toolkit-2.4.0/app/test/scripts/notcode.txt
+- lib/jsdoc-toolkit-2.4.0/app/test/shared.js
+- lib/jsdoc-toolkit-2.4.0/app/test/shared2.js
+- lib/jsdoc-toolkit-2.4.0/app/test/shortcuts.js
+- lib/jsdoc-toolkit-2.4.0/app/test/static_this.js
+- lib/jsdoc-toolkit-2.4.0/app/test/synonyms.js
+- lib/jsdoc-toolkit-2.4.0/app/test/tosource.js
+- lib/jsdoc-toolkit-2.4.0/app/test/variable_redefine.js
+- lib/jsdoc-toolkit-2.4.0/changes.txt
+- lib/jsdoc-toolkit-2.4.0/conf/sample.conf
+- lib/jsdoc-toolkit-2.4.0/java/build.xml
+- lib/jsdoc-toolkit-2.4.0/java/build_1.4.xml
+- lib/jsdoc-toolkit-2.4.0/java/classes/js.jar
+- lib/jsdoc-toolkit-2.4.0/java/src/JsDebugRun.java
+- lib/jsdoc-toolkit-2.4.0/java/src/JsRun.java
+- lib/jsdoc-toolkit-2.4.0/jsdebug.jar
+- lib/jsdoc-toolkit-2.4.0/jsrun.jar
+- lib/jsdoc-toolkit-2.4.0/jsrun.sh
+- lib/jsdoc-toolkit-2.4.0/templates/jsdoc/allclasses.tmpl
+- lib/jsdoc-toolkit-2.4.0/templates/jsdoc/allfiles.tmpl
+- lib/jsdoc-toolkit-2.4.0/templates/jsdoc/class.tmpl
+- lib/jsdoc-toolkit-2.4.0/templates/jsdoc/index.tmpl
+- lib/jsdoc-toolkit-2.4.0/templates/jsdoc/publish.js
+- lib/jsdoc-toolkit-2.4.0/templates/jsdoc/static/default.css
+- lib/jsdoc-toolkit-2.4.0/templates/jsdoc/static/header.html
+- lib/jsdoc-toolkit-2.4.0/templates/jsdoc/static/index.html
+- lib/jsdoc-toolkit-2.4.0/templates/jsdoc/symbol.tmpl
+- lib/jsdoc.rb
+- test/test_jsdoc.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/incandescent/jsdoc-gem
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: a wrapper around jsdoc
+test_files: 
+- test/test_jsdoc.rb
+- test/helper.rb