Class: Synvert::Core::Rewriter

Inherits:
Object
  • Object
show all
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, RubyVersion, Scope, UnlessExistCondition, Warning, WithinScope

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(group, name, &block) ⇒ Synvert::Core::Rewriter

Initialize a rewriter. When a rewriter is initialized, it is also registered.

Parameters:

  • group (String) —

    group of the rewriter.

  • name (String) —

    name of the rewriter.

  • block (Block) —

    a block defines the behaviors of the rewriter, block code won’t be called when initialization.



153
154
155
156
157
158
159
160
161
 
# File 'lib/synvert/core/rewriter.rb', line 153

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.

Returns:

  • (String) —

    the group of rewriter



144
145
146
 
# File 'lib/synvert/core/rewriter.rb', line 144

def group
  @group
end

#helper ⇒ Array (readonly)

Returns helper methods.

Returns:

  • (Array) —

    helper methods.



144
 
# File 'lib/synvert/core/rewriter.rb', line 144

attr_reader :group, :name, :sub_snippets, :helpers, :warnings

#helpers ⇒ Object (readonly)

Returns the value of attribute helpers.



144
145
146
 
# File 'lib/synvert/core/rewriter.rb', line 144

def helpers
  @helpers
end

#name ⇒ String (readonly)

Returns the unique name of rewriter.

Returns:

  • (String) —

    the unique name of rewriter



144
 
# File 'lib/synvert/core/rewriter.rb', line 144

attr_reader :group, :name, :sub_snippets, :helpers, :warnings

#sub_snippets ⇒ Array<Synvert::Core::Rewriter> (readonly)

Returns all rewriters this rewiter calls.

Returns:



144
 
# File 'lib/synvert/core/rewriter.rb', line 144

attr_reader :group, :name, :sub_snippets, :helpers, :warnings

#warnings ⇒ Object (readonly)

Returns the value of attribute warnings.



144
 
# File 'lib/synvert/core/rewriter.rb', line 144

attr_reader :group, :name, :sub_snippets, :helpers, :warnings

Class Method Details

.availables ⇒ Hash<String, Hash<String, Rewriter>>

Get all available rewriters

Returns:

  • (Hash<String, Hash<String, Rewriter>>) 


118
119
120
 
# File 'lib/synvert/core/rewriter.rb', line 118

def availables
  rewriters
end

.call(group, name, sandbox = false) ⇒ Synvert::Core::Rewriter

Get a registered rewriter by group and name, then process that rewriter.

Parameters:

  • group (String) —

    the rewriter group.

  • name (String) —

    the rewriter name.

  • sandbox (Boolean) (defaults to: false) —

    if run in sandbox mode, default is false.

Returns:

Raises:



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/synvert/core/rewriter.rb', line 86

def call(group, name, sandbox = false)
  group, name = group.to_s, name.to_s
  if exist? group, name
    rewriter = rewriters[group][name]
    if sandbox
      rewriter.process_with_sandbox
    else
      rewriter.process
    end
    rewriter
  else
    raise RewriterNotFound, "Rewriter #{group}/#{name} not found"
  end
end

.clear ⇒ Object

Clear all registered rewriters.



123
124
125
 
# File 'lib/synvert/core/rewriter.rb', line 123

def clear
  rewriters.clear
end

.execute(&block) ⇒ Object

Execute the temporary rewriter without group and name.

Parameters:

  • block (Block) —

    a block defines the behaviors of the rewriter.



49
50
51
 
# File 'lib/synvert/core/rewriter.rb', line 49

def execute(&block)
  Rewriter.new('', '', &block).process
end

.exist?(group, name) ⇒ Boolean

Check if one rewriter exist.

Parameters:

  • group (String) —

    the rewriter group.

  • name (String) —

    the rewriter name.

Returns:

  • (Boolean) —

    true if the rewriter exist.



106
107
108
109
110
111
112
113
 
# File 'lib/synvert/core/rewriter.rb', line 106

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.

Parameters:

  • group (String) —

    rewrtier group.

  • name (String) —

    rewrtier name.

Returns:

Raises:



70
71
72
73
74
75
76
77
 
# File 'lib/synvert/core/rewriter.rb', line 70

