jsduck 5.0.0.beta2 → 5.0.0.beta3

data/lib/jsduck/docs_code_comparer.rb

@@ -1,44 +0,0 @@
-require 'jsduck/util/singleton'
-
-module JsDuck
-
-  # Compares documentation and code hashes.
-  # Provides an utility method to help with merging.
-  class DocsCodeComparer
-    include Util::Singleton
-
-    # Sets the value of a field in result hash based on its value in
-    # docs and code hashes.
-    #
-    # - When docs has the key, gets value from there.
-    #
-    # - When code has the key and matches with docs, gets value from
-    #   there, and also remembers the fact that we're using
-    #   auto-detected value by recording it in :autodetected field.
-    #
-    def merge_if_matches(h, key, docs, code)
-      if docs[key]
-        h[key] = docs[key]
-      elsif code[key] && matches?(docs, code)
-        h[key] = code[key]
-        mark_autodetected(h, key)
-      else
-        # nothing
-      end
-    end
-
-    # True if the name detected from code matches with explicitly
-    # documented name.  Also true when no explicit name documented.
-    def matches?(docs, code)
-      return docs[:name] == nil || docs[:name] == code[:name]
-    end
-
-    # Stores the key as flag into h[:autodetcted]
-    def mark_autodetected(h, key)
-      h[:autodetected] = {} unless h[:autodetected]
-      h[:autodetected][key] = true
-    end
-
-  end
-
-end

data/lib/jsduck/render/signature.rb

@@ -1,94 +0,0 @@
-require 'jsduck/render/tags'
-require 'jsduck/tag_registry'
-
-module JsDuck
-  module Render
-
-    # Performs the rendering of member signatures.
-    class Signature
-      # Initializes the renderer for rendering members of the given
-      # class.
-      def initialize(cls)
-        @cls = cls
-      end
-
-      # Renders signature of the given member.
-      def render(member)
-        # Keep the code simpler by not passing around the member hash
-        @m = member
-
-        return [
-          render_new,
-          render_link,
-          render_type,
-          render_tag_signature,
-        ]
-      end
-
-      private
-
-      def render_new
-        constructor? ? "<strong class='new-keyword'>new</strong>" : ""
-      end
-
-      def render_link
-        "<a href='#{render_url}' class='name #{render_expandable}'>#{render_name}</a>"
-      end
-
-      def render_url
-        "#!/api/#{@m[:owner]}-#{@m[:id]}"
-      end
-
-      def render_expandable
-        @m[:short_doc] ? "expandable" : "not-expandable"
-      end
-
-      def render_name
-        constructor? ? @cls[:name] : @m[:name]
-      end
-
-      def constructor?
-        @m[:tagname] == :method && @m[:name] == "constructor"
-      end
-
-      def render_type
-        if like_property?
-          render_property_type
-        else
-          render_params + render_return
-        end
-      end
-
-      def like_property?
-        TagRegistry.member_type_names(:property_like).include?(@m[:tagname])
-      end
-
-      def render_property_type
-        "<span> : #{@m[:html_type]}</span>"
-      end
-
-      def render_params
-        ps = @m[:params].map {|p| render_single_param(p) }.join(", ")
-        "( <span class='pre'>#{ps}</span> )"
-      end
-
-      def render_single_param(param)
-        param[:optional] ? "["+param[:name]+"]" : param[:name]
-      end
-
-      def render_return
-        method_with_return? ? (" : " + @m[:return][:html_type]) : ""
-      end
-
-      def method_with_return?
-        @m[:tagname] == :method && @m[:return] != nil
-      end
-
-      def render_tag_signature
-        Render::Tags.render_signature(@m)
-      end
-
-    end
-
-  end
-end

data/lib/jsduck/tag/autodetected.rb

@@ -1,21 +0,0 @@
-require "jsduck/tag/tag"
-require "jsduck/docs_code_comparer"
-
-module JsDuck::Tag
-  # There is no @autodetected tag.
-  #
-  # This tag class exists to take care of the merging of :autodetected
-  # field.
-  class Autodetected < Tag
-    def initialize
-      @tagname = :autodetected
-      @merge_context = [:class, :member]
-    end
-
-    def merge(h, docs, code)
-      if docs[:autodetected] || code[:autodetected]
-        h[:autodetected] = (code[:autodetected] || {}).merge(docs[:autodetected] || {})
-      end
-    end
-  end
-end

data/lib/jsduck/tag/name.rb

@@ -1,36 +0,0 @@
-require "jsduck/tag/tag"
-
-module JsDuck::Tag
-  # There is no @name tag.
-  #
-  # The :name field is generated by several tags like @class, @method,
-  # @cfg, ...
-  #
-  # This class exists to take care of the merging of :name field.
-  class Name < Tag
-    def initialize
-      @merge_context = [:class, :member]
-    end
-
-    # When docs contains :name, it's taken from there.
-    #
-    # When code contains :name, we only take the full name when
-    # dealing with a class, otherwise we just take the last part of
-    # the dot.separate.name.
-    #
-    # :name defaults to empty string.
-    def merge(h, docs, code)
-      if docs[:name]
-        h[:name] = docs[:name]
-      elsif code[:name]
-        if h[:tagname] == :class
-          h[:name] = code[:name]
-        else
-          h[:name] = code[:name].split(/\./).last
-        end
-      else
-        h[:name] = ""
-      end
-    end
-  end
-end