Class: Synvert::Core::Rewriter::Instance
- Inherits:
-
Object
- Object
- Synvert::Core::Rewriter::Instance
- Includes:
- Helper
- Defined in:
- lib/synvert/core/rewriter/instance.rb
Overview
Instance Attribute Summary collapse
-
#current_node ⇒ Object
Current ast node.
-
#current_parser ⇒ Object
readonly
Returns the value of attribute current_parser.
-
#file_path ⇒ Object
readonly
File path.
Instance Method Summary collapse
-
#add_action(action) ⇒ Object
Add a custom action.
-
#add_callback(node_type, at: 'start') { ... } ⇒ Object
It adds a callback when visiting an ast node.
-
#add_leading_spaces(str, tab_size: 1) ⇒ String
Add leading spaces before the str according to Configuration.tab_width.
-
#append(code) ⇒ Object
It appends the code to the bottom of current node body.
-
#delete(*selectors, and_comma: false) ⇒ Object
It deletes child nodes.
-
#goto_node(child_node_name, &block) ⇒ Object
It creates a GotoScope to go to a child node, then continue operating on the child node.
-
#group(&block) ⇒ Object
Group actions.
-
#if_exist_node(nql_or_rules, &block) ⇒ Object
It creates a IfExistCondition to check if matching nodes exist in the child nodes, if so, then continue operating on each matching ast node.
-
#indent(tab_size: 1) ⇒ Object
It indent the code of current node.
-
#initialize(rewriter, file_path) { ... } ⇒ Instance
constructor
Initialize an Instance.
-
#insert(code, at: 'end', to: nil, and_comma: false) ⇒ Object
It inserts code.
-
#insert_after(code, to: nil, and_comma: false) ⇒ Object
It inserts the code next to the current node.
-
#insert_before(code, to: nil, and_comma: false) ⇒ Object
It inserts the code previous to the current node.
-
#mutation_adapter ⇒ NodeMutation::Adapter
Get current_mutation's adapter.
-
#node ⇒ Node
Gets current node, it allows to get current node in block code.
-
#noop ⇒ Object
No operation.
-
#prepend(code) ⇒ Object
It prepends the code to the top of current node body.
-
#process ⇒ Object
Process the instance.
-
#process_with_node(node) { ... } ⇒ Object
Set current_node to node and process.
-
#process_with_other_node(node) { ... } ⇒ Object
Set current_node properly, process and set current_node back to original current_node.
-
#remove(and_comma: false) ⇒ Object
It removes current node.
-
#replace(*selectors, with:) ⇒ Object
It replaces the code of specified child nodes.
-
#replace_erb_stmt_with_expr ⇒ Object
It replaces erb stmt code to expr code.
-
#replace_with(code) ⇒ Object
It replaces the whole code of current node.
-
#test ⇒ Object
Test the instance.
-
#unless_exist_node(nql_or_rules, &block) ⇒ Object
It creates a UnlessExistCondition to check if matching nodes doesn't exist in the child nodes, if so, then continue operating on each matching ast node.
-
#warn(message) ⇒ Object
It creates a Warning to save warning message.
-
#within_node(nql_or_rules, options = {}) { ... } ⇒ Object
(also: #with_node, #find_node)
It creates a WithinScope to recursively find matching ast nodes, then continue operating on each matching ast node.
-
#wrap(prefix:, suffix:, newline: false) ⇒ Object
It wraps current node with prefix and suffix code.
-
#wrap_with_quotes(str) ⇒ String
Wrap str string with single or doulbe quotes based on Configuration.single_quote.
Methods included from Helper
#add_arguments_with_parenthesis_if_necessary, #add_curly_brackets_if_necessary, #add_receiver_if_necessary, #strip_brackets
Constructor Details
#initialize(rewriter, file_path) { ... } ⇒ Instance
Initialize an Instance.
23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
# File 'lib/synvert/core/rewriter/instance.rb', line 23 def initialize(rewriter, file_path, &block) @rewriter = rewriter @current_parser = @rewriter.parser @current_visitor = NodeVisitor.new(adapter: @current_parser) @actions = [] @file_path = file_path @block = block strategy = NodeMutation::Strategy::KEEP_RUNNING if rewriter.[:strategy] == Strategy::ALLOW_INSERT_AT_SAME_POSITION strategy |= NodeMutation::Strategy::ALLOW_INSERT_AT_SAME_POSITION end NodeMutation.configure({ strategy: strategy, tab_width: Configuration.tab_width }) rewriter.helpers.each { |helper| singleton_class.send(:define_method, helper[:name], &helper[:block]) } end |
Instance Attribute Details
#current_node ⇒ Object
Returns current ast node.
44 |
# File 'lib/synvert/core/rewriter/instance.rb', line 44 attr_reader :file_path, :current_parser |
#current_parser ⇒ Object (readonly)
Returns the value of attribute current_parser.
44 |
# File 'lib/synvert/core/rewriter/instance.rb', line 44 attr_reader :file_path, :current_parser |
#file_path ⇒ Object (readonly)
Returns file path.
44 45 46 |
# File 'lib/synvert/core/rewriter/instance.rb', line 44 def file_path @file_path end |
Instance Method Details
#add_action(action) ⇒ Object
Add a custom action.
428 429 430 |
# File 'lib/synvert/core/rewriter/instance.rb', line 428 def add_action(action) @current_mutation.actions << action.process end |
#add_callback(node_type, at: 'start') { ... } ⇒ Object
It adds a callback when visiting an ast node.
450 451 452 |
# File 'lib/synvert/core/rewriter/instance.rb', line 450 def add_callback(node_type, at: 'start', &block) @current_visitor.add_callback(node_type, at: at, &block) end |
#add_leading_spaces(str, tab_size: 1) ⇒ String
Add leading spaces before the str according to Configuration.tab_width.
472 473 474 |
# File 'lib/synvert/core/rewriter/instance.rb', line 472 def add_leading_spaces(str, tab_size: 1) (" " * Configuration.tab_width * tab_size) + str; end |
#append(code) ⇒ Object
It appends the code to the bottom of current node body.
234 235 236 |
# File 'lib/synvert/core/rewriter/instance.rb', line 234 def append(code) @current_mutation.append(@current_node, code) end |
#delete(*selectors, and_comma: false) ⇒ Object
It deletes child nodes.
371 372 373 |
# File 'lib/synvert/core/rewriter/instance.rb', line 371 def delete(*selectors, and_comma: false) @current_mutation.delete(@current_node, *selectors, and_comma: and_comma) end |
#goto_node(child_node_name, &block) ⇒ Object
It creates a GotoScope to go to a child node, then continue operating on the child node.
188 189 190 |
# File 'lib/synvert/core/rewriter/instance.rb', line 188 def goto_node(child_node_name, &block) Rewriter::GotoScope.new(self, child_node_name, &block).process end |
#group(&block) ⇒ Object
Group actions.
419 420 421 |
# File 'lib/synvert/core/rewriter/instance.rb', line 419 def group(&block) @current_mutation.group(&block) end |
#if_exist_node(nql_or_rules, &block) ⇒ Object
It creates a Synvert::Core::Rewriter::IfExistCondition to check if matching nodes exist in the child nodes, if so, then continue operating on each matching ast node.
202 203 204 |
# File 'lib/synvert/core/rewriter/instance.rb', line 202 def if_exist_node(nql_or_rules, &block) Rewriter::IfExistCondition.new(self, nql_or_rules, &block).process end |
#indent(tab_size: 1) ⇒ Object
It indent the code of current node.
404 405 406 |
# File 'lib/synvert/core/rewriter/instance.rb', line 404 def indent(tab_size: 1) @current_mutation.indent(@current_node, tab_size: tab_size) end |
#insert(code, at: 'end', to: nil, and_comma: false) ⇒ Object
It inserts code.
268 269 270 |
# File 'lib/synvert/core/rewriter/instance.rb', line 268 def insert(code, at: 'end', to: nil, and_comma: false) @current_mutation.insert(@current_node, code, at: at, to: to, and_comma: and_comma) end |
#insert_after(code, to: nil, and_comma: false) ⇒ Object
It inserts the code next to the current node.
284 285 286 287 |
# File 'lib/synvert/core/rewriter/instance.rb', line 284 def insert_after(code, to: nil, and_comma: false) column = ' ' * @current_mutation.adapter.get_start_loc(@current_node, to).column @current_mutation.insert(@current_node, "\n#{column}#{code}", at: 'end', to: to, and_comma: and_comma) end |
#insert_before(code, to: nil, and_comma: false) ⇒ Object
It inserts the code previous to the current node.
301 302 303 304 |
# File 'lib/synvert/core/rewriter/instance.rb', line 301 def insert_before(code, to: nil, and_comma: false) column = ' ' * @current_mutation.adapter.get_start_loc(@current_node, to).column @current_mutation.insert(@current_node, "#{code}\n#{column}", at: 'beginning', to: to, and_comma: and_comma) end |
#mutation_adapter ⇒ NodeMutation::Adapter
Get current_mutation's adapter.
125 126 127 |
# File 'lib/synvert/core/rewriter/instance.rb', line 125 def mutation_adapter @current_mutation.adapter end |
#node ⇒ Node
Gets current node, it allows to get current node in block code.
118 119 120 |
# File 'lib/synvert/core/rewriter/instance.rb', line 118 def node @current_node end |
#noop ⇒ Object
No operation.
409 410 411 |
# File 'lib/synvert/core/rewriter/instance.rb', line 409 def noop @current_mutation.noop(@current_node) end |
#prepend(code) ⇒ Object
It prepends the code to the top of current node body.
252 253 254 |
# File 'lib/synvert/core/rewriter/instance.rb', line 252 def prepend(code) @current_mutation.prepend(@current_node, code) end |
#process ⇒ Object
Process the instance. It executes the block code, rewrites the original code, then writes the code back to the original file.
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 |
# File 'lib/synvert/core/rewriter/instance.rb', line 50 def process puts @file_path if Configuration.show_run_process absolute_file_path = File.join(Configuration.root_path, @file_path) # It keeps running until no conflict, # it will try 5 times at maximum. 5.times do source = read_source(absolute_file_path) encoded_source = Engine.encode(File.extname(file_path), source) @current_mutation = NodeMutation.new(source, adapter: @current_parser) @current_mutation.transform_proc = Engine.generate_transform_proc(File.extname(file_path), encoded_source) begin node = parse_code(@file_path, encoded_source) process_with_node(node) do instance_eval(&@block) end @current_visitor.visit(node, self) result = @current_mutation.process if result.affected? @rewriter.add_affected_file(file_path) write_source(absolute_file_path, result.new_source) end break unless result.conflicted? rescue Parser::SyntaxError, Prism::ParseError, SyntaxTree::Parser::ParseError => e if ENV['DEBUG'] == 'true' puts "[Warn] file #{file_path} was not parsed correctly." puts e. end break end end end |
#process_with_node(node) { ... } ⇒ Object
Set current_node to node and process.
133 134 135 136 137 |
# File 'lib/synvert/core/rewriter/instance.rb', line 133 def process_with_node(node) self.current_node = node yield self.current_node = node end |
#process_with_other_node(node) { ... } ⇒ Object
Set current_node properly, process and set current_node back to original current_node.
143 144 145 146 147 148 |
# File 'lib/synvert/core/rewriter/instance.rb', line 143 def process_with_other_node(node) original_node = current_node self.current_node = node yield self.current_node = original_node end |
#remove(and_comma: false) ⇒ Object
It removes current node.
357 358 359 |
# File 'lib/synvert/core/rewriter/instance.rb', line 357 def remove(and_comma: false) @current_mutation.remove(@current_node, and_comma: and_comma) end |
#replace(*selectors, with:) ⇒ Object
It replaces the code of specified child nodes.
347 348 349 |
# File 'lib/synvert/core/rewriter/instance.rb', line 347 def replace(*selectors, with:) @current_mutation.replace(@current_node, *selectors, with: with) end |
#replace_erb_stmt_with_expr ⇒ Object
It replaces erb stmt code to expr code.
316 317 318 319 320 321 |
# File 'lib/synvert/core/rewriter/instance.rb', line 316 def replace_erb_stmt_with_expr absolute_file_path = File.join(Configuration.root_path, @file_path) erb_source = read_source(absolute_file_path) action = Rewriter::ReplaceErbStmtWithExprAction.new(@current_node, erb_source, adapter: @current_mutation.adapter) add_action(action) end |
#replace_with(code) ⇒ Object
It replaces the whole code of current node.
332 333 334 |
# File 'lib/synvert/core/rewriter/instance.rb', line 332 def replace_with(code) @current_mutation.replace_with(@current_node, code) end |
#test ⇒ Object
Test the instance. It executes the block code, tests the original code, then returns the actions.
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 |
# File 'lib/synvert/core/rewriter/instance.rb', line 89 def test absolute_file_path = File.join(Configuration.root_path, file_path) source = read_source(absolute_file_path) @current_mutation = NodeMutation.new(source, adapter: @current_parser) encoded_source = Engine.encode(File.extname(file_path), source) @current_mutation.transform_proc = Engine.generate_transform_proc(File.extname(file_path), encoded_source) begin node = parse_code(file_path, encoded_source) process_with_node(node) do instance_eval(&@block) end @current_visitor.visit(node, self) result = Configuration.test_result == 'new_source' ? @current_mutation.process : @current_mutation.test result.file_path = file_path result rescue Parser::SyntaxError, Prism::ParseError, SyntaxTree::Parser::ParseError => e if ENV['DEBUG'] == 'true' puts "[Warn] file #{file_path} was not parsed correctly." puts e. end end end |
#unless_exist_node(nql_or_rules, &block) ⇒ Object
It creates a UnlessExistCondition to check if matching nodes doesn't exist in the child nodes, if so, then continue operating on each matching ast node.
216 217 218 |
# File 'lib/synvert/core/rewriter/instance.rb', line 216 def unless_exist_node(nql_or_rules, &block) Rewriter::UnlessExistCondition.new(self, nql_or_rules, &block).process end |
#warn(message) ⇒ Object
It creates a Warning to save warning message.
438 439 440 |
# File 'lib/synvert/core/rewriter/instance.rb', line 438 def warn() @rewriter.add_warning Rewriter::Warning.new(self, ) end |
#within_node(nql_or_rules, options = {}) { ... } ⇒ Object Also known as: with_node, find_node
It creates a WithinScope to recursively find matching ast nodes, then continue operating on each matching ast node.
169 170 171 172 173 |
# File 'lib/synvert/core/rewriter/instance.rb', line 169 def within_node(nql_or_rules, = {}, &block) Rewriter::WithinScope.new(self, nql_or_rules, , &block).process rescue NodeQueryLexer::ScanError, Racc::ParseError raise NodeQuery::Compiler::ParseError, "Invalid query string: #{nql_or_rules}" end |
#wrap(prefix:, suffix:, newline: false) ⇒ Object
It wraps current node with prefix and suffix code.
390 391 392 |
# File 'lib/synvert/core/rewriter/instance.rb', line 390 def wrap(prefix:, suffix:, newline: false) @current_mutation.wrap(@current_node, prefix: prefix, suffix: suffix, newline: newline) end |
#wrap_with_quotes(str) ⇒ String
Wrap str string with single or doulbe quotes based on Configuration.single_quote.
457 458 459 460 461 462 463 464 465 466 |
# File 'lib/synvert/core/rewriter/instance.rb', line 457 def wrap_with_quotes(str) quote = Configuration.single_quote ? "'" : '"'; another_quote = Configuration.single_quote ? '"' : "'"; if str.include?(quote) && !str.include?(another_quote) return "#{another_quote}#{str}#{another_quote}" end escaped_str = str.gsub(quote) { |_char| '\\' + quote } quote + escaped_str + quote end |