rails-crud-tools 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 768af8c4b3d9581a61568c0817ae477ef8d2f30552825ba1c69fa7daa4d748dc
+  data.tar.gz: aab060f00958cfa1c1969f7bb87692854b8a5c6d638cc7b31b4c540b6071e871
+SHA512:
+  metadata.gz: 0e58858f11d6fa4aab47fa791881ee52e2d714f347abee711eaeedfd57f780f51c63f0f8fae3964eb897b454e93fe116a0fb1cbcf57892d5f22612b3e7bd5500
+  data.tar.gz: 96a3967933bf721e59d1007a2fe12a3103f52866197401436523355282cc72367417c62a462b9490395b0f8ade376b8d8988b574df0178edb1ba012668085193

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+## [0.4.0] - 2025-01-03
+- セルの値が変化する場合のみ保存するよう修正
+- 設定ファイルにシート名を追加
+- 設定ファイルにフォント名を追加
+- テストコード作成
+- 初期化コマンド追加
+- 設定ファイル作成コマンド追加
+
+## [0.3.2] - 2025-01-01
+
+- 複数スレッド対応
+
+## [0.3.1] - 2024-12-31
+
+- rails-crud-toolsに変更
+
+## [0.3.0] - 2024-12-30
+
+- ジョブ対応
+- クラッド図生成コマンドの追加
+
+## [0.2.2] - 2024-12-25
+
+- SQL出力のON/OFFを追加
+- サマリーログの改善
+
+## [0.2.1] - 2024-12-25
+
+- リファクタリング
+
+## [0.2.0] - 2024-12-25
+
+- api対応
+
+## [0.1.6] - 2024-12-25
+
+- ログ改善
+
+## [0.1.5] - 2024-12-25
+
+- マルチスレッド改善
+
+## [0.1.4] - 2024-12-24
+
+- リファクタリング
+
+## [0.1.3] - 2024-12-24
+
+- bug fix
+
+## [0.1.2] - 2024-12-24
+
+- bug fix
+
+## [0.1.1] - 2024-12-24
+
+- プレビュー版のリリース
+
+## [0.1.0] - 2024-12-23
+
+- Initial release

data/Dockerfile

