yard 0.9.21 → 0.9.26

data/spec/handlers/mixin_handler_spec.rb

@@ -1,60 +0,0 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/spec_helper'
-
-RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}MixinHandler" do
-  before(:all) { parse_file :mixin_handler_001, __FILE__ }
-
-  it "handles includes from classes or modules" do
-    expect(Registry.at(:X).instance_mixins).to include(P(:A))
-    expect(Registry.at(:Y).instance_mixins).to include(P(:A))
-  end
-
-  it "handles includes in class << self" do
-    expect(Registry.at(:Y).class_mixins).to include(P(:A))
-  end
-
-  it "handles includes for modules that don't yet exist" do
-    expect(Registry.at(:X).instance_mixins).to include(P(nil, :NOTEXIST))
-  end
-
-  it "sets the type of non-existing modules to :module" do
-    o = Registry.at(:X).instance_mixins.find {|obj| obj.name == :NOTEXIST }
-    expect(o.type).to eq :module
-  end
-
-  it "handles includes with multiple parameters" do
-    expect(Registry.at(:X)).not_to be nil
-  end
-
-  it "handles complex include statements" do
-    expect(P(:Y).instance_mixins).to include(P('B::C'))
-    expect(P(:Y).instance_mixins).to include(P(:B))
-  end
-
-  it "treats a mixed in Constant by taking its value as the real object name" do
-    expect(P(:Y).instance_mixins).to include(Registry.at('B::D'))
-  end
-
-  it "adds includes in the correct order when include is given multiple arguments" do
-    expect(P(:Z).instance_mixins).to eq [P(:A), P(:B)]
-  end
-
-  it "avoids including self for unresolved mixins of the same name" do
-    expect(P("ABC::DEF::FOO").mixins).to eq [P("ABC::FOO")]
-    expect(P("ABC::DEF::BAR").mixins).to eq [P("ABC::BAR")]
-  end
-
-  it "raises undocumentable error if argument is variable" do
-    undoc_error "module X; include invalid; end"
-    expect(Registry.at('X').mixins).to eq []
-  end
-
-  it "parses all other arguments before erroring out on undocumentable error" do
-    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/handlers/module_function_handler_spec.rb

@@ -1,106 +0,0 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/spec_helper'
-
-RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}VisibilityHandler" do
-  after { Registry.clear }
-
-  def assert_module_function(namespace, name)
-    klass = Registry.at("#{namespace}.#{name}")
-    instance = Registry.at("#{namespace}##{name}")
-    expect(klass).not_to be nil
-    expect(instance).not_to be nil
-    expect(klass).to be_module_function
-    expect(instance).not_to be_module_function
-    expect(klass.visibility).to eq :public
-    expect(instance.visibility).to eq :private
-  end
-
-  it "is able to create a module function with parameters" do
-    YARD.parse_string <<-eof
-      module Foo
-        def bar; end
-        def baz; end
-
-        module_function :bar, :baz
-      end
-    eof
-    assert_module_function('Foo', 'bar')
-    assert_module_function('Foo', 'baz')
-  end
-
-  it "is able to set scope for duration of block without params" do
-    YARD.parse_string <<-eof
-      module Foo
-        def qux; end
-
-        module_function
-
-        def bar; end
-        def baz; end
-      end
-    eof
-    expect(Registry.at('Foo.qux')).to be nil
-    assert_module_function('Foo', 'bar')
-    assert_module_function('Foo', 'baz')
-  end
-
-  # @bug gh-563
-  it "copies tags to module function properly" do
-    YARD.parse_string <<-eof
-      module Foo
-        # @param [String] foo bar
-        # @option foo [String] bar (nil) baz
-        # @return [void]
-        def bar(foo); end
-        module_function :bar
-      end
-    eof
-    assert_module_function('Foo', 'bar')
-    o = Registry.at('Foo.bar')
-    expect(o.tag(:param).types).to eq ['String']
-    expect(o.tag(:param).name).to eq 'foo'
-    expect(o.tag(:param).text).to eq 'bar'
-    expect(o.tag(:option).name).to eq 'foo'
-    expect(o.tag(:option).pair.types).to eq ['String']
-    expect(o.tag(:option).pair.defaults).to eq ['nil']
-    expect(o.tag(:option).pair.text).to eq 'baz'
-    expect(o.tag(:return).types).to eq ['void']
-  end
-
-  it "handles all method names in parameters" do
-    YARD.parse_string <<-eof
-      module Foo
-        def -(t); end
-        def ==(other); end
-        def a?; end
-        module_function :-, '==', :a?
-      end
-    eof
-    assert_module_function('Foo', '-')
-    assert_module_function('Foo', '==')
-    assert_module_function('Foo', 'a?')
-  end
-
-  it "only accepts strings and symbols" do
-    YARD.parse_string <<-eof
-      module Foo
-        module_function name
-        module_function *argument
-        module_function *(method_call)
-      end
-    eof
-    expect(Registry.at('Foo#name')).to be nil
-    expect(Registry.at('Foo#argument')).to be nil
-    expect(Registry.at('Foo#method_call')).to be nil
-  end
-
-  it "handles constants passed in as symbols" do
-    YARD.parse_string <<-eof
-      module Foo
-        def Foo; end
-        module_function :Foo
-      end
-    eof
-    assert_module_function('Foo', 'Foo')
-  end
-end

