master_data_tool 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 553fcd688f3ae346cc356961473852142c87f0ee66145b9e1892bfac3e230927
-  data.tar.gz: 64813eea92f8afc4612cdeb19f281c11ecef5537a207a736cd38ef68d57d9adf
+  metadata.gz: 5d77c4691ca7880f5b1ab73c4d0e5d424e743cb2973e88cb2fc45e7d15cf7acf
+  data.tar.gz: a18d5f0ec46051a0c45db4e369270a5387a827cafa6b17760ead426152a1fd3e
 SHA512:
-  metadata.gz: 9b617aed72fbd9bc0a355e81baef951c4f7f3d4cdf3838cf80b7e35533c98ba4fdfc0c01137d6b28e81f4d60798f21c4b81c94f1c53badba689edfe6d9c0c117
-  data.tar.gz: 0d1daa98e982a6bb918d6dc63dde683b8ce65181337a6fb1754a124d7f93d0e6daa7b25e5cfa5f31a16261c8c4624d6544313a72105dff7746d9df69c28277d5
+  metadata.gz: 644b4a2322932c327a75d1cd955458689e4e08151301cbb1f5782a7465a62bfc80ba823774b0d77b2a525ce9cbd68dd28e6a14b354473608c4a7b61ef4cbf9b1
+  data.tar.gz: 91eb8811ca518eb91311c2d4a50dea7bb778edfa7f106e0d6d09e6bc5b866d4e12c6375936aa31f02f918c73979e9b81fa1038531f1ca9281e6a80d246516aa7

data/README.md

@@ -35,18 +35,18 @@ Or install it yourself as:
 
 ### マスタデータの投入
 
-| option               | default | 内容                                                              |
-|----------------------| --- |-----------------------------------------------------------------|
-| --dry-run            | true | dry-runモードで実行する（データ変更は行わない）                                     |
-| --verify             | true | データ投入後に全テーブル・全レコードのバリデーションチェックを行う                               |
-| --only-import-tables | [] | 指定したテーブルのみデータ投入を行う                                              |
-| --except-import-tables | [] | 指定したテーブルのデータ投入を行わない                                             |
-| --only-verify-tables | [] | 指定したテーブルのみ投入後のバリデーションチェックを行う                                    |
-| --except-verify-tables | [] | 指定したテーブルのバリデーションチェックを行わない                                       |
-| --skip-no-change     | true | CSVファイルに更新がないテーブルをスキップする                                        |
-| --silent | false | 結果の出力をやめる                                                       |
+| option                          | default | 内容                                                              |
+|---------------------------------| --- |-----------------------------------------------------------------|
+| --dry-run                       | true | dry-runモードで実行する（データ変更は行わない）                                     |
+| --verify                        | true | データ投入後に全テーブル・全レコードのバリデーションチェックを行う                               |
+| --only-import-tables            | [] | 指定したテーブルのみデータ投入を行う                                              |
+| --except-import-tables          | [] | 指定したテーブルのデータ投入を行わない                                             |
+| --only-verify-tables            | [] | 指定したテーブルのみ投入後のバリデーションチェックを行う                                    |
+| --except-verify-tables          | [] | 指定したテーブルのバリデーションチェックを行わない                                       |
+| --skip-no-change                | true | CSVファイルに更新がないテーブルをスキップする                                        |
+| --silent                        | false | 結果の出力をやめる                                                       |
 | --delete-all-ignore-foreign-key | false | 外部キー制約を無視してレコードを消すかどうか                                          |
