sord 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4302b93ba07124b24e91c6db6a2757d2fe148c573f3b86a918c72155e83d0d5
-  data.tar.gz: 610ce8222970fb4da8f5d01368a21b1aef4067936f6883b2eb5522e567e8fcce
+  metadata.gz: bfebf9f7b35b936d5a448430b99c0aaa79cb13af0183cdf438c9d210b79fcbe4
+  data.tar.gz: fd5d9f369fbc55d34bac6b3338cb481a3a0a3ed748d47130327f841e5ac3d8a7
 SHA512:
-  metadata.gz: 2a3798003e636dc6baba752bbae52718eefb3f43a5562d7fb3659e39d0a0245c39dd10d297433f05df12f60ac102b93a6ad1b71bc0e1fcb2bf3405233dfb834c
-  data.tar.gz: 0b9a87eea2db2c948006c89c0970175c98471f0e98358a190c17e6c8e064ff59c5849ea73b0081ef6cd09975488884e333b359a44f8d79a8dac78d6f7f461c3e
+  metadata.gz: 0407ed5b5770dd46c40df84dd40ba598d650a237f5f5a59127c66d30078970b36c803165dccbb9c6057784bee7763031f15d081fb0aabede6d100d5e943acd10
+  data.tar.gz: '07849f1278d3d40a3230c45293bc23d6c5ab31360f1d43a55ebc04eefc448e80481fc740180a776d6d999193798a30e1aa961a406c77e9f92d998a67ae43c4e2'

data/.parlour

@@ -0,0 +1,7 @@
+output_file: rbi/sord.rbi
+
+requires:
+  - sord
+
+plugins:
+  Sord::ParlourPlugin: {}

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+dist: trusty
+before_install:
+  - gem install bundler
+rvm: 
+  - 2.6

data/CHANGELOG.md

