rucoa 0.11.0 → 0.12.0

data/lib/rucoa/nodes/base.rb

@@ -14,16 +14,6 @@ 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
@@ -73,23 +63,6 @@ module Rucoa
         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 +71,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,27 +126,31 @@ module Rucoa
         module_nesting.first || 'Object'
       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)
+      # @return [Rucoa::Nodes::Base, nil]
+      def parent
+        @mutable_attributes[:parent]
+      end
+
+      # @param node [Rucoa::Nodes::Base]
+      def parent=(node)
+        @mutable_attributes[:parent] = node
+      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

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,24 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class BlockNode < Base
+      include NodeConcerns::Body
+      include NodeConcerns::Rescue
+
+      # @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/def_node.rb

@@ -3,6 +3,18 @@
 module Rucoa
   module Nodes
     class DefNode < Base
+      include NodeConcerns::Body
+      include NodeConcerns::Rescue
+
+      # @return [String]
+      def method_marker
+        if singleton?
+          '.'
+        else
+          '#'
+        end
+      end
+
       # @return [String]
       # @example returns method name
       #   node = Rucoa::Source.new(
@@ -23,7 +35,7 @@ module Rucoa
       #   )
       #   expect(node.name).to eq('baz')
       def name
-        children[0].to_s
+        children[-3].to_s
       end
 
       # @return [String]
@@ -55,18 +67,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/if_node.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class IfNode < Base
+      # @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) && eql?(parent.elsif)
+      end
+    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) && eql?(parent.send_node)
+      end
     end
   end
 end

data/lib/rucoa/nodes/until_node.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Rucoa
+  module Nodes
+    class UntilNode < Base
+    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

data/lib/rucoa/nodes/while_node.rb

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

data/lib/rucoa/nodes.rb

@@ -4,17 +4,26 @@ module Rucoa
   module Nodes
     autoload :Base, 'rucoa/nodes/base'
     autoload :BeginNode, 'rucoa/nodes/begin_node'
+    autoload :BlockNode, 'rucoa/nodes/block_node'
+    autoload :CaseNode, 'rucoa/nodes/case_node'
     autoload :CasgnNode, 'rucoa/nodes/casgn_node'
     autoload :CbaseNode, 'rucoa/nodes/cbase_node'
     autoload :ClassNode, 'rucoa/nodes/class_node'
     autoload :ConstNode, 'rucoa/nodes/const_node'
     autoload :DefNode, 'rucoa/nodes/def_node'
-    autoload :DefsNode, 'rucoa/nodes/defs_node'
+    autoload :EnsureNode, 'rucoa/nodes/ensure_node'
+    autoload :ForNode, 'rucoa/nodes/for_node'
+    autoload :IfNode, 'rucoa/nodes/if_node'
     autoload :LvarNode, 'rucoa/nodes/lvar_node'
     autoload :ModuleNode, 'rucoa/nodes/module_node'
+    autoload :ResbodyNode, 'rucoa/nodes/resbody_node'
+    autoload :RescueNode, 'rucoa/nodes/rescue_node'
     autoload :SclassNode, 'rucoa/nodes/sclass_node'
     autoload :SendNode, 'rucoa/nodes/send_node'
     autoload :StrNode, 'rucoa/nodes/str_node'
     autoload :SymNode, 'rucoa/nodes/sym_node'
+    autoload :UntilNode, 'rucoa/nodes/until_node'
+    autoload :WhenNode, 'rucoa/nodes/when_node'
+    autoload :WhileNode, 'rucoa/nodes/while_node'
   end
 end

data/lib/rucoa/parser_builder.rb

@@ -6,18 +6,32 @@ module Rucoa
   class ParserBuilder < ::Parser::Builders::Default
     NODE_CLASS_BY_TYPE = {
       begin: Nodes::BeginNode,
+      block: Nodes::BlockNode,
+      case: Nodes::CaseNode,
       casgn: Nodes::CasgnNode,
       cbase: Nodes::CbaseNode,
       class: Nodes::ClassNode,
       const: Nodes::ConstNode,
+      csend: Nodes::SendNode,
       def: Nodes::DefNode,
-      defs: Nodes::DefsNode,
+      defs: Nodes::DefNode,
+      ensure: Nodes::EnsureNode,
+      for: Nodes::ForNode,
+      if: Nodes::IfNode,
+      kwbegin: Nodes::BeginNode,
       lvar: Nodes::LvarNode,
       module: Nodes::ModuleNode,
+      resbody: Nodes::ResbodyNode,
+      rescue: Nodes::RescueNode,
       sclass: Nodes::SclassNode,
       send: Nodes::SendNode,
       str: Nodes::StrNode,
-      sym: Nodes::SymNode
+      super: Nodes::SendNode,
+      sym: Nodes::SymNode,
+      until: Nodes::UntilNode,
+      when: Nodes::WhenNode,
+      while: Nodes::WhileNode,
+      zsuper: Nodes::SendNode
     }.freeze
 
     class << self

