master_data_tool 0.5.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e86a46f55a42684795554c0bc95b7ae735cb8c05f35a160b53c2499e2117971c
-  data.tar.gz: b76e406b2373ef43ada14c05bab2f7b79a94fd9ac37c959911dfc71470106061
+  metadata.gz: 0c1a8cf7753997cee7c6508d745c9eb9152261ea433dcd0ea436bd9684d2b57c
+  data.tar.gz: ae108bb9da67df2a46e15335cc7930a6568a0e359d599323e24683bc3db761c4
 SHA512:
-  metadata.gz: 5d9c803172e97e3b3e607ce19f770de15ccf8dc42736b557abce41d90ad112c3b8e6a3d67e2a38871b2cd683492ae610f3ddc774bdfda6f0c05ced893ea3fc06
-  data.tar.gz: fe620d8afd70d5950d2f96a84d6db18255fa5ccc2b1fcf0c583e5dad3d52057e48507ecff0aa6e0c94ee026a38e868caf1b30e11bfec48557ca4f0fd94393d63
+  metadata.gz: be594e338ccd11ec1bb9621452c6ff1b0834c253326b74b89fd0f4e7285b3f040f5948f69cde7eae6028581503bf37f26ba8ce0950e7543184b529f44ec51e55
+  data.tar.gz: a3ceed39c0d391fb2ec5774371b54f66e25a7d3dc52fff323fd8235edb6e3d750022909782e482fa347ec950b55b2e75722440f3ce613569e7fd134a4b012069

data/Appraisals

@@ -1,13 +1,13 @@
-appraise 'rails52' do
-  gem 'rails', '~> 5.2'
+appraise 'activerecord52' do
+  gem 'activerecord', '~> 5.2'
 end
 
-appraise 'rails61' do
-  gem 'rails', '~> 6.1'
+appraise 'activerecord61' do
+  gem 'activerecord', '~> 6.1'
 end
 
 if RUBY_VERSION >= '2.7.0'
-  appraise 'rails70' do
-    gem 'rails', '~> 7.0'
+  appraise 'activerecord70' do
+    gem 'activerecord', '~> 7.0'
   end
 end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Takahiro Ooishi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -35,13 +35,16 @@ Or install it yourself as:
 
 ### マスタデータの投入
 
-| option               | default | 内容                                   |
-|----------------------| --- |--------------------------------------|
-| --dry-run            | true | dry-runモードで実行する（データ変更は行わない）          |
-| --verify             | true | データ投入後に全テーブル・全レコードのバリデーションチェックを行う    |
-| --only-import-tables | [] | 指定したテーブルのみデータ投入を行う                   |
-| --only-verify-tables | [] | 指定したテーブルのみ投入後のバリデーションチェックを行う |
-| --skip-no-change     | true | CSVファイルに更新がないテーブルをスキップする             |
+| 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 | 結果の出力をやめる                         |
 
 ```bash
 bundle exec master_data_tool import
@@ -54,8 +57,11 @@ bundle exec thor master_data_tool import \
   --dry-run=true \
   --verify=true \
   --only-import-tables="" \
+  --except-import-tables="" \
   --only-verify-tables="" \
-  --skip-no-change=true
+  --except-verify-tables="" \
+  --skip-no-change=true \
+  --silent=false
 ```
 
 ### ダンプ
@@ -155,24 +161,23 @@ docker-compose up -d
 export DB_HOST=127.0.0.1
 export DB_PORT=`docker port master_data_tool_mysql57 3306 | cut -f 2 -d ':'`
 export DB_USERNAME=root
-export DB_PASSWORD=
+export DB_PASSWORD=f3WpxNreVT2NgQry
+export DB_NAME=master_data_tool_test
 ```
 
 - dockerでMySQLを立ち上げるたびにポートは変わるのでDB_PORTは都度設定する
   - direnvを使っているならば `direnv reload` すればいい
 
 ```
-cd spec/dummy-rails52/
-RAILS_ENV=test bundle exec rake db:create
-RAILS_ENV=test bundle exec rake db:migrate
+./scripts/setup.sh
 ```
 
 ## rspec
 
 ```
