seedie 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dba945f1f8d911d59194de8191ef857885bc79fb3986fe4d159bbf21842758d9
-  data.tar.gz: 330174e781fa44b766d1fdcc4fbca9b4cc4f549db447913a60e2c1a41a4f0f51
+  metadata.gz: fa80b46ccb1727a4451598e8f94657bc15b43dbb0b2b0e58e8bd744db0636af6
+  data.tar.gz: b8e49e8fecdbc3c63f62b55384e3860428c9eb579114552cc2da7212c1e4b92c
 SHA512:
-  metadata.gz: 4717460bd7dc315de646b3e839f5d8be92881245638711c790b5f8a8b3dac216d8ab0eccf8c6d3bc974f7c9ecf1f00b8520bbf44f6b112af18e2620a44faee71
-  data.tar.gz: cc648a856d662822565da6d648f16d5f17da1f9b5f1eca45f0e2748fc8633e98d7018efda18d699af4771315b424fa83d13b397a632716a06d79910ee4ec4ae9
+  metadata.gz: fd0263009e5cd4b9d2287d56bde4ee2eb93337019218e018960efb9e5c9206b9f0323ccec95eaa986ddb9257d4acc9ccf684906f3f56319e1536fb6018201c4a
+  data.tar.gz: '0808e17b7a47e12367491571ade529974202d48eb0d93a0885143dba3e4b2982db13cac4a2196e478e39770d120cf4cd632b4436934d649f23e9f2f651263684'

data/CHANGELOG.md

@@ -2,6 +2,58 @@
 
 ### New Features
 
