Module: Rails::Crud::Tools

Defined in:
lib/rails/crud/tools.rb,
lib/rails/crud/tools/railtie.rb,
lib/rails/crud/tools/version.rb,
lib/rails/crud/tools/constants.rb,
lib/rails/crud/tools/crud_data.rb,
lib/rails/crud/tools/crud_config.rb,
lib/rails/crud/tools/crud_logger.rb,
lib/rails/crud/tools/crud_operations.rb,
lib/rails/crud/tools/crud_notifications.rb,
lib/rails/crud/tools/crud_operations_logger.rb

Overview

The Tools module provides utility methods for setting up notifications and processing SQL queries. It includes methods to subscribe to ActiveSupport notifications and handle different types of SQL operations.

Defined Under Namespace

Modules: Constants, OperationsLogger Classes: CrudConfig, CrudData, CrudLogger, CrudOperations, Railtie

Constant Summary collapse

VERSION = 
"0.6.20"
OPERATION_UNKNOWN = 
"Unknown"

Class Method Summary collapse

Class Method Details

.determine_key_and_method ⇒ Object

キーとメソッドを決定する



138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/rails/crud/tools/crud_notifications.rb', line 138

def self.determine_key_and_method
  request = Thread.current[:crud_request]
  sidekiq_job_class = Thread.current[:crud_sidekiq_job_class]

  if request
    method = request.request_method
    controller = request.params["controller"]
    action = request.params["action"]
    key = "#{controller}##{action}"
  elsif sidekiq_job_class
    key = sidekiq_job_class
    method = Constants::DEFAULT_METHOD
  else
    return nil
  end

  [key, method]
end

.handle_delete_select(data) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/rails/crud/tools/crud_notifications.rb', line 83

def self.handle_delete_select(data)
  # DELETE ... WHERE EXISTS ... SELECT の特別な処理
  delete_table = data[:sql].match(/DELETE FROM\s+`?(\w+)`?/i)[1]
  select_tables = data[:sql].scan(/SELECT .* FROM\s+`?(\w+)`?(?:\s*,\s*`?(\w+)`?)*|JOIN\s+`?(\w+)`?/i).flatten.compact.uniq

  key, method = determine_key_and_method
  if key.nil? || method.nil?
    CrudLogger.logger.warn "Request not found. #{data[:name]} - #{data[:sql]}"
    return
  end

  CrudOperations.instance.add_operation(method, key, delete_table, "D")
  select_tables.each do |select_table|
    CrudOperations.instance.add_operation(method, key, select_table, "R")
  end
end

.handle_general_sql(data) ⇒ Object 



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/rails/crud/tools/crud_notifications.rb', line 100

def self.handle_general_sql(data)
  operation = if (match = data[:sql].match(/\A\s*(INSERT|UPDATE|DELETE|SELECT)/i))
                case match[1].upcase
                when "INSERT" then "C"
                when "SELECT" then "R"
                when "UPDATE" then "U"
                when "DELETE" then "D"
                else OPERATION_UNKNOWN
                end
              else
                OPERATION_UNKNOWN
              end

  if operation == OPERATION_UNKNOWN
    warn "Warning: Unknown SQL operation. #{data[:name]} - #{data[:sql]}"
    return
  end

  table_names = data[:sql].scan(/(?:INSERT INTO|UPDATE|DELETE FROM|FROM|JOIN)\s+`?(\w+)`?(?:\s*,\s*`?(\w+)`?)*/i).flatten.compact.uniq
  if table_names.empty?
    # テーブル名が見つからない場合は警告を出力
    CrudLogger.logger.warn "Table name not found in SQL: #{data[:sql]}"
    return
  end

  key, method = determine_key_and_method
  if key.nil? || method.nil?
    CrudLogger.logger.warn "Request not found. #{data[:name]} - #{data[:sql]}"
    return
  end

  # テーブル名を取得して CRUD 操作に追加
  table_names.each do |table_name|
    CrudOperations.instance.add_operation(method, key, table_name, operation)
  end