@@ -3,6 +3,52 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [0.9.0] - 2019-08-09
+### Added
+- Add the `--replace-constants-with-untyped` flag, which generates `T.untyped` instead of `SORD_ERROR` constants.
+- Added an option to clean the `sord_examples` directory when seeding or reseeding.
+- Added a Rake task to typecheck the `sord_examples` directory.
+- Added a `.parlour` file to the project for generating Sord's RBIs.
+- Added CI with Travis.
+
+### Changed
+- Code generation has been broken out into the Parlour gem, and Sord is now a Parlour plugin.
+- Rainbow is now used for coloured output instead of colorize.
+- Duplicate type signatures are no longer generated for inherited methods.
+- The Resolver can now resolve more objects.
+- If a parameter has `nil` as its default, it now has a nilable type.
+- Generation of constants has been improved.
+- Superclass names are now generated as fully-qualified identifiers.
+
+### Fixed
+- Fixed `T::Hash` and `T::Array` syntax being generated incorrectly.
+- Fix a bug where the `--no-comments` or `--no-generate` flags were ignored.
+- Collections of `T.untyped` now have signatures generated correctly.
+- Fix generation of hashes when they are given too few parameters.
+- YARD no longer prints irrelevant error messages when running rake.
+
+## [0.8.0] - 2019-07-07
+### Added
+- Block types can now be generated using `@yieldparam` and `@yieldreturn`.
+- Long lists of parameters (at least 4) are now broken onto multiple lines. The threshold can be altered with the `--break-params` option.
+- If a constant used is not found, Sord will now attempt to locate it and fully-qualify its name.
+- Add the `--replace-errors-with-untyped` flag; when present, `T.untyped` is used instead of `SORD_ERROR_` constants.
+- Add the `--include/exclude-messages` flags, which can be used to suppress certain log message kinds.
+- Add support for the `Class<...>` generic becoming `T.class_of(...)`. (#44)
+- Add YARD array (`<...>`) and hash (`{... => ...}`) shorthands. (#43)
+- Sord now has an `examples` set of Rake tasks to test Sord on a large number of repos.
+- Sord now bundles an RBI for itself.
+
+### Changed
+- Methods without any YARD documentation are now typed as `T.untyped` rather than `void`.
+
+### Fixed
+- Duck types in the form of setters (`#foo=`) are now interpreted properly.
+- Fix some cases where indentation was incorrect. (#30, #46)
+- Fix `include` and `extend` calls being swapped, and give them proper blank lines.
+- Fix incorrect blank lines inside empty namespaces.
+- Fix a crash when a `@param` has no name given.
+
 ## [0.7.1] - 2019-06-24
 ### Fixed
 - Fix bug where `--no-regenerate` flag was ignored.

data/README.md

@@ -60,6 +60,7 @@ Sord also takes some flags to alter the generated `.rbi` file:
     the signature is changed from a single-line to a multi-line block.
     (Default: 4)
   - `--replace-errors-with-untyped`: Uses `T.untyped` instead of `SORD_ERROR_*` constants.
+  - `--replace-unresolved-with-untyped`: Uses `T.untyped` when Sord is unable to resolve a constant.
   - `--include-messages` and `--exclude-messages`: Used to filter the logging
     messages given by Sord. `--include-messages` acts as a whitelist, printing
     only messages of the specified logging kinds, whereas `--exclude-messages`

data/Rakefile

@@ -20,12 +20,12 @@ REPOS = {
 
 namespace :examples do
   require 'fileutils'
-  require 'colorize'
+  require 'rainbow'
 
   desc "Clone git repositories and run Sord on them as examples"
-  task :seed do
+  task :seed, [:clean] do |t, args|
     if File.directory?('sord_examples')
-      puts 'sord_examples directory already exists, please delete the directory or run a reseed!'.red
+      puts Rainbow('sord_examples directory already exists, please delete the directory or run a reseed!').red
       exit
     end
 
@@ -44,35 +44,91 @@ namespace :examples do
         system('bundle install')
         # Generate sri
         puts "Generating rbi for #{name}..."
-        system("bundle exec sord ../#{name}.rbi")
+        if args[:clean]
+          system("bundle exec sord ../#{name}.rbi --no-comments --replace-errors-with-untyped --replace-unresolved-with-untyped")
+        else
+          system("bundle exec sord ../#{name}.rbi")
+        end
         puts "#{name}.rbi generated!"
         FileUtils.cd '..'
       end
     end
 
-    puts "Seeding complete!".green
+    puts Rainbow("Seeding complete!").green
   end
 
   desc 'Regenerate the rbi files in sord_examples.'
-  task :reseed do
-    FileUtils.cd 'sord_examples'
+  task :reseed, [:clean] do |t, args|
+    if Dir.exist?('sord_examples')
+      FileUtils.cd 'sord_examples'
+    else
+      raise Rainbow("The sord_examples directory does not exist. Have you run the seed task?").red.bold
+    end
 
     REPOS.keys.each do |name|
       FileUtils.cd name.to_s
       puts "Regenerating rbi file for #{name}..."
       Bundler.with_clean_env do
-        system("bundle exec sord ../#{name}.rbi --no-regenerate")
+        if args[:clean]
+          system("bundle exec sord ../#{name}.rbi --no-regenerate --no-comments --replace-errors-with-untyped --replace-unresolved-with-untyped")
+        else
+          system("bundle exec sord ../#{name}.rbi --no-regenerate")
+        end
       end
       FileUtils.cd '..'
     end
 
-    puts "Re-seeding complete!".green
+    puts Rainbow("Re-seeding complete!").green
   end
   
   desc 'Delete the sord_examples directory to allow the seeder to run again.'
   task :reset do
     FileUtils.rm_rf 'sord_examples' if File.directory?('sord_examples')
-    puts 'Reset complete.'.green
+    puts Rainbow('Reset complete.').green
   end
-end
 
+  desc 'Typecheck each of the sord_examples rbi files.'
+  task :typecheck, [:verbose] do |t, args|
+    results_hash = {}
+    REPOS.each do |name, url|
+      Bundler.with_clean_env do
+        puts "srb tc sord_examples/#{name}.rbi --ignore sord.rbi 2>&1"
+        if args[:verbose]
+          output = system("srb tc sord_examples/#{name}.rbi --ignore sord.rbi 2>&1")
+        else
+          output = `srb tc sord_examples/#{name}.rbi --ignore sord.rbi 2>&1`.split("\n").last
+          results_hash[:"#{name}"] = output
+        end
+      end
+    end
+    
+    unless args[:verbose]
+      puts Rainbow("Errors").bold
+      longest_name = results_hash.keys.map { |name| name.length }.max
+
+      # Replace all values in results_hash with integer by parsing it.
+      results_hash.each do |name, result|
+        result.scan(/Errors\: (\d+)/) { |match| result = match.first.to_i }
+        results_hash[name] = (result == "No errors! Great job.") ? 0 : result
+      end
+
+      # Print the right-aligned name and the number of errors, with different colors depending on the number of errors. 
+      results_hash.each do |name, result|
+        spaces_needed = longest_name - name.length
+        output = "#{' ' * spaces_needed}#{name}: #{result}"
+        case result
+        when 0..5
+          puts Rainbow(output).green.bright
+        when 6..25
+          puts Rainbow(output).green
+        when 26..50
+          puts Rainbow(output).red
+        else
+          puts Rainbow(output).red.bright
+        end
+      end
+      # Report the Total.
+      puts Rainbow("#{' ' * (longest_name - 'Total'.length)}Total: #{results_hash.values.inject(0, :+)}").bold
+    end
+  end
+end

data/exe/sord

@@ -15,6 +15,7 @@ command :gen do |c|
   c.option '--[no-]regenerate', 'Controls whether YARD is executed before Sord runs'
   c.option '--break-params INTEGER', Integer, 'Break params onto their own lines if there are this many'
   c.option '--replace-errors-with-untyped', 'Uses T.untyped rather than SORD_ERROR_ constants'
+  c.option '--replace-unresolved-with-untyped', 'Uses T.untyped when Sord is unable to resolve a constant'
   c.option '--exclude-messages STRING', String, 'Blacklists a comma-separated string of log message types'
   c.option '--include-messages STRING', String, 'Whitelists a comma-separated string of log message types'
 
@@ -24,6 +25,7 @@ command :gen do |c|
       regenerate: true,
       break_params: 4,
       replace_errors_with_untyped: false,
+      replace_unresolved_with_untyped: false,
       exclude_messages: nil,
       include_messages: nil,
     )
@@ -33,41 +35,14 @@ command :gen do |c|
       exit 1
     end
 
-    if options.include_messages && options.exclude_messages
-      Sord::Logging.error('Please specify only one of --include-messages and --exclude-messages.')
-      exit 1
-    elsif options.include_messages
-      whitelist = options.include_messages.split(',').map { |x| x.downcase.to_sym }
-      unless Sord::Logging.valid_types?(whitelist)
-        Sord::Logging.error('Not all types on your --include-messages list are valid.')
-        Sord::Logging.error("Valid options are: #{Sord::Logging::AVAILABLE_TYPES.map(&:to_s).join(', ')}")
-        exit 1
-      end
-      Sord::Logging.enabled_types = whitelist | [:done]
-    elsif options.exclude_messages
-      blacklist = options.exclude_messages.split(',').map { |x| x.downcase.to_sym }
-      unless Sord::Logging.valid_types?(blacklist)
-        Sord::Logging.error('Not all types on your --include-messages list are valid.')
-        Sord::Logging.error("Valid options are: #{Sord::Logging::AVAILABLE_TYPES.map(&:to_s).join(', ')}")
-        exit 1
-      end
-      Sord::Logging.enabled_types = Sord::Logging::AVAILABLE_TYPES - blacklist
-    end
-
-    if options.regenerate
-      begin
-        Sord::Logging.info('Running YARD...')
-        Bundler.with_clean_env do
-          system('bundle exec yard')
-        end
-      rescue Errno::ENOENT
-        Sord::Logging.error('The YARD tool could not be found on your PATH.')
-        Sord::Logging.error('You may need to run \'gem install yard\'.')
-        Sord::Logging.error('If documentation has already been generated, pass --no-regenerate to Sord.')
-        exit 1
-      end
-    end
+    plugin_options = options.__hash__
+    plugin_options[:exclude_options] = plugin_options[:exclude_options]&.split(',')
+    plugin_options[:include_options] = plugin_options[:include_options]&.split(',')
 
-    Sord::RbiGenerator.new(options.__hash__).run(args.first)
+    plugin = Sord::ParlourPlugin.new(plugin_options)
+    plugin.parlour = Parlour::RbiGenerator.new(break_params: plugin_options[:break_params])
+    plugin.generate(plugin.parlour.root)
+    
+    File.write(args.first, plugin.parlour.rbi)
   end
 end

data/lib/sord/logging.rb

@@ -1,4 +1,5 @@
-require 'colorize'
+# typed: true
+require 'rainbow'
 
 module Sord
   # Handles writing logs to stdout and any other classes which request them.
@@ -68,18 +69,17 @@ module Sord
     # @param [YARD::CodeObjects::Base] item The CodeObject which this log 
     #  is associated with, if any. This is shown before the log message if it is
     #  specified.
-    # @param [Integer] indent_level The level at which to indent the code.
     # @return [void]
-    def self.generic(kind, header, msg, item, indent_level = 0)
+    def self.generic(kind, header, msg, item)
       return unless enabled_types.include?(kind)
 
       if item
-        puts "#{header} (#{item.path.bold}) #{msg}" unless silent?
+        puts "#{header} (#{Rainbow(item.path).bold}) #{msg}" unless silent?
       else
         puts "#{header} #{msg}" unless silent?
       end
 
-      invoke_hooks(kind, msg, item, indent_level)
+      invoke_hooks(kind, msg, item)
     end
 
     # Print a warning message. This should be used for things which require the
@@ -88,10 +88,9 @@ module Sord
     # @param [YARD::CodeObjects::Base] item The CodeObject which this log 
     #  is associated with, if any. This is shown before the log message if it is
     #  specified.
-    # @param [Integer] indent_level The level at which to indent the code.
     # @return [void]
-    def self.warn(msg, item = nil, indent_level = 0)
-      generic(:warn, '[WARN ]'.yellow, msg, item, indent_level)
+    def self.warn(msg, item = nil)
+      generic(:warn, Rainbow('[WARN ]').yellow, msg, item)
     end
 
     # Print an info message. This should be used for generic informational
@@ -100,10 +99,9 @@ module Sord
     # @param [YARD::CodeObjects::Base] item The CodeObject which this log 
     #  is associated with, if any. This is shown before the log message if it is
     #  specified.
-    # @param [Integer] indent_level The level at which to indent the code.
     # @return [void]
-    def self.info(msg, item = nil, indent_level = 0)
-      generic(:info, '[INFO ]', msg, item, indent_level)
+    def self.info(msg, item = nil)
+      generic(:info, '[INFO ]', msg, item)
     end
 
     # Print a duck-typing message. This should be used when the YARD 
@@ -113,10 +111,9 @@ module Sord
     # @param [YARD::CodeObjects::Base] item The CodeObject which this log 
     #  is associated with, if any. This is shown before the log message if it is
     #  specified.
-    # @param [Integer] indent_level The level at which to indent the code.
     # @return [void]
-    def self.duck(msg, item = nil, indent_level = 0)
-      generic(:duck, '[DUCK ]'.cyan, msg, item, indent_level)
+    def self.duck(msg, item = nil)
+      generic(:duck, Rainbow('[DUCK ]').cyan, msg, item)
     end
 
     # Print an error message. This should be used for things which require the
@@ -125,10 +122,9 @@ module Sord
     # @param [YARD::CodeObjects::Base] item The CodeObject which this log 
     #  is associated with, if any. This is shown before the log message if it is
     #  specified.
-    # @param [Integer] indent_level The level at which to indent the code.
     # @return [void]
-    def self.error(msg, item = nil, indent_level = 0)
-      generic(:error, '[ERROR]'.red, msg, item, indent_level)
+    def self.error(msg, item = nil)
+      generic(:error, Rainbow('[ERROR]').red, msg, item)
     end
 
     # Print an infer message. This should be used when the user should be told
@@ -138,10 +134,9 @@ module Sord
     # @param [YARD::CodeObjects::Base] item The CodeObject which this log 
     #  is associated with, if any. This is shown before the log message if it is
     #  specified.
-    # @param [Integer] indent_level The level at which to indent the code.
     # @return [void]
-    def self.infer(msg, item = nil, indent_level = 0)
-      generic(:infer, '[INFER]'.light_blue, msg, item, indent_level)
+    def self.infer(msg, item = nil)
+      generic(:infer, Rainbow('[INFER]').blue, msg, item)
     end
 
     # Print an omit message. This should be used as a special type of warning
@@ -151,10 +146,9 @@ module Sord
     # @param [YARD::CodeObjects::Base] item The CodeObject which this log 
     #  is associated with, if any. This is shown before the log message if it is
     #  specified.
-    # @param [Integer] indent_level The level at which to indent the code.
     # @return [void]
-    def self.omit(msg, item = nil, indent_level = 0)
-      generic(:omit, '[OMIT ]'.magenta, msg, item, indent_level)
+    def self.omit(msg, item = nil)
+      generic(:omit, Rainbow('[OMIT ]').magenta, msg, item)
     end
 
     # Print a done message. This should be used when a process completes
@@ -163,10 +157,9 @@ module Sord
     # @param [YARD::CodeObjects::Base] item The CodeObject which this log 
     #  is associated with, if any. This is shown before the log message if it is
     #  specified.
-    # @param [Integer] indent_level The level at which to indent the code.
     # @return [void]
-    def self.done(msg, item = nil, indent_level = 0)
-      generic(:done, '[DONE ]'.green, msg, item)
+    def self.done(msg, item = nil)
+      generic(:done, Rainbow('[DONE ]').green, msg, item)
     end
 
     # Invokes all registered hooks on the logger.
@@ -175,11 +168,10 @@ module Sord
     # @param [YARD::CodeObjects::Base] item The CodeObject which this log 
     #  is associated with, if any. This is shown before the log message if it is
     #  specified.
-    # @param [Integer] indent_level The level at which to indent the code.
     # @return [void]
-    def self.invoke_hooks(kind, msg, item, indent_level = 0)
+    def self.invoke_hooks(kind, msg, item)
       @@hooks.each do |hook|
-        hook.(kind, msg, item, indent_level) rescue nil
+        hook.(kind, msg, item) rescue nil
       end
     end
 
@@ -189,7 +181,6 @@ module Sord
     # @yieldparam [YARD::CodeObjects::Base] item The CodeObject which this log 
     #  is associated with, if any. This is shown before the log message if it is
     #  specified.
-    # @yieldparam [Integer] indent_level The level at which to indent the code.
     # @yieldreturn [void]
     # @return [void]
     def self.add_hook(&blk)

data/lib/sord/parlour_plugin.rb

@@ -0,0 +1,63 @@
+# typed: true
+require 'parlour'
+
+module Sord
+  class ParlourPlugin < Parlour::Plugin
+    attr_reader :options
+    attr_accessor :parlour
+
+    def initialize(options)
+      @parlour = nil
+      @options = options
+
+      options[:comments] = true if options[:comments].nil?
+      options[:regenerate] = true if options[:regenerate].nil?
+      options[:replace_errors_with_untyped] ||= false
+      options[:replace_unresolved_with_untyped] ||= false
+    end
+
+    def generate(root)
+      if options[:include_messages] && options[:exclude_messages]
+        Sord::Logging.error('Please specify only one of --include-messages and --exclude-messages.')
+        return false
+      elsif options[:include_messages]
+        whitelist = options[:include_messages].map { |x| x.downcase.to_sym }
+        unless Sord::Logging.valid_types?(whitelist)
+          Sord::Logging.error('Not all types on your --include-messages list are valid.')
+          Sord::Logging.error("Valid options are: #{Sord::Logging::AVAILABLE_TYPES.map(&:to_s).join(', ')}")
+          return false
+        end
+        Sord::Logging.enabled_types = whitelist | [:done]
+      elsif options[:exclude_messages]
+        blacklist = options[:exclude_messages].map { |x| x.downcase.to_sym }
+        unless Sord::Logging.valid_types?(blacklist)
+          Sord::Logging.error('Not all types on your --include-messages list are valid.')
+          Sord::Logging.error("Valid options are: #{Sord::Logging::AVAILABLE_TYPES.map(&:to_s).join(', ')}")
+          return false
+        end
+        Sord::Logging.enabled_types = Sord::Logging::AVAILABLE_TYPES - blacklist
+      end
+  
+      if options[:regenerate]
+        begin
+          Sord::Logging.info('Running YARD...')
+          Bundler.with_clean_env do
+            system('bundle exec yard')
+          end
+        rescue Errno::ENOENT
+          Sord::Logging.error('The YARD tool could not be found on your PATH.')
+          Sord::Logging.error('You may need to run \'gem install yard\'.')
+          Sord::Logging.error('If documentation has already been generated, pass --no-regenerate to Sord.')
+          return false
+        end
+      end
+
+      options[:parlour] = @parlour
+      options[:root] = root
+
+      Sord::RbiGenerator.new(options).run
+
+      true
+    end
+  end
+end