docjs 0.2 → 0.2.1

data/templates/generators/api_index_generator.rb

@@ -1,5 +1,6 @@
 module Generator
 
+  # renders the api_index.html file containing all documented elements as alphabetic listing
   class ApiIndexGenerator < Generator
 
     describe     'renders the api_index.html file containing all documented elements as alphabetic listing'

data/templates/generators/api_pages_generator.rb

@@ -1,5 +1,7 @@
 module Generator
 
+  # renders documented objects type-dependant (Functions and Objects). Each CodeObject is rendered to
+  # it's own page. The path is calculated using {Helper::Linker#path_to}
   class ApiPagesGenerator < Generator
 
     describe     'renders documented objects type-dependant (Functions and Objects)'

data/templates/generators/docs_generator.rb

@@ -1,5 +1,7 @@
 module Generator
 
+  # renders all specified Markdown files to static documentation. The path to each documentation-page
+  # is derived from it's position in the Dom, using {Helper::Linker#path_to}.
   class DocsGenerator < Generator
   
     describe     'renders all specified Markdown files to static documentation'

data/templates/generators/json_generator.rb

@@ -1,5 +1,21 @@
 module Generator
 
+  # renders all documented objects to a json file. Objects and Functions are handled seperatly.
+  # Needed for the JavaScript-search / filter. Renders the file `js/apisearch-data.js` which looks
+  # like:
+  #     
+  #     J.data.apisearch = { 
+  #     
+  #       "functions":[
+  #         { "namespace":"Core",
+  #           "fullname":"Core.extend",
+  #           "path":"api/Core/extend.html",
+  #           "name":".extend",
+  #           "constructor":false
+  #         },...],
+  #        
+  #       "objects": [...]
+  #     }
   class JsonGenerator < Generator
 
     describe     'renders all documented objects to a json file. Objects and Functions are handled seperatly'

data/templates/helpers/template.rb

@@ -3,6 +3,7 @@
 # They are included in the Typed-RenderTask 
 module Helper::Template
 
+  # Creates the html-signature of a function, including the markup for a tooltip
   def signature(method_or_token)
   
     if method_or_token.is_a? Token::Token
@@ -24,14 +25,16 @@ module Helper::Template
     "(#{return_types || 'Void'}) <span class='name'>#{method_or_token.name}</span>(<span class='params'>#{params}</span>)"
   end
   
-  def subsection(id, opts = {})
-    unless opts[:collection].nil? or opts[:collection].size == 0
-      "<h3>#{opts[:title]}</h3><ul class=\"#{id} subsection\">" +       
-      render(:partial => opts[:partial], :collection => opts[:collection]) +
-      "</ul>"
-    end
-  end
   
+  # Creates an hierarchy-overview, which can be seen in the sidebar. The direct parent and
+  # all children are listed in the overview:
+  # 
+  #     DocJs
+  #       > CurrentNode
+  #           ChildNode1
+  #           ChildNode2
+  #           ...
+  #
   def hierarchy(object) 
     
     children = object.children.values.reject {|c| c.is_a? CodeObject::Function }
@@ -43,6 +46,20 @@ module Helper::Template
     "</ul>" * (parents.size + 2)
   end
   
+  # Creates the markup for the Api-Tree Browser in the heading-section. The JavaScript tree is 
+  # powered by jquery-treeview by Jörn Zaefferer
+  #
+  # @example output
+  #  <ul>
+  #   <li class="object"><a href="api/Core.html"><span>Core</span></a>
+  #     <ul>
+  #       <li class="function"><a href="api/Core/extend.html"><span>extend</span></a>
+  #       <li class="function"><a href="api/Core/extensions.html"><span>extensions</span></a>
+  #     </ul>
+  #  </ul>
+  #
+  # @see http://bassistance.de/jquery-plugins/jquery-plugin-treeview/
+  # @see http://docs.jquery.com/Plugins/Treeview
   def api_browser(root = Dom.root)
     if root == Dom.root
       output = ""

data/templates/resources/css/application.css

@@ -1,4 +1,19 @@
 @charset "UTF-8";
+/*
+ * README
+ * ======
+ *
+ * The application.css is generated using SCSS (see http://sass-lang.com/). You can manipulate it
+ * yourself or edit the *.scss template files and afterwards run 
+ *
+ *     sass templates/resources/scss/application.scss:templates/resources/css/application.css`
+ *
+ * All needed partials (like `_print.scss`) will be required automatically through the use of `@import`.
+ *
+ * Please note, that all manual changes to application.css will be lost, by running the command
+ * above.
+ *
+ */
 /* Global Colors */
 /* Header-colors */
 /*#4096ee;*/
@@ -384,12 +399,12 @@ input:invalid, textarea:invalid {
       border: 1px solid #eee;
       padding: 0;
       margin: 0;
-      overflow: hidden;
-      /*overflow-y: scroll;*/ }
+      overflow: auto;
+      max-height: 450px; }
       #header .col50 section > ul::-webkit-scrollbar {
         width: 7px;
         height: 9px; }
-      #header .col50 section > ul::-webkit-scrollbar-button:start:decrement, #header .col50 section > ul .iScroll ::-webkit-scrollbar-button:end:increment {
+      #header .col50 section > ul::-webkit-scrollbar-button:start:decrement, #header .col50 section > ul::-webkit-scrollbar-button:end:increment {
         display: block;
         height: 0;
         background-color: transparent; }

