jsduck 5.0.0 → 5.0.1

data/.gitignore

@@ -1,6 +0,0 @@
-*.gem
-template/extjs
-template/resources/css
-template/resources/sass/.sass-cache
-template-min/
-sdk-vars.rb

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-rvm:
-  - "1.8.7"
-  - "1.9.3"
-install:
-  - gem install rdiscount
-  - gem install json
-  - gem install parallel
-  - gem install rkelly-remix -v 0.0.1
-  - gem install rspec
-  - gem install rake
-  - gem install dimensions

data/Rakefile

@@ -1,302 +0,0 @@
-require 'rubygems'
-require 'rake'
-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-
-require 'jsduck/util/md5'
-
-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"] unless os_is_windows?
-  spec.pattern = "spec/**/*_spec.rb"
-end
-
-def load_sdk_vars
-  if File.exists?("sdk-vars.rb")
-    require "./sdk-vars.rb"
-  else
-    puts "Error: sdk-vars.rb not found."
-    puts
-    puts "Please create file sdk-vars.rb and define in it:"
-    puts
-    puts "    # where to output the docs"
-    puts "    OUT_DIR='/path/to/ouput/dir'"
-    puts "    # path to Ext JS 4 build"
-    puts "    EXT_BUILD='/path/to/ext-4'"
-    puts "    # path to Touch 2 build (for building Sencha Touch)"
-    puts "    TOUCH_BUILD='/path/to/touch-2'"
-    puts "    # path to SDK (for developers at Sencha)"
-    puts "    SDK_DIR='/path/to/SDK'"
-    exit 1
-  end
-end
-
-# Compress JS/CSS file in-place
-# Using a hackish way to access yui-compressor
-def yui_compress(fname)
-  system "java -jar $(dirname $(which sencha))/bin/yuicompressor.jar -o #{fname} #{fname}"
-end
-
-# Reads in all CSS files referenced between BEGIN CSS and END CSS markers.
-# Deletes those input CSS files and writes out concatenated CSS to
-# resources/css/app.css
-# Finally replaces the CSS section with <link> to that one CSS file.
-def combine_css(html, dir)
-  css_section_re = /<!-- BEGIN CSS -->.*<!-- END CSS -->/m
-  css = []
-  css_section_re.match(html)[0].each_line do |line|
-    if line =~ /<link rel="stylesheet" href="(.*?)"/
-      file = $1
-      css << IO.read(dir + "/" + file)
-    end
-  end
-
-  fname = "#{dir}/resources/css/app.css"
-  File.open(fname, 'w') {|f| f.write(css.join("\n")) }
-  yui_compress(fname)
-  fname = JsDuck::Util::MD5.rename(fname)
-
-  html.sub(css_section_re, '<link rel="stylesheet" href="resources/css/' + File.basename(fname) + '" type="text/css" />')
-end
-
-# Same thing for JavaScript, result is written to: app.js
-def combine_js(html, dir)
-  js_section_re = /<!-- BEGIN JS -->.*<!-- END JS -->/m
-  js = []
-  js_section_re.match(html)[0].each_line do |line|
-    if line =~ /<script .* src="(.*)">/
-      file = $1
-      js << IO.read(dir + "/" + file)
-    elsif line =~ /<script .*>(.*)<\/script>/
-      js << $1
-    end
-  end
-
-  fname = "#{dir}/app.js"
-
-  File.open(fname, 'w') {|f| f.write(js.join("\n")) }
-  yui_compress(fname)
-  fname = JsDuck::Util::MD5.rename(fname)
-  html.sub(js_section_re, '<script type="text/javascript" src="' + File.basename(fname) + '"></script>')
-end
-
-# Modifies HTML to link app.css.
-def rewrite_css_links(dir, filename)
-  html = IO.read(dir + "/" + filename);
-  html = combine_css(html, dir)
-  File.open(dir + "/" + filename, 'w') {|f| f.write(html) }
-end
-
-# Compress JavaScript and CSS files of JSDuck
-def compress
-  load_sdk_vars
-
-  # Clean up template-min/ left over from previous compress task
-  system("rm", "-rf", "template-min")
-  # Copy template/ files to template-min/
-  system("cp", "-r", "template", "template-min")
-  # Now do everything that follows in template-min/ dir
-  dir = "template-min"
-
-  # Create JSB3 file for Docs app
-  system("sencha", "create", "jsb", "-a", "http://localhost/docs/", "-p", "#{dir}/app.jsb3")
-  # Concatenate files listed in JSB3 file
-  system("sencha", "build", "-p", "#{dir}/app.jsb3", "-d", dir)
-
-  # Remove intermediate build files
-  system("rm", "#{dir}/app.jsb3")
-  system("rm", "#{dir}/all-classes.js")
-  # Replace app.js with app-all.js
-  system("mv", "#{dir}/app-all.js", "#{dir}/app.js")
-  # Remove the entire app/ dir
-  system("rm", "-r", "#{dir}/app")
-
-  # Change CSS links in print-template.html and index-template.html files
-  rewrite_css_links(dir, "print-template.html")
-  rewrite_css_links(dir, "index-template.html")
-
-  # Concatenate CSS and JS files referenced in template.html file
-  template_html = "#{dir}/template.html"
-  html = IO.read(template_html)
-  html = combine_css(html, dir)
-  html = combine_js(html, dir)
-  File.open(template_html, 'w') {|f| f.write(html) }
-
-  # Clean up SASS files
-  # (But keep prettify lib, which is needed for source files)
-  system "rm -rf #{dir}/resources/css/docs-ext.css"
-  system "rm -rf #{dir}/resources/css/viewport.css"
-  system "rm -rf #{dir}/resources/sass"
-  system "rm -rf #{dir}/resources/codemirror"
-  system "rm -rf #{dir}/resources/.sass-cache"
-
-  # Empty the extjs dir, leave only the main JS file and images
-  system "rm -rf #{dir}/extjs"
-  system "mkdir #{dir}/extjs"
-  system "cp template/extjs/ext-all.js #{dir}/extjs"
-  system "mkdir -p #{dir}/extjs/resources/themes/images"
-  system "cp -r template/extjs/resources/themes/images/default #{dir}/extjs/resources/themes/images"
-end
-
-
-class JsDuckRunner
-  def initialize
-    @options = []
-    load_sdk_vars
-  end
-
-  def add_options(*options)
-    @options += options
-  end
-
-  def add_comments(db_name, version)
-    add_options("--comments-url", "http://localhost:3000/auth")
-    add_options("--comments-domain", db_name+"/"+version)
-  end
-
-  def add_search(product, version)
-    add_options("--search-url", "http://support-test.sencha.com:8080/docsearch/search")
-    add_options("--search-domain", product+"/"+version)
-  end
-
-  def add_ext4
-    @options += [
-      "--title", "Sencha Docs - Ext JS 4.0",
-      "--footer", "Ext JS 4.0 Docs - Generated with <a href='https://github.com/senchalabs/jsduck'>JSDuck</a> {VERSION}." +
-                  " <a href='http://www.sencha.com/legal/terms-of-use/'>Terms of Use</a>",
-      "--ignore-global",
-      "--warnings", "-all",
-      "--images", "#{EXT_BUILD}/docs/images",
-      "--local-storage-db", "ext-4",
-      "--output", "#{OUT_DIR}",
-      "#{EXT_BUILD}/src",
-    ]
-  end
-
-  def add_debug
-    add_options(
-      "--extjs-path", "extjs/ext-all-debug.js",
-      "--template", "template"
-    )
-    add_options("--template-links") unless os_is_windows?
-  end
-
-  def run
-    # Pass multiple arguments to system, so we'll take advantage of the built-in escaping
-    system(*["ruby", "bin/jsduck"].concat(@options))
-  end
-end
-
-# Download ExtJS into template/extjs
-task :get_extjs do
-  system "curl -o template/extjs.zip http://cdn.sencha.com/ext-4.1.1a-gpl.zip"
-  system "unzip template/extjs.zip -d template/"
-  system "rm -rf template/extjs"
-  system "mv template/ext-4.1.1a template/extjs"
-  system "rm template/extjs.zip"
-end
-
-# Auto-generate sdk-vars.rb config file
-task :config_file do
-  if File.exists?("sdk-vars.rb")
-    puts "sdk-vars.rb already exists. Keeping it."
-  else
-    puts "Generating sdk-vars.rb with the following content:"
-    config = <<-EORUBY
-# where to output the docs
-OUT_DIR='#{Dir.pwd}/output'
-# path to Ext JS 4 build
-EXT_BUILD='#{Dir.pwd}/template/extjs'
-    EORUBY
-    puts
-    puts config
-    File.open("sdk-vars.rb", "w") {|h| h.write(config) }
-  end
-end
-
-desc "Download ExtJS and initialize sdk-vars.rb config file"
-task :configure => [:get_extjs, :config_file]
-
-# Run compass to generate CSS files
-task :sass do
-  system "compass compile --quiet template/resources/sass"
-end
-
-desc "Build JSDuck gem"
-task :gem => :sass do
-  compress
-  system "gem build jsduck.gemspec"
-end
-
-desc "Run JSDuck on Docs app itself"
-task :docs do
-  runner = JsDuckRunner.new
-  runner.add_ext4
-  runner.add_options(
-    "--builtin-classes",
-    "template/app"
-  )
-  runner.add_debug
-  runner.run
-end
-
-desc "Run JSDuck on official Ext JS 4 build"
-task :ext4 => :sass do
-  runner = JsDuckRunner.new
-  runner.add_ext4
-  runner.add_debug
-  runner.run
-
-  system("ln -s #{EXT_BUILD} #{OUT_DIR}/extjs-build")
-end
-
-desc "Run JSDuck on Ext JS from SDK repo (for internal use at Sencha)"
-task :sdk => :sass do
-  runner = JsDuckRunner.new
-  runner.add_options(
-    "--output", OUT_DIR,
-    "--config", "#{SDK_DIR}/extjs/docs/config.json",
-    "--examples-base-url", "extjs-build/examples/",
-    # "--import", "4.1.3:../docs.sencha.com/exports/extjs-4.1.3",
-    # "--import", "4.2",
-    "--seo"
-  )
-  runner.add_debug
-  runner.add_comments('ext-js', '4')
-  runner.add_search('Ext JS', '4.2.0')
-  runner.run
-
-  system("ln -s #{EXT_BUILD} #{OUT_DIR}/extjs-build")
-end
-
-desc "Run JSDuck on Sencha Touch 2 repo (for internal use at Sencha)"
-task :touch2 => :sass do
-  runner = JsDuckRunner.new
-  runner.add_options(
-    "--output", OUT_DIR,
-    "--config", "#{SDK_DIR}/touch/docs/config.json",
-    "--examples-base-url", "touch-build/examples/production/",
-    # "--import", "1.1.0:../docs.sencha.com/exports/touch-1.1.0",
-    # "--import", "1.1.1:../docs.sencha.com/exports/touch-1.1.1",
-    # "--import", "2.0.0:../docs.sencha.com/exports/touch-2.0.0",
-    # "--import", "2.0.1:../docs.sencha.com/exports/touch-2.0.1",
-    # "--import", "2.1.0:../docs.sencha.com/exports/touch-2.1.0",
-    # "--import", "2.1.1:../docs.sencha.com/exports/touch-2.1.1",
-    # "--import", "2.2.0:../docs.sencha.com/exports/touch-2.2.0",
-    # "--import", "2.2.1",
-    "--seo"
-  )
-
-  runner.add_debug
-  runner.add_comments('touch', '2')
-  runner.run
-
-  system("ln -s #{TOUCH_BUILD} #{OUT_DIR}/touch-build")
-end
-
-task :default => :spec