@@ -0,0 +1,21 @@
+FROM ruby:3.1.4
+
+ARG IDEURL=https://download.jetbrains.com/ruby/RubyMine-2024.3.1.tar.gz
+
+RUN apt-get update -qq && apt-get install -y \
+  build-essential \
+  vim && \
+  rm -rf /var/lib/apt/lists/*
+
+ENV EDITOR=vim
+
+WORKDIR /root/app
+
+RUN curl -fsSL -o ide.tar.gz $IDEURL && \
+mkdir ide && \
+tar xfz ide.tar.gz --strip-components=1 -C ide && \
+rm ide.tar.gz
+
+CMD yes '' | ide/bin/remote-dev-server.sh run $APP_ROOT --listenOn 0.0.0.0 --port 5995
+
+EXPOSE 5995

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails-crud-tools.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.21"
+
+group :test do
+  gem "rails"
+  gem "simplecov"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 yamabiko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 yhijikata
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,108 @@
+# Rails::Crud::Tools
+
+Welcome to Rails::Crud::Tools!   
+This gem provides a tool to automatically update CRUD diagrams as you interact with your application.   
+It simplifies logging and managing CRUD operations seamlessly within a Rails application.
+
+## Installation
+
+Add the gem to the `development` group in your application's Gemfile by including the following lines:
+
+```ruby
+gem 'rails-crud-tools', git: 'https://github.com/YamabikoLab/rails-crud-tools', tag: 'v*.*.*'
+```
+
+Then execute:
+
+```sh
+$ bundle install
+```
+
+If you are not using Bundler, you can install the gem manually:
+
+```sh
+$ gem install rails-crud-tools
+```
+
+## Usage
+
+### Setup
+This command will generate the **doc/crud.xlsx** file and the **.crudconfig** file.
+
+```sh
+$ bundle exec crud init
+```
+
+.crudconfig
+```yaml
+enabled: true # Enables or disables the CRUD tools functionality
+base_dir: doc # The base directory where the CRUD files will be stored
+crud_file: crud.xlsx # The name of the CRUD Excel file
+sheet_name: CRUD # The name of the sheet in the CRUD Excel file
+method_col: Verb # Column indicating the HTTP method
+action_col: Controller#Action # Column indicating the controller and action
+table_start_col: your_first_table  # Column where the table starts
+header_bg_color: 00FFCC # The background color for the header in the CRUD Excel file
+sql_logging_enabled: true # Enables or disables SQL logging for CRUD operations
+font_name: Arial # The font name used in the CRUD Excel file
+```
+
+### How It Works
+
+Once integrated, the gem automatically tracks CRUD operations (Create, Read, Update, Delete) performed in your application.   
+The diagrams will update dynamically based on these operations, providing you with real-time insights into your application's data flow.
+
+## Logs
+
+Please refer to the log file at `log/crud.log`.
+
+## CRUD Macro Workbook
+
+The `tools/crud_macro.xlsm` file is a macro-enabled workbook used for manipulating CRUD diagrams.  
+This workbook contains macros that help in managing and visualizing CRUD operations within your application.
+
+### Download
+
+You can download the `crud_macro.xlsm` file from the following link:
+
+[Download crud_macro.xlsm](https://github.com/YamabikoLab/rails-crud/raw/main/tools/crud_macro.xlsm)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run the following command to execute the tests:
+
+```sh
+$ rake spec
+```
+
+You can also use `bin/console` for an interactive prompt to experiment with the gem’s functionality.
+
+To install this gem onto your local machine for development purposes, run:
+
+```sh
+$ bundle exec rake install
+```
+
+To release a new version:
+1. Update the version number in `version.rb`.
+2. Run:
+
+```sh
+$ bundle exec rake release
+```
+
+This will create a git tag for the new version, push the git commits and tag, and upload the `.gem` file to [RubyGems](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/YamabikoLab/rails-crud](https://github.com/YamabikoLab/rails-crud).
+
+When contributing, please:
+- Fork the repository.
+- Create a feature branch.
+- Submit a pull request with a clear description of your changes.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3.8'
+services:
+  app:
+    build: .
+    container_name: rails-crud-tools
+    volumes:
+      - .:/root/app
+      - /root/app/ide
+    ports:
+      - '5995:5995'
+    tty: true

data/exe/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rails/crud/tools"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/exe/crud

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require "rails/crud/tools/cli"
+
+def display_help
+  puts <<~HELP
+    Usage: crud [command]
+
+    Commands:
+      init    Initialize by generating CRUD and config files
+      gen_crud     Generate CRUD
+      gen_config   Generate config
+      help    Display this help message
+  HELP
+end
+
+if ARGV.empty? || ARGV.include?("help")
+  display_help
+elsif ARGV.include?("init")
+  RailsCrudTools::CLI.init
+elsif ARGV.include?("gen_crud")
+  RailsCrudTools::CLI.generate_crud_file
+elsif ARGV.include?("gen_config")
+  RailsCrudTools::CLI.generate_crudconfig
+else
+  puts "Unknown command: #{ARGV.join(' ')}"
+  display_help
+end

data/exe/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rails/crud/tools/cli.rb

@@ -0,0 +1,178 @@
+require "rubyXL"
+require 'rubyXL/convenience_methods'
+require 'active_record'
+require 'yaml'
+require 'erb'
+
+module RailsCrudTools
+  class CLI
+    @application_loaded = false
+    class << self
+      def generate_crud_file
+        load_application unless @application_loaded
+
+        # 1. `bundle exec rails routes --expanded`の結果を取得
+        routes_output = `bundle exec rails routes --expanded`
+        config = Rails::Crud::Tools::CrudConfig.instance
+        font_name = config.font_name
+
+        # 2. 取得した結果を区切り文字で分割
+        routes_lines = routes_output.split("\n").reject(&:empty?)
+        routes_data = []
+        current_route = {}
+
+        routes_lines.each do |line|
+          if line.start_with?("--[ Route")
+            routes_data << current_route unless current_route.empty?
+            current_route = {}
+          else
+            key, value = line.split("|").map(&:strip)
+            current_route[key] = value
+          end
+        end
+        routes_data << current_route unless current_route.empty?
+
+        # 3. 全テーブル名を取得し、アルファベット順にソート
+        table_names = ActiveRecord::Base.connection.tables.sort
+
+        # 4. `rubyXL`を使って`xlsx`ファイルに書き込み
+        workbook = RubyXL::Workbook.new
+        sheet = workbook[0]
+        sheet.sheet_name = config.sheet_name
+
+        # ヘッダー行を追加
+        headers = %w[Prefix Verb URI Controller#Action crud_count] + table_names
+
+        headers.each_with_index do |header, index|
+          cell = sheet.add_cell(0, index, header)
+          cell.change_fill("00FFCC")
+          cell.change_font_name(font_name)
+          cell.change_font_bold(true)
+          apply_borders(cell)
+        end
+
+        start_col = "F"
+        end_col = ("A".."ZZ").to_a[table_names.length + 4] # 'F'から始まる列の範囲を計算
+
+        # データ行を追加
+        routes_data.each_with_index do |route, row_index|
+          headers.each_with_index do |header, col_index|
+            cell = sheet.add_cell(row_index + 1, col_index, route[header])
+            cell.change_font_name(font_name)
+            apply_borders(cell)
+          end
+
+          # 追加: crud_count列に式を設定
+          crud_count_formula = "=SUMPRODUCT(LEN(#{start_col}#{row_index + 2}:#{end_col}#{row_index + 2}))"
+          crud_count_cell = sheet.add_cell(row_index + 1, 4, "", crud_count_formula)
+          crud_count_cell.change_font_name(font_name)
+          apply_borders(crud_count_cell)
+        end
+
+        # app/jobs ディレクトリ内のジョブ名を取得
+        job_files = Dir.glob("app/jobs/**/*.rb")
+        job_classes = job_files.map do |file|
+          File.basename(file, ".rb").camelize
+        end.reject { |job| job == "ApplicationJob" }.sort
+
+        # ジョブ名を Controller#Action 列に追加
+        job_classes.each_with_index do |job, index|
+          headers.each_with_index do |header, col_index|
+            if header == "Controller#Action"
+              cell = sheet.add_cell(routes_data.length + 1 + index, col_index, job)
+              cell.change_font_name(font_name)
+            else
+              cell = sheet.add_cell(routes_data.length + 1 + index, col_index, nil)
+            end
+            apply_borders(cell)
+          end
+
+          # 追加: crud_count列に式を設定
+          crud_count_formula = "=SUMPRODUCT(LEN(#{start_col}#{routes_data.length + 2 + index}:#{end_col}#{routes_data.length + 2 + index}))"
+          crud_count_cell = sheet.add_cell(routes_data.length + 1 + index, 4, "", crud_count_formula)
+          crud_count_cell.change_font_name(font_name)
+          apply_borders(crud_count_cell)
+        end
+
+        # ヘッダーの背景色を設定
+        (0..headers.length - 1).each do |col_index|
+          sheet[0][col_index].change_fill(config.header_bg_color)
+        end
+
+        # 列幅を設定
+        headers.each_with_index do |header, col_index|
+          max_length = header.length
+          (1..routes_data.length).each do |row_index|
+            cell_value = sheet[row_index][col_index].value.to_s
+            max_length = [max_length, cell_value.length].max
+          end
+          sheet.change_column_width(col_index, max_length + 2)
+        end
+
+        # ファイルを保存
+        crud_file = config.crud_file_path
+        workbook.write(crud_file)
+
+        puts "Output: #{crud_file}"
+      end
+
+      def generate_crudconfig
+        load_application unless @application_loaded
+
+        table_names = ActiveRecord::Base.connection.tables.sort
+        table_start_col = table_names.any? ? table_names.first : "active_admin_comments"
+
+        config_content = <<~CONFIG
+          enabled: true
+          base_dir: doc
+          crud_file: crud.xlsx
+          sheet_name: CRUD
+          method_col: Verb
+          action_col: Controller#Action
+          table_start_col: #{table_start_col}
+          sql_logging_enabled: true
+          header_bg_color: 00FFCC
+          font_name: Arial
+        CONFIG
+
+        File.write('.crudconfig', config_content)
+        puts "Generated .crudconfig file"
+      end
+
+      def init
+        generate_crudconfig
+        generate_crud_file
+      end
+
+      private
+
+      def load_application
+        return if @application_loaded
+
+        path = Dir.pwd
+        $stderr.puts "Loading application in '#{File.basename(path)}'..."
+        environment_path = "#{path}/config/environment.rb"
+        require environment_path
+
+        if defined? Rails
+          Rails.application.eager_load!
+          Rails.application.config.eager_load_namespaces.each(&:eager_load!) if Rails.application.config.respond_to?(:eager_load_namespaces)
+        end
+
+        @application_loaded = true
+      rescue ::LoadError
+        error_message = <<~EOS
+          Tried to load your application environment from '#{environment_path}'.
+        EOS
+        puts error_message
+      rescue TypeError
+      end
+
+      def apply_borders(cell)
+        %i[top bottom left right].each do |side|
+          cell.change_border(side, "thin")
+        end
+      end
+    end
+  end
+end

