docjs 0.1

data/test/dom/node.rb

@@ -0,0 +1,53 @@
+# ../data.img#1772233:1
+require_relative '../../lib/dom/dom'
+require_relative '../../lib/code_object/function'
+
+describe Dom::Node, "#resolve" do
+
+  before do
+    Dom.clear
+    @o1 = CodeObject::Object.new 
+    @o2 = CodeObject::Object.new
+    @o3 = CodeObject::Object.new
+    @o4 = CodeObject::Object.new
+    
+    Dom.add_node "Foo.bar" , @o1
+    @o1.add_node ".baz"    , @o2  
+    @o1.add_node ".baz.bam", @o3
+    @o1.add_node ".baz.poo", @o4
+  end
+
+  it "should find existing node in domtree" do
+    @o4.resolve('.bar').should == @o1
+    @o4.resolve('.baz').should == @o2
+    @o4.resolve('.bam').should == @o3
+    @o4.resolve('.poo').should == @o4    
+  end
+  
+  it "should not find non existing nodes" do
+    @o1.resolve('fofofo').should == nil
+  end
+end
+
+describe Dom::Node, "#qualified_name" do
+
+  before do
+    Dom.clear
+    @o1 = CodeObject::Object.new "bar"
+    @o2 = CodeObject::Object.new "baz"
+    @o3 = CodeObject::Object.new "bam"
+    @o4 = CodeObject::Object.new "poo"
+    
+    Dom.add_node "Foo.bar" , @o1
+    @o1.add_node ".baz"    , @o2  
+    @o1.add_node ".baz.bam", @o3
+    @o1.add_node ".baz.poo", @o4
+  end
+  
+  it "should generate correct qualified name from structure" do      
+    @o1.qualified_name.should == "Foo.bar"
+    @o2.qualified_name.should == "Foo.bar.baz"
+    @o3.qualified_name.should == "Foo.bar.baz.bam"
+    @o4.qualified_name.should == "Foo.bar.baz.poo"
+  end
+end

data/test/integration/converter.rb

@@ -0,0 +1,72 @@
+require_relative '../../lib/parser/parser'
+require_relative '../../lib/dom/dom'
+
+describe CodeObject::Converter, "#to_code_object" do
+
+  context "Parsing tokens.js" do
+  
+    before do
+      Dom.clear
+          
+      stream = File.read File.expand_path('../../js-files/tokens.js', __FILE__)
+      comments = Parser::Parser.new(stream).parse      
+      @objects = comments.map {|comment| comment.to_code_object }.compact
+    end
+  
+    it "should have built three objects" do
+      @objects.length.should == 3
+    end
+  
+    describe "First CodeObject" do
+      subject { @objects[0] }
+      
+      it "should be a function named 'say_hello'" do
+        subject.class.should == CodeObject::Function
+        subject.name.should == "say_hello"
+      end
+      
+      it "should have a 'public'-token" do
+        subject.token(:public).nil?.should == false
+        subject.token(:public).length.should == 1
+      end
+      
+      it "should have one param 'foo'" do
+        subject.params.length.should == 1
+        subject.params.first.should_be_named_typed_token("foo", ["String"], "some parameter\n")
+      end
+      
+      it "should have a return value" do
+        subject.returns.length.should == 1
+        subject.returns.first.should_be_typed_token(['String', 'Integer'], "returns a string \"hello\"\n")
+      end
+    end
+    
+    describe "Second CodeObject" do
+      subject { @objects[1] }
+    
+      it "should be an Object named 'FOO'" do
+        subject.class.should == CodeObject::Object
+        subject.name.should == "FOO"
+      end    
+    end
+    
+    describe "Third CodeObject" do
+      subject { @objects[2] }
+    
+      it "should be an Function named 'some_function'" do
+        subject.class.should == CodeObject::Function
+        subject.name.should == "some_function"
+      end
+      
+      it "should be flagged as constructor" do
+        subject.constructor?.should == true
+      end
+      
+      it "should contain one param 'parameter1'" do
+        subject.params.length.should == 1
+        subject.params.first.should_be_named_typed_token("parameter1", ["String"], "The first parameter\n")        
+      end
+    end
+  
+  end 
+end

data/test/integration/parser_factory.rb

