seedie 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa80b46ccb1727a4451598e8f94657bc15b43dbb0b2b0e58e8bd744db0636af6
-  data.tar.gz: b8e49e8fecdbc3c63f62b55384e3860428c9eb579114552cc2da7212c1e4b92c
+  metadata.gz: 0a25c63e4fcff73414ac22c60e08d8f7e2c7cd831e0480922cd3dd64bb5598b3
+  data.tar.gz: b824464c1d4d084856adbaec92e677ac09f1e3f983fd103ada6638df0b535d23
 SHA512:
-  metadata.gz: fd0263009e5cd4b9d2287d56bde4ee2eb93337019218e018960efb9e5c9206b9f0323ccec95eaa986ddb9257d4acc9ccf684906f3f56319e1536fb6018201c4a
-  data.tar.gz: '0808e17b7a47e12367491571ade529974202d48eb0d93a0885143dba3e4b2982db13cac4a2196e478e39770d120cf4cd632b4436934d649f23e9f2f651263684'
+  metadata.gz: 901e08a66477d23d1c108071f116206d4f530a46911402ca178baf66e433cda231c884fbbb667b186842c03e6d1b608bda31be44071d360cfdc28f1f46242482
+  data.tar.gz: ff5a02c6f6a14af3bc041fc2d39a1550d66dcca61f1491160718cb59a5fc17a07963cf5e6302bbbc89f856796d6c4a0d0a7080167b48173023cbf5454170276d

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,3 +1,104 @@
+## Verson 0.4.1
+
+### New Features
+
+#### Added Model-specific Custom Attributes
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/47)
+
+You can now define custom attributes for specific models in your `Seedie.configure` block:
+
+```ruby
+Seedie.configure do |config|
+  # Default custom attribute for all models
+  config.custom_attributes[:email] = "{{Faker::Internet.unique.email}}"
+
+  # Model-specific custom attribute
+  config.custom_attributes[:user][:email] = "email_#{rand(10)}@example.com"
+end
+```
+
+### Enhancements
+
+#### Rubocop Cleanup
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/45)
+
+#### Improved README
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/44)
+
+#### Added Screencast
+* [GitHub PR](https://github.com/keshavbiswa/seedie/pull/46)
+
+## 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

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.
@@ -8,6 +8,10 @@ The gem includes a Rake task for seeding models and a Rails generator for easy s
 [![Gem Version](https://badge.fury.io/rb/seedie.svg)](https://badge.fury.io/rb/seedie)
 ![Build Status](https://github.com/keshavbiswa/seedie/workflows/CI/badge.svg?branch=main)
 
+## Screencast
+
+[![Introducing Seedie](https://img.youtube.com/vi/3W0wRrOtsTk/0.jpg)](https://www.youtube.com/watch?v=3W0wRrOtsTk)
+
 ## Installation
 
 Add the following line to your application's Gemfile:
@@ -54,13 +58,13 @@ $ 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:
+If you want to exclude certain models while generating the `seedie.yml`, use the `--excluded_models` option:
 
 ```bash
-$ rails generate seedie:install --exclude_models User Admin Post
+$ rails generate seedie:install --excluded_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.
+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 `--excluded_models` option.
 
 You'll get a warning in your console if any models are not excluded:
 
@@ -113,7 +117,7 @@ $ rake seedie:seed
 
 This will use the configurations specified in seedie.yml to seed your models.
 
-The seedie.yml file has entries for each model in your application, and you can customize the configuration for each one. 
+The seedie.yml file has entries for each model in your application, and you can customize the configuration for each one.
 
 Here's an example of a more advanced configuration in seedie.yml:
 
@@ -133,7 +137,7 @@ models:
       title: "title {{index}}"
       category:
         values: [tech, sports, politics, entertainment]
-        options: 
+        options:
           pick_strategy: random # or sequential
     associations:
       has_many:
@@ -141,9 +145,14 @@ models:
       belongs_to:
         user: random # or new
       has_one:
-        post_metadatum: 
+        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:
@@ -165,7 +174,7 @@ 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. 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)
@@ -173,7 +182,7 @@ In this file:
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. 
+After checking out the repo, run `bin/setup` to install dependencies.
 Then, run `bundle exec rspec` to run the tests.
 By default, the tests will supress output of the seeds progress.
 Use `DEBUG_OUTPUT=true bundle exec rspec` to see the output of the seeds.

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,25 +17,24 @@ 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."
-
+      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)
+      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." 
+          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
 
@@ -42,7 +43,7 @@ module Seedie
         else
           Rails.application.eager_load! # Load all models. This is required!!
 
-          @models = get_models
+          @models = collect_models
           @models_config = build_models_config
           template "seedie.yml", "config/seedie.yml"
         end
@@ -57,9 +58,8 @@ module Seedie
 
         output_warning_for_extra_models(models)
 
-        models.reduce({}) do |config, model|
+        models.each_with_object({}) do |model, config|
           config[model.name.underscore] = model_configuration(model)
-          config
         end
       end
 
@@ -90,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
@@ -104,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
 
@@ -115,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
 
@@ -135,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
@@ -147,17 +146,16 @@ module Seedie
 
         unique_indexes = model.connection.indexes(model.table_name).select(&:unique).flat_map(&:columns)
 
-        belongs_to_associations.reduce({}) do |config, association|
+        belongs_to_associations.each_with_object({}) do |association, config|
           if association.polymorphic?
             config[association.name.to_s] = set_polymorphic_association_config(model, association)
           else
             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),
@@ -165,12 +163,12 @@ 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 ||= begin
+      def collect_models
+        @collect_models ||= begin
           all_models = ActiveRecord::Base.descendants
 
           if options[:include_only_models].present?
@@ -179,10 +177,10 @@ module Seedie
 
           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
+              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

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

@@ -4,5 +4,19 @@ Seedie.configure do |config|
   # config.default_count = 10
 
   config.custom_attributes[:email] = "{{Faker::Internet.unique.email}}"
+  # Model-Specific Custom Attributes
+  #
+  # Use the prepare_custom_attributes_for method to initialize the custom_attributes hash
+  # for the specified models. This ensures that you can safely set model-specific custom
+  # attributes without encountering NoMethodError.
+  #
+  # Example:
+  # config.prepare_custom_attributes_for :user, :account
+  #
+  # Now you can set custom attributes for these models:
+  # config.custom_attributes[:user][:email] = "user@example.com"
+  # config.custom_attributes[:account][:name] = "{{Faker::Business.name}}"
+  #
   # Add more custom attributes here
-end
+  #
+end

data/lib/seedie/associations/base_association.rb

@@ -1,44 +1,48 @@
+# frozen_string_literal: true
+
 module Seedie
-  class BaseAssociation
-    include Reporters::Reportable
-    
-    DEFAULT_COUNT = 1
-    INDEX = 0
+  module Associations
+    class BaseAssociation
+      include Reporters::Reportable
 
-    attr_reader :record, :model, :association_config, :reporters
+      DEFAULT_COUNT = 1
+      INDEX = 0
 
-    def initialize(record, model, association_config, reporters = [])
-      @record = record
-      @model = model
-      @association_config = association_config
-      @reporters = reporters
+      attr_reader :record, :model, :association_config, :reporters
 
-      add_observers(@reporters)
-    end
+      def initialize(record, model, association_config, reporters = [])
+        @record = record
+        @model = model
+        @association_config = association_config
+        @reporters = reporters
 
-    def generate_associations
-      raise NotImplementedError
-    end
+        add_observers(@reporters)
+      end
 
-    def generate_association
-      raise NotImplementedError
-    end
+      def generate_associations
+        raise NotImplementedError
+      end
 
-    private
+      def generate_association
+        raise NotImplementedError
+      end
 
-    def get_association_count(config)
-      return config if only_count_given?(config)
-      return config["count"] if config["count"].present?
+      private
 
-      DEFAULT_COUNT
-    end
+      def get_association_count(config)
+        return config if only_count_given?(config)
+        return config["count"] if config["count"].present?
 
-    def only_count_given?(config)
-      config.is_a?(Numeric) || config.is_a?(String)
-    end
+        DEFAULT_COUNT
+      end
+
+      def only_count_given?(config)
+        config.is_a?(Numeric) || config.is_a?(String)
+      end
 
-    def generate_associated_field(id, association_name)
-      { "#{association_name}" => id }
+      def generate_associated_field(id, association_name)
+        { association_name.to_s => id }
+      end
     end
   end
-end
+end

data/lib/seedie/associations/belongs_to.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Seedie
   module Associations
     class BelongsTo < BaseAssociation
@@ -11,7 +13,7 @@ module Seedie
 
       def generate_associations
         return if association_config["belongs_to"].nil?
-        
+
         report(:belongs_to_start)
 
         association_config["belongs_to"].each do |association_name, association_config|
@@ -29,7 +31,7 @@ module Seedie
 
       private
 
-      def handle_association_config_type(reflection, association_name, association_config)
+      def handle_association_config_type(reflection, _association_name, association_config)
         if reflection.polymorphic?
           handle_polymorphic_config_type(reflection, association_config)
         else
@@ -38,7 +40,6 @@ module Seedie
           handle_strategy(klass, reflection, strategy)
         end
       end
-      
 
       def handle_polymorphic_config_type(reflection, association_config)
         type_name = get_polymorphic_class_name(association_config["polymorphic"])
@@ -48,7 +49,7 @@ module Seedie
 
         handle_strategy(klass, reflection, strategy)
       end
-      
+
       # Handles the strategy for belongs_to associations
       # For polymorphic reflection, we might not add a strategy
       # so we need to default it to random
@@ -89,27 +90,25 @@ module Seedie
 
       def handle_new_config_type(klass, reflection)
         report(:belongs_to_associations, name: klass.to_s, parent_name: model.to_s)
-            
+
         new_associated_record = generate_association(klass, {}, INDEX)
         associated_field_set.merge!(generate_associated_field(new_associated_record.id, reflection.foreign_key))
       end
 
       def handle_other_config_type(klass, reflection, association_config)
         report(:belongs_to_associations, name: klass.to_s, parent_name: model.to_s)
-            
+
         new_associated_record = generate_association(klass, association_config, INDEX)
         associated_field_set.merge!(generate_associated_field(new_associated_record.id, reflection.foreign_key))
       end
 
       def get_type(association_config)
-        if association_config.is_a?(String)
-          raise InvalidAssociationConfigError, "Invalid association config" unless ["random", "new", "unique"].include?(association_config)
-
-          return association_config
-        else
-          association_config
+        if association_config.is_a?(String) && !%w[random new unique].include?(association_config)
+          raise InvalidAssociationConfigError, "Invalid association config"
         end
+
+        association_config
       end
     end
   end
-end
+end