sord 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48989b3587651b3576af45f8ba0664eb5e49696e6c8e9e18deb2bce33d78651e
-  data.tar.gz: 2b0f10c99524c00ebe89d76eecab495bd38c55dc5a84a0e707b888030a07caf9
+  metadata.gz: cf3418f5f5f96e17c76ee48515382ac008d975ed200eae3f837f9e136077a7f3
+  data.tar.gz: 2592ad90c6b6c17ec9a9c550d348a3989b4511a51b2b115643dafa05b41e9191
 SHA512:
-  metadata.gz: 6350ec6144be3d60d8056c0d25af71ad17c0960a1931e30cedb12fb1820461ed922fbad188b7ad6f8a3009a804311e6b2f63aae6bd938b7f036cfb00441db9ba
-  data.tar.gz: 2fffdecb428ab937948eebefa56aac39da39d4b1972ddc98d8d7d2d4ef37ee3f1fedecaa95146286d53707d8b8ccc16fa30d2aec9dcbe4eeb39369f2b4f4280c
+  metadata.gz: 4db0db07817d59efdceb9455cbf3613d4d6031d635fc40ad6dd310ad0828a6b8a6be35c6cd7e9cfa11d3cb7ab23496c851686027a82f5e6f55c034420a9c98a2
+  data.tar.gz: b00f3f123af693111782b734ce72d00930613408f113197bcddd182c6b36308b8f6b9e7d3cc2e0bc7a7ed15bb666aec93a9da7d2e7f9595e601ff51b7e16866a

data/Gemfile

@@ -2,3 +2,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in sord.gemspec
 gemspec
+
+gem "commander", "~> 4.4"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sord (0.2.1)
+    sord (0.3.0)
       colorize
       sorbet-runtime
       yard
@@ -10,8 +10,11 @@ GEM
   remote: https://rubygems.org/
   specs:
     colorize (0.8.1)
+    commander (4.4.7)
+      highline (~> 2.0.0)
     diff-lcs (1.3)
     docile (1.3.2)
+    highline (2.0.2)
     json (2.2.0)
     rake (10.5.0)
     rspec (3.8.0)
@@ -34,7 +37,7 @@ GEM
     simplecov-html (0.10.2)
     sorbet (0.4.4254)
       sorbet-static (= 0.4.4254)
-    sorbet-runtime (0.4.4254)
+    sorbet-runtime (0.4.4293)
     sorbet-static (0.4.4254-x86_64-linux)
     yard (0.9.19)
 
@@ -43,6 +46,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 2.0)
+  commander (~> 4.4)
   rake (~> 10.0)
   rspec (~> 3.0)
   simplecov

data/exe/sord

@@ -1,4 +1,25 @@
 #!/usr/bin/env ruby
 require 'sord'
+require 'commander/import'
 
-Sord::RbiGenerator.new.run($*[0])
+program :name, 'sord'
+program :version, Sord::VERSION
+program :description, 'Generate Sorbet RBIs from YARD documentation'
+
+default_command :gen
+command :gen do |c|
+  c.syntax = 'sord gen <output-file> [options]'
+  c.description = 'Generates an RBI file from this directory\'s YARD docs'
+  c.option '--[no-]comments', 'Disables informational/warning comments in the RBI file'
+
+  c.action do |args, options|
+    options.default comments: true
+
+    if args.length != 1
+      Sord::Logging.error('Must specify filename')
+      exit 1
+    end
+
+    Sord::RbiGenerator.new(options).run(args.first)
+  end
+end

data/lib/sord/rbi_generator.rb

@@ -15,15 +15,16 @@ module Sord
     attr_reader :object_count
 
     # Create a new RBI generator.
+    # @param [Hash] options
     # @return [RbiGenerator]
-    def initialize
+    def initialize(options)
       @rbi_contents = ['# typed: strong']
       @object_count = 0
 
       # Hook the logger so that messages are added as comments to the RBI file
       Logging.add_hook do |type, msg, item|
         rbi_contents << "  # sord #{type} - #{msg}"
-      end
+      end if options.comments
     end
 
     # Increment the object counter.
@@ -84,6 +85,9 @@ module Sord
           elsif name.start_with? '*'
             # TODO: is there a YARD definition for this?
             "args: T::Array[T.any]"
+          elsif name.start_with? '&'
+            # Cut the ampersand from the block parameter name.
+            "#{name[1..-1]}: T.untyped"
           elsif meth.path.end_with? '='
             # Look for the matching getter method
             getter_path = meth.path[0...-1]
@@ -131,6 +135,8 @@ module Sord
     # @param [String] filename
     # @return [void]
     def run(filename)
+      raise "No filename specified" unless filename
+
       # Get YARD ready
       YARD::Registry.load!
 
@@ -158,7 +164,6 @@ module Sord
       end
 
       # Write the file
-      raise "no filename specified" unless filename
       File.write(filename, rbi_contents.join(?\n))
 
       Logging.done("Processed #{object_count} objects")

data/lib/sord/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sord
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Aaron Christiansen