@@ -0,0 +1,28 @@
+require_relative '../../lib/parser/parser'
+require_relative '../../lib/dom/dom'
+
+describe CodeObject::Converter, ".build" do
+
+  before do
+    stream = File.read File.expand_path('../../js-files/tokens.js', __FILE__)
+    @parser = Parser::Parser.new stream
+    @comments = @parser.parse
+    
+    @objects = @comments.map {|comment| comment.to_code_object }.compact
+  end
+  
+  it "should have built three objects" do
+    @objects.length.should == 3
+  end
+  
+  it "should have built the first object as Function" do
+    @objects.first.class.should == CodeObject::Function
+    @objects.first.name.should == "say_hello"
+    @objects.first.token(:public).nil?.should == false
+  end
+
+  it "should have built the second object as Object" do
+    @objects[1].class.should == CodeObject::Object
+    @objects[1].name.should == "FOO"
+  end  
+end

data/test/interactive.rb

@@ -0,0 +1,7 @@
+require_relative '../lib/boot.rb'
+
+Logger.setup :level => :debug
+
+def load_core_doc
+  Processor.process_files_to_dom 'test/js-files/core-doc.js'  
+end

data/test/js-files/absolute.js

@@ -0,0 +1,11 @@
+/**
+ * @object Person
+ */
+var Person = {}
+
+/**
+ * Just testing if absolute nodes are added correct
+ *
+ * @object Person.config
+ */
+Person.config = {};

data/test/js-files/comments_in_strings.js

@@ -0,0 +1,31 @@
+var foo = "/** \
+ * @function Outer \
+ */"
+var Outer = function(){
+
+  var bar ="/** \
+   * This is an inner function \
+   * @function .inner\
+   */"
+   var inner = function() {
+      string = "}}"
+   }
+   
+  /* regular expression */   
+  var baz = /@function .inner_two/i
+
+  /**
+   * Hello World
+   * @object only_one
+   */
+  var innerTwo = function() {
+      
+      var another_string = "({})\n\n\n)){()[])"
+   
+      single_string = '// @object .foo'
+        var foo = {
+          bar: 4,
+          baz: function() {}          
+        };      
+   }  
+};

data/test/js-files/core-doc-relative.js

@@ -0,0 +1,77 @@
+/**
+ * 
+ * Man könnte überlegen den Extensions ein Sandbox-Element zu geben, welches diese auch erweitern
+ * können. z.B. könnte damit die Hooks-extension die Sandbox erweitern, ohne dass diese von modulen
+ * erreichbar wären.
+ *
+ * @todo Extensions als Packages: Core.extend('foo.bar') => Core.foo.bar mit foo = foo|| {}
+ * @todo Dependency Check der Extensions
+ * @todo Extensionloader
+ *
+ * @object Core
+ */
+var Core = Core || (function(){
+ 
+  var _extensions = {};
+
+  var core = {
+
+    /**
+     * register new {Core}-extension
+     *
+     * @function .extend
+     *
+     * @param [String] id the id to register the new extension under
+     * @param [Function] constructor a callback function, which acts as
+     *   constructor
+     */
+    extend: function(id, constructor) {
+      
+      // Already defined
+      if(!!core[id]) {
+        core.logger.log("Info: Overwriting '"+id+"'. It is already defined.");
+      }
+      
+      var ext = constructor();
+      if(!!ext) {
+        core[id] = ext;
+        _extensions[id] = ext;
+      } else {
+        core.logger.log("Info: Constructor of '"+id+"' did not return a valid value.");
+      }
+    }, 
+    
+    /**
+     * List all registered {Core.extension extensions}
+     *
+     * @function .extensions
+     *
+     * @return [Array] all registered extensions
+     */
+    extensions: function() {
+      return _extensions;
+    },    
+    
+    /**
+     * Adds minimal logging functionality to {Core}
+     *
+     * @object .logger
+     */
+    logger: {
+    
+      /**
+       * Logs a message if the console is present. Can be extended with a custom {Core.extension}.
+       *
+       * @function .log
+       * @param [String] msg The message to log
+       */
+      log: function(msg) {
+        if(!!window.console) {
+          window.console.log(msg);
+        }
+      }
+    }
+  };
+  
+  return core;      
+})();

data/test/js-files/core-doc.js

