pdoc 0.2.0

data/test/unit/parser/ebnf_javascript_test.rb

@@ -0,0 +1,37 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "parser_test_helper"))
+
+class EbnfJavascriptTest < Test::Unit::TestCase
+  include PDocTestHelper
+  
+  def setup
+    @parser = EbnfJavascriptParser.new
+  end
+  
+  def test_variable
+    assert_parsed "innerHTML"
+    assert_parsed "extended"
+    assert_parsed "getElementsByClassName"
+  end
+  
+  def test_constant
+    assert_parsed "Element"
+    assert_parsed "DefaultOptions"
+  end
+  
+  def test_all_caps_constant
+    assert_parsed "CSS"
+    assert_parsed "KEY_BACKSPACE"
+  end
+  
+  def test_object # basic and non-recursive
+    assert_parsed "{}"
+    assert_parsed "{foo: 'bar'}"
+  end
+  
+  def test_namespace # basic and non-recursive
+    assert_parsed "Foo.Bar"
+    assert_parsed "foo.bar"
+    assert_parsed "foo.Bar"
+    assert_parsed "Foo.bar"
+  end
+end

data/test/unit/parser/events_test.rb

@@ -0,0 +1,27 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "parser_test_helper"))
+
+class EventsTest < Test::Unit::TestCase
+  include PDocTestHelper
+  
+  def setup
+    @parser = EventsParser.new
+  end
+  
+  def test_single_event
+    fixture = "\n * fires click"
+    assert_parsed fixture
+    assert_equal %w[click],                  parse(fixture).to_a
+  end
+  
+  def test_single_namespaced_event
+    fixture = "\n * fires element:updated"
+    assert_parsed fixture
+    assert_equal %w[element:updated],        parse(fixture).to_a
+  end
+  
+  def test_multiple_events
+    fixture = "\n * fires click, element:updated"
+    assert_parsed fixture
+    assert_equal %w[click element:updated],  parse(fixture).to_a
+  end
+end

data/test/unit/parser/section_content_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "parser_test_helper"))
+
+class SectionContentTest < Test::Unit::TestCase
+  include PDocTestHelper
+  include Basic
+  include Description
+  include SectionContent
+  
+  def setup
+    @parser = SectionContentParser.new
+  end
+  
+  def test_parsing
+    assert_parsed "\n* ==dom==\n * hello"
+    assert_parsed "\n* == dom ==  \n * hello"
+  end
+  
+  def test_section
+    text = "\n* == dom ==  \n * hello"
+    assert_equal Section, parse(text).class
+  end
+  
+  def test_title
+    text = "\n* == DOM ==  \n * hello"
+    assert_equal "DOM", parse(text).name
+    assert_equal "DOM", parse(text).full_name
+    assert_equal "dom", parse(text).id
+    
+    text = "\n* == Some Section ==  \n * hello"
+    assert_equal "Some Section", parse(text).name
+    assert_equal "Some Section", parse(text).full_name
+    assert_equal "some_section", parse(text).id
+    
+    text = "\n* == scripty2 ==  \n * hello"
+    assert_equal "scripty2", parse(text).name
+    assert_equal "scripty2", parse(text).full_name
+    assert_equal "scripty2", parse(text).id
+  end
+  
+  def test_description
+    text = "\n* == Some Section ==  \n * hello"
+    assert_equal "hello", parse(text).description
+  end
+end

data/test/unit/parser/tags_test.rb

@@ -0,0 +1,39 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "parser_test_helper"))
+
+class TagsTest < Test::Unit::TestCase
+  include PDocTestHelper
+  
+  def setup
+    @parser = TagsParser.new
+  end
+  
+  def test_valueless_tag
+    tag = "deprecated"
+    assert_parsed tag
+    assert_equal "deprecated", parse(tag).to_a.first.name
+    assert_equal nil,          parse(tag).to_a.first.value
+  end
+  
+  def test_tag_with_value
+    tag = "section: dom"
+    assert_parsed tag
+    assert_equal "section", parse(tag).to_a.first.name
+    assert_equal "dom", parse(tag).to_a.first.value
+    
+    tag = "alias of: $A"
+    assert_parsed tag
+    assert_equal "alias of", parse(tag).to_a.first.name
+    assert_equal "$A", parse(tag).to_a.first.value
+  end
+  
+  def test_tags
+    tags = "deprecated, alias of: $A"
+    assert_parsed tags
+    assert_equal "deprecated", parse(tags).to_a.first.name
+    assert_equal nil,          parse(tags).to_a.first.value
+    assert_equal "alias of",   parse(tags).to_a.last.name
+    assert_equal "$A",         parse(tags).to_a.last.value
+    assert                     parse(tags).include?("deprecated")
+    assert                    !parse(tags).include?("foo")
+  end
+end