data/spec/handlers/module_handler_spec.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/spec_helper'
-
-RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}ModuleHandler" do
-  before(:all) { parse_file :module_handler_001, __FILE__ }
-
-  it "parses a module block" do
-    expect(Registry.at(:ModName)).not_to eq nil
-    expect(Registry.at("ModName::OtherModName")).not_to eq nil
-  end
-
-  it "attaches docstring" do
-    expect(Registry.at("ModName::OtherModName").docstring).to eq "Docstring"
-  end
-
-  it "handles any formatting" do
-    expect(Registry.at(:StressTest)).not_to eq nil
-  end
-
-  it "handles complex module names" do
-    expect(Registry.at("A::B")).not_to eq nil
-  end
-
-  it "handles modules in the form ::ModName" do
-    expect(Registry.at("Kernel")).not_to be nil
-  end
-
-  it "lists mixins in proper order" do
-    expect(Registry.at('D').mixins).to eq [P(:C), P(:B), P(:A)]
-  end
-
-  it "creates proper module when constant is in namespace" do
-    expect(Registry.at('Q::FOO::A')).not_to be nil
-  end
-end

data/spec/handlers/private_class_method_handler_spec.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/spec_helper'
-require File.dirname(__FILE__) + '/class_method_handler_shared_examples'
-
-RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}PrivateClassMethodHandler" do
-  before { Registry.clear }
-
-  let(:visibility) { :private }
-
-  include_examples "class method visibility decorator"
-end

data/spec/handlers/private_constant_handler_spec.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/spec_helper'
-
-RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}PrivateConstantHandler" do
-  before(:all) { parse_file :private_constant_handler_001, __FILE__ }
-
-  it "handles private_constant statement" do
-    expect(Registry.at('A::Foo').visibility).to eq :private
-    expect(Registry.at('A::B').visibility).to eq :private
-    expect(Registry.at('A::C').visibility).to eq :private
-  end
-
-  it "makes all other constants public" do
-    expect(Registry.at('A::D').visibility).to eq :public
-  end
-
-  it "fails if parameter is not String, Symbol or Constant" do
-    undoc_error 'class Foo; private_constant x; end'
-    undoc_error 'class Foo; X = 1; private_constant X.new("hi"); end'
-  end unless LEGACY_PARSER
-
-  it "fails if constant can't be recognized" do
-    undoc_error 'class Foo2; private_constant :X end'
-  end
-end

data/spec/handlers/processor_spec.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/spec_helper'
-
-RSpec.describe YARD::Handlers::Processor do
-  before do
-    @proc = Handlers::Processor.new(OpenStruct.new(:parser_type => :ruby))
-  end
-
-  it "starts with public visibility" do
-    expect(@proc.visibility).to eq :public
-  end
-
-  it "starts in instance scope" do
-    expect(@proc.scope).to eq :instance
-  end
-
-  it "starts in root namespace" do
-    expect(@proc.namespace).to eq Registry.root
-  end
-
-  it "has a globals structure" do
-    expect(@proc.globals).to be_a(OpenStruct)
-  end
-
-  it "ignores HandlerAborted exceptions (but print debug info)" do
-    class AbortHandlerProcessor < YARD::Handlers::Ruby::Base
-      process { abort! }
-    end
-    stmt = OpenStruct.new(:line => 1, :show => 'SOURCE')
-    allow(@proc).to receive(:find_handlers).and_return([AbortHandlerProcessor])
-    expect(log).to receive(:debug).with(/AbortHandlerProcessor cancelled from/)
-    expect(log).to receive(:debug).with("\tin file '(stdin)':1:\n\nSOURCE\n")
-    @proc.process([stmt])
-  end
-end