data/lib/rails/crud/tools/constants.rb

@@ -0,0 +1,9 @@
+module Rails
+  module Crud
+    module Tools
+      module Constants
+        DEFAULT_METHOD = "default_method"
+      end
+    end
+  end
+end

data/lib/rails/crud/tools/crud_config.rb

@@ -0,0 +1,50 @@
+require "yaml"
+
+module Rails
+  module Crud
+    module Tools
+      class CrudConfig
+        include Singleton
+
+        attr_accessor :enabled, :base_dir, :crud_file, :sheet_name, :method_col, :action_col, :table_start_col, :sql_logging_enabled, :header_bg_color, :font_name
+
+        def initialize
+          @config_file = ".crudconfig"
+          @last_loaded = nil
+          load_config
+        end
+
+        def load_config
+          if @last_loaded.nil? || File.mtime(@config_file) > @last_loaded
+            unless File.exist?(@config_file)
+              raise "Config file not found: #{@config_file}. Please generate it using `bundle exec crud gen_config`."
+            end
+
+            config = YAML.load_file(@config_file)
+
+            @enabled = config["enabled"]
+            @base_dir = config["base_dir"]
+            @crud_file = config["crud_file"]
+            @sheet_name = config["sheet_name"]
+            @method_col = config["method_col"]
+            @action_col = config["action_col"]
+            @table_start_col = config["table_start_col"]
+            @sql_logging_enabled = config["sql_logging_enabled"]
+            @header_bg_color = config["header_bg_color"]
+            @font_name = config["font_name"]
+
+            @last_loaded = File.mtime(@config_file)
+          end
+        end
+
+        def crud_file_path
+          File.join(@base_dir, @crud_file)
+        end
+
+        def crud_log_path
+          File.join(@base_dir, @crud_log)
+        end
+      end
+    end
+  end
+end

