jsduck 3.6.1 → 3.7.0

data/Rakefile

@@ -127,14 +127,10 @@ def compress
   system "rm -rf #{dir}/resources/codemirror"
   system "rm -rf #{dir}/resources/.sass-cache"
 
-  # Empty the extjs dir, leave only the main JS files, CSS and images
+  # Empty the extjs dir, leave only the main JS file and images
   system "rm -rf #{dir}/extjs"
   system "mkdir #{dir}/extjs"
-  system "cp #{EXT_DIR}/ext-all.js #{dir}/extjs"
-  system "cp #{EXT_DIR}/ext-all-debug.js #{dir}/extjs"
-  system "cp #{EXT_DIR}/bootstrap.js #{dir}/extjs"
-  system "mkdir -p #{dir}/extjs/resources/css"
-  system "cp #{EXT_DIR}/resources/css/ext-all.css #{dir}/extjs/resources/css"
+  system "cp template/extjs/ext-all.js #{dir}/extjs"
   system "mkdir -p #{dir}/extjs/resources/themes/images"
   system "cp -r #{EXT_DIR}/resources/themes/images/default #{dir}/extjs/resources/themes/images"
 end
@@ -158,27 +154,28 @@ class JsDuckRunner
   # This excludes Opera and IE < 8.
   # We check explicitly for IE version to make sure the code works the
   # same way in both real IE7 and IE7-mode of IE8/9.
-  def add_comments(db_name)
+  def add_comments(db_name, version)
     comments_base_url = "http://projects.sencha.com/auth"
     @options += ["--head-html", <<-EOHTML]
       <script type="text/javascript">
         Docs.enableComments = ("withCredentials" in new XMLHttpRequest()) || (Ext.ieVersion >= 8);
         Docs.baseUrl = "#{comments_base_url}";
         Docs.commentsDb = "#{db_name}";
+        Docs.commentsVersion = "#{version}";
       </script>
     EOHTML
   end
 
   # For export of ExtJS, reference extjs from the parent dir
-  def make_paths_relative
-    relative_sdk_path = "../"
-    ["#{@out_dir}/eg-iframe.html", "#{@out_dir}/index.html"].each do |file|
+  def make_extjs_path_relative
+    ["#{@out_dir}/index.html"].each do |file|
       out = []
       IO.read(file).each_line do |line|
