seedie 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dba945f1f8d911d59194de8191ef857885bc79fb3986fe4d159bbf21842758d9
-  data.tar.gz: 330174e781fa44b766d1fdcc4fbca9b4cc4f549db447913a60e2c1a41a4f0f51
+  metadata.gz: 7b22e6527a57385dbb0b5fc616cf632b84550a3ce8237f286a64b931670bd34a
+  data.tar.gz: edeb838fb02090e02a9434260e08f6cb376b4b9d1e16a75e7dc3bd97c6d0a14a
 SHA512:
-  metadata.gz: 4717460bd7dc315de646b3e839f5d8be92881245638711c790b5f8a8b3dac216d8ab0eccf8c6d3bc974f7c9ecf1f00b8520bbf44f6b112af18e2620a44faee71
-  data.tar.gz: cc648a856d662822565da6d648f16d5f17da1f9b5f1eca45f0e2748fc8633e98d7018efda18d699af4771315b424fa83d13b397a632716a06d79910ee4ec4ae9
+  metadata.gz: 85ae796fa177098ac721addf4e4da3a10f12e26613318fb8f3fe8d126d008ec3de310115b877848fa607a91ad69e51c7c10a531322100050e76e45e89a2f2b72
+  data.tar.gz: cb9fe8d4333e9a80f32fc33bab4e8fbe5066832121ab5c49bb3701691e8a07147115819f13ee41e58eb91d90d03a247e6bfe5f5280cc600b4c307c251b0e98fc

data/.rubocop.yml

@@ -1,16 +1,98 @@
 AllCops:
-  TargetRubyVersion: 2.6
-  DisabledByDefault: true
-  
+  TargetRubyVersion: 2.7
+  NewCops: disable
+  SuggestExtensions: false
+  Exclude:
+    - "spec/dummy/bin/*"
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+  EnforcedShorthandSyntax: never
+
+Style/GuardClause:
+  Enabled: false
+
+# Configuration parameters: EnforcedStyle, SingleLineConditionsOnly, IncludeTernaryExpressions.
+# SupportedStyles: assign_to_condition, assign_inside_condition
+Style/ConditionalAssignment:
+    Enabled: false
+
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
 Style/StringLiterals:
-  Enabled: true
   EnforcedStyle: double_quotes
+  ConsistentQuotesInMultiline: true
 
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: both, prefix, postfix
+Style/NegatedIf:
+  Enabled: false
+
+Style/RedundantBegin:
+  Enabled: false
+
+# Configuration parameters: MinDigits, Strict, AllowedNumbers, AllowedPatterns.
+Style/NumericLiterals:
+  Exclude:
+    - 'spec/dummy/db/*.rb'
 
+Style/RedundantInterpolation:
+  Exclude:
+    - 'lib/seedie/reporters/console_reporter.rb'
+
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
 Layout/LineLength:
-  Max: 120
+  Max: 150
+
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# ForbiddenPrefixes: is_, has_, have_
+# AllowedMethods: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
   Exclude:
-    - "spec/dummy/**/*"
+    - 'spec/**/*'
+    - 'lib/seedie/field_values/faker_builder.rb'
+    - 'lib/seedie/polymorphic_association_helper.rb'
+
+Metrics/AbcSize:
+  Max: 30
+  Exclude:
+    - "lib/generators/seedie/install_generator.rb"
+
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  CountComments: false
+  Max: 30
+  Exclude: 
+    - "spec/integration/*.rb"
+    - "spec/seedie/**/*.rb"
+    - "spec/generators/*.rb"
+    - "spec/dummy/**/*.rb"
+
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Exclude:
+    - "lib/generators/seedie/install_generator.rb"
+    - "lib/seedie/field_values/faker_builder.rb"
+
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 52
+
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 15

data/CHANGELOG.md

@@ -1,7 +1,130 @@
+## Version 0.4.0
+
+### New Features
+
+#### Added HasAndBelongsToMany Association support
+
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/43)
+
+You can now add `has_and_belongs_to_many` associations to your seedie.yml file:
+
+```yaml
+has_and_belongs_to_many:
+  posts:
+    count: 5
+    attributes:
+      title: "{{Faker::Lorem.sentence}}"
+      body: "{{Faker::Lorem.paragraph}}"
+```
+
+#### Added the ability to generate nested BelongsTo Associations
+
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/34)
+
+Before, Models had no ability to add assocations to the child_model.
+
+```yaml
+parent_model:
+  attributes:
+    some_attribute: 'hello'
+  associations:
+    has_many:
+      child_model: 2
+```
+
+Now you can add associations to the child_model:
+
+```yaml
+parent_model:
+  attributes:
+    some_attribute: 'hello'
+  associations:
+    has_many:
+      child_model:
+        attributes:
+          title: 'some title'
+        associations:
+          belongs_to:
+            another_parent_model: 'random'
+```
+
+### Enhancements
+
+#### Complete Rubocop Integration with CI
+
+* [Rubocop Integration](https://github.com/keshavbiswa/seedie/pull/33) by [@giovannism20](https://github.com/giovannism20)
+* Rubocop cleanups:
+  - https://github.com/keshavbiswa/seedie/pull/37
+  - https://github.com/keshavbiswa/seedie/pull/38
+  - https://github.com/keshavbiswa/seedie/pull/39
+  - https://github.com/keshavbiswa/seedie/pull/40
+  - https://github.com/keshavbiswa/seedie/pull/41
+  - https://github.com/keshavbiswa/seedie/pull/42
+
+#### Added Zeitwerk Support
+
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/35)
+
+#### Added Rails 7.1 Support
+
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/36)
+
 ## Version 0.3.0
 
 ### 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/Gemfile