data/lib/rails/crud/tools/crud_data.rb

@@ -0,0 +1,80 @@
+require_relative "crud_logger"
+require_relative "constants"
+
+module Rails
+  module Crud
+    module Tools
+      # このクラスは、CRUDファイルからデータを読み込むためのクラスです。
+      class CrudData
+        include Singleton
+
+        attr_accessor :crud_rows, :crud_cols, :workbook, :last_loaded_time
+
+        def initialize
+          @crud_rows = {}
+          @crud_cols = {}
+          @last_loaded_time = nil
+        end
+
+        def load_crud_data
+          config = CrudConfig.instance
+          return unless config.enabled
+
+          unless File.exist?(config.crud_file_path)
+            CrudLogger.logger.warn "CRUD file not found: #{config.crud_file_path}"
+            return false
+          end
+
+          @workbook = RubyXL::Parser.parse(config.crud_file_path)
+          @last_loaded_time = File.mtime(config.crud_file_path)
+          sheet = get_crud_sheet
+          headers = sheet[0].cells.map(&:value)
+
+          method_col_index = headers.index(config.method_col)
+          action_col_index = headers.index(config.action_col)
+          table_start_col_index = headers.index(config.table_start_col)
+
+          raise "Method column not found" unless method_col_index
+          raise "Action column not found" unless action_col_index
+          raise "Table start column not found" unless table_start_col_index
+
+          headers[table_start_col_index..].each_with_index do |table_name, index|
+            @crud_cols[table_name] = table_start_col_index + index
+          end
+
+          sheet.each_with_index do |row, index|
+            next if index.zero?
+
+            method = row[method_col_index]&.value.to_s.strip
+            method = Constants::DEFAULT_METHOD if method.empty?
+            action = row[action_col_index]&.value&.split&.first
+            next if action.nil?
+
+            @crud_rows[method] ||= {}
+            @crud_rows[method][action] = index
+          end
+        end
+
+        # CRUDデータが更新された場合に再読み込みする
+        def reload_if_needed
+          config = CrudConfig.instance
+          return unless config.enabled
+
+          return unless @last_loaded_time.nil? || File.mtime(config.crud_file_path) > @last_loaded_time
+          CrudLogger.logger.info "Reloading CRUD data due to file modification. last_loaded_time = #{@last_loaded_time}"
+          load_crud_data
+
+        end
+
+        # CRUDシートを取得する
+        def get_crud_sheet
+          sheet_name = CrudConfig.instance.sheet_name
+          sheet = @workbook[sheet_name]
+          raise "CRUD sheet '#{sheet_name}' not found" if sheet.nil?
+
+          sheet
+        end
+      end
+    end
+  end
+end

