masamune-ast 1.2.1 → 2.0.0

data/lib/masamune/lex_node.rb

@@ -1,17 +1,17 @@
 module Masamune
   # https://docs.ruby-lang.org/en/3.0/Ripper.html#method-c-lex
   #
-  # @position: Line number and starting point on the line. i.e. - [4, 7].
+  # @location: Line number and starting point on the line. i.e. - [4, 7].
   # @type: The type of token. i.e. - :kw (is a keyword).
   # @token: The raw string which represents the actual ruby code. i.e. - "do".
   # @state: Ripper::Lexer::State. i.e. - CMDARG.
   class LexNode
-    attr_accessor :position, :type, :token, :state, :ast_id
+    attr_accessor :location, :type, :token, :state, :ast_id
     attr_reader :index
 
     def initialize(index, raw_lex_node, ast_id)
       @index = index
-      @position, @type, @token, @state = raw_lex_node
+      @location, @type, @token, @state = raw_lex_node
       @type = @type.to_s.gsub(/^[a-z]*_/, "").to_sym
 
       # Since the Abstract Syntax Tree can get very large,
@@ -25,15 +25,15 @@ module Masamune
 
     def variable?
       return false unless identifier?
-      ast.variables(name: @token).any?
+      ast.variables(token_value: @token).any?
     end
 
     def method_definition?
-      ast.method_definitions(name: @token).any?
+      ast.method_definitions(token_value: @token).any?
     end
 
     def method_call?
-      ast.method_calls(name: @token).any?
+      ast.method_calls(token_value: @token).any?
     end
 
     def method?

data/lib/masamune/slasher.rb

@@ -1,34 +1,28 @@
 module Masamune
   module Slasher
-    def self.replace(type:, old_token:, new_token:, code:, ast:)
-      # `type` can either be a method from the ast like `method_definitions`,
-      # or it can be a list of Masamune::AbstractSyntaxTree node classes.
-      line_data_and_token_ary = if type.is_a?(Symbol)
+    def self.replace(type:, old_token_value:, new_token_value:, code:, ast:)
+      # `type` refers to the singluar form of a method name from the ast like `method_definitions`.
+      nodes = if type.is_a?(Symbol)
         type_to_method = type.to_s.pluralize.to_sym
         ast.send(type_to_method)
-      elsif type.is_a?(Array)
-        type.map {|klass| ast.find_nodes(klass)}.flatten
       end
 
-      tokens_to_replace = line_data_and_token_ary.select do |line_data_and_token|
-        line_data_and_token[:token] == old_token
+      nodes_of_tokens_to_replace = nodes.select do |node|
+        node.token_value == old_token_value
       end
 
       # Build from lex nodes
       result = ast.lex_nodes.map do |lex_node|
         match_found = false
-        tokens_to_replace.each do |line_data_and_token|
-          position = [
-            line_data_and_token[:line_number],
-            line_data_and_token[:index_on_line]
-          ]
-          if position == lex_node.position
+        nodes_of_tokens_to_replace.each do |node|
+          location = [node.token_location.start_line, node.token_location.start_column]
+          if location == lex_node.location
             match_found = true
             break
           end
         end
 
-        match_found ? new_token : lex_node.token
+        match_found ? new_token_value : lex_node.token
       end
 
       result.join

data/lib/masamune/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Masamune
-  VERSION = "1.2.1"
+  VERSION = "2.0.0"
 end

data/lib/masamune.rb

@@ -2,32 +2,20 @@
 
 require_relative "masamune/version"
 require "ripper"
+require "prism"
 require "active_support/core_ext/string/inflections"
+
+require "masamune/abstract_syntax_tree/visitors/block_parameters_visitor"
+require "masamune/abstract_syntax_tree/visitors/method_definitions_visitor"
+require "masamune/abstract_syntax_tree/visitors/method_calls_visitor"
+require "masamune/abstract_syntax_tree/visitors/parameters_visitor"
+require "masamune/abstract_syntax_tree/visitors/strings_visitor"
+require "masamune/abstract_syntax_tree/visitors/symbols_visitor"
+require "masamune/abstract_syntax_tree/visitors/variables_visitor"
+
 require "masamune/lex_node"
 require "masamune/slasher"
 require "masamune/abstract_syntax_tree"
