jsduck 4.0.beta2 → 4.0.0

data/lib/jsduck/override.rb

@@ -0,0 +1,87 @@
+module JsDuck
+
+  class Override
+    def initialize(classes_hash, classes_array)
+      @classes_hash = classes_hash
+      @classes_array = classes_array
+    end
+
+    # Applies all override classes to target classes
+    def process_all!
+      overrides = []
+
+      @classes_array.each do |cls|
+        if cls[:override]
+          process(cls)
+          overrides << cls
+        end
+      end
+
+      # Discard override classes
+      overrides.each do |cls|
+        @classes_hash.delete(cls[:name])
+        @classes_array.delete(cls)
+      end
+    end
+
+    private
+
+    # Applies override class to target class
+    def process(override)
+      target = @classes_hash[override[:override]]
+      unless target
+        ctx = override[:files][0]
+        return Logger.instance.warn(:extend, "Class #{override[:override]} not found", ctx[:filename], ctx[:linenr])
+      end
+
+      # Combine comments of classes
+      if override[:doc].length > 0
+        add_doc(target, "**From override #{override[:name]}:** " + override[:doc])
+      end
+      target[:files] += override[:files]
+
+      # Build lookup table of existing members
+      existing = {}
+      each_member(target) do |m|
+        existing[m[:id]] = m
+      end
+
+      # When the same member exists in overridden class, just append
+      # the docs.  Otherwise add the member as a whole to the class.
+      each_member(override) do |m|
+        ex = existing[m[:id]]
+        if ex
+          if m[:doc].length > 0
+            add_doc(ex, "**From override #{override[:name]}:** " + m[:doc])
+          else
+            add_doc(ex, "**Overridden in #{override[:name]}.**")
+          end
+          ex[:files] += m[:files]
+        else
+          add_member(target, m)
+          add_doc(m, "**Defined in override #{override[:name]}.**")
+          m[:owner] = target[:name]
+        end
+      end
+    end
+
+    # helpers
+
+    def each_member(cls)
+      [:members, :statics].each do |category|
+        cls[category].each_pair do |key, members|
+          members.each {|m| yield m }
+        end
+      end
+    end
+
+    def add_member(cls, m)
+      cls[m[:static] ? :statics : :members][m[:tagname]] << m
+    end
+
+    def add_doc(m, doc)
+      m[:doc] = (m[:doc] + "\n\n" + doc).strip
+    end
+  end
+
+end

data/lib/jsduck/tag/chainable.rb

@@ -0,0 +1,14 @@
+require "jsduck/meta_tag"
+
+module JsDuck::Tag
+  # Implementation of @chainable tag
+  class Chainable < JsDuck::MetaTag
+    def initialize
+      @name = "chainable"
+      @key = :chainable
+      @signature = {:long => "chainable", :short => "&gt;"} # show small right-arrow
+      @boolean = true
+    end
+  end
+end
+

data/lib/jsduck/videos.rb

@@ -18,7 +18,7 @@ module JsDuck
     def initialize(filename)
       @groups = JsonDuck.read(filename)
       add_names_if_missing
-      build_map_by_name("Two videos have the same name")
+      build_map_by_name("Two videos have the same name", filename)
     end
 
     # Each video should have a name, which is used in URL to reference the video.

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: jsduck
 version: !ruby/object:Gem::Version
-  version: 4.0.beta2
-  prerelease: 4
+  version: 4.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Rene Saarsoo
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-01 00:00:00.000000000 Z
+date: 2012-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdiscount
@@ -61,7 +61,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: execjs
+  name: therubyracer
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -133,13 +133,12 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - COPYING
-- Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bin/compare
 - bin/graph
 - bin/jsduck
+- esprima/esprima.js
 - js-classes/Array.js
 - js-classes/Boolean.js
 - js-classes/Date.js
@@ -194,14 +193,15 @@ files:
 - lib/jsduck/lexer.rb
 - lib/jsduck/lint.rb
 - lib/jsduck/logger.rb
-- lib/jsduck/markdown.rb
 - lib/jsduck/merger.rb
 - lib/jsduck/meta_tag.rb
 - lib/jsduck/meta_tag_loader.rb
 - lib/jsduck/meta_tag_registry.rb
 - lib/jsduck/null_object.rb
+- lib/jsduck/option_parser.rb
 - lib/jsduck/options.rb
 - lib/jsduck/os.rb
+- lib/jsduck/override.rb
 - lib/jsduck/parallel_wrap.rb
 - lib/jsduck/relations.rb
 - lib/jsduck/renderer.rb
@@ -215,6 +215,7 @@ files:
 - lib/jsduck/tag/abstract.rb
 - lib/jsduck/tag/aside.rb
 - lib/jsduck/tag/author.rb
+- lib/jsduck/tag/chainable.rb
 - lib/jsduck/tag/deprecated.rb
 - lib/jsduck/tag/docauthor.rb
 - lib/jsduck/tag/hide.rb
@@ -668,7 +669,6 @@ files:
 - template-min/extjs/ext-all.js
 - template-min/build-js.html
 - template-min/index.php
-- esprima/esprima.js
 homepage: https://github.com/senchalabs/jsduck
 licenses: []
 post_install_message: 
@@ -684,9 +684,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: 1.3.5
 requirements: []
 rubyforge_project: jsduck
 rubygems_version: 1.8.24

data/Gemfile

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

data/Gemfile.lock

@@ -1,45 +0,0 @@
-PATH
-  remote: .
-  specs:
-    jsduck (3.11.0)
-      execjs
-      json
-      parallel
-      rdiscount
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    chunky_png (1.2.5)
-    compass (0.12.2)
-      chunky_png (~> 1.2)
-      fssm (>= 0.2.7)
-      sass (~> 3.1)
-    diff-lcs (1.1.3)
-    execjs (1.4.0)
-      multi_json (~> 1.0)
-    fssm (0.2.9)
-    json (1.7.3)
-    multi_json (1.3.6)
-    parallel (0.5.17)
-    rake (0.9.2.2)
-    rdiscount (1.6.8)
-    rspec (2.10.0)
-      rspec-core (~> 2.10.0)
-      rspec-expectations (~> 2.10.0)
-      rspec-mocks (~> 2.10.0)
-    rspec-core (2.10.1)
-    rspec-expectations (2.10.0)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.10.1)
-    sass (3.1.19)
-
-PLATFORMS
-  ruby
-  x86-mingw32
-
-DEPENDENCIES
-  compass
-  jsduck!
-  rake
-  rspec

data/lib/jsduck/markdown.rb

@@ -1,46 +0,0 @@
-
-module JsDuck
-
-  # Wrapper which chooses the available Markdown implementation and
-  # provides a uniform interface to it.
-  #
-  # Possible engines in order of preference:
-  #
-  # - rdiscount
-  # - kramdown
-  #
-  class Markdown
-
-    if RUBY_PLATFORM == "java"
-      require "kramdown"
-      begin
-        @@engine = :kramdown
-      rescue LoadError
-        throw "ERROR: Kramdown gem not available."
-      end
-    else
-      begin
-        require "rdiscount"
-        @@engine = :rdiscount
-      rescue LoadError
-        begin
-          require "kramdown"
-          @@engine = :kramdown
-        rescue LoadError
-          throw "ERROR: Neither RDiscount nor Kramdown gem available."
-        end
-      end
-    end
-
-    # Converts Markdown text into HTML
-    def self.to_html(input)
-      if @@engine == :rdiscount
-        RDiscount.new(input).to_html
-      else
-        Kramdown::Document.new(input).to_html
-      end
-    end
-
-  end
-
-end