auto_seed 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 570a80405f90bdf4c8b3aa55314ef5ec3388507c29cd8aa353ab4e82beec1cfc
-  data.tar.gz: fcf0e87251ab915a047808aa55aa11780ff75c84f251d66e7825550556aedf83
+  metadata.gz: fcbda2a17e35171f9bf903093b8d32dd0fed8e7ae289f092edee39ebbf7e5e20
+  data.tar.gz: 38e0d57abbbde6e0cec647c4008fae09b1f06f99b3f12999553920a74989b892
 SHA512:
-  metadata.gz: 9044caea2f2c2866202b65515de9db6bab7452bccb32a5f8710fcb516dd74f5d529523d2c50527ae7d5cf63848250f6f74a962d86face3350a569e4f2415dfca
-  data.tar.gz: 3217d78dc3e51e06cda25a317ca1690c0e186c8af8476a423e3971eb81b4612c0d74183ef710bbf8c56cc1a6af0adb36100a46256a9a5e642eced50683bf143f
+  metadata.gz: 301efb1abe01e3ea3927bd1a69588fb179b1a11ecfdeb77e1b4622e22f9bf1140d158db0798d0b710ac9525a922d3d90716c4a23b317c6221d5775c1c5e10342
+  data.tar.gz: a0c2010af1460f10f27f1fd4fc068490b180e2a938404d21c1ae79255207420aa9ee5ad98f42ef320e8cb27a2955c4e22f0b7ea557b460b8ad17c34fd4632217

data/README.md

@@ -1,39 +1,140 @@
 # AutoSeed
 
-TODO: Delete this and the text below, and describe your gem
+AutoSeed is a Ruby on Rails gem that uses schema comments in the model to automatically generate seed files by running a rake task.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/auto_seed`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Features
+
+- Automatically generates seed data based on your Rails models and their schema comments.
+- Handles various associations, including `has_many`, `belongs_to`, `has_one`, and polymorphic associations.
+- Provides an easy-to-use rake task for seed generation.
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'auto_seed'
+```
 
