masamune-ast 1.1.0 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ee5dca320a96035fcea4f73effbc3fceff2ee531808bf94d99aa21086186ce5
-  data.tar.gz: 3f170766c1e97a15e9c550e61fc5f2048b28b48a5f12e2b4841a31b0dad6ebbb
+  metadata.gz: 0cafe74abe55158e29178163ef544558f8e8d042d8adae0668a8625e1883c843
+  data.tar.gz: f0068f9e6783403ba0d17f65902c0ecfded0806424383c8d325168ce0b4c7a58
 SHA512:
-  metadata.gz: 7650eff09ecb23034c236363ee70a971f003736a967f8efd5ae8f36e68d598f73a4239a38d839f478b4aa6b36662d7114834dedf501acfed6bd2adcb6494890e
-  data.tar.gz: fbd0fc4a505b03dc38304abdfadd9cb31fccf5f746bbb325056c63e9a790d7814bd7292d40c95da7441731cf3ab0613f2e9879c4c27f07f61445370a499665a2
+  metadata.gz: b6647c5ea9745d2e1f842a0d0eea3de05e795c7afa9a3241cf9d6a87dd802c4c62e7c9fdb266afcbc8e54ffe51af25d9bacc32830d4f28009f9c34b2a4f733a8
+  data.tar.gz: d7781f44d57a0bca23d7a61eaed10cdb687431a66540433ac0e01f43c6a625cd05aea2cd06168b1ea980d2fffaa827634ba3633ca8a94950df2110a60d4f9f5c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    masamune-ast (1.1.0)
+    masamune-ast (1.1.2)
       activesupport
 
 GEM

data/README.md

@@ -13,8 +13,38 @@ Or add the following to your Gemfile and run `bundle install`
 gem "masamune-ast"
 ```
 
+Then require the gem in a file like this:
+```ruby
+require "masamune"
+```
+
 ## Usage
 
+Isolate and replace variables, methods, or strings in your Ruby source code according to the specific tokens allotted when the code is intially parsed:
+```ruby
+code = <<~CODE
+  10.times do |n|
+    puts n
+  end
+
+  def n
+    "n"
+  end
+CODE
+
+msmn = Masamune::AbstractSyntaxTree.new(code)
+msmn.replace(type: :variables, old_token: "n", new_token: "foo")
+
+# This will produce the following code in string form.
+10.times do |foo|
+  puts foo
+end
+
+def n
+  "n"
+end
+```
+
 Pinpoint variables and methods in your source code even when other tokens have the same or similar spelling:
 ```ruby
 code = <<CODE

data/lib/masamune/abstract_syntax_tree/block_var.rb

@@ -14,7 +14,7 @@ module Masamune
       # nice to find out and implement it document/implement it somewhere.
       def extract_data_nodes
         @contents[1][1].map do |content|
-          Masamune::AbstractSyntaxTree::DataNode.new(content, @ast_id)
+          DataNode.new(content, @ast_id)
         end
       end
     end

data/lib/masamune/abstract_syntax_tree/brace_block.rb

@@ -11,7 +11,7 @@ module Masamune
 
       def params
         # This node should exist already, so we search for it in the ast object.
-        block_var = Masamune::AbstractSyntaxTree::BlockVar.new(contents[1], ast_id)
+        block_var = BlockVar.new(contents[1], ast_id)
         ast.node_list.find {|node| node.contents == block_var.contents}
       end
     end

data/lib/masamune/abstract_syntax_tree/call.rb

@@ -9,7 +9,7 @@ module Masamune
 
       def extract_data_nodes
         [
-          Masamune::AbstractSyntaxTree::DataNode.new(@contents.last, @ast_id)
+          DataNode.new(@contents.last, @ast_id)
         ]
       end
     end

data/lib/masamune/abstract_syntax_tree/def.rb

@@ -9,7 +9,7 @@ module Masamune
 
       def extract_data_nodes
         [
-          Masamune::AbstractSyntaxTree::DataNode.new(@contents[1], @ast_id)
+          DataNode.new(@contents[1], @ast_id)
         ]
       end
     end