-        out << line.sub(/((src|href)="extjs\/)/, '\2="' + relative_sdk_path)
+        out << line.sub(/(src|href)="extjs\//, '\1="../')
       end
       File.open(file, 'w') {|f| f.write(out) }
     end
+    system "rm -rf #{@out_dir}/extjs"
   end
 
   def add_ext4
@@ -194,54 +191,12 @@ class JsDuckRunner
     ]
   end
 
-  def add_touch_export
-    @options += [
-      "--json",
-      "--output", "#{@out_dir}/../export/touch1",
-      "--external=google.maps.Map,google.maps.LatLng",
-      "#{@sdk_dir}/touch/sencha-touch.jsb3",
-    ]
-  end
-
-  def add_touch2_export
-    @options += [
-      "--export", "full",
-      "--output", "#{@out_dir}/../export/touch2",
-      "--external=google.maps.Map,google.maps.LatLng",
-      "#{@sdk_dir}/touch/touch.jsb3",
-    ]
-  end
-
-  def set_touch2_src
-    relative_touch_path = "../"
-    system("cp", "-r", "#{@sdk_dir}/touch/docs/build-welcome.html", "template-min/welcome.html")
-    system("cp", "-r", "#{@sdk_dir}/touch/docs/eg-iframe.html", "template-min/eg-iframe.html")
-
-    ["template-min/eg-iframe.html", "template-min/welcome.html"].each do |file|
-      html = IO.read(file);
-
-      touch_src_re = /((src|href)="touch)/m
-      out = []
-
-      html.each_line do |line|
-        out << line.sub(/((src|href)="touch\/)/, '\2="' + relative_touch_path)
-      end
-
-      File.open(file, 'w') {|f| f.write(out) }
-    end
-
-    head_html = <<-EOHTML
+  def add_phone_redirect
+    @options += ["--body-html", <<-EOHTML]
       <script type="text/javascript">
-        if (Ext.is.Phone) { window.location = "#{relative_touch_path}examples/"; }
+        if (Ext.is.Phone) { window.location = "../examples/"; }
       </script>
     EOHTML
-
-    @options += [
-      "--body-html", head_html,
-      "--welcome", "template-min/welcome.html",
-      "--eg-iframe", "template-min/eg-iframe.html",
-      "--examples-base-url", "#{relative_touch_path}examples/",
-    ]
   end
 
   def add_debug
@@ -346,13 +301,8 @@ class JsDuckRunner
 
   end
 
-  # Copy over SDK examples
-  def copy_sdk_examples
-    system "mkdir #{@out_dir}/extjs/builds"
-    system "cp #{@ext_dir}/builds/ext-core.js #{@out_dir}/extjs/builds/ext-core.js"
-    system "cp #{@ext_dir}/release-notes.html #{@out_dir}/extjs"
-    system "cp -r #{@ext_dir}/examples #{@out_dir}/extjs"
-    system "cp -r #{@ext_dir}/welcome #{@out_dir}/extjs"
+  def copy_extjs_build
+    system "cp -r #{@ext_dir} #{@out_dir}/extjs-build"
   end
 
   # Copy over Sencha Touch
@@ -386,11 +336,20 @@ task :sdk, [:mode] => :sass do |t, args|
   runner.add_seo if mode == "debug" || mode == "live"
   runner.add_export_notice("ext-js/4-0") if mode == "export"
   runner.add_google_analytics if mode == "live"
-  runner.add_comments('comments-ext-js-4') if mode == "debug" || mode == "live"
+  runner.add_comments('ext-js', '4') if mode == "debug" || mode == "live"
+  if mode == "export"
+    runner.add_options ["--eg-iframe", "#{SDK_DIR}/extjs/docs/eg-iframe-build.html"]
+    runner.add_options ["--examples-base-url", "../examples/"]
+  else
+    runner.add_options ["--examples-base-url", "extjs-build/examples/"]
+  end
   runner.run
 
-  runner.copy_sdk_examples if mode == "export" || mode == "live"
-  runner.make_paths_relative if mode == "export"
+  if mode == "export"
+    runner.make_extjs_path_relative
+  else
+    runner.copy_extjs_build
+  end
 end
 
 desc "Run JSDuck on Docs app itself"
@@ -464,17 +423,26 @@ task :touch2, [:mode] => :sass do |t, args|
   compress if mode == "live" || mode == "export"
 
   runner = JsDuckRunner.new
-  runner.add_options ["--output", OUT_DIR, "--config", "#{SDK_DIR}/touch/docs/config.json"]
-  runner.add_debug if mode == "debug"
-  runner.add_export_notice("touch/2-0") if mode == "export"
+  runner.add_options [
+    "--output", OUT_DIR,
+    "--config", "#{SDK_DIR}/touch/docs/config.json"
+  ]
+
   if mode == "export"
-    runner.set_touch2_src
-  else
-    runner.add_options ["--examples-base-url", "touch/examples/"]
+    runner.add_export_notice("touch/2-0")
+    runner.add_phone_redirect
+    # override settings in config.json
+    runner.add_options [
+      "--welcome", "#{SDK_DIR}/touch/docs/build-welcome.html",
+      "--eg-iframe", "#{SDK_DIR}/touch/docs/build-eg-iframe.html",
+      "--examples-base-url", "../examples/",
+    ]
   end
+
+  runner.add_debug if mode == "debug"
   runner.add_seo if mode == "debug" || mode == "live"
   runner.add_google_analytics if mode == "live"
-  runner.add_comments('comments-touch-2') if mode == "debug" || mode == "live"
+  runner.add_comments('touch', '2') if mode == "debug" || mode == "live"
   runner.run
 
   runner.copy_touch2_build if mode != "export"
@@ -531,19 +499,6 @@ task :animator, [:mode] => :sass do |t, args|
   runner.run
 end
 
-desc "Run JSDuck JSON Export (for internal use at Sencha)\n" +
-     "export[touch]  - creates export for Touch 1\n" +
-     "export[touch2] - creates export for Touch 2"
-task :export, [:mode] do |t, args|
-  mode = args[:mode]
-  throw "Unknown mode #{mode}" unless ["touch", "touch2"].include?(mode)
-
-  runner = JsDuckRunner.new
-  runner.add_touch_export if mode == "touch"
-  runner.add_touch2_export if mode == "touch2"
-  runner.run
-end
-
 desc "Build JSDuck gem"
 task :gem => :sass do
   compress

data/jsduck.gemspec

@@ -2,8 +2,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.5"
 
   s.name = 'jsduck'
-  s.version = '3.6.1'
-  s.date = '2012-02-21'
+  s.version = '3.7.0'
+  s.date = '2012-02-29'
   s.summary = "Simple JavaScript Duckumentation generator"
   s.description = "Documentation generator for Sencha JS frameworks"
   s.homepage = "https://github.com/senchalabs/jsduck"

data/lib/jsduck/class.rb

@@ -33,10 +33,16 @@ module JsDuck
       @doc = doc
     end
 
+    # Accessor to internal hash
     def [](key)
       @doc[key]
     end
 
+    # Assignment to internal hash keys
+    def []=(key, value)
+      @doc[key] = value
+    end
+
     # Returns instance of parent class, or nil if there is none
     def parent
       @doc[:extends] ? lookup(@doc[:extends]) : nil

data/lib/jsduck/doc_parser.rb

@@ -124,7 +124,7 @@ module JsDuck
           at_member
         elsif look(/@inherit[dD]oc\b/)
           at_inheritdoc
-        elsif look(/@alias\s+[\w.]+#\w+/)
+        elsif look(/@alias\s+([\w.]+)?#\w+/)
           # For backwards compatibility.
           # @alias tag was used as @inheritdoc before
           at_inheritdoc
@@ -325,21 +325,24 @@ module JsDuck
 
       add_tag(:inheritdoc)
       skip_horiz_white
+
       if look(@ident_chain_pattern)
         @current_tag[:cls] = ident_chain
-        if look(/#\w/)
-          @input.scan(/#/)
-          if look(/static-/)
-            @current_tag[:static] = true
-            @input.scan(/static-/)
-          end
-          if look(/(cfg|property|method|event|css_var|css_mixin)-/)
-            @current_tag[:type] = ident.to_sym
-            @input.scan(/-/)
-          end
-          @current_tag[:member] = ident
+      end
+
+      if look(/#\w/)
+        @input.scan(/#/)
+        if look(/static-/)
+          @current_tag[:static] = true
+          @input.scan(/static-/)
+        end
+        if look(/(cfg|property|method|event|css_var|css_mixin)-/)
+          @current_tag[:type] = ident.to_sym
+          @input.scan(/-/)
         end
+        @current_tag[:member] = ident
       end
+
       skip_white
     end
 

data/lib/jsduck/examples.rb

@@ -33,24 +33,29 @@ module JsDuck
     #
     def fix_examples_data
       each_item do |ex|
+        ex["name"] = ex["url"] unless ex["name"]
+
         unless ex["url"] =~ /^https?:\/\//
           ex["url"] = @opts.examples_base_url + ex["url"]
-          ex["name"] = ex["url"] unless ex["name"]
-          unless ex["title"]
-            ex["title"] = ex["text"]
-            ex.delete("text")
-          end
-          unless ex["description"]
-            ex["description"] = ex["desc"]
-            ex.delete("desc")
-          end
+        end
+        unless ex["icon"] =~ /^https?:\/\//
+          ex["icon"] = @opts.examples_base_url + ex["icon"]
+        end
+
+        unless ex["title"]
+          ex["title"] = ex["text"]
+          ex.delete("text")
+        end
+        unless ex["description"]
+          ex["description"] = ex["desc"]
+          ex.delete("desc")
         end
       end
     end
 
     # Extracts example icon URL from example hash
     def icon_url(example)
-      @opts.examples_base_url + example["icon"]
+      example["icon"]
     end
 
   end

data/lib/jsduck/inherit_doc.rb

@@ -12,6 +12,7 @@ module JsDuck
     # Performs all inheriting
     def resolve_all
       @relations.each do |cls|
+        resolve_class(cls) if cls[:inheritdoc]
         cls.all_local_members.each do |member|
           if member[:inheritdoc]
             resolve(member)
@@ -33,57 +34,80 @@ module JsDuck
     #
     # If the parent also has @inheritdoc, continues recursively.
     def find_parent(m)
-      context = m[:files][0]
-      inherit = m[:inheritdoc]
+      if m[:inheritdoc][:cls]
+        # @inheritdoc MyClass#member
+        parent_cls = @relations[m[:inheritdoc][:cls]]
+        return warn("class not found", m) unless parent_cls
+
+        parent = lookup_member(parent_cls, m)
+        return warn("member not found", m) unless parent
+
+      elsif m[:inheritdoc][:member]
+        # @inheritdoc #member
+        parent = lookup_member(@relations[m[:owner]], m)
+        return warn("member not found", m) unless parent
 
-      if inherit[:cls]
-        parent_cls = @relations[inherit[:cls]]
-        unless parent_cls
-          warn("@inheritdoc #{inherit[:cls]}##{inherit[:member]} - class not found", context)
-          return m
-        end
-        parent = parent_cls.get_members(inherit[:member], inherit[:type] || m[:tagname], inherit[:static] || m[:meta][:static])[0]
-        unless parent
-          warn("@inheritdoc #{inherit[:cls]}##{inherit[:member]} - member not found", context)
-          return m
-        end
       else
+        # @inheritdoc
         parent_cls = @relations[m[:owner]].parent
         mixins = @relations[m[:owner]].mixins
+
         # Warn when no parent or mixins at all
-        if !parent_cls && mixins.length == 0
-          warn("@inheritdoc - parent class not found", context)
-          return m
-        end
+        return warn("parent class not found", m) unless parent_cls || mixins.length > 0
+
         # First check for the member in all mixins, because members
         # from mixins override those from parent class.  Looking first
         # from mixins is probably a bit slower, but it's the correct
         # order to do things.
         if mixins.length > 0
-          parent = mixins.map do |mix|
-            mix.get_members(m[:name], m[:tagname], m[:meta][:static])[0]
-          end.compact.first
+          parent = mixins.map {|mix| lookup_member(mix, m) }.compact.first
         end
+
         # When not found, try looking from parent class
         if !parent && parent_cls
-          parent = parent_cls.get_members(m[:name], m[:tagname], m[:meta][:static])[0]
+          parent = lookup_member(parent_cls, m)
         end
+
         # Only when both parent and mixins fail, throw warning
-        if !parent
-          warn("@inheritdoc - parent member not found", context)
-          return m
-        end
+        return warn("parent member not found", m) unless parent
       end
 
-      if parent[:inheritdoc]
-        find_parent(parent)
+      return parent[:inheritdoc] ? find_parent(parent) : parent
+    end
+
+    def lookup_member(cls, m)
+      inherit = m[:inheritdoc]
+      cls.get_members(inherit[:member] || m[:name], inherit[:type] || m[:tagname], inherit[:static] || m[:meta][:static])[0]
+    end
+
+    # Copy over doc from parent class.
+    def resolve_class(cls)
+      parent = find_class_parent(cls)
+      cls[:doc] = (cls[:doc] + "\n\n" + parent[:doc]).strip
+    end
+
+    def find_class_parent(cls)
+      if cls[:inheritdoc][:cls]
+        # @inheritdoc MyClass
+        parent = @relations[cls[:inheritdoc][:cls]]
+        return warn("class not found", cls) unless parent
       else
-        parent
+        # @inheritdoc
+        parent = cls.parent
+        return warn("parent class not found", cls) unless parent
       end
+
+      return parent[:inheritdoc] ? find_class_parent(parent) : parent
     end
 
-    def warn(msg, context)
+    def warn(msg, item)
+      context = item[:files][0]
+      i_member = item[:inheritdoc][:member]
+
+      msg = "@inheritdoc #{item[:inheritdoc][:cls]}"+ (i_member ? "#" + i_member : "") + " - " + msg
       Logger.instance.warn(:inheritdoc, msg, context[:filename], context[:linenr])
+
+      return item
     end
 
   end

data/lib/jsduck/lint.rb

@@ -41,7 +41,7 @@ module JsDuck
         end
       end
       each_member do |member|
-        if member[:doc] == "" && !member[:private]
+        if member[:doc] == "" && !member[:private] && !member[:meta][:hide]
           warn(:no_doc, "No documentation for #{member[:owner]}##{member[:name]}", member)
         end
       end

data/lib/jsduck/options.rb

@@ -72,7 +72,7 @@ module JsDuck
       ]
       @meta_tag_paths = []
 
-      @version = "3.6.1"
+      @version = "3.7.0"
 
       # Customizing output
       @title = "Sencha Docs - Ext JS"
@@ -95,7 +95,7 @@ module JsDuck
       @export = nil
       @seo = false
       @eg_iframe = nil
-      @examples_base_url = "extjs/examples/"
+      @examples_base_url = "extjs-build/examples/"
 
       # Debugging
       # Turn multiprocessing off by default in Windows

data/opt/comments-server-side/.gitignore

@@ -0,0 +1,2 @@
+config.js
+node_modules

data/opt/comments-server-side/ForumUser.js

@@ -0,0 +1,80 @@
+/**
+ * Authentication with a vBulletin user database
+ */
+
+var crypto = require('crypto'),
+    _ = require('underscore');
+
+var ForumUser = exports.ForumUser = function(client) {
+    this.client = client;
+};
+
+ForumUser.prototype = {
+
+    login: function(username, password, callback) {
+
+        var sql = "SELECT userid, usergroupid, membergroupids, email, username, password, salt FROM user WHERE username = ?",
+            self = this;
+
+        this.client.query(sql, [username],
+
+            function selectCb(err, results, fields) {
+                if (err) {
+                    callback(err);
+                    return;
+                }
+
+                if (results.length == 0) {
+                    callback("No such user");
+                    return;
+                }
+
+                if (!self.checkPassword(password, results[0].salt, results[0].password)) {
+                    callback("Invalid password");
+                    return;
+                }
+
+                var user = self.getUserFromResult(results[0]);
+
+                callback(null, user);
+            }
+        );
+    },
+
+    clientUser: function(user) {
+
+        crypto.createHash('md5').update(user.email).digest("hex");
+
+        return {
+            emailHash: user.email,
+            userName: user.username,
+            userId: user.userid,
+            mod: _.include(user.membergroupids, 7)
+        };
+    },
+
+    checkPassword: function(password, salt, saltedPassword) {
+
+        password = crypto.createHash('md5').update(password).digest("hex") + salt;
+        password = crypto.createHash('md5').update(password).digest("hex");
+
+        return password == saltedPassword;
+    },
+
+    getUserFromResult: function(result) {
+
+        var ids, id;
+
+        if (result.membergroupids) {
+            ids = result.membergroupids.split(',');
+            result.membergroupids = [];
+            for (id in ids) {
+                result.membergroupids.push(Number(ids[id]));
+            }
+        }
+
+        result.moderator = _.include(result.membergroupids, 7);
+
+        return result;
+    }
+};

data/opt/comments-server-side/app.js

@@ -0,0 +1,332 @@
+
+/**
+ * JSDuck authentication / commenting server side element. Requires Node.js + MongoDB.
+ *
+ * Authentication assumes a vBulletin forum database, but could easily be adapted (see ForumUser.js)
+ *
+ * Expects a config file, config.js, that looks like this:
+ *
+ *     exports.db = {
+ *         user: 'forumUsername',
+ *         password: 'forumPassword',
+ *         host: 'forumHost',
+ *         dbName: 'forumDb'
+ *     };
+ *
+ *     exports.sessionSecret = 'random string for session cookie encryption';
+ *
+ *     exports.mongoDb = 'mongodb://mongoHost:port/comments';
+ *
+ */
+
+config = require('./config');
+mongoose = require('mongoose');
+require('./database');
+require('express-namespace');
+
+var mysql = require('mysql'),
+    client = mysql.createClient({
+        host: config.db.host,
+        user: config.db.user,
+        password: config.db.password,
+        database: config.db.dbName
+    }),
+    express = require('express'),
+    connect = require('connect'),
+    MongoStore = require('connect-session-mongo'),
+    _ = require('underscore'),
+    ForumUser = require('./ForumUser').ForumUser,
+    forumUser = new ForumUser(client),
+    util = require('./util'),
+    crypto = require('crypto');
+
+
+var app = express.createServer(
+
+    // Headers for Cross Origin Resource Sharing (CORS)
+    function (req, res, next) {
+        res.setHeader('Access-Control-Allow-Origin', '*');
+        res.setHeader('Access-Control-Allow-Methods', 'POST, GET, OPTIONS');
+        res.setHeader('Access-Control-Allow-Headers', 'X-Requested-With, X-HTTP-Method-Override, Content-Type, Accept');
+        next();
+    },
+
+    express.cookieParser(),
+
+    // Hack to set session cookie if session ID is set as a URL param.
+    // This is because not all browsers support sending cookies via CORS
+    function(req, res, next) {
+        if (req.query.sid) {
+            var sid = req.query.sid.replace(/ /g, '+');
+            req.cookies = req.cookies || {};
+            req.cookies['sencha_docs'] = sid;
+        }
+        next();
+    },
+
+    // Use MongoDB for session storage
+    connect.session({ store: new MongoStore, secret: config.sessionSecret, key: 'sencha_docs' }),
+
+    function(req, res, next) {
+        // IE doesn't get content-type, so default to form encoded.
+        if (!req.headers['content-type']) {
+            req.headers['content-type'] = 'application/x-www-form-urlencoded';
+        }
+        next();
+    },
+    express.bodyParser(),
+    express.methodOverride()
+);
+
+app.enable('jsonp callback');
+
+// All URLs start with /auth
+app.namespace('/auth', function(){
+
+    /**
+     * Authentication
+     */
+
+    app.get('/session', function(req, res) {
+        var result = req.session && req.session.user && forumUser.clientUser(req.session.user);
+        res.json(result || false);
+    });
+
+    app.post('/login', function(req, res){
+
+        forumUser.login(req.body.username, req.body.password, function(err, result) {
+
+            if (err) {
+                res.json({ success: false, reason: err });
+                return;
+            }
+
+            req.session = req.session || {};
+            req.session.user = result;
+
+            var response = _.extend(forumUser.clientUser(result), {
+                sessionID: req.sessionID,
+                success: true
+            });
+
+            res.json(response);
+        });
+    });
+
+    // Remove session
+    app.post('/logout', function(req, res){
+        req.session.user = null;
+        res.json({ success: true });
+    });
+
+    /**
+     * Handles comment unsubscription requests.
+     */
+    app.get('/unsubscribe/:subscriptionId', function(req, res) {
+
+        Subscription.findOne({ _id: req.params.subscriptionId }, function(err, subscription) {
+            if (err) throw(err);
+
+            if (subscription) {
+                if (req.query.all == 'true') {
+                    Subscription.remove({ userId: subscription.userId }, function(err) {
+                        res.send("You have been unsubscribed from all threads.");
+                    });
+                } else {
+                    Subscription.remove({ _id: req.params.subscriptionId }, function(err) {
+                        res.send("You have been unsubscribed from that thread.");
+                    });
+                }
+            } else {
+                res.send("You are already unsubscribed.")
+            }
+        });
+    });
+
+});
+
+
+/**
+ * Commenting
+ */
+app.namespace('/auth/:sdk/:version', function(){
+
+    /**
+     * Returns a list of comments for a particular target (eg class, guide, video)
+     */
+    app.get('/comments', function(req, res) {
+
+        Comment.find({
+            target: JSON.parse(req.query.startkey),
+            deleted: { '$ne': true },
+            sdk: req.params.sdk,
+            version: req.params.version
+        }).sort('createdAt', 1).run(function(err, comments){
+            res.json(util.formatComments(comments, req));
+        });
+    });
+
+    /**
+     * Returns 100 most recent comments.
+     */
+    app.get('/comments_recent', function(req, res) {
+        Comment.find({
+            deleted: { '$ne': true },
+            sdk: req.params.sdk,
+            version: req.params.version
+        }).sort('createdAt', -1).limit(100).run(function(err, comments){
+            res.json(util.formatComments(comments, req));
+        });
+    });
+
+    /**
+     * Returns number of comments for each class / method
+     */
+    app.get('/comments_meta', util.getCommentsMeta, util.getCommentSubscriptions, function(req, res) {
+        res.send({ comments: req.commentsMeta, subscriptions: req.commentSubscriptions || [] });
+    });
+
+    /**
+     * Returns an individual comment (used when editing a comment)
+     */
+    app.get('/comments/:commentId', util.findComment, function(req, res) {
+        res.json({ success: true, content: req.comment.content });
+    });
+
+    /**
+     * Creates a new comment
+     */
+    app.post('/comments', util.requireLoggedInUser, function(req, res) {
+
+        var target = JSON.parse(req.body.target);
+
+        if (target.length === 2) {
+            target.push('');
+        }
+
+        var comment = new Comment({
+            author: req.session.user.username,
+            userId: req.session.user.userid,
+            content: req.body.comment,
+            action: req.body.action,
+            rating: Number(req.body.rating),
+            contentHtml: util.sanitize(req.body.comment),
+            downVotes: [],
+            upVotes: [],
+            createdAt: new Date,
+            target: target,
+            emaiHash: crypto.createHash('md5').update(req.session.user.email).digest("hex"),
+            sdk: req.params.sdk,
+            version: req.params.version,
+            moderator: req.session.user.moderator,
+            title: req.body.title,
+            url: req.body.url
+        });
+
+        comment.save(function(err, response) {
+            res.json({ success: true, id: response._id, action: req.body.action });
+
+            util.sendEmailUpdates(comment);
+        });
+    });
+
+    /**
+     * Updates an existing comment (for voting or updating contents)
+     */
+    app.post('/comments/:commentId', util.requireLoggedInUser, util.findComment, function(req, res) {
+
+        var voteDirection,
+            comment = req.comment;
+
+        if (req.body.vote) {
+            util.vote(req, res, comment);
+        } else {
+            var canUpdate = _.include(req.session.user.membergroupids, 7) || req.session.user.username == comment.author;
+
+            if (!canUpdate) {
+                res.json({success: false, reason: 'Forbidden'}, 403);
+                return;
+            }
+
+            comment.content = req.body.content;
+            comment.contentHtml = util.sanitize(req.body.content);
+
+            comment.updates = comment.updates || [];
+            comment.updates.push({
+                updatedAt: String(new Date()),
+                author: req.session.user.username
+            });
+
+            comment.save(function(err, response) {
+                res.json({ success: true, content: comment.contentHtml });
+            });
+        }
+    });
+
+    /**
+     * Deletes a comment
+     */
+    app.post('/comments/:commentId/delete', util.requireLoggedInUser, util.findComment, function(req, res) {
+
+        var canDelete = false,
+            comment = req.comment;
+
+        canDelete = _.include(req.session.user.membergroupids, 7) || req.session.user.username == req.comment.author;
+
+        if (!canDelete) {
+            res.json({ success: false, reason: 'Forbidden' }, 403);
+            return;
+        }
+
+        comment.deleted = true;
+
+        comment.save(function(err, response) {
+            res.send({ success: true });
+        });
+    });
+
+    /**
+     * Get email subscriptions
+     */
+    app.get('/subscriptions', util.getCommentSubscriptions, function(req, res) {
+        res.json({ subscriptions: req.commentSubscriptions });
+    });
+
+    /**
+     * Subscibe / unsubscribe to a comment thread
+     */
+    app.post('/subscribe', util.requireLoggedInUser, function(req, res) {
+
+        var subscriptionBody = {
+            sdk: req.params.sdk,
+            version: req.params.version,
+            target: JSON.parse(req.body.target),
+            userId: req.session.user.userid
+        };
+
+        Subscription.findOne(subscriptionBody, function(err, subscription) {
+
+            if (subscription && req.body.subscribed == 'false') {
+
+                subscription.remove(function(err, ok) {
+                    res.send({ success: true });
+                });
+
+            } else if (!subscription && req.body.subscribed == 'true') {
+
+                subscription = new Subscription(subscriptionBody);
+                subscription.email = req.session.user.email;
+
+                subscription.save(function(err, ok) {
+                    res.send({ success: true });
+                });
+            }
+        });
+    });
+
+});
+
+
+app.listen(3000);
+console.log("Server started...");
+

data/opt/comments-server-side/database.js

@@ -0,0 +1,36 @@
+/**
+ * Defines comment schema and connects to database
+ */
+Comment = mongoose.model('Comment', new mongoose.Schema({
+    sdk:         String,
+    version:     String,
+
+    action:      String,
+    author:      String,
+    userId:      Number,
+    content:     String,
+    contentHtml: String,
+    createdAt:   Date,
+    downVotes:   Array,
+    emailHash:   String,
+    rating:      Number,
+    target:      Array,
+    upVotes:     Array,
+    deleted:     Boolean,
+    updates:     Array,
+    mod:         Boolean,
+    title:       String,
+    url:         String
+}));
+
+Subscription = mongoose.model('Subscription', new mongoose.Schema({
+    sdk:         String,
+    version:     String,
+
+    createdAt:   Date,
+    userId:      Number,
+    email:       String,
+    target:      Array
+}));
+
+mongoose.connect(config.mongoDb);

data/opt/comments-server-side/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "jsduck_comments",
+  "version": "0.5.0",
+  "description": "Commenting backend for JSDuck Documentation",
+  "author": "Nick Poudlen <nick@sencha.com>",
+  "dependencies": {
+    "connect": "",
+    "connect-session-mongo": "",
+    "express": "",
+    "express-namespace": "",
+    "marked": "",
+    "mongoose": "",
+    "mysql": "",
+    "sanitizer": "",
+    "step": "",
+    "underscore": "",
+    "nodemailer": ""
+  }
+}
+

data/opt/comments-server-side/util.js

@@ -0,0 +1,245 @@
+
+var marked = require('marked'),
+    _ = require('underscore'),
+    sanitizer = require('sanitizer'),
+    nodemailer = require("nodemailer");
+
+exports.sanitize = function(content, opts) {
+
+    var markdowned, sanitized_output, urlFunc;
+
+    try {
+        markdowned = marked(content);
+    } catch(e) {
+        markdowned = content;
+    }
+
+    var exp = /(\bhttps?:\/\/[-A-Z0-9+&@#\/%?=~_|!:,.;]*[-A-Z0-9+&@#\/%=~_|])/igm;
+    markdowned = markdowned.replace(exp, "<a href='$1'>$1</a>");
+
+    if (opts && opts.stripUrls) {
+        urlFunc = function(str) {
+            if (str.match(/^(http:\/\/(www\.)?sencha.com|#))/)) {
+                return str;
+            } else {
+                return '';
+            }
+        };
+    }
+
+    sanitized_output = sanitizer.sanitize(markdowned, urlFunc);
+    sanitized_output = sanitized_output.replace(/&apos;/g, '&#39;');
+
+    return sanitized_output;
+};
+
+exports.formatComments = function(comments, req) {
+
+    return _.map(comments, function(comment) {
+
+        comment = _.extend(comment._doc, {
+            score: comment.upVotes.length - comment.downVotes.length,
+            createdAt: String(comment.createdAt)
+        });
+
+        if (req.session.user) {
+            comment.upVote = _.contains(comment.upVotes, req.session.user.username);
+            comment.downVote = _.contains(comment.downVotes, req.session.user.username);
+        }
+
+        return comment;
+    });
+};
+
+exports.vote = function(req, res, comment) {
+
+    var voteDirection;
+
+    if (req.session.user.username == comment.author) {
+
+        // Ignore votes from the author
+        res.json({success: false, reason: 'You cannot vote on your own content'});
+        return;
+
+    } else if (req.body.vote == 'up' && !_.include(comment.upVotes, req.session.user.username)) {
+
+        var voted = _.include(comment.downVotes, req.session.user.username);
+
+        comment.downVotes = _.reject(comment.downVotes, function(v) {
+            return v == req.session.user.username;
+        });
+
+        if (!voted) {
+            voteDirection = 'up';
+            comment.upVotes.push(req.session.user.username);
+        }
+    } else if (req.body.vote == 'down' && !_.include(comment.downVotes, req.session.user.username)) {
+
+        var voted = _.include(comment.upVotes, req.session.user.username);
+
+        comment.upVotes = _.reject(comment.upVotes, function(v) {
+            return v == req.session.user.username;
+        });
+
+        if (!voted) {
+            voteDirection = 'down';
+            comment.downVotes.push(req.session.user.username);
+        }
+    }
+
+    comment.save(function(err, response) {
+        res.json({
+            success: true,
+            direction: voteDirection,
+            total: (comment.upVotes.length - comment.downVotes.length)
+        });
+    });
+};
+
+
+exports.requireLoggedInUser = function(req, res, next) {
+
+    if (!req.session || !req.session.user) {
+        res.json({success: false, reason: 'Forbidden'}, 403);
+    } else {
+        next();
+    }
+};
+
+exports.findComment = function(req, res, next) {
+
+    if (req.params.commentId) {
+        Comment.findById(req.params.commentId, function(err, comment) {
+            req.comment = comment;
+            next();
+        });
+    } else {
+        res.json({success: false, reason: 'No such comment'});
+    }
+
+};
+
+exports.sendEmailUpdates = function(comment) {
+
+    var mailTransport = nodemailer.createTransport("SMTP",{
+        host: 'localhost',
+        port: 25
+    });
+
+    var sendSubscriptionEmail = function(emails) {
+
+        var email = emails.shift();
+
+        if (email) {
+            nodemailer.sendMail(email, function(err){
+                if (err){
+                    console.log(err);
+                } else{
+                    console.log("Sent email to " + email.to);
+                    sendSubscriptionEmail(emails);
+                }
+            });
+        } else {
+             console.log("Finished sending emails");
+             mailTransport.close();
+        }
+    }
+
+    var subscriptionBody = {
+        sdk: comment.sdk,
+        version: comment.version,
+        target: comment.target
+    };
+
+    var emails = [];
+
+    Subscription.find(subscriptionBody, function(err, subscriptions) {
+
+        _.each(subscriptions, function(subscription) {
+            var mailOptions = {
+                transport: mailTransport,
+                from: "Sencha Documentation <no-reply@sencha.com>",
+                to: subscription.email,
+                subject: "Comment on '" + comment.title + "'",
+                text: [
+                    "A comment by " + comment.author + " on '" + comment.title + "' was posted on the Sencha Documentation:\n",
+                    comment.content + "\n",
+                    "--",
+                    "Original thread: " + comment.url,
+                    "Unsubscribe from this thread: http://projects.sencha.com/auth/unsubscribe/" + subscription._id,
+                    "Unsubscribe from all threads: http://projects.sencha.com/auth/unsubscribe/" + subscription._id + '?all=true'
+                ].join("\n")
+            }
+
+            if (Number(comment.userId) != Number(subscription.userId)) {
+                emails.push(mailOptions);
+            }
+        });
+
+        if (emails.length) {
+            sendSubscriptionEmail(emails);
+        } else {
+            console.log("No emails to send");
+        }
+    });
+}
+
+
+exports.getCommentsMeta = function(req, res, next) {
+
+    var map = function() {
+        if (this.target) {
+            emit(this.target.slice(0,3).join('__'), 1);
+        } else {
+            return;
+        }
+    }
+
+    var reduce = function(key, values) {
+        var i = 0, total = 0;
+
+        for (; i< values.length; i++) {
+            total += values[i];
+        }
+
+        return total;
+    }
+
+    mongoose.connection.db.executeDbCommand({
+        mapreduce: 'comments',
+        map: map.toString(),
+        reduce: reduce.toString(),
+        out: 'commentCounts',
+        query: {
+            deleted: { '$ne': true },
+            sdk: req.params.sdk,
+            version: req.params.version
+        }
+    }, function(err, dbres) {
+        mongoose.connection.db.collection('commentCounts', function(err, collection) {
+            collection.find({}).toArray(function(err, comments) {
+                req.commentsMeta = comments;
+                next()
+            });
+        });
+    });
+}
+
+exports.getCommentSubscriptions = function(req, res, next) {
+    if (req.session.user) {
+        Subscription.find({
+            sdk: req.params.sdk,
+            version: req.params.version,
+            userId: req.session.user.userid
+        }, function(err, subscriptions) {
+            req.commentSubscriptions = _.map(subscriptions, function(subscription) {
+                return subscription.target;
+            });
+            next();
+        })
+    } else {
+        next();
+    }
+}
+
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: jsduck
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 3
-  - 6
-  - 1
-  version: 3.6.1
+  - 7
+  - 0
+  version: 3.7.0
 platform: ruby
 authors: 
 - Rene Saarsoo
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-21 00:00:00 +02:00
+date: 2012-02-29 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -150,6 +150,12 @@ files:
 - lib/jsduck/type_parser.rb
 - lib/jsduck/videos.rb
 - lib/jsduck/welcome.rb
+- opt/comments-server-side/.gitignore
+- opt/comments-server-side/ForumUser.js
+- opt/comments-server-side/app.js
+- opt/comments-server-side/database.js
+- opt/comments-server-side/package.json
+- opt/comments-server-side/util.js
 - opt/example.js
 - template-min/README.md
 - template-min/template.html
@@ -213,8 +219,6 @@ files:
 - template-min/app.js
 - template-min/print-template.html
 - template-min/favicon.ico
-- template-min/extjs/bootstrap.js
-- template-min/extjs/ext-all-debug.js
 - template-min/extjs/resources/themes/images/default/tab/tab-default-bottom-sides.gif
 - template-min/extjs/resources/themes/images/default/tab/tab-default-top-disabled-corners.gif
 - template-min/extjs/resources/themes/images/default/tab/tab-default-top-active-sides.gif
@@ -476,12 +480,20 @@ files:
 - template-min/extjs/resources/themes/images/default/form/text-bg.gif
 - template-min/extjs/resources/themes/images/default/window-header/window-header-default-bottom-corners.gif
 - template-min/extjs/resources/themes/images/default/window-header/window-header-default-right-sides.gif
+- template-min/extjs/resources/themes/images/default/window-header/window-header-default-collapsed-bottom-corners.gif
+- template-min/extjs/resources/themes/images/default/window-header/window-header-default-collapsed-right-sides.gif
 - template-min/extjs/resources/themes/images/default/window-header/window-header-default-top-sides.gif
+- template-min/extjs/resources/themes/images/default/window-header/window-header-default-collapsed-left-sides.gif
 - template-min/extjs/resources/themes/images/default/window-header/window-header-default-top-corners.gif
 - template-min/extjs/resources/themes/images/default/window-header/window-header-default-left-corners.gif
+- template-min/extjs/resources/themes/images/default/window-header/window-header-default-collapsed-right-corners.gif
+- template-min/extjs/resources/themes/images/default/window-header/window-header-default-collapsed-top-corners.gif
 - template-min/extjs/resources/themes/images/default/window-header/window-header-default-left-sides.gif
+- template-min/extjs/resources/themes/images/default/window-header/window-header-default-collapsed-bottom-sides.gif
+- template-min/extjs/resources/themes/images/default/window-header/window-header-default-collapsed-left-corners.gif
 - template-min/extjs/resources/themes/images/default/window-header/window-header-default-right-corners.gif
 - template-min/extjs/resources/themes/images/default/window-header/window-header-default-bottom-sides.gif
+- template-min/extjs/resources/themes/images/default/window-header/window-header-default-collapsed-top-sides.gif
 - template-min/extjs/resources/themes/images/default/tab-bar/scroll-left.gif
 - template-min/extjs/resources/themes/images/default/tab-bar/tab-bar-default-bg.gif
 - template-min/extjs/resources/themes/images/default/tab-bar/scroll-right.gif
@@ -577,7 +589,6 @@ files:
 - template-min/extjs/resources/themes/images/default/slider/slider-v-bg.png
 - template-min/extjs/resources/themes/images/default/slider/slider-v-bg.gif
 - template-min/extjs/resources/themes/images/default/slider/slider-thumb.png
-- template-min/extjs/resources/css/ext-all.css
 - template-min/extjs/ext-all.js
 - template-min/build-js.html
 - template-min/index.php