yard 0.9.20 → 0.9.21

data/samus.json

@@ -0,0 +1,80 @@
+{
+  "actions": [
+    {
+      "action": "fs-sedfiles",
+      "files": ["lib/*/version.rb"],
+      "arguments": {
+        "search": "VERSION = ['\"](.+?)['\"]",
+        "replace": "VERSION = '$version'"
+      }
+    },
+    {
+      "action": "chmod-files",
+      "files": ["**/*,644", "bin/*,755"]
+    },
+    {
+      "action": "changelog-rotate",
+      "files": ["CHANGELOG.md"],
+      "arguments": {
+        "title_format": "$version - %B %-d$day_nth, %Y"
+      }
+    },
+    {
+      "action": "git-commit",
+      "files": ["CHANGELOG.md", "lib/*/version.rb"]
+    },
+    {
+      "action": "git-merge",
+      "arguments": {
+        "branch": "master"
+      }
+    },
+    {
+      "action": "ruby-bundle"
+    },
+    {
+      "action": "rake-task"
+    },
+    {
+      "action": "archive-git-full",
+      "files": ["git.tgz"],
+      "publish": [
+        {
+          "action": "git-push",
+          "credentials": "lsegal.github.ssh",
+          "arguments": {
+            "remotes": "origin",
+            "refs": "master v$version"
+          }
+        }
+      ]
+    },
+    {
+      "action": "gem-build",
+      "files": ["*.gemspec"],
+      "publish": [
+        {
+          "action": "gem-push",
+          "files": ["*.gem"],
+          "credentials": "lsegal.rubygems"
+        }
+      ]
+    },
+    {
+      "action": "changelog-parse",
+      "files": ["CHANGELOG.md"],
+      "publish": [
+        {
+          "action": "github-release",
+          "credentials": "lsegal.github",
+          "files": [],
+          "arguments": {
+            "repository": "lsegal/yard",
+            "tag": "v$version",
+            "changelog": "CHANGELOG.md"
+          }
+        }
+      ]
+    }
+  ]
+}

data/spec/code_objects/base_spec.rb

@@ -84,6 +84,21 @@ RSpec.describe YARD::CodeObjects::Base do
     expect { CodeObjects::Base.new("ROOT!", :Me) }.to raise_error(ArgumentError)
   end
 
+  it "allows constants to be used as a namespace" do
+    a = ConstantObject.new(:root, :A)
+    a.value = "B::C"
+    b = ClassObject.new(:root, :B)
+    c = ClassObject.new(b, :C)
+    klass = ClassObject.new(a, "MyClass")
+    expect(klass.path).to eq "B::C::MyClass"
+  end
+
+  it "does not allow constants to be used as a namespace if they do not resolve to a valid namespace" do
+    a = ConstantObject.new(:root, :A)
+    a.value = "$$INVALID$$"
+    expect { ClassObject.new(a, "MyClass") }.to raise_error(Parser::UndocumentableError)
+  end
+
   it "registers itself in the registry if namespace is supplied" do
     obj = ModuleObject.new(:root, :Me)
     expect(Registry.at(:Me)).to eq obj

data/spec/code_objects/extra_file_object_spec.rb

@@ -103,10 +103,11 @@ RSpec.describe YARD::CodeObjects::ExtraFileObject do
     it "attempts to re-parse data as 8-bit ascii if parsing fails" do
       expect(log).not_to receive(:warn)
       str, out = *([String.new("\xB0")] * 2)
-      if str.respond_to?(:force_encoding)
-        str.force_encoding('utf-8')
-        out.force_encoding('binary')
+      if str.respond_to?(:force_encoding!)
+        str.force_encoding!('utf-8')
+        out.force_encoding!('binary')
       end
+      expect(str.valid_encoding?).to be(false)
       file = ExtraFileObject.new('file.txt', str)
       expect(file.contents).to eq out
     end

data/spec/code_objects/proxy_spec.rb

@@ -4,6 +4,12 @@ require File.dirname(__FILE__) + '/spec_helper'
 RSpec.describe YARD::CodeObjects::Proxy do
   before { Registry.clear }
 
+  it "does not allow constants to be used as a namespace if they do not resolve to a valid namespace" do
+    a = ConstantObject.new(:root, :A)
+    a.value = "$$INVALID$$"
+    expect { P("A::MyClass") }.to raise_error(Parser::UndocumentableError)
+  end
+
   it "returns the object if it's in the Registry" do
     ModuleObject.new(:root, :YARD)
     proxyobj = P(:root, :YARD)

data/spec/handlers/dsl_handler_spec.rb

@@ -67,6 +67,13 @@ RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}DSLHandl
     expect(obj.docstring).to eq 'The foo method'
   end
 