data/test/unit/parser/test_fragment.rb

@@ -0,0 +1,80 @@
+require "test/unit"
+require "../../../lib/pdoc/parser/fragment"
+require "../../../lib/pdoc/error"
+
+class TestFragment < Test::Unit::TestCase
+  
+  def test_normalize_empty_fragment
+    fragment =<<EOF
+    /**
+    *
+    *
+    **/
+EOF
+    fragment = PDoc::Fragment.new(fragment, 0)
+    lines = fragment.normalize
+    assert_equal("", lines[0])
+    assert_equal("", lines[1])
+    assert_equal("", lines.last)
+  end
+  
+  def test_normalize_basic_fragment
+    fragment =<<EOF
+    /**
+    * foo
+    *   bar
+    **/
+EOF
+    fragment = PDoc::Fragment.new(fragment, 0)
+    lines = fragment.normalize
+    assert_equal("", lines[0])
+    assert_equal("foo", lines[1])
+    assert_equal("  bar", lines[2])
+    assert_equal("", lines.last)
+  end
+  
+  def test_normalize_broken_fragment
+    fragment =<<EOF
+    /**
+    * foo
+    *bar
+    **/
+EOF
+    assert_raise PDoc::Fragment::InconsistentPrefixError do
+      PDoc::Fragment.new(fragment, 0).normalize
+    end
+  end
+  
+  def test_empty_prefix
+    fragment =<<EOF
+/**
+foo
+  bar
+**/
+EOF
+    fragment = PDoc::Fragment.new(fragment, 0)
+    assert_equal("", fragment.prefix)
+  end
+  
+  def test_whitespace_prefix
+    fragment =<<EOF
+    /**
+  foo
+    bar
+  **/
+EOF
+    fragment = PDoc::Fragment.new(fragment, 0)
+    assert_equal("  ", fragment.prefix)
+  end
+
+  def test_mixed_prefix
+    fragment =<<EOF
+/**
+ * foo
+ *   bar
+ **/
+EOF
+    fragment = PDoc::Fragment.new(fragment, 0)
+    assert_equal(" * ", fragment.prefix)
+  end 
+end

data/test/unit/parser_test_helper.rb

@@ -0,0 +1,62 @@
+require 'test/unit'
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "..", "lib", "pdoc")) unless defined?(PDoc)
+
+class Treetop::Runtime::SyntaxNode 
+  def method_missing(method, *args)
+    raise "Node representing '#{text_value}' does not respond to '#{method}'"
+  end
+end
+
+module PDocTestHelper
+  def parse(input)
+    result = @parser.parse(input)
+    unless result
+      puts "\n" << @parser.terminal_failures.join("\n") << "\n"
+    end
+    assert !result.nil?
+    result
+  end
+  
+  def blank_line
+    "\n * \n "
+  end
+  
+  def parse_file(filename)
+    path = File.expand_path(File.join(File.dirname(__FILE__), "..", "fixtures", filename))
+    file = File.open(path){ |f| f.read }
+    file.gsub!(/\r\n/, "\n")
+    file = file.split("\n").map do |line|
+      line.gsub(/\s+$/, '')
+    end.join("\n")
+    parse(file)
+  end
+  
+  def assert_parsed(input)
+    assert !parse(input).nil?
+  end
+  
+  def assert_file_parsed(filename)
+    assert !parse_file(filename).nil?
+  end
+  
+  def assert_not_parsed(input)
+    assert @parser.parse(input).nil?
+  end
+end
+
+# Stolen from Rails
+unless :test.respond_to?(:to_proc)
+  class Symbol
+    # Turns the symbol into a simple proc, which is especially useful for enumerations. Examples:
+    #
+    #   # The same as people.collect { |p| p.name }
+    #   people.collect(&:name)
+    #
+    #   # The same as people.select { |p| p.manager? }.collect { |p| p.salary }
+    #   people.select(&:manager?).collect(&:salary)
+    def to_proc
+      Proc.new { |*args| args.shift.__send__(self, *args) }
+    end
+  end
+end

