distil 0.11.6 → 0.11.8

data/vendor/pdoc/PDoc.tmbundle/Preferences/PDoc.tmPreferences

@@ -0,0 +1,50 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>name</key>
+	<string>PDoc</string>
+	<key>scope</key>
+	<string>comment.block</string>
+	<key>settings</key>
+	<dict>
+		<key>smartTypingPairs</key>
+		<array>
+			<array>
+				<string>"</string>
+				<string>"</string>
+			</array>
+			<array>
+				<string>(</string>
+				<string>)</string>
+			</array>
+			<array>
+				<string>{</string>
+				<string>}</string>
+			</array>
+			<array>
+				<string>[</string>
+				<string>]</string>
+			</array>
+			<array>
+				<string>“</string>
+				<string>”</string>
+			</array>
+			<array>
+				<string>‘</string>
+				<string>’</string>
+			</array>
+			<array>
+				<string>`</string>
+				<string>`</string>
+			</array>
+			<array>
+				<string>_</string>
+				<string>_</string>
+			</array>
+		</array>
+	</dict>
+	<key>uuid</key>
+	<string>1711013A-1566-488B-816B-AB5614C47B7D</string>
+</dict>
+</plist>

data/vendor/pdoc/PDoc.tmbundle/Snippets/class.tmSnippet

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>content</key>
+	<string>/**
+ * class ${1:class name}${2: &lt; ${3:super class}}
+ * ${4: includes ${5:mixin}}
+ * $0
+ * 
+ * 
+ * 
+ * 
+ **/</string>
+	<key>name</key>
+	<string>class</string>
+	<key>scope</key>
+	<string>source.js</string>
+	<key>tabTrigger</key>
+	<string>doc class</string>
+	<key>uuid</key>
+	<string>9805E27A-D127-4A3E-A51E-39B844228FD8</string>
+</dict>
+</plist>

data/vendor/pdoc/PDoc.tmbundle/Snippets/constant.tmSnippet

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>content</key>
+	<string>/**
+ * ${1:Class}.${2:ConstantName}
+ * $0
+ * 
+ * 
+ * 
+ **/</string>
+	<key>name</key>
+	<string>constant</string>
+	<key>scope</key>
+	<string>source.js</string>
+	<key>tabTrigger</key>
+	<string>doc constant</string>
+	<key>uuid</key>
+	<string>EFF335C1-ACCE-4684-8C61-94AF724227DB</string>
+</dict>
+</plist>

data/vendor/pdoc/PDoc.tmbundle/Snippets/event.tmSnippet

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>content</key>
+	<string>fires ${2:namespace}:${4:eventName}$0</string>
+	<key>name</key>
+	<string>event</string>
+	<key>scope</key>
+	<string>source.js</string>
+	<key>tabTrigger</key>
+	<string>doc event</string>
+	<key>uuid</key>
+	<string>460ABE5C-0250-474D-9401-C01F8743C5A4</string>
+</dict>
+</plist>

data/vendor/pdoc/PDoc.tmbundle/Snippets/method.tmSnippet

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>content</key>
+	<string>/**
+ * ${1:Class}${2:#}${3:methodName}(${4:parameters})
+ * $0
+ * 
+ * 
+ * 
+ **/</string>
+	<key>name</key>
+	<string>method</string>
+	<key>scope</key>
+	<string>source.js</string>
+	<key>tabTrigger</key>
+	<string>doc method</string>
+	<key>uuid</key>
+	<string>15D39C72-C707-4C30-9DCA-BEB3073FE3D2</string>
+</dict>
+</plist>

data/vendor/pdoc/PDoc.tmbundle/Snippets/mixin.tmSnippet

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>content</key>
+	<string>/**
+ * mixin ${1:mixin name}
+ * $0
+ * 
+ * 
+ * 
+ * 
+ **/</string>
+	<key>name</key>
+	<string>mixin</string>
+	<key>scope</key>
+	<string>source.js</string>
+	<key>tabTrigger</key>
+	<string>doc mixin</string>
+	<key>uuid</key>
+	<string>82FA7BB9-A47F-419E-8AB2-8E78235E280E</string>
+</dict>
+</plist>