+  it "recognizes methods with no attached source" do
+    obj = Registry.at('Foo#no_src')
+    expect(obj).not_to be nil
+    expect(obj.signature).to eq 'def no_src'
+    expect(obj.source).to eq ''
+  end
+
   it "allows setting of @!scope" do
     expect(Registry.at('Foo.xyz').scope).to eq :class
   end

data/spec/handlers/examples/dsl_handler_001.rb.txt

@@ -79,6 +79,8 @@ class Foo
   # @!method qux2(a, b, c)
   something
 
+  # @!method no_src
+
   # @!macro
   #   $1 $2 $3
   def regular_meth(a, b, c) end

data/spec/handlers/examples/extend_handler_001.rb.txt

@@ -13,4 +13,7 @@ module Q
       extend A
     end
   end
-end
+end
+
+module FromConstant; end
+FromConstant.extend A

data/spec/handlers/examples/mixin_handler_001.rb.txt

@@ -35,3 +35,6 @@ module ABC
     end
   end
 end
+
+module FromConstant; end
+FromConstant.include A

data/spec/handlers/extend_handler_spec.rb

@@ -21,4 +21,8 @@ RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}ExtendHa
   it "does not allow extending self if object is a class" do
     undoc_error "class Foo; extend self; end"
   end
+
+  it "adds mixins from extend calls to constants" do
+    expect(P('FromConstant').class_mixins).to eq [P('A')]
+  end
 end

data/spec/handlers/method_handler_spec.rb

@@ -43,6 +43,30 @@ RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MethodHa
     expect(P('Foo#/').parameters).to eq [['x', "File.new('x', 'w')"], ['y', '2']]
   end
 
+  it "handles multiline parameters" do
+    YARD.parse_string <<-EOF
+      class Bar
+        def multiline_params(x,
+          y, z, zz = 'zz',
+          *foo,
+          a: 'a', b: 'b',
+          c: 'c',
+          **bar,
+          &blk
+        )
+        end
+      end
+    EOF
+
+    sig = "def multiline_params(x, y, z, zz = 'zz', *foo, a: 'a', b: 'b', c: 'c', **bar, &blk)"
+    expect(P('Bar#multiline_params').signature).to eq sig
+  end if YARD.ruby2?
+
+  it "handles method signature with no parameters" do
+    YARD.parse_string "class Bar; def foo; end end"
+    expect(P('Bar#foo').signature).to eq 'def foo'
+  end
+
   it "handles opts = {} as parameter" do
     expect(P('Foo#optsmeth').parameters).to eq [['x', nil], ['opts', '{}']]
   end

data/spec/handlers/mixin_handler_spec.rb

@@ -53,4 +53,8 @@ RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MixinHan
     undoc_error "module X; include invalid, Y; end"
     expect(Registry.at('X').mixins).to eq [P('Y')]
   end
+
+  it "adds mixins from include calls to constants" do
+    expect(P('FromConstant').instance_mixins).to eq [P('A')]
+  end
 end

data/spec/registry_store_spec.rb

@@ -304,6 +304,17 @@ RSpec.describe YARD::RegistryStore do
     end
   end
 
+  describe "#delete" do
+    it "deletes the given object from store" do
+      @store.put(:YARD, @foo)
+      expect(@store.get(:YARD)).to be @foo
+      expect(@store.paths_for_type(:method)).to eq ["YARD"]
+      @store.delete(:YARD)
+      expect(@store.get(:YARD)).to be nil
+      expect(@store.paths_for_type(:method)).to eq []
+    end
+  end
+
   describe "#locale" do
     it "loads ./po/LOCALE_NAME.po" do
       fr_locale = I18n::Locale.new("fr")

data/spec/templates/examples/module001.html

@@ -381,7 +381,7 @@ and newlines.
   
 </h3><div class="docstring">
   <div class="discussion">
-    Returns the value of attribute attr1
+    Returns the value of attribute attr1.
 
   </div>
 </div>
@@ -422,7 +422,7 @@ end</pre>
   
 </h3><div class="docstring">
   <div class="discussion">
-    Returns the value of attribute attr2
+    Returns the value of attribute attr2.
 
   </div>
 </div>
@@ -481,7 +481,7 @@ end</pre>
         <span class="signature">#<strong>attr3</strong>  &#x21d2; <tt>String</tt> </span>
         <div class="docstring">
   <div class="discussion">
-    Returns a string
+    Returns a string.
 
   </div>
 </div>

data/spec/templates/examples/module002.html

@@ -193,7 +193,7 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    Returns the value of attribute foo_attr
+    Returns the value of attribute foo_attr.
 
   </div>
 </div>

data/spec/templates/examples/module003.html

@@ -138,7 +138,7 @@
   
 </h3><div class="docstring">
   <div class="discussion">
-    Returns the value of attribute bar
+    Returns the value of attribute bar.
 
   </div>
 </div>