data/test/unit/runner/basic_test.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "parser_test_helper"))
+
+class BasicTest < Test::Unit::TestCase
+  
+  def test_restores_original_dir
+    original_dir = Dir.pwd
+    puts "*** #{original_dir}"
+    PDoc::Runner.new("test/fixtures/test.txt",
+      :output    => 'test/output',
+      :templates => 'templates/html'
+    ).run
+    assert_equal original_dir, Dir.pwd
+  end
+end

data/test/unit/templates/html_helpers_test.rb

@@ -0,0 +1,25 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "parser_test_helper"))
+require File.expand_path(File.join(File.dirname(__FILE__), *%w[.. .. .. templates html helpers]))
+
+class HtmlHelpersTest < Test::Unit::TestCase
+  include PDocTestHelper
+  # include EbnfExpression
+  
+  def setup
+    @helper = Object.new
+    class << @helper
+      attr_accessor :root
+      include PDoc::Generators::Html::Helpers::BaseHelper
+      include PDoc::Generators::Html::Helpers::LinkHelper
+      include PDoc::Generators::Html::Helpers::CodeHelper
+      
+      def path_to(foo)
+        '/some/path' # Not tested here, although it should
+      end
+    end
+  end
+  
+  def test_truth
+    assert true
+  end
+end

metadata