-| --override_identifier | nil | fixtures/#{override_identifier} のディレクトリにある内容でfixturesを上書きして投入する |
+| --override-identifier           | nil | fixtures/#{override_identifier} のディレクトリにある内容でfixturesを上書きして投入する |
 
 ```bash
 bundle exec master_data_tool import

data/lib/master_data_tool/import/executor.rb

@@ -27,11 +27,13 @@ module MasterDataTool
         @override_identifier = override_identifier
         @report_printer = report_printer
         @report_printer.silent = silent
+        @master_data_statuses = []
       end
 
       def execute
         ApplicationRecord.transaction do
           print_execute_options
+          load_master_data_statuses
 
           master_data_collection = build_master_data_collection
 
@@ -51,6 +53,8 @@ module MasterDataTool
 
       private
 
+      attr_reader :master_data_statuses
+
       def print_execute_options
         return if @silent
 
@@ -115,7 +119,10 @@ module MasterDataTool
         return true if import_skip_table?(master_data_file.table_name)
         return false unless @skip_no_change
 
-        !MasterDataTool::MasterDataStatus.master_data_will_change?(master_data_file)
+        master_data_status = master_data_statuses.dig(master_data_file.table_name)
+        return false unless master_data_status
+
+        !master_data_status.will_change?(master_data_file)
       end
 
       def import_skip_table?(table_name)
@@ -152,6 +159,10 @@ module MasterDataTool
         pattern = Pathname.new(MasterDataTool.config.master_data_dir).join(@override_identifier).join('*.csv').to_s
         Pathname.glob(pattern).select(&:file?)
       end
+
+      def load_master_data_statuses
+        @master_data_statuses = MasterDataTool::MasterDataStatus.fetch_all
+      end
     end
   end
 end

data/lib/master_data_tool/master_data.rb

@@ -142,9 +142,13 @@ module MasterDataTool
         scoped.find_each do |record|
           valid = record.valid?
           report.append(MasterDataTool::Report::VerifyReport.build_verify_record_report(self, record, valid))
+          next if valid
           next if ignore_fail
 
-          raise MasterDataTool::VerifyFailed.new("[#{table_name}] id = #{record.id} is invalid") unless valid
+          e = MasterDataTool::VerifyFailed.new("[#{table_name}] id = #{record.id} is invalid")
+          e.errors = record.errors
+
+          raise e
         end
       end
     end

data/lib/master_data_tool/master_data_status.rb

@@ -14,7 +14,17 @@ module MasterDataTool
     validates :version,
               presence: true
 
+    def will_change?(master_data_file)
+      raise unless name == master_data_file.table_name
+
+      version != self.class.decide_version(master_data_file.path)
+    end
+
     class << self
+      def fetch_all
+        all.index_by(&:name)
+      end
+
       def build(master_data_file)
         version = decide_version(master_data_file.path)
         new(name: MasterDataTool.resolve_table_name(master_data_file.path, master_data_file.override_identifier), version: version)
@@ -23,15 +33,10 @@ module MasterDataTool
       def import_records!(records, dry_run: true)
         if dry_run
           pp records
-        else
-          import!(records, validate: true, on_duplicate_key_update: %w[name version], timestamps: true)
+          return
         end
-      end
 
-      # @param [MasterDataTool::MasterDataFile] master_data_file
-      def master_data_will_change?(master_data_file)
-        new_version = decide_version(master_data_file.path)
-        !where(name: master_data_file.table_name, version: new_version).exists?
+        import!(records, validate: true, on_duplicate_key_update: %w[name version], timestamps: true)
       end
 
       def decide_version(csv_path)

data/lib/master_data_tool/report/default_printer.rb

@@ -7,6 +7,7 @@ module MasterDataTool
 
       def print(message)
         return if @silent
+        return if message.blank?
 
         MasterDataTool.config.logger.info message
         puts message

data/lib/master_data_tool/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MasterDataTool
-  VERSION = "0.18.0"
+  VERSION = "0.19.0"
 end

data/lib/master_data_tool.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'csv'
+require 'socket'
 require_relative "master_data_tool/version"
 require_relative "master_data_tool/config"
 require_relative "master_data_tool/master_data_status"
@@ -15,9 +16,13 @@ require_relative "master_data_tool/import"
 module MasterDataTool
   class Error < StandardError; end
   class DryRunError < StandardError; end
-  class VerifyFailed < StandardError; end
   class NotLoadedError < StandardError; end
 
+  class VerifyFailed < StandardError
+    attr_accessor :errors
+    delegate :full_messages, to: :errors
+  end
+
   class << self
     def config
       @config ||= Config.new

data/scripts/drop_db.sh

@@ -0,0 +1,11 @@
+#!/bin/bash
+set -ex
+
+CURRENT=$(cd $(dirname $0);pwd)
+
+mysql \
+  -u ${DB_USERNAME} \
+  -h ${DB_HOST} \
+  -p${DB_PASSWORD} \
+  --port ${DB_PORT} \
+  -e "DROP DATABASE ${DB_NAME}"

data/sig/master_data_tool.rbs

@@ -1,4 +1,230 @@
+# TypeProf 0.21.3
+
+# Classes
 module MasterDataTool
   VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  self.@config: Config
+
+  def self.config: -> Config
+  def self.configure: -> untyped
+  def self.resolve_table_name: (Pathname csv_path, String? override_identifier) -> String
+
+  class Config
+    def initialize: -> void
+  end
+
+  class MasterDataStatus
+    def will_change?: (MasterDataFile master_data_file) -> bool
+    def self.fetch_all: -> Hash[String,MasterDataStatus]
+    def self.build: (MasterDataFile master_data_file) -> MasterDataStatus
+    def self.import_records!: (Array[MasterDataStatus] records, dry_run: bool) -> Array[MasterDataStatus]
+    def self.master_data_will_change?: (MasterDataFile master_data_file) -> bool
+    def self.decide_version: (Pathname csv_path) -> String
+  end
+
+  class MasterDataFile
+    attr_reader table_name: String
+    attr_reader path: Pathname
+    attr_reader override_identifier: String?
+    def initialize: (String table_name, Pathname path, String? override_identifier) -> void
+    def self.build: (Pathname path, String? override_identifier) -> MasterDataFile
+    def basename: -> Pathname
+    def ==: (untyped other) -> bool
+    alias eql? ==
+    def hash: -> Integer
+  end
+
+  class MasterDataFileCollection
+    @override_identifier: String?
+    @collection: Array[MasterDataFile]
+
+    def initialize: (override_identifier: String?) -> void
+    def each: ?{ -> Array[MasterDataFile] } -> Enumerator[bot, untyped]
+    def to_a: -> Array[MasterDataFile]
+
+    private
+    def build: -> Array[MasterDataFile]
+    def extract_master_data_csv_paths: -> Array[MasterDataFile]
+    def overridden_master_data_csv_paths: -> Array[MasterDataFile]
+  end
+
+  class MasterData
+    @loaded: bool
+    @affected: bool
+    @preload_associations: Array[untyped]
+    @eager_load_associations: Array[untyped]
+
+    attr_reader master_data_file: MasterDataFile
+    attr_reader model_klass: untyped
+    attr_reader columns: Array[String]
+    attr_reader new_records: Array[untyped]
+    def new_records: -> Array[untyped]
+    attr_reader updated_records: Array[untyped]
+    def updated_records: -> Array[untyped]
+    attr_reader no_change_records: Array[untyped]
+    def no_change_records: -> Array[untyped]
+    attr_reader deleted_records: Array[untyped]
+    def deleted_records: -> Array[untyped]
+    attr_reader before_count: Integer
+    def before_count: -> Integer
+    attr_reader after_count: Integer
+    def after_count: -> Integer
+    def initialize: (MasterDataFile master_data_file, untyped model_klass) -> void
+    def self.build: (MasterDataFile master_data_file, ?load: bool) -> MasterData
+    def basename: -> Pathname
+    def load: -> true
+    def import_records: -> Array[untyped]
+    def affected_records: -> Array[untyped]
+    def loaded?: -> bool
+    def affected?: -> bool?
+    def table_name: -> String
+    def import!: (?dry_run: true, ?delete_all_ignore_foreign_key: false) -> Report::ImportReport
+    def verify!: (?ignore_fail: bool) -> Report::VerifyReport
+    def print_affected_table: -> Report::PrintAffectedTableReport?
+
+    private
+    def preload_associations: -> Array[untyped]
+    def eager_load_associations: -> Array[untyped]
+    def build_records_from_csv: (Array[Array[String?]] csv, Hash[Integer, untyped] old_records_by_id) -> Hash[Integer, untyped]
+    def enable_foreign_key_checks: -> untyped
+    def disable_foreign_key_checks: -> untyped
+  end
+
+  class MasterDataCollection
+    @collection: Array[MasterData]
+
+    def initialize: -> void
+    def append: (MasterData master_data) -> Array[MasterData]
+    def each: ?{ (MasterData) -> (Array[MasterDataStatus | {operation: :verify, table_name: untyped, valid: untyped, id: untyped}]?) } -> (Array[MasterData] | Enumerator[MasterData, untyped] | Enumerator[untyped, untyped])
+    def to_a: -> Array[MasterData]
+  end
+
+  module Report
+    module Printer
+      attr_accessor silent: false
+      def initialize: (?silent: false) -> void
+      def print: (String message) -> nil
+    end
+
+    class DefaultPrinter
+      include Printer
+
+      def print: (String message) -> nil
+    end
+
+    module Core
+      def initialize: (MasterData master_data) -> void
+      def print: (Printer printer) -> untyped
+
+      private
+      def convert_to_ltsv: ({operation: :affected_table | :verify, table_name: untyped, valid: untyped, id: untyped} items) -> String
+    end
+
+    class ImportReport
+      include Core
+      @master_data: MasterData
+
+      attr_reader reports: Array[untyped]
+      def reports: -> Array[untyped]
+      def print: (Printer printer) -> untyped
+
+      private
+      def count_report: -> Hash[Symbol, Array[Hash[Symbol, untyped]]]
+      def new_records_report: -> Hash[Symbol, Array[Hash[Symbol, untyped]]]
+      def updated_records_report: -> Hash[Symbol, Array[Hash[Symbol, untyped]]]
+      def no_change_records_report: -> Hash[Symbol, Array[Hash[Symbol, untyped]]]
+      def deleted_records_report: -> Hash[Symbol, Array[Hash[Symbol, untyped]]]
+    end
+
+    class VerifyReport
+      include Core
+      @master_data: MasterData
+
+      attr_reader reports: Array[{operation: :verify, table_name: untyped, valid: untyped, id: untyped}]
+      def initialize: (MasterData master_data) -> void
+      def append: ({operation: :verify, table_name: untyped, valid: untyped, id: untyped} verify_record_report) -> Array[{operation: :verify, table_name: untyped, valid: untyped, id: untyped}]
+      def print: (Printer printer) -> Array[{operation: :verify, table_name: untyped, valid: untyped, id: untyped}]
+      def self.build_verify_record_report: (MasterData master_data, untyped record, untyped valid) -> {operation: :verify, table_name: untyped, valid: untyped, id: untyped}
+    end
+
+    class PrintAffectedTableReport
+      include Core
+      @master_data: MasterData
+
+      def print: (Printer printer) -> nil
+    end
+  end
+
+  module Dump
+    class Executor
+      DEFAULT_IGNORE_TABLES: [String, String, String]
+      DEFAULT_IGNORE_COLUMNS: [String, String]
+      @ignore_empty_table: bool
+      @ignore_tables: Array[String]
+      @ignore_column_names: Array[String]
+      @only_tables: Array[String]
+      @verbose: bool
+
+      def initialize: (ignore_empty_table: bool, ignore_tables: Array[String], ignore_column_names: Array[String], only_tables: Array[String], verbose: bool) -> void
+      def execute: -> Array[untyped]
+
+      private
+      def print_message: (String message) -> nil
+      def dump_to_csv: (untyped table) -> nil
+      def ignore?: (untyped model_klass) -> false
+
+      class Error < Struct[untyped]
+        attr_accessor table(): untyped
+        attr_accessor exception(): nil
+      end
+    end
+  end
+
+  module Import
+    class Executor
+      @dry_run: bool
+      @verify: bool
+      @only_import_tables: Array[String]
+      @except_import_tables: Array[String]
+      @only_verify_tables: Array[String]
+      @except_verify_tables: Array[String]
+      @skip_no_change: bool
+      @silent: bool
+      @delete_all_ignore_foreign_key: bool
+      @override_identifier: String?
+      @report_printer: Report::DefaultPrinter
+      @master_data_statuses: [MasterDataStatus]
+
+      def initialize: (dry_run: bool, verify: bool, only_import_tables: Array[String], except_import_tables: Array[String], only_verify_tables: Array[String], except_verify_tables: Array[String], skip_no_change: bool, silent: bool, delete_all_ignore_foreign_key: bool, override_identifier: String?, report_printer: Report::Printer) -> void
+      def execute: -> nil
+
+      private
+      def print_execute_options: -> nil
+      def build_master_data_collection: -> MasterDataCollection
+      def import_all!: (MasterDataCollection master_data_collection) -> (Array[MasterData] | Enumerator[MasterData, untyped] | Enumerator[untyped, untyped])
+      def verify_all!: (MasterDataCollection master_data_collection) -> (Array[MasterData] | Enumerator[MasterData, untyped] | Enumerator[untyped, untyped])
+      def save_master_data_statuses!: (MasterDataCollection master_data_collection) -> Array[MasterDataStatus]
+      def print_affected_tables: (MasterDataCollection master_data_collection) -> (Array[MasterData] | Enumerator[MasterData, untyped] | Enumerator[untyped, untyped])
+      def load_skip_table?: (untyped master_data_file) -> bool
+      def import_skip_table?: (untyped table_name) -> bool
+      def verify_skip_table?: (untyped table_name) -> bool
+      def need_skip_table?: (untyped table_name, Array[untyped] only, Array[untyped] except) -> bool
+      def extract_master_data_csv_paths: -> Array[Pathname]
+      def overridden_master_data_csv_paths: -> Array[Pathname]
+      def master_data_statuses: -> untyped
+    end
+  end
+
+  class Error < StandardError
+  end
+
+  class DryRunError < StandardError
+  end
+
+  class NotLoadedError < StandardError
+  end
+
+  class VerifyFailed < StandardError
+    attr_accessor errors: untyped
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: master_data_tool
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Takahiro Ooishi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-29 00:00:00.000000000 Z
+date: 2022-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -209,6 +209,7 @@ files:
 - lib/master_data_tool/version.rb
 - log/test.log
 - master_data_tool.gemspec
+- scripts/drop_db.sh
 - scripts/setup.sh
 - sig/master_data_tool.rbs
 homepage: https://github.com/taka0125/master_data_tool
@@ -231,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: マスタデータの管理ツール