real_data_tests 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40264604e537da8c1f365cd1afce57fef95988d3e51d36e1c7c68c425f0e3e8b
+  data.tar.gz: 57d486a6a25bc26522051aa2ad2a105698e28911679b1bccf6c25e1c4dd11880
+SHA512:
+  metadata.gz: d7784e89db22fd3c522a9c4b60a8cca7c4c8e15bdbc86f3d20b9aa8cce4a58dbe1f1724c0355defbec3ab00f2d26e831a4351e2b5dc6fd15c97a724ed5079c95
+  data.tar.gz: 60ea36eb4824cb15554026431e0fd06d52ca1194417d025be3db9b9f93e093ccce8b50db48baecf4f5388e8458c76028ae687b6513f00bb1cb3c1acfb2b1637b

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-01-11
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at diasks2@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Kevin Dias
+
+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

@@ -0,0 +1,327 @@
+# Real Data Tests
+
+Create realistic test data in your Rails applications by extracting real records and their associations from your PostgreSQL database.
+
+> **Note**: This gem currently only supports PostgreSQL databases. MySQL and other database adapters are not supported.
+
+## Why use Real Data Tests?
+
+Testing with realistic data is crucial for catching edge cases and ensuring your application works with real-world data structures. However, creating complex test fixtures that accurately represent your data relationships can be time-consuming and error-prone.
+
+Real Data Tests solves this by:
+- Automatically analyzing and extracting real records and their associations
+- Creating reusable SQL dumps that can be committed to your repository
+- Making it easy to load realistic test data in your specs
+- Supporting data anonymization for sensitive information
+
+## Requirements
+
+- Rails 5.0 or higher
+- PostgreSQL database
+- `pg_dump` command-line utility installed and accessible
+- Database user needs sufficient permissions to run `pg_dump`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'real_data_tests'
+```
+
+And then execute:
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+```bash
+$ gem install real_data_tests
+```
+
+## Configuration
+
+Create an initializer in your Rails application:
+
+```ruby
+# config/initializers/real_data_tests.rb
+Rails.application.config.after_initialize do
+  RealDataTests.configure do |config|
+    # Directory where SQL dumps will be stored
+    config.dump_path = 'spec/fixtures/real_data_dumps'
+
+    # Global associations (apply to all models)
+    config.include_associations(
+      :user,
+      :organization,
+      :profile
+    )
+
+    # Model-specific associations
+    config.include_associations_for 'Patient', :visit_notes, :treatment_reports
+    config.include_associations_for 'Discipline', :organization, :user
+
+    # Control association loading behavior
+    config.limit_association 'Patient.visit_notes', 10
+    config.prevent_reciprocal 'VisitNoteType.visit_notes'
+
+    # Configure data anonymization
+    config.anonymize 'User', {
+      first_name: -> (_) { Faker::Name.first_name },
+      last_name:  -> (_) { Faker::Name.last_name },
+      email:      -> (user) { Faker::Internet.email(name: "user#{user.id}") }
+    }
+  end
+end
+```
+
+## Usage
+
+### 1. Preparing Test Data
+
+You can create SQL dumps from your development or production database in two ways:
+
+**From Rails console:**
+```ruby
+# Find a record you want to use as test data
+user = User.find(1)
+
+# Create a dump file including the user and all related records
+RealDataTests.create_dump_file(user, name: "active_user_with_posts")
+```
+
+**Or from command line:**
+```bash
+$ bundle exec real_data_tests create_dump User 1 active_user_with_posts
+```
+
+This will:
+1. Find the specified User record
+2. Collect all associated records based on your configuration
+3. Apply any configured anonymization rules
+4. Generate a SQL dump file in your configured dump_path
+
+### 2. Using in Tests
+
+First, include the helper in your test setup:
+
+```ruby
+# spec/rails_helper.rb or spec/spec_helper.rb
+require 'real_data_tests'
+
+RSpec.configure do |config|
+  config.include RealDataTests::RSpecHelper
+end
+```
+
+Then use it in your tests:
+
+```ruby
+RSpec.describe "Blog" do
+  it "displays user's posts correctly" do
+    # Load the previously created dump file
+    load_real_test_data("active_user_with_posts")
+
+    # Your test code here - the database now contains
+    # the user and all their associated records
+    visit user_posts_path(User.first)
+    expect(page).to have_content("My First Post")
+  end
+end
+```
+
+## Association Control
+
+Real Data Tests provides several ways to control how associations are collected and loaded.
+
+### Global Association Filtering
+
+You can control which associations are collected globally using either whitelist or blacklist mode:
+
+```ruby
+# Whitelist Mode - ONLY collect these associations
+config.include_associations(
+  :user,
+  :organization,
+  :profile
+)
+
+# OR Blacklist Mode - collect all EXCEPT these associations
+config.exclude_associations(
+  :very_large_association,
+  :unused_association
+)
+```
+
+### Model-Specific Associations
+
+For more granular control, you can specify which associations should be collected for specific models:
+
+```ruby
+RealDataTests.configure do |config|
+  # Global associations that apply to all models
+  config.include_associations(
+    :organization,
+    :user
+  )
+
+  # Model-specific associations
+  config.include_associations_for 'Patient',
+    :visit_notes,
+    :treatment_reports,
+    :patient_status
+
+  config.include_associations_for 'Discipline',
+    :organization,  # Will collect this even though it's in global associations
+    :credentials,
+    :specialty_types
+end
+```
+
+This is particularly useful when:
+- Different models need different association rules
+- The same association name means different things on different models
+- You want to collect an association from one model but not another
+- You need to maintain a clean separation of concerns in your test data
+
+### Association Loading Control
+
+You can further refine how associations are loaded using limits and reciprocal prevention:
+
+```ruby
+RealDataTests.configure do |config|
+  # Limit the number of records loaded for specific associations
+  config.limit_association 'Patient.visit_notes', 10
+
+  # Prevent loading associations in the reverse direction
+  config.prevent_reciprocal 'VisitNoteType.visit_notes'
+end
+```
+
+### Best Practices for Association Control
+
+1. **Start with Global Rules**: Define global association rules that apply to most models
+2. **Add Model-Specific Rules**: Use `include_associations_for` when you need different rules for specific models
+3. **Control Data Volume**: Use `limit_association` for has_many relationships that could return large numbers of records
+4. **Prevent Cycles**: Use `prevent_reciprocal` to break circular references in your association chain
+5. **Monitor Performance**: Watch the size of your dump files and adjust your association rules as needed
+
+## Association Filtering
+
+Real Data Tests provides two mutually exclusive approaches to control which associations are collected:
+
+### Whitelist Mode
+Use this when you want to ONLY collect specific associations:
+```ruby
+RealDataTests.configure do |config|
+  config.include_associations(
+    :user,
+    :profile,
+    :posts,
+    :comments
+  )
+end
+```
+
+### Blacklist Mode
+Use this when you want to collect all associations EXCEPT specific ones:
+```ruby
+RealDataTests.configure do |config|
+  config.exclude_associations(
+    :large_association,
+    :unused_association
+  )
+end
+```
+
+> **Note**: You must choose either blacklist or whitelist mode, not both. Attempting to use both will raise an error.
+
+## Data Anonymization
+
+Real Data Tests uses lambdas with the Faker gem for flexible data anonymization. Each anonymization rule receives the record as an argument, allowing for dynamic value generation:
+
+```ruby
+RealDataTests.configure do |config|
+  config.anonymize 'User', {
+    # Simple value replacement
+    first_name: -> (_) { Faker::Name.first_name },
+
+    # Dynamic value based on record
+    email: -> (user) { Faker::Internet.email(name: "user#{user.id}") },
+
+    # Custom anonymization logic
+    full_name: -> (user) {
+      "#{Faker::Name.first_name} #{Faker::Name.last_name}"
+    }
+  }
+end
+```
+
+### Common Faker Examples
+
+```ruby
+{
+  name:         -> (_) { Faker::Name.name },
+  username:     -> (_) { Faker::Internet.username },
+  email:        -> (_) { Faker::Internet.email },
+  phone:        -> (_) { Faker::PhoneNumber.phone_number },
+  address:      -> (_) { Faker::Address.street_address },
+  company:      -> (_) { Faker::Company.name },
+  description:  -> (_) { Faker::Lorem.paragraph }
+}
+```
+
+See the [Faker documentation](https://github.com/faker-ruby/faker) for a complete list of available generators.
+
+## Database Cleaner Integration
+
+If you're using DatabaseCleaner with models that have foreign key constraints, you'll need to handle the cleanup order carefully.
+
+### Disable Foreign Key Constraints During Cleanup
+Add this to your DatabaseCleaner configuration:
+
+```ruby
+config.append_after(:suite) do
+  # Disable foreign key constraints
+  ActiveRecord::Base.connection.execute('SET session_replication_role = replica;')
+  begin
+    # Your cleanup code here
+    SKIP_MODELS.each { |model| model.delete_all }
+  ensure
+    # Re-enable foreign key constraints
+    ActiveRecord::Base.connection.execute('SET session_replication_role = DEFAULT;')
+  end
+end
+```
+
+## How It Works
+
+1. **Record Collection**: The gem analyzes your ActiveRecord associations to find all related records.
+2. **Dump Generation**: It creates a PostgreSQL dump file containing only the necessary records.
+3. **Test Loading**: During tests, it loads the dump file into your test database.
+
+## Best Practices
+
+1. **Version Control**: Commit your SQL dumps to version control so all developers have access to the same test data.
+2. **Meaningful Names**: Use descriptive names for your dump files that indicate the scenario they represent.
+3. **Data Privacy**: Always use anonymization for sensitive data before creating dumps.
+4. **Association Control**: Use association filtering to keep dumps focused and maintainable.
+5. **Unique Identifiers**: Use record IDs in anonymized data to maintain uniqueness (e.g., emails).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/diasks2/real_data_tests. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/diasks2/real_data_tests/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Real Data Tests project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/diasks2/real_data_tests/blob/main/CODE_OF_CONDUCT.md).

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/lib/real_data_tests/configuration.rb

@@ -0,0 +1,116 @@
+# lib/real_data_tests/configuration.rb
+module RealDataTests
+  class Configuration
+    attr_accessor :dump_path, :cleanup_models
+    attr_reader :association_filter_mode, :association_filter_list, :anonymization_rules,
+                :model_specific_associations, :association_limits, :prevent_reciprocal_loading
+
+    def initialize
+      @dump_path = 'spec/fixtures/real_data_dumps'
+      @anonymization_rules = {}
+      @association_filter_mode = nil
+      @association_filter_list = []
+      @model_specific_associations = {}
+      @cleanup_models = []
+      @association_limits = {}
+      @prevent_reciprocal_loading = {}
+    end
+
+    def anonymize(model_name, mappings = {})
+      if defined?(::Rails::Engine)
+        unless ::Rails::Engine.subclasses.map(&:name).include?('RealDataTests::Engine')
+          @delayed_anonymizations << [model_name, mappings]
+          return
+        end
+      end
+
+      begin
+        model = model_name.to_s.constantize
+        @anonymization_rules[model_name.to_s] = mappings
+      rescue => e
+        warn "Note: Anonymization for #{model_name} will be configured when Rails is fully initialized."
+      end
+    end
+
+    def process_delayed_anonymizations
+      return unless @delayed_anonymizations
+
+      @delayed_anonymizations.each do |model_name, mappings|
+        anonymize(model_name, mappings)
+      end
+      @delayed_anonymizations = []
+    end
+
+    def exclude_associations(*associations)
+      if @association_filter_mode == :whitelist
+        raise Error, "Cannot set excluded_associations when included_associations is already set"
+      end
+
+      @association_filter_mode = :blacklist
+      @association_filter_list = associations.flatten
+    end
+
+    def include_associations(*associations)
+      if @association_filter_mode == :blacklist
+        raise Error, "Cannot set included_associations when excluded_associations is already set"
+      end
+      @association_filter_mode = :whitelist
+      @association_filter_list = associations.flatten
+    end
+
+    # New method for model-specific association rules
+    def include_associations_for(model, *associations)
+      model_name = model.is_a?(String) ? model : model.name
+      @model_specific_associations[model_name] = associations.flatten
+    end
+
+    def should_process_association?(model, association_name)
+      model_name = model.is_a?(Class) ? model.name : model.class.name
+
+      # Check model-specific rules first
+      if @model_specific_associations.key?(model_name)
+        return @model_specific_associations[model_name].include?(association_name)
+      end
+
+      # Fall back to global rules
+      case @association_filter_mode
+      when :whitelist
+        @association_filter_list.include?(association_name)
+      when :blacklist
+        !@association_filter_list.include?(association_name)
+      else
+        true
+      end
+    end
+
+    def configure_cleanup(*models)
+      @cleanup_models = models.flatten
+    end
+
+    # Configure limits for specific associations
+    # Example: limit_association 'Patient.visit_notes', 10
+    def limit_association(path, limit)
+      @association_limits[path.to_s] = limit
+    end
+
+    # Prevent loading reciprocal associations
+    # Example: prevent_reciprocal 'VisitNoteType.visit_notes'
+    def prevent_reciprocal(path)
+      @prevent_reciprocal_loading[path.to_s] = true
+    end
+
+    # Get limit for a specific association
+    def get_association_limit(record_class, association_name)
+      path = "#{record_class.name}.#{association_name}"
+      @association_limits[path]
+    end
+
+    # Check if reciprocal loading should be prevented
+    def prevent_reciprocal?(record_class, association_name)
+      path = "#{record_class.name}.#{association_name}"
+      @prevent_reciprocal_loading[path]
+    end
+  end
+
+  class Error < StandardError; end
+end

data/lib/real_data_tests/data_anonymizer.rb

@@ -0,0 +1,58 @@
+# lib/real_data_tests/data_anonymizer.rb
+require 'faker'
+
+module RealDataTests
+  class DataAnonymizer
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    def anonymize_records(records)
+      records.map do |record|
+        anonymize_record(record)
+      end
+    end
+
+    def anonymize_record(record)
+      return record unless should_anonymize?(record)
+
+      anonymization_rules = @configuration.anonymization_rules[record.class.name]
+
+      anonymization_rules.each do |attribute, anonymizer|
+        begin
+          new_value = case anonymizer
+                     when String
+                       # Handle legacy string-based Faker calls
+                       process_faker_string(anonymizer)
+                     when Proc, Lambda
+                       # Handle lambda-based anonymizers
+                       anonymizer.call(record)
+                     else
+                       raise Error, "Unsupported anonymizer type: #{anonymizer.class}"
+                     end
+
+          record.send("#{attribute}=", new_value)
+        rescue => e
+          raise Error, "Failed to anonymize #{attribute} using #{anonymizer.inspect}: #{e.message}"
+        end
+      end
+
+      record
+    end
+
+    private
+
+    def should_anonymize?(record)
+      @configuration.anonymization_rules.key?(record.class.name)
+    end
+
+    def process_faker_string(faker_method)
+      # Support legacy string format like "Faker::Name.first_name"
+      faker_class, faker_method = faker_method.split('::')[1..].join('::').split('.')
+      faker_class = Object.const_get("Faker::#{faker_class}")
+      faker_class.send(faker_method)
+    rescue => e
+      raise Error, "Failed to process Faker method '#{faker_method}': #{e.message}"
+    end
+  end
+end

data/lib/real_data_tests/engine.rb

@@ -0,0 +1,17 @@
+require 'rails'
+
+module RealDataTests
+  class Engine < ::Rails::Engine
+    isolate_namespace RealDataTests
+
+    config.before_configuration do
+      RealDataTests.configuration
+    end
+
+    initializer 'real_data_tests.initialize' do |app|
+      if RealDataTests.configuration
+        RealDataTests.configuration.process_delayed_anonymizations
+      end
+    end
+  end
+end