Class: Synvert::Core::Rewriter
- Inherits:
-
Object
- Object
- Synvert::Core::Rewriter
- Defined in:
- lib/synvert/core/rewriter.rb
Overview
Rewriter is the top level namespace in a snippet.
One Rewriter checks if the depndency version matches, and it can contain one or many Instance, which define the behavior what files and what codes to detect and rewrite to what code.
Defined Under Namespace
Modules: Helper Classes: Action, AnyValue, AppendAction, Condition, DeleteAction, GemSpec, GotoScope, IfExistCondition, IfOnlyExistCondition, InsertAction, InsertAfterAction, Instance, PrependAction, QueryScope, RemoveAction, ReplaceAction, ReplaceErbStmtWithExprAction, ReplaceWithAction, RubyVersion, Scope, UnlessExistCondition, Warning, WithinScope, WrapAction
Instance Attribute Summary collapse
-
#affected_files ⇒ Set
readonly
Affected fileds.
-
#gem_spec ⇒ Object
readonly
Returns the value of attribute gem_spec.
-
#group ⇒ String
readonly
The group of rewriter.
-
#helper ⇒ Array
readonly
Helper methods.
-
#helpers ⇒ Object
readonly
Returns the value of attribute helpers.
-
#name ⇒ String
readonly
The unique name of rewriter.
-
#ruby_version ⇒ Rewriter::RubyVersion
readonly
The ruby version.
-
#sub_snippets ⇒ Array<Synvert::Core::Rewriter>
readonly
All rewriters this rewiter calls.
-
#warnings ⇒ Array<Synvert::Core::Rewriter::Warning>
readonly
Warning messages.
Class Method Summary collapse
-
.availables ⇒ Hash<String, Hash<String, Rewriter>>
Get all available rewriters.
-
.call(group, name, sandbox = false) ⇒ Synvert::Core::Rewriter
Get a registered rewriter by group and name, then process that rewriter.
-
.clear ⇒ Object
Clear all registered rewriters.
-
.execute { ... } ⇒ Object
Execute the temporary rewriter without group and name.
-
.fetch(group, name) ⇒ Synvert::Core::Rewriter
Fetch a rewriter by group and name.
-
.register(group, name, rewriter) ⇒ Object
Register a rewriter with its group and name.
Instance Method Summary collapse
-
#add_affected_file(file_path) ⇒ Object
Add an affected file.
-
#add_file(filename, content) ⇒ Object
Parses
add_file
dsl, it adds a new file. -
#add_snippet(group, name) ⇒ Object
Parse
add_snippet
dsl, it calls anther rewriter. -
#add_warning(warning) ⇒ Object
Add a warning.
-
#description(description = nil) ⇒ Object
Parse
description
dsl, it sets description of the rewrite. -
#helper_method(name) { ... } ⇒ Object
Parse
helper_method
dsl, it defines helper method for Instance. -
#if_gem(name, version) ⇒ Object
Parse
if_gem
dsl, it compares version of the specified gem. -
#if_ruby(version) ⇒ Object
Parse
if_ruby
dsl, it checks if ruby version is greater than or equal to the specified ruby version. -
#initialize(group, name) { ... } ⇒ Rewriter
constructor
Initialize a Rewriter.
-
#process ⇒ Object
Process the rewriter.
-
#process_with_sandbox ⇒ Object
Process rewriter with sandbox mode.
-
#redo_until_no_change ⇒ Object
Rerun the snippet until no change.
-
#remove_file(filename) ⇒ Object
Parses
remove_file
dsl, it removes a file. -
#todo(todo = nil) ⇒ String
Parse
todo
dsl, it sets todo of the rewriter. -
#within_files(file_patterns, &block) ⇒ Object
(also: #within_file)
Parse
within_files
dsl, it finds specified files.
Constructor Details
#initialize(group, name) { ... } ⇒ Rewriter
Initialize a Rewriter. When a rewriter is initialized, it is already registered.
141 142 143 144 145 146 147 148 149 150 151 |
# File 'lib/synvert/core/rewriter.rb', line 141 def initialize(group, name, &block) @group = group @name = name @block = block @helpers = [] @sub_snippets = [] @warnings = [] @affected_files = Set.new @redo_until_no_change = false self.class.register(@group, @name, self) end |
Instance Attribute Details
#affected_files ⇒ Set (readonly)
Returns affected fileds.
133 |
# File 'lib/synvert/core/rewriter.rb', line 133 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec |
#gem_spec ⇒ Object (readonly)
Returns the value of attribute gem_spec.
133 |
# File 'lib/synvert/core/rewriter.rb', line 133 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec |
#group ⇒ String (readonly)
Returns the group of rewriter.
133 134 135 |
# File 'lib/synvert/core/rewriter.rb', line 133 def group @group end |
#helper ⇒ Array (readonly)
Returns helper methods.
133 |
# File 'lib/synvert/core/rewriter.rb', line 133 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec |
#helpers ⇒ Object (readonly)
Returns the value of attribute helpers.
133 134 135 |
# File 'lib/synvert/core/rewriter.rb', line 133 def helpers @helpers end |
#name ⇒ String (readonly)
Returns the unique name of rewriter.
133 |
# File 'lib/synvert/core/rewriter.rb', line 133 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec |
#ruby_version ⇒ Rewriter::RubyVersion (readonly)
Returns the ruby version.
133 |
# File 'lib/synvert/core/rewriter.rb', line 133 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec |
#sub_snippets ⇒ Array<Synvert::Core::Rewriter> (readonly)
Returns all rewriters this rewiter calls.
133 |
# File 'lib/synvert/core/rewriter.rb', line 133 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec |
#warnings ⇒ Array<Synvert::Core::Rewriter::Warning> (readonly)
Returns warning messages.
133 |
# File 'lib/synvert/core/rewriter.rb', line 133 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec |
Class Method Details
.availables ⇒ Hash<String, Hash<String, Rewriter>>
Get all available rewriters
101 102 103 |
# File 'lib/synvert/core/rewriter.rb', line 101 def availables rewriters end |
.call(group, name, sandbox = false) ⇒ Synvert::Core::Rewriter
Get a registered rewriter by group and name, then process that rewriter.
88 89 90 91 92 93 94 95 96 |
# File 'lib/synvert/core/rewriter.rb', line 88 def call(group, name, sandbox = false) rewriter = fetch(group, name) if sandbox rewriter.process_with_sandbox else rewriter.process end rewriter end |
.clear ⇒ Object
Clear all registered rewriters.
106 107 108 |
# File 'lib/synvert/core/rewriter.rb', line 106 def clear rewriters.clear end |
.execute { ... } ⇒ Object
Execute the temporary rewriter without group and name.
48 49 50 51 52 |
# File 'lib/synvert/core/rewriter.rb', line 48 def execute(&block) rewriter = Rewriter.new('', '', &block) rewriter.process rewriter end |
.fetch(group, name) ⇒ Synvert::Core::Rewriter
Fetch a rewriter by group and name.
72 73 74 75 76 77 78 79 |
# File 'lib/synvert/core/rewriter.rb', line 72 def fetch(group, name) group = group.to_s name = name.to_s rewriter = rewriters.dig(group, name) raise RewriterNotFound, "Rewriter #{group} #{name} not found" unless rewriter rewriter end |
.register(group, name, rewriter) ⇒ Object
Register a rewriter with its group and name.
59 60 61 62 63 64 |
# File 'lib/synvert/core/rewriter.rb', line 59 def register(group, name, rewriter) group = group.to_s name = name.to_s rewriters[group] ||= {} rewriters[group][name] = rewriter end |
Instance Method Details
#add_affected_file(file_path) ⇒ Object
Add an affected file.
183 184 185 |
# File 'lib/synvert/core/rewriter.rb', line 183 def add_affected_file(file_path) @affected_files.add(file_path) end |
#add_file(filename, content) ⇒ Object
Parses add_file
dsl, it adds a new file.
260 261 262 263 264 265 266 267 268 269 270 271 |
# File 'lib/synvert/core/rewriter.rb', line 260 def add_file(filename, content) return if @sandbox filepath = File.join(Configuration.path, filename) if File.exist?(filepath) puts "File #{filepath} already exists." return end FileUtils.mkdir_p File.dirname(filepath) File.write(filepath, content) end |
#add_snippet(group, name) ⇒ Object
Parse add_snippet
dsl, it calls anther rewriter.
305 306 307 |
# File 'lib/synvert/core/rewriter.rb', line 305 def add_snippet(group, name) @sub_snippets << self.class.call(group.to_s, name.to_s, @sandbox) end |
#add_warning(warning) ⇒ Object
Add a warning.
176 177 178 |
# File 'lib/synvert/core/rewriter.rb', line 176 def add_warning(warning) @warnings << warning end |
#description(description = nil) ⇒ Object
Parse description
dsl, it sets description of the rewrite. Or get description.
199 200 201 202 203 204 205 |
# File 'lib/synvert/core/rewriter.rb', line 199 def description(description = nil) if description @description = description else @description end end |
#helper_method(name) { ... } ⇒ Object
Parse helper_method
dsl, it defines helper method for Instance.
322 323 324 |
# File 'lib/synvert/core/rewriter.rb', line 322 def helper_method(name, &block) @helpers << { name: name, block: block } end |
#if_gem(name, version) ⇒ Object
Parse if_gem
dsl, it compares version of the specified gem.
224 225 226 |
# File 'lib/synvert/core/rewriter.rb', line 224 def if_gem(name, version) @gem_spec = Rewriter::GemSpec.new(name, version) end |
#if_ruby(version) ⇒ Object
Parse if_ruby
dsl, it checks if ruby version is greater than or equal to the specified ruby version.
213 214 215 |
# File 'lib/synvert/core/rewriter.rb', line 213 def if_ruby(version) @ruby_version = Rewriter::RubyVersion.new(version) end |
#process ⇒ Object
Process the rewriter. It will call the block.
155 156 157 158 159 160 |
# File 'lib/synvert/core/rewriter.rb', line 155 def process @affected_files = Set.new instance_eval(&@block) process if !@affected_files.empty? && @redo_until_no_change # redo end |
#process_with_sandbox ⇒ Object
Process rewriter with sandbox mode. It will call the block but doesn’t change any file.
164 165 166 167 168 169 170 171 |
# File 'lib/synvert/core/rewriter.rb', line 164 def process_with_sandbox @sandbox = true begin process ensure @sandbox = false end end |
#redo_until_no_change ⇒ Object
Rerun the snippet until no change.
353 354 355 |
# File 'lib/synvert/core/rewriter.rb', line 353 def redo_until_no_change @redo_until_no_change = true end |
#remove_file(filename) ⇒ Object
Parses remove_file
dsl, it removes a file.
279 280 281 282 283 284 |
# File 'lib/synvert/core/rewriter.rb', line 279 def remove_file(filename) return if @sandbox file_path = File.join(Configuration.path, filename) File.delete(file_path) if File.exist?(file_path) end |
#todo(todo = nil) ⇒ String
Parse todo
dsl, it sets todo of the rewriter. Or get todo.
340 341 342 343 344 345 346 |
# File 'lib/synvert/core/rewriter.rb', line 340 def todo(todo = nil) if todo @todo = todo else @todo end end |
#within_files(file_patterns, &block) ⇒ Object Also known as: within_file
Parse within_files
dsl, it finds specified files. It creates a Instance to rewrite code.
237 238 239 240 241 242 243 244 |
# File 'lib/synvert/core/rewriter.rb', line 237 def within_files(file_patterns, &block) return if @sandbox return if @ruby_version && !@ruby_version.match? return if @gem_spec && !@gem_spec.match? Rewriter::Instance.new(self, Array(file_patterns), &block).process end |