-require "masamune/abstract_syntax_tree/node"
-require "masamune/abstract_syntax_tree/data_node"
-
-require "masamune/abstract_syntax_tree/nodes/support_nodes/block"
-require "masamune/abstract_syntax_tree/nodes/support_nodes/comment"
-
-require "masamune/abstract_syntax_tree/nodes/blocks/brace_block"
-require "masamune/abstract_syntax_tree/nodes/blocks/do_block"
-require "masamune/abstract_syntax_tree/nodes/symbols/dyna_symbol"
-require "masamune/abstract_syntax_tree/nodes/symbols/symbol_literal"
-require "masamune/abstract_syntax_tree/nodes/variables/block_var"
-require "masamune/abstract_syntax_tree/nodes/variables/var_field"
-require "masamune/abstract_syntax_tree/nodes/variables/var_ref"
-require "masamune/abstract_syntax_tree/nodes/assign"
-require "masamune/abstract_syntax_tree/nodes/call"
-require "masamune/abstract_syntax_tree/nodes/command"
-require "masamune/abstract_syntax_tree/nodes/def"
-require "masamune/abstract_syntax_tree/nodes/params"
-require "masamune/abstract_syntax_tree/nodes/program"
-require "masamune/abstract_syntax_tree/nodes/string_content"
-require "masamune/abstract_syntax_tree/nodes/symbol"
-require "masamune/abstract_syntax_tree/nodes/vcall"
 
 require "pp"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: masamune-ast
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Gabriel Zayas
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-04 00:00:00.000000000 Z
+date: 2023-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
 description: A layer of abstraction on top of Ripper for handling Abstract Syntax
   Trees in Ruby.
 email:
@@ -40,26 +54,14 @@ files:
 - Rakefile
 - lib/masamune.rb
 - lib/masamune/abstract_syntax_tree.rb
-- lib/masamune/abstract_syntax_tree/data_node.rb
-- lib/masamune/abstract_syntax_tree/node.rb
-- lib/masamune/abstract_syntax_tree/nodes/assign.rb
-- lib/masamune/abstract_syntax_tree/nodes/blocks/brace_block.rb
-- lib/masamune/abstract_syntax_tree/nodes/blocks/do_block.rb
-- lib/masamune/abstract_syntax_tree/nodes/call.rb
-- lib/masamune/abstract_syntax_tree/nodes/command.rb
-- lib/masamune/abstract_syntax_tree/nodes/def.rb
-- lib/masamune/abstract_syntax_tree/nodes/params.rb
-- lib/masamune/abstract_syntax_tree/nodes/program.rb
-- lib/masamune/abstract_syntax_tree/nodes/string_content.rb
-- lib/masamune/abstract_syntax_tree/nodes/support_nodes/block.rb
-- lib/masamune/abstract_syntax_tree/nodes/support_nodes/comment.rb
-- lib/masamune/abstract_syntax_tree/nodes/symbol.rb
-- lib/masamune/abstract_syntax_tree/nodes/symbols/dyna_symbol.rb
-- lib/masamune/abstract_syntax_tree/nodes/symbols/symbol_literal.rb
-- lib/masamune/abstract_syntax_tree/nodes/variables/block_var.rb
-- lib/masamune/abstract_syntax_tree/nodes/variables/var_field.rb
-- lib/masamune/abstract_syntax_tree/nodes/variables/var_ref.rb
-- lib/masamune/abstract_syntax_tree/nodes/vcall.rb
+- lib/masamune/abstract_syntax_tree/prism/node_extensions.rb
+- lib/masamune/abstract_syntax_tree/visitors/block_parameters_visitor.rb
+- lib/masamune/abstract_syntax_tree/visitors/method_calls_visitor.rb
+- lib/masamune/abstract_syntax_tree/visitors/method_definitions_visitor.rb
+- lib/masamune/abstract_syntax_tree/visitors/parameters_visitor.rb
+- lib/masamune/abstract_syntax_tree/visitors/strings_visitor.rb
+- lib/masamune/abstract_syntax_tree/visitors/symbols_visitor.rb
+- lib/masamune/abstract_syntax_tree/visitors/variables_visitor.rb
 - lib/masamune/lex_node.rb
 - lib/masamune/slasher.rb
 - lib/masamune/version.rb