-bundle exec appraisal rails52 rspec
-bundle exec appraisal rails61 rspec
-bundle exec appraisal rails70 rspec
+bundle exec appraisal activerecord52 rspec
+bundle exec appraisal activerecord61 rspec
+bundle exec appraisal activerecord70 rspec
 ```
 
 

data/docker-compose.yml

@@ -4,7 +4,7 @@ x-mysql: &mysql
   image: mysql:5.7
   container_name: master_data_tool_mysql57
   environment:
-    MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
+    MYSQL_ROOT_PASSWORD: 'f3WpxNreVT2NgQry'
   platform: linux/x86_64
   ports:
     - 127.0.0.1::3306

data/exe/master_data_tool

@@ -12,22 +12,31 @@ module MasterDataTool
     option :dry_run, default: true, type: :boolean
     option :verify, default: true, type: :boolean
     option :only_import_tables, default: [], type: :array
+    option :except_import_tables, default: [], type: :array
     option :only_verify_tables, default: [], type: :array
+    option :except_verify_tables, default: [], type: :array
     option :skip_no_change, default: true, type: :boolean
+    option :silent, default: false, type: :boolean
     desc 'import', 'import'
     def import
       dry_run = options[:dry_run]
       verify = options[:verify]
       only_import_tables = options[:only_import_tables]
+      except_import_tables = options[:except_import_tables]
       only_verify_tables = options[:only_verify_tables]
+      except_verify_tables = options[:except_verify_tables]
       skip_no_change = options[:skip_no_change]
+      silent = options[:silent]
 
       executor = MasterDataTool::Import::Executor.new(
         dry_run: dry_run,
         verify: verify,
         only_import_tables: only_import_tables,
+        except_import_tables: except_import_tables,
         only_verify_tables: only_verify_tables,
-        skip_no_change: skip_no_change
+        except_verify_tables: except_verify_tables,
+        skip_no_change: skip_no_change,
+        silent: silent
       )
       executor.execute
     end
@@ -50,7 +59,7 @@ module MasterDataTool
         verbose: verbose
       )
       errors = executor.execute
-      
+
       return if errors.empty?
 
       message = errors.map { |error| "table:#{error.table}\tmessage:#{error.exception.message}" }.join("\n")

data/gemfiles/{rails52.gemfile → activerecord52.gemfile}

@@ -4,6 +4,6 @@ source "https://rubygems.org"
 
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
-gem "rails", "~> 5.2"
+gem "activerecord", "~> 5.2"
 
 gemspec path: "../"

data/gemfiles/{rails61.gemfile → activerecord61.gemfile}

@@ -4,6 +4,6 @@ source "https://rubygems.org"
 
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
-gem "rails", "~> 6.1"
+gem "activerecord", "~> 6.1"
 
 gemspec path: "../"

data/gemfiles/{rails70.gemfile → activerecord70.gemfile}

@@ -4,6 +4,6 @@ source "https://rubygems.org"
 
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
-gem "rails", "~> 7.0"
+gem "activerecord", "~> 7.0"
 
 gemspec path: "../"

data/lib/master_data_tool/config.rb

@@ -11,10 +11,10 @@ module MasterDataTool
 
     def self.default_config
       new.tap do |config|
-        config.master_data_dir = Rails.root.join('db/fixtures')
+        config.master_data_dir = nil # Rails.root.join('db/fixtures')
         config.dump_ignore_tables = %w[]
         config.dump_ignore_columns = %w[]
-        config.logger = Rails.logger
+        config.logger = Logger.new(nil)
       end
     end
   end

data/lib/master_data_tool/dump/executor.rb

@@ -39,7 +39,7 @@ module MasterDataTool
       end
 
       def dump_to_csv(table)
-        model_klass = Rails.const_get(table.classify)
+        model_klass = Object.const_get(table.classify)
         if ignore?(model_klass)
           print_message "[ignore] #{table}"
 

data/lib/master_data_tool/import/executor.rb

@@ -3,13 +3,26 @@
 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)
+      def initialize(dry_run: true,
+                     verify: true,
+                     only_import_tables: [],
+                     except_import_tables: [],
+                     only_verify_tables: [],
+                     except_verify_tables: [],
+                     skip_no_change: true,
+                     silent: false,
+                     report_printer: MasterDataTool::Report::DefaultPrinter.new)
+
         @dry_run = dry_run
         @verify = verify
         @only_import_tables = Array(only_import_tables)
+        @except_import_tables = Array(except_import_tables)
         @only_verify_tables = Array(only_verify_tables)
+        @except_verify_tables = Array(except_verify_tables)
         @skip_no_change = skip_no_change
+        @silent = silent
         @report_printer = report_printer
+        @report_printer.silent = silent
       end
 
       def execute
@@ -38,7 +51,7 @@ module MasterDataTool
             table_name = MasterDataTool.resolve_table_name(path)
             load_skip = load_skip_table?(table_name, path)
 
-            model_klass = Rails.const_get(table_name.classify)
+            model_klass = Object.const_get(table_name.classify)
             master_data = MasterData.new(path, model_klass)
             master_data.load unless load_skip
 
@@ -47,13 +60,10 @@ module MasterDataTool
         end
       end
 
-      # 1. 変更があるかどうかのチェックをスキップした
-      # 2. 変更があるかどうかのチェックを実行し、変更がないので処理をスキップした
-      # 3. 変更があるかどうかのチェックを実行し、変更があるので実行した
-      # の3パターンがある
       def import_all!(master_data_list)
         master_data_list.each do |master_data|
           next unless master_data.loaded?
+          next if import_skip_table?(master_data.table_name)
 
           report = master_data.import!(dry_run: @dry_run)
           report.print(@report_printer)
@@ -64,7 +74,7 @@ module MasterDataTool
         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 = master_data.verify!(ignore_fail: @dry_run)
           report.print(@report_printer)
         end
       end
@@ -72,6 +82,8 @@ module MasterDataTool
       def save_master_data_statuses!(master_data_list)
         records = []
         master_data_list.each do |master_data|
+          next unless master_data.loaded?
+
           records << MasterDataTool::MasterDataStatus.build(master_data.csv_path)
         end
 
@@ -89,29 +101,33 @@ module MasterDataTool
       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
+        return true if import_skip_table?(table_name)
+        return false unless @skip_no_change
 
         !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)
+      def import_skip_table?(table_name)
+        need_skip_table?(table_name, @only_import_tables, @except_import_tables)
       end
 
       def verify_skip_table?(table_name)
-        return false if @only_verify_tables.empty?
+        need_skip_table?(table_name, @only_verify_tables, @except_verify_tables)
+      end
+
+      # 1. onlyを指定した時点でそのリストに含まれるものだけになるべき
+      # 2. exceptのリストはどんな状況でも除外されるべき
+      # 3. それ以外はすべて実行する
+      def need_skip_table?(table_name, only, except)
+        only_result = only.presence&.include?(table_name)
+        except_result = except.presence&.include?(table_name)
+
+        # onlyが指定された時点でデフォルトはskipとする
+        default = only_result.nil? ? false : true
+        return true if except_result == true
+        return false if only_result == true
 
-        @only_verify_tables.exclude?(table_name)
+        default
       end
 
       def extract_master_data_csv_paths

data/lib/master_data_tool/master_data.rb

@@ -117,12 +117,12 @@ module MasterDataTool
       end
     end
 
-    def verify!(dry_run: true)
+    def verify!(ignore_fail: false)
       MasterDataTool::Report::VerifyReport.new(self).tap do |report|
-        @model_klass.all.find_each do |record|
+        @model_klass.order(id: :asc).all.find_each do |record|
           valid = record.valid?
           report.append(MasterDataTool::Report::VerifyReport.build_verify_record_report(self, record, valid))
-          next if dry_run
+          next if ignore_fail
 
           raise MasterDataTool::VerifyFailed.new("[#{table_name}] id = #{record.id} is invalid") unless valid
         end

data/lib/master_data_tool/master_data_status.rb

@@ -2,6 +2,7 @@
 
 require 'active_record'
 require 'activerecord-import'
+require 'openssl'
 
 module MasterDataTool
   class MasterDataStatus < ::ActiveRecord::Base

data/lib/master_data_tool/report/print_affected_table_report.rb

@@ -5,11 +5,6 @@ module MasterDataTool
     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

data/lib/master_data_tool/report/printer.rb

@@ -3,7 +3,15 @@
 module MasterDataTool
   module Report
     module Printer
+      attr_accessor :silent
+
+      def initialize(silent: false)
+        @silent = silent
+      end
+
       def print(message)
+        return if @silent
+
         raise NotImplementedError
       end
     end

data/lib/master_data_tool/version.rb

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

data/master_data_tool.gemspec

@@ -0,0 +1,42 @@
+# 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

data/scripts/setup.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+set -ex
+
+CURRENT=$(cd $(dirname $0);pwd)
+
+mysql \
+  -u ${DB_USERNAME} \
+  -h ${DB_HOST} \
+  -p${DB_PASSWORD} \
+  --port ${DB_PORT} \
+  -e "CREATE DATABASE IF NOT EXISTS ${DB_NAME}"
+
+bundle exec ridgepole \
+  -c ${CURRENT}/../spec/dummy/config/database.yml \
+  --apply \
+  -f ${CURRENT}/../spec/dummy/db/Schemafile \
+  -E test

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: master_data_tool
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Takahiro Ooishi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-18 00:00:00.000000000 Z
+date: 2022-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,49 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: ridgepole
+  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: database_cleaner-active_record
+  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: standalone_activerecord_boot_loader
+  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: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.1.7
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: thor
   requirement: !ruby/object:Gem::Requirement
@@ -119,6 +175,7 @@ files:
 - ".rspec"
 - Appraisals
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -126,9 +183,9 @@ files:
 - docker-compose.yml
 - exe/master_data_tool
 - gemfiles/.bundle/config
-- gemfiles/rails52.gemfile
-- gemfiles/rails61.gemfile
-- gemfiles/rails70.gemfile
+- gemfiles/activerecord52.gemfile
+- gemfiles/activerecord61.gemfile
+- gemfiles/activerecord70.gemfile
 - 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
@@ -148,6 +205,8 @@ 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
 licenses: []
@@ -169,7 +228,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: マスタデータの管理ツール