data/spec/handlers/public_class_method_handler_spec.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-require File.dirname(__FILE__) + '/spec_helper'
-require File.dirname(__FILE__) + '/class_method_handler_shared_examples'
-
-RSpec.describe "YARD::Handlers::Ruby::#{LEGACY_PARSER ? "Legacy::" : ""}PublicClassMethodHandler" do
-  before { Registry.clear }
-
-  let(:visibility) { :public }
-
-  include_examples "class method visibility decorator"
-end

data/spec/handlers/ruby/base_spec.rb

@@ -1,95 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe YARD::Handlers::Ruby::Base, '#valid_handler?' do
-  include YARD::Parser::Ruby
-  YARD::Parser::Ruby::AstNode # rubocop:disable Lint/Void
-
-  before do
-    allow(Handlers::Ruby::Base).to receive(:inherited)
-    @processor = Handlers::Processor.new(OpenStruct.new(:parser_type => :ruby))
-  end
-
-  after(:all) do
-    Handlers::Base.clear_subclasses
-  end
-
-  def valid(handler, stmt)
-    expect(@processor.find_handlers(stmt)).to include(handler)
-  end
-
-  def invalid(handler, stmt)
-    expect(@processor.find_handlers(stmt)).not_to include(handler)
-  end
-
-  it "only handles Handlers inherited from Ruby::Base class" do
-    class IgnoredHandler < Handlers::Base
-      handles :list
-    end
-    class NotIgnoredHandler < Handlers::Ruby::Base
-      handles :list
-    end
-    allow(Handlers::Base).to receive(:subclasses).and_return [IgnoredHandler, NotIgnoredHandler]
-    expect(@processor.find_handlers(s)).to eq [NotIgnoredHandler]
-  end
-
-  it "handles string input (matches AstNode#source)" do
-    class StringHandler < Handlers::Ruby::Base
-      handles "x"
-    end
-    allow(Handlers::Base).to receive(:subclasses).and_return [StringHandler]
-    ast = Parser::Ruby::RubyParser.parse("if x == 2 then true end").ast
-    valid StringHandler, ast[0][0][0]
-    invalid StringHandler, ast[0][1]
-  end
-
-  it "handles symbol input (matches AstNode#type)" do
-    class SymbolHandler < Handlers::Ruby::Base
-      handles :myNodeType
-    end
-    allow(Handlers::Base).to receive(:subclasses).and_return [SymbolHandler]
-    valid SymbolHandler, s(:myNodeType, s(1, 2, 3))
-    invalid SymbolHandler, s(:NOTmyNodeType, s(1, 2, 3))
-  end
-
-  it "handles regex input (matches AstNode#source)" do
-    class RegexHandler < Handlers::Ruby::Base
-      handles(/^if x ==/)
-    end
-    allow(Handlers::Base).to receive(:subclasses).and_return [RegexHandler]
-    ast = Parser::Ruby::RubyParser.parse("if x == 2 then true end").ast
-    valid RegexHandler, ast
-    invalid RegexHandler, ast[0][1]
-  end
-
-  it "handles AstNode input (matches AST literally)" do
-    class ASTHandler < Handlers::Ruby::Base
-      handles s(:vcall, s(:ident, "hello_world"))
-    end
-    allow(Handlers::Base).to receive(:subclasses).and_return [ASTHandler]
-    valid ASTHandler, s(:vcall, s(:ident, "hello_world"))
-    invalid ASTHandler, s(:vcall, s(:ident, "NOTHELLOWORLD"))
-  end
-
-  it "handles #method_call(:methname) on a valid AST" do
-    class MethCallHandler < Handlers::Ruby::Base
-      handles method_call(:meth)
-    end
-    allow(Handlers::Base).to receive(:subclasses).and_return [MethCallHandler]
-    ast = Parser::Ruby::RubyParser.parse(<<-"eof").ast
-      meth                   # 0
-      meth()                 # 1
-      meth(1,2,3)            # 2
-      meth 1,2,3             # 3
-      NotMeth.meth           # 4
-      NotMeth.meth { }       # 5
-      NotMeth.meth do end    # 6
-      NotMeth.meth 1, 2, 3   # 7
-      NotMeth.meth(1, 2, 3)  # 8
-      NotMeth                # 9
-    eof
-    (0..8).each do |i|
-      valid MethCallHandler, ast[i]
-    end
-    invalid MethCallHandler, ast[9]
-  end
-end if HAVE_RIPPER

