yard-sketchup 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55bd7c6ccd04b15c3dda040cee5268918be3e7dce6bb08e9b225b82e2659ed3b
-  data.tar.gz: 82b2114686ed2614b0b9f4621540bd92f83eca8fdaf6d639151f45d99d366fe8
+  metadata.gz: 24442dd83c24269038c6e8b2542f8b0a2e41ccbff0e60f11db8c5663f10aa89a
+  data.tar.gz: e7ed0fc1c3289fefa2c9fc794053d200a4b4faf4417c8b707b8ddb3d1e51ab14
 SHA512:
-  metadata.gz: 778e3f58d9e62b041a2e69253754fabc3e8bf169737bc9da0e7307e4b6a0509ec37bdb15ac12bac31afa82360a030d5a1b983a6dffb66f3b61c11a548d7b10e0
-  data.tar.gz: 4b79e9d05a91d08d49207b0de0638294662aef933ebe6326c57038b61462618ad0c092fb357654ea86c9232aec0b69109b5cab6a729fa448678fd47997f80146
+  metadata.gz: 5188fcae0888a56ae9730db6ccbfff584ee1038be903a235ac5dea5f77e02dabd3d6888681a9c61d182d1f5f73ffb47bc7182c927c0b48585edb8a195d0820ed
+  data.tar.gz: 388c4c9ca2bfe3f95395a770605c7810702e45bbb427613189b17646ee2dfdfce41fd2fd605fd94ca54878c24605a40a441871956c017c42377f7bbbfde424f8

data/lib/yard-sketchup/templates/apis/fulldoc/text/setup.rb

@@ -0,0 +1,23 @@
+require 'set'
+
+include Helpers::ModuleHelper
+
+def init
+  find_all_apis
+end
+
+
+def all_objects
+  run_verifier(Registry.all)
+end
+
+
+def find_all_apis
+  apis = Set.new
+  all_objects.each { |object|
+    version_tag = object.tag(:api)
+    apis << version_tag.text if version_tag
+  }
+  puts apis.sort.join("\n")
+  exit # Avoid the YARD summary
+end

data/lib/yard-sketchup/templates/default/docstring/html/api.erb

@@ -0,0 +1,4 @@
+<div class="note deprecated">
+  <strong>Pre-release feature.</strong>
+  This is work in progress and might change before officially being released.
+</div>

data/lib/yard-sketchup/templates/default/docstring/setup.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+def init
+  super
+  # Add an "api" section to docstrings. This will cause the `api` method
+  # below to be called which will in turn render the `api` template.
+  @sections.unshift(:api)
+end
+
+def api
+  return unless object.has_tag?(:api)
+  # Displays a a message warning the user that the API is not stable.
+  erb(:api)
+end

data/lib/yard-sketchup/version.rb

@@ -1,3 +1,3 @@
 module SketchUpYARD
-  VERSION = '1.5.1'.freeze
+  VERSION = '1.6.0'.freeze
 end

data/lib/yard-sketchup.rb

@@ -1,7 +1,6 @@
 require 'yard'
 require 'yard-sketchup/version'
 require 'yard-sketchup/stubs/autoload'
-require 'yard-sketchup/yard/logger'
 require 'yard-sketchup/yard/handlers/class_constants'
 require 'yard-sketchup/yard/handlers/class_enum_constants'
 require 'yard-sketchup/yard/handlers/global_constants'

data/yard-sketchup.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
       'Gemfile'
   ]
 
-  spec.add_dependency 'yard', '~> 0.9.18'
+  spec.add_dependency 'yard', '~> 0.9.37'
   spec.add_dependency 'rouge', '~> 3.26'
   spec.add_development_dependency 'bundler', '>= 1.15.0', '< 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yard-sketchup
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Trimble Inc, SketchUp Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-08 00:00:00.000000000 Z
+date: 2024-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        version: 0.9.37
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.18
+        version: 0.9.37
 - !ruby/object:Gem::Dependency
   name: rouge
   requirement: !ruby/object:Gem::Requirement
@@ -68,8 +68,11 @@ files:
 - lib/yard-sketchup.rb
 - lib/yard-sketchup/patches/c_base_handler.rb
 - lib/yard-sketchup/stubs/autoload.rb
+- lib/yard-sketchup/templates/apis/fulldoc/text/setup.rb
 - lib/yard-sketchup/templates/changelog/fulldoc/text/setup.rb
 - lib/yard-sketchup/templates/coverage/fulldoc/text/setup.rb
+- lib/yard-sketchup/templates/default/docstring/html/api.erb
+- lib/yard-sketchup/templates/default/docstring/setup.rb
 - lib/yard-sketchup/templates/default/fulldoc/html/css/rubyapi.css
 - lib/yard-sketchup/templates/default/fulldoc/html/css/sketchup.css
 - lib/yard-sketchup/templates/default/fulldoc/html/favicon.ico
@@ -102,7 +105,6 @@ files:
 - lib/yard-sketchup/yard/handlers/class_enum_constants.rb
 - lib/yard-sketchup/yard/handlers/global_constants.rb
 - lib/yard-sketchup/yard/html_helper.rb
-- lib/yard-sketchup/yard/logger.rb
 - yard-sketchup.gemspec
 homepage: https://github.com/SketchUp/sketchup-yard-template
 licenses:

data/lib/yard-sketchup/yard/logger.rb

@@ -1,45 +0,0 @@
-require 'yard/logging'
-
-# Hack to show some progress on Windows while building the docs.
-# Helpful in seeing what takes most time.
-# It's Copy+Paste from YARD 0.9.9 with some noted edits.
-module YARD
-  class Logger < ::Logger
-
-    def show_progress
-      return false if YARD.ruby18? # threading is too ineffective for progress support
-      # <hack>
-      # return false if YARD.windows? # windows has poor ANSI support
-      # </hack>
-      return false unless io.tty? # no TTY support on IO
-      return false unless level > INFO # no progress in verbose/debug modes
-      @show_progress
-    end
-
-    def progress(msg, nontty_log = :debug)
-      send(nontty_log, msg) if nontty_log
-      return unless show_progress
-      icon = ""
-      if defined?(::Encoding)
-        icon = PROGRESS_INDICATORS[@progress_indicator] + " "
-      end
-      @mutex.synchronize do
-        print("\e[2K\e[?25l\e[1m#{icon}#{msg}\e[0m\r")
-        @progress_msg = msg
-        if Time.now - @progress_last_update > 0.2
-          @progress_indicator += 1
-          @progress_indicator %= PROGRESS_INDICATORS.size
-          @progress_last_update = Time.now
-        end
-      end
-      Thread.new do
-        sleep(0.05)
-        # <hack>
-        # progress(msg + ".", nil) if @progress_msg == msg
-        # </hack>
-        progress(msg, nil) if @progress_msg == msg
-      end
-    end
-
-  end
-end if true # Set to false to disable hack.