distil 0.11.6 → 0.11.8

data/vendor/pdoc/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/vendor/pdoc/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/vendor/pdoc/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/vendor/pdoc/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/vendor/pdoc/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/vendor/pdoc/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

data/vendor/pdoc/lib/pdoc/parser/treetop_files/description.treetop

@@ -0,0 +1,7 @@
+grammar Description
+  include Basic
+  
+  rule text
+    (blank_line / text_line)* <Text>
+  end
+end

data/vendor/pdoc/lib/pdoc/parser/treetop_files/documentation.treetop

@@ -0,0 +1,75 @@
+grammar Documentation
+  include Tags
+  include Events
+  include ArgumentDescription
+  include Description
+  include SectionContent
+  include EbnfExpression
+  
+  rule documentation
+    ((!comment_start .)* doc_instance)+ (!comment_start .)* <Doc> / (!comment_start .)* {
+      def each
+      end
+    }
+  end
+  
+  rule doc_instance
+    section_doc / klass_method_doc / instance_method_doc / klass_property_doc / instance_property_doc / utility_doc / constructor_doc / klass_doc / mixin_doc / constant_doc / namespace_doc
+  end
+  
+  rule section_doc
+    start section comment_end <Section>
+  end
+  
+  rule constructor_doc
+    start ebnf:(line constructor)+ argument_descriptions events text comment_end <Constructor>
+  end
+  
+  rule mixin_doc
+    start line ebnf:mixin text comment_end <Mixin>
+  end
+  
+  rule klass_doc
+    start line space* ebnf:klass text comment_end <Klass>
+  end
+
+  rule klass_method_doc
+    start ebnf:(line klass_method)+ argument_descriptions events text comment_end <KlassMethod>
+  end
+  
+  rule instance_method_doc
+    start ebnf:(line instance_method)+ argument_descriptions events text comment_end <InstanceMethod>
+  end
+  
+  rule klass_property_doc
+    start line ebnf:klass_property text comment_end <KlassProperty>
+  end
+  
+  rule instance_property_doc
+    start line ebnf:instance_property text comment_end <InstanceProperty>
+  end
+
+  rule constant_doc
+    start line ebnf:constant text comment_end <Constant>
+  end
+  
+  rule utility_doc
+    start ebnf:(line utility)+ argument_descriptions events text comment_end <Utility>
+  end
+  
+  rule namespace_doc
+    start line space* ebnf:namespace text comment_end <Namespace>
+  end
+  
+  rule start
+    comment_start space* (tags)?
+  end
+  
+  rule argument_descriptions
+    (argument_description+ blank_line)?
+  end
+  
+  rule events
+    (super)?
+  end
+end

data/vendor/pdoc/lib/pdoc/parser/treetop_files/ebnf_arguments.treetop

@@ -0,0 +1,33 @@
+grammar EbnfArguments
+  include EbnfJavascript
+
+  rule arguments
+    first_argument:argument rest:(argument_separator argument)* <Arguments>
+    /
+    space* {
+      def to_a
+        []
+      end
+    }
+  end
+
+  rule argument
+    optional_argument / required_argument
+  end
+
+  rule argument_separator
+    space* (&'[' / ',')
+  end
+
+  rule optional_argument
+    "[" space* ","? required_argument default:(default_value?) nested:(optional_argument*) "]" <OptionalArgument> 
+  end
+
+  rule default_value
+    space* "=" space* value:[^\[\]]+ 
+  end
+
+  rule required_argument
+    space* (js_variable / js_object) '...'? space* <Argument>
+  end
+end

data/vendor/pdoc/lib/pdoc/parser/treetop_files/ebnf_expression.treetop

