yard 0.9.23 → 0.9.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 484d7d1eba166d665522d156cf729726c9398f422785cb6151291e91489408fe
-  data.tar.gz: 96bdb186472b35313799c19852f9ff1dbb00a294f1748eb310555a2a0e074cb6
+  metadata.gz: 53bb10d04117e8e6b53dc07a0b93520b0a08b713a77588254c85dfeec52ace67
+  data.tar.gz: 4945cd96795da8c07ef2eb571536ba0ad5f6a9a0f185717c6ba20943e5cc3153
 SHA512:
-  metadata.gz: 4e1b559f847bda1e1554f000be7734797511abedb1b1dec1cb94d7392cce11d66397f39d25257de07a8681eb92ce2e9256df47c57e15d9a68a835c7c6154b91b
-  data.tar.gz: e7e0bdccc9f896f459bed1dbeb3ea37d1b373c9a0c9a05a624d84ecfeba1b7fbceda87ba6576df96b13649f1969733316ce499c234003c101ef7a93ca914b153
+  metadata.gz: 50ee44093b616fddc463b77168111c4c5047995a83582968792c9bab6ec4ace104ccd074397e4925c7fbe5e2c2c273413c9163a00ad016a3c4a895d433b0b1d4
+  data.tar.gz: 824c71f1724f55ccc7f4a0e98e69df583d0f553ae908ec75fe1d080b596e1bed028c12d6d422f3a9841a5b50e07394cd2059c4412a91c48efb23840977346f44

data/.github/workflows/ci.yml

@@ -0,0 +1,30 @@
+name: Unit Tests
+
+on: [push, pull_request]
+jobs:
+  build:
+    name: "Ruby: ${{ matrix.ruby }} OS: ${{ matrix.os }}"
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, windows-latest, ubuntu-latest]
+        ruby: ["2.4", "2.5", "2.6", "2.7"]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Select Ruby Version
+        uses: eregon/use-ruby-action@master
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          base: update
+      - name: Update RubyGems & Bundler
+        run: gem update --system --no-document --conservative
+      - name: Install Dependencies
+        run: bundle install --jobs=3 --retry=3
+      - name: Run Test
+        run: |
+          ruby -v
+          bundle exec rake
+        env:
+          CI: true

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # master
 
+# 0.9.24 - January 8th, 2020
+
+[0.9.24]: https://github.com/lsegal/yard/compare/v0.9.23...v0.9.24
+
+- Add {YARD::CodeObjects::NamespaceMapper.on_invalidate} callback when separator
+  cache is changed.
+- Fix issue where Registry fails to resolve first-time lookups on instance methods.
+
 # 0.9.23 - January 5th, 2020
 
 [0.9.23]: https://github.com/lsegal/yard/compare/v0.9.22...v0.9.23

data/Gemfile

@@ -16,11 +16,11 @@ group :asciidoc do
 end
 
 group :markdown do
-  gem 'redcarpet', :platforms => [:ruby]
+  gem 'redcarpet'
 end
 
 group :textile do
-  gem 'RedCloth', :platforms => [:ruby]
+  gem 'RedCloth'
 end
 
 group :server do

data/lib/yard/code_objects/namespace_mapper.rb

@@ -11,6 +11,9 @@ module YARD
       # Registers a separator with an optional set of valid types that
       # must follow the separator lexically.
       #
+      # Calls all callbacks defined by {NamespaceMapper.on_invalidate} after
+      # the separator is registered.
+      #
       # @param sep [String] the separator string for the namespace
       # @param valid_types [Array<Symbol>] a list of object types that
       #   must follow the separator. If the list is empty, any type can
@@ -20,6 +23,7 @@ module YARD
       #   register_separator "#", :method
       #   # Anything after a "." denotes a method object
       #   register_separator ".", :method
+      # @see .on_invalidate
       def register_separator(sep, *valid_types)
         NamespaceMapper.invalidate
 
@@ -32,6 +36,19 @@ module YARD
         NamespaceMapper.map[sep] += valid_types
       end
 