data/vendor/pdoc/PDoc.tmbundle/Snippets/namespace.tmSnippet

@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>content</key>
+	<string>/**
+ * ${1:namespace name}
+ * ${2: includes ${3:mixin}}
+ * $0
+ * 
+ * 
+ * 
+ * 
+ **/</string>
+	<key>name</key>
+	<string>namespace</string>
+	<key>scope</key>
+	<string>source.js</string>
+	<key>tabTrigger</key>
+	<string>doc ns</string>
+	<key>uuid</key>
+	<string>2B83660B-5296-4C53-953C-5088AEEAA47A</string>
+</dict>
+</plist>

data/vendor/pdoc/PDoc.tmbundle/Snippets/param.tmSnippet

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>content</key>
+	<string>- ${1:param name}${2: (${3:allowed types})}: ${4:description}</string>
+	<key>name</key>
+	<string>param</string>
+	<key>scope</key>
+	<string>source.js</string>
+	<key>tabTrigger</key>
+	<string>doc param</string>
+	<key>uuid</key>
+	<string>31545749-99C9-43D7-8397-F895E42058C4</string>
+</dict>
+</plist>

data/vendor/pdoc/PDoc.tmbundle/Snippets/property.tmSnippet

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>content</key>
+	<string>/**
+ * ${1:Class}${2:#}${3:propName}
+ * $0
+ * 
+ * 
+ * 
+ **/</string>
+	<key>name</key>
+	<string>property</string>
+	<key>scope</key>
+	<string>source.js</string>
+	<key>tabTrigger</key>
+	<string>doc prop</string>
+	<key>uuid</key>
+	<string>39699591-AFD0-4B2C-BA41-29B55445F472</string>
+</dict>
+</plist>

data/vendor/pdoc/PDoc.tmbundle/Snippets/section.tmSnippet

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>content</key>
+	<string>/**
+ * == ${1:section name} ==
+ * $0
+ * 
+ * 
+ * 
+ * 
+ **/</string>
+	<key>name</key>
+	<string>section</string>
+	<key>scope</key>
+	<string>source.js</string>
+	<key>tabTrigger</key>
+	<string>doc section</string>
+	<key>uuid</key>
+	<string>8C7DCFEE-3EB2-4DB9-AF0C-2F35534F2A45</string>
+</dict>
+</plist>

data/vendor/pdoc/PDoc.tmbundle/Syntaxes/PDoc.tmLanguage

@@ -0,0 +1,33 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>fileTypes</key>
+	<array>
+		<string>js</string>
+	</array>
+	<key>foldingStartMarker</key>
+	<string>/\*\*|\{\s*$</string>
+	<key>foldingStopMarker</key>
+	<string>\*\*/|^\s*\}</string>
+	<key>keyEquivalent</key>
+	<string>^~J</string>
+	<key>name</key>
+	<string>PDoc</string>
+	<key>patterns</key>
+	<array>
+		<dict>
+			<key>include</key>
+			<string>source.prototype.js</string>
+		</dict>
+		<dict>
+			<key>include</key>
+			<string>source.js</string>
+		</dict>
+	</array>
+	<key>scopeName</key>
+	<string>source.js.pdoc</string>
+	<key>uuid</key>
+	<string>E8B01951-A6A4-4B14-A314-31903479BF59</string>
+</dict>
+</plist>

