jsduck 4.8.0 → 4.9.0

data/Rakefile

@@ -273,10 +273,14 @@ task :touch2 => :sass do
     "--output", OUT_DIR,
     "--config", "#{SDK_DIR}/touch/docs/config.json",
     "--examples-base-url", "touch-build/examples/production/",
-    # "--import", "Touch 1.1:../docs.sencha.com/exports/touch-1.1",
-    # "--import", "Touch 2.0:../docs.sencha.com/exports/touch-2.0.1",
-    # "--import", "Touch 2.1.0:../docs.sencha.com/exports/touch-2.1.0",
-    # "--import", "Touch 2.1.1",
+    # "--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"
   )
 

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.8.0'
-  s.date = '2013-04-22'
+  s.version = '4.9.0'
+  s.date = Time.new.strftime('%Y-%m-%d')
   s.summary = "Simple JavaScript Duckumentation generator"
   s.description = "Documentation generator for Sencha JS frameworks"
   s.homepage = "https://github.com/senchalabs/jsduck"

data/lib/jsduck/assets.rb

@@ -6,6 +6,7 @@ require 'jsduck/videos'
 require 'jsduck/examples'
 require 'jsduck/categories'
 require 'jsduck/doc_formatter'
+require 'jsduck/news'
 
 module JsDuck
 
@@ -22,6 +23,7 @@ module JsDuck
     attr_reader :videos
     attr_reader :examples
     attr_reader :categories
+    attr_reader :news
 
     def initialize(relations, opts)
       @relations = relations
@@ -35,6 +37,7 @@ module JsDuck
       @videos = Videos.create(@opts.videos)
       @examples = Examples.create(@opts.examples, @opts)
       @categories = Categories.create(@opts.categories_path, doc_formatter, @relations)
+      @news = News.create(@relations, doc_formatter, @opts)
     end
 
     # Writes out the assets that can be written out separately:

data/lib/jsduck/categories.rb

@@ -2,6 +2,7 @@ require 'jsduck/logger'
 require 'jsduck/file_categories'
 require 'jsduck/auto_categories'
 require 'jsduck/categories_class_name'
+require 'jsduck/columns'
 
 module JsDuck
 
@@ -19,6 +20,7 @@ module JsDuck
     def initialize(categories, doc_formatter, relations={})
       @categories = categories
       @class_name = CategoriesClassName.new(doc_formatter, relations)
+      @columns = Columns.new("classes")
     end
 
     # Returns HTML listing of classes divided into categories
@@ -40,10 +42,12 @@ module JsDuck
       EOHTML
     end
 
+    private
+
     def render_columns(groups)
       align = ["left-column", "middle-column", "right-column"]
       i = -1
