master_data_tool 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f743857cb2c8d71b0382648bda8a4a528f025bd385fa0d1016ac956fbca87a27
+  data.tar.gz: f47f109a2b5224224706aa9bfc36f9805fb5dab367105b9fa0e211125b50e9e4
+SHA512:
+  metadata.gz: 29e2f8763b3c512723b7fb1f0320e1bdec9e1e7636cad315bb55e275f54dedb2a0c7e10ecb26c97d760cf24c1a865212aed9bda5360928865db2cfad8f03c067
+  data.tar.gz: 19622b43daf9f7be96204024aa9e9ec8b42b02e401aa356af809d60b44bea2519d7944e9eb7e5c468b326821c6b803443351332860a5f5a1db761a98d6086621

data/.rspec

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

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in master_data_tool.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/README.md

@@ -0,0 +1,146 @@
+# MasterDataTool
+
+[![Build Status](https://github.com/taka0125/master_data_tool/workflows/Ruby/badge.svg?branch=main)](https://github.com/taka0125/master_data_tool/actions)
+
+システムが稼働する上で最初から必要なデータ（マスタデータ）を管理するツール
+
+以下の機能を提供する
+
+- CSVからテーブルにデータを入れる
+    - dry-runができる
+    - 新規・更新・変更なし・削除がわかる
+    - CSVのハッシュ値をDBに記録し差分があったテーブルのみ取り込みを実行する
+- 既存DBからCSVとしてデータをダンプする
+
+## 前提条件
+
+- マスタデータの更新は同時並行で実行されない
+- `db/fixtures/#{table_name}.csv` の命名規則
+
+## インストール
+
+```ruby
+gem 'master_data_tool'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install master_data_tool
+
+## Usage
+
+### マスタデータの投入
+
+| option               | default | 内容                                   |
+|----------------------| --- |--------------------------------------|
+| --dry-run            | true | dry-runモードで実行する（データ変更は行わない）          |
+| --verify             | true | データ投入後に全テーブル・全レコードのバリデーションチェックを行う    |
+| --only-import-tables | [] | 指定したテーブルのみデータ投入を行う                   |
+| --only-verify-tables | [] | 指定したテーブルのみ投入後のバリデーションチェックを行う |
+| --skip-no-change     | true | CSVファイルに更新がないテーブルをスキップする             |
+
+```bash
+bundle exec master_data_tool import
+```
+
+は以下のオプションを指定したものと一緒
+
+```bash
+bundle exec thor master_data_tool import \
+  --dry-run=true \
+  --verify=true \
+  --only-import-tables="" \
+  --only-verify-tables="" \
+  --skip-no-change=true
+```
+
+### ダンプ
+
+| option                | default | 内容            |
+|-----------------------|---------|---------------|
+| --ignore-empty-table  | true    | 空のテーブルを無視する   |
+| --ignore-tables       | []      | 指定したテーブルを無視する |
+| --ignore-column-names | []      | 指定したカラムを無視する  |
+| --verbose      | false   | 詳細表示          |
+
+```bash
+bundle exec master_data_tool dump
+```
+
+は以下のオプションを指定したものと一緒
+
+```bash
+bundle exec master_data_tool dump \
+  --ignore-empty-table=true \
+  --ignore-tables="" \
+  --ignore-column-names="" \
+  --verbose=false
+```
+
+## マイグレーション
+
+`master_data_statuses` というテーブルにCSVファイルのハッシュ値を記録し差分更新に利用する
+
+```
+bundle exec rails generate master_data_tool:install
+```
+
+を実行するとマイグレーションファイルが生成される。
+
+ridgepoleの場合は以下のような定義で実行する
+
+```
+create_table 'master_data_statuses', id: :bigint, unsigned: true, force: :cascade, comment: "マスタデータの状態管理用テーブル" do |t|
+  t.string   "name", limit: 255, null: false, comment: 'テーブル名'
+  t.string   "version", limit: 255, null: false, comment: 'ハッシュ値'
+  t.datetime "created_at", null: false, comment: '作成日時'
+  t.datetime "updated_at", null: false, comment: '更新日時'
+end
+
+add_index 'master_data_statuses', ["name"], name: "idx_master_data_statuses_1", unique: true, using: :btree
+add_index 'master_data_statuses', ["name", "version"], name: "idx_master_data_statuses_2", using: :btree
+```
+
+
+## Tips
+### マスタデータ投入でどうなるか？を調べる
+
+```
+RAILS_ENV=development bundle exec master_data_tool import > /tmp/dry-run.txt
+```
+
+- 影響を受けるテーブル
+
+```
+grep 'operation:affected_table' /tmp/dry-run.txt
+```
+
+- 更新されるレコード
+
+```
+grep 'operation:import' /tmp/dry-run.txt | grep 'label:detail' | grep 'status:updated'
+```
+
+- 削除されるレコード
+
+```
+grep 'operation:import' /tmp/dry-run.txt | grep 'label:detail' | grep 'status:deleted'
+```
+
+- 追加されるレコード
+
+```
+grep 'operation:import' /tmp/dry-run.txt | grep 'label:detail' | grep 'status:new'
+```
+
+## TODO
+
+- upsert_allに移行する
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/taka0125/master_data_tool.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "master_data_tool"
+
+# 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/bin/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/exe/master_data_tool

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'thor'
+require 'master_data_tool'
+
+environment_path = "#{Dir.pwd}/config/environment"
+require environment_path
+
+module MasterDataTool
+  class CLI < Thor
+    option :dry_run, default: true, type: :boolean
+    option :verify, default: true, type: :boolean
+    option :only_import_tables, default: [], type: :array
+    option :only_verify_tables, default: [], type: :array
+    option :skip_no_change, default: true, type: :boolean
+    desc 'import', 'import'
+    def import
+      dry_run = options[:dry_run]
+      verify = options[:verify]
+      only_import_tables = options[:only_import_tables]
+      only_verify_tables = options[:only_verify_tables]
+      skip_no_change = options[:skip_no_change]
+
+      executor = MasterDataTool::Import::Executor.new(
+        dry_run: dry_run,
+        verify: verify,
+        only_import_tables: only_import_tables,
+        only_verify_tables: only_verify_tables,
+        skip_no_change: skip_no_change
+      )
+      executor.execute
+    end
+
+    option :ignore_empty_table, default: true, type: :boolean
+    option :ignore_tables, default: [], type: :array
+    option :ignore_column_names, default: [], 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]
+      verbose = options[:verbose]
+
+      executor = MasterDataTool::Dump::Executor.new(
+        ignore_empty_table: ignore_empty_table,
+        ignore_tables: ignore_tables,
+        ignore_column_names: ignore_column_names,
+        verbose: verbose
+      )
+      executor.execute
+    end
+  end
+end
+
+MasterDataTool::CLI.start(ARGV)

data/lib/generators/master_data_tool/install/install_generator.rb

@@ -0,0 +1,39 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module MasterDataTool
+  class InstallGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+
+    source_root File.expand_path("templates", __dir__)
+
+    def self.next_migration_number(dirname)
+      ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    def create_migration_file
+      migration_dir = File.expand_path("db/migrate")
+      template = 'create_master_data_statuses'
+
+      if self.class.migration_exists?(migration_dir, template)
+        ::Kernel.warn "Migration already exists: #{template}"
+      else
+        migration_template(
+          "#{template}.rb.erb",
+          "db/migrate/#{template}.rb",
+          migration_version: migration_version
+        )
+      end
+    end
+
+    private
+
+    def migration_version
+      format(
+        "[%d.%d]",
+        ActiveRecord::VERSION::MAJOR,
+        ActiveRecord::VERSION::MINOR
+      )
+    end
+  end
+end

data/lib/generators/master_data_tool/install/templates/create_master_data_statuses.rb.erb

@@ -0,0 +1,17 @@
+class CreateMasterDataStatuses < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    create_table :master_data_statuses do |t|
+      t.string :name, limit: 255, null: false, comment: 'テーブル名'
+      t.string :version, limit: 255, null: false, comment: 'ハッシュ値'
+      t.datetime :created_at, null: false, comment: '作成日時'
+      t.datetime :updated_at, null: false, comment: '更新日時'
+    end
+
+    add_index :master_data_statuses, %i[name], name: 'idx_master_data_statuses_1', unique: true
+    add_index :master_data_statuses, %i[name version], name: 'idx_master_data_statuses_2'
+  end
+
+  def self.down
+    drop_table :master_data_statuses
+  end
+end

data/lib/master_data_tool/config.rb

@@ -0,0 +1,21 @@
+require 'active_support/configurable'
+
+module MasterDataTool
+  class Config
+    include ActiveSupport::Configurable
+
+    config_accessor :master_data_dir
+    config_accessor :dump_ignore_tables
+    config_accessor :dump_ignore_columns
+    config_accessor :logger
+
+    def self.default_config
+      new.tap do |config|
+        config.master_data_dir = Rails.root.join('db/fixtures')
+        config.dump_ignore_tables = %w[]
+        config.dump_ignore_columns = %w[]
+        config.logger = Rails.logger
+      end
+    end
+  end
+end

data/lib/master_data_tool/dump/executor.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module MasterDataTool
+  module Dump
+    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(ignore_empty_table: true, ignore_tables: [], ignore_column_names: [], verbose: false)
+        @ignore_empty_table = ignore_empty_table
+        @ignore_tables = DEFAULT_IGNORE_TABLES + Array(MasterDataTool.config.dump_ignore_tables) + ignore_tables
+        @ignore_column_names = DEFAULT_IGNORE_COLUMNS + Array(MasterDataTool.config.dump_ignore_columns) + ignore_column_names
+      end
+
+      def execute
+        [].tap do |errors|
+          ApplicationRecord.connection.tables.each do |table|
+            if @ignore_tables.include?(table)
+              print_message "[ignore] #{table}"
+
+              next
+            end
+
+            dump_to_csv(table)
+          rescue => e
+            errors << Error.new(table, e)
+          end
+        end
+      end
+
+      private
+
+      def print_message(message)
+        return unless @verbose
+
+        puts message
+      end
+
+      def dump_to_csv(table)
+        model_klass = Rails.const_get(table.classify)
+        if ignore?(model_klass)
+          print_message "[ignore] #{table}"
+
+          return
+        end
+
+        csv_path = Pathname.new(MasterDataTool.config.master_data_dir).join("#{table}.csv")
+        CSV.open(csv_path, 'w', force_quotes: true) do |csv|
+          headers = model_klass.column_names - @ignore_column_names
+
+          csv << headers
+
+          model_klass.all.find_each do |record|
+            items = []
+            headers.each do |name|
+              items << record[name]
+            end
+
+            csv << items
+          end
+        end
+      end
+
+      def ignore?(model_klass)
+        return false unless @ignore_empty_table
+
+        model_klass.count < 1
+      end
+    end
+  end
+end

data/lib/master_data_tool/dump.rb

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

data/lib/master_data_tool/import/executor.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module MasterDataTool
+  module Import
+    class Executor
+      def initialize(dry_run: true, verify: true, only_import_tables: [], only_verify_tables: [], skip_no_change: true, report_printer: MasterDataTool::Report::DefaultPrinter.new)
+        @dry_run = dry_run
+        @verify = verify
+        @only_import_tables = Array(only_import_tables)
+        @only_verify_tables = Array(only_verify_tables)
+        @skip_no_change = skip_no_change
+        @report_printer = report_printer
+      end
+
+      def execute
+        ApplicationRecord.transaction do
+          master_data_list = build_master_data_list
+
+          import_all!(master_data_list)
+          verify_all!(master_data_list) if @verify
+          save_master_data_statuses!(master_data_list)
+
+          print_affected_tables(master_data_list)
+
+          raise DryRunError if @dry_run
+
+          master_data_list
+        end
+      rescue DryRunError
+        puts "[DryRun] end"
+      end
+
+      private
+
+      def build_master_data_list
+        [].tap do |master_data_list|
+          extract_master_data_csv_paths.each do |path|
+            table_name = MasterDataTool.resolve_table_name(path)
+            load_skip = load_skip_table?(table_name, path)
+
+            model_klass = Rails.const_get(table_name.classify)
+            master_data = MasterData.new(path, model_klass)
+            master_data.load unless load_skip
+
+            master_data_list << master_data
+          end
+        end
+      end
+
+      # 1. 変更があるかどうかのチェックをスキップした
+      # 2. 変更があるかどうかのチェックを実行し、変更がないので処理をスキップした
+      # 3. 変更があるかどうかのチェックを実行し、変更があるので実行した
+      # の3パターンがある
+      def import_all!(master_data_list)
+        master_data_list.each do |master_data|
+          next unless master_data.loaded?
+
+          report = master_data.import!(dry_run: @dry_run)
+          report.print(@report_printer)
+        end
+      end
+
+      def verify_all!(master_data_list)
+        master_data_list.each do |master_data|
+          next if verify_skip_table?(master_data.table_name)
+
+          report = master_data.verify!(dry_run: @dry_run)
+          report.print(@report_printer)
+        end
+      end
+
+      def save_master_data_statuses!(master_data_list)
+        records = []
+        master_data_list.each do |master_data|
+          records << MasterDataTool::MasterDataStatus.build(master_data.csv_path)
+        end
+
+        MasterDataTool::MasterDataStatus.import_records!(records, dry_run: @dry_run)
+      end
+
+      def print_affected_tables(master_data_list)
+        master_data_list.each do |master_data|
+          next unless master_data.loaded?
+          next unless master_data.affected?
+
+          report = master_data.print_affected_table
+          report&.print(@report_printer)
+        end
+      end
+
+      def load_skip_table?(table_name, csv_path)
+        return load_skip_table_when_target_all_table?(table_name) unless @skip_no_change
+
+        load_skip_table_when_target_changed_table?(table_name, csv_path)
+      end
+
+      def load_skip_table_when_target_changed_table?(table_name, csv_path)
+        unless @only_import_tables.empty?
+          return true if @only_import_tables.exclude?(table_name)
+        end
+
+        !MasterDataTool::MasterDataStatus.master_data_will_change?(csv_path)
+      end
+
+      def load_skip_table_when_target_all_table?(table_name)
+        return false if @only_import_tables.empty?
+
+        @only_import_tables.exclude?(table_name)
+      end
+
+      def verify_skip_table?(table_name)
+        return false if @only_verify_tables.empty?
+
+        @only_verify_tables.exclude?(table_name)
+      end
+
+      def extract_master_data_csv_paths
+        pattern = Pathname.new(MasterDataTool.config.master_data_dir).join('*.csv').to_s
+        Pathname.glob(pattern).select(&:file?)
+      end
+    end
+  end
+end

data/lib/master_data_tool/import.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "import/executor"

data/lib/master_data_tool/master_data.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module MasterDataTool
+  module Import
+    class MasterData
+      attr_reader :csv_path, :model_klass, :columns, :new_records, :updated_records, :no_change_records, :deleted_records
+      attr_reader :before_count, :after_count
+
+      def initialize(csv_path, model_klass)
+        @csv_path = csv_path
+        @model_klass = model_klass
+
+        @loaded = false
+
+        @columns = []
+        @new_records = []
+        @updated_records = []
+        @no_change_records = []
+        @deleted_records = []
+      end
+
+      def load
+        csv = CSV.read(@csv_path, headers: true, skip_blanks: true)
+        old_records_by_id = @model_klass.all.index_by(&:id)
+
+        csv_records_by_id = build_records_from_csv(csv, old_records_by_id)
+        deleted_ids = old_records_by_id.keys - csv_records_by_id.keys
+
+        @columns = csv.headers
+
+        csv_records_by_id.each do |_, record|
+          if record.new_record?
+            @new_records << record
+
+            next
+          end
+
+          if record.has_changes_to_save?
+            @updated_records << record
+
+            next
+          end
+
+          @no_change_records << record
+        end
+
+        deleted_ids.each do |id|
+          @deleted_records << old_records_by_id[id]
+        end
+
+        @loaded = true
+      end
+
+      def import_records
+        new_records + updated_records + no_change_records
+      end
+
+      def affected_records
+        new_records + updated_records + deleted_records
+      end
+
+      def new_records
+        raise MasterDataTool::NotLoadedError unless @loaded
+
+        @new_records
+      end
+
+      def updated_records
+        raise MasterDataTool::NotLoadedError unless @loaded
+
+        @updated_records
+      end
+
+      def no_change_records
+        raise MasterDataTool::NotLoadedError unless @loaded
+
+        @no_change_records
+      end
+
+      def deleted_records
+        raise MasterDataTool::NotLoadedError unless @loaded
+
+        @deleted_records
+      end
+
+      def loaded?
+        @loaded
+      end
+
+      def affected?
+        return @affected if instance_variable_defined?(:@affected)
+        @affected = affected_records.any?
+      end
+
+      def before_count
+        @before_count ||= updated_records.count + no_change_records.count + deleted_records.count
+      end
+
+      def after_count
+        @after_count ||= updated_records.count + no_change_records.count + new_records.count
+      end
+
+      def table_name
+        @model_klass.table_name
+      end
+
+      def import!(dry_run: true)
+        raise MasterDataTool::NotLoadedError unless @loaded
+
+        MasterDataTool::Report::ImportReport.new(self).tap do |report|
+          return report if dry_run
+          return report unless affected?
+
+          @model_klass.delete_all
+
+          # マスターデータ間の依存がある場合に投入順制御するのは大変なのでこのタイミングでのバリデーションはしない
+          @model_klass.import(import_records, validate: false, on_duplicate_key_update: @columns, timestamps: true)
+        end
+      end
+
+      def verify!(dry_run: true)
+        MasterDataTool::Report::VerifyReport.new(self).tap do |report|
+          @model_klass.all.find_each do |record|
+            valid = record.valid?
+            report.append(MasterDataTool::Report::VerifyReport.build_verify_record_report(self, record, valid))
+            next if dry_run
+
+            raise MasterDataTool::VerifyFailed.new("[#{table_name}] id = #{record.id} is invalid") unless valid
+          end
+        end
+      end
+
+      def print_affected_table
+        return unless loaded?
+        return unless affected?
+
+        MasterDataTool::Report::PrintAffectedTableReport.new(self)
+      end
+
+      private
+
+      def build_records_from_csv(csv, old_records_by_id)
+        {}.tap do |records|
+          csv.each do |row|
+            id = row['id'].to_i
+            record = old_records_by_id[id] || @model_klass.new(id: id)
+
+            csv.headers.each do |key|
+              record[key.to_s] = row[key]
+            end
+
+            records[id] = record
+          end
+        end
+      end
+    end
+  end
+end

data/lib/master_data_tool/master_data_status.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'activerecord-import'
+
+module MasterDataTool
+  class MasterDataStatus < ::ActiveRecord::Base
+    self.table_name = 'master_data_statuses'
+
+    validates :name,
+              presence: true
+
+    validates :version,
+              presence: true
+
+    class << self
+      def build(csv_path)
+        version = decide_version(csv_path)
+        new(name: MasterDataTool.resolve_table_name(csv_path), version: version)
+      end
+
+      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)
+        end
+      end
+
+      def master_data_will_change?(csv_path)
+        new_version = decide_version(csv_path)
+        !where(name: MasterDataTool.resolve_table_name(csv_path), version: new_version).exists?
+      end
+
+      def decide_version(csv_path)
+        OpenSSL::Digest::SHA256.hexdigest(File.open(csv_path).read)
+      end
+    end
+  end
+end

data/lib/master_data_tool/report/core.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module MasterDataTool
+  module Report
+    module Core
+      def initialize(master_data)
+        @master_data = master_data
+      end
+
+      def print(printer)
+        raise NotImplementedError
+      end
+
+      private
+
+      def convert_to_ltsv(items)
+        items.map { |k, v| "#{k}:#{v}" }.join("\t")
+      end
+    end
+  end
+end

data/lib/master_data_tool/report/default_printer.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module MasterDataTool
+  module Report
+    class DefaultPrinter
+      include Printer
+
+      def print(message)
+        MasterDataTool.config.logger.info message
+        puts message
+      end
+    end
+  end
+end

data/lib/master_data_tool/report/import_report.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module MasterDataTool
+  module Report
+    class ImportReport
+      include Core
+
+      attr_reader :reports
+
+      def initialize(master_data)
+        super(master_data)
+        @reports = {}
+      end
+
+      def print(printer)
+        reports.each do |_, report|
+          if report.is_a?(Array)
+            report.each { |r| printer.print(convert_to_ltsv(r)) }
+          else
+            printer.print(convert_to_ltsv(report))
+          end
+        end
+      end
+
+      def reports
+        @reports ||= count_report.merge(new_records_report, updated_records_report, no_change_records_report, deleted_records_report)
+      end
+
+      private
+
+      def count_report
+        label = :count_report
+        {}.tap do |report|
+          report[label] = []
+          report[label] << {operation: :import, label: :count, table_name: @master_data.table_name, before: @master_data.before_count, after: @master_data.after_count}
+          report[label] << {operation: :import, label: :affected, table_name: @master_data.table_name, affected: @master_data.affected?}
+          report[label] << {operation: :import, label: :new_count, table_name: @master_data.table_name, count: @master_data.new_records.count}
+          report[label] << {operation: :import, label: :updated_count, table_name: @master_data.table_name, count: @master_data.updated_records.count}
+          report[label] << {operation: :import, label: :no_change_count, table_name: @master_data.table_name, count: @master_data.no_change_records.count}
+          report[label] << {operation: :import, label: :deleted_count, table_name: @master_data.table_name, count: @master_data.deleted_records.count}
+        end
+      end
+
+      def new_records_report
+        label = :new_records_report
+        {}.tap do |report|
+          report[label] = []
+          @master_data.new_records.each do |record|
+            report[label] << {operation: :import, label: :detail, table_name: @master_data.table_name, status: :new, id: record.id}
+          end
+        end
+      end
+
+      def updated_records_report
+        label = :updated_records_report
+        {}.tap do |report|
+          report[label] = []
+          @master_data.updated_records.each do |record|
+            report[label] << {operation: :import, label: :detail, table_name: @master_data.table_name, status: :updated, id: record.id, detail: record.changes_to_save}
+          end
+        end
+      end
+
+      def no_change_records_report
+        label = :no_change_records_report
+        {}.tap do |report|
+          report[label] = []
+          @master_data.no_change_records.each do |record|
+            report[label] << {operation: :import, label: :detail, table_name: @master_data.table_name, status: :no_change, id: record.id}
+          end
+        end
+      end
+
+      def deleted_records_report
+        label = :deleted_records_report
+        {}.tap do |report|
+          report[label] = []
+          @master_data.deleted_records.each do |record|
+            report[label] << {operation: :import, label: :detail, table_name: @master_data.table_name, status: :deleted, id: record.id}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/master_data_tool/report/print_affected_table_report.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MasterDataTool
+  module Report
+    class PrintAffectedTableReport
+      include Core
+
+      def initialize(master_data)
+        super(master_data)
+        @reports = []
+      end
+
+      def print(printer)
+        printer.print(convert_to_ltsv({operation: :affected_table, table_name: @master_data.table_name}))
+      end
+    end
+  end
+end

data/lib/master_data_tool/report/printer.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module MasterDataTool
+  module Report
+    module Printer
+      def print(message)
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/master_data_tool/report/verify_report.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MasterDataTool
+  module Report
+    class VerifyReport
+      include Core
+
+      attr_reader :reports
+
+      def initialize(master_data)
+        super(master_data)
+        @reports = []
+      end
+
+      def append(verify_record_report)
+        @reports << verify_record_report
+      end
+
+      def print(printer)
+        @reports.each do |report|
+          printer.print(convert_to_ltsv(report))
+        end
+      end
+
+      class << self
+        def build_verify_record_report(master_data, record, valid)
+          {operation: :verify, table_name: master_data.table_name, valid: valid, id: record.id}
+        end
+      end
+    end
+  end
+end

data/lib/master_data_tool/report.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "report/printer"
+require_relative "report/default_printer"
+require_relative "report/core"
+require_relative "report/import_report"
+require_relative "report/verify_report"
+require_relative "report/print_affected_table_report"

data/lib/master_data_tool/version.rb

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

data/lib/master_data_tool.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'csv'
+require_relative "master_data_tool/version"
+require_relative "master_data_tool/config"
+require_relative "master_data_tool/master_data_status"
+require_relative "master_data_tool/master_data"
+require_relative "master_data_tool/report"
+require_relative "master_data_tool/dump/executor"
+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 << self
+    def config
+      @config ||= Config.default_config
+    end
+
+    def configure
+      yield config
+    end
+
+    def resolve_table_name(csv_path)
+      csv_path.relative_path_from(config.master_data_dir).to_s.delete_suffix('.csv')
+    end
+  end
+end

data/sig/master_data_tool.rbs

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

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: master_data_tool
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takahiro Ooishi
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-02-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.6.2
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: psych
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.7
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-import
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: システムが稼働する上で最初から必要なデータ（マスタデータ）を管理するツールです。
+email:
+- taka0125@gmail.com
+executables:
+- master_data_tool
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/master_data_tool
+- lib/generators/master_data_tool/install/install_generator.rb
+- lib/generators/master_data_tool/install/templates/create_master_data_statuses.rb.erb
+- lib/master_data_tool.rb
+- lib/master_data_tool/config.rb
+- lib/master_data_tool/dump.rb
+- lib/master_data_tool/dump/executor.rb
+- lib/master_data_tool/import.rb
+- lib/master_data_tool/import/executor.rb
+- lib/master_data_tool/master_data.rb
+- lib/master_data_tool/master_data_status.rb
+- lib/master_data_tool/report.rb
+- lib/master_data_tool/report/core.rb
+- lib/master_data_tool/report/default_printer.rb
+- lib/master_data_tool/report/import_report.rb
+- lib/master_data_tool/report/print_affected_table_report.rb
+- lib/master_data_tool/report/printer.rb
+- lib/master_data_tool/report/verify_report.rb
+- lib/master_data_tool/version.rb
+- sig/master_data_tool.rbs
+homepage: https://github.com/taka0125/master_data_tool
+licenses: []
+metadata:
+  homepage_uri: https://github.com/taka0125/master_data_tool
+  source_code_uri: https://github.com/taka0125/master_data_tool
+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.0.3
+signing_key:
+specification_version: 4
+summary: マスタデータの管理ツール
+test_files: []