rails-crud-tools 0.6.9 → 0.6.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d60769342a2c4f14ca5185dac7446f06fb2ab137c2835f004da3994a97bad2d
-  data.tar.gz: d0f0ba569e37b04b0d5e5692b4ca60c05becc2ab3c91b0da2a315e12ca26f274
+  metadata.gz: f093aa23597638ca343e4b2f5e19ccf2e49399728da2e96eb6dc1103d1281e45
+  data.tar.gz: fc4d4f153eeb5d192822fd359d3d0b104d19689bf2bb59d078955bd4f36c2ad7
 SHA512:
-  metadata.gz: 3cfd62496d6616601689aa943fd6a4face9369249489dbb88d1be2c825b69118e28ac850cd9e91299930153a91b38ff7d9caa1413d1d5592d58ec58a9c8ce141
-  data.tar.gz: fcc34ae205587a64a795e07ad9d5111443a86d4913cfda3823a72358c53c0c0cca7290726b652b2a349990afb5c322402711d99ffaa544795252a448401db4e7
+  metadata.gz: 73d9ba0b4425afc54440ce49a6383e42cfee4888c0c4fcdc25a4e9f696468a56462cc782abaabf02f40268e14cd555948750921a185c1180a44132e7a2fa7c3c
+  data.tar.gz: 63e0033da0b7c56e64f75913f8978bdb7b4496363438efcee6d772db866bd45dbd34698ba47c4b980b0066495f6695c2b0035db6526b6892cc39965d423046f3

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
   Exclude:
     - 'ide/**/*'
     - 'spec/**/*'

data/CHANGELOG.md

@@ -1,8 +1,9 @@
-## [0.6.3] - 2025-01-09
-- refactoring gem dependency
+## [0.6.10] - 2025-01-11 
+- Required ruby version up
+- Change configuration file to yaml format
 
-## [0.6.2] - 2025-01-09
-- bug fix:uninitialized constant RubyXL::Cell
+## [0.6.9] - 2025-01-10
+- refactoring gem dependency
 
 ## [0.6.1] - 2025-01-09
 - Rubocop support 

data/README.md

