master_data_tool 0.21.1 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3b637e96ac2000aeea49efd8a638384ebe87d750798dfc6e7f87e0d6be5f5d0
-  data.tar.gz: 2845294e3da24330a05b9f25c8d4bbf9fa0b9d17e12277dbb5cfe75be73b0d63
+  metadata.gz: f6232c3b6ae362cffd34640cd73539eb95423952013d5c37d49f23e54407f075
+  data.tar.gz: 96378ffa854e3743e75b977219e5727992c0732455f92e417d4bd428e635c7f9
 SHA512:
-  metadata.gz: 5363243ee6f1a9e3210b97f31e88eaf4add3f2e452348cc79e27987b9d735947e2c2ffec45076dbad7c2a0d38b434d5ee04bb0de6d460a25b123a85ab54a2ced
-  data.tar.gz: 5a665a846fd443010e83a99236436bf0e32c68a65185945eeb919415f7f5c2b3b686c993f329eff2ab6f0445abd41b0a40d58744b0136b029418a21c30ca2423
+  metadata.gz: 5d730d66002a0f74a6f1600077e30a1df4d4481eee665328fb0d2aa151763a0800112cc073165efe9e5c9df6dd50135348416c296d4b5c8d08ae5c7265c5c9cf
+  data.tar.gz: 685e1be7c64b7b61627c08499bd43c5517e8637c203925e9b4f0e8997bdfbc9fe86c3d2d8f6a29500f8bbe754be65be409e3d806a69ba65f53d5940992ca7278

data/exe/master_data_tool

@@ -9,71 +9,9 @@ require environment_path
 
 module MasterDataTool
   class CLI < Thor
-    option :dry_run, default: nil, type: :boolean
-    option :verify, default: nil, type: :boolean
-    option :spec_name, default: '', type: :string
-    option :only_import_tables, default: nil, type: :array
-    option :except_import_tables, default: nil, type: :array
-    option :only_verify_tables, default: nil, type: :array
-    option :except_verify_tables, default: nil, type: :array
-    option :skip_no_change, default: nil, type: :boolean
-    option :silent, default: nil, type: :boolean
-    option :override_identifier, default: nil, type: :string
-    option :delete_all_ignore_foreign_key, default: nil, type: :boolean
-    desc 'import', 'import'
-    def import
-      spec_config = MasterDataTool.config.spec_config(options['spec_name'])
-      new_options = config.default_import_options.with_indifferent_access.merge(options)
-      new_options[:spec_config] = spec_config
-
-      executor = MasterDataTool::Import::Executor.new(**new_options.symbolize_keys)
-      executor.execute
-    end
-
-    option :dry_run, default: nil, type: :boolean
-    option :verify, default: nil, type: :boolean
-    option :skip_no_change, default: nil, type: :boolean
-    desc 'import_all', 'import all'
-    def import_all
-      MasterDataTool.config.spec_configs.each do |spec_config|
-        new_options = spec_config.default_import_options.with_indifferent_access.merge(options)
-        new_options[:spec_config] = spec_config
-
-        executor = MasterDataTool::Import::Executor.new(**new_options.symbolize_keys)
-        executor.execute
-      end
-    end
-
-    option :spec_name, default: nil, type: :string
-    option :ignore_empty_table, default: true, type: :boolean
-    option :ignore_tables, default: [], type: :array
-    option :ignore_column_names, default: [], type: :array
-    option :only_tables, default: nil, type: :array
-    option :verbose, default: false, type: :boolean
-    desc 'dump', 'dump'
-    def dump
-      ignore_empty_table = options[:ignore_empty_table]
-      ignore_tables = options[:ignore_tables]
-      ignore_column_names = options[:ignore_column_names]
-      only_tables = options[:only_tables]
-      verbose = options[:verbose]
-      spec_config = MasterDataTool.config.spec_config(options['spec_name'])
-
-      executor = MasterDataTool::Dump::Executor.new(
-        spec_config: spec_config,
-        ignore_empty_table: ignore_empty_table,
-        ignore_tables: ignore_tables,
-        ignore_column_names: ignore_column_names,
-        only_tables: only_tables,
-        verbose: verbose
-      )
-      errors = executor.execute
-
-      return if errors.empty?
-
-      message = errors.map { |error| "table:#{error.table}\tmessage:#{error.exception.message}" }.join("\n")
-      raise message
-    end
+    include MasterDataTool::Command::Import
+    include MasterDataTool::Command::Verify
+    include MasterDataTool::Command::Dump
   end
 end
 