end

.handle_insert_select(data) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/rails/crud/tools/crud_notifications.rb', line 49

def self.handle_insert_select(data)
  # INSERT INTO ... SELECT の特別な処理
  insert_table = data[:sql].match(/INSERT INTO\s+`?(\w+)`?/i)[1]
  select_tables = data[:sql].scan(/SELECT .* FROM\s+`?(\w+)`?(?:\s*,\s*`?(\w+)`?)*|JOIN\s+`?(\w+)`?/i).flatten.compact.uniq

  key, method = determine_key_and_method
  if key.nil? || method.nil?
    CrudLogger.logger.warn "Request not found. #{data[:name]} - #{data[:sql]}"
    return
  end

  CrudOperations.instance.add_operation(method, key, insert_table, "C")
  select_tables.each do |select_table|
    CrudOperations.instance.add_operation(method, key, select_table, "R")
  end
end

.handle_update_select(data) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/rails/crud/tools/crud_notifications.rb', line 66

def self.handle_update_select(data)
  # UPDATE ... SET ... SELECT の特別な処理
  update_table = data[:sql].match(/UPDATE\s+`?(\w+)`?/i)[1]
  select_tables = data[:sql].scan(/SELECT .* FROM\s+`?(\w+)`?(?:\s*,\s*`?(\w+)`?)*|JOIN\s+`?(\w+)`?/i).flatten.compact.uniq

  key, method = determine_key_and_method
  if key.nil? || method.nil?
    CrudLogger.logger.warn "Request not found. #{data[:name]} - #{data[:sql]}"
    return
  end

  CrudOperations.instance.add_operation(method, key, update_table, "U")
  select_tables.each do |select_table|
    CrudOperations.instance.add_operation(method, key, select_table, "R")
  end
end

.process_sql(data) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/rails/crud/tools/crud_notifications.rb', line 29

def self.process_sql(data)
  return unless data[:sql] =~ /\A\s*(INSERT|UPDATE|DELETE|SELECT)/i

  case data[:sql]
  when /\bINSERT INTO\b.*\bSELECT\b/i
    handle_insert_select(data)
  when /\bUPDATE\b.*\bSET\b.*\bSELECT\b/i
    handle_update_select(data)
  when /\bDELETE\b.*\bEXISTS\b.*\bSELECT\b/i
    handle_delete_select(data)
  else
    handle_general_sql(data)
  end

  return unless CrudConfig.instance.config.sql_logging_enabled

  # SQL ログを出力
  CrudLogger.logger.info "#{data[:name]} - #{data[:sql]}"
end

.setup ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/rails/crud/tools.rb', line 20

def self.setup
  unless File.exist?(CrudConfig.config_path)
    puts "The .crudconfig.yml file is required. Please run `bundle exec crud init`."
    return
  end

  unless File.exist?(CrudConfig.instance.config.crud_file_path)
    puts "The CRUD file is required. Please run `bundle exec crud gen crud`."
    return
  end

  CrudData.instance.process_id = "rails-crud-tools-#{Time.now.strftime("%Y%m%d%H%M%S")}"
  CrudData.instance.load_crud_data
  setup_notifications
end

.setup_notifications ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
# File 'lib/rails/crud/tools/crud_notifications.rb', line 10

def self.setup_notifications
  # 初回呼び出し時に @subscribed を false に設定
  @subscribed ||= false
  # 既に通知が登録されている場合は処理を中断
  return if @subscribed

  if CrudConfig.instance.config.enabled
    # SQL クエリを監視する
    ActiveSupport::Notifications.subscribe(/sql.active_record/) do |_name, _started, _finished, _unique_id, data|
      process_sql(data)
    end
  end

  # 通知の登録が完了した後に @subscribed を true に設定
  @subscribed = true
end