@@ -0,0 +1,222 @@
+--- !ruby/object:Gem::Specification 
+name: pdoc
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Tobie Langel
+autorequire: lib/pdoc.rb
+bindir: bin
+cert_chain: []
+
+date: 2008-11-17 00:00:00 -06:00
+default_executable: pdoc
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: BlueCloth
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 0
+        version: 0.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: treetop
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 0
+        version: 0.0.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: oyster
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 0
+        version: 0.0.0
+  type: :runtime
+  version_requirements: *id003
+description: PDoc is an inline comment parser and JavaScript documentation generator written in Ruby. It is designed for documenting Prototype and Prototype-based libraries.
+email: tobie.langel@gmail.com
+executables: 
+- pdoc
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- Rakefile
+- pdoc.gemspec
+- lib/pdoc/error.rb
+- lib/pdoc/generators/abstract_generator.rb
+- lib/pdoc/generators/html/helpers.rb
+- lib/pdoc/generators/html/page.rb
+- lib/pdoc/generators/html/syntax_highlighter.rb
+- lib/pdoc/generators/html/template.rb
+- lib/pdoc/generators/html/website.rb
+- lib/pdoc/generators/html.rb
+- lib/pdoc/generators/json.rb
+- lib/pdoc/generators/pythonesque.rb
+- lib/pdoc/generators.rb
+- lib/pdoc/models/argument.rb
+- lib/pdoc/models/base.rb
+- lib/pdoc/models/callable.rb
+- lib/pdoc/models/class.rb
+- lib/pdoc/models/class_method.rb
+- lib/pdoc/models/class_property.rb
+- lib/pdoc/models/constant.rb
+- lib/pdoc/models/constructor.rb
+- lib/pdoc/models/container.rb
+- lib/pdoc/models/entity.rb
+- lib/pdoc/models/instance_method.rb
+- lib/pdoc/models/instance_property.rb
+- lib/pdoc/models/mixin.rb
+- lib/pdoc/models/namespace.rb
+- lib/pdoc/models/root.rb
+- lib/pdoc/models/section.rb
+- lib/pdoc/models/signature.rb
+- lib/pdoc/models/utility.rb
+- lib/pdoc/models.rb
+- lib/pdoc/parser/argument_description_nodes.rb
+- lib/pdoc/parser/basic_nodes.rb
+- lib/pdoc/parser/description_nodes.rb
+- lib/pdoc/parser/documentation_nodes.rb
+- lib/pdoc/parser/ebnf_arguments_nodes.rb
+- lib/pdoc/parser/ebnf_expression_nodes.rb
+- lib/pdoc/parser/fragment.rb
+- lib/pdoc/parser/section_content_nodes.rb
+- lib/pdoc/parser/tags_nodes.rb
+- lib/pdoc/parser/treetop_files/argument_description.treetop
+- lib/pdoc/parser/treetop_files/basic.treetop
+- lib/pdoc/parser/treetop_files/description.treetop
+- lib/pdoc/parser/treetop_files/documentation.treetop
+- lib/pdoc/parser/treetop_files/ebnf_arguments.treetop
+- lib/pdoc/parser/treetop_files/ebnf_expression.treetop
+- lib/pdoc/parser/treetop_files/ebnf_javascript.treetop
+- lib/pdoc/parser/treetop_files/events.treetop
+- lib/pdoc/parser/treetop_files/section_content.treetop
+- lib/pdoc/parser/treetop_files/tags.treetop
+- lib/pdoc/parser.rb
+- lib/pdoc/runner.rb
+- lib/pdoc/treemaker.rb
+- lib/pdoc.rb
+- templates/html/assets/images/pdoc/alias.png
+- templates/html/assets/images/pdoc/class.png
+- templates/html/assets/images/pdoc/class_deprecated.png
+- templates/html/assets/images/pdoc/class_method.png
+- templates/html/assets/images/pdoc/class_property.png
+- templates/html/assets/images/pdoc/constant.png
+- templates/html/assets/images/pdoc/constructor.png
+- templates/html/assets/images/pdoc/deprecated.png
+- templates/html/assets/images/pdoc/description.png
+- templates/html/assets/images/pdoc/information.png
+- templates/html/assets/images/pdoc/instance_method.png
+- templates/html/assets/images/pdoc/instance_property.png
+- templates/html/assets/images/pdoc/method.png
+- templates/html/assets/images/pdoc/method_deprecated.png
+- templates/html/assets/images/pdoc/mixin.png
+- templates/html/assets/images/pdoc/namespace.png
+- templates/html/assets/images/pdoc/property.png
+- templates/html/assets/images/pdoc/related_to.png
+- templates/html/assets/images/pdoc/search-background.png
+- templates/html/assets/images/pdoc/section-background.png
+- templates/html/assets/images/pdoc/section.png
+- templates/html/assets/images/pdoc/selected-section-background.png
+- templates/html/assets/images/pdoc/subclass.png
+- templates/html/assets/images/pdoc/superclass.png
+- templates/html/assets/images/pdoc/utility.png
+- templates/html/assets/javascripts/pdoc/application.js
+- templates/html/assets/javascripts/pdoc/prototype.js
+- templates/html/assets/javascripts/pdoc/tabs.js
+- templates/html/assets/stylesheets/pdoc/api.css
+- templates/html/assets/stylesheets/pdoc/pygments.css
+- templates/html/helpers.rb
+- templates/html/index.erb
+- templates/html/item_index.js.erb
+- templates/html/layout.erb
+- templates/html/leaf.erb
+- templates/html/node.erb
+- templates/html/partials/class_relationships.erb
+- templates/html/partials/classes.erb
+- templates/html/partials/constructor.erb
+- templates/html/partials/description.erb
+- templates/html/partials/link_list.erb
+- templates/html/partials/method_signatures.erb
+- templates/html/partials/methodized_note.erb
+- templates/html/partials/mixins.erb
+- templates/html/partials/namespaces.erb
+- templates/html/partials/related_utilities.erb
+- templates/html/partials/relationships.erb
+- templates/html/partials/short_description_list.erb
+- templates/html/partials/title.erb
+- templates/html/section.erb
+has_rdoc: true
+homepage: http://pdoc.org/
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Inline comment parser and JavaScript documentation generator
+test_files: 
+- test/unit/parser/argument_description_test.rb
+- test/unit/parser/basic_test.rb
+- test/unit/parser/description_test.rb
+- test/unit/parser/documentation_test.rb
+- test/unit/parser/ebnf_arguments_test.rb
+- test/unit/parser/ebnf_expression_test.rb
+- test/unit/parser/ebnf_javascript_test.rb
+- test/unit/parser/events_test.rb
+- test/unit/parser/section_content_test.rb
+- test/unit/parser/tags_test.rb
+- test/unit/parser/test_fragment.rb
+- test/unit/parser_test_helper.rb
+- test/unit/runner/basic_test.rb
+- test/unit/templates/html_helpers_test.rb