data/lib/masamune/abstract_syntax_tree/do_block.rb

@@ -11,7 +11,7 @@ module Masamune
 
       def params
         # This node should exist already, so we search for it in the ast object.
-        block_var = Masamune::AbstractSyntaxTree::BlockVar.new(contents[1], ast_id)
+        block_var = BlockVar.new(contents[1], ast_id)
         ast.node_list.find {|node| node.contents == block_var.contents}
       end
     end

data/lib/masamune/abstract_syntax_tree/params.rb

@@ -14,7 +14,7 @@ module Masamune
         # to ensure that it's being handled properly.
         unless @contents[1].nil?
           @contents[1].map do |content|
-            Masamune::AbstractSyntaxTree::DataNode.new(content, @ast_id)
+            DataNode.new(content, @ast_id)
           end
         end
       end

data/lib/masamune/abstract_syntax_tree/string_content.rb

@@ -9,7 +9,7 @@ module Masamune
 
       def extract_data_nodes
         [
-          Masamune::AbstractSyntaxTree::DataNode.new(@contents[1], @ast_id)
+          DataNode.new(@contents[1], @ast_id)
         ]
       end
     end

data/lib/masamune/abstract_syntax_tree/var_field.rb

@@ -9,7 +9,7 @@ module Masamune
 
       def extract_data_nodes
         [
-          Masamune::AbstractSyntaxTree::DataNode.new(@contents[1], @ast_id)
+          DataNode.new(@contents[1], @ast_id)
         ]
       end
     end

data/lib/masamune/abstract_syntax_tree/var_ref.rb

@@ -11,7 +11,7 @@ module Masamune
 
       def extract_data_nodes
         [
-          Masamune::AbstractSyntaxTree::DataNode.new(@contents[1], @ast_id)
+          DataNode.new(@contents[1], @ast_id)
         ]
       end
     end

data/lib/masamune/abstract_syntax_tree/vcall.rb

@@ -9,7 +9,7 @@ module Masamune
 
       def extract_data_nodes
         [
-          Masamune::AbstractSyntaxTree::DataNode.new(@contents[1], @ast_id)
+          DataNode.new(@contents[1], @ast_id)
         ]
       end
     end

data/lib/masamune/abstract_syntax_tree.rb

@@ -1,13 +1,14 @@
 module Masamune
   class AbstractSyntaxTree
-    attr_reader :tree
+    attr_reader :code, :tree
     attr_accessor :node_list, :data_node_list, :lex_nodes
 
     def initialize(code)
+      @code = code
       @tree = Ripper.sexp(code)
       raw_lex_nodes = Ripper.lex(code)
       @lex_nodes = raw_lex_nodes.map do |lex_node|
-        Masamune::LexNode.new(raw_lex_nodes.index(lex_node), lex_node, self.__id__)
+        LexNode.new(raw_lex_nodes.index(lex_node), lex_node, self.__id__)
       end
 
       @node_list = []
@@ -21,7 +22,7 @@ module Masamune
         msmn_node = klass.new(tree_node, self.__id__)
       else
         # Create a general node if the node is a single value.
-        msmn_node = Masamune::AbstractSyntaxTree::Node.new(tree_node, self.__id__)
+        msmn_node = Node.new(tree_node, self.__id__)
       end
 
       # Register nodes and any data nodes housed within it.
@@ -69,6 +70,14 @@ module Masamune
     def brace_block_params
     end
 
+    # @tree only shows comments as a type of `:void_stmt` and
+    # doesn't have a data node, so we get comments from @lex_nodes.
+    def comments(content: nil)
+      comments = @lex_nodes.select {|node| node.type == :comment}
+      comments.select {|comment| comment.token == content} if content
+      comments.map {|comment| {position: comment.position, token: comment.token}}
+    end
+
     def all_methods
       method_definitions + method_calls
     end
@@ -83,37 +92,48 @@ module Masamune
       # Ensure the classes are in an array
       token_classes = [token_classes].flatten
 
