better_seeder 0.2.1 → 0.2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d73544e7817771707d5e7f1421767992e3c3f87d69ff5605268cd1be22cb98c
-  data.tar.gz: 1c6306a91c0f338c57b1cbc60b2d5046cd2e11e7d4774e6d38aa52e50d035a84
+  metadata.gz: 58577f255f87b959dca2b8d422ebf59f8a450ac857b05e5b9b46af1cfcd4fc9e
+  data.tar.gz: 6c4022a220f744d03209ec5ce45c6344f328e2dbe1c46b9a7e6ae9ca323133f1
 SHA512:
-  metadata.gz: c579ee578d90e816e920651a5576f29884f3cbc2b8b5663cba2eee5499e3ca661655592c8ad81d6edc42f7c5aefd054ad3fdeebe714be4d8a0c67c5c8337cdc9
-  data.tar.gz: cd5e076bc6b252d29c8cde4a530d887eddc9bf582236364b42130e74ce5340dd47520ec0d10fa4ec9fd62341ae9d7c94d4a249775ff0261b436eb7109b148bc8
+  metadata.gz: 8f322c8907aa1db395c3a231823080c50d4825f63f1d89d8dfa52784d0e686fa064b6c57cf8c6fafc830fc650741ca8853c7fb6c45fb248ef31b16c0f94de972
+  data.tar.gz: c9d8b6d14f21db93507ac0a5b856dd832f367fe6aab97043cf7dcb6310043b37fd79ca4a6e86a6a2a2b7368c250f0ccebb0e7e797153d06a1e5687efc2a72130

data/README.md

@@ -1,6 +1,6 @@
 # BetterSeeder
 
-**BetterSeeder** is a Rails gem designed to simplify and centralize your application's seeding process. It provides a flexible system to generate dynamic data, validate it using Dry-schema, enforce uniqueness constraints, load it into the database, and export it in various formats (SQL, CSV, JSON). Configuration is centralized via a Rails initializer, while model-specific logic is defined in dedicated structure files.
+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.
 
 ---
 
@@ -10,17 +10,19 @@
   Define custom data generators for each model in dedicated structure files.
 
 - **Validation and Uniqueness**  
-  Validate generated records using Dry-schema and enforce uniqueness constraints (both single and multi-column).
+  Validate generated records using Dry-schema and enforce uniqueness constraints across one or multiple columns.
 
 - **Loading & Exporting**  
-  - Load generated data directly into your database (with support for parent/child relationships).  
-  - Export data as a single SQL INSERT statement, or in CSV or JSON formats.
+  Load generated data directly into your database—supporting parent/child relationships—and export the data as a single SQL INSERT statement, CSV, or JSON file.
 
 - **Centralized Configuration**  
-  Easily customize settings such as `log_language`, `structure_path`, and `preload_path` via a Rails initializer. If no initializer is provided, default values are used.
+  Customize settings such as `log_language`, `structure_path`, and `preload_path` via a Rails initializer. If no initializer is provided, default settings apply.
 
-- **Automatic Initializer Installation**  
-  Use the `BetterSeeder.install` method to automatically create the initializer file in your Rails app.
+- **Initializer Installation**  
+  An install method creates the necessary initializer file in your Rails application to streamline setup.
+
+- **Rails Generator**  
+  A custom Rails generator scaffolds a structure file template for your models, ensuring a consistent configuration format.
 
 ---
 
@@ -42,7 +44,7 @@ bundle install
 
 ## Configuration
 
-BetterSeeder uses a centralized configuration defined in `BetterSeeder.configuration`. You can override the default settings via an initializer. For example, create a file:
+BetterSeeder uses a centralized configuration defined in `BetterSeeder.configuration`. You can override the default settings by creating an initializer. For example, create a file:
 
 ```ruby
 # config/initializers/better_seeder.rb
@@ -55,53 +57,43 @@ BetterSeeder.configure do |config|
 end
 ```
 
-If these values are set in the initializer, they will be used; otherwise, the gem will fall back to its default values.
+If these values are set in the initializer, they will be used; otherwise, the gem will use its default values.
 
 ---
 
-## Install Method
+## Initializer Installation
 
-BetterSeeder provides an `install` method that automatically creates an initializer file. To run the installer, simply execute in your Rails console:
+To streamline the setup, execute the following command in your Rails console:
 
 ```ruby
 BetterSeeder.install
 ```
 
-This command creates (if not already present) the file `config/initializers/better_seeder.rb` with content similar to:
-
-```ruby
-# BetterSeeder initializer
-BetterSeeder.configure do |config|
-  config.log_language   = :en
-  config.structure_path = Rails.root.join('db', 'seed', 'structure')
-  config.preload_path   = Rails.root.join('db', 'seed', 'preload')
-end
-```
+This command creates (if not already present) the file `config/initializers/better_seeder.rb` with the necessary configuration.
 
 ---
 
 ## Structure Files
 
-For each model, create a structure file that centralizes the logic for generating, validating, and configuring seed data. Each structure file should define at least the following methods:
+For each model, create a structure file that centralizes the logic for generating, validating, and configuring seed data. Each structure file should include:
 
 - **`structure`**  