+      # Unregisters a separator by a type.
+      #
+      # @param type [Symbol] the type to unregister
+      # @see #register_separator
+      def unregister_separator_by_type(type)
+        seps = NamespaceMapper.rev_map[type]
+        return unless seps
+        
+        seps.each {|s| NamespaceMapper.map.delete(s) }
+        NamespaceMapper.rev_map.delete(type)
+        NamespaceMapper.invalidate
+      end
+
       # Clears the map of separators.
       #
       # @return [void]
@@ -50,6 +67,7 @@ module YARD
       #   default_separator "::"
       def default_separator(value = nil)
         if value
+          NamespaceMapper.invalidate
           NamespaceMapper.default_separator = Regexp.quote value
         else
           NamespaceMapper.default_separator
@@ -71,17 +89,25 @@ module YARD
       # @param sep [String] the separator to return types for
       # @return [Array<Symbol>] a list of types registered to a separator
       def types_for_separator(sep)
-        NamespaceMapper.map[sep]
+        NamespaceMapper.map[sep] || []
       end
 
       # @param type [String] the type to return separators for
       # @return [Array<Symbol>] a list of separators registered to a type
       def separators_for_type(type)
-        NamespaceMapper.rev_map[type]
+        NamespaceMapper.rev_map[type] || []
       end
 
       # Internal methods to act as a singleton registry
       class << self
+        # @!group Invalidation callbacks
+
+        # Adds a callback that triggers when a new separator is registered or
+        # the cache is cleared by invalidation.
+        def on_invalidate(&block)
+          (@invalidation_callbacks ||= []).push(block)
+        end
+
         # @!visibility private
 
         # @return [Hash] a mapping of types to separators
@@ -98,11 +124,12 @@ module YARD
         # @return [void]
         def invalidate
           @map_match = nil
+          (@invalidation_callbacks || []).each(&:call)
         end
 
         # @return [Regexp] the full list of separators as a regexp match
         def map_match
-          @map_match ||= @map.keys.map {|k| Regexp.quote k }.join('|')
+          @map_match ||= map.keys.map {|k| Regexp.quote k }.join('|')
         end
 
         # @return [String] the default separator when no separator can begin

data/lib/yard/parser/ruby/token_resolver.rb

@@ -7,6 +7,7 @@ module YARD
       # constant or identifier token.
       class TokenResolver
         include Enumerable
+        include CodeObjects::NamespaceMapper
 
         # Creates a token resolver for given source.
         #
@@ -114,7 +115,8 @@ module YARD
 
           if toktype == :const
             types.any? do |type|
-              prefix = (type ? type.path : "") + last_sep.to_s
+              prefix = type ? type.path : ""
+              prefix += last_sep.to_s if separators.include?(last_sep.to_s)
               self.object = Registry.resolve(@default_namespace, "#{prefix}#{name}", true)
             end
           else # ident

data/lib/yard/registry_resolver.rb

@@ -16,6 +16,9 @@ module YARD
     def initialize(registry = Registry)
       @registry = registry
       @default_sep = nil
+
+      # Preload all code objects for separator declarations
+      YARD::CodeObjects.constants.map {|t| YARD::CodeObjects.const_get(t) }
     end
 
     # Performs a lookup on a given path in the registry. Resolution will occur
@@ -186,46 +189,29 @@ module YARD
       nss
     end
 
-    # @see NamespaceMapper#register_separator
-    def register_separator(*)
-      super
-      invalidate_memoized_matchers
-    end
-
-    # @see NamespaceMapper#clear_separators
-    def clear_separators
-      super
-      invalidate_memoized_matchers
-    end
-
-    # @see NamespaceMapper#default_separator
-    def default_separator(value = nil)
-      @starts_with_default_separator_match = nil if value
-      super
-    end
-
     # @return [Regexp] the regexp match of the default separator
     def starts_with_default_separator_match
-      @starts_with_default_separator_match ||= /\A#{default_separator}/
+      @@starts_with_default_separator_match ||= /\A#{default_separator}/
     end
 
     # @return [Regexp] the regexp that matches strings starting with
     #   a separator
     def starts_with_separator_match