-      return split(groups, 3).map do |col|
+      return @columns.split(groups, 3).map do |col|
         i += 1
         [
           "<div class='#{align[i]}'>",
@@ -64,48 +68,6 @@ module JsDuck
       end
     end
 
-    # Splits the array of items into n chunks so that the sum of
-    # largest chunk is as small as possible.
-    #
-    # This is a brute-force implementation - we just try all the
-    # combinations and choose the best one.
-    def split(items, n)
-      if n == 1
-        [items]
-      elsif items.length <= n
-        Array.new(n) {|i| items[i] ? [items[i]] : [] }
-      else
-        min_max = nil
-        min_arr = nil
-        i = 0
-        while i <= items.length-n
-          i += 1
-          # Try placing 1, 2, 3, ... items to first chunk.
-          # Calculate the remaining chunks recursively.
-          cols = [items[0,i]] + split(items[i, items.length], n-1)
-          max = max_sum(cols)
-          # Is this the optimal solution so far? Remember it.
-          if !min_max || max < min_max
-            min_max = max
-            min_arr = cols
-          end
-        end
-        min_arr
-      end
-    end
-
-    def max_sum(cols)
-      cols.map {|col| sum(col) }.max
-    end
-
-    # Finds the total size of items in array
-    #
-    # The size of one item is it's number of classes + the space for header
-    def sum(arr)
-      header_size = 3
-      arr.reduce(0) {|sum, item| sum + item["classes"].length + header_size }
-    end
-
   end
 
 end

data/lib/jsduck/categories_class_name.rb

@@ -26,36 +26,12 @@ module JsDuck
     # Adds small star to new classes in the current version.
     def render_new_label(cls)
       if cls[:meta][:new]
-        "&nbsp;<span class='new-class' title='New class'>#{stars(1)}</span>"
+        "&nbsp;<span class='new-class' title='New class'>&#9733;</span>"
       else
-        n = new_members_count(cls)
-        if n > 0
-          title = "#{n} new member#{(n>1) ? 's' : ''}"
-          "&nbsp;<span class='new-members' title='#{title}'>#{stars(n)}</span>"
-        else
-          ""
-        end
+        ""
       end
     end
 
-    # Produces string of n stars.
-    # First 3 stars are rendered as "<unicode-star>", the following as "+".
-    # At max 15 stars are rendered.
-    def stars(n)
-      if n > 15
-        stars(3) + ("+" * (15-3))
-      elsif n > 3
-        stars(3) + ("+" * (n-3))
-      else
-        "&#9733;" * n
-      end
-    end
-
-    # Returns number of new members the class has in the current version
-    def new_members_count(cls)
-      cls.find_members(:local => true).find_all {|m| m[:meta][:new] && !m[:private] }.length
-    end
-
   end
 
 end

data/lib/jsduck/columns.rb

@@ -0,0 +1,56 @@
+module JsDuck
+
+  # Splits array of items with subitems into roughly equal size groups.
+  class Columns
+    # Initialized with the name of subitems field.
+    def initialize(subitems_field)
+      @header_size = 3
+      @subitems_field = subitems_field
+    end
+
+    # Splits the array of items into n chunks so that the sum of
+    # largest chunk is as small as possible.
+    #
+    # This is a brute-force implementation - we just try all the
+    # combinations and choose the best one.
+    def split(items, n)
+      if n == 1
+        [items]
+      elsif items.length <= n
+        Array.new(n) {|i| items[i] ? [items[i]] : [] }
+      else
+        min_max = nil
+        min_arr = nil
+        i = 0
+        while i <= items.length-n
+          i += 1
+          # Try placing 1, 2, 3, ... items to first chunk.
+          # Calculate the remaining chunks recursively.
+          cols = [items[0,i]] + split(items[i, items.length], n-1)
+          max = max_sum(cols)
+          # Is this the optimal solution so far? Remember it.
+          if !min_max || max < min_max
+            min_max = max
+            min_arr = cols
+          end
+        end
+        min_arr
+      end
+    end
+
+    private
+
+    def max_sum(cols)
+      cols.map {|col| sum(col) }.max
+    end
+
+    # Finds the total size of items in array
+    #
+    # The size of one item is it's number of classes + the space for header
+    def sum(arr)
+      arr.reduce(0) {|sum, item| sum + item[@subitems_field].length + @header_size }
+    end
+
+  end
+
+end

data/lib/jsduck/index_html.rb

@@ -37,6 +37,7 @@ module JsDuck
         "{data_path}" => File.basename(@opts.data_path),
         "{welcome}" => @assets.welcome.to_html("display:none"),
         "{categories}" => @assets.categories.to_html("display:none"),
+        "{news}" => @assets.news.to_html("display:none"),
         "{guides}" => @assets.guides.to_html("display:none"),
         "{head_html}" => @opts.head_html,
         "{body_html}" => @opts.body_html,

data/lib/jsduck/news.rb

@@ -0,0 +1,128 @@
+require 'jsduck/util/null_object'
+require 'jsduck/columns'
+
+module JsDuck
+
+  class News
+    # Creates News object from relations data when --import option
+    # specified.
+    def self.create(relations, doc_formatter, opts)
+      if opts[:imports].length > 0
+        News.new(relations, doc_formatter)
+      else
+        Util::NullObject.new(:to_html => "")
+      end
+    end
+
+    # Generates list of new classes & members in this version.
+    def initialize(relations, doc_formatter)
+      @doc_formatter = doc_formatter
+      @columns = Columns.new(:members)
+      @new_items = filter_new_items(relations)
+    end
+
+    # Returns the HTML
+    def to_html(style="")
+      return [
+        "<div id='news-content' style='#{style}'>",
+          "<div class='section'>",
+            "<h1>New in this version</h1>",
+            render_columns(@new_items),
+            "<div style='clear:both'></div>",
+          "</div>",
+        "</div>",
+      ].flatten.join("\n")
+    end
+
+    private
+
+    def filter_new_items(relations)
+      classes = []
+      new_items = []
+
+      relations.each do |cls|
+        if !cls[:meta][:private]
+          if cls[:meta][:new]
+            classes << cls
+          else
+            members = filter_new_members(cls)
+            if members.length > 0
+              new_items << {:name => cls[:name], :members => members}
+            end
+          end
+        end
+      end
+
+      new_items.sort! {|a, b| a[:name] <=> b[:name] }
+
+      # Place the new classes section at the beginning
+      if classes.length > 0
+        new_items.unshift({:name => "New classes", :members => classes})
+      end
+
+      new_items
+    end
+
+    def filter_new_members(cls)
+      members = []
+      cls.all_local_members.each do |m|
+        members << m if m[:meta][:new] && visible?(m)
+      end
+      members = discard_accessors(members)
+      members.sort! {|a, b| a[:name] <=> b[:name] }
+    end
+
+    def visible?(member)
+      !member[:meta][:private] && !member[:meta][:hide]
+    end
+
+    def discard_accessors(members)
+      accessors = {}
+      members.find_all {|m| m[:accessor] }.each do |cfg|
+        accessors["set" + upcase_first(cfg[:name])] = true
+        accessors["get" + upcase_first(cfg[:name])] = true
+        accessors[cfg[:name].downcase + "change"] = true if cfg[:evented]
+      end
+
+      members.reject {|m| accessors[m[:name]] }
+    end
+
+    def upcase_first(str)
+      str[0,1].upcase + str[1..-1]
+    end
+
+    def render_columns(new_items)
+      align = ["left-column", "middle-column", "right-column"]
+      i = -1
+      return @columns.split(new_items, 3).map do |col|
+        i += 1
+        [
+          "<div class='#{align[i]}'>",
+          render_col(col),
+          "</div>",
+        ]
+      end
+    end
+
+    def render_col(col)
+      return col.map do |item|
+        [
+          "<h3>#{item[:name]}</h3>",
+          "<ul class='links'>",
+          item[:members].map {|m| "<li>" + link(m) + "</li>" },
+          "</ul>",
+        ]
+      end
+    end
+
+    def link(m)
+      if m[:tagname] == :class
+        @doc_formatter.link(m[:name], nil, m[:name])
+      else
+        @doc_formatter.link(m[:owner], m[:name], m[:name], m[:tagname], m[:meta][:static])
+      end
+    end
+
+  end
+
+end

data/lib/jsduck/options.rb

@@ -93,7 +93,7 @@ module JsDuck
       @ext4_events = nil
       @meta_tag_paths = []
 
-      @version = "4.8.0"
+      @version = "4.9.0"
 
       # Customizing output
       @title = "Documentation - JSDuck"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsduck
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-22 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdiscount
@@ -203,6 +203,7 @@ files:
 - lib/jsduck/class_formatter.rb
 - lib/jsduck/class_name.rb
 - lib/jsduck/class_writer.rb
+- lib/jsduck/columns.rb
 - lib/jsduck/css_lexer.rb
 - lib/jsduck/css_parser.rb
 - lib/jsduck/doc_ast.rb
@@ -249,6 +250,7 @@ files:
 - lib/jsduck/meta_tag_loader.rb
 - lib/jsduck/meta_tag_registry.rb
 - lib/jsduck/meta_tag_renderer.rb
+- lib/jsduck/news.rb
 - lib/jsduck/option_parser.rb
 - lib/jsduck/options.rb
 - lib/jsduck/override.rb
@@ -671,10 +673,10 @@ files:
 - template-min/extjs/resources/themes/images/default/btn-group/btn-group-default-framed-sides.gif
 - template-min/index-template.html
 - template-min/README.md
-- template-min/app-9096a86b4ef476d85905927d55b2fdef.js
 - template-min/eg-iframe.html
+- template-min/app-baf1b533a51447e178d66adecf5e85d4.js
 - template-min/index.php
-- template-min/resources/css/app-d837b293d081641aaa2111b87080b6d6.css
+- template-min/resources/css/app-44f34022ca84128086b28c375ab02185.css
 - template-min/resources/images/link-green-standard.png
 - template-min/resources/images/class-m.png
 - template-min/resources/images/singleton-m.png