data/vendor/pdoc/PDoc.tmbundle/info.plist

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>name</key>
+	<string>PDoc</string>
+	<key>ordering</key>
+	<array>
+		<string>8C7DCFEE-3EB2-4DB9-AF0C-2F35534F2A45</string>
+		<string>9805E27A-D127-4A3E-A51E-39B844228FD8</string>
+		<string>2B83660B-5296-4C53-953C-5088AEEAA47A</string>
+		<string>82FA7BB9-A47F-419E-8AB2-8E78235E280E</string>
+		<string>15D39C72-C707-4C30-9DCA-BEB3073FE3D2</string>
+		<string>39699591-AFD0-4B2C-BA41-29B55445F472</string>
+		<string>EFF335C1-ACCE-4684-8C61-94AF724227DB</string>
+		<string>31545749-99C9-43D7-8397-F895E42058C4</string>
+		<string>460ABE5C-0250-474D-9401-C01F8743C5A4</string>
+	</array>
+	<key>uuid</key>
+	<string>31DB3560-8F7C-40A8-B82D-BC7E020FFCF1</string>
+</dict>
+</plist>

data/vendor/pdoc/README.markdown

@@ -0,0 +1,34 @@
+PDoc
+====
+
+PDoc is an inline comment parser and JavaScript documentation generator written in Ruby. It is designed for documenting [Prototype](http://prototypejs.org) and Prototype-based libraries.
+
+PDoc uses [Treetop](http://treetop.rubyforge.org/), a Ruby-based DSL for text parsing and interpretation, and its own ActionView-inspired, ERB-based templating system for HTML generation. Other documentation generators (e.g., DocBook XML) are planned.
+
+Unlike other inline-doc parsers, PDoc does not rely on the JavaScript source code at all; it only parses the comments. This approach, though slightly more verbose, is much better at generating consistent, reliable documentation, and avoids the headaches encountered when documenting highly dynamic languages.
+
+## Installation
+
+PDoc depends on Rake, your choice of markdown parser, and treetop, all of which can be obtained through RubyGems:
+
+    gem install rake bluecloth treetop
+    
+## Usage
+
+For hints on how to run PDoc on the command line, consult the built-in Rake tasks (in `Rakefile`) and the `PDoc::Runner` class (in `lib/pdoc/runner.rb`).
+
+## How it works
+
+The process of turning inline PDoc comments into a human-friendly document has two phases.
+
+### Parsing phase
+In this phase, the source files are scanned for PDoc comments, then parsed with the Ruby files generated from the Treetop language grammar. The product of this phase is a tree full of specialized classes, all of which inherit from `Treetop::Runtime::SyntaxNode`.
+
+The root of the tree is an instance of `Documentation::Doc`. It comprises one or more instances of `Documentation::Section`; which in turn comprise language elements like namespaces, classes, constants, etc., all of which have class representations.
+
+### Rendering phase
+Next, PDoc asks a _generator_ how to translate this abstract tree into a hierarchical document. The default generator outputs organized HTML in a manner similar to [RDoc](http://rdoc.sourceforge.net/ "RDoc - Document Generator for Ruby Source")'s.
+
+The HTML generator (`PDoc::Generators::Html`) has associated _templates_ (in the `templates` directory) that accept syntax nodes and echo their metadata onto the page using [ERB](http://www.ruby-doc.org/stdlib/libdoc/erb/rdoc/index.html "erb: Ruby Standard Library Documentation"). Templates are modular, so it's quite easy to apply a custom "skin" to one's documentation pages.
+
+Furthermore, generators themselves are modular; PDoc can, theoretically, parse once and render to several different targets (HTML, [DocBook XML](http://www.docbook.org/ "DocBook.org"), CHM, PDF, even [ScriptDoc](http://www.scriptdoc.org/ "ScriptDoc.org: Dynamic Language Documentation").) We hope many such generators will exist in the future.

data/vendor/pdoc/Rakefile

@@ -0,0 +1,46 @@
+require 'rake'
+require 'lib/pdoc'
+
+desc "Builds the documentation"
+task :build_doc do
+  PDoc.run({
+    :source_files => [File.join(File.dirname(__FILE__), "test", "fixtures", "ajax.js")],
+    :destination => OUTPUT_DIR,
+    :syntax_highlighter => :pygments,
+    :markdown_parser => :bluecloth,
+    :src_code_href => proc { |file, line|
+      "http://github.com/example/ex/#{file}##{line}"
+    },
+    :pretty_urls => false,
+    :bust_cache => true,
+    :name => 'Example JavaScript Framework',
+    :short_name => 'Ex',
+    :home_url => 'http://example.com',
+    :doc_url => 'http://example.com/api',
+    :version => "1.2.0",
+    :copyright_notice => 'This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-Share Alike 3.0 Unported License</a>.' 
+  })
+end
+
+desc "Empties output directory"
+task :remove_doc do
+  rm_rf Dir.glob(File.join(OUTPUT_DIR, "*"))
+end
+
+desc "Empties the output directory and builds the documentation."
+task :doc => [:remove_doc, :build_doc]
+
+desc "Runs all the unit tests."
+task :test do 
+  require 'rake/runtest'
+  Rake.run_tests '**/*_test.rb'
+end
+
+task :compile_parser do
+  require 'treetop'
+  compiler = Treetop::Compiler::GrammarCompiler.new
+  treetop_dir = File.expand_path(File.join(File.dirname(__FILE__), "lib", "pdoc", "parser", "treetop_files"))
+  Dir.glob(File.join(treetop_dir, "*.treetop")).each do |treetop_file_path|
+    compiler.compile(treetop_file_path)
+  end
+end

data/vendor/pdoc/bin/pdoc

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'oyster'
+require File.dirname(__FILE__) + '/../lib/pdoc'
+
+spec = Oyster.spec do
+  name "pdoc -- Inline comment parser and JavaScript documentation generator"
+  author "Tobie Langel <tobie.langel@gmail.com>"
+  
+  synopsis <<-EOS
+    pdoc [-o OUTPUT_DIR] [-t TEMPLATE_DIR] SOURCE_FILES
+    pdoc [OPTIONS] -d SOURCE_DIRECTORY
+  EOS
+  
+  string :directory,
+         :desc => "Directory to search for JavaScript files. Will take all *.js " +
+                  "files from the given directory (including subdirectories) and use " +
+                  "them to generate documentation. This option takes precedence over " +
+                  "SOURCE_FILES."
+  
+  string :output,
+         :desc => "Directory in which to dump output files",
+         :default => "pdoc"
+  
+  string :templates,
+         :desc => "Directory containing template files"
+  
+  subcommand :'copy-templates' do
+    synopsis <<-EOS
+      pdoc copy-templates TYPE DESTINATION
+    EOS
+    
+    description <<-EOS
+      PDoc includes a set of default templates for each type of output generator.
+      This command lets you extract a set of these templates into a local directory
+      so you can tweak it to suit your needs. Be sure to specify your set of
+      templates next time you run pdoc.
+    EOS
+  end
+end
+
+begin; options = spec.parse
+rescue Oyster::HelpRendered; exit
+end
+
+if command = options[:'copy-templates']
+  args = command[:unclaimed]
+  PDoc.copy_templates(args[0], File.expand_path(args[1]))
+  exit
+end
+
+files = (d = options[:directory]) ?
+        Dir["#{d}/**/*.js"].map(&File.method(:expand_path)) :
+        options[:unclaimed].dup
+
+files << {:destination => options[:output], :templates => options[:templates]}
+PDoc::Runner.new(*files).run
+

data/vendor/pdoc/lib/pdoc/error.rb

@@ -0,0 +1,4 @@
+module PDoc
+  class PDocError < StandardError
+  end
+end

data/vendor/pdoc/lib/pdoc/generators/abstract_generator.rb

@@ -0,0 +1,16 @@
+module PDoc
+  module Generators
+    class AbstractGenerator
+      attr_reader :options, :root
+      def initialize(root, options = {})
+        @root = root
+        @options = options
+      end
+      
+      # Creates a new directory with read, write and execute permission.
+      def mkdir(name)
+        Dir.mkdir(name, 0755)
+      end
+    end
+  end
+end