data/lib/rails/crud/tools/crud_logger.rb

@@ -0,0 +1,24 @@
+require 'logger'
+require 'singleton'
+
+module Rails
+  module Crud
+    module Tools
+      class CrudLogger
+        include Singleton
+
+        def initialize
+          @logger = Logger.new("log/crud.log")
+        end
+
+        def self.logger
+          instance.logger
+        end
+
+        def logger
+          @logger
+        end
+      end
+    end
+  end
+end

data/lib/rails/crud/tools/crud_notifications.rb

@@ -0,0 +1,77 @@
+require 'active_support/notifications'
+
+# Notification を使用して SQL クエリを監視するためのモジュール
+module Rails
+  module Crud
+    module Tools
+      def self.setup_notifications
+        # 初回呼び出し時に @subscribed を false に設定
+        @subscribed ||= false
+        # 既に通知が登録されている場合は処理を中断
+        return if @subscribed
+
+        config = CrudConfig.instance
+        if config.enabled
+          # SQL クエリを監視する
+          ActiveSupport::Notifications.subscribe(/sql.active_record/) do |name, started, finished, unique_id, data|
+            # INSERT, UPDATE, DELETE, SELECT のみを対象とする
+            if data[:sql] =~ /(INSERT|UPDATE|DELETE|SELECT)/
+              operation = case $1
+                          when "INSERT" then "C"
+                          when "UPDATE" then "U"
+                          when "DELETE" then "D"
+                          when "SELECT" then "R"
+                          else "Unknown"
+                          end
+
+              match_data = data[:sql].match(/(?:INSERT INTO|UPDATE|DELETE FROM|FROM)\s+`?(\w+)`?/i)
+              if match_data
+                # テーブル名を取得して CRUD 操作に追加
+                table_name = match_data[1]
+                key, method = determine_key_and_method
+                next if key.nil? || method.nil?
+
+                CrudOperations.instance.add_operation(method, key, table_name, operation)
+
+                next unless config.sql_logging_enabled
+
+                # SQL ログを出力
+                CrudLogger.logger.info "#{data[:name]} - #{data[:sql]}"
+              else
+                # テーブル名が見つからない場合は警告を出力
+                CrudLogger.logger.warn "Table name not found in SQL: #{data[:sql]}"
+              end
+            end
+          end
+        end
+
+        # 通知の登録が完了した後に @subscribed を true に設定
+        @subscribed = true
+      end
+
+      private
+
+      # キーとメソッドを決定する
+      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
+          CrudLogger.logger.warn "Unknown method and key detected"
+          return nil
+        end
+
+        [key, method]
+      end
+
+    end
+  end
+end

data/lib/rails/crud/tools/crud_operations.rb

@@ -0,0 +1,50 @@
+require_relative 'crud_logger'
+require_relative 'constants'
+
+module Rails
+  module Crud
+    module Tools
+      class CrudOperations
+        include Singleton
+
+        attr_accessor :table_operations, :logs
+
+        def initialize
+          @table_operations = Hash.new do |hash, method|
+            hash[method] = Hash.new do |h, key|
+              h[key] = Hash.new do |hh, table|
+                hh[table] = []
+              end
+            end
+          end
+        end
+
+        def add_operation(method, key, table_name, operation)
+          # @table_operations[method]が存在しない場合は初期化
+          @table_operations[method] ||= {}
+          # @table_operations[method][key]が存在しない場合は初期化
+          @table_operations[method][key] ||= {}
+          # @table_operations[method][key][table_name]が存在しない場合は初期化
+          @table_operations[method][key][table_name] ||= []
+
+          @table_operations[method][key][table_name] << operation unless @table_operations[method][key][table_name].include?(operation)
+        end
+
+        def log_operations(method, key)
+          CrudLogger.logger.info "\nSummary: Method: #{method}, Key: #{key}"
+
+          @table_operations[method][key].each do |table_name, operations|
+            CrudLogger.logger.info "#{table_name} - #{operations.join(', ')}"
+          end
+
+        end
+
+        def table_operations_present?(method, key)
+          return false if @table_operations[method].nil?
+          return false if @table_operations[method][key].nil?
+          !@table_operations[method][key].empty?
+        end
+      end
+    end
+  end
+end