+#### Generate a Blank Seedie.yml file with `--blank` option
+
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/20)
+
+  You can now generate a blank seedie.yml file with the `--blank` option:
+
+  ```bash
+  rails g seedie:install --blank
+  ```
+
+#### Exclude models from seedie.yml generation with `--excluded_models` option
+
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/21)
+
+  You can now exclude models from seedie.yml generation with the `--excluded_models` option:
+
+  ```bash
+  rails g seedie:install --excluded_models Post Comment
+  ```
+
+#### Generate a Seedie.yml file with only specific models with `--include_only_models` option
+
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/22)
+
+  You can now generate a seedie.yml file with only specific models with the `--include_only_models` option:
+
+  ```bash
+  rails g seedie:install --include_only_models Post Comment
+  ```
+
+#### Bugfix: Now unique indexes will be generated with `unique` instead of `random` pick_strategy
+
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/23)
+
+#### Introducing new Seedie.rb initializer
+
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/28)
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/29)
+
+```ruby
+Seedie.configure do |config|
+  # config.default_count = 10
+
+  config.custom_attributes[:email] = "{{Faker::Internet.unique.email}}"
+  # Add more custom attributes here
+end
+```
+
+## Version 0.2.0
+
+### New Features
+
 #### Polymorphic Association
 * [GitHub PR](https://github.com/keshavbiswa/seedie/pull/12)
   

data/README.md

@@ -34,8 +34,77 @@ $ rails generate seedie:install
 ```
 This will create a seedie.yml file in your config directory, which will include configurations for your models.
 
+Alternatively, you can also create a blank seedie.yml file by running:
+
+```bash
+$ rails generate seedie:install --blank
+```
+
+This will generate a blank seedie.yml config file for you that you can now customize according to your needs.
+
 ## Usage
 
+### Generating blank seedie.yml
+If you want to create a blank seedie.yml file, use the `--blank` option:
+
+```bash
+$ rails generate seedie:install --blank
+```
+
+This will generate a blank seedie.yml config file for you that you can now customize according to your needs.
+
+### Excluding Models
+If you want to exclude certain models while generating the `seedie.yml`, use the `--exclude_models` option:
+
+```bash
+$ rails generate seedie:install --exclude_models User Admin Post
+```
+
+NOTE: Some models may not be excluded because of their dependencies. For example, if you have a model `Post` that belongs to a model `User`, then the `User` model will not be excluded even if you specify it in the `--exclude_models` option.
+
+You'll get a warning in your console if any models are not excluded:
+
+```bash
+WARNING: User has dependencies with other models and cannot be excluded.
+```
+
+### Including only few Models
+If you want to include only few particular models while generating the `seedie.yml`, use the `--include_only_models` option:
+
+```bash
+$ rails generate seedie:install --include_only_models Post Comment
+```
+
+NOTE: Some models may be a dependency for the required models and will need to be included for successful seeding. For example, if you have a model `Post` that belongs to a model `User`, then the `User` model will need to be included even if you didn't specify it in the `--include_only_models` option.
+
+You'll get a warning in your console if any other models are included:
+
+```bash
+WARNING: User is a dependency of included models and needs to be included.
+```
+
+### Add Custom Attributes inside seedie.rb initializer
+
+While generating the seedie.yml file, there are default values.
+For example, for every `string` field, the default value is `{{Faker::Lorem.word}}`.
+This works fine for most attributes, but for some there are validations which breaks the seeding.
+Take `email` as an example, the default value `{{Faker::Lorem.word}}` will not be a valid email.
+By default, when we generate the seedie.yml file, we add a `seedie.rb` initializer file in the `config/initializers` directory.
+
+```ruby
+Seedie.configure do |config|
+  # config.default_count = 10
+
+  config.custom_attributes[:email] = "{{Faker::Internet.unique.email}}"
+  # Add more custom attributes here
+end
+```
+
+This ensures that the `email` field is seeded with a valid email address.
+You can add more custom attributes in the `seedie.rb` initializer file.
+
+### Seeding Models
+
 To seed your models, run the following Rake task:
 
 ```bash
@@ -98,7 +167,7 @@ In this file:
 - `disabled_fields` is an array of fields that should not be automatically filled by Seedie.
 - `associations` specify how associated models should be generated. Here, `has_many`, `belongs_to`, and `has_one` are supported.
 - The specified number for `has_many` represents the number of associated records to create.
-- For `belongs_to`, the value `random` means that a random existing record will be associated.
+- For `belongs_to`, the value `random` means that a random existing record will be associated. If there is a unique index associated, then `unique` will be set or else `random` is the default.
 - If attributes are specified under an association, those attributes will be used when creating the associated record(s)
 - When using associations, it's important to define the models in the correct order in the `seedie.yml` file. Associated models should be defined before the models that reference them.
 

data/lib/generators/seedie/install_generator.rb

@@ -19,22 +19,44 @@ module Seedie
 
       source_root File.expand_path("templates", __dir__)
 
+      class_option :blank, type: :boolean, default: false, desc: "Generate a blank seedie.yml with examples"
+      class_option :excluded_models, type: :array, default: [], desc: "Models to exclude from seedie.yml"
+      class_option :include_only_models, type: :array, default: [], 
+        desc: "Models to be specifically included in seedie.yml. This will ignore all other models."
+
+
       desc "Creates a seedie.yml for your application."
       def generate_seedie_file(output = STDOUT)
-        Rails.application.eager_load! # Load all models. This is required!!
+        if options[:include_only_models].present? && options[:excluded_models].present?
+          raise ArgumentError, "Cannot use both --include_only_models and --excluded_models together." 
+        end
+        
+        # This needs to be generated before anything else.
+        template "seedie_initializer.rb", "config/initializers/seedie.rb"
+        
+        @excluded_models = options[:excluded_models] + EXCLUDED_MODELS
+        @output = output
 
-        @models = get_models
-        @models_config = build_models_config
-        template "seedie.yml", "config/seedie.yml"
+        if options[:blank]
+          template "blank_seedie.yml", "config/seedie.yml"
+        else
+          Rails.application.eager_load! # Load all models. This is required!!
 
-        output_seedie_warning(output)
+          @models = get_models
+          @models_config = build_models_config
+          template "seedie.yml", "config/seedie.yml"
+        end
+
+        output_seedie_warning
       end
 
       private
 
-
       def build_models_config
         models = Model::ModelSorter.new(@models).sort_by_dependency
+
+        output_warning_for_extra_models(models)
+
         models.reduce({}) do |config, model|
           config[model.name.underscore] = model_configuration(model)
           config
@@ -123,11 +145,14 @@ module Seedie
           association.options[:optional] == true # Excluded Optional Associations
         end
 
+        unique_indexes = model.connection.indexes(model.table_name).select(&:unique).flat_map(&:columns)
+
         belongs_to_associations.reduce({}) do |config, association|
           if association.polymorphic?
             config[association.name.to_s] = set_polymorphic_association_config(model, association)
           else
-            config[association.name.to_s] = "random"
+            association_has_unique_index = unique_indexes.include?(association.foreign_key.to_s)
+            config[association.name.to_s] = association_has_unique_index ? "unique" : "random"
           end
           config
         end
@@ -145,21 +170,45 @@ module Seedie
       end
 
       def get_models
-        @get_models ||= ActiveRecord::Base.descendants.reject do |model|
-          EXCLUDED_MODELS.include?(model.name) || # Excluded Reserved Models
-          model.abstract_class? || # Excluded Abstract Models
-          model.table_exists? == false || # Excluded Models without tables
-          model.name.blank? || # Excluded Anonymous Models
-          model.name.start_with?("HABTM_") # Excluded HABTM Models
+        @get_models ||= begin
+          all_models = ActiveRecord::Base.descendants
+
+          if options[:include_only_models].present?
+            all_models.select! { |model| options[:include_only_models].include?(model.name) }
+          end
+
+          all_models.reject do |model|
+            @excluded_models.include?(model.name) || # Excluded Reserved Models
+            model.abstract_class? || # Excluded Abstract Models
+            model.table_exists? == false || # Excluded Models without tables
+            model.name.blank? || # Excluded Anonymous Models
+            model.name.start_with?("HABTM_") # Excluded HABTM Models
+          end
         end
       end
 
-      def output_seedie_warning(output)
-        output.puts "Seedie config file generated at config/seedie.yml"
-        output.puts "##################################################"
-        output.puts "WARNING: Please review the generated config file before running the seeds."
-        output.puts "There might be some things that you might need to change to ensure that the generated seeds run successfully."
-        output.puts "##################################################"
+      def output_seedie_warning
+        @output.puts "Seedie config file generated at config/seedie.yml"
+        @output.puts "##################################################"
+        @output.puts "WARNING: Please review the generated config file before running the seeds."
+        @output.puts "There might be some things that you might need to change to ensure that the generated seeds run successfully."
+        @output.puts "##################################################"
+      end
+
+      def output_warning_for_extra_models(models)
+        if options[:excluded_models].present?
+          required_excluded_models = models.map(&:name) & @excluded_models
+
+          required_excluded_models.each do |model_name|
+            @output.puts "WARNING: #{model_name} has dependencies with other models and cannot be excluded."
+          end
+        elsif options[:include_only_models].present?
+          dependent_models = models.map(&:name) - @models.map(&:name)
+
+          dependent_models.each do |model_name|
+            @output.puts "WARNING: #{model_name} is a dependency of included models and needs to be included."
+          end
+        end
       end
     end
   end

data/lib/generators/seedie/templates/blank_seedie.yml

@@ -0,0 +1,22 @@
+### This is a blank seedie.yml file. ###
+
+# default_count: 10
+#
+# models:
+#   model_name:
+#     attributes:
+#       string_field: '{{Faker::Lorem.word}}'
+#       integer_field:
+#         values: [1, 2, 3]
+#         options: 
+#           pick_strategy: random
+#       jsonb_field:
+#         value: '{"key": "value"}'
+#     disabled_fields: ["unwanted_field"]
+#     associations:
+#       belongs_to:
+#         parent_model: random
+#       has_one:
+#         associated_model: random
+#       has_many:
+#         other_models: random

data/lib/generators/seedie/templates/seedie_initializer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+Seedie.configure do |config|
+  # config.default_count = 10
+
+  config.custom_attributes[:email] = "{{Faker::Internet.unique.email}}"
+  # Add more custom attributes here
+end

data/lib/seedie/configuration.rb

@@ -0,0 +1,10 @@
+module Seedie
+  class Configuration
+    attr_accessor :default_count, :custom_attributes
+
+    def initialize
+      @default_count = nil
+      @custom_attributes = {}
+    end
+  end
+end

data/lib/seedie/field_values/faker_builder.rb

@@ -10,9 +10,12 @@ module Seedie
         @class_prefix = ""
         @method_prefix = ""
         @options = ""
+        @seedie_config_custom_attributes = Seedie.configuration.custom_attributes
       end
 
       def build_faker_constant
+        return @seedie_config_custom_attributes[@name.to_sym] if @seedie_config_custom_attributes.key?(@name.to_sym)
+
         @unique_prefix = "unique." if has_validation?(:uniqueness)
         
         add_faker_class_and_method(@column.type)

data/lib/seedie/model/model_sorter.rb

@@ -22,7 +22,6 @@ module Seedie
     
       private
 
-
       # Independent models need to be added first
       def add_independent_models_to_queue
         @models.each do |model|

data/lib/seedie/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Seedie
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/seedie.rb

@@ -24,6 +24,7 @@ require_relative "seedie/associations/belongs_to"
 
 require_relative "seedie/seeder"
 require_relative "seedie/version"
+require_relative "seedie/configuration"
 
 require "seedie/railtie" if defined?(Rails)
 
@@ -41,4 +42,14 @@ module Seedie
   class InvalidCustomFieldValuesError < StandardError; end
   class InvalidCustomFieldOptionsError < StandardError; end
   class CustomFieldNotEnoughValuesError < StandardError; end
+
+  class << self
+    def configure
+      yield configuration if block_given?
+    end
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: seedie
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Keshav Biswa
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-08-13 00:00:00.000000000 Z
+date: 2023-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.9'
 - !ruby/object:Gem::Dependency
@@ -125,12 +125,15 @@ files:
 - Rakefile
 - lib/generators/seedie/USAGE
 - lib/generators/seedie/install_generator.rb
+- lib/generators/seedie/templates/blank_seedie.yml
 - lib/generators/seedie/templates/seedie.yml
+- lib/generators/seedie/templates/seedie_initializer.rb
 - lib/seedie.rb
 - lib/seedie/associations/base_association.rb
 - lib/seedie/associations/belongs_to.rb
 - lib/seedie/associations/has_many.rb
 - lib/seedie/associations/has_one.rb
+- lib/seedie/configuration.rb
 - lib/seedie/field_values/custom_value.rb
 - lib/seedie/field_values/fake_value.rb
 - lib/seedie/field_values/faker_builder.rb