@@ -71,7 +73,7 @@ metadata:
   homepage_uri: https://www.github.com/gazayas/masamune-ast
   source_code_uri: https://www.github.com/gazayas/masamune-ast
   changelog_uri: https://www.github.com/gazayas/masamune-ast
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -79,15 +81,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
-signing_key:
+rubygems_version: 3.5.0.dev
+signing_key: 
 specification_version: 4
 summary: Masamune
 test_files: []

data/lib/masamune/abstract_syntax_tree/data_node.rb

@@ -1,49 +0,0 @@
-# A data node represents an abstraction in the AST which has details about a specific type.
-# i.e. - [:@ident, "variable_name", [4, 7]]
-# These values are the `type`, `token`, and `position`, respectively.
-# It is simliar to what you see in `Ripper.lex(code)` and `Masamune::AbstractSyntaxTree's @lex_nodes`.
-
-# We break this down into a simpler structure, `line_data_and_token`,
-# which looks like this: {line_number: 4, index_on_line: 7, token: "ruby"}
-
-module Masamune
-  class AbstractSyntaxTree
-    class DataNode < Node
-      attr_reader :type, :token, :line_number, :index_on_line
-
-      def initialize(contents, ast_id, parent)
-        @type, @token, line_position = contents
-        @line_number, @index_on_line = line_position
-        @parent = parent
-        super(contents, ast_id)
-      end
-
-      # Results here represent the position and token of the
-      # data we're searching in the form of a Hash like the following:
-      # [
-      #   {line_number: 4, index_on_line: 7, token: "ruby"},
-      #   {line_number: 7, index_on_line: 7, token: "rails"}
-      # ]
-      # TODO: Worry about using a faster sorting algorithm later.
-      def self.order_results_by_position(results)
-        results.sort do |a, b|
-          by_line = a[:line_number] <=> b[:line_number]
-          # If we're on the same line, refer to the inner index for order.
-          by_line.zero? ? a[:index_on_line] <=> b[:index_on_line] : by_line
-        end
-      end
-
-      def line_data_and_token
-        {
-          line_number: @line_number,
-          index_on_line: @index_on_line,
-          token: @token
-        }
-      end
-
-      def position
-        [@line_number, @index_on_line]
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/node.rb

@@ -1,41 +0,0 @@
-# TODO: Add description
-
-module Masamune
-  class AbstractSyntaxTree
-    class Node
-      attr_reader :ast_id, :contents, :index_stack, :data_nodes
-
-      def initialize(contents, ast_id)
-        @ast_id = ast_id
-        @contents = contents
-        @data_nodes = extract_data_nodes
-      end
-
-      def ast
-        ObjectSpace._id2ref(@ast_id)
-      end
-
-      # TODO: Consider removing the :type and :typeless methods.
-
-      # Ripper's abstract syntax tree nodes are either typed or typeless.
-      # Types consist of values such as :def, :do_block, :var_ref, etc.
-      # Typed nodes house one of these types as its first element,
-      # whereas typeless nodes simply have arrays as top-level elements.
-      # Example of a typed node: [:@tstring_content, "ruby", [4, 7]]
-      def typed?
-        @contents.is_a?(Array) && @contents.first.is_a?(Symbol)
-      end
-
-      def typeless?
-        !typed?
-      end
-
-      # By default, we assume a node has no data nodes to extract.
-      # Because the structure for each node is different, we handle
-      # extraction separately for each node within its respective class.
-      def extract_data_nodes
-        # TODO: Might want to make this [] instead of nil.
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/assign.rb

@@ -1,11 +0,0 @@
-# TODO: Add description.
-
-module Masamune
-  class AbstractSyntaxTree
-    class Assign < Node
-      def initialize(contents, ast_id)
-        super
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/blocks/brace_block.rb