data/lib/rails/crud/tools/crud_operations_logger.rb

@@ -0,0 +1,122 @@
+require_relative 'crud_logger'
+require_relative 'constants'
+
+# ログ出力を行うモジュール
+module Rails
+  module Crud
+    module Tools
+      module OperationsLogger
+
+        # コントローラのCRUD操作をログ出力する
+        def log_crud_operations
+          if CrudConfig.instance.enabled
+            CrudConfig.instance.load_config
+            log_request_details
+            Thread.current[:crud_request] = request
+          end
+
+          yield
+
+          if CrudConfig.instance.enabled
+            key = "#{controller_path}##{action_name}"
+            method = request.request_method
+            if CrudOperations.instance.table_operations_present?(method, key)
+              CrudOperations.instance.log_operations(method, key)
+              log_and_write_operations(method, key)
+            end
+          end
+        ensure
+          Thread.current[:crud_request] = nil
+        end
+
+        # ジョブのCRUD操作をログ出力する
+        def log_crud_operations_for_job
+          if CrudConfig.instance.enabled
+            CrudConfig.instance.load_config
+            log_job_details
+            key = self.class.name
+            Thread.current[:crud_sidekiq_job_class] = key
+          end
+
+          yield
+
+          if CrudConfig.instance.enabled
+            if CrudOperations.instance.table_operations_present?(Constants::DEFAULT_METHOD, key)
+              CrudOperations.instance.log_operations(Constants::DEFAULT_METHOD, key)
+              log_and_write_operations(Constants::DEFAULT_METHOD, key)
+            end
+          end
+        ensure
+          Thread.current[:crud_sidekiq_job_class] = nil
+        end
+
+        private
+
+        # リクエストの詳細をログ出力する
+        def log_request_details
+          method = request.request_method
+          CrudLogger.logger.info "******************** Method: #{method}, Controller: #{controller_path}, Action: #{action_name}, Key: #{controller_path}##{action_name} ********************"
+        end
+
+        # ジョブの詳細をログ出力する
+        def log_job_details
+          job_name = self.class.name
+          CrudLogger.logger.info "******************** Job: #{job_name} ********************"
+        end
+
+        # ExcelファイルにCRUD操作を書き込む
+        def log_and_write_operations(method, key)
+          CrudData.instance.reload_if_needed
+          sheet = CrudData.instance.get_crud_sheet
+
+          # フラグを初期化
+          contents_changed = false
+
+          CrudOperations.instance.table_operations[method][key].each_key do |table_name|
+            row = CrudData.instance.crud_rows[method][key]
+            col = CrudData.instance.crud_cols[table_name]
+
+            # colまたはrowが存在しない場合にログ出力してスキップ
+            unless row && col
+              CrudLogger.logger.warn "Row or Column not found for table: #{table_name}, method: #{method}, key: #{key}, row: #{row}, col: #{col}"
+              next
+            end
+
+            # sheet[row][col]がnilの場合に警告文を出力し、空文字列として処理を進める
+            cell = sheet[row][col]
+            if cell.nil?
+              cell = sheet.add_cell(row, col, "")
+              CrudLogger.logger.warn "Cell not found at row: #{row}, col: #{col} for table: #{table_name}, method: #{method}, key: #{key}. Adding new cell."
+              existing_value = ""
+            else
+              existing_value = cell.value || ""
+            end
+
+            # 新しい値と既存の値を結合し、重複を排除
+            new_value = CrudOperations.instance.table_operations[method][key][table_name].join
+            merged_value = (existing_value.chars + new_value.chars).uniq
+
+            # CRUDの順序に並び替え
+            crud_order = %w[C R U D]
+            sorted_value = merged_value.sort_by { |char| crud_order.index(char) }.join
+
+            # 値が変化した場合のみ change_contents を実行
+            if cell.value != sorted_value
+              cell.change_contents(sorted_value)
+              contents_changed = true
+            end
+          end
+
+          if contents_changed
+            # Excelファイルを書き込む
+            CrudData.instance.workbook.write(CrudConfig.instance.crud_file_path)
+            timestamp = File.mtime(CrudConfig.instance.crud_file_path)
+            CrudLogger.logger.debug "Updated timestamp: #{timestamp}"
+            # タイムスタンプを更新する
+            CrudData.instance.last_loaded_time = timestamp
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails/crud/tools/railtie.rb