data/spec/handlers/ruby/legacy/base_spec.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-include Parser::Ruby::Legacy
-
-RSpec.describe YARD::Handlers::Ruby::Legacy::Base, "#handles and inheritance" do
-  before do
-    allow(Handlers::Ruby::Legacy::Base).to receive(:inherited)
-    if RUBY_VERSION > '1.8.7'
-      allow(Handlers::Ruby::Legacy::MixinHandler).to receive(:inherited) # fixes a Ruby1.9 issue
-    end
-    @processor = Handlers::Processor.new(OpenStruct.new(:parser_type => :ruby18))
-  end
-
-  after(:all) do
-    Handlers::Base.clear_subclasses
-  end
-
-  def stmt(string)
-    Statement.new(TokenList.new(string))
-  end
-
-  it "only handles Handlers inherited from Ruby::Legacy::Base class" do
-    class IgnoredHandler < Handlers::Base
-      handles "hello"
-    end
-    class NotIgnoredHandlerLegacy < Handlers::Ruby::Legacy::Base
-      handles "hello"
-    end
-    allow(Handlers::Base).to receive(:subclasses).and_return [IgnoredHandler, NotIgnoredHandlerLegacy]
-    expect(@processor.find_handlers(stmt("hello world"))).to eq [NotIgnoredHandlerLegacy]
-  end
-
-  it "handles a string input" do
-    class TestStringHandler < Handlers::Ruby::Legacy::Base
-      handles "hello"
-    end
-
-    expect(TestStringHandler.handles?(stmt("hello world"))).to be true
-    expect(TestStringHandler.handles?(stmt("nothello world"))).to be false
-  end
-
-  it "handles regex input" do
-    class TestRegexHandler < Handlers::Ruby::Legacy::Base
-      handles(/^nothello$/)
-    end
-
-    expect(TestRegexHandler.handles?(stmt("nothello"))).to be true
-    expect(TestRegexHandler.handles?(stmt("not hello hello"))).to be false
-  end
-
-  it "handles token input" do
-    class TestTokenHandler < Handlers::Ruby::Legacy::Base
-      handles TkMODULE
-    end
-
-    expect(TestTokenHandler.handles?(stmt("module"))).to be true
-    expect(TestTokenHandler.handles?(stmt("if"))).to be false
-  end
-
-  it "parses a do/end or { } block with #parse_block" do
-    class MyBlockHandler < Handlers::Ruby::Legacy::Base
-      handles(/\AmyMethod\b/)
-      def process
-        parse_block(:owner => "test")
-      end
-    end
-
-    class MyBlockInnerHandler < Handlers::Ruby::Legacy::Base
-      handles "inner"
-      def self.reset; @@reached = false end
-      def self.reached?; @@reached ||= false end
-      def process; @@reached = true end
-    end
-
-    allow(Handlers::Base).to receive(:subclasses).and_return [MyBlockHandler, MyBlockInnerHandler]
-    Parser::SourceParser.parser_type = :ruby18
-    Parser::SourceParser.parse_string "myMethod do inner end"
-    expect(MyBlockInnerHandler).to be_reached
-    MyBlockInnerHandler.reset
-    Parser::SourceParser.parse_string "myMethod { inner }"
-    expect(MyBlockInnerHandler).to be_reached
-    Parser::SourceParser.parser_type = :ruby
-  end
-end