-      @starts_with_separator_match ||= /\A(#{separators_match})/
+      @@starts_with_separator_match ||= /\A(#{separators_match})/
     end
 
     # @return [Regexp] the regexp that can be used to split a string on all
     #   occurrences of separator tokens
     def split_on_separators_match
-      @split_on_separators_match ||= /(.+?)(#{separators_match}|$)/
+      @@split_on_separators_match ||= /(.+?)(#{separators_match}|$)/
     end
 
     # Additional invalidations to done when NamespaceMapper API methods are
     # called on this class
-    def invalidate_memoized_matchers
-      @starts_with_separator_match = nil
-      @split_on_separators_match = nil
+    YARD::CodeObjects::NamespaceMapper.on_invalidate do
+      @@starts_with_default_separator_match = nil
+      @@starts_with_separator_match = nil
+      @@split_on_separators_match = nil
     end
   end
 end

data/lib/yard/serializers/yardoc_serializer.rb

@@ -77,7 +77,7 @@ module YARD
               p.gsub(/[^\w\.-]/) do |x|
                 encoded = '_'
 
-                x.each_byte {|b| encoded << ("%X" % b) }
+                x.each_byte {|b| encoded += ("%X" % b) }
                 encoded
               end
             end.join('/') + '.' + extension

data/lib/yard/version.rb

@@ -2,5 +2,5 @@
 # frozen_string_literal: true
 
 module YARD
-  VERSION = '0.9.23'
+  VERSION = '0.9.24'
 end

data/spec/code_objects/namespace_mapper_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+require File.dirname(__FILE__) + '/spec_helper'
+
+RSpec.describe YARD::CodeObjects::NamespaceMapper do
+  include YARD::CodeObjects::NamespaceMapper
+
+  describe '#register_separator' do
+    it 'should allow separators to be registered' do
+      register_separator '!', :test_type
+
+      expect(separators_for_type(:test_type)).to eq ['!']
+      expect(types_for_separator('!')).to eq [:test_type]
+
+      unregister_separator_by_type :test_type
+
+      expect(separators_for_type(:test_type)).to be_empty
+      expect(types_for_separator('!')).to be_empty
+    end
+  end
+
+  describe '.on_invalidate' do
+    it 'receives a callback when a new separator is added' do
+      invalidated = false
+      NamespaceMapper.on_invalidate { invalidated = true }
+
+      register_separator '!', :test_type
+      expect(invalidated).to be true
+
+      unregister_separator_by_type :test_type
+    end
+  end
+end

data/spec/parser/ruby/ruby_parser_spec.rb

@@ -504,5 +504,17 @@ eof
     it "handles compile errors" do
       expect { stmt(":~$ Do not clobber") }.to raise_error(Parser::ParserSyntaxError)
     end
+
+    it "handles cls/mod comments without line spacing" do
+      ast = stmt <<-eof
+        module A
+          # comment 1
+          # comment 2
+          class B
+          end
+        end
+      eof
+      expect(ast.jump(:class).docstring).to eq "comment 1\ncomment 2"
+    end
   end
 end if HAVE_RIPPER

data/spec/registry_resolver_spec.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+RSpec.describe YARD::RegistryResolver do
+  include YARD::CodeObjects::NamespaceMapper
+
+  describe '#starts_with_separator_match' do
+    subject { RegistryResolver.new }
+
+    it 'should clear cache when a namespace separator is registered' do
+      expect(subject.send(:starts_with_separator_match).to_s).not_to include('!')
+      register_separator '!', :test_type
+      expect(subject.send(:starts_with_separator_match).to_s).to include('!')
+    end
+  end
+end

data/spec/serializers/yardoc_serializer_spec.rb

@@ -45,6 +45,18 @@ RSpec.describe YARD::Serializers::YardocSerializer do
     end
   end
 
+  describe "#serialized_path" do
+    it "handles String path name" do
+      path = @serializer.serialized_path('Path::To#object')
+      expect(path).to eq('objects/Path/To/object_i.dat')
+    end
+
+    it "handles special encoding characters" do
+      path = @serializer.serialized_path('object$')
+      expect(path).to eq('objects/object_24.dat')
+    end
+  end
+
   describe "#lock_for_writing" do
     it "creates a lock file during writing and cleans up" do
       expect(File).to receive(:open!).with(@serializer.processing_path, 'w')

data/spec/templates/helpers/html_helper_spec.rb

@@ -106,16 +106,6 @@ RSpec.describe YARD::Templates::Helpers::HtmlHelper do
   end
 
   describe "#htmlify" do
-    it "does not use hard breaks for textile markup (RedCloth specific)" do
-      begin; require 'redcloth'; rescue LoadError; pending 'test requires redcloth gem' end
-      expect(htmlify("A\nB", :textile)).not_to include("<br")
-    end
-
-    it "uses hard breaks for textile_strict markup (RedCloth specific)" do
-      begin; require 'redcloth'; rescue LoadError; pending 'test requires redcloth gem' end
-      expect(htmlify("A\nB", :textile_strict)).to include("<br")
-    end
-
     it "handles various encodings" do
       allow(self).to receive(:object).and_return(Registry.root)
       text = String.new("\xB0\xB1")
@@ -159,17 +149,6 @@ RSpec.describe YARD::Templates::Helpers::HtmlHelper do
       expect(htmlify("test {include:file:foo.rdoc}", :rdoc).gsub(/[\r?\n]+/, '')).to eq '<p>test HI</p>'
     end
 
-    it "autolinks URLs (markdown specific)" do
-      log.enter_level(Logger::FATAL) do
-        unless markup_class(:markdown).to_s == "RedcarpetCompat"
-          pending 'This test depends on a markdown engine that supports autolinking'
-        end
-      end
-      expect(htmlify('http://example.com', :markdown).chomp.gsub('&#47;', '/')).to eq(
-        '<p><a href="http://example.com">http://example.com</a></p>'
-      )
-    end
-
     it "does not autolink URLs inside of {} (markdown specific)" do
       log.enter_level(Logger::FATAL) do
         pending 'This test depends on markdown' unless markup_class(:markdown)

data/spec/templates/markup_processor_integrations/integration_spec_helper.rb

@@ -1,6 +1,10 @@
 # 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

data/spec/templates/markup_processor_integrations/rdoc_markdown_spec.rb

@@ -27,12 +27,6 @@ Fenced and annotated block of Ruby code:
 x = 3
 ```
 
-Fenced and annotated block of non-Ruby code:
-
-```plain
-x = 4
-```
-
 MARKDOWN
   end
 
@@ -51,9 +45,4 @@ MARKDOWN
   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

data/spec/templates/markup_processor_integrations/redcarpet_spec.rb

@@ -53,7 +53,12 @@ MARKDOWN
   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
+
+  it "autolinks URLs" do
+    expect(html_renderer.htmlify('http://example.com', :markdown).chomp.gsub('/', '/')).to eq(
+      '<p><a href="http://example.com">http://example.com</a></p>'
+    )
+  end
 end

data/spec/templates/markup_processor_integrations/redcloth_spec.rb

@@ -2,6 +2,14 @@
 
 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 }
@@ -45,4 +53,12 @@ TEXTILE
   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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard
 version: !ruby/object:Gem::Version
-  version: 0.9.23
+  version: 0.9.24
 platform: ruby
 authors:
 - Loren Segal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-05 00:00:00.000000000 Z
+date: 2020-01-08 00:00:00.000000000 Z
 dependencies: []
 description: |2
       YARD is a documentation generation tool for the Ruby programming language.
@@ -26,6 +26,7 @@ files:
 - ".dockerignore"
 - ".github/ISSUE_TEMPLATE.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -319,6 +320,7 @@ files:
 - spec/code_objects/macro_object_spec.rb
 - spec/code_objects/method_object_spec.rb
 - spec/code_objects/module_object_spec.rb
+- spec/code_objects/namespace_mapper_spec.rb
 - spec/code_objects/namespace_object_spec.rb
 - spec/code_objects/proxy_spec.rb
 - spec/code_objects/spec_helper.rb
@@ -415,6 +417,7 @@ files:
 - spec/parser/source_parser_spec.rb
 - spec/parser/tag_parsing_spec.rb
 - spec/rake/yardoc_task_spec.rb
+- spec/registry_resolver_spec.rb
 - spec/registry_spec.rb
 - spec/registry_store_spec.rb
 - spec/rubygems/doc_manager_spec.rb