jsdoc_plugin 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Aaron Hamid
+
+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,17 @@
+= jsdoc_plugin
+
+Description goes here.
+
+== 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) 2010 Aaron Hamid. See LICENSE for details.

data/VERSION

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

data/jsdoc_plugin.gemspec

@@ -0,0 +1,55 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{jsdoc_plugin}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Hamid"]
+  s.date = %q{2010-11-19}
+  s.description = %q{adds a doc:jsdco task to a rails project}
+  s.email = %q{aaron@incandescentsoftware.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.rdoc",
+     "VERSION",
+     "jsdoc_plugin.gemspec",
+     "lib/jsdoc_plugin.rb",
+     "lib/jsdoc_plugin/railtie.rb",
+     "lib/jsdoc_plugin/version.rb",
+     "lib/tasks/jsdoc.rake"
+  ]
+  s.homepage = %q{http://github.com/incandescent/jsdoc_plugin}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{adds a doc:jsdoc task to a rails project}
+  s.test_files = [
+    "test/test_jsdoc_plugin.rb",
+     "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::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<jsdoc>, [">= 0"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<jsdoc>, [">= 0"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<jsdoc>, [">= 0"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/lib/jsdoc_plugin.rb

@@ -0,0 +1,3 @@
+module JsDocPlugin
+  require 'jsdoc_plugin/railtie' if defined?(Rails)
+end

data/lib/jsdoc_plugin/railtie.rb

@@ -0,0 +1,11 @@
+require 'jsdoc'
+require 'rails'
+
+module JsDocPlugin
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      puts "Loading jsdoc rake tasks"
+      load "tasks/jsdoc.rake"
+    end
+  end
+end

data/lib/jsdoc_plugin/version.rb

@@ -0,0 +1,3 @@
+module JsDocPlugin
+  VERSION = "0.1.0"
+end

data/lib/tasks/jsdoc.rake

@@ -0,0 +1,24 @@
+require 'jsdoc'
+require 'fileutils'
+
+EXCLUDE_REGEXES = %w(.*\.min\.js)
+
+def generate_jsdoc(*args)
+  # TODO: determine root of Rails project
+  dir = File.expand_path('doc' + File::SEPARATOR + 'jsdoc')
+  FileUtils.mkdir_p(dir)
+  recursive = '-r'
+  jsdoc_args = [ recursive ]
+  jsdoc_args += EXCLUDE_REGEXES.map{|x| "-E=#{x}"}
+  jsdoc_args += args
+  JsDoc.new.run(dir, *jsdoc_args)
+end
+
+namespace :doc do
+  
+  desc "Generate jsdoc docs"
+  task :jsdoc do
+    generate_jsdoc('public')
+  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_plugin'
+
+class Test::Unit::TestCase
+end

data/test/test_jsdoc_plugin.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestJsdocPlugin < 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,105 @@
+--- !ruby/object:Gem::Specification 
+name: jsdoc_plugin
+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: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jsdoc
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: adds a doc:jsdco task to a rails project
+email: aaron@incandescentsoftware.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- VERSION
+- jsdoc_plugin.gemspec
+- lib/jsdoc_plugin.rb
+- lib/jsdoc_plugin/railtie.rb
+- lib/jsdoc_plugin/version.rb
+- lib/tasks/jsdoc.rake
+- test/test_jsdoc_plugin.rb
+- test/helper.rb
+has_rdoc: true
+homepage: http://github.com/incandescent/jsdoc_plugin
+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: adds a doc:jsdoc task to a rails project
+test_files: 
+- test/test_jsdoc_plugin.rb
+- test/helper.rb