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: Condition, GemSpec, GotoScope, IfExistCondition, IfOnlyExistCondition, Instance, ReplaceErbStmtWithExprAction, RubyVersion, Scope, UnlessExistCondition, Warning, WithinScope
Constant Summary collapse
- DEFAULT_OPTIONS =
{ run_instance: true, write_to_file: true }.freeze
Instance Attribute Summary collapse
-
#affected_files ⇒ Set
readonly
Affected fileds.
-
#gem_spec ⇒ Rewriter::GemSpec
readonly
The 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.
-
#options ⇒ Hash
The rewriter options.
-
#ruby_version ⇒ Rewriter::RubyVersion
readonly
The ruby version.
-
#sub_snippets ⇒ Array<Synvert::Core::Rewriter>
readonly
All rewriters this rewiter calls.
-
#test_results ⇒ Object
readonly
Returns the value of attribute test_results.
-
#warnings ⇒ Array<Synvert::Core::Rewriter::Warning>
readonly
Warning messages.
Class Method Summary collapse
-
.availables ⇒ Hash<String, Hash<String, Rewriter>>
Get all available rewriters.
-
.clear ⇒ Object
Clear all registered rewriters.
-
.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
It adds a new file.
-
#add_snippet(group, name = nil) ⇒ Object
It calls anther rewriter.
-
#add_warning(warning) ⇒ Object
Add a warning.
-
#configure(options) ⇒ Object
Configure the rewriter.
-
#description(description = nil) ⇒ Object
It sets description of the rewrite or get description.
-
#helper_method(name) { ... } ⇒ Object
It defines helper method for Instance.
-
#if_gem(name, version) ⇒ Object
It compares version of the specified gem.
-
#if_ruby(version) ⇒ Object
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
It removes a file.
- #test ⇒ Object
-
#within_files(file_patterns, &block) ⇒ Object
(also: #within_file)
It finds specified files.
Constructor Details
#initialize(group, name) { ... } ⇒ Rewriter
Initialize a Rewriter. When a rewriter is initialized, it is already registered.
114 115 116 117 118 119 120 121 122 123 124 125 126 |
# File 'lib/synvert/core/rewriter.rb', line 114 def initialize(group, name, &block) @group = group @name = name @block = block @helpers = [] @sub_snippets = [] @warnings = [] @affected_files = Set.new @redo_until_no_change = false @options = DEFAULT_OPTIONS.dup @test_results = [] self.class.register(@group, @name, self) end |
Instance Attribute Details
#affected_files ⇒ Set (readonly)
Returns affected fileds.
97 98 99 100 101 102 103 104 105 |
# File 'lib/synvert/core/rewriter.rb', line 97 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec, :test_results |
#gem_spec ⇒ Rewriter::GemSpec (readonly)
Returns the gem spec.
97 98 99 100 101 102 103 104 105 |
# File 'lib/synvert/core/rewriter.rb', line 97 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec, :test_results |
#group ⇒ String (readonly)
Returns the group of rewriter.
97 98 99 |
# File 'lib/synvert/core/rewriter.rb', line 97 def group @group end |
#helper ⇒ Array (readonly)
Returns helper methods.
97 98 99 100 101 102 103 104 105 |
# File 'lib/synvert/core/rewriter.rb', line 97 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec, :test_results |
#helpers ⇒ Object (readonly)
Returns the value of attribute helpers.
97 98 99 |
# File 'lib/synvert/core/rewriter.rb', line 97 def helpers @helpers end |
#name ⇒ String (readonly)
Returns the unique name of rewriter.
97 98 99 100 101 102 103 104 105 |
# File 'lib/synvert/core/rewriter.rb', line 97 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec, :test_results |
#options ⇒ Hash
Returns the rewriter options.
97 98 99 100 101 102 103 104 105 |
# File 'lib/synvert/core/rewriter.rb', line 97 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec, :test_results |
#ruby_version ⇒ Rewriter::RubyVersion (readonly)
Returns the ruby version.
97 98 99 100 101 102 103 104 105 |
# File 'lib/synvert/core/rewriter.rb', line 97 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec, :test_results |
#sub_snippets ⇒ Array<Synvert::Core::Rewriter> (readonly)
Returns all rewriters this rewiter calls.
97 98 99 100 101 102 103 104 105 |
# File 'lib/synvert/core/rewriter.rb', line 97 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec, :test_results |
#test_results ⇒ Object (readonly)
Returns the value of attribute test_results.
97 98 99 100 101 102 103 104 105 |
# File 'lib/synvert/core/rewriter.rb', line 97 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec, :test_results |
#warnings ⇒ Array<Synvert::Core::Rewriter::Warning> (readonly)
Returns warning messages.
97 98 99 100 101 102 103 104 105 |
# File 'lib/synvert/core/rewriter.rb', line 97 attr_reader :group, :name, :sub_snippets, :helpers, :warnings, :affected_files, :ruby_version, :gem_spec, :test_results |
Class Method Details
.availables ⇒ Hash<String, Hash<String, Rewriter>>
Get all available rewriters
61 62 63 |
# File 'lib/synvert/core/rewriter.rb', line 61 def availables rewriters end |
.clear ⇒ Object
Clear all registered rewriters.
66 67 68 |
# File 'lib/synvert/core/rewriter.rb', line 66 def clear rewriters.clear end |
.fetch(group, name) ⇒ Synvert::Core::Rewriter
Fetch a rewriter by group and name.
52 53 54 55 56 |
# File 'lib/synvert/core/rewriter.rb', line 52 def fetch(group, name) group = group.to_s name = name.to_s rewriters.dig(group, name) end |
.register(group, name, rewriter) ⇒ Object
Register a rewriter with its group and name.
40 41 42 43 44 45 |
# File 'lib/synvert/core/rewriter.rb', line 40 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.
165 166 167 |
# File 'lib/synvert/core/rewriter.rb', line 165 def add_affected_file(file_path) @affected_files.add(file_path) end |
#add_file(filename, content) ⇒ Object
It adds a new file.
264 265 266 267 268 269 270 271 272 273 274 275 |
# File 'lib/synvert/core/rewriter.rb', line 264 def add_file(filename, content) return unless @options[:run_instance] filepath = File.join(Configuration.root_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 = nil) ⇒ Object
It calls anther rewriter.
304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 |
# File 'lib/synvert/core/rewriter.rb', line 304 def add_snippet(group, name = nil) rewriter = if name Rewriter.fetch(group, name) || Utils.eval_snippet([group, name].join('/')) else Utils.eval_snippet(group) end return unless rewriter && rewriter.is_a?(Rewriter) rewriter. = @options if !rewriter.[:write_to_file] results = rewriter.test merge_test_results(results) elsif rewriter.[:run_instance] rewriter.process else rewriter.process_with_sandbox end @sub_snippets << rewriter end |
#add_warning(warning) ⇒ Object
Add a warning.
158 159 160 |
# File 'lib/synvert/core/rewriter.rb', line 158 def add_warning(warning) @warnings << warning end |
#configure(options) ⇒ Object
Configure the rewriter
178 179 180 181 182 |
# File 'lib/synvert/core/rewriter.rb', line 178 def configure() if [:strategy] @options[:strategy] = [:strategy] end end |
#description(description = nil) ⇒ Object
It sets description of the rewrite or get description.
191 192 193 194 195 196 197 |
# File 'lib/synvert/core/rewriter.rb', line 191 def description(description = nil) if description @description = description else @description end end |
#helper_method(name) { ... } ⇒ Object
It defines helper method for Instance.
338 339 340 |
# File 'lib/synvert/core/rewriter.rb', line 338 def helper_method(name, &block) @helpers << { name: name, block: block } end |
#if_gem(name, version) ⇒ Object
It compares version of the specified gem.
216 217 218 |
# File 'lib/synvert/core/rewriter.rb', line 216 def if_gem(name, version) @gem_spec = Rewriter::GemSpec.new(name, version) end |
#if_ruby(version) ⇒ Object
It checks if ruby version is greater than or equal to the specified ruby version.
205 206 207 |
# File 'lib/synvert/core/rewriter.rb', line 205 def if_ruby(version) @ruby_version = Rewriter::RubyVersion.new(version) end |
#process ⇒ Object
Process the rewriter. It will call the block.
130 131 132 133 134 135 |
# File 'lib/synvert/core/rewriter.rb', line 130 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.
139 140 141 142 |
# File 'lib/synvert/core/rewriter.rb', line 139 def process_with_sandbox @options[:run_instance] = false process end |
#redo_until_no_change ⇒ Object
Rerun the snippet until no change.
347 348 349 |
# File 'lib/synvert/core/rewriter.rb', line 347 def redo_until_no_change @redo_until_no_change = true end |
#remove_file(filename) ⇒ Object
It removes a file.
283 284 285 286 287 288 |
# File 'lib/synvert/core/rewriter.rb', line 283 def remove_file(filename) return unless @options[:run_instance] file_path = File.join(Configuration.root_path, filename) File.delete(file_path) if File.exist?(file_path) end |
#test ⇒ Object
144 145 146 147 148 149 150 151 152 153 |
# File 'lib/synvert/core/rewriter.rb', line 144 def test @options[:write_to_file] = false @affected_files = Set.new instance_eval(&@block) if !@affected_files.empty? && @redo_until_no_change # redo test end @test_results end |
#within_files(file_patterns, &block) ⇒ Object Also known as: within_file
It finds specified files. It creates a Instance to rewrite code.
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 |
# File 'lib/synvert/core/rewriter.rb', line 229 def within_files(file_patterns, &block) return unless @options[:run_instance] return if @ruby_version && !@ruby_version.match? return if @gem_spec && !@gem_spec.match? if @options[:write_to_file] handle_one_file(Array(file_patterns)) do |file_path| instance = Rewriter::Instance.new(self, file_path, &block) instance.process end else results = handle_one_file(Array(file_patterns)) do |file_path| instance = Rewriter::Instance.new(self, file_path, &block) instance.test end merge_test_results(results) end end |