@@ -1,13 +0,0 @@
-# TODO: Add description.
-
-module Masamune
-  class AbstractSyntaxTree
-    class BraceBlock < Block
-      attr_accessor :ast_id
-
-      def initialize(contents, ast_id)
-        super
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/blocks/do_block.rb

@@ -1,13 +0,0 @@
-# TODO: Add description.
-
-module Masamune
-  class AbstractSyntaxTree
-    class DoBlock < Block
-      attr_accessor :ast_id
-
-      def initialize(contents, ast_id)
-        super
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/call.rb

@@ -1,17 +0,0 @@
-# TODO: Add description.
-
-module Masamune
-  class AbstractSyntaxTree
-    class Call < Node
-      def initialize(contents, ast_id)
-        super
-      end
-
-      def extract_data_nodes
-        [
-          DataNode.new(@contents.last, @ast_id, self)
-        ]
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/command.rb

@@ -1,64 +0,0 @@
-# Code example:
-# puts "hello"
-#
-# syntax_tree output:
-# SyntaxTree::Command[
-#   message: SyntaxTree::Ident[value: "puts"],
-#   arguments: SyntaxTree::Args[
-#     parts: [
-#       SyntaxTree::StringLiteral[
-#         parts: [SyntaxTree::TStringContent[value: "greetings"]]
-#       ]
-#     ]
-#   ]
-# ]
-
-# Code example:
-# namespace :project
-#   resources :pages
-# end
-#
-# syntax_tree output:
-# SyntaxTree::Command[
-#   message: SyntaxTree::Ident[value: "namespace"],
-#   arguments: SyntaxTree::Args[
-#     parts: [SyntaxTree::SymbolLiteral[value: SyntaxTree::Ident[value: "project"]]]
-#   ],
-#   block: SyntaxTree::BlockNode[
-#     bodystmt: SyntaxTree::BodyStmt[
-#       statements: SyntaxTree::Statements[
-#         body: [
-#           SyntaxTree::Command[
-#             message: SyntaxTree::Ident[value: "resources"],
-#             arguments: SyntaxTree::Args[
-#               parts: [
-#                 SyntaxTree::SymbolLiteral[
-#                   value: SyntaxTree::Ident[value: "pages"]
-#                 ]
-#               ]
-#             ]
-#           ]
-#         ]
-#       ]
-#     ]
-#   ]
-# ]
-
-
-# TODO: As you can see in the second example above, `command` can receive a
-# block, so we might want to have a way to access the block node in the future.
-module Masamune
-  class AbstractSyntaxTree
-    class Command < Node
-      def initialize(contents, ast_id)
-        super
-      end
-
-      def extract_data_nodes
-        [
-          DataNode.new(@contents[1], @ast_id, self)
-        ]
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/def.rb

@@ -1,17 +0,0 @@
-# TODO: Add description.
-
-module Masamune
-  class AbstractSyntaxTree
-    class Def < Node
-      def initialize(contents, ast_id)
-        super
-      end
-
-      def extract_data_nodes
-        [
-          DataNode.new(@contents[1], @ast_id, self)
-        ]
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/params.rb

@@ -1,23 +0,0 @@
-# TODO: Add description.
-
-module Masamune
-  class AbstractSyntaxTree
-    class Params < Node
-      def initialize(contents, ast_id)
-        super
-      end
-
-      def extract_data_nodes
-        # TODO: Sometimes the params node looks like this:
-        # [:params, nil, nil, nil, nil, nil, nil, nil]
-        # Add a description for this, and review this portion
-        # to ensure that it's being handled properly.
-        unless @contents[1].nil?
-          @contents[1].map do |content|
-            DataNode.new(content, @ast_id, self)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/program.rb

@@ -1,16 +0,0 @@
-# Program represents the top layer of the abstract syntax tree,
-# and the second element of the array houses the entire program.
-
-module Masamune
-  class AbstractSyntaxTree
-    class Program < Node
-      def initialize(contents, ast_id)
-        super
-      end
-
-      def extract_data_nodes
-        # No data nodes to extract.
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/string_content.rb