@@ -6,10 +6,13 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
-gem "rubocop", "~> 1.21"
 
 gem "pry", "~> 0.14.2"
 
 group :test do
   gem "simplecov", "~> 0.22.0", require: false
 end
+
+group :development, :test do
+  gem "rubocop", require: false
+end

data/README.md

@@ -1,6 +1,6 @@
 # Seedie
 
-Seedie is a Ruby gem designed to streamline the seeding of your database.
+Seedie is a Ruby gem designed to make it easy to seed your database with realistic data.
 Utilizing the Faker library, Seedie generates realistic data for ActiveRecord models.
 Currently supports only PostrgreSQL and SQLite3 databases.
 The gem includes a Rake task for seeding models and a Rails generator for easy setup.
@@ -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
@@ -75,6 +144,11 @@ models:
         post_metadatum: 
           attributes:
             seo_text: "{{Faker::Lorem.paragraph}}"
+      has_and_belongs_to_many:
+        tags:
+          count: 3
+          attributes:
+            name: "{{Faker::Lorem.word}}"
     disabled_fields: []
   comment:
     attributes:
@@ -96,9 +170,9 @@ In this file:
   - Additionally, we can use placeholders like `{{Faker::Internet.email}}` to generate dynamic and unique data for each record using Faker.
   - We can also specify an array of values that can be picked from randomly or sequentially using the `values` and `pick_strategy` options.
 - `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.
+- `associations` specify how associated models should be generated. Here, `has_many`, `belongs_to`, `has_one` and `has_and_belongs_to_many` 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/Rakefile

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-
 desc "Run all examples"
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.ruby_opts = %w[-w]

data/lib/generators/seedie/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails/generators/base"
 require "seedie"
 
@@ -5,7 +7,7 @@ module Seedie
   module Generators
     class InstallGenerator < Rails::Generators::Base
       include PolymorphicAssociationHelper
-      
+
       EXCLUDED_MODELS = %w[
         ActiveRecord::SchemaMigration
         ActiveRecord::InternalMetadata
@@ -15,29 +17,49 @@ module Seedie
         ActionText::RichText
         ActionMailbox::InboundEmail
         ActionText::EncryptedRichText
-      ]
+      ].freeze
 
       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!!
+      def generate_seedie_file(output = $stdout)
+        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
+
+        if options[:blank]
+          template "blank_seedie.yml", "config/seedie.yml"
+        else
+          Rails.application.eager_load! # Load all models. This is required!!
 
-        @models = get_models
-        @models_config = build_models_config
-        template "seedie.yml", "config/seedie.yml"
+          @models = collect_models
+          @models_config = build_models_config
+          template "seedie.yml", "config/seedie.yml"
+        end
 
-        output_seedie_warning(output)
+        output_seedie_warning
       end
 
       private
 
-
       def build_models_config
         models = Model::ModelSorter.new(@models).sort_by_dependency
-        models.reduce({}) do |config, model|
+
+        output_warning_for_extra_models(models)
+
+        models.each_with_object({}) do |model, config|
           config[model.name.underscore] = model_configuration(model)
-          config
         end
       end
 
@@ -68,12 +90,12 @@ module Seedie
           if polymorphic_types.include?(column.name) || foreign_keys.include?(column.name)
             next
           end
-          
+
           # Adding default columns to default_columns
           if column.default.present? || column.default_function.present?
             default_columns << column
-          elsif column.null == false || has_presence_validator?(model, column.name)
-          # Only add to active if its required or has presence validator
+          elsif column.null == false || presence_validator?(model, column.name)
+            # Only add to active if its required or has presence validator
             active_columns << column
           else
             disabled_columns << column
@@ -82,7 +104,7 @@ module Seedie
 
         # Add atleast one column to active columns
         active_columns << disabled_columns.pop if active_columns.empty? && disabled_columns.present?
-        
+
         # Disable all default columns
         disabled_columns += default_columns
 
@@ -93,14 +115,13 @@ module Seedie
       end
 
       def active_columns_configuration(model, columns)
-        columns.reduce({}) do |config, column|
+        columns.each_with_object({}) do |column, config|
           validations = model.validators_on(column.name)
           config[column.name] = if validations.present?
                                   FieldValues::FakerBuilder.new(column.name, column, validations).build_faker_constant
                                 else
                                   FieldValues::FakeValue.new(column.name, column).generate_fake_value
                                 end
-          config
         end
       end
 
@@ -113,7 +134,7 @@ module Seedie
           "associations" => {
             "belongs_to" => belongs_to_associations_configuration(model),
             "has_one" => {}, # TODO: Add has_one associations
-            "has_many" => {}, # TODO: Add has_many associations
+            "has_many" => {} # TODO: Add has_many associations
           }
         }
       end
@@ -123,16 +144,18 @@ module Seedie
           association.options[:optional] == true # Excluded Optional Associations
         end
 
-        belongs_to_associations.reduce({}) do |config, association|
+        unique_indexes = model.connection.indexes(model.table_name).select(&:unique).flat_map(&:columns)
+
+        belongs_to_associations.each_with_object({}) do |association, config|
           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
-      end      
-      
+      end
+
       def set_polymorphic_association_config(model, association)
         {
           "polymorphic" => find_polymorphic_types(model, association.name),
@@ -140,26 +163,50 @@ module Seedie
         }
       end
 
-      def has_presence_validator?(model, column_name)
+      def presence_validator?(model, column_name)
         model.validators_on(column_name).any? { |v| v.kind == :presence }
       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
+      def collect_models
+        @collect_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