jsduck 3.10.0 → 3.10.1

data/Gemfile

@@ -0,0 +1,4 @@
+source :rubygems
+
+gemspec
+

data/Rakefile

@@ -1,13 +1,16 @@
 require 'rubygems'
 require 'rake'
-require 'json'
 
 $LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
 
+def os_is_windows?
+  RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/
+end
+
 require 'rspec'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.rspec_opts = ["--color"]
+  spec.rspec_opts = ["--color"] unless os_is_windows?
   spec.pattern = "spec/**/*_spec.rb"
 end
 
@@ -176,11 +179,11 @@ class JsDuckRunner
   end
 
   def add_debug
-    @options += [
+    add_options(
       "--extjs-path", "extjs/ext-all-debug.js",
-      "--template-links",
       "--template", "template",
-    ]
+    )
+    add_options("--template-links") unless os_is_windows?
   end
 
   def run
@@ -246,7 +249,7 @@ task :touch2 => :sass do
   runner.add_options(
     "--output", OUT_DIR,
     "--config", "#{SDK_DIR}/touch/docs/config.json",
-    "--examples-base-url", "touch/examples/production/",
+    "--examples-base-url", "touch-build/examples/production/",
     "--seo",
     "--tests"
   )
@@ -255,7 +258,7 @@ task :touch2 => :sass do
   runner.add_comments('touch', '2')
   runner.run
 
-  system("cp -r #{TOUCH_BUILD} #{OUT_DIR}/touch")
+  system("cp -r #{TOUCH_BUILD} #{OUT_DIR}/touch-build")
 end
 
 task :default => :spec

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.10.0'
-  s.date = '2012-05-04'
+  s.version = '3.10.1'
+  s.date = '2012-05-11'
   s.summary = "Simple JavaScript Duckumentation generator"
   s.description = "Documentation generator for Sencha JS frameworks"
   s.homepage = "https://github.com/senchalabs/jsduck"
@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = s.name
 
   s.files = `git ls-files`.split("\n").find_all do |file|
-    file !~ /spec.rb$/ && file !~ /benchmark/ && file !~ /template\//
+    file !~ /spec.rb$/ && file !~ /benchmark/ && file !~ /template\// && file !~ /opt\//
   end
   # Add files not in git
   s.files += Dir['template-min/**/*']
@@ -23,5 +23,9 @@ Gem::Specification.new do |s|
   s.add_dependency 'json'
   s.add_dependency 'parallel'
 
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'compass'
+
   s.require_path = 'lib'
 end

data/lib/jsduck/doc_formatter.rb

@@ -2,10 +2,10 @@
 require 'rubygems'
 require 'rdiscount'
 require 'strscan'
-require 'cgi'
 require 'jsduck/logger'
 require 'jsduck/inline_img'
 require 'jsduck/inline_video'
+require 'jsduck/html'
 
 module JsDuck
 
@@ -274,7 +274,7 @@ module JsDuck
         when '%-'
           member ? "-" : ""
         when '%a'
-          CGI.escapeHTML(anchor_text||"")
+          HTML.escape(anchor_text||"")
         else
           $1
         end
@@ -327,7 +327,7 @@ module JsDuck
     #   Blah blah blah some text.
     #
     def shorten(input)
-      sent = first_sentence(strip_tags(input))
+      sent = first_sentence(HTML.strip_tags(input).strip)
       # Use u-modifier to correctly count multi-byte characters
       chars = sent.scan(/./mu)
       if chars.length > @max_length
@@ -343,15 +343,12 @@ module JsDuck
 
     # Returns true when input should get shortened.
     def too_long?(input)
-      stripped = strip_tags(input)
+      stripped = HTML.strip_tags(input).strip
       # for sentence v/s full - compare byte length
       # for full v/s max - compare char length
       first_sentence(stripped).length < stripped.length || stripped.scan(/./mu).length > @max_length
     end
 
-    def strip_tags(str)
-      str.gsub(/<.*?>/, "").strip
-    end
   end
 
 end

data/lib/jsduck/guides.rb

@@ -4,6 +4,7 @@ require 'jsduck/io'
 require 'jsduck/null_object'
 require 'jsduck/logger'
 require 'jsduck/grouped_asset'
+require 'jsduck/html'
 require 'fileutils'
 
 module JsDuck
@@ -51,7 +52,7 @@ module JsDuck
       @groups.map do |group|
         {
           "title" => group["title"],
-          "items" => group["items"].map {|g| g.select {|k, v| k != :html } }
+          "items" => group["items"].map {|g| Hash[g.select {|k, v| k != :html }] }
         }
       end
     end
@@ -111,8 +112,9 @@ module JsDuck
       html.each_line do |line|
         if line =~ /^<h2>(.*)<\/h2>$/
           i += 1
-          toc << "<li><a href='#!/guide/#{guide['name']}-section-#{i}'>#{$1}</a></li>\n"
-          new_html << "<h2 id='#{guide['name']}-section-#{i}'>#{$1}</h2>\n"
+          text = HTML.strip_tags($1)
+          toc << "<li><a href='#!/guide/#{guide['name']}-section-#{i}'>#{text}</a></li>\n"
+          new_html << "<h2 id='#{guide['name']}-section-#{i}'>#{text}</h2>\n"
         else
           new_html << line
         end

data/lib/jsduck/html.rb

