Class: ToggleableFieldGenerator

Inherits:
Rails::Generators::NamedBase
  • Object
show all
Defined in:
lib/generators/toggleable_field/toggleable_field_generator.rb

Overview

lib/generators/toggleable_field/toggleable_field_generator.rb

Instance Method Summary collapse

Instance Method Details

#create_migration_fileObject



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/generators/toggleable_field/toggleable_field_generator.rb', line 17

def create_migration_file
  # Step 1: 使用 rails generate migration 创建一个带时间戳的空迁移文件
  # 迁移类名通常为 AddFieldNameToTableName (e.g., AddActiveToUsers)
  migration_class_name = "Add#{field_name.camelize}To#{table_name.camelize}"
  
  # 调用 migration generator 创建骨架
  generate "migration", migration_class_name
  
  # Step 2: 找到刚刚生成的、带有最新时间戳的迁移文件
  # Rails generators 将文件添加到 pending 操作中,我们可以从这里获取路径
  # 更可靠的方法是搜索 db/migrate 目录下以该类名结尾的 .rb 文件
  generated_files = Dir.glob(Rails.root.join("db/migrate/*_#{migration_class_name.underscore}.rb"))
  if generated_files.empty?
    abort "Error: Failed to find the generated migration file for #{migration_class_name}."
  end
  
  # 取最新的一个(理论上应该只有一个)
  migration_file_path = generated_files.sort.last
  
  # Step 3: 读取现有内容并插入我们的代码
  content = <<~RUBY
    class #{migration_class_name} < ActiveRecord::Migration[#{migration_version}]
      def change
        add_column :#{table_name}, :#{field_name}, :boolean, default: true
        # Consider adding an index if you frequently query by this field
        # add_index :#{table_name}, :#{field_name}
      end
    end
  RUBY
  
  # 写入新内容
  File.open(migration_file_path, 'w') do |file|
    file.write(content)
  end
  
  # Step 4: 向用户报告
  log "\nUpdated migration file: #{migration_file_path.sub(Rails.root.to_s + '/', '')}"
end

#field_nameObject



5
6
7
# File 'lib/generators/toggleable_field/toggleable_field_generator.rb', line 5

def field_name
  file_name
end

#model_nameObject



9
10
11
# File 'lib/generators/toggleable_field/toggleable_field_generator.rb', line 9

def model_name
  options[:model] || file_name.singularize.classify
end

#table_nameObject



13
14
15
# File 'lib/generators/toggleable_field/toggleable_field_generator.rb', line 13

def table_name
  model_name.underscore.pluralize
end