parlour 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12b7eca4df3f9c2609ae2f8cabbf07b73a26c66f596ce060aea6f9faec5a494d
-  data.tar.gz: 6ca3cf5d7d22d15fd3270adf78044b4aa8286808074c0e0c9b43b68ef4be0bdb
+  metadata.gz: 5a670215d6246dfe4cc4aec9e3dd5121cf1da1357dbc1703a53dd059d3467d47
+  data.tar.gz: 6c8fa32d0adb363b72d43e307fb38c443dd469444ffbefddaa561e841b108846
 SHA512:
-  metadata.gz: d90cfc6922e9b4ccea622d31d4cdbfe422e6cd8292cdae12a1b2e70ee51bfd1d1779ae66b1b213c14806e3239306f92e149e2d280387127c66147f570d8e198d
-  data.tar.gz: a9f75203ac84c20e91dd24702c904b79741f1156b4975da43d3078423e316ecb534ae56261a4c949454175ee49ba4d5f44236dcadadcebb6368f00a30d52d937
+  metadata.gz: '0089e4ef2b9cf1855bba3e1a8a1a5faeae2a020003c9625ef95e96fb7c6b0293cf44cf8fda4a2a312fe3ea91d9b10e05cd70d83b96cc80eb1354741958210140'
+  data.tar.gz: b9554148306f4a0453cf4d6e9244581a6380df6341d0ec88033b91c917ef4a1d9e67f7448cc51758b7ec8c98044583810ccb68ad5a85aa3b221086e9c105844f

data/CHANGELOG.md

@@ -3,6 +3,15 @@ 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.8.1] - 2019-09-27
+### Added
+- Running with the PARLOUR_DEBUG environment variable set will now print debug
+output to the console during conflict resolution.
+
+### Fixed
+- Performance is now much faster when the conflict resolver needs to resolve a
+conflict between many identical objects.
+
 ## [0.8.0] - 2019-09-14
 ### Added
 - Methods can now have type parameters specified.

data/README.md

