orthoses-yard 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36b54b543b79745b042a7ec072d923adaf37d46a51e61477637a6b14ec2051bc
-  data.tar.gz: 5f591556c56266c92d83e58f6af2f9a970734b5f5c6f2b21894d93a350bf1f55
+  metadata.gz: d80e8c5e354b7be1e8d3e160e30093ab485a42f2a0d70460473721f93528bfa2
+  data.tar.gz: 19af1c287147f7da97338dbea77d17bc857a3154bab3770a09d4939c2abbaf4c
 SHA512:
-  metadata.gz: 712dbf70f932c3d5fdea40b6844e5a78a363f51b33bf96dfec250fd0e20d3ca61c2b13ac1320c6edf1e503cbb45d601f9a3da2416731bb6a8efe64a7a5d69426
-  data.tar.gz: a03f7ca554c4548f99ef07eaed0213fd68ab6aa4a5cc3f0dcd5bd7ce2386a81d800efc5aa28a9af0091b30d9b5afdfbe8bf4dff309f23460a9aba0b178db53a9
+  metadata.gz: 11f717bb93e085083f79ac23e169d8dd02f4996faed4073d53cdb1895af039fdcc707a68326ef6459fd6e2943e622097faf5624884cfe55aaef7f5ced1ac9224
+  data.tar.gz: 5b6c127a6789659eff70f25fe21131dc5c7d0b3490cff6337675d60ae824f973a30252f98933f9aae2cfde76ec12b5b8daa7136616575141d81bc6ecff2537ac

data/lib/orthoses/yard/version.rb

@@ -2,6 +2,6 @@
 
 module Orthoses
   class YARD
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

data/lib/orthoses/yard/yard2rbs.rb

@@ -35,7 +35,7 @@ module Orthoses
       # @return [void]
       def run
         Orthoses.logger.info("YARD will generate about #{yardoc.inspect}")
-        block.call(yardoc.path, yardoc.docstring.all, nil)
+        emit(yardoc.path, yardoc.docstring.all, nil, false)
         yardoc.children.each do |child|
           case child.type
           when :module, :class
@@ -70,6 +70,10 @@ module Orthoses
 
       private
 
+      def emit(namespace, docstring, rbs, skippable)
+        block.call(namespace, docstring, rbs, skippable)
+      end
+
       def class_of(mod)
         Kernel.instance_method(:class).bind_call(mod)
       end
@@ -82,15 +86,18 @@ module Orthoses
             if class_attributes[:read] && class_attributes[:write]
               visibility = class_attributes[:read].visibility == :private ? 'private ' : ''
               type = tag_types_to_rbs_type(class_attributes[:read].tags('return').flat_map(&:types))
-              block.call(yardoc.path, class_attributes[:read].docstring.all, "#{visibility}attr_accessor #{prefix}#{name}: #{type}")
+              skippable = class_attributes[:read].tags('return').empty?
+              emit(yardoc.path, class_attributes[:read].docstring.all, "#{visibility}attr_accessor #{prefix}#{name}: #{type}", skippable)
             elsif class_attributes[:read]
               visibility = class_attributes[:read].visibility == :private ? 'private ' : ''
               type = tag_types_to_rbs_type(class_attributes[:read].tags('return').flat_map(&:types))
-              block.call(yardoc.path, class_attributes[:read].docstring.all, "#{visibility}attr_reader #{prefix}#{name}: #{type}")
+              skippable = class_attributes[:read].tags('return').empty?
+              emit(yardoc.path, class_attributes[:read].docstring.all, "#{visibility}attr_reader #{prefix}#{name}: #{type}", skippable)
             elsif class_attributes[:write]
               visibility = class_attributes[:write].visibility == :private ? 'private ' : ''
               type = tag_types_to_rbs_type(class_attributes[:write].tags('return').flat_map(&:types))
-              block.call(yardoc.path, class_attributes[:write].docstring.all, "#{visibility}attr_writer #{prefix}#{name}: #{type}")
+              skippable = class_attributes[:write].tags('return').empty?
+              emit(yardoc.path, class_attributes[:write].docstring.all, "#{visibility}attr_writer #{prefix}#{name}: #{type}", skippable)
             else
               raise "bug"
             end
@@ -106,8 +113,8 @@ module Orthoses
           # skip attribute methods because of generate_for_attributes
           next if meth.attr_info
 
-          # skip no tags methods
-          next if meth.tags.empty?
+          # skip no type tags methods
+          skippable = meth.docstring.all.empty?
 
           namespace = meth.namespace
           method_name = meth.name
@@ -131,8 +138,7 @@ module Orthoses
 
           if meth.is_alias?
             orig_key = yardoc.aliases[meth]