@@ -0,0 +1,36 @@
+require 'rails/railtie'
+require_relative 'crud_operations_logger'
+
+module Rails
+  module Crud
+    module Tools
+      class Railtie < ::Rails::Railtie
+        initializer 'rails-crud.add_after_action' do
+          ActiveSupport.on_load(:action_controller) do
+            include Rails::Crud::Tools::OperationsLogger
+
+            # 全てのコントローラにafter_actionフィルタを追加
+            ActionController::Base.class_eval do
+              around_action :log_crud_operations
+            end
+
+            # APIモードの場合はActionController::APIにも追加
+            ActionController::API.class_eval do
+              around_action :log_crud_operations
+            end
+          end
+
+          # ActiveJobにもフィルタを追加
+          ActiveSupport.on_load(:active_job) do
+            include Rails::Crud::Tools::OperationsLogger
+
+            # 全てのジョブにaround_performフィルタを追加
+            ActiveJob::Base.class_eval do
+              around_perform :log_crud_operations_for_job
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails/crud/tools/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Rails
+  module Crud
+    module Tools
+      VERSION = "0.4.0"
+    end
+  end
+end

data/lib/rails/crud/tools.rb

@@ -0,0 +1,34 @@
+require "rubyXL"
+require "rubyXL/convenience_methods/cell"
+require "rubyXL/convenience_methods/color"
+require "rubyXL/convenience_methods/font"
+require "rubyXL/convenience_methods/workbook"
+require "rubyXL/convenience_methods/worksheet"
+require_relative "tools/crud_operations"
+require_relative "tools/crud_config"
+require_relative "tools/crud_notifications"
+require_relative "tools/railtie"
+require_relative "tools/crud_data"
+
+module Rails
+  module Crud
+    module Tools
+      def self.setup()
+        unless File.exist?(".crudconfig")
+          puts "The .crudconfig file is required. Please run `bundle exec crud init`."
+          return
+        end
+
+        unless File.exist?(CrudConfig.instance.crud_file_path)
+          puts "The CRUD file is required. Please run `bundle exec crud gen_crud`."
+          return
+        end
+
+        CrudData.instance.load_crud_data
+        setup_notifications
+      end
+
+      setup
+    end
+  end
+end

data/sig/rails/crud.rbs

@@ -0,0 +1,6 @@
+module Rails
+  module Crud
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: rails-crud-tools
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- yhijikata
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubyXL
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+description: This gem provides CRUD functionality for Rails applications.
+email:
+- yhijikata@systemlancer.com
+executables:
+- console
+- crud
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Dockerfile
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- docker-compose.yml
+- exe/console
+- exe/crud
+- exe/setup
+- lib/rails/crud/tools.rb
+- lib/rails/crud/tools/cli.rb
+- lib/rails/crud/tools/constants.rb
+- lib/rails/crud/tools/crud_config.rb
+- lib/rails/crud/tools/crud_data.rb
+- lib/rails/crud/tools/crud_logger.rb
+- lib/rails/crud/tools/crud_notifications.rb
+- lib/rails/crud/tools/crud_operations.rb
+- lib/rails/crud/tools/crud_operations_logger.rb
+- lib/rails/crud/tools/railtie.rb
+- lib/rails/crud/tools/version.rb
+- sig/rails/crud.rbs
+- tools/crud_macro.xlsm
+homepage: https://github.com/YamabikoLab
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/YamabikoLab
+  source_code_uri: https://github.com/YamabikoLab/rails-crud-tools
+  changelog_uri: https://github.com/YamabikoLab/rails-crud-tools/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A crud diagram is created simply by manipulating the screen.
+test_files: []