-  Returns a hash where each key represents an attribute and its value is an array in the format `[type, lambda_generator]`.
+  Returns a hash where each key is an attribute and its value is an array in the format `[type, lambda_generator]`.
 
 - **`seed_schema` (Optional)**  
-  Defines a Dry-schema for validating the generated records.
+  Defines a Dry-schema for validating generated records.
 
 - **`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, this 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 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
 
 - **`unique_keys` (Optional)**  
-  Returns an array of column groups (each group is an array of symbols) that must be unique.  
-  For example:
+  Returns an array of column groups (each group is an array of symbols) that must be unique. For example:
 
   ```ruby
   def self.unique_keys
@@ -111,13 +103,10 @@ For each model, create a structure file that centralizes the logic for generatin
 
 ### Example Structure File
 
-For a generic model `MyModel` in the namespace `MyNamespace`, create a file at `db/seed/structure/my_namespace/my_model_structure.rb`:
-
 ```ruby
 # db/seed/structure/my_namespace/my_model_structure.rb
 module MyNamespace
   class MyModelStructure < BetterSeeder::StructureBase
-    # Defines generators for each attribute.
     def self.structure
       {
         name:       [:string,   -> { FFaker::Name.name }],
@@ -126,7 +115,6 @@ module MyNamespace
       }
     end
 
-    # Optional: Validate generated records using Dry-schema.
     def self.seed_schema
       Dry::Schema.Params do
         required(:name).filled(:string)
@@ -135,7 +123,6 @@ module MyNamespace
       end
     end
 
-    # Specific seeding configuration for MyModel.
     def self.seed_config
       {
         file_name: 'my_model_seed',
@@ -147,7 +134,6 @@ module MyNamespace
       }
     end
 
-    # Optional: Uniqueness constraints; for example, email must be unique.
     def self.unique_keys
       [[:email]]
     end
@@ -162,19 +148,19 @@ end
 When you call `BetterSeeder.magic` with a configuration that contains an array of model names (as strings), the gem will:
 
 1. **Load Structure Files**  
-   For each model, the gem loads the corresponding structure file from `BetterSeeder.configuration.structure_path`.
+   Retrieve the corresponding structure file from the directory defined by `BetterSeeder.configuration.structure_path` for each model.
 
 2. **Retrieve Seeding Configurations**  
-   It calls the model's `seed_config` method to get its specific settings.
+   Invoke the model's `seed_config` method to obtain its specific settings.
 
 3. **Generate or Retrieve Records**  
-   Using the `structure` method, the gem generates data dynamically (or retrieves existing records) and validates them with `seed_schema` if provided. Uniqueness is enforced based on `unique_keys`.
+   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**  
-   For child models, foreign keys are automatically injected using the records from the parent models.
+   Automatically inject foreign keys into child models using records from parent models.
 
-5. **Load and Export**  
-   If enabled (`load_data: true`), the generated records are inserted into the database and then exported in the specified format (SQL, CSV, or JSON). Export files are saved in the directory defined by `BetterSeeder.configuration.preload_path` (default: `db/seed/preload`).
+5. **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
 
@@ -190,24 +176,17 @@ BetterSeeder.magic(
 )
 ```
 
-This command processes each model by:
-
-- Reading its structure file and retrieving its configuration via `seed_config`.
-- Generating or fetching data according to the specified rules.
-- Inserting the data into the database (if `load_data` is enabled).
-- Exporting the data as an SQL file (or CSV/JSON, depending on `export_type`).
-
 ---
 
-## Structure Generator
+## Rails Generator
 
-BetterSeeder now provides a custom Rails generator to scaffold a structure file template for your models. You can generate a structure file automatically using the following command:
+A custom Rails generator is available to scaffold a structure file template for your models. Execute the following command:
 
 ```bash
 rails generate better_seeder:structure MyNamespace::MyModel
 ```
 
-This command creates a structure file template in the appropriate subdirectory under `db/seed/structure`. The generated file includes placeholders for:
+This command creates a structure file template in the appropriate subdirectory under `db/seed/structure`. The generated template includes placeholders for:
 
 - Attribute generators (via the `structure` method)
 - Validation schema (via the `seed_schema` method)
@@ -219,21 +198,18 @@ This command creates a structure file template in the appropriate subdirectory u
 ```ruby
 module MyNamespace
   class MyModelStructure < BetterSeeder::StructureBase
-    # Defines generators for each attribute.
     def self.structure
       {
         attribute_name: [:string, -> { "your value" }]
       }
     end
 
-    # Optional: Validate generated records using Dry-schema.
     def self.seed_schema
       Dry::Schema.Params do
         required(:attribute_name).filled(:string)
       end
     end
 
-    # Specific seeding configuration for MyModel.
     def self.seed_config
       {
         file_name: 'my_model_seed',
@@ -245,7 +221,6 @@ module MyNamespace
       }
     end
 
-    # Optional: Uniqueness constraints.
     def self.unique_keys
       []
     end
@@ -253,27 +228,33 @@ module MyNamespace
 end
 ```
 
