application_seeds 0.3.0 → 0.4.0

data/CHANGELOG.md

@@ -1,4 +1,11 @@
-v0.3.0, 2013-01-09
+v0.4.0, 2014-02-09
+------------------
+
+  * Added support for nested/inheritable datasets
+  * Warn user if `ApplicationSeeds.config=` is called after `ApplicationSeeds.dataset=`
+
+
+v0.3.0, 2014-01-09
 ------------------
 
   * Added support for Capistrano 3.x

data/README.md

@@ -34,12 +34,12 @@ the YAML files into a gem.  The gem should have the following directory
 structure:
 
 ```
-lib
- +-- seeds
-      |-- seed_data_set_1
+lib/
+ +-- seeds/
+      |-- seed_data_set_1/
       |    |-- some_data.yml
       |    +-- some_other_data.yml
-      +-- seed_data_set_2  
+      +-- seed_data_set_2/
            |-- some_data.yml
            +-- some_other_data.yml
 ```
@@ -63,11 +63,11 @@ be identical to what is described above in the "Via a gem" section, but the `lib
 diretory is not required.
 
 ```
-seeds
- |-- seed_data_set_1
+seeds/
+ |-- seed_data_set_1/
  |    |-- some_data.yml
  |    +-- some_other_data.yml
- +-- seed_data_set_2  
+ +-- seed_data_set_2/
       |-- some_data.yml
       +-- some_other_data.yml
 ```
@@ -160,6 +160,65 @@ Then, you can seed a remote database by running the following:
     bundle exec cap <environment> deploy:application_seeds -s dataset=your_data_set
 
 
+## The Datasets
+
+The `application_seeds` library supports multiple datasets within the
+same source (place on the file system, gem, etc).  The user specifies
+which dataset to load when beginning to work with the seed data.
+
+    ApplicationSeeds.dataset = "my_data_set"
+
+### Nested Datasets
+
+Datasets can be structured so that child directories can inherit the
+seed data files that are stored in the parent directories.  For example,
+let's look at the following directory structure:
+
+```
+seeds/
+ +-- parent_data_set/
+      |-- companies.yml
+      +-- child_data_set/
+          |-- departments.yml
+          +-- grandchild_data_set/
+              +-- people.yml
+```
+
+In this example, if the `grandchild_data_set` is loaded, you will have
+access to the seed data files in `grandchild_data_set`,
+`child_data_set`, and `parent_data_set`.  Because of this, data from
+`people.yml`, `departments.yml`, and `companies.yml` can be loaded.
+
+If `child_data_set` is loaded, you will have access to the seed data
+files in `child_data_set` and `parent_data_set`, but **not**
+`grandchild_data_set`.  This includes the `departments.yml` and
+`companies.yml` data files.
+
+### Merging Data Files
+
+It is possible to have files for the same data type scattered throughout
+the dataset hierarchy.
+
+```
+seeds/
+ +-- parent_data_set/
+      |-- companies.yml
+      |-- people.yml
+      +-- child_data_set/
+          |-- departments.yml
+          |-- people.yml
+          +-- grandchild_data_set/
+              +-- people.yml
+```
+
+In this example, when data is loaded from the `people` dataset via call
+to `ApplicationSeeds.people`, then the result will contain the data from
+all three files.
+
+If the files contain conflicting labels, then precedence is given to
+data at the lowest level (`grandchild_data_set` in this example).
+
+
 ## The Seed Files
 
 The seed files contain the data that the Rake task works with to

data/lib/application_seeds.rb

@@ -86,6 +86,7 @@ module ApplicationSeeds
     # Specify any configuration, such as the type of ids to generate (:integer or :uuid).
     #
     def config=(config)
+      warn "WARNING!  Calling ApplicationSeeds.config= after dataset has been set (ApplicationSeeds.dataset=) may not produce expected results." unless @dataset.nil?
       @_config = config
     end
 
@@ -140,8 +141,8 @@ module ApplicationSeeds
     # the dataset could not be found.
     #
     def dataset=(dataset)
-      if dataset.nil? || dataset.strip.empty? || !Dir.exist?(File.join(seed_data_path, dataset))
-        datasets = Dir[File.join(seed_data_path, "*")].map { |x| File.basename(x) }.join(', ')
+      if dataset.nil? || dataset.strip.empty? || dataset_path(dataset).nil?
+        datasets = Dir[File.join(seed_data_path, "**", "*")].select { |x| File.directory?(x) }.map { |x| File.basename(x) }.join(', ')
 
         error_message =  "\nERROR: A valid dataset is required!\n"
         error_message << "Usage: bundle exec rake application_seeds:load[your_data_set]\n\n"
@@ -150,6 +151,7 @@ module ApplicationSeeds
       end
 
       store_dataset(dataset)
+      find_seed_data_files(dataset)
       process_labels(dataset)
       load_seed_data(dataset)
       @dataset = dataset
@@ -241,14 +243,19 @@ module ApplicationSeeds
 
     def load_seed_data(dataset)
       @seed_data = {}
-      seed_files(dataset).each do |seed_file|
+      @seed_data_files.each do |seed_file|
         basename = File.basename(seed_file, ".yml")
         data = YAML.load(ERB.new(File.read(seed_file)).result)
         if data
           data.each do |label, attributes|
             data[label] = replace_labels_with_ids(attributes)
           end
-          @seed_data[basename] = data
+
+          if @seed_data[basename].nil?
+            @seed_data[basename] = data
+          else
+            @seed_data[basename] = data.merge(@seed_data[basename])
+          end
         end
       end
     end
@@ -313,6 +320,10 @@ module ApplicationSeeds
       end
     end
 
+    def dataset_path(dataset)
+      Dir[File.join(seed_data_path, "**", "*")].select { |x| File.directory?(x) && File.basename(x) == dataset }.first
+    end
+
     def fetch(type, &block)
       result = {}
       @seed_data[type].each do |label, attrs|
@@ -350,11 +361,20 @@ module ApplicationSeeds
       Database.connection.exec("INSERT INTO application_seeds (dataset) VALUES ('#{dataset}');")
     end
 
+    def find_seed_data_files(dataset)
+      @seed_data_files = []
+      path = dataset_path(dataset)
+      while (seed_data_path != path) do
+        @seed_data_files.concat(Dir[File.join(path, "*.yml")])
+        path.sub!(/\/[^\/]+$/, "")
+      end
+    end
+
     def process_labels(dataset)
       return @seed_labels unless @seed_labels.nil?
 
       @seed_labels = {}
-      seed_files(dataset).each do |seed_file|
+      @seed_data_files.each do |seed_file|
         seed_type = File.basename(seed_file, ".yml")
         @seed_labels[seed_type] = {}
 
@@ -379,10 +399,6 @@ module ApplicationSeeds
       { :integer => id, :uuid => "00000000-0000-0000-0000-%012d" % id }
     end
 
-    def seed_files(dataset)
-      Dir[File.join(seed_data_path, dataset, "*.yml")]
-    end
-
     def id_type(type)
       self.config["#{type}_id_type".to_sym] || self.config[:id_type]
     end

data/lib/application_seeds/version.rb

@@ -1,3 +1,3 @@
 module ApplicationSeeds
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/spec/application_seeds_spec.rb

@@ -9,6 +9,24 @@ class Person
   end
 end
 
+class Company
+  attr_accessor :attributes, :id, :saved
+  attr_accessor :name
+
+  def save!(options={})
+    @saved = true
+  end
+end
+
+class Department
+  attr_accessor :attributes, :id, :saved
+  attr_accessor :name
+
+  def save!(options={})
+    @saved = true
+  end
+end
+
 describe "ApplicationSeeds" do
   before do
     ApplicationSeeds.data_directory = File.join(File.dirname(__FILE__), "seed_data")
@@ -219,8 +237,44 @@ describe "ApplicationSeeds" do
     end
   end
 
+  describe "with a nested dataset" do
+    before do
+      ApplicationSeeds.stub(:store_dataset)
+      ApplicationSeeds.dataset = "level_3"
+    end
+
+    describe "finding seed data" do
+      it "can find data at the root level" do
+        company = ApplicationSeeds.companies(:mega_corp)
+        expect(company['name']).to eql("Megacorp")
+      end
+      it "can find data at the middle level" do
+        department = ApplicationSeeds.departments(:engineering)
+        expect(department['name']).to eql("Engineering")
+      end
+      it "can find data at the lowest level" do
+        person = ApplicationSeeds.people(:joe_smith)
+        expect(person['first_name']).to eql("Joe")
+      end
+    end
+
+    describe "merging seed data" do
+      it "can merge data from different levels" do
+        person = ApplicationSeeds.people(:joe_smith)
+        expect(person['first_name']).to eql("Joe")
+        person = ApplicationSeeds.people(:sam_jones)
+        expect(person['first_name']).to eql("Sam")
+      end
+      it "gives the data in lower levels precendence" do
+        person = ApplicationSeeds.people(:ken_adams)
+        expect(person['first_name']).to eql("Ken")
+      end
+    end
+  end
+
   describe "with UUIDs configured for all seed types" do
     before do
+      ApplicationSeeds.instance_variable_set("@dataset", nil)
       ApplicationSeeds.stub(:store_dataset)
       ApplicationSeeds.config = { :id_type => :uuid }
       ApplicationSeeds.dataset = "test_data_set"
@@ -239,6 +293,7 @@ describe "ApplicationSeeds" do
 
   describe "with data type specific key types configured" do
     before do
+      ApplicationSeeds.instance_variable_set("@dataset", nil)
       ApplicationSeeds.stub(:store_dataset)
       ApplicationSeeds.config = { :id_type => :uuid, :companies_id_type => :integer }
       ApplicationSeeds.dataset = "test_data_set"

data/spec/seed_data/test_inheritable_data_set/companies.yml

@@ -0,0 +1,9 @@
+mega_corp:
+  name: Megacorp
+
+ma_and_pa:
+  name: Ma and Pa
+
+global_corp:
+  id: 123
+  name: Global Corp

data/spec/seed_data/test_inheritable_data_set/level_2/departments.yml

@@ -0,0 +1,7 @@
+engineering:
+  name: Engineering
+  people_ids: [joe_smith, jane_doe, john_walsh]
+
+sales:
+  name: Sales
+  employee_ids: "[sam_jones, ken_adams] (people)"

data/spec/seed_data/test_inheritable_data_set/level_2/level_3/people.yml

@@ -0,0 +1,26 @@
+joe_smith:
+  first_name: Joe
+  last_name: Smith
+  company_id: mega_corp
+  start_date: <%= 2.months.ago.to_date %>
+  bogus_attribute: foo
+
+jane_doe:
+  first_name: Jane
+  last_name: Doe
+  company_id: mega_corp
+  start_date: <%= 10.months.ago.to_date %>
+  bogus_attribute: foo
+
+john_walsh:
+  first_name: John
+  last_name: Walsh
+  company_id: ma_and_pa
+  start_date: <%= 10.years.ago.to_date %>
+  bogus_attribute: foo
+
+ken_adams:
+  first_name: Ken
+  last_name: Adams
+  employer_id: ma_and_pa (companies)
+  start_date: <%= 10.years.ago.to_date %>

data/spec/seed_data/test_inheritable_data_set/level_2/people.yml

@@ -0,0 +1,12 @@
+sam_jones:
+  id: 456
+  first_name: Sam
+  last_name: Jones
+  company_id: 123
+  start_date: <%= 10.years.ago.to_date %>
+
+ken_adams:
+  first_name: Kenneth
+  last_name: Adams
+  employer_id: ma_and_pa (companies)
+  start_date: <%= 10.years.ago.to_date %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: application_seeds
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-09 00:00:00.000000000 Z
+date: 2014-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -101,6 +101,10 @@ files:
 - spec/seed_data/test_data_set/companies.yml
 - spec/seed_data/test_data_set/departments.yml
 - spec/seed_data/test_data_set/people.yml
+- spec/seed_data/test_inheritable_data_set/companies.yml
+- spec/seed_data/test_inheritable_data_set/level_2/departments.yml
+- spec/seed_data/test_inheritable_data_set/level_2/level_3/people.yml
+- spec/seed_data/test_inheritable_data_set/level_2/people.yml
 homepage: https://github.com/centro/application_seeds
 licenses:
 - MIT
@@ -116,7 +120,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1780168384698824643
+      hash: 1911143344573555233
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -125,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1780168384698824643
+      hash: 1911143344573555233
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -139,3 +143,7 @@ test_files:
 - spec/seed_data/test_data_set/companies.yml
 - spec/seed_data/test_data_set/departments.yml
 - spec/seed_data/test_data_set/people.yml
+- spec/seed_data/test_inheritable_data_set/companies.yml
+- spec/seed_data/test_inheritable_data_set/level_2/departments.yml
+- spec/seed_data/test_inheritable_data_set/level_2/level_3/people.yml
+- spec/seed_data/test_inheritable_data_set/level_2/people.yml