data/lib/master_data_tool/act_as_master_data.rb

@@ -0,0 +1,13 @@
+require 'active_support/concern'
+
+module MasterDataTool
+  module ActAsMasterData
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def master_data?
+        true
+      end
+    end
+  end
+end

data/lib/master_data_tool/command/dump.rb

@@ -0,0 +1,43 @@
+module MasterDataTool
+  module Command
+    module Dump
+      extend ActiveSupport::Concern
+
+      included do
+        desc 'dump', 'dump'
+
+        option :spec_name, default: nil, type: :string
+
+        option :ignore_empty_table, default: MasterDataTool::Dump::Config::DEFAULT_VALUES[:ignore_empty_table], type: :boolean
+        option :ignore_tables, default: MasterDataTool::Dump::Config::DEFAULT_VALUES[:ignore_tables], type: :array
+        option :ignore_column_names, default: MasterDataTool::Dump::Config::DEFAULT_VALUES[:ignore_column_names], type: :array
+        option :only_tables, default: MasterDataTool::Dump::Config::DEFAULT_VALUES[:only_tables], type: :array
+        option :verbose, default: false, type: :boolean
+
+        def dump
+          spec_config = MasterDataTool.config.spec_config(options[:spec_name])
+          raise "正しいspec_nameを指定して下さい" unless spec_config
+
+          dump_config = spec_config.dump_config || MasterDataTool::Dump::Config.new(
+            ignore_empty_table: options[:ignore_empty_table],
+            ignore_tables: options[:ignore_tables],
+            ignore_column_names: options[:ignore_column_names],
+            only_tables: options[:only_tables]
+          )
+
+          executor = MasterDataTool::Dump::Executor.new(
+            spec_config: spec_config,
+            dump_config: dump_config,
+            verbose: options[:verbose]
+          )
+          errors = executor.execute
+
+          return if errors.empty?
+
+          message = errors.map { |error| "table:#{error.table}\tmessage:#{error.exception.message}" }.join("\n")
+          raise message
+        end
+      end
+    end
+  end
+end

data/lib/master_data_tool/command/import.rb