data/lib/rucoa/range.rb

@@ -103,6 +103,12 @@ module Rucoa
     #   )
     #   expect(range).to include(
     #     Rucoa::Position.new(
+    #       column: 1,
+    #       line: 1
+    #     )
+    #   )
+    #   expect(range).to include(
+    #     Rucoa::Position.new(
     #       column: 0,
     #       line: 2
     #     )
@@ -116,9 +122,9 @@ module Rucoa
     def include?(position)
       return false if position.line > @ending.line
       return false if position.line < @beginning.line
-      return false if position.column < @beginning.column
-      return false if position.column > @ending.column
-      return false if position.column == @ending.column && !@including_ending
+      return false if position.line == @beginning.line && position.column < @beginning.column
+      return false if position.line == @ending.line && position.column > @ending.column
+      return false if position.line == @ending.line && position.column == @ending.column && !@including_ending
 
       true
     end

data/lib/rucoa/rbs/constant_definition_mapper.rb

@@ -32,15 +32,15 @@ module Rucoa
         @declaration.comment&.string&.sub(/\A\s*<!--.*-->\s*/m, '')
       end
 
-      # @return [String]
-      def qualified_name
-        @declaration.name.to_s.delete_prefix('::')
-      end
-
       # @return [Rucoa::Location]
       def location
         Location.from_rbs_location(@declaration.location)
       end
+
+      # @return [String]
+      def qualified_name
+        @declaration.name.to_s.delete_prefix('::')
+      end
     end
   end
 end

data/lib/rucoa/rbs/method_definition_mapper.rb

@@ -42,23 +42,19 @@ module Rucoa
 
       private
 
-      # @return [Array<Rucoa::Types::MethodType>]
-      def types
-        @method_definition.types.map do |method_type|
-          MethodTypeMapper.call(
-            method_type: method_type
-          )
-        end
-      end
-
       # @return [String, nil]
       def description
         @method_definition.comment&.string&.sub(/\A\s*<!--.*-->\s*/m, '')
       end
 
-      # @return [String]
-      def namespace
-        @declaration.name.to_s.delete_prefix('::')
+      # @return [Symbol]
+      def kind
+        @method_definition.kind
+      end
+
+      # @return [Rucoa::Location]
+      def location
+        Location.from_rbs_location(@method_definition.location)
       end
 
       # @return [String]
@@ -66,14 +62,18 @@ module Rucoa
         @method_definition.name.to_s
       end
 
-      # @return [Symbol]
-      def kind
-        @method_definition.kind
+      # @return [String]
+      def namespace
+        @declaration.name.to_s.delete_prefix('::')
       end
 
-      # @return [Rucoa::Location]
-      def location
-        Location.from_rbs_location(@method_definition.location)
+      # @return [Array<Rucoa::Types::MethodType>]
+      def types
+        @method_definition.types.map do |method_type|
+          MethodTypeMapper.call(
+            method_type: method_type
+          )
+        end
       end
 
       class MethodTypeMapper

data/lib/rucoa/rbs/module_definition_mapper.rb

@@ -35,16 +35,6 @@ module Rucoa
         @declaration.comment&.string&.sub(/\A\s*<!--.*-->\s*/m, '')
       end
 
-      # @return [String]
-      def qualified_name
-        @declaration.name.to_s.delete_prefix('::')
-      end
-
-      # @return [Rucoa::Location]
-      def location
-        Location.from_rbs_location(@declaration.location)
-      end
-
       # @return [Array<String>]
       def extended_module_qualified_names
         module_qualified_names_for(::RBS::AST::Members::Extend)
@@ -55,9 +45,9 @@ module Rucoa
         module_qualified_names_for(::RBS::AST::Members::Include)
       end
 
-      # @return [Array<String>]
-      def prepended_module_qualified_names
-        module_qualified_names_for(::RBS::AST::Members::Prepend)
+      # @return [Rucoa::Location]
+      def location
+        Location.from_rbs_location(@declaration.location)
       end
 
       def module_qualified_names_for(member_class)
@@ -68,6 +58,16 @@ module Rucoa
           end
         end
       end
+
+      # @return [Array<String>]
+      def prepended_module_qualified_names
+        module_qualified_names_for(::RBS::AST::Members::Prepend)
+      end
+
+      # @return [String]
+      def qualified_name
+        @declaration.name.to_s.delete_prefix('::')
+      end
     end
   end
 end