-            block.call(yardoc.to_s, "", "alias #{prefix}#{meth.name} #{prefix}#{orig_key}")
-            next
+            emit(yardoc.to_s, "", "alias #{prefix}#{meth.name} #{prefix}#{orig_key}", false)
           end
 
           required_positionals = []
@@ -226,7 +232,7 @@ module Orthoses
           )
 
           visibility = meth.visibility == :private ? 'private ' : ''
-          block.call(yardoc.to_s, meth.docstring.all, "#{visibility}def #{prefix}#{method_name}: #{method_type}")
+          emit(yardoc.to_s, meth.docstring.all, "#{visibility}def #{prefix}#{method_name}: #{method_type}", skippable)
         end
       end
 
@@ -234,8 +240,9 @@ module Orthoses
       def generate_for_constants
         yardoc.constants(inherited: false).each do |const|
           return_tags = const.tags('return')
-          return_type = return_tags.empty? ? untyped : tag_types_to_rbs_type(return_tags.flat_map(&:types))
-          block.call(const.namespace.to_s, const.docstring.all, "#{const.name}: #{return_type}")
+          return_type = tag_types_to_rbs_type(return_tags.flat_map(&:types))
+          skippable = return_tags.empty?
+          emit(const.namespace.to_s, const.docstring.all, "#{const.name}: #{return_type}", skippable)
         end
       end
 
@@ -243,8 +250,9 @@ module Orthoses
       def generate_for_classvariable
         yardoc.cvars.each do |cvar|
           return_tags = cvar.tags('return')
-          return_type = return_tags.empty? ? untyped : tag_types_to_rbs_type(return_tags.flat_map(&:types))
-          block.call(cvar.namespace.to_s, cvar.docstring.all, "#{cvar.name}: #{return_type}")
+          return_type = tag_types_to_rbs_type(return_tags.flat_map(&:types))
+          skippable = return_tags.empty?
+          emit(cvar.namespace.to_s, cvar.docstring.all, "#{cvar.name}: #{return_type}", skippable)
         end
       end
 

data/lib/orthoses/yard.rb

@@ -10,11 +10,13 @@ module Orthoses
     # @param [<String>, String] parse Target files
     # @param [Boolean] use_cache Use cache .yardoc
     # @param [Symbol, nil] log_level Set YARD log level
-    def initialize(loader, parse:, use_cache: true, log_level: nil)
+    # @param [Boolean] allow_empty_doc Generate RBS also from empty doc
+    def initialize(loader, parse:, use_cache: true, log_level: nil, allow_empty_doc: false)
       @loader = loader
       @parse = Array(parse)
       @use_cache = use_cache
       @log_level = log_level
+      @allow_empty_doc = allow_empty_doc
     end
 
     # @return [void]
@@ -36,13 +38,14 @@ module Orthoses
 
           case yardoc.type
           when :class, :module
-            YARD2RBS.run(yardoc: yardoc) do |namespace, docstring, rbs|
-              comment = docstring.each_line.map { |line| "# #{line}" }.join
+            YARD2RBS.run(yardoc: yardoc) do |namespace, docstring, rbs, skippable|
+              next if skippable && !@allow_empty_doc
+              comment = docstring.empty? ? '' : "# #{docstring.gsub("\n", "\n# ")}"
               if rbs.nil? && comment && !store.has_key?(namespace)
                 store[namespace].comment = comment
               else
                 Orthoses.logger.debug("#{namespace} << #{rbs}")
-                store[namespace] << "#{comment}\n#{rbs}"
+                store[namespace] << "#{comment.chomp}\n#{rbs}"
               end
             end
           end

data/sig/orthoses.rbs

@@ -6,10 +6,10 @@ class Orthoses::YARD
   # @param [<String>, String] parse Target files
   # @param [Boolean] use_cache Use cache .yardoc
   # @param [Symbol, nil] log_level Set YARD log level
-  def initialize: (untyped loader, parse: Array[String] | String, ?use_cache: bool, ?log_level: Symbol?) -> void
+  # @param [Boolean] allow_empty_doc Generate RBS also from empty doc
+  def initialize: (untyped loader, parse: Array[String] | String, ?use_cache: bool, ?log_level: Symbol?, ?allow_empty_doc: bool) -> void
   # @return [void]
   def call: () -> void
-  VERSION: untyped
 end
 
 class Orthoses::YARD::YARD2RBS
@@ -23,7 +23,6 @@ class Orthoses::YARD::YARD2RBS
   attr_reader void: RBS::Types::Bases::Void
   # @return [RBS::Types::Bases::Bool]
   attr_reader bool: RBS::Types::Bases::Bool
-  def initialize: (yardoc: untyped, block: untyped) -> void
   # @return [void]
   def run: () -> void
   # @return [RBS::Types::t]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: orthoses-yard
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - ksss
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-10-01 00:00:00.000000000 Z
+date: 2023-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: orthoses