master_data_tool 0.13.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8d4c2c62c923b5e23871ac9e4df2f91c535c36cd8c66a6cb3d3a05ca6c7275d
-  data.tar.gz: 39c776e2196f8a080d7caac86eb4a689701f7263b7aa2d856a4061bd8893863f
+  metadata.gz: '09f03f9ca56ad09dd1f511a53248da3ffe917a0e8be0dba68e3bfbb8f61f74bb'
+  data.tar.gz: 56d9f18f92c96ca4cf2f5bac42edc369d861cbf1cb3ba3e39cb6c8b19eccbdc0
 SHA512:
-  metadata.gz: 624bf1b07e720e1d062c607c9dd697d5709bbc28d19f6396510a2426a0e423b56791682d57f72b6323e36a34c3b70e22f1f1e40dfa9d687cb8dc2fd071a39116
-  data.tar.gz: 1bc885ac91429ba21b201ccf7bc275bcba05377004ac0517aec0ec0ceedb3ead0c1bb2324fe29c435a8e06a9e50101e3e7b85636c5b700ec79b4f44528585ae0
+  metadata.gz: 229dc35b454ca6adafddc65125042649172d203a87554fbe161cade5ad6f17c9e645c40108cb37a937cbf1bfa496b06f0ad6406e904e706a7945b4a9ffe9bb2f
+  data.tar.gz: 285b4f485f23c1215b8029af39bac2808a85050506e02cb92e1662ddaf0ccf634f9a8de4b821663f297d78f6e8a74d61a0920af4e2570ebe19200a0d1ec2f121

data/README.md

@@ -35,17 +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 | 結果の出力をやめる                         |
-| --delete-all-ignore-foreign-key | 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を上書きして投入する |
 
 ```bash
 bundle exec master_data_tool import
@@ -68,12 +69,13 @@ bundle exec thor master_data_tool import \
 
 ### ダンプ
 
-| option                | default | 内容            |
-|-----------------------|---------|---------------|
-| --ignore-empty-table  | true    | 空のテーブルを無視する   |
-| --ignore-tables       | []      | 指定したテーブルを無視する |
-| --ignore-column-names | []      | 指定したカラムを無視する  |
-| --verbose      | false   | 詳細表示          |
+| option                | default | 内容              |
+|-----------------------|---------|-----------------|
+| --ignore-empty-table  | true    | 空のテーブルを無視する     |
+| --ignore-tables       | []      | 指定したテーブルを無視する   |
+| --ignore-column-names | []      | 指定したカラムを無視する    |
+| --only-tables | nil     | 指定したテーブルのみダンプする |
+| --verbose      | false   | 詳細表示            |
 
 ```bash
 bundle exec master_data_tool dump
@@ -86,6 +88,7 @@ bundle exec master_data_tool dump \
   --ignore-empty-table=true \
   --ignore-tables="" \
   --ignore-column-names="" \
