rails-crud-tools 0.6.18 → 0.6.19

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

@@ -0,0 +1,166 @@
+# frozen_string_literal: true
+
+require "zip"
+require_relative "crud_logger"
+require_relative "constants"
+
+module Rails
+  module Crud
+    module Tools
+      # The OperationsLogger module is responsible for logging CRUD operations in controllers and jobs.
+      # It provides methods to log request and job details, and to write CRUD operations to an Excel file.
+      module OperationsLogger
+        # コントローラのCRUD操作をログ出力する
+        def log_crud_operations
+          config = CrudConfig.instance.config
+          if config.enabled
+            CrudConfig.instance.load_config
+            log_request_details
+            Thread.current[:crud_request] = request
+          end
+
+          yield
+
+          if config.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
+          config = CrudConfig.instance.config
+          if config.enabled
+            CrudConfig.instance.load_config
+            log_job_details
+            key = self.class.name
+            Thread.current[:crud_sidekiq_job_class] = key
+          end
+
+          yield
+
+          if config.enabled && 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
+        ensure
+          Thread.current[:crud_sidekiq_job_class] = nil
+        end
+
+        # xlsxファイルの最終更新者を更新する
+        def set_last_modified_by(file_path, modifier_name)
+          Zip::File.open(file_path) do |zip_file|
+            doc_props = zip_file.find_entry("docProps/core.xml")
+            if doc_props
+              content = doc_props.get_input_stream.read
+              updated_content = if content.include?("<cp:lastModifiedBy>")
+                                  content.sub(
+                                    %r{<cp:lastModifiedBy>.*?</cp:lastModifiedBy>},
+                                    "<cp:lastModifiedBy>#{modifier_name}</cp:lastModifiedBy>"
+                                  )
+                                else
+                                  content.sub(
+                                    %r{</cp:coreProperties>},
+                                    "<cp:lastModifiedBy>#{modifier_name}</cp:lastModifiedBy></cp:coreProperties>"
+                                  )
+                                end
+              zip_file.get_output_stream("docProps/core.xml") { |f| f.write(updated_content) }
+              CrudLogger.logger.info "Set the last modifier to #{modifier_name}."
+            else
+              CrudLogger.logger.warn "docProps/core.xml was not found."
+            end
+          end
+        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.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
+
+          return unless contents_changed
+
+          Thread.new do
+            update_crud_file
+          rescue StandardError => e
+            CrudLogger.logger.error "Failed to update #{CrudConfig.instance.config.crud_file_path}: #{e.message}"
+          end
+        end
+
+        def update_crud_file
+          File.open(CrudConfig.instance.config.crud_file_path, "r+") do |crud_file|
+            crud_file.flock(File::LOCK_EX)
+            begin
+              # Excelファイルを書き込む
+              CrudData.instance.workbook.write(crud_file)
+              set_last_modified_by(crud_file, CrudData.instance.process_id)
+              timestamp = File.mtime(crud_file)
+              # タイムスタンプを更新する
+              CrudData.instance.last_loaded_time = timestamp
+              CrudLogger.logger.info "Updated timestamp: #{timestamp}"
+            ensure
+              crud_file.flock(File::LOCK_UN)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require_relative "crud_operations_logger"
+
+module Rails
+  module Crud
+    module Tools
+      # The Railtie class is responsible for adding custom initialization code to a Rails application.
+      # It includes filters for logging CRUD operations in controllers and jobs.
+      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.6.19"
+    end
+  end
+end

data/lib/rails/crud/tools.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+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
+    # 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.
+    module Tools
+      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 unless ENV["SKIP_CRUD_SETUP"] == "true"
+    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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-crud-tools
 version: !ruby/object:Gem::Version
-  version: 0.6.18
+  version: 0.6.19
 platform: ruby
 authors:
 - yhijikata
@@ -55,17 +55,49 @@ dependencies:
 description: This gem provides CRUD functionality for Rails applications.
 email:
 - yhijikata@systemlancer.com
-executables: []
+executables:
+- console
+- crud
+- setup
 extensions: []
 extra_rdoc_files: []
-files: []
-homepage: https://github.com/YamabikoLab
+files:
+- ".devcontainer/devcontainer.json"
+- ".devcontainer/docker-compose.yml"
+- ".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/rails-crud-tools
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://github.com/YamabikoLab
+  homepage_uri: https://github.com/YamabikoLab/rails-crud-tools
   source_code_uri: https://github.com/YamabikoLab/rails-crud-tools
   changelog_uri: https://github.com/YamabikoLab/rails-crud-tools/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -74,7 +106,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="