colonization 0.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9907296322411ab264d5463c48bd55edfc83d5a
-  data.tar.gz: a7a487a862999ce8e6b35db4a32dec3b0fcf55ce
+  metadata.gz: 8568fe85422ca7740126206b7df754c16391c5cb
+  data.tar.gz: f89833d1ca93b44256b46bd3e4e0343dcdd354c0
 SHA512:
-  metadata.gz: ad86fc64496fac7815bab8ff3953c3611d78e866dd6cbefdd212db619e56113d0597884ee7b1a9c99544b4a3d1dd25f423623a78aaf6421125f8c1d161e3b06b
-  data.tar.gz: 78e4eaa67eaab63afaff5da1053b0984b937581c01f6ff7684bdaab3187b0d73c34b4bf258a69ce32196b461a774b447aa5797ca624c5de546cf947ae36dc11c
+  metadata.gz: 66e0cd1d5896ca41c8e4c300db442cb2c2ed45c8a259af87ed238c409230acd946e81940d38349ac008ffbe7db79e745b8f6d657539f3644a93cdb5e2418add2
+  data.tar.gz: 0805aa28b92176fc9ef77cc9a9d1579a7b72d7eddbca410aa5a3c3717ad88200c59c35a12c58fe87f5025916e50dfc81608c6ccf704339c8bcd481789afdbb38

data/README.md

@@ -1,8 +1,6 @@
 # Colonization
 
-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/colonization`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Gem for development database populating. Data seeding regarding to your models fields, their types and validations. It is in development now - only presence and acceptance validations currently supported.
 
 ## Installation
 
@@ -22,15 +20,52 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Add then following to seeds.rb file:
+
+```ruby
+Colonization::Ship.new.colonize
+```
+That's all!
+
+## Customization
+
+Add colonization.rb file to your initializers:
+
+```ruby
+Colonization.configure do |config|
+  config.something = :something
+  config.seed_type = :default
+  config.seed_index = 4
+  config.count_of_instances_to_seed = 10
+  config.clear_table = true
+end
+```
+
+List of currently allowed configurations:
+
+  seed_type:
+
+  currently 2 seed strategies are supported  - :fixed and :default. Fixed strategy seeding fixed count of
+  instances(user will be able to customize this for each model, it is in development now), by default it is 100. Default strategy populates database according to other configuration setting - :seed_index.  By this strategy count of model instances will increase by geometric progression(from parent models to dependent), by default - 3.
+
+  seed_index:
+  by default: 3
+
+  index according to model instances count increase(from parent model to child). E.g. Client has_many orders. With seed_index = 3 Client will have 100 instances, Order - up to 300
+  It is used only by default seed strategy
+
+  count_of_instances_to_seed:
+  by_default: 100
+
+  Used by both strategies. For fixed strategy it means - accurate number of instances to create, for default strategy - instances count for top level model
 
-## Development
+  clear_table:
+  by_default: true
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+  Clear or not table before seeding
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/colonization.
+Bug reports and pull requests are welcome on GitHub at https://github.com/dongan2010/colonization.
 

data/lib/colonization/version.rb

@@ -1,3 +1,3 @@
 module Colonization
-  VERSION = "0.3"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: colonization
 version: !ruby/object:Gem::Version
-  version: '0.3'
+  version: 0.3.1
 platform: ruby
 authors:
 - Denys Dvoriashyn