@@ -1,17 +0,0 @@
-# TODO: Add description.
-
-module Masamune
-  class AbstractSyntaxTree
-    class StringContent < Node
-      def initialize(contents, ast_id)
-        super
-      end
-
-      def extract_data_nodes
-        [
-          DataNode.new(@contents[1], @ast_id, self)
-        ]
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/support_nodes/block.rb

@@ -1,18 +0,0 @@
-# DoBlock and BraceBlock share some of
-# the same logic, so we share that here.
-
-module Masamune
-  class AbstractSyntaxTree
-    class Block < Node
-      def initialize(contents, ast_id)
-        super
-      end
-
-      def params
-        # This node should exist already, so we search for it in the ast object.
-        block_var = BlockVar.new(contents[1], ast_id)
-        ast.node_list.find {|node| node.contents == block_var.contents}
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/support_nodes/comment.rb

@@ -1,25 +0,0 @@
-# In the abstract syntax tree created by Ripper.sexp,
-# the type for comments is :void_stmt, and it doesn't have
-# a data node within it either. This means that the text
-# for the comment doesn't exist in the ast. It DOES exist
-# in LexNode though, so we grab from them there instead.
-
-module Masamune
-  class AbstractSyntaxTree
-    class Comment < Node
-      def initialize(contents, ast_id)
-        super
-
-        # Since this is techincally supposed to be a :void_stmt
-        # in this ast, we just leave this as nil.
-        @contents = nil
-      end
-
-      def extract_data_nodes
-        [
-          DataNode.new([contents.type, contents.token, contents.position], @ast_id, self)
-        ]
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/symbol.rb

@@ -1,17 +0,0 @@
-# TODO: Add description.
-
-module Masamune
-  class AbstractSyntaxTree
-    class Symbol < Node
-      def initialize(contents, ast_id)
-        super
-      end
-
-      def extract_data_nodes
-        [
-          DataNode.new(@contents[1], @ast_id, self)
-        ]
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/symbols/dyna_symbol.rb

@@ -1,20 +0,0 @@
-# TODO: Add description.
-
-module Masamune
-  class AbstractSyntaxTree
-    class DynaSymbol < Node
-      def initialize(contents, ast_id)
-        super
-      end
-
-      # Dyna Symbols are symbols created from strings, i.e. - :"project".
-      # Since they have :@tstring_content inside of them, the data node
-      # is technically for a String, so instead of duplicating it here,
-      # we just use a method specifically for getting the symbol.
-      # This should be the same as the :symbol_literal type.
-      def get_symbol_data
-        DataNode.new(@contents[1][1], @ast_id, self)
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/symbols/symbol_literal.rb

@@ -1,21 +0,0 @@
-# TODO: Add description.
-
-module Masamune
-  class AbstractSyntaxTree
-    class SymbolLiteral < Node
-      def initialize(contents, ast_id)
-        super
-      end
-
-      # Symbol Literals are a node type of :symbol_literal,
-      # but have a node type of :symbol nested within them.
-      # For the reason, the data node is technically for :symbol
-      # and not :symbol_literal, so instead of duplicating it here,
-      # we just use a method specifically for getting the symbol.
-      # This should be the same as the :dyna_symbol type.
-      def get_symbol_data
-        DataNode.new(@contents[1][1], @ast_id, self)
-      end
-    end
-  end
-end

data/lib/masamune/abstract_syntax_tree/nodes/variables/block_var.rb

@@ -1,22 +0,0 @@
-# TODO: Add description.
-
-module Masamune
-  class AbstractSyntaxTree
-    class BlockVar < Node
-      attr_accessor :ast_id
-
-      def initialize(contents, ast_id)
-        super
-      end
-
-      # :block_var has a lot of nil values within in.
-      # I'm not sure what this represents, but it would be
-      # nice to find out and document/implement it somewhere.
-      def extract_data_nodes
-        @contents[1][1].map do |content|
-          DataNode.new(content, @ast_id, self)
-        end
-      end
-    end
-  end
-end