rubocop-schema 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 74ebb239864efb97d282fd4b9e8064ad9fafafb9
-  data.tar.gz: 1b30fa6f53e8e3f2c20015d32cb6e8f41b28887e
+  metadata.gz: 5605a5aa19b68890f91c69788d78b5a675e86f67
+  data.tar.gz: 5cf07e32d62124447777ed27c49b02122e922372
 SHA512:
-  metadata.gz: e0cee0a3383c134ef4f7241b936d3afc9cbf7669e43df9e235a26f42aa8c36e4a28625864f9d740620487641adfe0dfe3586deb7c25ce420df4ccc5615296982
-  data.tar.gz: e3aae90d5df023bb9c4279de2a414aaade64d1d70f497e73ba50a581aa369486748980cbb900afddf8c253531c0292b1fc3a1d212348c9fe0b402d7ff6b54348
+  metadata.gz: 48264645ec6bbed4ddcb05b845fbdcc9d7d5cbc512f26fa2e75e30a6d0ea881824e127dd7f41912231d55a070973a11140e8b03453e27b710441649d02c3e736
+  data.tar.gz: dd864cc9159875b3695a2a8fb7bb7bba06458169a4f215df1d25b1f1d90812776320cd434d2e842f13e7b613979c710eb86b58f120d74fb5ea4b6eefbe2db73e

data/lib/rubocop/ast/builder.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # `RuboCop::Builder` is an AST builder that is utilized to let `Parser`
+    # generate ASTs with {RuboCop::AST::Node}.
+    #
+    # @example
+    #   buffer = Parser::Source::Buffer.new('(string)')
+    #   buffer.source = 'puts :foo'
+    #
+    #   builder = RuboCop::Builder.new
+    #   parser = Parser::CurrentRuby.new(builder)
+    #   root_node = parser.parse(buffer)
+    class Builder < Parser::Builders::Default
+      NODE_MAP = {
+        AndNode          => [:and],
+        ArgsNode         => [:args],
+        ArrayNode        => [:array],
+        DefNode          => %i[def defs],
+        BlockNode        => [:block],
+        CaseNode         => [:case],
+        EnsureNode       => [:ensure],
+        ForNode          => [:for],
+        HashNode         => [:hash],
+        IfNode           => [:if],
+        KeywordSplatNode => [:kwsplat],
+        OrNode           => [:or],
+        PairNode         => [:pair],
+        ResbodyNode      => [:resbody],
+        SendNode         => %i[csend send],
+        SuperNode        => %i[super zsuper],
+        UntilNode        => %i[until until_post],
+        WhenNode         => [:when],
+        WhileNode        => %i[while while_post]
+      }.freeze
+
+      # Generates {Node} from the given information.
+      #
+      # @return [Node] the generated node
+      def n(type, children, source_map)
+        node_klass(type).new(type, children, location: source_map)
+      end
+
+      # TODO: Figure out what to do about literal encoding handling...
+      # More details here https://github.com/whitequark/parser/issues/283
+      def string_value(token)
+        value(token)
+      end
+
+      private
+
+      def node_klass(type)
+        node_map[type] || Node
+      end
+
+      # Take the human readable constant and generate a hash map where each
+      # (mapped) node type is a key with its constant as the value.
+      def node_map
+        @node_map ||= begin
+          NODE_MAP.each_pair.each_with_object({}) do |(klass, types), map|
+            types.each { |type| map[type] = klass }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/ast/node/def_node.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # A node extension for `def` nodes. This will be used in place of a plain
+    # node when the builder constructs the AST, making its methods available
+    # to all `def` nodes within RuboCop.
+    class DefNode < Node
+      include ParameterizedNode
+      include MethodIdentifierPredicates
+
+      # Checks whether this node body is a void context.
+      #
+      # @return [Boolean] whether the `def` node body is a void context
+      def void_context?
+        method?(:initialize) || assignment_method?
+      end
+
+      # The name of the defined method as a symbol.
+      #
+      # @return [Symbol] the name of the defined method
+      def method_name
+        node_parts[2]
+      end
+
+      # An array containing the arguments of the method definition.
+      #
+      # @return [Array<Node>] the arguments of the method definition
+      def arguments
+        node_parts[1]
+      end
+
+      # The body of the method definition.
+      #
+      # @note this can be either a `begin` node, if the method body contains
+      #       multiple expressions, or any other node, if it contains a single
+      #       expression.
+      #
+      # @return [Node] the body of the method definition
+      def body
+        node_parts[0]
+      end
+
+      # The receiver of the method definition, if any.
+      #
+      # @return [Node, nil] the receiver of the method definition, or `nil`.
+      def receiver
+        node_parts[3]
+      end
+
+      # Custom destructuring method. This can be used to normalize
+      # destructuring for different variations of the node.
+      #
+      # In this case, the `def` node destructures into:
+      #
+      #   `method_name, arguments, body`
+      #
+      # while the `defs` node destructures into:
+      #
+      #   `receiver, method_name, arguments, body`
+      #
+      # so we reverse the destructured array to get the optional receiver
+      # at the end, where it can be discarded.
+      #
+      # @return [Array] the different parts of the `def` or `defs` node
+      def node_parts
+        to_a.reverse
+      end
+    end
+  end
+end

data/lib/rubocop-schema.rb

@@ -1,5 +1,7 @@
 require 'rubocop'
 require 'rubocop/style/inject'
+require 'rubocop/ast/builder'
+require 'rubocop/ast/node/def_node'
 RuboCop::Style::Inject.defaults!
 
 require 'rubocop/cop/style/schema_comments'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-schema
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - ceclinux
@@ -32,6 +32,8 @@ extra_rdoc_files: []
 files:
 - config/default.yml
 - lib/rubocop-schema.rb
+- lib/rubocop/ast/builder.rb
+- lib/rubocop/ast/node/def_node.rb
 - lib/rubocop/cop/style/migration_comments.rb
 - lib/rubocop/cop/style/schema_comments.rb
 - lib/rubocop/style/inject.rb