sord 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a20a16fb8b21d103c934ed6f4846db387ab40174ebe9468b33ec70b82c8c883
-  data.tar.gz: 235f786ea4950554c1c78a9887c40218efdb1cafdf2b281ca5d923af2130eaf5
+  metadata.gz: 5de7160886a2e2fd6df02d245102315d772029a951075d885a88ac253ed1ea0a
+  data.tar.gz: a14f5c19796cfd9033111c76ef144541a3dd9304d1421341fcb3fb9e9f1e65f3
 SHA512:
-  metadata.gz: e4c45eef8d708353b0a1817b273c7a548799fed3380e5ad76a0744e6c51b02d9b5d139e31a9aac49bfafc9936a4cecf8f0098a9911b2cda556b9c8456bb3cde9
-  data.tar.gz: 47f885d8222de2169f987e603cc46b949475046439a7d7e7e312ecb09e9d1510459a59e1621622e967d185b5855cdd5face4a984cf825a1a17256e7ed0876186
+  metadata.gz: 3ec7636f302c059c5a1fe826cfa077c786410b1d3378783feac63ce77a7600df516fc1f1794f869996d0aa64f13de2a42eceda806d7378efece157c0254a58a6
+  data.tar.gz: 208a0d864121ca13eeeb2c5713cd98768e4710dc9cf2bdacb9fd13471e97e2dc580f9b31530dee847b4de8e9d62072f1a1cef640c4f768f4537754058ad253c3

data/README.md

@@ -111,19 +111,6 @@ The general rule of thumb for type conversions is:
     You should search through your resulting RBI to find and fix and 
     `SORD_ERROR`s.
 
-## Things to work on
-
-  - No support whatsoever for blocks (they appear to cause syntax errors in RBI
-    currently)
-  - I'm not 100% sure how this handles undocumented methods and classes.
-  - More inference systems would be nice.
-  - This won't generate type parameter definitions for things which mix-in
-    `Enumerable`.
-  - Module scoping is an issue - if `Example::Person` is replaced with `Person`
-    in the YARD comments in the above example, Sorbet won't be able to resolve
-    it. _This can be solved by making definitions syntactically heirarchical._
-  - Tests!!
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/AaronC81/sord. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/lib/sord/logging.rb

@@ -61,7 +61,7 @@ module Sord
     #  is associated with, if any. This is shown before the log message if it is
     #  specified.
     def self.duck(msg, item=nil)
-      generic(:ducl, '[DUCK ]'.cyan, msg, item)
+      generic(:duck, '[DUCK ]'.cyan, msg, item)
     end
 
     # Print an error message. This should be used for things which require the
@@ -128,4 +128,4 @@ module Sord
       @@hooks << blk
     end
   end
-end
+end

data/lib/sord/rbi_generator.rb

@@ -132,6 +132,26 @@ module Sord
       end
     end
 
+    # Given a YARD NamespaceObject, add lines defining its mixins, methods
+    # and children to the RBI file.
+    # @param [YARD::CodeObjects::NamespaceObject] item
+    def add_namespace(item)
+      count_object
+
+      if item.type == :class && item.superclass.to_s != "Object"
+        rbi_contents << "class #{item.name} < #{item.superclass.path}" 
+      else
+        rbi_contents << "#{item.type} #{item.name}"
+      end
+      add_mixins(item)
+      add_methods(item)
+
+      item.children.select { |x| [:class, :module].include?(x.type) }
+        .each { |child| add_namespace(child) }
+
+      rbi_contents << "end"
+    end
+
     # Generates the RBI file and writes it to the given file path.
     # @param [String] filename
     # @return [void]
@@ -143,26 +163,10 @@ module Sord
 
       # TODO: constants?
 
-      # Populate the RBI with modules first
-      YARD::Registry.all(:module).each do |item|
-        count_object
-        
-        rbi_contents << "module #{item.path}"
-        add_mixins(item)
-        add_methods(item)
-        rbi_contents << "end"
-      end
-
-      # Now populate with classes
-      YARD::Registry.all(:class).each do |item|
-        count_object
-
-        superclass = (item.superclass if item.superclass.to_s != "Object")
-        rbi_contents << "class #{item.path} #{"< #{superclass}" if superclass}" 
-        add_mixins(item)
-        add_methods(item)        
-        rbi_contents << "end"
-      end
+      # Generate top-level modules, which recurses to all modules
+      YARD::Registry.root.children
+        .select { |x| [:class, :module].include?(x.type) }
+        .each { |child| add_namespace(child) }
 
       # Write the file
       File.write(filename, rbi_contents.join(?\n))

data/lib/sord/version.rb

@@ -1,4 +1,4 @@
 # typed: strong
 module Sord
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sord
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Aaron Christiansen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-22 00:00:00.000000000 Z
+date: 2019-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yard