@@ -0,0 +1,25 @@
+require 'cgi'
+
+module JsDuck
+
+  # Helpers for dealing with HTML
+  class HTML
+
+    # Strips tags from HTML text
+    def self.strip_tags(html)
+      html.gsub(/<.*?>/, "")
+    end
+
+    # Escapes HTML, replacing < with &lt; ...
+    def self.escape(html)
+      CGI.escapeHTML(html)
+    end
+
+    # Unescapes HTML, replacing &lt; with < ...
+    def self.unescape(html)
+      CGI.unescapeHTML(html)
+    end
+
+  end
+
+end

data/lib/jsduck/inline_examples.rb

@@ -1,5 +1,5 @@
 require 'jsduck/json_duck'
-require 'cgi'
+require 'jsduck/html'
 
 module JsDuck
 
@@ -65,7 +65,7 @@ module JsDuck
             ex = s.scan_until(@end_example_re).sub(@end_example_re, '')
 
             examples << {
-              :code => CGI.unescapeHTML(strip_tags(ex)),
+              :code => HTML.unescape(HTML.strip_tags(ex)),
               :options => options,
             }
           else
@@ -89,9 +89,6 @@ module JsDuck
       hash
     end
 
-    def strip_tags(str)
-      str.gsub(/<.*?>/, "")
-    end
   end
 
 end

data/lib/jsduck/inline_img.rb

@@ -1,4 +1,4 @@
-require 'cgi'
+require 'jsduck/html'
 require 'jsduck/logger'
 
 module JsDuck
@@ -42,7 +42,7 @@ module JsDuck
         when '%u'
           @base_path ? (@base_path + "/" + url) : url
         when '%a'
-          CGI.escapeHTML(alt_text||"")
+          HTML.escape(alt_text||"")
         else
           $1
         end

data/lib/jsduck/inline_video.rb

@@ -1,4 +1,4 @@
-require 'cgi'
+require 'jsduck/html'
 require 'jsduck/logger'
 
 module JsDuck
@@ -47,7 +47,7 @@ module JsDuck
         when '%u'
           url
         when '%a'
-          CGI.escapeHTML(alt_text||"")
+          HTML.escape(alt_text||"")
         else
           $1
         end

data/lib/jsduck/options.rb

@@ -75,7 +75,7 @@ module JsDuck
       ]
       @meta_tag_paths = []
 
-      @version = "3.10.0"
+      @version = "3.10.1"
 
       # Customizing output
       @title = "Sencha Docs - Ext JS"

data/lib/jsduck/renderer.rb

@@ -1,5 +1,5 @@
 require 'jsduck/meta_tag_registry'
-require 'cgi'
+require 'jsduck/html'
 
 module JsDuck
 
@@ -267,7 +267,7 @@ module JsDuck
       doc << m[:doc]
 
       if m[:default] && m[:default] != "undefined"
-        doc << "<p>Defaults to: <code>" + CGI.escapeHTML(m[:default]) + "</code></p>"
+        doc << "<p>Defaults to: <code>" + HTML.escape(m[:default]) + "</code></p>"
       end
 
       doc << render_meta_data(m[:html_meta], :bottom)
@@ -329,7 +329,7 @@ module JsDuck
           p[:optional] ? " (optional)" : "",
           "<div class='sub-desc'>",
             p[:doc],
-            p[:default] ? "<p>Defaults to: <code>#{CGI.escapeHTML(p[:default])}</code></p>" : "",
+            p[:default] ? "<p>Defaults to: <code>#{HTML.escape(p[:default])}</code></p>" : "",
             p[:properties] && p[:properties].length > 0 ? render_params_and_return(p) : "",
           "</div>",
         "</li>",

data/lib/jsduck/source_file.rb

@@ -1,7 +1,7 @@
 require 'jsduck/js_parser'
 require 'jsduck/css_parser'
 require 'jsduck/merger'
-require "cgi"
+require 'jsduck/html'
 
 module JsDuck
 
@@ -54,7 +54,7 @@ module JsDuck
       # Use #each_line instead of #lines to support Ruby 1.6
       @contents.each_line do |line|
         linenr += 1;
-        line = CGI.escapeHTML(line)
+        line = HTML.escape(line)
         # wrap the line in as many spans as there are links to this line number.
         if @links[linenr]
           @links[linenr].each do |link|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsduck
 version: !ruby/object:Gem::Version
-  version: 3.10.0
+  version: 3.10.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-04 00:00:00.000000000 Z
+date: 2012-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdiscount
@@ -60,6 +60,54 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: compass
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Documentation generator for Sencha JS frameworks
 email: rene.saarsoo@sencha.com
 executables:
@@ -69,6 +117,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - COPYING
+- Gemfile
 - README.md
 - Rakefile
 - bin/compare
@@ -104,6 +153,7 @@ files:
 - lib/jsduck/grouped_asset.rb
 - lib/jsduck/guide_writer.rb
 - lib/jsduck/guides.rb
+- lib/jsduck/html.rb
 - lib/jsduck/icons.rb
 - lib/jsduck/images.rb
 - lib/jsduck/index_html.rb
@@ -154,14 +204,6 @@ files:
 - lib/jsduck/type_parser.rb
 - lib/jsduck/videos.rb
 - lib/jsduck/welcome.rb
-- opt/aside.png
-- 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
 - template-min/eg-iframe.html

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

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

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

@@ -1,80 +0,0 @@
-/**
- * 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;
-    }
-};