yard 0.9.24 → 0.9.25

data/spec/templates/helpers/text_helper_spec.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + "/shared_signature_examples"
-
-RSpec.describe YARD::Templates::Helpers::TextHelper do
-  include YARD::Templates::Helpers::BaseHelper
-  include YARD::Templates::Helpers::TextHelper
-  include YARD::Templates::Helpers::MethodHelper
-
-  describe "#signature" do
-    before do
-      @results = {
-        :regular => "root.foo -> Object",
-        :default_return => "root.foo -> Hello",
-        :no_default_return => "root.foo",
-        :private_class => "A.foo -> Object (private)",
-        :single => "root.foo -> String",
-        :two_types => "root.foo -> (String, Symbol)",
-        :two_types_multitag => "root.foo -> (String, Symbol)",
-        :type_nil => "root.foo -> Type?",
-        :type_array => "root.foo -> Type+",
-        :multitype => "root.foo -> (Type, ...)",
-        :void => "root.foo -> void",
-        :hide_void => "root.foo",
-        :block => "root.foo {|a, b, c| ... } -> Object",
-        :empty_overload => 'root.foobar -> String'
-      }
-    end
-
-    def signature(obj) super(obj).strip end
-
-    it_should_behave_like "signature"
-  end
-
-  describe "#align_right" do
-    it "aligns text right" do
-      text = "Method: #some_method (SomeClass)"
-      expect(align_right(text)).to eq ' ' * 40 + text
-    end
-
-    it "truncates text that is longer than allowed width" do
-      text = "(Defined in: /home/user/.rip/.packages/some_gem-2460672e333ac07b9190ade88ec9a91c/long/path.rb)"
-      expect(align_right(text)).to eq ' ' + text[0, 68] + '...'
-    end
-  end
-
-  describe "#h" do
-    let(:object) do
-      YARD::CodeObjects::MethodObject.new(:root, :foo, :instance).tap do |o|
-        o.docstring = "test"
-      end
-    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/spec/templates/markup_processor_integrations/asciidoctor_spec.rb

@@ -1,60 +0,0 @@
-# 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

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.shared_context 'shared helpers for markup processor integration specs' do
-  after do
-    YARD::Templates::Helpers::MarkupHelper.clear_markup_cache
-  end
-
-  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