@@ -0,0 +1,70 @@
+grammar EbnfExpression
+  include EbnfArguments
+  rule ebnf
+    klass_method / instance_method / klass_property / instance_property / utility / constructor / mixin / klass / constant / namespace 
+  end
+  
+  rule mixin
+    space* 'mixin' space+ js_namespace  (includes)? <Mixin>
+  end
+  
+  rule klass
+    space* 'class' space+ js_namespace extends:(space+ '<' space+ js_namespace)? (includes)? <Klass>
+  end
+  
+  rule includes
+    line space* 'includes' space+ js_namespace more:(',' space+ js_namespace)*
+  end
+  
+  rule constructor
+    space* 'new' (space)+ js_namespace args <Constructor>
+  end
+  
+  rule instance_accessor
+    js_namespace '#' js_variable
+  end
+  
+  rule instance_signature
+    instance_accessor args
+  end
+
+  rule klass_method
+    space* js_namespace args return_value <KlassMethod>
+  end
+  
+  rule instance_method
+    space* instance_signature return_value <InstanceMethod>
+  end
+  
+  rule klass_property
+    space* js_namespace return_value <KlassProperty>
+  end
+  
+  rule instance_property
+    space* instance_accessor return_value <InstanceProperty>
+  end
+
+  rule constant
+    space* js_namespace space* "=" space* value:(char)+ space* <Constant>
+  end
+  
+  rule utility
+    space* utility_name:('$' [$a-zA-Z]*) args return_value <Utility>
+  end
+  
+  rule args
+    '(' space* methodize:'@'? arguments space* ')' {
+      def text_value
+        super.to_s.sub('( )', '()')
+      end
+    }
+  end
+
+  rule namespace
+    js_namespace (includes)? <Namespace>
+  end
+
+  rule return_value
+    space* '->' space* value:(char)+
+  end
+end

data/vendor/pdoc/lib/pdoc/parser/treetop_files/ebnf_javascript.treetop

@@ -0,0 +1,54 @@
+grammar EbnfJavascript
+  include Basic
+  rule primitive
+    js_all_caps_constant / js_namespace / js_constant  / js_variable / js_object
+  end
+  
+  rule js_object
+    '{' [^}]* '}'
+  end
+  
+  rule js_constant
+    [A-Z] [a-zA-Z_0-9$]* {
+      def value
+        text_value
+      end
+    }
+  end
+
+  rule js_all_caps_constant
+    [A-Z] [A-Z_]+ {
+      def value
+        text_value
+      end
+    }
+  end
+  
+  rule js_variable
+    [_a-zA-Z] [_a-zA-Z0-9]* {
+      def value
+        text_value
+      end
+    }
+  end
+  
+  rule js_namespace
+    (js_constant / js_all_caps_constant / js_variable) ('.' (js_constant / js_all_caps_constant / js_variable))* {
+      def namespace
+        to_a.slice(0..-2).join(".")
+      end
+    
+      def name
+        to_a.pop
+      end
+    
+      def to_a
+        text_value.split('.')
+      end
+      
+      def full_name
+        text_value
+      end
+    }
+  end
+end

data/vendor/pdoc/lib/pdoc/parser/treetop_files/events.treetop

@@ -0,0 +1,17 @@
+grammar Events
+  include Basic
+  
+  rule events
+    line space* 'fires' space+ event more:(',' space* event)* {
+      def to_a
+        [event.text_value].concat(more.elements.map{ |e| e.event.text_value })
+      end
+    }
+  end
+  
+  rule event
+    [a-zA-Z]+ (':' [a-zA-Z]+)*
+  end
+end
+
+

data/vendor/pdoc/lib/pdoc/parser/treetop_files/section_content.treetop

@@ -0,0 +1,8 @@
+grammar SectionContent
+  include Basic
+  include Description
+  
+  rule section
+    line space* '==' space* title:[a-zA-Z0-9\s]+ space* '==' space* text <Section>
+  end
+end

data/vendor/pdoc/lib/pdoc/parser/treetop_files/tags.treetop

@@ -0,0 +1,31 @@
+grammar Tags
+  include Basic
+  
+  rule tags
+    tag more:(', ' tag)* <Tags>
+  end
+
+  rule tag
+    tag_name opt:(": " tag_value)? {
+      def name
+        tag_name.text_value
+      end
+    
+      def value
+        if opt.respond_to?("tag_value")
+          opt.tag_value.text_value
+        else
+          nil
+        end
+      end
+    }
+  end
+  
+  rule tag_value
+    (![\n:,] .)+
+  end
+  
+  rule tag_name
+    (![\n:,] .)+
+  end
+end