better_seeder 0.2.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0703abc9a90ae9676b1c1d79553345e09e148b0c5411740779b1157c4d6cbdd
-  data.tar.gz: 1e0966ba4ea675cfdd6b6a28b8bae9457770957251272be352ed44e7db0d2b2b
+  metadata.gz: 19461c43288bc59e79dcad650e0f64ab6b135db335813fb29ae9ddacbed238d3
+  data.tar.gz: db98585d74a4f04644ab60ec254d469e12f7078e157ec505a0c4d8b909850aad
 SHA512:
-  metadata.gz: 83d3b209222d0a44824c7795a2ca3b041177e7d01d12277d89a3c5b39fd194157da4764e9d6a185759348c74d8d0bc10b6a2ac3587fcb607cdc5711d87bd339a
-  data.tar.gz: e11c9bf4bc617d3d588464eb0661811bfd198d8ccf9188421c95eff5437117f50ee542f3a894cff50bb99a3709d0211d8a822c708034588517bea6d4eddf2420
+  metadata.gz: 5b0dc886f98b74bdd3e72ff07b52c72786b74f8c21937204c6e04a5dfcbb94c883b0d27bc1a83c18ea00c0adf99d766fde94a17cb6390c1369b5773e3b903666
+  data.tar.gz: b4dd522996c4ac5a6113f82ef99010e104c988afa815c8476c6040dea4c65f738646d0c4d617600a22344c8c2031c57825903d7d2c897b1ccfd95c226a2fd9a5

data/README.md

@@ -201,21 +201,20 @@ This command processes each model by:
 
 ## Structure Generator
 
-`BetterSeeder.generate_structure(model_name: 'MyModel')` method. This functionality automatically creates a structure file template for a given model name. The generated file is saved in the appropriate subdirectory under `db/seed/structure` and includes placeholders for attribute generators, a validation schema, seed configuration, and uniqueness constraints.
+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:
 
-### How to Use
-
-Simply call the method with your model name. For example:
-
-```ruby
-BetterSeeder.generate_structure(model_name: 'MyNamespace::MyModel')
+```bash
+rails generate better_seeder:structure MyNamespace::MyModel
 ```
 
-This command will generate a file at `db/seed/structure/my_namespace/my_model_structure.rb`.
+This command creates a structure file template in the appropriate subdirectory under `db/seed/structure`. The generated file includes placeholders for:
 
-### Example Generated File
+- 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)
 
-The generated file will contain a template similar to the following:
+### Example Generated Template
 
 ```ruby
 module MyNamespace
@@ -254,6 +253,8 @@ module MyNamespace
 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.

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.0"
+  VERSION = "0.2.2"
 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/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.2.0
+  version: 0.2.2
 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_generator/structure_generator.rb
+- lib/generators/better_seeder/structure/structure_generator.rb
 homepage: https://github.com/alessiobussolari/better_seeder
 licenses:
 - MIT

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

@@ -1,19 +0,0 @@
-# lib/generators/better_seeder/structure_generator/structure_generator.rb
-require 'rails/generators'
-require 'better_seeder'
-
-module BetterSeeder
-  module Generators
-    class StructureGenerator < Rails::Generators::NamedBase
-      # No template file is needed as our method generates the file content.
-      # Instead, we call the BetterSeeder.generate_structure method.
-      def create_structure_file
-        say_status("info", "Generating structure file for #{name}", :green)
-        # Call the generator method from your gem.
-        # It expects a keyword argument :model_name.
-        file_path = BetterSeeder.generate_structure(model_name: name)
-        say_status("info", "Structure file created at #{file_path}", :green)
-      end
-    end
-  end
-end