@@ -0,0 +1,145 @@
+/**
+ * 
+ * Man könnte überlegen den Extensions ein Sandbox-Element zu geben, welches diese auch erweitern
+ * können. z.B. könnte damit die Hooks-extension die Sandbox erweitern, ohne dass diese von modulen
+ * erreichbar wären.
+ *
+ * Noch eine Überschrift
+ * =====================
+ * Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt 
+ * ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo 
+ * dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor 
+ * sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor
+ * invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et 
+ * 
+ *     if(!!core[id]) {
+ *       core.logger.log("Info: Overwriting '"+id+"'. It is already defined.");
+ *     }
+ *
+ *
+ * Justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum 
+ * dolor sit amet.
+ * 
+ * Testüberschrift
+ * ---------------
+ * Dies ist nur ein Absatz in **Markdown**, um zu testen, ob dies funnktioniert.
+ *
+ * Core contains a simple {Core.logger logger} which only supports one functionality {.log}.
+ *
+ * @todo Extensions als Packages: Core.extend('foo.bar') => Core.foo.bar mit foo = foo|| {}
+ * @todo Dependency Check der Extensions
+ * @todo Extensionloader
+ *
+ * @note something to note, which is really important, because im testing the style of `@note-tokens`
+ *       var foo = {
+ *         bar: 4
+ *       }
+ *
+ * @deprecated since 1.0 - because this is not as cool, as i suspected first.
+ *
+ * @warn don't use without parental advise
+ *
+ * @author Jonathan Brachthäuser
+ * @version 1.2.245
+ *
+ * @example foobar
+ *   This is just a stupid test
+ *
+ * @object Core
+ */
+var Core = Core || (function(){
+ 
+  var _extensions = {};
+  
+  var core = {
+
+    /**
+     * register new {Core.extensions}
+     * 
+     * @function Core.extend
+     *
+     * @param [String] id the id to register the new {Core.extensionss extension} under
+     * @param [Function] constructor a callback function, which acts as
+     *   constructor for {Core.extensions}
+     * @param settings
+     *   [String] name the name of the extension
+     *   [Number] pos the position to put the extension to (Defaults to 0)
+     *   [String] color the background-color of the extension
+     *
+     * @return [Core.logger] the constructed extension
+     *
+     *
+     * @example Testextension
+     *   Core.extend('testextension', function() {
+     *     return {};
+     *   });
+     */
+    extend: function(id, constructor) {
+      
+      // Already defined
+      if(!!core[id]) {
+        core.logger.log("Info: Overwriting '"+id+"'. It is already defined.");
+      }
+      
+      var ext = constructor();
+      if(!!ext) {
+        core[id] = ext;
+        _extensions[id] = ext;
+      } else {
+        core.logger.log("Info: Constructor of '"+id+"' did not return a valid value.");
+      }
+    }, 
+    
+    /**
+     * List all registered {Core.extensions extensions}
+     *
+     * @function Core.extensions
+     *
+     * @return [Array] all registered extensions
+     */
+    extensions: function() {
+      return _extensions;
+    },    
+    
+    /**
+     * Adds minimal logging functionality to {Core}
+     *
+     * @object Core.logger
+     */
+    logger: {
+    
+      /**
+       * Logs a message if the console is present
+       *
+       * @function Core.logger.log
+       *
+       * @overload log(msg)
+       *   @param [String] msg The message to log
+       *
+       * @overload log(level, msg)
+       *
+       */
+      log: function(msg) {
+        if(!!window.console) {
+          window.console.log(msg);
+        }
+      }
+    },
+    
+    /**
+     * Config Object for Core
+     * @object Core.properties
+     *
+     * @prop [Boolean] logging turns internal logging on and off
+     * @prop [Numeric] maximalExtensions limits the maximum extensions count
+     * @prop [Boolean] autostart should Core start on Application-start?
+     */
+    properties: {
+      logging: true,
+      maximalExtensions: 4,
+      autostart: true
+    }
+  };
+
+  return core;      
+})();

data/test/js-files/nested.js

@@ -0,0 +1,34 @@
+/**
+ * @function Outer
+ */
+var Outer = function(){
+  
+  /**
+   * This is an inner function
+   * @function .inner
+   */
+   var inner = function() {
+   
+   }
+   
+   
+  /**
+   * This is a second inner function
+   * @function .inner_two
+   */
+   var innerTwo = function() {
+   
+   
+      /**
+       * And again, here is a inner function
+       * @object .foo
+       */
+        var foo = {
+          bar: 4,
+          baz: function() {}          
+        };   
+   
+   
+   }
+  
+};