@@ -37,14 +37,15 @@ $ bundle exec crud init
 ```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
+crud_file:
+  file_name: crud.xlsx # The name of the CRUD Excel file
+  sheet_name: CRUD # The name of the sheet in the CRUD Excel file
+  header_bg_color: 00FFCC # The background color for the header in the CRUD Excel file
+  font_name: Arial # The font name used 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
+table_start_col: your_first_table # Column where the table starts
 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

data/docker-compose.yml

@@ -5,7 +5,7 @@ services:
     container_name: rails-crud-tools
     volumes:
       - .:/root/app
-      - ./ide:/root/app/ide
+      - /root/app/ide
     ports:
       - '5995:5995'
     tty: true

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

@@ -11,14 +11,15 @@ module RailsCrudTools
   # It includes methods to generate CRUD files, generate configuration files, and initialize the application.
   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
+        config = Rails::Crud::Tools::CrudConfig.instance.config
+        font_name = config.crud_file.font_name
 
         # 2. 取得した結果を区切り文字で分割
         routes_lines = routes_output.split("\n").reject(&:empty?)
@@ -42,7 +43,7 @@ module RailsCrudTools
         # 4. `rubyXL`を使って`xlsx`ファイルに書き込み
         workbook = RubyXL::Workbook.new
         sheet = workbook[0]
-        sheet.sheet_name = config.sheet_name
+        sheet.sheet_name = config.crud_file.sheet_name
 
         # ヘッダー行を追加
         headers = %w[Prefix Verb URI Controller#Action crud_count] + table_names
@@ -100,7 +101,7 @@ module RailsCrudTools
 
         # ヘッダーの背景色を設定
         (0..headers.length - 1).each do |col_index|
-          sheet[0][col_index].change_fill(config.header_bg_color)
+          sheet[0][col_index].change_fill(config.crud_file.header_bg_color)
         end
 
         # 列幅を設定
@@ -133,14 +134,15 @@ module RailsCrudTools
         config_content = <<~CONFIG
           enabled: true
           base_dir: doc
-          crud_file: crud.xlsx
-          sheet_name: CRUD
+          crud_file:
+            file_name: crud.xlsx
+            sheet_name: CRUD
+            header_bg_color: 00FFCC
+            font_name: Arial
           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.yml", config_content)

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

@@ -1,49 +1,54 @@
 # frozen_string_literal: true
 
 require "yaml"
+require "singleton"
 
 module Rails
   module Crud
     module Tools
-      # The CrudConfig class is responsible for loading and managing the configuration settings for CRUD operations.
-      # It uses the Singleton pattern to ensure only one instance of the configuration exists.
+      # The CrudConfig class is a singleton class responsible for loading and managing configuration settings from a YAML file (.crudconfig.yml).
+      # It ensures that the configuration is reloaded if the file is updated.
       class CrudConfig
         include Singleton
 
-        attr_reader :enabled, :base_dir, :crud_file, :sheet_name, :method_col, :action_col, :table_start_col, :sql_logging_enabled, :header_bg_color, :font_name, :config_file
+        CONFIG_PATH = File.expand_path(".crudconfig.yml", Dir.pwd)
 
         def initialize
-          @config_file = ".crudconfig.yml"
-          @last_loaded = nil
-          load_config
+          @last_loaded_time = Time.at(0)
+        end
+
+        def self.config_path
+          CONFIG_PATH
+        end
+
+        def config
+          load_config if @config.nil? || config_file_updated?
+          @config
         end
 
         def load_config
-          return unless @last_loaded.nil? || File.mtime(@config_file) > @last_loaded
-          raise "Config file not found: #{@config_file}. Please generate it using `bundle exec crud gen_config`." unless File.exist?(@config_file)
-
-          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)
+          @config = deep_convert_to_struct(YAML.load_file(CONFIG_PATH))
+          @last_loaded_time = File.mtime(CONFIG_PATH)
+        rescue Errno::ENOENT
+          raise "Configuration file not found: #{CONFIG_PATH}"
+        rescue Psych::SyntaxError => e
+          raise "YAML syntax error occurred while parsing #{CONFIG_PATH}: #{e.message}"
         end
 
-        def crud_file_path
-          File.join(@base_dir, @crud_file)
+        private
+
+        def config_file_updated?
+          File.mtime(CONFIG_PATH) > @last_loaded_time
         end
 
-        def crud_log_path
-          File.join(@base_dir, @crud_log)
+        # Recursively convert hash to Struct and add crud_file_path method
+        def deep_convert_to_struct(hash)
+          struct_class = Struct.new(*hash.keys.map(&:to_sym)) do
+            def crud_file_path
+              File.join(base_dir, crud_file.file_name)
+            end
+          end
+          struct_class.new(*hash.values.map { |value| value.is_a?(Hash) ? deep_convert_to_struct(value) : value })
         end
       end
     end

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

@@ -22,7 +22,7 @@ module Rails
         end
 
         def load_crud_data
-          config = CrudConfig.instance
+          config = CrudConfig.instance.config
           return unless config.enabled
 
           unless File.exist?(config.crud_file_path)
@@ -64,7 +64,7 @@ module Rails
 
         # CRUDデータが更新された場合に再読み込みする
         def reload_if_needed
-          config = CrudConfig.instance
+          config = CrudConfig.instance.config
           return unless config.enabled
 
           return unless @last_loaded_time.nil? || File.mtime(config.crud_file_path) > @last_loaded_time
@@ -85,7 +85,7 @@ module Rails
             doc_props = zipfile.find_entry("docProps/core.xml")
             if doc_props
               content = doc_props.get_input_stream.read
-              last_modified_by = content[%r{<cp:lastModifiedBy>(.*?)<\\\\/cp:lastModifiedBy>}, 1]
+              last_modified_by = content[%r{<cp:lastModifiedBy>(.*?)</cp:lastModifiedBy>}, 1]
             else
               CrudLogger.logger.warn "docProps/core.xml が見つかりませんでした。"
             end
@@ -96,7 +96,7 @@ module Rails
 
         # CRUDシートを取得する
         def crud_sheet
-          sheet_name = CrudConfig.instance.sheet_name
+          sheet_name = CrudConfig.instance.config.crud_file.sheet_name
           sheet = @workbook[sheet_name]
           raise "CRUD sheet '#{sheet_name}' not found" if sheet.nil?
 

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

@@ -13,7 +13,7 @@ module Rails
         # 既に通知が登録されている場合は処理を中断
         return if @subscribed
 
-        if CrudConfig.instance.enabled
+        if CrudConfig.instance.config.enabled
           # SQL クエリを監視する
           ActiveSupport::Notifications.subscribe(/sql.active_record/) do |_name, _started, _finished, _unique_id, data|
             process_sql(data)
@@ -40,7 +40,7 @@ module Rails
           handle_general_sql(data)
         end
 
-        return unless CrudConfig.instance.sql_logging_enabled
+        return unless CrudConfig.instance.config.sql_logging_enabled
 
         # SQL ログを出力
         CrudLogger.logger.info "#{data[:name]} - #{data[:sql]}"

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

@@ -12,7 +12,8 @@ module Rails
       module OperationsLogger
         # コントローラのCRUD操作をログ出力する
         def log_crud_operations
-          if CrudConfig.instance.enabled
+          config = CrudConfig.instance.config
+          if config.enabled
             CrudConfig.instance.load_config
             log_request_details
             Thread.current[:crud_request] = request
@@ -20,7 +21,7 @@ module Rails
 
           yield
 
-          if CrudConfig.instance.enabled
+          if config.enabled
             key = "#{controller_path}##{action_name}"
             method = request.request_method
             if CrudOperations.instance.table_operations_present?(method, key)
@@ -34,7 +35,8 @@ module Rails
 
         # ジョブのCRUD操作をログ出力する
         def log_crud_operations_for_job
-          if CrudConfig.instance.enabled
+          config = CrudConfig.instance.config
+          if config.enabled
             CrudConfig.instance.load_config
             log_job_details
             key = self.class.name
@@ -43,7 +45,7 @@ module Rails
 
           yield
 
-          if CrudConfig.instance.enabled && CrudOperations.instance.table_operations_present?(Constants::DEFAULT_METHOD, key)
+          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
@@ -138,12 +140,12 @@ module Rails
           Thread.new do
             update_crud_file
           rescue StandardError => e
-            CrudLogger.logger.error "Failed to update #{CrudConfig.instance.crud_file_path}: #{e.message}"
+            CrudLogger.logger.error "Failed to update #{CrudConfig.instance.config.crud_file_path}: #{e.message}"
           end
         end
 
         def update_crud_file
-          File.open(CrudConfig.instance.crud_file_path, "r+") do |crud_file|
+          File.open(CrudConfig.instance.config.crud_file_path, "r+") do |crud_file|
             crud_file.flock(File::LOCK_EX)
             begin
               # Excelファイルを書き込む

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

@@ -3,7 +3,7 @@
 module Rails
   module Crud
     module Tools
-      VERSION = "0.6.9"
+      VERSION = "0.6.10"
     end
   end
 end

data/lib/rails/crud/tools.rb

@@ -18,12 +18,12 @@ module Rails
     # It includes methods to subscribe to ActiveSupport notifications and handle different types of SQL operations.
     module Tools
       def self.setup
-        unless File.exist?(CrudConfig.instance.config_file)
+        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.crud_file_path)
+        unless File.exist?(CrudConfig.instance.config.crud_file_path)
           puts "The CRUD file is required. Please run `bundle exec crud gen crud`."
           return
         end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-crud-tools
 version: !ruby/object:Gem::Version
-  version: 0.6.9
+  version: 0.6.10
 platform: ruby
 authors:
 - yhijikata
@@ -104,7 +104,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:
   - - ">="