pdoc 0.2.0

data/lib/pdoc/parser/ebnf_arguments_nodes.rb

@@ -0,0 +1,58 @@
+module EbnfArguments
+  class Argument < Treetop::Runtime::SyntaxNode
+    def name
+      text_value.strip
+    end
+    
+    def optional?
+      false
+    end
+    
+    def default_value
+      nil
+    end
+    
+    def flatten_nested_args
+      [self]
+    end
+  end
+
+  class OptionalArgument < Treetop::Runtime::SyntaxNode
+    def name
+      required_argument.name
+    end
+    
+    def optional?
+      true
+    end
+    
+    def default_value
+      unless default.empty?
+        value = default.value.text_value.strip
+        value.empty? ? nil : value
+      end
+    end
+    
+    def flatten_nested_args
+      arguments = [self]
+      unless nested.empty?
+        nested.elements.each do |optional|
+          arguments.concat(optional.flatten_nested_args)
+        end
+      end
+      arguments
+    end
+  end
+  
+  class Arguments < Treetop::Runtime::SyntaxNode
+    def to_a
+      first_argument.flatten_nested_args + rest_arguments_flattened
+    end
+    
+    def rest_arguments_flattened
+      rest.elements.inject([]) do |args, e|
+        args.concat(e.argument.flatten_nested_args)
+      end
+    end
+  end
+end

data/lib/pdoc/parser/ebnf_expression_nodes.rb

@@ -0,0 +1,227 @@
+module EbnfExpression
+  class Base < Treetop::Runtime::SyntaxNode
+    def klass_name
+      js_namespace.to_a.last
+    end
+    
+    def name
+      js_variable.value
+    end
+    
+    def full_name
+      js_namespace.text_value
+    end
+    
+    def namespace
+      js_namespace.text_value
+    end
+    
+    def returns
+      return_value.value.text_value.strip
+    end
+    
+    def to_s
+      text_value
+    end
+    
+    def inspect
+      "#<#{self.class} @input=#{@input.inspect}>"
+    end
+  end
+  
+  class Method < Base
+    def arguments
+      args.arguments.to_a
+    end
+    
+    def methodized?
+      false
+    end
+    
+    def signature
+      "#{name}#{args.text_value}"
+    end
+  end
+  
+  class KlassMethod < Method
+    def klass_name
+      js_namespace.to_a.slice(-2)
+    end
+    
+    def name
+      js_namespace.to_a.last
+    end
+
+    def methodized?
+      args.methodize.text_value == '@'
+    end
+
+    def namespace
+      js_namespace.to_a.slice(0..-2).join(".")
+    end
+    
+    def signature
+      "#{namespace}.#{name}#{args.text_value.sub('@', '')}"
+    end
+  end
+  
+  class Utility < Method
+    def klass_name
+      nil
+    end
+    
+    def name
+      utility_name.text_value
+    end
+    
+    def full_name
+      name
+    end
+    
+    def namespace
+      ""
+    end
+  end
+  
+  class InstanceMethod < Method
+    def accessor
+      instance_signature.instance_accessor
+    end
+    
+    def args
+      instance_signature.args
+    end
+    
+    def js_namespace
+      accessor.js_namespace
+    end
+    
+    def js_variable
+      accessor.js_variable
+    end
+    
+    def full_name
+      accessor.text_value
+    end
+
+    def signature
+      instance_signature.text_value
+    end
+  end
+  
+  class Constructor < Method
+    def name
+      "new"
+    end
+    
+    def full_name
+      "new #{super}"
+    end
+    
+    def returns
+      nil
+    end
+    
+    def signature
+      "#{full_name}#{args.text_value}"
+    end
+  end
+  
+  class KlassProperty < Base
+    def klass_name
+      js_namespace.to_a.slice(-2)
+    end
+    
+    def name
+      js_namespace.to_a.last
+    end
+
+    def namespace
+      js_namespace.to_a.slice(0..-2).join(".")
+    end
+    
+    def signature
+      "#{namespace}.#{name}"
+    end
+  end
+  
+  class InstanceProperty < Base
+    def accessor
+      instance_accessor
+    end
+    
+    def js_namespace
+      accessor.js_namespace
+    end
+    
+    def js_variable
+      accessor.js_variable
+    end
+    
+    def full_name
+      accessor.text_value
+    end
+    
+    def signature
+      "#{namespace}##{name}"
+    end
+  end
+  
+  class Constant < Base
+    def klass_name
+      nil
+    end
+    
+    def name
+      js_namespace.to_a.last
+    end
+        
+    def namespace
+      js_namespace.to_a.slice(0..-2).join(".")
+    end
+    
+    def returns
+      value.text_value.strip
+    end
+    
+    def signature
+      "#{namespace}.#{name}"
+    end
+  end
+  
+  class Namespace < Base
+    def klass_name
+      nil
+    end
+    
+    def name
+      js_namespace.to_a.last
+    end
+
+    def namespace
+      js_namespace.to_a.slice(0..-2).join(".")
+    end
+    
+    def mixins
+      second_line = elements.last
+      if second_line.empty?
+        []
+      else
+        [second_line.js_namespace].concat(second_line.more.elements.map{|e| e.elements.last})
+      end
+    end
+  end
+  
+  class Klass < Namespace
+    def subklass?
+      !extends.elements.nil?
+    end
+    
+    def superklass
+      subklass? ? extends.elements.last : nil
+    end
+  end
+  
+  class Mixin < Namespace
+  end
+end