+  --only-tables="" \
   --verbose=false
 ```
 

data/exe/master_data_tool

@@ -17,6 +17,7 @@ module MasterDataTool
     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
@@ -28,18 +29,21 @@ module MasterDataTool
     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]
 
       executor = MasterDataTool::Dump::Executor.new(
         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

data/lib/master_data_tool/dump/executor.rb

@@ -8,10 +8,11 @@ module MasterDataTool
       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)
+      def initialize(ignore_empty_table: true, ignore_tables: [], ignore_column_names: [], only_tables: [], 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
+        @only_tables = Array(only_tables)
       end
 
       def execute
@@ -23,6 +24,11 @@ module MasterDataTool
               next
             end
 
+            if @only_tables.any? && !@only_tables.include?(table)
+              print_message "[skip] #{table}"
+              next
+            end
+
             dump_to_csv(table)
           rescue => e
             errors << Error.new(table, e)

data/lib/master_data_tool/import/executor.rb

@@ -12,6 +12,7 @@ module MasterDataTool
                      skip_no_change: true,
                      silent: false,
                      delete_all_ignore_foreign_key: false,
+                     override_identifier: nil,
                      report_printer: MasterDataTool::Report::DefaultPrinter.new)
 
         @dry_run = dry_run
@@ -23,6 +24,7 @@ module MasterDataTool
         @skip_no_change = skip_no_change
         @silent = silent
         @delete_all_ignore_foreign_key = delete_all_ignore_foreign_key
+        @override_identifier = override_identifier
         @report_printer = report_printer
         @report_printer.silent = silent
       end
@@ -61,17 +63,16 @@ module MasterDataTool
 
       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)
+          MasterDataTool::Import::MasterDataFileList.new(override_identifier: @override_identifier).build.each do |master_data_file|
+            load_skip = load_skip_table?(master_data_file)
 
-            model_klass = Object.const_get(table_name.classify)
-            master_data = MasterData.new(path, model_klass)
+            model_klass = Object.const_get(master_data_file.table_name.classify)
+            master_data = MasterData.new(master_data_file, model_klass)
             master_data.load unless load_skip
 
             master_data_list << master_data
           end
-        end.sort_by { |m| m.csv_path } # 外部キー制約などがある場合には先に入れておかないといけないデータなどがある。なので、プレフィックスを付けて順序を指定して貰う
+        end.sort_by { |m| m.basename } # 外部キー制約などがある場合には先に入れておかないといけないデータなどがある。なので、プレフィックスを付けて順序を指定して貰う
       end
 
       def import_all!(master_data_list)
@@ -98,7 +99,7 @@ module MasterDataTool
         master_data_list.each do |master_data|
           next unless master_data.loaded?
 
-          records << MasterDataTool::MasterDataStatus.build(master_data.csv_path)
+          records << MasterDataTool::MasterDataStatus.build(master_data.master_data_file)
         end
 
         MasterDataTool::MasterDataStatus.import_records!(records, dry_run: @dry_run)
@@ -114,11 +115,11 @@ module MasterDataTool
         end
       end
 
-      def load_skip_table?(table_name, csv_path)
-        return true if import_skip_table?(table_name)
+      def load_skip_table?(master_data_file)
+        return true if import_skip_table?(master_data_file.table_name)
         return false unless @skip_no_change
 
-        !MasterDataTool::MasterDataStatus.master_data_will_change?(csv_path)
+        !MasterDataTool::MasterDataStatus.master_data_will_change?(master_data_file)
       end
 
       def import_skip_table?(table_name)
@@ -148,6 +149,13 @@ module MasterDataTool
         pattern = Pathname.new(MasterDataTool.config.master_data_dir).join('*.csv').to_s
         Pathname.glob(pattern).select(&:file?)
       end
+
+      def overridden_master_data_csv_paths
+        return [] unless @override_identifier
+
+        pattern = Pathname.new(MasterDataTool.config.master_data_dir).join(@override_identifier).join('*.csv').to_s
+        Pathname.glob(pattern).select(&:file?)
+      end
     end
   end
 end

data/lib/master_data_tool/import/master_data_file_list.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module MasterDataTool
+  module Import
+    class MasterDataFileList
+      Result = Struct.new(:table_name, :path, :override_identifier)
+
+      def initialize(override_identifier: nil)
+        @override_identifier = override_identifier
+      end
+
+      def build
+        files = extract_master_data_csv_paths.presence&.index_by(&:table_name)
+        overridden_files = overridden_master_data_csv_paths.presence&.index_by(&:table_name) || {}
+
+        table_names = (files.keys + overridden_files.keys).uniq
+        table_names.map do |table_name|
+          overridden_files[table_name] || files[table_name]
+        end
+      end
+
+      private
+
+      def extract_master_data_csv_paths
+        pattern = Pathname.new(MasterDataTool.config.master_data_dir).join('*.csv').to_s
+        Pathname.glob(pattern).select(&:file?).map do |path|
+          table_name = MasterDataTool.resolve_table_name(path, nil)
+          MasterDataTool::MasterDataFile.new(table_name, path, nil)
+        end
+      end
+
+      def overridden_master_data_csv_paths
+        return [] if @override_identifier.blank?
+
+        pattern = Pathname.new(MasterDataTool.config.master_data_dir).join(@override_identifier).join('*.csv').to_s
+        Pathname.glob(pattern).select(&:file?).map do |path|
+          table_name = MasterDataTool.resolve_table_name(path, @override_identifier)
+          MasterDataTool::MasterDataFile.new(table_name, path, @override_identifier)
+        end
+      end
+    end
+  end
+end

data/lib/master_data_tool/import.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
+require_relative 'import/master_data_file_list'
 require_relative "import/executor"

data/lib/master_data_tool/master_data.rb

@@ -2,11 +2,12 @@
 
 module MasterDataTool
   class MasterData
-    attr_reader :csv_path, :model_klass, :columns, :new_records, :updated_records, :no_change_records, :deleted_records
+    attr_reader :master_data_file, :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
+    # @param [MasterDataTool::MasterDataFile] master_data_file
+    def initialize(master_data_file, model_klass)
+      @master_data_file = master_data_file
       @model_klass = model_klass
 
       @loaded = false
@@ -18,8 +19,12 @@ module MasterDataTool
       @deleted_records = []
     end
 
+    def basename
+      @master_data_file.basename
+    end
+
     def load
-      csv = CSV.read(@csv_path, headers: true, skip_blanks: true)
+      csv = CSV.read(@master_data_file.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)

data/lib/master_data_tool/master_data_file.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module MasterDataTool
+  class MasterDataFile < Struct.new(:table_name, :path, :override_identifier)
+    def initialize(table_name, path, override_identifier)
+      super(table_name, path, override_identifier)
+      freeze
+    end
+
+    def basename
+      self.path.basename
+    end
+  end
+end

data/lib/master_data_tool/master_data_status.rb

@@ -15,9 +15,9 @@ module MasterDataTool
               presence: true
 
     class << self
-      def build(csv_path)
-        version = decide_version(csv_path)
-        new(name: MasterDataTool.resolve_table_name(csv_path), version: version)
+      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)
       end
 
       def import_records!(records, dry_run: true)
@@ -28,9 +28,10 @@ module MasterDataTool
         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?
+      # @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?
       end
 
       def decide_version(csv_path)

data/lib/master_data_tool/report/default_printer.rb

@@ -6,6 +6,8 @@ module MasterDataTool
       include Printer
 
       def print(message)
+        return if @silent
+
         MasterDataTool.config.logger.info message
         puts message
       end

data/lib/master_data_tool/version.rb

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

data/lib/master_data_tool.rb

@@ -4,6 +4,7 @@ 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_file"
 require_relative "master_data_tool/master_data"
 require_relative "master_data_tool/report"
 require_relative "master_data_tool/dump/executor"
@@ -24,9 +25,11 @@ module MasterDataTool
       yield config
     end
 
-    def resolve_table_name(csv_path)
+    def resolve_table_name(csv_path, override_identifier)
       # 0001_table_nameのように投入順序を制御可能にする
-      csv_path.relative_path_from(config.master_data_dir).to_s.gsub(/^\d+_/, '').delete_suffix('.csv')
+      relative_path = config.master_data_dir
+      relative_path = "#{relative_path}/#{override_identifier}" if override_identifier.present?
+      csv_path.relative_path_from(relative_path).to_s.gsub(/^\d+_/, '').delete_suffix('.csv')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: master_data_tool
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Takahiro Ooishi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-05 00:00:00.000000000 Z
+date: 2022-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -194,7 +194,9 @@ files:
 - lib/master_data_tool/dump/executor.rb
 - lib/master_data_tool/import.rb
 - lib/master_data_tool/import/executor.rb
+- lib/master_data_tool/import/master_data_file_list.rb
 - lib/master_data_tool/master_data.rb
+- lib/master_data_tool/master_data_file.rb
 - lib/master_data_tool/master_data_status.rb
 - lib/master_data_tool/report.rb
 - lib/master_data_tool/report/core.rb
@@ -205,7 +207,6 @@ files:
 - lib/master_data_tool/report/verify_report.rb
 - lib/master_data_tool/version.rb
 - log/test.log
-- master_data_tool.gemspec
 - scripts/setup.sh
 - sig/master_data_tool.rbs
 homepage: https://github.com/taka0125/master_data_tool
@@ -228,7 +229,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: マスタデータの管理ツール

data/master_data_tool.gemspec

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/master_data_tool/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "master_data_tool"
-  spec.version = MasterDataTool::VERSION
-  spec.authors = ["Takahiro Ooishi"]
-  spec.email = ["taka0125@gmail.com"]
-
-  spec.summary = "マスタデータの管理ツール"
-  spec.description = "システムが稼働する上で最初から必要なデータ（マスタデータ）を管理するツールです。"
-  spec.homepage = "https://github.com/taka0125/master_data_tool"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'mysql2'
-  spec.add_development_dependency 'psych', '~> 3.1'
-  spec.add_development_dependency 'appraisal'
-  spec.add_development_dependency 'ridgepole'
-  spec.add_development_dependency 'database_cleaner-active_record'
-  spec.add_development_dependency 'standalone_activerecord_boot_loader'
-
-  spec.add_dependency 'activerecord', '>= 5.1.7'
-  spec.add_dependency 'activesupport'
-  spec.add_dependency 'thor'
-  spec.add_dependency 'activerecord-import'
-end