@@ -1,48 +0,0 @@
-# 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
-```
-
-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
-end

data/spec/templates/markup_processor_integrations/rdoc_spec.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require File.dirname(__FILE__) + '/integration_spec_helper'
-
-RSpec.describe 'RDoc integration' do
-  include_context 'shared helpers for markup processor integration specs'
-  let(:markup) { :rdoc }
-  # Must be nil as this is how this provider is defined.
-  # See: https://github.com/lsegal/yard/commit/6634ae25878cd4fcb79.
-  let(:markup_provider) { nil }
-
-  let(:document) do
-    <<-RDOC
-== Example code listings
-
-Verbatim block of Ruby code:
-
-  x = 1
-
-Verbatim non-Ruby block:
-
-  This has nothing to do with Ruby.
-
-RDOC
-  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 indented block of text which is not a piece of Ruby code, ' \
-    'and does not apply syntax highlight' do
-    expect(rendered_document).to match('This has nothing to do with Ruby.')
-  end
-end

data/spec/templates/markup_processor_integrations/redcarpet_spec.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require File.dirname(__FILE__) + '/integration_spec_helper'
-
-RSpec.describe 'Redcarpet integration' do
-  include_context 'shared helpers for markup processor integration specs'
-  let(:markup) { :markdown }
-  let(:markup_provider) { :redcarpet }
-
-  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
-    expect(rendered_document).to match('x = 4')
-  end
-
-  it "autolinks URLs" do
-    expect(html_renderer.htmlify('http://example.com', :markdown).chomp.gsub('&#47;', '/')).to eq(
-      '<p><a href="http://example.com">http://example.com</a></p>'
-    )
-  end
-end

data/spec/templates/markup_processor_integrations/redcloth_spec.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require File.dirname(__FILE__) + '/integration_spec_helper'
-
-# Hack to fix RedCloth compat issues with MinGW compilation hosts
-begin
-  require 'redcloth'
-rescue LoadError
-  require 'rbconfig'
-  RbConfig::CONFIG['arch'] = 'not_windows_dont_worry'
-end
-
-RSpec.describe 'RedCloth integration' do
-  include_context 'shared helpers for markup processor integration specs'
-  let(:markup) { :textile }
-  let(:markup_provider) { :redcloth }
-
-  let(:document) do
-    <<-TEXTILE
-h2. Example code listings
-
-Example paragraph.
-
-p. Example paragraph using 'p' tag.
-
-p. Block of Ruby code using 'bc' tag:
-
-bc. x = 1
-
-p. Block of Ruby code using 'pre' tag:
-
-pre. x = 2
-TEXTILE
-  end
-
-  it 'renders level 2 header' do
-    expect(rendered_document).to match(header_regexp(2, 'Example code listings'))
-  end
-
-  it 'renders paragraphs' do
-    expect(rendered_document).
-      to include('<p>Example paragraph.</p>')
-    # Textile may replace typewriter apostrophes here used as quotes with
-    # something typographically better
-    expect(rendered_document).
-      to match(%r{<p>Example paragraph using .*p.* tag.</p>})
-  end
-
-  it 'renders bc. block, and applies Ruby syntax highlight' do
-    expect(rendered_document).to match(highlighted_ruby_regexp('x', '=', '1'))
-  end
-
-  it 'renders pre. block, and applies Ruby syntax highlight' do
-    expect(rendered_document).to match(highlighted_ruby_regexp('x', '=', '2'))
-  end
-
-  it "does not use hard breaks for newlines" do
-    expect(html_renderer.htmlify("A\nB", :textile)).not_to include("<br")
-  end
-
-  it "uses hard breaks for newlines with textile_strict" do
-    expect(html_renderer.htmlify("A\nB", :textile_strict)).to include("<br")
-  end
-end

data/spec/templates/method_spec.rb

@@ -1,118 +0,0 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/spec_helper'
-
-# $COPY = :method001
-# $COPYT = :html
-
-RSpec.describe YARD::Templates::Engine.template(:default, :method) do
-  before { Registry.clear }
-
-  shared_examples_for "all formats" do
-    it "renders html format correctly" do
-      html_equals(Registry.at('#m').format(html_options), @template)
-    end
-
-    it "renders text format correctly" do
-      text_equals(Registry.at('#m').format(text_options), @template)
-    end
-  end
-
-  describe "regular (deprecated) method" do
-    before do
-      @template = :method001
-      YARD.parse_string <<-'eof'
-        private
-        # Comments
-        # @param [Hash] x the x argument
-        # @option x [String] :key1 (default) first key
-        # @option x [Symbol] :key2 second key
-        # @return [String] the result
-        # @raise [Exception] hi!
-        # @deprecated for great justice
-        def m(x) end
-        alias x m
-      eof
-    end
-
-    it_should_behave_like "all formats"
-  end
-
-  describe "method with 1 overload" do
-    before do
-      @template = :method002
-      YARD.parse_string <<-'eof'
-        private
-        # Comments
-        # @overload m(x, y)
-        #   @param [String] x parameter x
-        #   @param [Boolean] y parameter y
-        def m(x) end
-      eof
-    end
-
-    it_should_behave_like "all formats"
-  end
-
-  describe "method with 2 overloads" do
-    before do
-      @template = :method003
-      YARD.parse_string <<-'eof'
-        private
-        # Method comments
-        # @overload m(x, y)
-        #   Overload docstring
-        #   @param [String] x parameter x
-        #   @param [Boolean] y parameter y
-        # @overload m(x, y, z)
-        #   @param [String] x parameter x
-        #   @param [Boolean] y parameter y
-        #   @param [Boolean] z parameter z
-        def m(*args) end
-      eof
-    end
-
-    it_should_behave_like "all formats"
-  end
-
-  describe "method void return" do
-    before do
-      @template = :method004
-      YARD.parse_string <<-'eof'
-        # @return [void]
-        def m(*args) end
-      eof
-    end
-
-    it_should_behave_like "all formats"
-  end
-
-  describe "method void return in an overload" do
-    before do
-      @template = :method005
-      YARD.parse_string <<-'eof'
-        # @overload m(a)
-        #   @return [void]
-        # @overload m(b)
-        #   @param [String] b hi
-        def m(*args) end
-      eof
-    end
-
-    it_should_behave_like "all formats"
-  end
-
-  describe "method with keyword arguments" do
-    before do
-      @template = :method006
-      YARD.parse_string <<-'eof'
-        # @param [String] x the x argument
-        # @param [Boolean] y the y argument
-        # @param [kword1] keyword 1
-        # @param [kword2] keyword 2
-        def m(x, y, *args, kword1: 123, kword2:, **) end
-      eof
-    end
-
-    it_should_behave_like "all formats"
-  end if RUBY_VERSION >= "2.1"
-end