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 can contain one or many [Synvert::Core::Rewriter::Instance], which define the behavior what files and what codes to detect and rewrite to what code.
Synvert::Rewriter.new 'factory_girl_short_syntax', 'use FactoryGirl short syntax' do
if_gem 'factory_girl', {gte: '2.0.0'}
within_files 'spec/**/*.rb' do
with_node type: 'send', receiver: 'FactoryGirl', message: 'create' do
replace_with "create({{arguments}})"
end
end
end
Defined Under Namespace
Modules: Helper Classes: Action, AppendAction, Condition, GemSpec, GotoScope, IfExistCondition, IfOnlyExistCondition, InsertAction, InsertAfterAction, Instance, RemoveAction, ReplaceErbStmtWithExprAction, ReplaceWithAction, Scope, UnlessExistCondition, Warning, WithinScope
Instance Attribute Summary collapse
-
#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.
-
#sub_snippets ⇒ Array<Synvert::Core::Rewriter>
readonly
All rewriters this rewiter calls.
-
#warnings ⇒ Object
readonly
Returns the value of attribute warnings.
Class Method Summary collapse
-
.availables ⇒ Hash<String, Hash<String, Rewriter>>
Get all available rewriters.
-
.call(group, name) ⇒ Synvert::Core::Rewriter
Get a registered rewriter by group and name, then process that rewriter.
-
.clear ⇒ Object
Clear all registered rewriters.
-
.exist?(group, name) ⇒ Boolean
Check if one rewriter exist.
-
.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_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, &block) ⇒ Object
Parse helper_method dsl, it defines helper method for [Synvert::Core::Rewriter::Instance].
-
#if_gem(name, comparator) ⇒ Object
Parse if_gem dsl, it compares version of the specified gem.
-
#initialize(group, name, &block) ⇒ Synvert::Core::Rewriter
constructor
Initialize a rewriter.
-
#process ⇒ Object
Process the rewriter.
-
#process_with_sandbox ⇒ Object
Process rewriter with sandbox mode.
-
#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_pattern, &block) ⇒ Object
(also: #within_file)
Parse within_files dsl, it finds specified files.
Constructor Details
#initialize(group, name, &block) ⇒ Synvert::Core::Rewriter
Initialize a rewriter. When a rewriter is initialized, it is also registered.
140 141 142 143 144 145 146 147 148 |
# File 'lib/synvert/core/rewriter.rb', line 140 def initialize(group, name, &block) @group = group @name = name @block = block @helpers = [] @sub_snippets = [] @warnings = [] self.class.register(@group, @name, self) end |
Instance Attribute Details
#group ⇒ String (readonly)
Returns the group of rewriter.
131 132 133 |
# File 'lib/synvert/core/rewriter.rb', line 131 def group @group end |
#helper ⇒ Array (readonly)
Returns helper methods.
131 |
# File 'lib/synvert/core/rewriter.rb', line 131 attr_reader :group, :name, :sub_snippets, :helpers, :warnings |
#helpers ⇒ Object (readonly)
Returns the value of attribute helpers.
131 132 133 |
# File 'lib/synvert/core/rewriter.rb', line 131 def helpers @helpers end |
#name ⇒ String (readonly)
Returns the unique name of rewriter.
131 |
# File 'lib/synvert/core/rewriter.rb', line 131 attr_reader :group, :name, :sub_snippets, :helpers, :warnings |
#sub_snippets ⇒ Array<Synvert::Core::Rewriter> (readonly)
Returns all rewriters this rewiter calls.
131 |
# File 'lib/synvert/core/rewriter.rb', line 131 attr_reader :group, :name, :sub_snippets, :helpers, :warnings |
#warnings ⇒ Object (readonly)
Returns the value of attribute warnings.
131 |
# File 'lib/synvert/core/rewriter.rb', line 131 attr_reader :group, :name, :sub_snippets, :helpers, :warnings |
Class Method Details
.availables ⇒ Hash<String, Hash<String, Rewriter>>
Get all available rewriters
105 106 107 |
# File 'lib/synvert/core/rewriter.rb', line 105 def availables rewriters end |
.call(group, name) ⇒ Synvert::Core::Rewriter
Get a registered rewriter by group and name, then process that rewriter.
77 78 79 80 81 82 83 84 85 86 |
# File 'lib/synvert/core/rewriter.rb', line 77 def call(group, name) group, name = group.to_s, name.to_s if exist? group, name rewriter = rewriters[group][name] rewriter.process rewriter else raise RewriterNotFound.new "Rewriter #{group}/#{name} not found" end end |
.clear ⇒ Object
Clear all registered rewriters.
110 111 112 |
# File 'lib/synvert/core/rewriter.rb', line 110 def clear rewriters.clear end |
.exist?(group, name) ⇒ Boolean
Check if one rewriter exist.
93 94 95 96 97 98 99 100 |
# File 'lib/synvert/core/rewriter.rb', line 93 def exist?(group, name) group, name = group.to_s, name.to_s if rewriters[group] && rewriters[group][name] true else false end end |
.fetch(group, name) ⇒ Synvert::Core::Rewriter
Fetch a rewriter by group and name.
62 63 64 65 66 67 68 69 |
# File 'lib/synvert/core/rewriter.rb', line 62 def fetch(group, name) group, name = group.to_s, name.to_s if exist? group, name rewriters[group][name] else raise RewriterNotFound.new "Rewriter #{group} #{name} not found" end end |
.register(group, name, rewriter) ⇒ Object
Register a rewriter with its group and name.
50 51 52 53 54 |
# File 'lib/synvert/core/rewriter.rb', line 50 def register(group, name, rewriter) group, name = group.to_s, name.to_s rewriters[group] ||= {} rewriters[group][name] = rewriter end |
Instance Method Details
#add_file(filename, content) ⇒ Object
Parses add_file dsl, it adds a new file.
217 218 219 220 221 222 223 |
# File 'lib/synvert/core/rewriter.rb', line 217 def add_file(filename, content) return if @sandbox File.open File.join(Configuration.instance.get(:path), filename), 'w' do |file| file.write content end end |
#add_snippet(group, name) ⇒ Object
Parse add_snippet dsl, it calls anther rewriter.
239 240 241 |
# File 'lib/synvert/core/rewriter.rb', line 239 def add_snippet(group, name) @sub_snippets << self.class.call(group.to_s, name.to_s) end |
#add_warning(warning) ⇒ Object
Add a warning.
167 168 169 |
# File 'lib/synvert/core/rewriter.rb', line 167 def add_warning(warning) @warnings << warning end |
#description(description = nil) ⇒ Object
Parse description dsl, it sets description of the rewrite. Or get description.
180 181 182 183 184 185 186 |
# File 'lib/synvert/core/rewriter.rb', line 180 def description(description=nil) if description @description = description else @description end end |
#helper_method(name, &block) ⇒ Object
Parse helper_method dsl, it defines helper method for [Synvert::Core::Rewriter::Instance].
247 248 249 |
# File 'lib/synvert/core/rewriter.rb', line 247 def helper_method(name, &block) @helpers << {name: name, block: block} end |
#if_gem(name, comparator) ⇒ Object
Parse if_gem dsl, it compares version of the specified gem.
193 194 195 |
# File 'lib/synvert/core/rewriter.rb', line 193 def if_gem(name, comparator) @gem_spec = Rewriter::GemSpec.new(name, comparator) end |
#process ⇒ Object
Process the rewriter. It will call the block.
152 153 154 |
# File 'lib/synvert/core/rewriter.rb', line 152 def process self.instance_eval &@block end |
#process_with_sandbox ⇒ Object
Process rewriter with sandbox mode. It will call the block but doesn’t change any file.
158 159 160 161 162 |
# File 'lib/synvert/core/rewriter.rb', line 158 def process_with_sandbox @sandbox = true self.process @sandbox = false end |
#remove_file(filename) ⇒ Object
Parses remove_file dsl, it removes a file.
228 229 230 231 232 233 |
# File 'lib/synvert/core/rewriter.rb', line 228 def remove_file(filename) return if @sandbox file_path = File.join(Configuration.instance.get(: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.
256 257 258 259 260 261 262 |
# File 'lib/synvert/core/rewriter.rb', line 256 def todo(todo=nil) if todo @todo = todo else @todo end end |
#within_files(file_pattern, &block) ⇒ Object Also known as: within_file
Parse within_files dsl, it finds specified files. It creates a [Synvert::Core::Rewriter::Instance] to rewrite code.
202 203 204 205 206 207 208 |
# File 'lib/synvert/core/rewriter.rb', line 202 def within_files(file_pattern, &block) return if @sandbox if !@gem_spec || @gem_spec.match? Rewriter::Instance.new(self, file_pattern, &block).process end end |