yard 0.7.4 → 0.7.5

data/spec/templates/module_spec.rb

@@ -106,4 +106,26 @@ describe YARD::Templates::Engine.template(:default, :module) do
     
     html_equals(Registry.at('A').format(:format => :html, :no_highlight => true), :module002)
   end
+  
+  it "should ignore overwritten/private attributes/constants from inherited list" do
+    Registry.clear
+    YARD.parse_string <<-'eof'
+      module B
+        attr_reader :foo
+        attr_accessor :bar
+        # @private
+        attr_writer :baz
+        FOO = 1
+      end
+      module A
+        include B
+        def foo; end
+        attr_reader :bar
+        FOO = 2
+      end
+    eof
+    
+    html_equals(Registry.at('A').format(:format => :html, :no_highlight => true,
+      :verifier => Verifier.new('!@private')), :module003)
+  end
 end

data/spec/templates/tag_spec.rb

@@ -36,4 +36,16 @@ describe YARD::Templates::Engine.template(:default, :tags) do
       text_equals(Registry.at('#m').format, :tag001)
     end
   end
+  
+  describe 'param tags on non-methods' do
+    it 'should not display @param tags on non-method objects' do
+      YARD.parse_string <<-'eof'
+        # @param [#to_s] name the name
+        module Foo; end
+      eof
+      
+      proc = lambda { Registry.at('Foo').format(:format => :html) }
+      proc.should_not raise_error(NoMethodError)
+    end
+  end
 end

data/templates/default/fulldoc/html/js/full_list.js

@@ -4,6 +4,9 @@ var searchCache = [];
 var searchString = '';
 var regexSearchString = '';
 var caseSensitiveMatch = false;
+var ignoreKeyCodeMin = 8;
+var ignoreKeyCodeMax = 46;
+var commandKey = 91;
 
 RegExp.escape = function(text) {
     return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
@@ -19,6 +22,9 @@ function fullListSearch() {
   });
   
   $('#search input').keyup(function() {
+    if ((event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax) 
+         || event.keyCode == commandKey)
+      return;
     searchString = this.value;
     caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
     regexSearchString = RegExp.escape(searchString);

data/templates/default/module/html/inherited_attributes.erb

@@ -1,16 +1,13 @@
 <% found_method = false %>
-<% object.inheritance_tree(true)[1..-1].each do |superclass| %>
-  <% next if superclass.is_a?(YARD::CodeObjects::Proxy) %>
-  <% attribs = superclass.attributes[:instance] %>
-  <% next if attribs.size == 0 %>
+<% inherited_attr_list do |superclass, attribs| %>
   <% if attr_listing.size == 0 && !found_method %><h2>Instance Attribute Summary</h2><% end %>
   <% found_method = true %>
   <h3 class="inherited">Attributes <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
-  <p class="inherited"><%=
-    attribs.sort_by {|args| args.first.to_s }.collect do |args|
-      name, methods = args
-      method = methods[:read] || methods[:write]
-      name = method.name.to_s.gsub(/^#/,'') if superclass.type == :module && object.class_mixins.include?(superclass)
+  <p class="inherited"><%= attribs.map do |method|
+      name = method.name(true).gsub(/=$/, '')
+      if superclass.type == :module && object.instance_mixins.include?(superclass)
+        name = "##{name}" unless name =~ /^#/
+      end
       linkify(method, name)
     end.join(", ")
   %></p>

data/templates/default/module/html/inherited_constants.erb

@@ -1,8 +1,8 @@
-<% object.inheritance_tree(true)[1..-1].each do |superclass| %>
-  <% next if superclass.is_a?(YARD::CodeObjects::Proxy) %>
-  <% consts = run_verifier superclass.constants(:included => false, :inherited => false) %>
-  <% consts.reject! {|m| object.child(:scope => :class, :name => m.name) != nil } %>
-  <% next if consts.size == 0 %>
-  <h3 class="inherited">Constants <%= superclass.type == :class ? 'inherited' : 'included' %> from <%= linkify superclass %></h3>
-  <p class="inherited"><%= consts.sort_by {|o| o.name.to_s }.map {|m| linkify(m, m.name) }.join(", ") %></p>
-<% end %>
+<% found_const = false %>
+<% inherited_constant_list do |superclass, consts| %>
+  <% if constant_listing.size == 0 && !found_const %><h2>Constant Summary</h2><% end %>
+  <% found_const = true %>
+  <h3 class="inherited">Constants <%= superclass.type == :class ? 'inherited' : 'included' %>
+     from <%= linkify superclass %></h3>
+  <p class="inherited"><%= consts.map {|c| linkify c }.join(", ") %></p>
+<% end %>

data/templates/default/module/setup.rb

@@ -69,6 +69,28 @@ def sort_listing(list)
   list.sort_by {|o| [o.scope.to_s, o.name.to_s.downcase] }
 end
 
+def inherited_attr_list(&block)
+  object.inheritance_tree(true)[1..-1].each do |superclass|
+    next if superclass.is_a?(YARD::CodeObjects::Proxy)
+    attribs = superclass.attributes[:instance]
+    attribs = attribs.reject {|name, rw| object.child(:scope => :instance, :name => name) != nil }
+    attribs = attribs.sort_by {|args| args.first.to_s }.map {|n, m| m[:read] || m[:write] }
+    attribs = prune_method_listing(attribs, false)
+    yield superclass, attribs if attribs.size > 0
+  end
+end
+
+def inherited_constant_list(&block)
+  object.inheritance_tree(true)[1..-1].each do |superclass|
+    next if superclass.is_a?(YARD::CodeObjects::Proxy)
+    consts = superclass.constants(:included => false, :inherited => false)
+    consts = consts.reject {|const| object.child(:type => :constant, :name => const.name) != nil }
+    consts = consts.sort_by {|const| const.name.to_s }
+    consts = run_verifier(consts)
+    yield superclass, consts if consts.size > 0
+  end
+end
+
 def docstring_full(obj)
   docstring = ""
   if obj.tags(:overload).size == 1 && obj.docstring.empty?

data/templates/default/tags/setup.rb

@@ -13,6 +13,10 @@ def return
   tag(:return)
 end
 
+def param
+  tag(:param) if object.type == :method
+end
+
 private
 
 def tag(name, opts = nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-03 00:00:00.000000000 -05:00
+date: 2012-01-31 00:00:00.000000000 -05:00
 default_executable: 
 dependencies: []
 description: ! "    YARD is a documentation generation tool for the Ruby programming
@@ -308,6 +308,7 @@ files:
 - spec/server/commands/base_spec.rb
 - spec/server/commands/library_command_spec.rb
 - spec/server/commands/static_file_command_spec.rb
+- spec/server/doc_server_helper_spec.rb
 - spec/server/doc_server_serializer_spec.rb
 - spec/server/rack_adapter_spec.rb
 - spec/server/router_spec.rb
@@ -344,6 +345,7 @@ files:
 - spec/templates/examples/module001.html
 - spec/templates/examples/module001.txt
 - spec/templates/examples/module002.html
+- spec/templates/examples/module003.html
 - spec/templates/examples/tag001.txt
 - spec/templates/helpers/base_helper_spec.rb
 - spec/templates/helpers/html_helper_spec.rb