data/bin/compare

@@ -1,374 +0,0 @@
-#!/usr/bin/env ruby
-# Produces diff of two JSDuck exports.
-
-# For running when gem not installed
-$:.unshift File.dirname(File.dirname(__FILE__)) + "/lib"
-
-require "rubygems"
-require "cgi"
-require "optparse"
-require "jsduck/util/json"
-
-options = {
-  :title => "Comparison of Ext 4.0.7 and Ext 4.1.1",
-  :remap => {},
-}
-
-input_files = OptionParser.new do |opts|
-  opts.banner = "Produces diff of two JSDuck exports.\n\n" +
-    "Usage: compare [options] old/classes/ new/classes/ output.html\n\n"
-
-  opts.on("--ignore=FILE", "A file listing members to be ignored") do |file|
-    options[:ignore] = file
-  end
-
-  opts.on("--type=NAME", "Only produce diff of cfg, property, method or event.") do |name|
-    options[:type] = name
-  end
-
-  opts.on("--title=TEXT", "Title for the generated HTML page.",
-    "Defaults to: 'Comparison of Ext 4.0.7 and Ext 4.1.1'") do |text|
-    options[:title] = text
-  end
-
-  opts.on("--show-unchanged", "To list classes that have not changed.",
-    "By default only classes with changes are listed.") do
-    options[:show_unchanged] = true
-  end
-
-  opts.on("--map=A:B", "Maps class A in old/classes/ to class B",
-    "in new/classes/. For example --map Ext.Foo:Ext.NewFoo") do |pair|
-    (a, b) = pair.split(/:/)
-    options[:remap][a] = b
-  end
-
-  opts.on("-h", "--help", "Show this help message") do
-    puts opts
-    exit
-  end
-end.parse!
-
-if input_files.length == 3
-  options[:old_classes] = input_files[0]
-  options[:new_classes] = input_files[1]
-  options[:out_file] = input_files[2]
-else
-  puts "You must specify exactly 3 filenames: old/classes/ new/classes/ output.html"
-  exit 1
-end
-
-
-def read_class(filename)
-  JsDuck::Util::Json.read(filename)
-end
-
-# loops through all members of class
-def each_member(cls)
-  ["members", "statics"].each do |category|
-    cls[category].each_pair do |k, members|
-      members.each do |m|
-        yield m
-      end
-    end
-  end
-end
-
-def discard_docs(cls)
-  each_member(cls) do |m|
-    m["doc"] = nil
-    m["params"] = nil
-  end
-  cls
-end
-
-def read_all_classes(dir)
-  map = {}
-  Dir[dir+"/*.json"].each do |filename|
-    print "."
-    STDOUT.flush
-    cls = discard_docs(read_class(filename))
-    map[cls["name"]] = cls
-    cls["alternateClassNames"].each do |name|
-      map[name] = cls
-    end
-  end
-  puts "OK"
-  map
-end
-
-def read_ignored_members(filename)
-  map = {}
-  IO.read(filename).each_line do |line|
-    map[line.chomp] = true
-  end
-  map
-end
-
-def normal_public_member?(m)
-  !m["private"] && !m["protected"] && !m["deprecated"] && !m["removed"]
-end
-
-def unify_default(v)
-  (v || "undefined").gsub(/"/, "'").sub(/^Ext\.baseCSSPrefix \+ '/, "'x-")
-end
-
-def visibility(m)
-  if m["private"]
-    "private"
-  elsif m["protected"]
-    "protected"
-  else
-    "public"
-  end
-end
-
-# Finds equivalent member to given member from class.
-# Returns the member found or nil.
-def find_member(cls, member)
-  cls[member["static"] ? "statics" : "members"][member["tagname"]].find do |m|
-    member["name"] == m["name"]
-  end
-end
-
-
-# Compares members of cls1 to cls2.
-# Returns diff array of added, removed and changed members.
-def compare_classes(cls1, cls2)
-  diff = []
-
-  checked_members = {}
-
-  each_member(cls1) do |m1|
-    next unless normal_public_member?(m1) && m1["owner"] == cls1["name"]
-
-    checked_members[m1["id"]] = true
-
-    m2 = find_member(cls2, m1)
-
-    if m2
-      changes = []
-      if m1["type"] != m2["type"]
-        changes << {
-          :what => "type",
-          :a => m1["type"],
-          :b => m2["type"],
-        }
-      end
-      if unify_default(m1["default"]) != unify_default(m2["default"])
-        changes << {
-          :what => "default",
-          :a => unify_default(m1["default"]),
-          :b => unify_default(m2["default"]),
-        }
-      end
-      if visibility(m1) != visibility(m2)
-        changes << {
-          :what => "visibility",
-          :a => visibility(m1),
-          :b => visibility(m2),
-        }
-      end
-
-      if changes.length > 0
-        diff << {
-          :type => m1["tagname"],
-          :name => m1["name"],
-          :what => "changed",
-          :changes => changes,
-        }
-      end
-
-    elsif !m2 && m1["name"] != "constructor" && m1["name"] != ""
-      other = nil
-      ["cfg", "property", "method", "event"].each do |g|
-        other = other || cls2["members"][g].find {|m2| m2["name"] == m1["name"] }
-        other = other || cls2["statics"][g].find {|m2| m2["name"] == m1["name"] }
-      end
-      diff << {
-        :type => m1["tagname"],
-        :name => m1["name"],
-        :what => "removed",
-        :other => other ? {
-          :type => other["tagname"],
-          :static => other["static"],
-          :private => other["private"],
-          :protected => other["protected"],
-        } : nil
-      }
-    end
-  end
-
-  each_member(cls2) do |m2|
-    next unless normal_public_member?(m2) && m2["owner"] == cls2["name"] && !checked_members[m2["id"]]
-
-    m1 = find_member(cls1, m2)
-
-    if m1
-      changes = []
-      if visibility(m1) != visibility(m2)
-        changes << {
-          :what => "visibility",
-          :a => visibility(m1),
-          :b => visibility(m2),
-        }
-      end
-
-      if changes.length > 0
-        diff << {
-          :type => m2["tagname"],
-          :name => m2["name"],
-          :what => "changed",
-          :changes => changes,
-        }
-      end
-
-    elsif !m1 && m2["name"] != "constructor" && m2["name"] != ""
-      diff << {
-        :type => m2["tagname"],
-        :name => m2["name"],
-        :what => "added",
-      }
-    end
-  end
-
-  diff
-end
-
-
-old_classes = read_all_classes(options[:old_classes])
-new_classes = read_all_classes(options[:new_classes])
-ignored_members = options[:ignore] ? read_ignored_members(options[:ignore]) : {}
-
-diff_data = []
-old_classes.each_pair do |name, cls|
-  # only go through classes, not alternate names
-  if name == cls["name"] && !cls["private"]
-    if options[:remap][name]
-      new_cls = new_classes[options[:remap][name]]
-    else
-      new_cls = new_classes[name]
-    end
-
-    diff_data << {
-      :name => cls["name"],
-      :found => (new_cls || ignored_members[name]) ? :both : :old,
-      :new_name => new_cls && new_cls["name"],
-      :diff => new_cls ? compare_classes(cls, new_cls) : [],
-    }
-  end
-end
-
-new_classes.each_pair do |name, cls|
-  if name == cls["name"] && !cls["private"]
-    unless old_classes[name]
-      diff_data << {
-        :name => cls["name"],
-        :found => :new,
-        :diff => [],
-      }
-    end
-  end
-end
-
-# Throw away ignored members and everything except configs
-diff_data.each do |cls|
-  cls[:diff] = cls[:diff].find_all do |m|
-    !ignored_members[cls[:name]+"#"+m[:name]] && (!options[:type] || m[:type] == options[:type])
-  end
-end
-
-# Choose title based on filename
-if options[:out_file] =~ /touch/
-  title = "Comparison of Touch 1.1.1 and Touch 2.0.0"
-else
-  title = "Comparison of Ext 4.0.7 and Ext 4.1.1"
-end
-
-# do HTML output
-html = []
-html << <<-EOHTML
-<!DOCTYPE html>
-<html>
-<head>
-<title>#{options[:title]}</title>
-<style type="text/css">
-body { font-family: Georgia, serif; }
-li h2 { font-size: medium; font-weight: normal; }
-li ul { display: none; }
-b.unchanged { color: green; }
-b.removed { color: red; }
-b.new { color: black; }
-</style>
-<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.6.3/jquery.min.js"></script>
-<script>
-$(function() {
-    $("h2 > a").live("click", function() {
-        $("ul", $(this).parent().parent()).toggle();
-        return false;
-    });
-});
-</script>
-</head>
-<body>
-<h1>#{options[:title]}</h1>
-EOHTML
-
-html << "<ul>"
-diff_data.sort! {|a, b| a[:name] <=> b[:name] }
-diff_data.each do |cls|
-  if cls[:found] == :both
-    if cls[:diff].length > 0 || options[:show_unchanged]
-      html << "<li>"
-      new_name = (cls[:new_name] == cls[:name] ? "" : " --> " + cls[:new_name])
-      diff_count = cls[:diff].length > 0 ? "(#{cls[:diff].length} changes)" : ""
-      link = cls[:diff].length > 0 ? "<a href='#expand'>#{cls[:name]}</a>" : cls[:name]+" <b class='unchanged'>Unchanged</b>"
-      html << "<h2>#{link} #{new_name} #{diff_count}</h2>"
-      if cls[:diff].length > 0
-        html << "<ul>"
-        cls[:diff].each do |m|
-          html << "<li>"
-          html << m[:what] + " " + m[:type] + " " + m[:name]
-          if m[:other]
-            o = m[:other]
-            stat = o[:static] ? 'static' : ''
-            priv = o[:private] ? 'private' : ''
-            prot = o[:protected] ? 'protected' : ''
-            html << " (found #{stat} #{priv} #{prot} #{o[:type]} with the same name)"
-          elsif m[:changes]
-            m[:changes].each do |c|
-              html << " (#{c[:what]} changed from #{CGI.escapeHTML(c[:a])} to #{CGI.escapeHTML(c[:b])})"
-            end
-          end
-        end
-        html << "</li>"
-      end
-      html << "</li>"
-    end
-  elsif cls[:found] == :old
-    html << "<li>"
-    html << "<h2>" + cls[:name] + " <b class='removed'>Removed</b></h2>"
-    html << "</li>"
-  elsif cls[:found] == :new
-    html << "<li>"
-    html << "<h2>" + cls[:name] + " <b class='new'>New class</b></h2>"
-    html << "</li>"
-  end
-  html << "</li>"
-end
-html << "</ul>"
-
-html << "<h2>Summary</h2>"
-dd = diff_data
-html << "<p>" + dd.find_all {|c| c[:found] == :old }.length.to_s + " classes removed</p>"
-html << "<p>" + dd.find_all {|c| c[:found] == :new }.length.to_s + " new classes added</p>"
-html << "<p>" + dd.find_all {|c| c[:found] == :both && c[:diff].length == 0 }.length.to_s + " classes exactly the same</p>"
-html << "<p>" + dd.find_all {|c| c[:found] == :both && c[:name] == c[:new_name] }.length.to_s + " classes with same name</p>"
-html << "<p>" + dd.find_all {|c| c[:found] == :both && c[:name] != c[:new_name] }.length.to_s + " renamed classes</p>"
-html << "<p>" + dd.find_all {|c| c[:diff].length > 0 }.length.to_s + " classes with changed members</p>"
-html << "<p>" + dd.map {|c| c[:diff].length }.inject {|sum,x| sum + x }.to_s + " changed members</p>"
-
-
-html << "</body>"
-html << "</html>"
-
-File.open(options[:out_file], 'w') {|f| f.write(html.join("\n")) }