-This generator streamlines the setup of new structure files, ensuring consistency and saving time when defining your seed data configuration.
+This generator ensures a consistent structure for your seeding configuration across models.
 
-### Benefits
+---
 
-- **Automated Scaffolding:** Quickly generate a complete structure file template for any model.
-- **Consistency:** All generated files adhere to a standard format, ensuring consistency across your seeding logic.
-- **Customization:** Easily modify the generated file to fine-tune attribute generators, validation rules, seeding configuration, and uniqueness constraints.
+## Contact & Feature Requests
+
+For suggestions, bug reports, or to report new feature requests, please reach out via email at: **alessio.bussolari@pandev.it**.
 
 ---
 
-## Conclusion
+## Upcoming Features
 
-BetterSeeder provides a modular, configurable, and extensible system for seeding your Rails application's data:
+The development team is continuously enhancing BetterSeeder. Current efforts include:
 
-- **Centralized Configuration:**  
-  Configure paths and logging via a Rails initializer.
+- **Additional Export Formats:** Expanding beyond SQL, CSV, and JSON to offer more options.
+- **Enhanced Rails Associations Integration:** Improving support for complex parent/child relationships.
+- **Expanded Configuration Options:** Providing more granular control over the seeding process.
+- **Performance Optimizations:** Refining data generation algorithms for faster processing.
+
+---
+
+## Conclusion
 
-- **Modular Structure Files:**  
-  Define generation, validation, and configuration logic for each model in dedicated structure files.
+BetterSeeder provides a modular, configurable, and extensible system for seeding your Rails application's data. Its key benefits include:
 
-- **Seamless Data Handling:**  
-  Automatically generate, validate, load, and export seed data with support for parent/child relationships and various export formats.
+- **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.
 
-For further details or contributions, please refer to the official repository or documentation.
+For further details or to contribute, please refer to the official repository or documentation.

data/lib/better_seeder/{generators → builders}/structure.rb

@@ -2,7 +2,7 @@
 require 'fileutils'
 
 module BetterSeeder
-  module Generators
+  module Builders
     class Structure
       TEMPLATE = <<~RUBY
         module %{module_name}

data/lib/better_seeder/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BetterSeeder
-  VERSION = "0.2.1"
+  VERSION = "0.2.2.1"
 end

data/lib/better_seeder.rb

@@ -6,6 +6,7 @@ require_relative "better_seeder/exporters/base"
 require_relative "better_seeder/exporters/json"
 require_relative "better_seeder/exporters/csv"
 require_relative "better_seeder/exporters/sql"
+require_relative "better_seeder/builders/structure"
 
 module BetterSeeder
   class Configuration
@@ -110,7 +111,7 @@ module BetterSeeder
   end
 
   def self.generate_structure(model_name: )
-    BetterSeeder::Generators::Structure.generate(model_name)
+    BetterSeeder::Builders::Structure.generate(model_name)
   end
 
   private

data/lib/generators/better_seeder/structure_generator.rb

@@ -0,0 +1,15 @@
+# lib/generators/better_seeder/structure_generator.rb
+require "rails/generators"
+
+module BetterSeeder
+  class StructureGenerator < Rails::Generators::NamedBase
+    # Optionally, if you have a template directory, you can set it here:
+    # source_root File.expand_path("templates", __dir__)
+
+    def create_structure_file
+      say_status("info", "Generating structure file for #{name}", :green)
+      file_path = BetterSeeder.generate_structure(model_name: name)
+      say_status("info", "Structure file created at #{file_path}", :green)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: better_seeder
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2.1
 platform: ruby
 authors:
 - alessio_bussolari
@@ -133,17 +133,17 @@ files:
 - LICENSE.txt
 - README.md
 - lib/better_seeder.rb
+- lib/better_seeder/builders/structure.rb
 - lib/better_seeder/configuration.rb
 - lib/better_seeder/exporters/base.rb
 - lib/better_seeder/exporters/csv.rb
 - lib/better_seeder/exporters/json.rb
 - lib/better_seeder/exporters/sql.rb
 - lib/better_seeder/farms/farmer.rb
-- lib/better_seeder/generators/structure.rb
 - lib/better_seeder/structure/utils.rb
 - lib/better_seeder/utils.rb
 - lib/better_seeder/version.rb
-- lib/generators/better_seeder/structure/structure_generator.rb
+- lib/generators/better_seeder/structure_generator.rb
 homepage: https://github.com/alessiobussolari/better_seeder
 licenses:
 - MIT

data/lib/generators/better_seeder/structure/structure_generator.rb

@@ -1,17 +0,0 @@
-# lib/generators/better_seeder/structure/structure_generator.rb
-require "rails/generators"
-
-module BetterSeeder
-  module Structure
-    class StructureGenerator < Rails::Generators::NamedBase
-      # Optionally, if you have a template directory, you can set it here:
-      # source_root File.expand_path("templates", __dir__)
-
-      def create_structure_file
-        say_status("info", "Generating structure file for #{name}", :green)
-        file_path = BetterSeeder.generate_structure(model_name: name)
-        say_status("info", "Structure file created at #{file_path}", :green)
-      end
-    end
-  end
-end