yard 0.9.0 → 0.9.1

data/spec/templates/examples/constant001.txt

@@ -5,8 +5,8 @@ DEFAULT_SEARCH_PATHS = []
 ------------------------------------------------------------------------
 
     Default search paths that should be loaded dynamically into YRI.
-    These paths take precedence over all other paths
-    ({SEARCH_PATHS_FILE} and RubyGems paths). To add a path, call: 
+    These paths take precedence over all other paths (SEARCH_PATHS_FILE
+    and RubyGems paths). To add a path, call: 
     
       DEFAULT_SEARCH_PATHS.push("/path/to/.yardoc")
 

data/spec/templates/helpers/html_helper_spec.rb

@@ -148,7 +148,14 @@ describe YARD::Templates::Helpers::HtmlHelper do
       load_markup_provider(:rdoc)
       expect(File).to receive(:file?).with('foo.rdoc').and_return(true)
       expect(File).to receive(:read).with('foo.rdoc').and_return('HI')
-      expect(htmlify("{include:file:foo.rdoc}", :rdoc).gsub(/\s+/, '')).to eq "<p><p>HI</p></p>"
+      expect(htmlify("{include:file:foo.rdoc}", :rdoc).gsub(/\s+/, '')).to eq "<p>HI</p>"
+    end
+
+    it "allows inline includes for {include:} in the middle of a line" do
+      load_markup_provider(:rdoc)
+      expect(File).to receive(:file?).with('foo.rdoc').and_return(true)
+      expect(File).to receive(:read).with('foo.rdoc').and_return('HI')
+      expect(htmlify("test {include:file:foo.rdoc}", :rdoc).gsub(/[\r?\n]+/, '')).to eq '<p>test HI</p>'
     end
 
     it "autolinks URLs (markdown specific)" do

data/spec/templates/helpers/module_helper_spec.rb

@@ -0,0 +1,35 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe YARD::Templates::Helpers::ModuleHelper do
+  include YARD::Templates::Helpers::BaseHelper
+  include YARD::Templates::Helpers::ModuleHelper
+
+  describe "#prune_method_listing" do
+    before { YARD::Registry.clear }
+    let(:options) { OpenStruct.new }
+    let(:object) { YARD::Registry.at("Foo#bar") }
+    let(:objects) { [object] }
+
+    it "filters aliases" do
+      YARD.parse_string "class Foo; def orig; end; alias bar orig end"
+      expect(prune_method_listing(objects)).to eq []
+    end
+
+    it "filters attributes" do
+      YARD.parse_string "class Foo; attr_accessor :bar end"
+      expect(prune_method_listing(objects)).to eq []
+    end
+
+    it "ignores methods if namespace object is filtered" do
+      YARD.parse_string <<-eof
+        # @author test
+        class Foo
+          def bar; end
+        end
+      eof
+
+      options.verifier = YARD::Verifier.new('@author.text != "test"')
+      expect(prune_method_listing(objects)).to eq []
+    end
+  end
+end

data/spec/templates/helpers/text_helper_spec.rb

@@ -2,6 +2,7 @@ require File.dirname(__FILE__) + '/../../spec_helper'
 require File.dirname(__FILE__) + "/shared_signature_examples"
 
 describe YARD::Templates::Helpers::TextHelper do
+  include YARD::Templates::Helpers::BaseHelper
   include YARD::Templates::Helpers::TextHelper
   include YARD::Templates::Helpers::MethodHelper
 
@@ -41,4 +42,23 @@ describe YARD::Templates::Helpers::TextHelper do
       expect(align_right(text)).to eq ' ' + text[0,68] + '...'
     end
   end
+
+  describe "#h" do
+    let(:object) do
+      o = YARD::CodeObjects::MethodObject.new(:root, :foo, :instance)
+      o.tap {|o| o.docstring = "test" }
+    end
+
+    it "resolves links" do
+      expect(h("{include:#foo} 1 2 3").strip).to eq "test 1 2 3"
+    end
+
+    it "uses title when present" do
+      expect(h("{A b}").strip).to eq "b"
+    end
+
+    it "uses object name when no title is present" do
+      expect(h("{A}").strip).to eq "A"
+    end
+  end
 end

data/templates/default/module/setup.rb

@@ -55,7 +55,7 @@ def attr_listing
   object.inheritance_tree(true).each do |superclass|
     next if superclass.is_a?(CodeObjects::Proxy)
     next if options.embed_mixins.size > 0 &&
-      options.embed_mixins_match?(superclass) == false
+      !options.embed_mixins_match?(superclass)
     [:class, :instance].each do |scope|
       superclass.attributes[scope].each do |name, rw|
         attr = prune_method_listing([rw[:read], rw[:write]].compact, false).first

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-04 00:00:00.000000000 Z
+date: 2016-07-18 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.
@@ -98,6 +98,7 @@ files:
 - lib/yard/code_objects/macro_object.rb
 - lib/yard/code_objects/method_object.rb
 - lib/yard/code_objects/module_object.rb
+- lib/yard/code_objects/namespace_mapper.rb
 - lib/yard/code_objects/namespace_object.rb
 - lib/yard/code_objects/proxy.rb
 - lib/yard/code_objects/root_object.rb
@@ -193,6 +194,7 @@ files:
 - lib/yard/parser/source_parser.rb
 - lib/yard/rake/yardoc_task.rb
 - lib/yard/registry.rb
