better_seeder 0.1.1 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9aae14d62a0773d4feb44b44b3100975b9553bcf6fb4f4236a19a9aff170918
-  data.tar.gz: a1d099172e14308d76187c63ae5596f84bf21859ecfae7d109d081e876b9c950
+  metadata.gz: 9d73544e7817771707d5e7f1421767992e3c3f87d69ff5605268cd1be22cb98c
+  data.tar.gz: 1c6306a91c0f338c57b1cbc60b2d5046cd2e11e7d4774e6d38aa52e50d035a84
 SHA512:
-  metadata.gz: ed17059f5eb6791783c32e9b0beca47d9c231b0d6d37c2864472a6c8bea34bbfe099d4ac212cdc95b3b7c88960c8258ad170cfd6798b84ae786b66250630cdd2
-  data.tar.gz: 1e58946159f5c8c01991774084bf5967325ccaf6a71474ba4d4123e215bd794408e61ab0ad6bf15f21b5fd76bc3fc082b895d71bb490094c33c8c0a1dcdb5494
+  metadata.gz: c579ee578d90e816e920651a5576f29884f3cbc2b8b5663cba2eee5499e3ca661655592c8ad81d6edc42f7c5aefd054ad3fdeebe714be4d8a0c67c5c8337cdc9
+  data.tar.gz: cd5e076bc6b252d29c8cde4a530d887eddc9bf582236364b42130e74ce5340dd47520ec0d10fa4ec9fd62341ae9d7c94d4a249775ff0261b436eb7109b148bc8

data/README.md

@@ -199,6 +199,70 @@ This command processes each model by:
 
 ---
 
+## Structure 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:
+
+```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:
+
+- Attribute generators (via the `structure` method)
+- Validation schema (via the `seed_schema` method)
+- Seeding configuration (via the `seed_config` method)
+- Uniqueness constraints (via the `unique_keys` method)
+
+### Example Generated Template
+
+```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',
+        columns: { excluded: [] },
+        generate_data: true,
+        count: 10,
+        load_data: true,
+        parent: nil
+      }
+    end
+
+    # Optional: Uniqueness constraints.
+    def self.unique_keys
+      []
+    end
+  end
+end
+```
+
+This generator streamlines the setup of new structure files, ensuring consistency and saving time when defining your seed data configuration.
+
+### 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.
+
+---
+
 ## Conclusion
 
 BetterSeeder provides a modular, configurable, and extensible system for seeding your Rails application's data:

data/lib/better_seeder/{generators/data_generator.rb → farms/farmer.rb}

@@ -1,6 +1,6 @@
 module BetterSeeder
-  module Generators
-    class DataGenerator
+  module Farms
+    class Farmer
       # Genera dati fittizi per il modello specificato utilizzando il file di structure.
       #
       # Opzioni attese (Hash):

data/lib/better_seeder/generators/structure.rb

@@ -0,0 +1,79 @@
+# lib/better_seeder/generators/structure_generator.rb
+require 'fileutils'
+
+module BetterSeeder
+  module Generators
+    class Structure
+      TEMPLATE = <<~RUBY
+        module %{module_name}
+          class %{class_name}Structure < ::BetterSeeder::Structure::Utils
+            # Defines generators for each attribute.
+            def self.structure
+              {
+                # Replace with your attribute generators:
+                attribute_name: [:string, -> { "your value" }]
+              }
+            end
+
+            # Optional: Validate generated records using Dry-schema.
+            def self.seed_schema
+              Dry::Schema.Params do
+                # Replace with your validations:
+                required(:attribute_name).filled(:string)
+              end
+            end
+
+            # Specific seeding configuration for %{class_name}.
+            def self.seed_config
+              {
+                file_name: '%{file_name}',
+                columns: { excluded: [] },
+                generate_data: true,
+                count: 10,
+                load_data: true,
+                parent: nil
+              }
+            end
+
+            # Optional: Uniqueness constraints.
+            def self.unique_keys
+              []
+            end
+          end
+        end
+      RUBY
+
+      # Generates a structure file for the given model name.
+      #
+      # @param model_name [String] The full model name (e.g., "MyNamespace::MyModel")
+      # @return [String] The full path to the generated file.
+      def self.generate(model_name)
+        # Split the model name into module parts and the actual class name.
+        parts = model_name.split("::")
+        class_name = parts.pop
+        module_name = parts.empty? ? "Main" : parts.join("::")
+
+        # Determine the file path.
+        # For example, for "MyNamespace::MyModel", the file will be placed in:
+        # lib/better_seeder/generators/my_namespace/my_model_structure.rb
+        folder_path = File.join(BetterSeeder.configuration.structure_path, *parts.map(&:underscore))
+        file_name = "#{class_name.underscore}_structure.rb"
+        full_path = File.join(folder_path, file_name)
+
+        # Ensure the target directory exists.
+        FileUtils.mkdir_p(folder_path) unless Dir.exist?(folder_path)
+
+        # Prepare the file content.
+        content = TEMPLATE % {
+          module_name: module_name,
+          class_name: class_name,
+          file_name: "#{class_name.underscore}_seed"
+        }
+
+        # Write the template to the file.
+        File.write(full_path, content)
+        full_path
+      end
+    end
+  end
+end

data/lib/better_seeder/version.rb

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

data/lib/better_seeder.rb

@@ -1,7 +1,7 @@
 require_relative "better_seeder/utils"
 require_relative "better_seeder/configuration"
 require_relative "better_seeder/structure/utils"
-require_relative "better_seeder/generators/data_generator"
+require_relative "better_seeder/farms/farmer"
 require_relative "better_seeder/exporters/base"
 require_relative "better_seeder/exporters/json"
 require_relative "better_seeder/exporters/csv"
@@ -109,6 +109,10 @@ module BetterSeeder
     log_statistics(stats, total_time)
   end
 
+  def self.generate_structure(model_name: )
+    BetterSeeder::Generators::Structure.generate(model_name)
+  end
+
   private
 
   # Processa la configurazione per un singolo modello.
@@ -167,7 +171,7 @@ module BetterSeeder
 
     # Recupera o genera i record.
     records = if generate_data
-                Generators::DataGenerator.generate(model: model_name, count: count)
+                Farms::Farmer.generate(model: model_name, count: count)
               else
                 model_class.all.map(&:attributes)
               end

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

@@ -0,0 +1,17 @@
+# 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: better_seeder
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.1
 platform: ruby
 authors:
 - alessio_bussolari
@@ -138,10 +138,12 @@ files:
 - lib/better_seeder/exporters/csv.rb
 - lib/better_seeder/exporters/json.rb
 - lib/better_seeder/exporters/sql.rb
-- lib/better_seeder/generators/data_generator.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
 homepage: https://github.com/alessiobussolari/better_seeder
 licenses:
 - MIT