@@ -152,7 +152,7 @@ _Have you written an awesome Parlour plugin? Please submit a PR to add it to thi
 
   - [Sord](https://github.com/AaronC81/sord) - Generate RBIs from YARD documentation
   - [parlour-datamapper](https://github.com/AaronC81/parlour-datamapper) - Simple plugin for generating DataMapper model types
-
+  - [sorbet-rails](https://github.com/chanzuckerberg/sorbet-rails) - Generate RBIs for Rails models, routes, mailers, etc.
 
 ## Contributing
 

data/lib/parlour.rb

@@ -3,6 +3,8 @@ require 'sorbet-runtime'
 
 require 'parlour/version'
 
+require 'parlour/debugging'
+
 require 'parlour/kernel_hack'
 
 require 'parlour/plugin'

data/lib/parlour/conflict_resolver.rb

@@ -39,23 +39,49 @@ module Parlour
     #   will be kept, or nil to keep none of them.
     # @return [void]
     def resolve_conflicts(namespace, &resolver)
+      Debugging.debug_puts(self, Debugging::Tree.begin("Resolving conflicts for #{namespace.name}..."))
+
       # Check for multiple definitions with the same name
       grouped_by_name_children = namespace.children.group_by(&:name)
 
       grouped_by_name_children.each do |name, children|
+        Debugging.debug_puts(self, Debugging::Tree.begin("Checking children named #{name}..."))
+
         if children.length > 1
+          Debugging.debug_puts(self, Debugging::Tree.here("Possible conflict between #{children.length} objects"))
+
           # Special case: do we have two methods, one of which is a class method 
           # and the other isn't? If so, do nothing - this is fine
-          next if children.length == 2 &&
+          if children.length == 2 &&
             children.all? { |c| c.is_a?(RbiGenerator::Method) } &&
             children.count { |c| T.cast(c, RbiGenerator::Method).class_method } == 1
 
+            Debugging.debug_puts(self, Debugging::Tree.end("One is an instance method and one is a class method; no resolution required"))
+            next
+          end
+
           # Special case: do we have two attributes, one of which is a class 
           # attribute and the other isn't? If so, do nothing - this is fine
-          next if children.length == 2 &&
+          if children.length == 2 &&
             children.all? { |c| c.is_a?(RbiGenerator::Attribute) } &&
             children.count { |c| T.cast(c, RbiGenerator::Attribute).class_attribute } == 1
 
+            Debugging.debug_puts(self, Debugging::Tree.end("One is an instance attribute and one is a class attribute; no resolution required"))
+            next
+          end
+
+          # Special case: are they all clearly equal? If so, remove all but one
+          if all_eql?(children)
+            Debugging.debug_puts(self, Debugging::Tree.end("All children are identical"))
+
+            # All of the children are the same, so this deletes all of them
+            namespace.children.delete(T.must(children.first))
+          
+            # Re-add one child
+            namespace.children << T.must(children.first)
+            next
+          end
+
           # We found a conflict!
           # Start by removing all the conflicting items
           children.each do |c|
@@ -66,7 +92,8 @@ module Parlour
           # type of object, so check that first
           children_type = single_type_of_array(children)
           unless children_type
-            # The types aren't the same, so ask the resovler what to do, and
+            Debugging.debug_puts(self, Debugging::Tree.end("Children are different types; requesting manual resolution"))
+            # The types aren't the same, so ask the resolver what to do, and
             # insert that (if not nil)
             choice = resolver.call("Different kinds of definition for the same name", children)
             namespace.children << choice if choice
@@ -77,21 +104,29 @@ module Parlour
           first, *rest = children
           first, rest = T.must(first), T.must(rest)
           if T.must(first).mergeable?(T.must(rest))
+            Debugging.debug_puts(self, Debugging::Tree.end("Children are all mergeable; resolving automatically"))
             first.merge_into_self(rest)
             namespace.children << first
             next
           end
 
           # I give up! Let it be resolved manually somehow
+          Debugging.debug_puts(self, Debugging::Tree.end("Unable to resolve automatically; requesting manual resolution"))
           choice = resolver.call("Can't automatically resolve", children)
           namespace.children << choice if choice
+        else
+          Debugging.debug_puts(self, Debugging::Tree.end("No conflicts"))
         end
       end
 
+      Debugging.debug_puts(self, Debugging::Tree.here("Resolving children..."))
+
       # Recurse to child namespaces
       namespace.children.each do |child|
         resolve_conflicts(child, &resolver) if RbiGenerator::Namespace === child
       end
+
+      Debugging.debug_puts(self, Debugging::Tree.end("All children done"))
     end
 
     private

data/lib/parlour/debugging.rb

@@ -0,0 +1,122 @@
+# typed: true
+require 'rainbow'
+
+module Parlour
+  # Contains methods to enable debugging facilities for Parlour.
+  module Debugging
+    extend T::Sig
+
+    @debug_mode = !ENV["PARLOUR_DEBUG"].nil?
+
+    # Set whether debug messages should be printed.
+    # @param [Boolean] value True if debug messages will be printed, false
+    #   otherwise.
+    # @return [Boolean] The new value.
+    sig { params(value: T::Boolean).returns(T::Boolean) }
+    def self.debug_mode=(value)
+      @debug_mode = value
+    end
+
+    # Whether debug messages sent by {#debug_puts} should be printed.
+    # Defaults to true if the PARLOUR_DEBUG environment variable is set.
+    # @return [Boolean] True if debug messages will be printed, false otherwise.
+    sig { returns(T::Boolean) }
+    def self.debug_mode?
+      @debug_mode
+    end
+
+    # Prints a message with a debugging prefix to STDOUT if {#debug_mode?} is
+    # true.
+    # @params [Object] object The object which is printing this debug message. 
+    #   Callers should pass +self+.
+    # @params [String] message The message to print. It should not contain
+    #   newlines.
+    # @return [void]
+    sig { params(object: T.untyped, message: String).void }
+    def self.debug_puts(object, message)
+      return unless debug_mode?
+      name = Rainbow("#{name_for_debug_caller(object)}: ").magenta.bright.bold
+      prefix = Rainbow("Parlour debug: ").blue.bright.bold
+      puts prefix + name + message
+    end
+
+    # Converts the given object into a human-readable prefix to a debug message.
+    # For example, passing an instance of {ConflictResolver} returns
+    # "conflict resolver". If the object type is unknown, this returns its class
+    # name.
+    # @param [Object] object The object to convert.
+    # @return [String] A string describing the object for {#debug_puts}. 
+    sig { params(object: T.untyped).returns(String) }
+    def self.name_for_debug_caller(object)
+      case object
+      when ConflictResolver
+        "conflict resolver"
+      when RbiGenerator
+        "RBI generator"
+      else
+        if ((object < Plugin) rescue false)
+          return "plugin #{object.name}"
+        end
+        object.class.name
+      end
+    end
+
+    # A module for generating a globally-consistent, nicely-formatted tree of
+    # output using Unicode block characters.
+    module Tree
+      extend T::Sig
+
+      # The number of spaces to indent each layer of the tree by. Should be at
+      # least 1.
+      INDENT_SPACES = 2
+
+      # The current indent level of the tree.
+      @indent_level = 0
+
+      # Returns a new heading, and then decents the tree one level into it. 
+      # (That is, future output will go under the new heading.)
+      # @param [String] message The heading.
+      # @return [String] The line of this tree which should be printed.
+      sig { params(message: String).returns(String) }
+      def self.begin(message)
+        result = line_prefix + '├' + text_prefix + Rainbow(message).green.bright.bold
+        @indent_level += 1
+        result
+      end
+
+      # Prints a new tree element at the current level.
+      # @param [String] message The element.
+      # @return [String] The line of this tree which should be printed.
+      sig { params(message: String).returns(String) }
+      def self.here(message)
+        line_prefix + '├' + text_prefix + message
+      end
+
+      # Prints the final tree element at the current level, then ascends one
+      # level.
+      # @param [String] message The element.
+      # @return [String] The line of this tree which should be printed.
+      sig { params(message: String).returns(String) }
+      def self.end(message)
+        result = line_prefix + '└' + text_prefix + message
+        @indent_level = [0, @indent_level - 1].max
+        result
+      end
+
+      # The prefix which should be printed before anything else on this line of
+      # the tree, based on the current indent level.
+      # @return [String]
+      def self.line_prefix
+        @indent_level.times.map { '│' + ' ' * INDENT_SPACES }.join
+      end
+
+      # The horizontal lines which should be printed between the beginning of
+      # the current element and its text, based on the specified number of
+      # spaces to use for indents.
+      # @return [String]
+      def self.text_prefix
+        '─' * (INDENT_SPACES - 1) + " "
+      end
+    end
+  end
+end

data/lib/parlour/plugin.rb

@@ -25,6 +25,7 @@ module Parlour
     # @param new_plugin [Plugin] The new plugin.
     # @return [void]
     def self.inherited(new_plugin)
+      Debugging.debug_puts(self, 'Registered')
       registered_plugins[T.must(new_plugin.name)] = new_plugin
     end
 

data/lib/parlour/rbi_generator/method.rb

@@ -54,7 +54,7 @@ module Parlour
         yield_self(&block) if block
       end
 
-      sig { overridable.params(other: Object).returns(T::Boolean) }
+      sig { overridable.params(other: Object).returns(T::Boolean).checked(:never) }
       # Returns true if this instance is equal to another method.
       #
       # @param other [Object] The other instance. If this is not a {Method} (or a

data/lib/parlour/version.rb

@@ -1,5 +1,5 @@
 # typed: strong
 module Parlour
   # The library version.
-  VERSION = '0.8.0'
+  VERSION = '0.8.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parlour
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Aaron Christiansen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-14 00:00:00.000000000 Z
+date: 2019-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
@@ -130,6 +130,7 @@ files:
 - exe/parlour
 - lib/parlour.rb
 - lib/parlour/conflict_resolver.rb
+- lib/parlour/debugging.rb
 - lib/parlour/kernel_hack.rb
 - lib/parlour/plugin.rb
 - lib/parlour/rbi_generator.rb