data/spec/templates/markup_processor_integrations/asciidoctor_spec.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/integration_spec_helper'
+
+RSpec.describe 'Asciidoctor integration' do
+  include_context 'shared helpers for markup processor integration specs'
+  let(:markup) { :asciidoc }
+  let(:markup_provider) { :asciidoctor }
+
+  let(:document) do
+    <<-ASCIIDOC
+== Example code listings
+
+Indented block of Ruby code:
+
+    x = 1
+
+Fenced block of Ruby code:
+
+-----
+x = 2
+-----
+
+Fenced and annotated block of Ruby code:
+
+[source,ruby]
+-----
+x = 3
+-----
+
+Fenced and annotated block of non-Ruby code:
+
+[source,bash]
+-----
+x = 4
+-----
+
+ASCIIDOC
+  end
+
+  it 'renders level 2 header' do
+    expect(rendered_document).to match(header_regexp(2, 'Example code listings'))
+  end
+
+  it 'renders indented block of code, and applies Ruby syntax highlight' do
+    expect(rendered_document).to match(highlighted_ruby_regexp('x', '=', '1'))
+  end
+
+  it 'renders fenced block of code, and applies Ruby syntax highlight' do
+    expect(rendered_document).to match(highlighted_ruby_regexp('x', '=', '2'))
+  end
+
+  it 'renders fenced and annotated block of Ruby code, and applies syntax highlight' do
+    expect(rendered_document).to match(highlighted_ruby_regexp('x', '=', '3'))
+  end
+
+  it 'renders fenced and annotated block of non-Ruby code, and does not apply syntax highlight' do
+    expect(rendered_document).to match('x = 4')
+  end
+end

data/spec/templates/markup_processor_integrations/integration_spec_helper.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+RSpec.shared_context 'shared helpers for markup processor integration specs' do
+  let(:rendered_document) { html_renderer.htmlify document }
+
+  let(:template_options) do
+    Templates::TemplateOptions.new.tap do |o|
+      o.reset_defaults
+      o.default_return = nil
+      o.markup = markup
+      o.markup_provider = markup_provider
+    end
+  end
+
+  let(:html_renderer) do
+    obj = OpenStruct.new
+    obj.options = template_options
+    obj.object = Registry.root
+    obj.extend(Templates::Helpers::HtmlHelper)
+    obj
+  end
+
+  before(:each) do
+    if html_renderer.markup_class(markup).nil?
+      skip "Missing markup renderer #{markup}"
+    end
+  end
+
+  # Works only with one-liners.
+  def highlighted_ruby_regexp(*identifiers)
+    prefix = Regexp.escape '<pre class="code ruby"><code class="ruby">'
+    any_span_tag = '<span\b'
+    escaped_identifiers = identifiers.map {|a| Regexp.escape(a) }
+
+    regexp_parts = [prefix, any_span_tag, escaped_identifiers]
+    regexp_str = regexp_parts.flatten.join(".*")
+    Regexp.compile(regexp_str)
+  end
+
+  def header_regexp(level, text)
+    prefix = "<h#{level}[^>]*?>"
+    escaped_text = Regexp.escape text
+    regexp_str = [prefix, escaped_text].join(".*")
+    Regexp.compile(regexp_str)
+  end
+end

data/spec/templates/markup_processor_integrations/rdoc_markdown_spec.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/integration_spec_helper'
+
+RSpec.describe 'Markdown via RDoc integration' do
+  include_context 'shared helpers for markup processor integration specs'
+  let(:markup) { :markdown }
+  let(:markup_provider) { :rdoc }
+
+  let(:document) do
+    <<-MARKDOWN
+## Example code listings
+
+Indented block of Ruby code:
+
+    x = 1
+
+Fenced block of Ruby code:
+
+```
+x = 2
+```
+
+Fenced and annotated block of Ruby code:
+
+```ruby
+x = 3
+```
+
+Fenced and annotated block of non-Ruby code:
+
+```plain
+x = 4
+```
+
+MARKDOWN
+  end
+
+  it 'renders level 2 header' do
+    expect(rendered_document).to match(header_regexp(2, 'Example code listings'))
+  end
+
+  it 'renders indented block of code, and applies Ruby syntax highlight' do
+    expect(rendered_document).to match(highlighted_ruby_regexp('x', '=', '1'))
+  end
+
+  it 'renders fenced block of code, and applies Ruby syntax highlight' do
+    expect(rendered_document).to match(highlighted_ruby_regexp('x', '=', '2'))
+  end
+
+  it 'renders fenced and annotated block of Ruby code, and applies syntax highlight' do
+    expect(rendered_document).to match(highlighted_ruby_regexp('x', '=', '3'))
+  end
+
+  it 'renders fenced and annotated block of non-Ruby code, and does not apply syntax highlight' do
+    pending 'This is actually highlighted, but it is not a big deal'
+    expect(rendered_document).to match('x = 4')
+  end
+end