From 87856f21b9a26f927bf552aa8409d0c3c6d71cc8 Mon Sep 17 00:00:00 2001
From: Rene Saarsoo <nene@triin.net>
Date: Tue, 22 Jan 2013 19:20:10 +0200
Subject: [PATCH] Move warning logging back to Doc::Subproperties.

Gets rid of all the duplicated warning logging code from the Tag classes
that use Doc::Subproperties.
---
 lib/jsduck/doc/subproperties.rb | 16 ++++++++--------
 lib/jsduck/tag/cfg.rb           |  8 +-------
 lib/jsduck/tag/param.rb         |  4 +---
 lib/jsduck/tag/property.rb      |  8 +-------
 lib/jsduck/tag/return.rb        |  8 +-------
 5 files changed, 12 insertions(+), 32 deletions(-)

diff --git a/lib/jsduck/doc/subproperties.rb b/lib/jsduck/doc/subproperties.rb
index a71c1ae8..d63a936b 100644
--- a/lib/jsduck/doc/subproperties.rb
+++ b/lib/jsduck/doc/subproperties.rb
@@ -1,4 +1,5 @@
 require 'jsduck/util/singleton'
+require 'jsduck/logger'
 
 module JsDuck
   module Doc
@@ -22,13 +23,12 @@ module JsDuck
       #         {:name => "baz"}]},
       #     {:name => "zap"},
       #
-      # NOTE: It returns two values: the resulting nested items array
-      # and warnings array of :subproperty warnings that should get
-      # printed out.
-      def nest(raw_items)
+      # Secondly it takes a position argument which is used for
+      # logging warnings when bogus subproperty syntax is encountered.
+      def nest(raw_items, pos)
         # First item can't be namespaced, if it is ignore the rest.
         if raw_items[0] && raw_items[0][:name] =~ /\./
-          return [raw_items[0]], []
+          return [raw_items[0]]
         end
 
         # build name-index of all items
@@ -39,7 +39,6 @@ module JsDuck
         # Otherwise look up the parent of item and add it as the
         # property of that parent.
         items = []
-        warnings = []
         raw_items.each do |it|
           if it[:name] =~ /^(.+)\.([^.]+)$/
             it[:name] = $2
@@ -48,14 +47,15 @@ module JsDuck
               parent[:properties] = [] unless parent[:properties]
               parent[:properties] << it
             else
-              warnings << "Ignoring subproperty #{$1}.#{$2}, no parent found with name '#{$1}'."
+              msg = "Ignoring subproperty #{$1}.#{$2}, no parent found with name '#{$1}'."
+              Logger.warn(:subproperty, msg, pos[:filename], pos[:linenr])
             end
           else
             items << it
           end
         end
 
-        return items, warnings
+        return items
       end
 
     end
diff --git a/lib/jsduck/tag/cfg.rb b/lib/jsduck/tag/cfg.rb
index ba158ee6..addcefa6 100644
--- a/lib/jsduck/tag/cfg.rb
+++ b/lib/jsduck/tag/cfg.rb
@@ -26,14 +26,8 @@ module JsDuck::Tag
       h[:name] = p[:name]
       h[:type] = p[:type]
       h[:default] = p[:default]
-      h[:properties] = nest_properties(tags, pos)
+      h[:properties] = JsDuck::Doc::Subproperties.nest(tags, pos)[0][:properties]
       h[:required] = true if p[:optional] == false
     end
-
-    def nest_properties(tags, pos)
-      items, warnings = JsDuck::Doc::Subproperties.nest(tags)
-      warnings.each {|msg| JsDuck::Logger.warn(:subproperty, msg, pos[:filename], pos[:linenr]) }
-      items[0][:properties]
-    end
   end
 end
diff --git a/lib/jsduck/tag/param.rb b/lib/jsduck/tag/param.rb
index 50139468..6cc07946 100644
--- a/lib/jsduck/tag/param.rb
+++ b/lib/jsduck/tag/param.rb
@@ -21,9 +21,7 @@ module JsDuck::Tag
     end
 
     def process_doc(h, tags, pos)
-      items, warnings = JsDuck::Doc::Subproperties.nest(tags)
-      warnings.each {|msg| JsDuck::Logger.warn(:subproperty, msg, pos[:filename], pos[:linenr]) }
-      h[:params] = items
+      h[:params] = JsDuck::Doc::Subproperties.nest(tags, pos)
     end
   end
 end
diff --git a/lib/jsduck/tag/property.rb b/lib/jsduck/tag/property.rb
index 8f289c4e..37dbf39a 100644
--- a/lib/jsduck/tag/property.rb
+++ b/lib/jsduck/tag/property.rb
@@ -22,13 +22,7 @@ module JsDuck::Tag
       # Type might also come from @type, don't overwrite it with nil.
       h[:type] = p[:type] if p[:type]
       h[:default] = p[:default]
-      h[:properties] = nest_properties(tags, pos)
-    end
-
-    def nest_properties(tags, pos)
-      items, warnings = JsDuck::Doc::Subproperties.nest(tags)
-      warnings.each {|msg| JsDuck::Logger.warn(:subproperty, msg, pos[:filename], pos[:linenr]) }
-      items[0][:properties]
+      h[:properties] = JsDuck::Doc::Subproperties.nest(tags, pos)[0][:properties]
     end
   end
 end
diff --git a/lib/jsduck/tag/return.rb b/lib/jsduck/tag/return.rb
index f86666ca..6f64547f 100644
--- a/lib/jsduck/tag/return.rb
+++ b/lib/jsduck/tag/return.rb
@@ -30,14 +30,8 @@ module JsDuck::Tag
         :type => ret[:type] || "Object",
         :name => ret[:name] || "return",
         :doc => ret[:doc] || "",
-        :properties => nest_properties(tags, pos)[0][:properties]
+        :properties => JsDuck::Doc::Subproperties.nest(tags, pos)[0][:properties],
       }
     end
-
-    def nest_properties(tags, pos)
-      items, warnings = JsDuck::Doc::Subproperties.nest(tags)
-      warnings.each {|msg| JsDuck::Logger.warn(:subproperty, msg, pos[:filename], pos[:linenr]) }
-      items
-    end
   end
 end
-- 
GitLab