data_taster 0.2.2

data/lib/data_taster/sanitizer.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module DataTaster
+  class Sanitizer
+    # Ensures the given tables are cleaned of
+    # information deemed sensitive
+    def initialize(table_name, custom_selections)
+      @table_name = table_name
+      @custom_selections = custom_selections || {}
+      @include_insert = DataTaster.config.include_insert
+    end
+
+    def clean!
+      return if skippable_table?
+
+      # custom selections should ALWAYS override defaults
+      default_selections.merge(custom_selections).filter_map do |column_name, sanitized_value|
+        sql = DataTaster::Detergent.new(
+          table_name, column_name, sanitized_value
+        ).deliver
+
+        process(sql)
+      end
+    end
+
+  private
+
+    attr_reader :table_name, :custom_selections, :include_insert
+
+    def process(sql)
+      return if sql == DataTaster::SKIP_CODE
+      return sql unless include_insert
+
+      DataTaster.safe_execute(sql)
+    rescue => e
+      e.message << context_warning
+
+      raise e
+    end
+
+    def context_warning
+      <<~WARNING
+
+        *****
+
+        DATA TASTER WARNING: Many columns are sanitized by default for safety. Please check DataTaster documentation for more details.
+
+        *****
+
+      WARNING
+    end
+
+    def skippable_table?
+      DataTaster.confection[table_name].blank? ||
+        DataTaster.confection[table_name] == DataTaster::SKIP_CODE
+    end
+
+    def default_selections
+      table_columns.each_with_object({}) do |table_col, selections|
+        sanitized_value = defaults.select do |default_col|
+          table_col.match(default_col)
+        end&.first&.last
+
+        next unless sanitized_value
+
+        selections[table_col] = sanitized_value
+      end
+    end
+
+    def table_columns
+      @table_columns ||= ActiveRecord::Base
+                         .connection
+                         .schema_cache
+                         .columns(table_name.to_s)
+                         .map(&:name)
+    end
+
+    def defaults # rubocop:disable Metrics/MethodLength
+      {
+        # `encrypted` should be removed if it is not custom-sanitized
+        /encrypted/ => "",
+        /#{exceptions}.*(ssn|passport|license)/ => "111111111",
+        /#{exceptions}.*(dob|birth)/ => Date.current - 29.years,
+        /#{exceptions}.*(note|body)/ => "Redacted for privacy",
+        /#{exceptions}.*(compensation|income)/ => 999_999,
+        /#{exceptions(extra: ['2'])}.*email.*/ => "CONCAT('#{table_name}_', id, '@nitrophrg.com')",
+        /email.*2$/ => "CONCAT('#{table_name}_', id, '_2', '@nitrophrg.com')",
+        /#{exceptions(extra: %w[2 email])}.*address.*/ => "CONCAT(id, ' Disneyland Dr')",
+        /#{exceptions(extra: ['email'])}.*address.*2/ => "Unit M",
+      }.freeze
+    end
+
+    def exceptions(extra: [])
+      default = %w[_id _at type subject ip mac remote count encrypted voice count]
+      all_exceptions = default + extra
+
+      "^(?!.*(?:#{all_exceptions.join('|')}))"
+    end
+  end
+end

data/lib/data_taster/version.rb

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

data/lib/data_taster.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module DataTaster
+  autoload :Collection, "data_taster/collection"
+  autoload :Confection, "data_taster/confection"
+  autoload :Detergent, "data_taster/detergent"
+  autoload :Helper, "data_taster/helper"
+  autoload :Sample, "data_taster/sample"
+  autoload :Sanitizer, "data_taster/sanitizer"
+
+  SKIP_CODE = "skip_processing"
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+  def self.logger
+    @logger ||= Logger.new($stdout)
+  end
+
+  def self.config(**args)
+    @config ||= Config.new(
+      args[:months],
+      Array.wrap(args[:list] || Rails.root.glob("**/data_taster_export_tables.yml")),
+      args[:source_client] || raise(ArgumentError, "DataTaster.config missing source_client"),
+      args[:working_client] || raise(ArgumentError, "DataTaster.config missing working_client"),
+      args[:include_insert] || false
+    )
+  end
+
+  def self.confection
+    @confection ||= DataTaster::Confection.new.assemble
+  end
+
+  def self.sample!
+    DataTaster
+      .config
+      .source_client
+      .query("SHOW tables").collect { |t| t[t.keys.first] }
+      .each do |table_name|
+        DataTaster::Sample.new(table_name).serve!
+      end
+  end
+
+  def self.safe_execute(sql, client = DataTaster.config.working_client)
+    foreign_key_check = client.query("SELECT @@FOREIGN_KEY_CHECKS").first["@@FOREIGN_KEY_CHECKS"]
+
+    begin
+      client.query("SET FOREIGN_KEY_CHECKS=0")
+      client.query(sql)
+    ensure
+      client.query("SET FOREIGN_KEY_CHECKS=#{foreign_key_check};")
+    end
+  end
+
+  Config = Struct.new(:months, :list, :source_client, :working_client, :include_insert)
+end

data/mkdocs.yml

@@ -0,0 +1,7 @@
+site_name: Data Taster
+
+nav:
+  - "Home": "README.md"
+  - "Changelog": "CHANGELOG.md"
+plugins:
+  - techdocs-core

data/sig/data_taster.rbs

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

metadata

@@ -0,0 +1,236 @@
+--- !ruby/object:Gem::Specification
+name: data_taster
+version: !ruby/object:Gem::Version
+  version: 0.2.2
+platform: ruby
+authors:
+- Jill Klang
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: license_finder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 2.5.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 2.5.1.1
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.1
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.1.5
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.34
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.34
+description: Export, sanitize, and import data to help develop better apps.
+email:
+- jillian.emilie@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/dependency_decisions.yml
+- docs/CHANGELOG.md
+- docs/README.md
+- gemfiles/.bundle/config
+- gemfiles/rails_6_0.gemfile
+- gemfiles/rails_6_0.gemfile.lock
+- gemfiles/rails_6_1.gemfile
+- gemfiles/rails_6_1.gemfile.lock
+- gemfiles/rails_7_0.gemfile
+- gemfiles/rails_7_0.gemfile.lock
+- lib/data_taster.rb
+- lib/data_taster/collection.rb
+- lib/data_taster/confection.rb
+- lib/data_taster/detergent.rb
+- lib/data_taster/flavors.rb
+- lib/data_taster/helper.rb
+- lib/data_taster/sample.rb
+- lib/data_taster/sanitizer.rb
+- lib/data_taster/version.rb
+- mkdocs.yml
+- sig/data_taster.rbs
+homepage: https://github.com/powerhome/power-tools
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/powerhome/power-tools
+  source_code_uri: https://github.com/powerhome/power-tools
+  changelog_uri: https://github.com/powerhome/power-tools/blob/main/packages/data_taster/docs/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.4
+signing_key:
+specification_version: 4
+summary: Delicious and sanitized data samples for development and testing.
+test_files: []