@@ -0,0 +1,86 @@
+module MasterDataTool
+  module Command
+    module Import
+      extend ActiveSupport::Concern
+
+      included do
+        option :spec_name, default: nil, type: :string
+        option :dry_run, default: true, type: :boolean
+        option :verify, default: true, type: :boolean
+        option :silent, default: false, type: :boolean
+        option :override_identifier, default: nil, type: :string
+
+        # import config
+        option :only_import_tables, default: MasterDataTool::Import::Config::DEFAULT_VALUES[:only_tables], type: :array
+        option :except_import_tables, default: MasterDataTool::Import::Config::DEFAULT_VALUES[:except_tables], type: :array
+        option :skip_no_change, default: MasterDataTool::Import::Config::DEFAULT_VALUES[:skip_no_change], type: :boolean
+        option :ignore_foreign_key_when_delete, default: MasterDataTool::Import::Config::DEFAULT_VALUES[:ignore_foreign_key_when_delete], type: :boolean
+
+        # verify config
+        option :only_verify_tables, default: MasterDataTool::Verify::Config::DEFAULT_VALUES[:only_tables], type: :array
+        option :except_verify_tables, default: MasterDataTool::Verify::Config::DEFAULT_VALUES[:except_tables], type: :array
+        option :preload_belongs_to_associations, default: MasterDataTool::Verify::Config::DEFAULT_VALUES[:preload_belongs_to_associations], type: :boolean
+
+        desc 'import', 'import'
+        def import
+          spec_config = MasterDataTool.config.spec_config(options[:spec_name])
+          raise "正しいspec_nameを指定して下さい" unless spec_config
+
+          build_import_executor(spec_config).execute
+        end
+
+        option :dry_run, default: true, type: :boolean
+        option :verify, default: true, type: :boolean
+        option :silent, default: false, type: :boolean
+        option :override_identifier, default: nil, type: :string
+
+        # import config
+        option :only_import_tables, default: MasterDataTool::Import::Config::DEFAULT_VALUES[:only_tables], type: :array
+        option :except_import_tables, default: MasterDataTool::Import::Config::DEFAULT_VALUES[:except_tables], type: :array
+        option :skip_no_change, default: MasterDataTool::Import::Config::DEFAULT_VALUES[:skip_no_change], type: :boolean
+        option :ignore_foreign_key_when_delete, default: MasterDataTool::Import::Config::DEFAULT_VALUES[:ignore_foreign_key_when_delete], type: :boolean
+
+        # verify config
+        option :only_verify_tables, default: MasterDataTool::Verify::Config::DEFAULT_VALUES[:only_tables], type: :array
+        option :except_verify_tables, default: MasterDataTool::Verify::Config::DEFAULT_VALUES[:except_tables], type: :array
+        option :preload_belongs_to_associations, default: MasterDataTool::Verify::Config::DEFAULT_VALUES[:preload_belongs_to_associations], type: :boolean
+
+        desc 'import_all', 'import all'
+        def import_all
+          MasterDataTool.config.spec_configs.each do |spec_config|
+            build_import_executor(spec_config).execute
+          end
+        end
+
+        private
+
+        def build_import_executor(spec_config)
+          import_config = spec_config.import_config || MasterDataTool::Import::Config.new(
+            only_tables: options[:only_import_tables],
+            except_tables: options[:except_import_tables],
+            skip_no_change: options[:skip_no_change],
+            ignore_foreign_key_when_delete: options[:ignore_foreign_key_when_delete]
+          )
+
+          verify_config = spec_config.verify_config || MasterDataTool::Verify::Config.new(
+            only_tables: options[:only_verify_tables],
+            except_tables: options[:except_verify_tables],
+            preload_belongs_to_associations: options[:preload_belongs_to_associations],
+            preload_associations: {},
+            eager_load_associations: {}
+          )
+
+          MasterDataTool::Import::Executor.new(
+            spec_config: spec_config,
+            import_config: import_config,
+            verify_config: verify_config,
+            dry_run: options[:dry_run],
+            verify: options[:verify],
+            silent: options[:silent],
+            override_identifier: options[:override_identifier]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/master_data_tool/command/verify.rb

@@ -0,0 +1,64 @@
+module MasterDataTool
+  module Command
+    module Verify
+      extend ActiveSupport::Concern
+
+      included do
+        desc 'verify', 'verify'
+
+        option :spec_name, default: nil, type: :string
+        option :verify, default: true, type: :boolean
+        option :silent, default: false, type: :boolean
+        option :override_identifier, default: nil, type: :string
+
+        # verify config
+        option :only_tables, default: MasterDataTool::Verify::Config::DEFAULT_VALUES[:only_tables], type: :array
+        option :except_tables, default: MasterDataTool::Verify::Config::DEFAULT_VALUES[:except_tables], type: :array
+        option :preload_belongs_to_associations, default: MasterDataTool::Verify::Config::DEFAULT_VALUES[:preload_belongs_to_associations], type: :boolean
+
+        def verify
+          spec_config = MasterDataTool.config.spec_config(options[:spec_name])
+          raise "正しいspec_nameを指定して下さい" unless spec_config
+
+          build_verify_executor(spec_config).execute
+        end
+
+        desc 'verify_all', 'verify all'
+
+        option :verify, default: true, type: :boolean
+        option :silent, default: false, type: :boolean
+        option :override_identifier, default: nil, type: :string
+
+        # verify config
+        option :only_tables, default: MasterDataTool::Verify::Config::DEFAULT_VALUES[:only_tables], type: :array
+        option :except_tables, default: MasterDataTool::Verify::Config::DEFAULT_VALUES[:except_tables], type: :array
+        option :preload_belongs_to_associations, default: MasterDataTool::Verify::Config::DEFAULT_VALUES[:preload_belongs_to_associations], type: :boolean
+
+        def verify_all
+          MasterDataTool.config.spec_configs.each do |spec_config|
+            build_verify_executor(spec_config).execute
+          end
+        end
+
+        private
+
+        def build_verify_executor(spec_config)
+          verify_config = spec_config.verify_config || MasterDataTool::Verify::Config.new(
+            only_tables: options[:only_tables],
+            except_tables: options[:except_tables],
+            preload_belongs_to_associations: options[:preload_belongs_to_associations],
+            preload_associations: {},
+            eager_load_associations: {}
+          )
+
+          MasterDataTool::Verify::Executor.new(
+            spec_config: spec_config,
+            verify_config: verify_config,
+            silent: options[:silent],
+            override_identifier: options[:override_identifier]
+          )
+        end
+      end
+    end
+  end
+end

data/lib/master_data_tool/command.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require_relative "command/import"
+require_relative "command/verify"
+require_relative "command/dump"

data/lib/master_data_tool/config.rb

@@ -13,10 +13,10 @@ module MasterDataTool
     end
 
     def spec_config(spec_name)
-      spec_configs.detect { |c| c.spec_name == spec_name }
+      spec_configs.detect { |c| c.spec_name.to_s == spec_name.to_s }
     end
 
-    def csv_dir_for(spec_name, override_identifier = nil)
+    def csv_dir_for(spec_name:, override_identifier: nil)
       path = MasterDataTool.config.master_data_dir
       path = path.join(spec_name.to_s) if spec_name.present?
       path = path.join(override_identifier.to_s) if override_identifier.present?

data/lib/master_data_tool/dump/config.rb

@@ -0,0 +1,42 @@
+module MasterDataTool
+  module Dump
+    class Config
+      DEFAULT_IGNORE_TABLES = %w[ar_internal_metadata schema_migrations master_data_statuses]
+      DEFAULT_IGNORE_COLUMNS = %w[created_at updated_at]
+
+      DEFAULT_VALUES = {
+        ignore_empty_table: true,
+        ignore_tables: [],
+        ignore_column_names: [],
+        only_tables: [],
+      }
+
+      attr_accessor :ignore_empty_table, :ignore_tables, :ignore_column_names, :only_tables
+
+      def initialize(ignore_empty_table:, ignore_tables:, ignore_column_names:, only_tables:)
+        @ignore_empty_table = ignore_empty_table
+        @ignore_tables = DEFAULT_IGNORE_TABLES + ignore_tables
+        @ignore_column_names = DEFAULT_IGNORE_COLUMNS + ignore_column_names
+        @only_tables = only_tables
+      end
+
+      def configure
+        yield self
+      end
+
+      def ignore_tables=(tables)
+        @ignore_tables = (DEFAULT_IGNORE_TABLES + tables).uniq
+      end
+
+      def ignore_column_names=(column_names)
+        @ignore_column_names = (DEFAULT_IGNORE_COLUMNS + column_names).uniq
+      end
+
+      class << self
+        def default_config
+          new(**DEFAULT_VALUES)
+        end
+      end
+    end
+  end
+end

data/lib/master_data_tool/dump/executor.rb

@@ -5,34 +5,28 @@ module MasterDataTool
     class Executor
       Error = Struct.new(:table, :exception)
 
-      DEFAULT_IGNORE_TABLES = %w[ar_internal_metadata schema_migrations master_data_statuses]
-      DEFAULT_IGNORE_COLUMNS = %w[created_at updated_at]
-
-      def initialize(spec_config:, ignore_empty_table: true, ignore_tables: [], ignore_column_names: [], only_tables: [], verbose: false)
+      def initialize(spec_config:, dump_config:, verbose: false)
         @spec_config = spec_config
-        @ignore_empty_table = ignore_empty_table
-        @ignore_tables = DEFAULT_IGNORE_TABLES + Array(spec_config.dump_ignore_tables) + ignore_tables
-        @ignore_column_names = DEFAULT_IGNORE_COLUMNS + Array(spec_config.dump_ignore_columns) + ignore_column_names
-        @only_tables = Array(only_tables)
+        @dump_config = dump_config
         @verbose = verbose
       end
 
       def execute
         [].tap do |errors|
           spec_config.application_record_class.connection.tables.each do |table|
-            if ignore_tables.include?(table)
+            if dump_config.ignore_tables.include?(table)
               print_message "[ignore] #{table}"
 
               next
             end
 
-            if only_tables.any? && !only_tables.include?(table)
+            if dump_config.only_tables.any? && !dump_config.only_tables.include?(table)
               print_message "[skip] #{table}"
               next
             end
 
             dump_to_csv(table)
-          rescue => e
+          rescue StandardError => e
             errors << Error.new(table, e)
           end
         end
@@ -40,7 +34,7 @@ module MasterDataTool
 
       private
 
-      attr_reader :spec_config, :ignore_empty_table, :ignore_tables, :ignore_column_names, :only_tables, :verbose
+      attr_reader :spec_config, :dump_config, :verbose
 
       def print_message(message)
         return unless verbose
@@ -56,11 +50,11 @@ module MasterDataTool
           return
         end
 
-        csv_path = MasterDataTool.config.csv_dir_for(spec_config.spec_name).join("#{table}.csv")
+        csv_path = MasterDataTool.config.csv_dir_for(spec_name: spec_config.spec_name).join("#{table}.csv")
         FileUtils.mkdir_p(csv_path.dirname)
 
         CSV.open(csv_path, 'w', force_quotes: true) do |csv|
-          headers = model_klass.column_names - ignore_column_names
+          headers = model_klass.column_names - dump_config.ignore_column_names
 
           csv << headers
 
@@ -76,7 +70,7 @@ module MasterDataTool
       end
 
       def ignore?(model_klass)
-        return false unless ignore_empty_table
+        return false unless dump_config.ignore_empty_table
 
         model_klass.count < 1
       end

data/lib/master_data_tool/dump.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
+require_relative "dump/config"
 require_relative "dump/executor"

data/lib/master_data_tool/import/config.rb

@@ -0,0 +1,35 @@
+module MasterDataTool
+  module Import
+    class Config
+      DEFAULT_VALUES = {
+        only_tables: [],
+        except_tables: [],
+        skip_no_change: true,
+        ignore_foreign_key_when_delete: true,
+      }
+
+      attr_accessor :only_tables, :except_tables, :skip_no_change, :ignore_foreign_key_when_delete
+
+      def initialize(only_tables:, except_tables:, skip_no_change:, ignore_foreign_key_when_delete:)
+        @only_tables = only_tables
+        @except_tables = except_tables
+        @skip_no_change = skip_no_change
+        @ignore_foreign_key_when_delete = ignore_foreign_key_when_delete
+      end
+
+      def skip_table?(table_name)
+        MasterDataTool.need_skip_table?(table_name, only_tables, except_tables)
+      end
+
+      def configure
+        yield self
+      end
+
+      class << self
+        def default_config
+          new(**DEFAULT_VALUES)
+        end
+      end
+    end
+  end
+end