better_seeder 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7efa6650656240adf416711cabab9debe997812e5e666472e3391c59ad74ce44
-  data.tar.gz: 504062b646d4800f75dbb20ef7e221fc0da730bf9aa207026795341e9e1c50e3
+  metadata.gz: 1d6d632652800d470d6214fa647d32b9fa48cab4c95ba88c7ff986a22093c33f
+  data.tar.gz: e9b16e216cd24c4f547f29f7f2fa50e690b5f31617145a84631f594186c60c6a
 SHA512:
-  metadata.gz: bc24811f8a5ea605435701ee6ceda23927c1dad77327e054cd9b31756065037ef75a77f6b02bd1c2558f92870746de38366814bea90cd5597aba29a0b85b1e11
-  data.tar.gz: 34c2cfc41ca466c7c4e7e4db290a47fc0ffd92503b2fc65c567c716f7123138e2de4f2ce485f4b1c5dc1e56f40f3b8b205b4d96d51deec3da5d35ffc6bc124c0
+  metadata.gz: 59358b3b0441b582abd6ec8601c97bc62e1e69b536b40e1f8137a3c1ba5b4495d66a862973da908d43ee5326c9aeebeab83cd594c665b42e10e42894380ee5a4
+  data.tar.gz: 3c99f4e4411e64ffb2626bd5016193792afd62122816e241f3f69f4825e8961c562850bd04eaf37e0fec90d03e26799c75a13ac24b4b4b45f168670ddc1b87e1

data/README.md

@@ -1,7 +1,22 @@
+![BetterSeeder Logo](logo.png)
 # BetterSeeder
 
 BetterSeeder is a Rails gem designed to simplify and centralize your application's seeding process. It offers a flexible system to generate dynamic data, validate it using Dry-schema, enforce uniqueness constraints, load data into the database, and export it in various formats (SQL, CSV, JSON). The configuration is managed through a Rails initializer, while model-specific logic is defined in dedicated structure files.
 
+## Statistics
+
+Below are two images displaying key statistics from the seeding process:
+
+- **Initial Generation Statistics:**  
+  This chart represents metrics from the very first generation run.
+
+![Initial Generation Statistics](generate.png)
+
+- **Reload Data Statistics:**  
+  This chart shows the metrics after reloading data (from the SQL file) into the database.
+
+![Reload Data Statistics](reload.png)
+
 ---
 
 ## Features
@@ -24,6 +39,12 @@ BetterSeeder is a Rails gem designed to simplify and centralize your application
 - **Rails Generator**  
   A custom Rails generator scaffolds a structure file template for your models, ensuring a consistent configuration format.
 
+- **Child Record Generation**  
+  Now, BetterSeeder supports generating multiple child records per parent record. In your model’s seed configuration, you can define a `childs` section that specifies the number of child records to generate for each parent, along with attribute arrays to assign distinct values for each child. This allows for a total record count equal to *(parent count) × (childs count)*.
+
+- **Preflight Data**  
+  You can now define a `preflight` method in your structure file. The records returned by this method are inserted first before generating any additional records, ensuring that specific data is loaded as part of the seeding process. The total record count (defined in `seed_config[:count]`) includes these preflight records.
+
 ---
 
 ## Installation
@@ -65,7 +86,7 @@ If these values are set in the initializer, they will be used; otherwise, the ge
 
 To streamline the setup, execute the following command in your Rails console:
 