-      var_nodes = []
+      nodes = []
       token_classes.each do |klass|
-        var_nodes << @node_list.select {|node| node.class == klass}
+        nodes << @node_list.select {|node| node.class == klass}
       end
 
       # Searching for multiple classes will yield multi-dimensional arrays,
       # so we ensure everything is flattened out before moving forward.
-      var_nodes.flatten!
+      nodes.flatten!
 
       if token
-        var_nodes = var_nodes.select {|node| node.data_nodes.first.token == token}.flatten
+        # TODO: This most likely shouldn't be `node.data_nodes.first`.
+        # There are probably more data_nodes we need to check depending on the node class.
+        nodes = nodes.select {|node| node.data_nodes.first.token == token}.flatten
       end
 
       final_result = []
-      var_nodes.each do |node|
-        node.data_nodes.each {|dn| final_result << dn.position_and_token}
+      nodes.each do |node|
+        node.data_nodes.each {|dn| final_result << dn.position_and_token} if node.data_nodes
       end
 
-      Masamune::AbstractSyntaxTree::DataNode.order_results_by_position(final_result)
+      DataNode.order_results_by_position(final_result)
+    end
+
+    def replace(type:, old_token:, new_token:)
+      Slasher.replace(
+        type: type,
+        old_token: old_token,
+        new_token: new_token,
+        code: @code,
+        ast: self
+      )
     end
 
     private
 
     def get_node_class(type)
       begin
-        class_name = "Masamune::AbstractSyntaxTree::#{type.to_s.camelize}"
-        klass = class_name.constantize
+        "Masamune::AbstractSyntaxTree::#{type.to_s.camelize}".constantize
       rescue NameError
         # For all other nodes that we haven't covered yet, we just make a general class.
         # We can worry about adding the classes for other nodes as we go.
-        msmn_node = Masamune::AbstractSyntaxTree::Node
+        Node
       end
     end
   end

data/lib/masamune/slasher.rb

@@ -0,0 +1,32 @@
+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.
+      position_and_token_ary = if type.is_a?(Symbol) && ast.respond_to?(type)
+        ast.send(type)
+      elsif type.is_a?(Array)
+        type.map {|klass| ast.find_nodes(klass)}.flatten
+      end
+
+      tokens_to_replace = position_and_token_ary.select do |pos_and_tok|
+        pos_and_tok[:token] == old_token
+      end
+
+      # Build from lex nodes
+      result = ast.lex_nodes.map do |lex_node|
+        match_found = false
+        tokens_to_replace.each do |position_and_token|
+          if position_and_token[:position] == lex_node.position
+            match_found = true
+            break
+          end
+        end
+
+        match_found ? new_token : lex_node.token
+      end
+
+      result.join
+    end
+  end
+end

data/lib/masamune/version.rb

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

data/lib/masamune.rb

@@ -4,6 +4,7 @@ require_relative "masamune/version"
 require "ripper"
 require "active_support/core_ext/string/inflections"
 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"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: masamune-ast
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.2
 platform: ruby
 authors:
 - Gabriel Zayas
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-02 00:00:00.000000000 Z
+date: 2023-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -55,7 +55,7 @@ files:
 - lib/masamune/abstract_syntax_tree/var_ref.rb
 - lib/masamune/abstract_syntax_tree/vcall.rb
 - lib/masamune/lex_node.rb
-- lib/masamune/slicer.rb
+- lib/masamune/slasher.rb
 - lib/masamune/version.rb
 - sig/masamune.rbs
 homepage: https://www.github.com/gazayas/masamune-ast

data/lib/masamune/slicer.rb

@@ -1,19 +0,0 @@
-module Masamune
-  module Slicer
-    def initialize(ast)
-      @ast = ast
-    end
-
-    # TODO
-
-    # def replace(type, token)
-    #   @ast.search(type, token)
-    # end
-
-    # def insert_inside_block
-    # end
-
-    # def append_to_block
-    # end
-  end
-end