rucoa 0.11.0 → 0.13.0

data/lib/rucoa/nodes/base.rb

@@ -14,24 +14,19 @@ module Rucoa
         end
       end
 
-      # @return [Rucoa::Nodes::Base, nil]
-      def parent
-        @mutable_attributes[:parent]
-      end
-
-      # @param node [Rucoa::Nodes::Base]
-      def parent=(node)
-        @mutable_attributes[:parent] = node
-      end
-
       # @return [Array<Rucoa::Nodes::Base>]
       def ancestors
         each_ancestor.to_a
       end
 
       # @return [Array<Rucoa::Nodes::Base>]
-      def descendants
-        each_descendant.to_a
+      def child_nodes
+        each_child_node.to_a
+      end
+
+      # @return [Array<Rucoa::Nodes::Base>]
+      def descendant_nodes
+        each_descendant_node.to_a
       end
 
       # @param types [Array<Symbol>]
@@ -63,33 +58,16 @@ module Rucoa
       # @param types [Array<Symbol>]
       # @return [Rucoa::Nodes::Base] if a block is given
       # @return [Enumerator] if no block is given
-      def each_descendant(
+      def each_descendant_node(
         *types,
         &block
       )
         return to_enum(__method__, *types) unless block
 
-        visit_descendants(types, &block)
+        visit_descendant_nodes(types, &block)
         self
       end
 
-      # @note Override.
-      #   Some nodes change their type depending on the context.
-      #   For example, `const` node can be `casgn` node.
-      # @return [Rucoa::Nodes::Base]
-      def updated(
-        type = nil,
-        children = nil,
-        properties = {}
-      )
-        properties[:location] ||= @location
-        ParserBuilder.node_class_for(type || @type).new(
-          type || @type,
-          children || @children,
-          properties
-        )
-      end
-
       # @param position [Rucoa::Position]
       # @return [Boolean]
       def include_position?(position)
@@ -98,6 +76,29 @@ module Rucoa
         Range.from_parser_range(location.expression).include?(position)
       end
 
+      # @return [Array<String>]
+      # @example return ["Bar::Foo", "Foo"] for class Foo::Bar::Baz
+      #   node = Rucoa::Source.new(
+      #     content: <<~RUBY,
+      #       module Foo
+      #         module Bar
+      #           module Baz
+      #           end
+      #         end
+      #       end
+      #     RUBY
+      #     uri: 'file:///path/to/foo/bar/baz.rb'
+      #   ).node_at(
+      #     Rucoa::Position.new(
+      #       column: 4,
+      #       line: 3
+      #     )
+      #   )
+      #   expect(node.module_nesting).to eq(['Foo::Bar', 'Foo'])
+      def module_nesting
+        each_ancestor(:class, :module).map(&:qualified_name)
+      end
+
       # @note namespace is a String representation of `Module.nesting`.
       # @return [String]
       # @example returns namespace
@@ -130,46 +131,109 @@ module Rucoa
         module_nesting.first || 'Object'
       end
 
-      # @return [Array<String>]
-      # @example return ["Bar::Foo", "Foo"] for class Foo::Bar::Baz
+      # @return [Array<Rucoa::Nodes::Base>]
+      # @example returns next siblings
       #   node = Rucoa::Source.new(
       #     content: <<~RUBY,
-      #       module Foo
-      #         module Bar
-      #           module Baz
-      #           end
-      #         end
+      #       def foo
+      #         a
+      #         b
+      #         c
+      #         d
+      #         e
       #       end
       #     RUBY
-      #     uri: 'file:///path/to/foo/bar/baz.rb'
+      #     uri: 'file:///path/to/example.rb'
       #   ).node_at(
       #     Rucoa::Position.new(
-      #       column: 4,
-      #       line: 3
+      #       column: 2,
+      #       line: 4
       #     )
       #   )
-      #   expect(node.module_nesting).to eq(['Foo::Bar', 'Foo'])
-      def module_nesting
-        each_ancestor(:class, :module).map(&:qualified_name)
+      #   expect(node.next_sibling_nodes.map(&:name)).to eq(%w[d e])
+      def next_sibling_nodes
+        return [] unless parent
+
+        parent.child_nodes[(sibling_node_index + 1)..]
+      end
+
+      # @return [Rucoa::Nodes::Base, nil]
+      def parent
+        @mutable_attributes[:parent]
+      end
+
+      # @param node [Rucoa::Nodes::Base]
+      def parent=(node)
+        @mutable_attributes[:parent] = node
+      end
+
+      # @return [Array<Rucoa::Nodes::Base>]
+      # @example returns previous siblings
+      #   node = Rucoa::Source.new(
+      #     content: <<~RUBY,
+      #       def foo
+      #         a
+      #         b
+      #         c
+      #         d
+      #         e
+      #       end
+      #     RUBY
+      #     uri: 'file:///path/to/example.rb'
+      #   ).node_at(
+      #     Rucoa::Position.new(
+      #       column: 2,
+      #       line: 4
+      #     )
+      #   )
+      #   expect(node.previous_sibling_nodes.map(&:name)).to eq(%w[a b])
+      def previous_sibling_nodes
+        return [] unless parent
+
+        parent.child_nodes[0...sibling_node_index]
+      end
+
+      # @note Override.
+      #   Some nodes change their type depending on the context.
+      #   For example, `const` node can be `casgn` node.
+      # @return [Rucoa::Nodes::Base]
+      def updated(
+        type = nil,
+        children = nil,
+        properties = {}
+      )
+        properties[:location] ||= @location
+        ParserBuilder.node_class_for(type || @type).new(
+          type || @type,
+          children || @children,
+          properties
+        )
       end
 
       protected
 
-      # Visit all descendants.
+      # Visit all descendant_nodes.
       # @param types [Array<Symbol>]
       # @return [void]
-      def visit_descendants(
+      def visit_descendant_nodes(
         types,
         &block
       )
         each_child_node do |child|
           yield(child) if types.empty? || types.include?(child.type)
-          child.visit_descendants(types, &block)
+          child.visit_descendant_nodes(types, &block)
         end
       end
 
       private
 
+      # @return [Integer, nil]
+      def sibling_node_index
+        parent&.child_nodes&.index do |child|
+          child.equal?(self)
+        end
+      end
+
       # Visits all ancestors.
       # @param types [Array<Symbol>]
       # @return [void]

data/lib/rucoa/nodes/begin_node.rb

@@ -3,6 +3,8 @@
 module Rucoa
   module Nodes
     class BeginNode < Base
+      include NodeConcerns::Body
+      include NodeConcerns::Rescue
     end
   end
 end

data/lib/rucoa/nodes/block_node.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class BlockNode < Base
+      include NodeConcerns::Body
+      include NodeConcerns::Rescue
+
+      # @return [Array<Rucoa::Nodes::ArgNode>]
+      # @example returns arguments
+      #   node = Rucoa::Source.new(
+      #     content: <<~RUBY,
+      #       foo do |bar, baz|
+      #       end
+      #     RUBY
+      #     uri: 'file:///path/to/example.rb'
+      #   ).root_node
+      #   expect(node.arguments.map(&:name)).to eq(%w[bar baz])
+      def arguments
+        children[-2]
+      end
+
+      # @return [Rucoa::Nodes::SendNode]
+      # @example returns send node
+      #   node = Rucoa::Source.new(
+      #     content: <<~RUBY,
+      #       foo do
+      #       end
+      #     RUBY
+      #     uri: 'file:///foo.rb'
+      #   ).root_node
+      #   expect(node.send_node.name).to eq('foo')
+      def send_node
+        children[0]
+      end
+    end
+  end
+end

data/lib/rucoa/nodes/case_node.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class CaseNode < Base
+      # @return [Array<Rucoa::Nodes::Base>]
+      # @example returns when nodes
+      #   node = Rucoa::Source.new(
+      #     content: <<~RUBY,
+      #       case foo
+      #       when 1
+      #       when 2
+      #       else
+      #       end
+      #     RUBY
+      #     uri: 'file:///foo.rb'
+      #   ).root_node
+      #   expect(node.whens.length).to eq(2)
+      def whens
+        children[1...-1]
+      end
+    end
+  end
+end

data/lib/rucoa/nodes/const_node.rb

@@ -3,32 +3,6 @@
 module Rucoa
   module Nodes
     class ConstNode < Base
-      # @return [String]
-      # @example returns "A" for "A"
-      #   node = Rucoa::Source.new(
-      #     content: <<~RUBY,
-      #       A
-      #     RUBY
-      #     uri: 'file:///path/to/a.rb'
-      #   ).root_node
-      #   expect(node.name).to eq('A')
-      # @example returns "B" for "A::B"
-      #   node = Rucoa::Source.new(
-      #     content: <<~RUBY,
-      #       A::B
-      #     RUBY
-      #     uri: 'file:///path/to/a.rb'
-      #   ).node_at(
-      #     Rucoa::Position.new(
-      #       column: 4,
-      #       line: 1
-      #     )
-      #   )
-      #   expect(node.name).to eq('B')
-      def name
-        children[1].to_s
-      end
-
       # @return [String]
       # @example returns "A" for "A"
       #   node = Rucoa::Source.new(
@@ -91,6 +65,32 @@ module Rucoa
         each_ancestor(:class, :module).map(&:qualified_name)
       end
 
+      # @return [String]
+      # @example returns "A" for "A"
+      #   node = Rucoa::Source.new(
+      #     content: <<~RUBY,
+      #       A
+      #     RUBY
+      #     uri: 'file:///path/to/a.rb'
+      #   ).root_node
+      #   expect(node.name).to eq('A')
+      # @example returns "B" for "A::B"
+      #   node = Rucoa::Source.new(
+      #     content: <<~RUBY,
+      #       A::B
+      #     RUBY
+      #     uri: 'file:///path/to/a.rb'
+      #   ).node_at(
+      #     Rucoa::Position.new(
+      #       column: 4,
+      #       line: 1
+      #     )
+      #   )
+      #   expect(node.name).to eq('B')
+      def name
+        children[1].to_s
+      end
+
       private
 
       # @return [Rucoa::Nodes::Base, nil]

data/lib/rucoa/nodes/cvar_node.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class CvarNode < Base
+      include NodeConcerns::Variable
+    end
+  end
+end

data/lib/rucoa/nodes/cvasgn_node.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class CvasgnNode < Base
+      include NodeConcerns::Variable
+    end
+  end
+end

data/lib/rucoa/nodes/def_node.rb

@@ -3,6 +3,32 @@
 module Rucoa
   module Nodes
     class DefNode < Base
+      include NodeConcerns::Body
+      include NodeConcerns::Rescue
+
+      # @return [Array<Rucoa::Nodes::ArgNode>]
+      # @example returns arguments
+      #   node = Rucoa::Source.new(
+      #     content: <<~RUBY,
+      #       def foo(bar, baz)
+      #       end
+      #     RUBY
+      #     uri: 'file:///path/to/example.rb'
+      #   ).root_node
+      #   expect(node.arguments.map(&:name)).to eq(%w[bar baz])
+      def arguments
+        children[-2]
+      end
+
+      # @return [String]
+      def method_marker
+        if singleton?
+          '.'
+        else
+          '#'
+        end
+      end
+
       # @return [String]
       # @example returns method name
       #   node = Rucoa::Source.new(
@@ -23,7 +49,7 @@ module Rucoa
       #   )
       #   expect(node.name).to eq('baz')
       def name
-        children[0].to_s
+        children[-3].to_s
       end
 
       # @return [String]
@@ -55,18 +81,7 @@ module Rucoa
 
       # @return [Boolean]
       def singleton?
-        each_ancestor(:sclass).any?
-      end
-
-      private
-
-      # @return [String]
-      def method_marker
-        if singleton?
-          '.'
-        else
-          '#'
-        end
+        type == :defs || each_ancestor(:sclass).any?
       end
     end
   end

data/lib/rucoa/nodes/ensure_node.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class EnsureNode < Base
+      # @return [Rucoa::Nodes::Base, nil]
+      def body
+        children[0]
+      end
+
+      # @return [Rucoa::Nodes::RescueNode, nil]
+      def rescue
+        return unless body.is_a?(Nodes::RescueNode)
+
+        body
+      end
+    end
+  end
+end

data/lib/rucoa/nodes/for_node.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class ForNode < Base
+    end
+  end
+end

data/lib/rucoa/nodes/gvar_node.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class GvarNode < Base
+      include NodeConcerns::Variable
+    end
+  end
+end

data/lib/rucoa/nodes/gvasgn_node.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class GvasgnNode < Base
+      include NodeConcerns::Variable
+    end
+  end
+end

data/lib/rucoa/nodes/if_node.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class IfNode < Base
+      include NodeConcerns::Modifier
+
+      # @return [Rucoa::Nodes::Base, nil]
+      def branch_else
+        children[2]
+      end
+
+      # @return [Rucoa::Nodes::Base, nil]
+      def branch_if
+        children[1]
+      end
+
+      # @return [Rucoa::Nodes::Base]
+      def condition
+        children[0]
+      end
+
+      # @return [Rucoa::Nodes::IfNode, nil]
+      def elsif
+        branch_else if branch_else.is_a?(Nodes::IfNode)
+      end
+
+      # @return [Boolean]
+      def elsif?
+        parent.is_a?(Nodes::IfNode) && equal?(parent.elsif)
+      end
+    end
+  end
+end

data/lib/rucoa/nodes/ivar_node.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class IvarNode < Base
+      include NodeConcerns::Variable
+    end
+  end
+end

data/lib/rucoa/nodes/ivasgn_node.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class IvasgnNode < Base
+      include NodeConcerns::Variable
+    end
+  end
+end

data/lib/rucoa/nodes/lvar_node.rb

@@ -3,24 +3,7 @@
 module Rucoa
   module Nodes
     class LvarNode < Base
-      # @return [String]
-      # @example returns local variable name
-      #   node = Rucoa::Source.new(
-      #     content: <<~RUBY,
-      #       foo = 1
-      #       foo
-      #     RUBY
-      #     uri: 'file:///path/to/example.rb'
-      #   ).node_at(
-      #     Rucoa::Position.new(
-      #       column: 2,
-      #       line: 2
-      #     )
-      #   )
-      #   expect(node.name).to eq('foo')
-      def name
-        children[0].to_s
-      end
+      include NodeConcerns::Variable
     end
   end
 end

data/lib/rucoa/nodes/lvasgn_node.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class LvasgnNode < Base
+      include NodeConcerns::Variable
+    end
+  end
+end

data/lib/rucoa/nodes/resbody_node.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class ResbodyNode < Base
+    end
+  end
+end

data/lib/rucoa/nodes/rescue_node.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class RescueNode < Base
+      # @return [Rucoa::Nodes::Base, nil]
+      def body
+        children[0]
+      end
+
+      # @return [Array<Rucoa::Nodes::Resbody>]
+      def resbodies
+        children[1..-2]
+      end
+    end
+  end
+end

data/lib/rucoa/nodes/send_node.rb

@@ -21,6 +21,39 @@ module Rucoa
         children[2..]
       end
 
+      # @return [Rucoa::Nodes::BlockNode, nil]
+      # @example returns nil for method call without block
+      #   node = Rucoa::Source.new(
+      #     content: <<~RUBY,
+      #       foo
+      #     RUBY
+      #     uri: 'file:///path/to/example.rb'
+      #   ).node_at(
+      #     Rucoa::Position.new(
+      #       column: 0,
+      #       line: 1
+      #     )
+      #   )
+      #   expect(node.block).to be_nil
+      # @example returns block
+      #   node = Rucoa::Source.new(
+      #     content: <<~RUBY,
+      #       foo do
+      #         bar
+      #       end
+      #     RUBY
+      #     uri: 'file:///path/to/example.rb'
+      #   ).node_at(
+      #     Rucoa::Position.new(
+      #       column: 0,
+      #       line: 1
+      #     )
+      #   )
+      #   expect(node.block).to be_a(Rucoa::Nodes::BlockNode)
+      def block
+        parent if called_with_block?
+      end
+
       # @return [String]
       # @example returns method name
       #   node = Rucoa::Source.new(
@@ -59,6 +92,13 @@ module Rucoa
       def receiver
         children[0]
       end
+
+      private
+
+      # @return [Boolean]
+      def called_with_block?
+        parent.is_a?(Nodes::BlockNode) && equal?(parent.send_node)
+      end
     end
   end
 end

data/lib/rucoa/nodes/until_node.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class UntilNode < Base
+      include NodeConcerns::Modifier
+    end
+  end
+end

data/lib/rucoa/nodes/when_node.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class WhenNode < Base
+    end
+  end
+end