+- lib/yard/registry_resolver.rb
 - lib/yard/registry_store.rb
 - lib/yard/rubygems/backports.rb
 - lib/yard/rubygems/backports/LICENSE.txt
@@ -200,6 +202,7 @@ files:
 - lib/yard/rubygems/backports/gem.rb
 - lib/yard/rubygems/backports/source_index.rb
 - lib/yard/rubygems/doc_manager.rb
+- lib/yard/rubygems/hook.rb
 - lib/yard/rubygems/specification.rb
 - lib/yard/serializers/base.rb
 - lib/yard/serializers/file_system_serializer.rb
@@ -215,6 +218,7 @@ files:
 - lib/yard/server/commands/library_command.rb
 - lib/yard/server/commands/library_index_command.rb
 - lib/yard/server/commands/list_command.rb
+- lib/yard/server/commands/root_request_command.rb
 - lib/yard/server/commands/search_command.rb
 - lib/yard/server/commands/static_file_command.rb
 - lib/yard/server/doc_server_helper.rb
@@ -400,7 +404,6 @@ files:
 - spec/server/adapter_spec.rb
 - 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
@@ -448,6 +451,7 @@ files:
 - spec/templates/helpers/markup/rdoc_markup_spec.rb
 - spec/templates/helpers/markup_helper_spec.rb
 - spec/templates/helpers/method_helper_spec.rb
+- spec/templates/helpers/module_helper_spec.rb
 - spec/templates/helpers/shared_signature_examples.rb
 - spec/templates/helpers/text_helper_spec.rb
 - spec/templates/method_spec.rb
@@ -611,4 +615,3 @@ signing_key:
 specification_version: 4
 summary: Documentation tool for consistent and usable documentation in Ruby.
 test_files: []
-has_rdoc: yard

data/spec/server/commands/static_file_command_spec.rb

@@ -1,84 +0,0 @@
-require File.dirname(__FILE__) + '/../spec_helper'
-
-describe YARD::Server::Commands::StaticFileCommand do
-  before do
-    adapter = mock_adapter
-    adapter.document_root = '/c'
-    @cmd = StaticFileCommand.new(:adapter => adapter)
-  end
-
-  describe "#run" do
-    def run(path, status = nil, body = nil)
-      s, h, b = *@cmd.call(mock_request(path))
-      expect(body).to eq b.first if body
-      expect(status).to eq s if status
-      [s, h, b]
-    end
-
-    it "searches through document root before static paths" do
-      expect(File).to receive(:exist?).with('/c/path/to/file.txt').ordered.and_return(false)
-      StaticFileCommand::STATIC_PATHS.reverse.each do |path|
-        expect(File).to receive(:exist?).with(File.join(path, 'path/to/file.txt')).ordered.and_return(false)
-      end
-      run '/path/to/file.txt'
-    end
-
-    it "returns file contents if found" do
-      tpl = Templates::Engine.template(:default, :fulldoc, :html)
-      expect(File).to receive(:exist?).with('/c/path/to/file.txt').and_return(false)
-      expect(tpl).to receive(:find_file).with('/path/to/file.txt').and_return('/path/to/foo')
-      expect(File).to receive(:read).with('/path/to/foo').and_return('FOO')
-      run('/path/to/file.txt', 200, 'FOO')
-    end
-
-    it "allows registering of new paths and use those before other static paths" do
-      Server.register_static_path '/foo'
-      path = '/foo/path/to/file.txt'
-      expect(File).to receive(:exist?).with('/c/path/to/file.txt').and_return(false)
-      expect(File).to receive(:exist?).with(path).and_return(true)
-      expect(File).to receive(:read).with(path).and_return('FOO')
-      run('/path/to/file.txt', 200, 'FOO')
-    end
-
-    it "does not use registered path before docroot" do
-      Server.register_static_path '/foo'
-      path = '/foo/path/to/file.txt'
-      expect(File).to receive(:exist?).with('/c/path/to/file.txt').and_return(true)
-      expect(File).to receive(:read).with('/c/path/to/file.txt').and_return('FOO')
-      run('/c/path/to/file.txt', 200, 'FOO')
-    end
-
-    it "returns 404 if not found" do
-      expect(File).to receive(:exist?).with('/c/path/to/file.txt').ordered.and_return(false)
-      StaticFileCommand::STATIC_PATHS.reverse.each do |path|
-        expect(File).to receive(:exist?).with(File.join(path, 'path/to/file.txt')).ordered.and_return(false)
-      end
-      run('/path/to/file.txt', 404)
-    end
-
-    it "returns text/html for file with no extension" do
-      expect(File).to receive(:exist?).with('/c/file').and_return(true)
-      expect(File).to receive(:read).with('/c/file')
-      s, h, b = *run('/file')
-      expect(h['Content-Type']).to eq 'text/html'
-    end
-
-    {
-      "js" => "text/javascript",
-      "css" => "text/css",
-      "png" => "image/png",
-      "gif" => "image/gif",
-      "htm" => "text/html",
-      "html" => "text/html",
-      "txt" => "text/plain",
-      "unknown" => "application/octet-stream"
-    }.each do |ext, mime|
-      it "serves file.#{ext} as #{mime}" do
-        expect(File).to receive(:exist?).with('/c/file.' + ext).and_return(true)
-        expect(File).to receive(:read).with('/c/file.' + ext)
-        s, h, b = *run('/file.' + ext)
-        expect(h['Content-Type']).to eq mime
-      end
-    end
-  end
-end