def fetch(group, name)
  group, name = group.to_s, name.to_s
  if exist? group, name
    rewriters[group][name]
  else
    raise RewriterNotFound, "Rewriter #{group} #{name} not found"
  end
end

.register(group, name, rewriter) ⇒ Object

Register a rewriter with its group and name.

Parameters:

  • group (String) —

    the rewriter group.

  • name (String) —

    the unique rewriter name.

  • rewriter (Synvert::Core::Rewriter) —

    the rewriter to register.



58
59
60
61
62
 
# File 'lib/synvert/core/rewriter.rb', line 58

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.

Parameters:

  • filename (String) —

    file name of newly created file.

  • content (String) —

    file body of newly created file.



241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/synvert/core/rewriter.rb', line 241

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.open filepath, 'w' do |file|
    file.write content
  end
end

#add_snippet(group, name) ⇒ Object

Parse add_snippet dsl, it calls anther rewriter.

Parameters:

  • group (String) —

    group of another rewriter.

  • name (String) —

    name of another rewriter.



270
271
272
 
# File 'lib/synvert/core/rewriter.rb', line 270

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.

Parameters:



183
184
185
 
# File 'lib/synvert/core/rewriter.rb', line 183

def add_warning(warning)
  @warnings << warning
end

#description(description = nil) ⇒ Object

Parse description dsl, it sets description of the rewrite. Or get description.

Parameters:

  • description (String) (defaults to: nil) —

    rewriter description.

Returns:

  • rewriter description.



196
197
198
199
200
201
202
 
# File 'lib/synvert/core/rewriter.rb', line 196

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].

Parameters:

  • name (String) —

    helper method name.

  • block (Block) —

    helper method block.



278
279
280
 
# File 'lib/synvert/core/rewriter.rb', line 278

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.

Parameters:

  • name (String) —

    gem name.

  • comparator (Hash) —

    equal, less than or greater than specified version, e.g. ‘2.0.0’, key can be eq, lt, gt, lte, gte or ne.



216
217
218
 
# File 'lib/synvert/core/rewriter.rb', line 216

def if_gem(name, comparator)
  @gem_spec = Rewriter::GemSpec.new(name, comparator)
end

#if_ruby(version) ⇒ Object

Parse if_ruby dal, it checks if ruby version if greater than or equal to the specified ruby version.

Parameters:

  • version, (String) —

    specified ruby version.



207
208
209
 
# File 'lib/synvert/core/rewriter.rb', line 207

def if_ruby(version)
  @ruby_version = Rewriter::RubyVersion.new(version)
end

#process ⇒ Object

Process the rewriter. It will call the block.



165
166
167
 
# File 'lib/synvert/core/rewriter.rb', line 165

def process
  instance_eval &@block
end

#process_with_sandbox ⇒ Object

Process rewriter with sandbox mode. It will call the block but doesn’t change any file.



171
172
173
174
175
176
177
178
 
# File 'lib/synvert/core/rewriter.rb', line 171

def process_with_sandbox
  @sandbox = true
  begin
    process
  ensure
    @sandbox = false
  end
end

#remove_file(filename) ⇒ Object

Parses remove_file dsl, it removes a file.

Parameters:

  • filename (String) —

    file name.



259
260
261
262
263
264
 
# File 'lib/synvert/core/rewriter.rb', line 259

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.

Parameters:

  • todo_list (String) —

    rewriter todo.

Returns:

  • (String) —

    rewriter todo.



287
288
289
290
291
292
293
 
# File 'lib/synvert/core/rewriter.rb', line 287

def todo(todo = nil)
  if todo
    @todo = todo
  else
    @todo
  end
end

#within_files(file_pattern, options = {}, &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.

Parameters:

  • file_pattern (String) —

    pattern to find files, e.g. spec/*/_spec.rb

  • options (Hash) (defaults to: {}) —

    instance options.

  • block (Block) —

    the block to rewrite code in the matching files.



226
227
228
229
230
231
232
 
# File 'lib/synvert/core/rewriter.rb', line 226

def within_files(file_pattern, options = {}, &block)
  return if @sandbox

  if (!@ruby_version || @ruby_version.match?) && (!@gem_spec || @gem_spec.match?)
    Rewriter::Instance.new(self, file_pattern, options, &block).process
  end
end