-Install the gem and add to the application's Gemfile by executing:
+And then execute:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+bundle install
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Or install it yourself as:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+gem install auto_seed
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+To generate the seed file, run the following rake task:
+
+```
+rails db:generate_seeds
+```
+
+This will create or overwrite the db/seeds.rb file with seed data based on your application's models and their associations.
+
+## Example
+
+Assume you have the following models:
+
+```
+class User < ApplicationRecord
+  has_many :posts
+end
+
+class Post < ApplicationRecord
+  belongs_to :user
+  has_many :comments, as: :commentable
+end
+
+class Comment < ApplicationRecord
+  belongs_to :commentable, polymorphic: true
+end
+```
+
+Running the `rails db:generate_seeds` task will generate a `db/seeds.rb` file similar to the following:
+
+```
+## User seeds
+User.create!(
+  id: 'sample_value',
+  name: 'sample_value',
+  email: 'sample_value',
+  created_at: 'sample_value',
+  updated_at: 'sample_value',
+  posts: [Post.create!(...)],
+);
+
+## Post seeds
+Post.create!(
+  id: 'sample_value',
+  title: 'sample_value',
+  content: 'sample_value',
+  created_at: 'sample_value',
+  updated_at: 'sample_value',
+  user: User.first,
+  comments: [Comment.create!(...)],
+);
+
+## Comment seeds
+Comment.create!(
+  id: 'sample_value',
+  content: 'sample_value',
+  created_at: 'sample_value',
+  updated_at: 'sample_value',
+  commentable_type: 'Post',
+  commentable_id: Post.first.id,
+);
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+To install this gem onto your local machine, run:
+
+```
+bundle exec rake install
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To release a new version, update the version number in version.rb, and then run:
+
+```
+bundle exec rake release
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/auto_seed. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/auto_seed/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/your_username/auto_seed.
+
+Fork it (https://github.com/your_username/auto_seed/fork)
+
+Create your feature branch (git checkout -b my-new-feature)
+
+Commit your changes (git commit -am 'Add some feature')
+
+Push to the branch (git push origin my-new-feature)
+
+Create a new Pull Request
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+This project is licensed under the MIT License - see the LICENSE file for details.
+
+Acknowledgments
+Special thanks to all contributors and the open-source community.
+
+## Explanation:
 
-## Code of Conduct
+1. **Features**: Lists what the gem can do.
+2. **Installation**: Provides instructions for adding the gem to a Rails project.
+3. **Usage**: Explains how to use the rake task to generate seed files.
+4. **Example**: Demonstrates an example output of the generated seeds file.
+5. **Development**: Describes how to install the gem locally and release a new version.
+6. **Contributing**: Provides guidelines for contributing to the project.
+7. **License**: Mentions the project’s license.
 
-Everyone interacting in the AutoSeed project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/auto_seed/blob/main/CODE_OF_CONDUCT.md).
+Make sure to replace placeholders such as `your_username` with your actual GitHub username and adjust any other project-specific details as needed.

data/lib/auto_seed/seeder.rb

@@ -1,38 +1,26 @@
 module AutoSeed
   class Seeder
+    DEVISE_COLUMNS = %w[
+      last_sign_in_at current_sign_in_at last_sign_in_ip current_sign_in_ip
+      encrypted_password reset_password_token reset_password_sent_at
+      remember_created_at sign_in_count
+    ].freeze
+
     def self.generate_seed_file
       File.open('db/seeds.rb', 'w') do |file|
         ActiveRecord::Base.descendants.each do |model|
-          next if model.name.in?(%w[ApplicationRecord ActiveRecord::Base]) # Skip base classes
+          next if skip_model?(model)
 
           file.puts "## #{model.name} seeds"
 
           begin
-            attributes = model.columns.reject { |col| col.name.in?(%w[ip_address current_sign_in_at]) }
+            attributes = fetch_attributes(model)
+            attribute_values = generate_attributes(attributes)
             file.puts "#{model.name}.create!("
+            attribute_values.each { |attr, value| file.puts "  #{attr}: #{value.inspect}," }
 
-            attributes.each do |attribute|
-              file.puts "  #{attribute.name}: 'sample_value',"
-            end
-
-            model.reflect_on_all_associations.each do |assoc|
-              case assoc.macro
-              when :has_many
-                file.puts "  #{assoc.name}: [#{assoc.klass}.create!(...)]"
-              when :belongs_to
-                file.puts "  #{assoc.name}: #{assoc.klass}.first"
-              when :has_one
-                file.puts "  #{assoc.name}: #{assoc.klass}.create!(...)"
-              when :has_many_attached
-                file.puts "  #{assoc.name}: [#{assoc.klass}.attach(...)]"
-              end
-
-              # Handle polymorphic associations
-              if assoc.polymorphic?
-                file.puts "  #{assoc.name}_type: '#{assoc.klass}',"
-                file.puts "  #{assoc.name}_id: #{assoc.klass}.first.id"
-              end
-            end
+            associations = handle_associations(model)
+            associations.each { |assoc| file.puts "  #{assoc[:name]}: #{assoc[:value]}," }
 
             file.puts ");"
           rescue StandardError => e
@@ -43,5 +31,80 @@ module AutoSeed
         end
       end
     end
+
+    private
+
+    def self.skip_model?(model)
+      model.name.in?(%w[ApplicationRecord ActiveRecord::Base])
+    end
+
+    def self.fetch_attributes(model)
+      model.columns.reject { |col| col.name.in?(DEVISE_COLUMNS + %w[ip_address current_sign_in_at]) }.map(&:name)
+    end
+
+    def self.generate_attributes(attributes)
+      attributes.each_with_object({}) do |attribute, hash|
+        hash[attribute] = generate_sample_value(attribute)
+      end
+    end
+
+    def self.generate_sample_value(attribute)
+      case attribute
+      when /_at$/
+        "'#{Time.now}'"
+      when /_on$/
+        "'#{Date.today}'"
+      when /date$/
+        "'#{Date.today}'"
+      else
+        "'sample_value'"
+      end
+    end
+
+    def self.handle_associations(model)
+      associations = []
+      model.reflect_on_all_associations.each do |association|
+        next if association.options[:optional]
+
+        case association.macro
+        when :has_many
+          associations.concat(handle_has_many_association(association))
+        when :belongs_to
+          associations.concat(handle_belongs_to_association(association))
+        when :has_one
+          associations.concat(handle_has_one_association(association))
+        when :has_many_attached
+          associations.concat(handle_has_many_attached_association(association))
+        end
+
+        if association.polymorphic?
+          associations.concat(handle_polymorphic_association(association))
+        end
+      end
+      associations
+    end
+
+    def self.handle_has_many_association(association)
+      [{ name: association.name, value: "[#{association.klass}.create!(...)]" }]
+    end
+
+    def self.handle_belongs_to_association(association)
+      [{ name: association.name, value: "#{association.klass}.first" }]
+    end
+
+    def self.handle_has_one_association(association)
+      [{ name: association.name, value: "#{association.klass}.create!(...)" }]
+    end
+
+    def self.handle_has_many_attached_association(association)
+      [{ name: association.name, value: "[#{association.klass}.attach(...)]" }]
+    end
+
+    def self.handle_polymorphic_association(association)
+      [
+        { name: "#{association.name}_type", value: "'#{association.klass}'" },
+        { name: "#{association.name}_id", value: "#{association.klass}.first.id" }
+      ]
+    end
   end
 end

data/lib/auto_seed/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auto_seed
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Shobhit Shukla