TODO list

[kibitan]

configuration

• [ ] masking.yml generator
• [ ] validate masking.yml ( format / exists )

option

• [ ] --strict (raise error if target column does not exists or isn't used)
• [ ] --replace-null it is current behavior, but default change to not replace null ( add documentation as well)

documentation

• [x] write about use case
• [x] write Changelog #21
• [ ] clarify&write regarding binary format in masking.yml definiation
• [x] write about Feature on top of README -> Design Concept
• [x] dockernize & write execute way in README
• [ ] make tutorial with sample mysql database? MySQL :: Other MySQL Documentation
  • MySQL :: Sakila Sample Database
  • MySQL :: Employees Sample Database

acceptance test

• [x] setup #32
• [x] setup for ci #34
• [ ] setup docker build cache for ci (github action)
  • dependency cache (gem)
    • https://github.blog/changelog/2019-11-04-github-actions-adds-dependency-caching/
    • https://github.com/rails/rails/pull/37612/files
  • docker image cache
    • https://docs.docker.com/docker-hub/builds/

error handling

• [x] not valid sql ( most likely without --complete-insert
• ... etc

refactoring

• [x] make unit test decoupled https://github.com/kibitan/masking/pull/48
• [ ] rename Masking::Config::TargetColumns::Column::Method
• [ ] extract Masking::Config::TargetColumns::TargetColumns.tables ( yaml parser )
• [ ] singletonize Masking::Config::TargetColumns
• [ ] rename Masking::Config::TargetColumns
• [x] refactoring inside of DataMaskProcessor.process #49
• [ ] rename DataMaskProcessor
• [ ] sort fixture with class usecase?
• [ ] Remove git dependency on masking.gemspec

performance tuning

• [ ] try to String Scanner refs: https://www.clear-code.com/blog/2018/12/25.html
• [ ] try to enable JIT? In 2.6
• [x] write benchmark script
• [ ] setup benchmark log? 継続的にベンチマークを取るための GitHub Action をつくった - はやくプログラムになりたい
• [ ] parallel execute shell script? like mysql-parallel/mysqldumpp.sh
• [ ] try with mysqlpump mysqlpump --single-transaction --compress --compress-output=lz4 --default-parallelism=4

setup code static analizer in Codeclimate & rake

• [ ] seattlerb/flog
• [ ] troessner/reek: Code smell detector for Ruby

CI

• [x] fix coverall multiple comment by coverall #12
• [ ] setup http://tachikoma.io/ ? -> low priority

publishing

• [x] publish to RubyGems
  • [x] fullfill .gemspec
  • [x] update README ( remove not published yet description)
  • [x] specify Ruby satisfied version
• [ ] publish to HomeBrew?

setup github

• [ ] https://github.com/kibitan/masking/community