seedgen 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c656032481489823a64542f0f864d64c8874d6156d1f17664f1770b2e945027
-  data.tar.gz: ff0b902ea7ef8a597732a957d214fa6f80d0a40b1993da7b7e4c994810336866
+  metadata.gz: ad6fae3db4e47667a9813436800e355f26037c5ed8d1d4ae5b12681303191c1f
+  data.tar.gz: 7f47ad19983eb6adcef7711f35b9a36a62028486f80a77065b17fa273af704fe
 SHA512:
-  metadata.gz: cb9c89738160a21995a42560e070c4ed7ee8a5f3ef9173096217a3cefca5dc006ccdf2048a8d19a2e6baea572af896e892ad81c82d448692826558cb414b57a3
-  data.tar.gz: 988d86cacea68dd32c98415268f1f271fb8c5f5c3e863d44dace229ae02f25fb962b19d01aae5984183bd2e9669ccc1f728fd095a51213601fcb2387371411cb
+  metadata.gz: 255cf01b72f3c71bb6725300e36dba5955a7bf576f9a9bbd4ebdcd810c4389af9f94f0e75468cb3660ab4559a1230cfca62bd6d9903aa98f4afd2364ad9b7778
+  data.tar.gz: 44b25ebd9032567e23871942c8e6018cb7a784628b9959928ccd117101fcf88ff7a5076fc3192293c9ef9195814dd9940c23c7a5861af0d177bd8638a5bbab66

data/README.md

@@ -1,26 +1,28 @@
 # SeedGen
-Generate seed files based on your schema.
+Generate seed files based on your Rails models and schema.
 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "seedgen", "~> 0.0.3"
+gem "seedgen", "~> 0.0.4"
 ```
 
 ## Usage
-SeedGen hooks in to your models and their relationships to build you a seed file. After installation,
-run: 
+SeedGen hooks into your models to build you a seed file. After installation, run: 
 
 ```bash
 SEED=1 rails db:schema:load
 ```
 
-The above command generates `db/seedgen.rb` and seeds your database with the output of this new file based on your schema/models.
+The above command generates `db/seedgen.rb` with a scaffold of all of your models and a line for each that will create the record in your db. 
+SeedGen attempts to create a model tree and will write to the file in the order of Root -> Child. This is so that when you run your seed file, 
+you won't run into any issues with relationships. For example, you may have a `Post` model that `belongs_to: user`. If the seed file attempts to create
+a `Post` before its associated `User` is created, it'll obviously raise an error and crash.
 
 Note: You may notice SeedGen missing some of your models. If this is the case, it is because
 your application needs to eager load its classes for SeedGen to see them. 
-In `config/application.rb`, add:
+In `config/application.rb`, add the below block in your test env:
 
 ```ruby
 config.after_initialize do
@@ -28,4 +30,23 @@ config.after_initialize do
 end
 ```
 
-and rerun `SEED=1 rails db:schema:load`.
+and rerun `SEED=1 rails db:schema:load`.
+
+## Running the seed file
+At the moment, `seedgen` doesn't provide you with a rake task to run this seed file. So, for now, you'll have to either 1) copy 
+the contents of `seedgen.rb` into your `seed.rb` file, or create your own rake task in `lib/tasks`. Note: this is a high priority
+issue.
+
+## Example output of seeds/seedgen.rb
+
+Let's imagine you have a database with two tables: `posts` & `users`. SeedGen will create the following order-specific seed file.
+
+```ruby
+# TODO: Add any code that needs to run before data is created.
+
+User.create!(first_name: 'temgcpr', last_name: 'cuqoghi', email: 'zrcpqhn', password: 'ophpnxy')
+
+Post.create!(title: 'vurkcff', body: 'morph back-end initiatives', status: 2, user_id: 1)
+
+# TODO: Add any code that needs to run after data is created.
+```

data/lib/seedgen/version.rb

@@ -1,3 +1,3 @@
 module SeedGen
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/seedgen.rb

@@ -9,23 +9,54 @@ module SeedGen
 
   def self.run
     @models = Database.models || []
-    @seeded_models = []
+    @scaffold = {}
+    @scaffolded_models = []
 
+    build_scaffold
+  end
+
+  def self.build_scaffold
     @models.each do |model|
-      seed(model)
-      @seeded_models << model
+      scaffold_model(model)
+      @scaffolded_models << model
     end
 
-    puts database_seeded?
+    if database_scaffolded?
+      write_scaffold_to_file
+    end
   end
 
-  def self.seed(model)
+  def self.write_scaffold_to_file
+    Dir.mkdir("db/seeds") unless File.exist?("db/seeds")
+    File.open("db/seeds/seedgen.rb", "w") do |file|
+      file.write("# TODO: Add any code that needs to run before data is created.\n\n")
+
+      @scaffold.each do |key, value|
+        create_model = "#{key}.create!("
+        attrs = []
+        value.each do |attr, v|
+          if v.is_a? String
+            attrs << "#{attr}: '#{v}'"
+          else
+            attrs << "#{attr}: #{v}"
+          end
+        end
+
+        create_model += "#{attrs.join(', ')})\n\n"
+        file.write(create_model)
+      end
+
+      file.write("# TODO: Add any code that needs to run after data is created.\n\n")
+    end
+  end
+
+  def self.scaffold_model(model)
     parents = parents(model)
     if parents.empty?
-      create_record(model)
+      write_to_scaffold(model)
     else
       parents.each do |parent|
-        seed(parent)
+        scaffold_model(parent)
       end
     end
   end
@@ -47,22 +78,21 @@ module SeedGen
     nonpersisted_parents
   end
 
-  def self.create_record(model)
-    puts "===================="
-    puts "Creating: #{model}"
+  def self.write_to_scaffold(model)
     attributes = attrs(model)
     parents = []
+
     model.reflect_on_all_associations(:belongs_to).each do |assoc|
       parents << assoc.name.to_s
     end
 
     unless parents.empty?
       parents.each do |parent|
-        attributes.merge!({ parent.to_sym => Object.const_get(parent.capitalize).first })
+        attributes.merge!({ "#{parent}_id" => 1 })
       end
     end
 
-    model.create!(attributes)
+    @scaffold[model] = attributes
   end
 
   def self.attrs(model)
@@ -78,8 +108,7 @@ module SeedGen
     data
   end
 
-  # TODO: validate that all records have been created
-  def self.database_seeded?
-    @models == @seeded_models
+  def self.database_scaffolded?
+    @models == @scaffolded_models
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: seedgen
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Austin Wasson