data/templates/resources/scss/_header.scss

@@ -91,8 +91,8 @@
         border: 1px solid #eee;
         padding: 0; margin: 0;
         
-        overflow: hidden; 
-        /*overflow-y: scroll;*/
+        overflow: auto;
+        max-height: 450px;
       }    
     }
     

data/templates/resources/scss/_helpers.scss

@@ -32,7 +32,8 @@ $golden_ratio: 1.618;
 /* inspired by http://docs.sencha.com/ext-js/4-0/ */
 @mixin scrollbars() {
   &::-webkit-scrollbar { width: 7px; height: 9px; }
-  &::-webkit-scrollbar-button:start:decrement, .iScroll ::-webkit-scrollbar-button:end:increment { display: block; height: 0; background-color: transparent; }
+  &::-webkit-scrollbar-button:start:decrement, 
+  &::-webkit-scrollbar-button:end:increment { display: block; height: 0; background-color: transparent; }
   &::-webkit-scrollbar-track-piece { -webkit-border-radius: 0; -webkit-border-bottom-right-radius: 4px; -webkit-border-bottom-left-radius: 4px; }
   &::-webkit-scrollbar-thumb:vertical { height: 50px; background-color: rgba(0, 0, 0, 0.15); -webkit-border-radius: 4px; }
   &::-webkit-scrollbar-thumb:horizontal { width: 50px; background-color: rgba(0, 0, 0, 0.15); -webkit-border-radius: 4px; }
@@ -94,4 +95,4 @@ $golden_ratio: 1.618;
 @mixin float($direction) {
   display: block;
   float: $direction;
-}
+}

data/templates/resources/scss/application.scss

@@ -1,3 +1,18 @@
+/*!
+ * README
+ * ======
+ *
+ * The application.css is generated using SCSS (see http://sass-lang.com/). You can manipulate it
+ * yourself or edit the *.scss template files and afterwards run 
+ *
+ *     sass templates/resources/scss/application.scss:templates/resources/css/application.css`
+ *
+ * All needed partials (like `_print.scss`) will be required automatically through the use of `@import`.
+ *
+ * Please note, that all manual changes to application.css will be lost, by running the command
+ * above.
+ *
+ */
 $default-fonts: Arial, sans-serif;
 $font-size: 10pt;
 

data/test/parser/intelligent_skip_until.rb

@@ -40,6 +40,16 @@ describe StringScanner, "#intelligent_skip_until" do
     end  
   end
   
+  context "strings as code context (pattern from scope search)" do
+    before do
+      @scanner = StringScanner.new "var string = \"1234567\;\"\nsome more"
+      @scanner.intelligent_skip_until /\{|\(|\}|\)|$/
+    end
+    
+    it "should find linebreak at pos 23" do
+      @scanner.pos.should == 23
+    end  
+  end  
   
   context "regular expressions" do  
     before do

data/test/parser/parser.rb

@@ -244,6 +244,50 @@ describe Parser::Parser, ".parse" do
   end
   
   
+  context "parsing regular expressions" do
+  
+    before do
+      
+      @comments = Parser::Parser.new("/**
+ * @function _dispatchResponse    
+ */       
+function _dispatchResponse(response) {
+  var code = response.statusCode;
+  var data = response.data || response.rawData;
+
+  _respond(code.toString().replace(/\d{2}$/, 'XX'), data, response);
+}").parse
+    end
+    
+    subject { @comments.first }
+  
+    it "should find the correct source" do
+      subject.source.should == "function _dispatchResponse(response) {
+  var code = response.statusCode;
+  var data = response.data || response.rawData;
+
+  _respond(code.toString().replace(/\d{2}$/, 'XX'), data, response);
+}"
+    end
+  end
+  
+  context "parsing strings and lineends correctly for scope" do
+    before do
+      @comments = Parser::Parser.new("/**
+ * @object someString
+ */
+var string =  \"1234567\";
+").parse
+    end
+    
+    subject { @comments.first }
+    
+    it "should parse the string correctly" do
+      subject.source.should == "var string =  \"1234567\";\n"
+    end
+  end
+  
+  
   context "parsing multibyte character" do
 
     before do  

metadata

@@ -1,49 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: docjs
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.2.1
   prerelease: 
-  version: "0.2"
 platform: ruby
-authors: 
-- "Jonathan Brachth\xC3\xA4user"
+authors:
+- Jonathan Brachthäuser
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-28 00:00:00 +02:00
-default_executable: bin/docjs
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-10-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rdiscount
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: thor
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-description: Create beautiful Javascript documentations with this ruby-gem. It's pretty easy to customize and add your own tokens/DSL.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Create beautiful Javascript documentations with this ruby-gem. It's pretty
+  easy to customize and add your own tokens/DSL.
 email: jonathan@b-studios.de
-executables: 
+executables:
 - docjs
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - LICENSE.md
 - README.md
 - bin/docjs
@@ -157,33 +164,29 @@ files:
 - test/rspec_helper.rb
 - test/token/handler.rb
 - test/token/tokens.rb
-has_rdoc: true
 homepage: https://github.com/b-studios/doc.js
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "1.9"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "1.5"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.5'
 requirements: []
-
 rubyforge_project: docjs
-rubygems_version: 1.5.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Javascript Documentation Generator
 test_files: []
-
+has_rdoc: