jsduck 4.3.1 → 4.3.2

data/Rakefile

@@ -162,20 +162,9 @@ class JsDuckRunner
     @options += options
   end
 
-  # Enables comments when CORS is supported by browser.
-  # 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, version)
-    comments_base_url = "http://localhost:3000/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
+    add_options("--comments-url", "http://localhost:3000/auth")
+    add_options("--comments-domain", db_name+"/"+version)
   end
 
   def add_ext4

data/jsduck.gemspec

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

data/lib/jsduck/app_data.rb

@@ -28,6 +28,8 @@ module JsDuck
           :showPrintButton => @opts.seo,
           :touchExamplesUi => @opts.touch_examples_ui,
           :source => @opts.source,
+          :commentsUrl => @opts.comments_url,
+          :commentsDomain => @opts.comments_domain,
         }
       }) + ";\n"
       File.open(filename, 'w') {|f| f.write(js) }

data/lib/jsduck/circular_deps.rb

@@ -0,0 +1,39 @@
+module JsDuck
+
+  # Checks for circular dependencies
+  class CircularDeps
+
+    # Checks class for circular dependencies.
+    #
+    # When all OK, returns false.
+    #
+    # When circular dependencies found returns a string describing the
+    # problematic dependency chain e.g. "Foo extends Bar mixins Foo".
+    def check(cls, names = [])
+      names += [cls[:name]]
+
+      if cls.parent && chain = track_circular(" extends ", cls.parent, names)
+        return chain
+      end
+
+      cls.mixins.each do |mixin|
+        if chain = track_circular(" mixins ", mixin, names)
+          return chain
+        end
+      end
+
+      false
+    end
+
+    def track_circular(type, cls, names)
+      names += [type]
+      if names.include?(cls[:name])
+        (names + [cls[:name]]).join("")
+      else
+        check(cls, names)
+      end
+    end
+
+  end
+
+end

data/lib/jsduck/index_html.rb

@@ -17,7 +17,6 @@ module JsDuck
     def write
       if @opts.seo
         FileUtils.cp(@opts.template_dir+"/index.php", @opts.output_dir+"/index.php")
-        FileUtils.cp(@opts.template_dir+"/Mobile_Detect.php", @opts.output_dir+"/Mobile_Detect.php")
         create_template_html(@opts.template_dir+"/template.html", @opts.output_dir+"/template.html")
         create_print_template_html(@opts.template_dir+"/print-template.html", @opts.output_dir+"/print-template.html")
         create_index_template_html(@opts.template_dir+"/index-template.html", @opts.output_dir+"/index-template.html")
@@ -31,6 +30,7 @@ module JsDuck
     def create_template_html(in_file, out_file)
       write_template(in_file, out_file, {
         "{title}" => @opts.title,
+        "{mobile_redirect}" => @opts.seo ? include_script(@opts.template_dir+"/mobile-redirect.js") : "",
         "{header}" => @opts.header,
         "{footer}" => "<div id='footer-content' style='display: none'>#{@opts.footer}</div>",
         "{extjs_path}" => @opts.extjs_path,
@@ -61,6 +61,10 @@ module JsDuck
       })
     end
 
+    def include_script(filename)
+      "<script type='text/javascript'>\n" + Util::IO.read(filename) + "\n</script>"
+    end
+
     # Opens in_file, replaces {keys} inside it, writes to out_file
     def write_template(in_file, out_file, replacements)
       Logger.log("Writing", out_file)

data/lib/jsduck/lint.rb

@@ -1,5 +1,6 @@
 require 'jsduck/logger'
 require 'jsduck/class'
+require 'jsduck/circular_deps'
 
 module JsDuck
 
@@ -20,6 +21,7 @@ module JsDuck
       warn_duplicate_members
       warn_singleton_statics
       warn_empty_enums
+      fail_on_circular_dependencies
     end
 
     # print warning for each member or parameter with no name
@@ -117,6 +119,17 @@ module JsDuck
       end
     end
 
+    # Print fatal error message for circular dependency.
+    def fail_on_circular_dependencies
+      circular_deps = CircularDeps.new
+      @relations.each do |cls|
+        if chain = circular_deps.check(cls)
+          Logger.fatal("Class #{cls[:name]} has a circular dependency: #{chain}")
+          exit 1
+        end
+      end
+    end
+
     # Loops through all members of all classes
     def each_member(&block)
       @relations.each {|cls| cls.all_local_members.each(&block) }

data/lib/jsduck/options.rb

@@ -37,6 +37,8 @@ module JsDuck
     attr_accessor :eg_iframe
     attr_accessor :examples_base_url
     attr_accessor :tests
+    attr_accessor :comments_url
+    attr_accessor :comments_domain
 
     # Debugging
     attr_accessor :template_dir
@@ -79,7 +81,7 @@ module JsDuck
       @ext4_events = nil
       @meta_tag_paths = []
 
-      @version = "4.3.1"
+      @version = "4.3.2"
 
       # Customizing output
       @title = "Documentation - JSDuck"
@@ -103,6 +105,8 @@ module JsDuck
       @eg_iframe = nil
       @examples_base_url = "extjs-build/examples/"
       @tests = false
+      @comments_url = nil
+      @comments_domain = nil
 
       # Debugging
       @root_dir = File.dirname(File.dirname(File.dirname(__FILE__)))
@@ -376,6 +380,24 @@ module JsDuck
           @new_since = v
         end
 
+        opts.on('--comments-url=URL',
+          "Address of comments server.",
+          "",
+          "For example: http://projects.sencha.com/auth",
+          "",
+          "Must be used together with --comments-domain option.") do |url|
+          @comments_url = url
+        end
+
+        opts.on('--comments-domain=STRING',
+          "A string consisting of <name>/<version>.",
+          "",
+          "For example: ext-js/4",
+          "",
+          "Must be used together with --comments-url option.") do |domain|
+          @comments_domain = domain
+        end
+
         opts.separator ""
         opts.separator "Tweaking:"
         opts.separator ""

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsduck
 version: !ruby/object:Gem::Version
-  version: 4.3.1
+  version: 4.3.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-24 00:00:00.000000000 Z
+date: 2012-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdiscount
@@ -159,6 +159,7 @@ files:
 - lib/jsduck/batch_formatter.rb
 - lib/jsduck/batch_parser.rb
 - lib/jsduck/categories.rb
+- lib/jsduck/circular_deps.rb
 - lib/jsduck/class.rb
 - lib/jsduck/class_doc_expander.rb
 - lib/jsduck/class_formatter.rb
@@ -629,7 +630,6 @@ files:
 - template-min/app.js
 - template-min/index.php
 - template-min/build-js.html
-- template-min/Mobile_Detect.php
 - template-min/resources/css/app.css
 - template-min/resources/images/link-green-standard.png
 - template-min/resources/images/class-m.png
@@ -683,6 +683,7 @@ files:
 - template-min/resources/images/group-expand-sprite.gif
 - template-min/resources/prettify/prettify.css
 - template-min/resources/prettify/prettify.js
+- template-min/mobile-redirect.js
 homepage: https://github.com/senchalabs/jsduck
 licenses: []
 post_install_message: