Commit 3848e4e7 authored by Rene Saarsoo's avatar Rene Saarsoo
Browse files

Eliminate JsDuck::Class#full_name method. 

Easier to just use cls[:name] and keeps JsDuck::Class simpler.
parent 35e1c6c7

lib/jsduck/class.rb

+1 −6
Original line number Diff line number Diff line
@@ -125,7 +125,7 @@ module JsDuck 
    # Returns true when this class inherits from the specified class.

    # Also returns true when the class itself is the one we are asking about.

    def inherits_from?(class_name)

      return full_name == class_name || (parent ? parent.inherits_from?(class_name) : false)

      return @doc[:name] == class_name || (parent ? parent.inherits_from?(class_name) : false)

    end



    # Returns list of members filtered by a query.
@@ -184,11 +184,6 @@ module JsDuck 
      @doc[:members]

    end



    # A way to access full class name with similar syntax to short_name

    def full_name

      @doc[:name]

    end



    # Static methods



    # Generates member :id from member hash

lib/jsduck/doc_formatter.rb

+1 −1
Original line number Diff line number Diff line
@@ -259,7 +259,7 @@ module JsDuck 
    # applies the link template

    def link(cls, member, anchor_text, type=nil, static=nil)

      # Use the canonical class name for link (not some alternateClassName)

      cls = @relations[cls].full_name

      cls = @relations[cls][:name]

      # prepend type name to member name

      member = member && get_matching_member(cls, {:name => member, :tagname => type, :static => static})

lib/jsduck/full_exporter.rb

+8 −8
Original line number Diff line number Diff line
@@ -22,14 +22,14 @@ module JsDuck 
        h[:statics][tagname] = export_members(cls, {:tagname => tagname, :static => true})

      end

      h[:component] = cls.inherits_from?("Ext.Component")

      h[:superclasses] = cls.superclasses.collect {|c| c.full_name }

      h[:subclasses] = @relations.subclasses(cls).collect {|c| c.full_name }

      h[:mixedInto] = @relations.mixed_into(cls).collect {|c| c.full_name }



      h[:mixins] = cls.deps(:mixins).collect {|c| c.full_name }

      h[:parentMixins] = cls.parent_deps(:mixins).collect {|c| c.full_name }

      h[:requires] = cls.deps(:requires).collect {|c| c.full_name }

      h[:uses] = cls.deps(:uses).collect {|c| c.full_name }

      h[:superclasses] = cls.superclasses.collect {|c| c[:name] }

      h[:subclasses] = @relations.subclasses(cls).collect {|c| c[:name] }

      h[:mixedInto] = @relations.mixed_into(cls).collect {|c| c[:name] }



      h[:mixins] = cls.deps(:mixins).collect {|c| c[:name] }

      h[:parentMixins] = cls.parent_deps(:mixins).collect {|c| c[:name] }

      h[:requires] = cls.deps(:requires).collect {|c| c[:name] }

      h[:uses] = cls.deps(:uses).collect {|c| c[:name] }



      h

    end

lib/jsduck/inline_examples.rb

+3 −3
Original line number Diff line number Diff line
@@ -16,9 +16,9 @@ module JsDuck 
      relations.each do |cls|

        extract(cls[:doc]).each_with_index do |ex, i|

          @examples << {

            :id => cls.full_name + "-" + i.to_s,

            :name => cls.full_name + " example #" + (i+1).to_s,

            :href => '#!/api/' + cls.full_name,

            :id => cls[:name] + "-" + i.to_s,

            :name => cls[:name] + " example #" + (i+1).to_s,

            :href => '#!/api/' + cls[:name],

            :code => ex[:code],

            :options => ex[:options],

          }

lib/jsduck/relations.rb

+9 −9
Original line number Diff line number Diff line
@@ -20,7 +20,7 @@ module JsDuck 
      # mixins and subclasses will depend on that.

      @lookup = {}

      @classes.each do |cls|

        @lookup[cls.full_name] = cls

        @lookup[cls[:name]] = cls

        (cls[:alternateClassNames] || []).each do |alt_name|

          @lookup[alt_name] = cls

        end
@@ -58,31 +58,31 @@ module JsDuck 
    def reg_subclasses(cls)

      if !cls.parent

        # do nothing

      elsif @subs[cls.parent.full_name]

        @subs[cls.parent.full_name] << cls

      elsif @subs[cls.parent[:name]]

        @subs[cls.parent[:name]] << cls

      else

        @subs[cls.parent.full_name] = [cls]

        @subs[cls.parent[:name]] = [cls]

      end

    end



    # Returns subclasses of particular class, empty array if none

    def subclasses(cls)

      @subs[cls.full_name] || []

      @subs[cls[:name]] || []

    end



    def reg_mixed_into(cls)

      cls.mixins.each do |mix|

        if @mixes[mix.full_name]

          @mixes[mix.full_name] << cls

        if @mixes[mix[:name]]

          @mixes[mix[:name]] << cls

        else

          @mixes[mix.full_name] = [cls]

          @mixes[mix[:name]] = [cls]

        end

      end

    end



    # Returns classes having particular mixin, empty array if none

    def mixed_into(cls)

      @mixes[cls.full_name] || []

      @mixes[cls[:name]] || []

    end

  end