-```ruby
+```bash
 BetterSeeder.install
 ```
 
@@ -85,12 +106,18 @@ For each model, create a structure file that centralizes the logic for generatin
 
 - **`seed_config`**  
   Returns a hash with model-specific seeding settings:
-  - `file_name`: The output file name (without extension)
-  - `columns: { excluded: [...] }`: Columns to exclude from the generated data
-  - `generate_data`: Boolean flag indicating whether to generate data dynamically (if false, existing records are used)
-  - `count`: The number of records to generate (default: 10)
-  - `load_data`: Boolean flag indicating whether the generated records should be inserted into the database
-  - `parent`: For child models, specifies the parent model(s) used for injecting foreign keys
+    - `file_name`: The output file name (without extension)
+    - `columns: { excluded: [...] }`: Columns to exclude from the generated data
+    - `generate_data`: Boolean flag indicating whether to generate data dynamically (if false, existing records are used)
+    - `count`: The number of parent records to generate (default: 10)
+    - `load_data`: Boolean flag indicating whether the generated records should be inserted into the database
+    - `parent`: For child models, specifies the parent model(s) used for injecting foreign keys
+    - **`childs` (Optional):** A hash to define child record generation:
+        - `count`: The number of child records to generate for each parent.
+        - `attributes`: A hash mapping attribute names to an array of values. Each child record will receive a distinct value from the provided array.
+      
+- **`preflight` (Optional)**  
+  If defined, this method should return an array of records to be inserted before generating dynamic records. These preloaded records count toward the total defined by `count`.
 
 - **`unique_keys` (Optional)**  
   Returns an array of column groups (each group is an array of symbols) that must be unique. For example:
@@ -132,10 +159,20 @@ module MyNamespace
         load_data: true,
         parents: [
           { model: ::MyNamespace::MyModelParent, column: :column_id }
-        ]
+        ],
+        childs: {
+          count: 3,
+          attributes: {
+            some_attribute: ['value1', 'value2', 'value3']
+          }
+        }
       }
     end
 
+    def self.preflight
+      [{ name: 'preloaded record', email: 'preloaded@example.com', created_at: Time.zone.now }]
+    end
+
     def self.unique_keys
       [[:email]]
     end
@@ -155,13 +192,16 @@ When you call `BetterSeeder.magic` with a configuration that contains an array o
 2. **Retrieve Seeding Configurations**  
    Invoke the model's `seed_config` method to obtain its specific settings.
 
-3. **Generate or Retrieve Records**  
+3. **Preflight Data**  
+   If a `preflight` method is defined in the structure file, its returned records will be inserted first. These records count toward the total number of records defined in `seed_config[:count]`.
+
+4. **Generate or Retrieve Records**  
    Use the `structure` method to generate data dynamically (or fetch existing records) and validate them using `seed_schema` if defined. Uniqueness is enforced via `unique_keys`.
 
-4. **Handle Parent/Child Relationships**  
-   Automatically inject foreign keys into child models using records from parent models.
+5. **Handle Parent/Child Relationships**  
+   Automatically inject foreign keys into child models using records from parent models. With the new functionality, if a `childs` configuration is present, the gem generates child records for each parent record. For example, if `count` is set to 200 and `childs[:count]` is set to 2, a total of 400 records will be generated. Each child record receives distinct attribute values from the specified arrays.
 
-5. **Load and Export Data**  
+6. **Load and Export Data**  
    If enabled (`load_data: true`), the generated records are inserted into the database and exported in the specified format (SQL, CSV, or JSON). Export files are saved in the directory specified by `BetterSeeder.configuration.preload_path`.
 
 ### Example Usage
@@ -257,6 +297,6 @@ BetterSeeder provides a modular, configurable, and extensible system for seeding
 
 - **Centralized Configuration:** Manage settings through a simple Rails initializer.
 - **Modular Structure Files:** Define data generation, validation, and configuration logic on a per-model basis.
-- **Seamless Data Handling:** Efficiently generate, validate, load, and export seed data while supporting complex relationships.
+- **Seamless Data Handling:** Efficiently generate, validate, load, and export seed data while supporting complex relationships—now with enhanced child record generation for a more realistic data model.
 
 For further details or to contribute, please refer to the official repository or documentation.

data/lib/better_seeder/farms/farmer.rb

@@ -16,7 +16,6 @@ module BetterSeeder
 
           load structure_file
 
-          # Costruisce il nome della classe di structure: es. "Media::Participant" => "Media::ParticipantStructure"
           structure_class_name = "#{model_name}Structure"
           begin
             structure_class = Object.const_get(structure_class_name)
@@ -27,18 +26,26 @@ module BetterSeeder
           end
 
           seed_config = structure_class.respond_to?(:seed_config) ? structure_class.seed_config : {}
+          total_count = seed_config[:count] || 10
 
           generated_records = []
+
+          # Se il metodo preflight è definito, usalo per ottenere dati predefiniti
+          if structure_class.respond_to?(:preflight)
+            preflight_data = structure_class.preflight
+            generated_records.concat(preflight_data)
+          end
+
+          remaining_count = total_count - generated_records.size
+
           if seed_config.key?(:childs)
-            # Logica per il modello child: il numero totale di record = count * childs_count
-            parent_count = seed_config[:count] || 10
+            # Modalità child: per ogni "record padre", generare childs_count record
             childs_count = seed_config.dig(:childs, :count) || 10
-
-            parent_count.times do |_i|
+            # Calcolo: i record generati saranno i preflight + (remaining_count * childs_count)
+            remaining_count.times do |_i|
               childs_count.times do |child_index|
                 new_record = nil
                 loop do
-                  # Passo l'indice del record figlio per far variare gli attributi definiti in childs[:attributes]
                   new_record = build_record(model_name, structure_class, child_index, child_mode: true)
                   new_record = inject_parent_keys(model_name, new_record, structure_class)
                   break if validate_record(new_record, structure_class) &&
@@ -48,9 +55,8 @@ module BetterSeeder
               end
             end
           else
-            # Logica standard per i modelli parent (o modelli senza childs)
-            count = options[:count] || (seed_config[:count] || 10)
-            count.times do |index|
+            # Modalità standard: genera remaining_count record
+            remaining_count.times do |index|
               new_record = nil
               loop do
                 new_record = build_record(model_name, structure_class, index)

data/lib/better_seeder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BetterSeeder
-  VERSION = '0.2.4'
+  VERSION = '0.2.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_seeder
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - alessio_bussolari
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-03-03 00:00:00.000000000 Z
+date: 2025-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-schema