data/lib/pdoc/parser/fragment.rb

@@ -0,0 +1,55 @@
+require 'pdoc/error'
+
+module PDoc
+  class Fragment
+    PREFIX_REGEXP = /^\s*\*?\s*/
+    
+    attr_reader :line_number
+    def initialize(string, line_number)
+      @line_number = line_number
+      @string = string
+    end
+    
+    def normalize
+      # Cleans up the text by removing opening and closing comment tags
+      # and removing the prefix off of every line.
+      # Raises and error if prefix are inconsistent. (Prefix is calculated
+      # by looking at line 2 of the comment)
+      results = []
+      lines.each_with_index do |line, index|
+        if index == 0                              # first line
+          results << line.sub(/\s*\/\*\*\s*/, '')  # remove opening /**
+        elsif index == lines.size - 1              # last line
+          results << line.sub(/\s*\*\*?\/\s*/, '') # remove closing **/
+        elsif line =~ prefix_regexp                # correctly prefixed lines
+          results << line.sub(prefix_regexp, '')   # remove optional prefix
+        else
+          raise InconsistentPrefixError.new(self, line, index)
+        end
+      end
+      results
+    end
+    
+    def prefix
+      PREFIX_REGEXP.match(lines[1])[0] if lines.size > 2
+    end
+    
+    def prefix_regexp
+      @prefix_regexp ||= Regexp.new('^' << Regexp.escape(prefix))
+    end
+    
+    def lines
+      @lines ||= @string.split("\n")
+    end
+    
+    class InconsistentPrefixError < PDocError
+      def initialize(fragment, line, index)
+        @fragment = fragment
+        actual = PREFIX_REGEXP.match(line)[0].inspect
+        msg = "Inconsistent prefixing at line ##{fragment.line_number + index}."
+        msg << "Expected prefix is: #{fragment.prefix.inspect}, actual prefix is: #{actual}"
+        super(msg)
+      end
+    end
+  end
+end

data/lib/pdoc/parser/section_content_nodes.rb

@@ -0,0 +1,19 @@
+module SectionContent
+  class Section < Treetop::Runtime::SyntaxNode
+    def name
+      title.text_value.strip
+    end
+
+    def description
+      text.to_s
+    end
+
+    def full_name
+      name
+    end
+    
+    def id
+      name.downcase.gsub(/\s+/, "_")
+    end
+  end
+end

data/lib/pdoc/parser/tags_nodes.rb

@@ -0,0 +1,14 @@
+module Tags
+  class Tags < Treetop::Runtime::SyntaxNode
+    include Enumerable
+    
+    def include?(tag_name)
+      any? {|tag| tag.name == tag_name }
+    end
+    
+    def each
+      yield tag
+      more.elements.each { |e| yield e.tag }
+    end
+  end
+end

data/lib/pdoc/parser/treetop_files/argument_description.treetop

@@ -0,0 +1,31 @@
+grammar ArgumentDescription
+  include EbnfJavascript
+  
+  rule argument_description
+    first:argument_description_first_line more:(argument_description_line)* <ArgumentDescription>
+  end
+  
+  rule argument_description_first_line
+    line space* '-' space+ argument_name arg_types:(space+ arguments_types)? ':' description:char+
+  end
+  
+  rule argument_description_line
+    line space* first_char:(!'-' .) more_char:char+ {
+      def to_s
+        first_char.text_value << more_char.text_value
+      end
+    }
+  end
+  
+  rule argument_name
+    '@'? name:[a-zA-Z$]+
+  end
+  
+  rule arguments_types
+    '(' space* argument_type more:(space+ '|' space+ argument_type)* space* ')'
+  end
+  
+  rule argument_type
+    js_namespace / '?'
+  end
+end

data/lib/pdoc/parser/treetop_files/basic.treetop

@@ -0,0 +1,41 @@
+grammar Basic
+  rule test_base
+    (blank_line / text_line / comment_start / comment_end / line / line_break / space / char)+
+  end
+
+  rule blank_line
+    line_break space* line_separator space* &(line_break) <BlankLine>
+  end
+  
+  rule text_line
+    line text:char+ <TextLine>
+  end
+  
+  rule line
+    line_break space* line_separator space <Line>
+  end
+  
+  rule comment_start
+    line_break space* "/**" space* <CommentStart>
+  end
+  
+  rule comment_end
+    line_break space* "**/" space* line_break <CommentEnd>
+  end
+  
+  rule line_break
+    [\n] <LineBreak>
+  end
+  
+  rule line_separator
+    "*"
+  end
+
+  rule char
+    ![\n] . <Char>
+  end
+  
+  rule space
+    " " <Space>
+  end
+end