Commit c217c8bd authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Use only actual member names in tag context. 

This allows us to do a larger refactoring in Merger class, eliminating
all the merge_like_* methods, and doing almost all the merging inside
the main #merge method.
parent 7d955f50

lib/jsduck/merger.rb

+22 −45
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ module JsDuck 


  # Takes data from comment and code that follows it and combines

  # these two pieces of information into one.  The code comes from

  # JsDuck::Ast and comment from JsDuck::DocAst.

  # JsDuck::JS::Ast and comment from JsDuck::Doc::Processor.

  #

  # The main method merge() produces a hash as a result.

  class Merger
@@ -16,65 +16,42 @@ module JsDuck 
      docs = docset[:comment]

      code = docset[:code]



      case docset[:tagname]

      when :class

        result = merge_class(docs, code)

      when :method, :event, :css_mixin

        result = merge_like_method(docs, code)

      when :cfg, :property, :css_var

        result = merge_like_property(docs, code)

      end



      result[:linenr] = docset[:linenr]



      result

    end

      h = {

        :tagname => docset[:tagname],

        :name => merge_name(docs, code),

        :linenr => docset[:linenr],

      }



    private

      invoke_merge_in_tags(h, docs, code)

      general_merge(h, docs, code)



    def merge_class(docs, code)

      h = {}

      TagRegistry.mergers(:class).each do |tag|

        tag.merge(h, docs, code)

      end



      do_merge(h, docs, code)

    end

      # Needs to be calculated last, as it relies on the existance of

      # :name, :static and :tagname fields.

      h[:id] = JsDuck::Class.member_id(h)



    def merge_like_method(docs, code)

      h = {}

      TagRegistry.mergers(:method_like).each do |tag|

        tag.merge(h, docs, code)

      h

    end



      do_merge(h, docs, code)

    end

    private



    def merge_like_property(docs, code)

      h = {}

      TagRegistry.mergers(:property_like).each do |tag|

    # Invokes the #merge methods of tags registered for the given

    # merge context.

    def invoke_merge_in_tags(h, docs, code)

      TagRegistry.mergers(h[:tagname]).each do |tag|

        tag.merge(h, docs, code)

      end



      do_merge(h, docs, code)

    end



    # --- helpers ---



    def do_merge(h, docs, code)

      h[:name] = merge_name(docs, code)



    # Applies default merge algorithm to the rest of the data.

    def general_merge(h, docs, code)

      # Merge in all items in docs that don't occour already in result.

      docs.each_pair do |key, value|

        h[key] = docs[key] || code[key] unless h.has_key?(key)

        h[key] = value unless h.has_key?(key)

      end

      # Add items only detected in code.

      # Then add all in the items from code not already in result.

      code.each_pair do |key, value|

        h[key] = value unless h.has_key?(key)

      end



      h[:id] = JsDuck::Class.member_id(h)



      h

    end



    def merge_name(docs, code)

lib/jsduck/tag/default.rb

+1 −1
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ module JsDuck::Tag 
  # fields.

  class Default < Tag

    def initialize

      @merge_context = :property_like

      @merge_context = [:cfg, :property, :css_var]

    end



    def merge(h, docs, code)

lib/jsduck/tag/param.rb

+1 −1
Original line number Diff line number Diff line
@@ -7,7 +7,7 @@ module JsDuck::Tag 
    def initialize

      @pattern = "param"

      @key = :param

      @merge_context = :method_like

      @merge_context = [:method, :event, :css_mixin]

    end



    # @param {Type} [name=default] (optional) ...

lib/jsduck/tag/type.rb

+1 −1
Original line number Diff line number Diff line
@@ -6,7 +6,7 @@ module JsDuck::Tag 
    def initialize

      @pattern = "type"

      @key = :type

      @merge_context = :property_like

      @merge_context = [:cfg, :property, :css_var]

    end



    # matches @type {type}  or  @type type