application_seeds 0.4.3 → 0.5.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+v0.5.0, 2014-02-28
+------------------
+
+  * Added support for config values.
+
+
 v0.4.3, 2014-02-22
 ------------------
 

data/README.md

@@ -322,6 +322,56 @@ specified.
 See `spec/seed_data/test_data_set` for more examples of seed data files.
 
 
+## Config Values
+
+Since the YAML files are first run through ERB, you are able to sprinkle
+ruby code throughout your seed data files.  This allows you to do some
+interesting things:
+
+```ruby
+<% 10.times do |x| %>
+company_<%= x %>:
+  name: Company_<%= x %>
+<% end %>
+```
+
+But `10` here is a magic number.  It would be better if we had a
+variable that better communicated its use.
+
+`ApplicationSeeds` allows you to place a `_config.yml` file in each
+dataset directory.  The data in this file is loaded, and made available
+via the `ApplicationSeeds.config_value` API.
+
+Take the following `_config.yml`:
+
+```ruby
+num_companies: 5
+num_people: 1
+num_departments: 3
+```
+
+You can fetch these values by calling `ApplicationSeeds.config_value`:
+
+```ruby
+ApplicationSeeds.config_value(:num_companies)
+=> 5
+
+ApplicationSeeds.config_value(:num_people)
+=> 1
+
+ApplicationSeeds.config_value(:num_departments)
+=> 3
+```
+
+### Merging config value files
+
+If you are using nested datasets, then all of the appropriate
+`_config.yml` files will be loaded, and all data in those files
+will be available. Config values defined in the lower levels
+are given precedence if there is a naming conflict, allowing the
+lower levels to override values specified in the upper levels.
+
+
 ## Configuration
 
 The `ApplicationSeeds` module can generate integer or UUID ids.  You can
@@ -504,6 +554,17 @@ are unable to insert new data into the databse after your dataset has
 been imported, then this should correct them.
 
 
+### Fetch data from the `_config.yml` files
+
+```ruby
+ApplicationSeeds.config_value(:foo)
+```
+
+Fetch the value for the key named `foo` that is defined in the
+`_config.yml` config values files.  Will return nil if no config value
+could be found by that name.
+
+
 ## The Problem
 
 Applications in a service oriented architecture (SOA) are often

data/lib/application_seeds/version.rb

@@ -1,3 +1,3 @@
 module ApplicationSeeds
-  VERSION = "0.4.3"
+  VERSION = "0.5.0"
 end

data/lib/application_seeds.rb

@@ -10,74 +10,10 @@ require "application_seeds/database"
 require "application_seeds/version"
 require "application_seeds/attributes"
 
-# A library for managing a standardized set of seed data for applications in a non-production environment.
-#
-# == The API
-#
-# === Fetching all seeds of a given type
-#
-#   ApplicationSeeds.campaigns  # where "campaigns" is the name of the seed file
-#
-# This call returns a hash with one or more entries (depending on the contentes of the seed file).
-# The IDs of the object are the keys, and a hash containing the object's attributes are the values.
-# An exception is raised if no seed data could be with the given name.
-#
-# === Fetching seed data by label
-#
-#   ApplicationSeeds.campaigns(:label)  # where "campaigns" is the name of the seed file, and :label is the label of the campaign
-#
-# This call returns a hash containing the object's attributes.  An exception is raised if no
-# seed data could be found with the given label.
-#
-# === Fetching seed data by id
-#
-#   ApplicationSeeds.campaigns(12345)  # where "campaigns" is the name of the seed file, and 12345 is the id of the campaign
-#
-# This call returns a hash containing the object's attributes.  An exception is raised if no
-# seed data could be found with the given id.
-#
-# === Fetching seed data by some other attribute
-#
-#   ApplicationSeeds.campaigns(foo: 'bar', name: 'John')  # where "campaigns" is the name of the seed file
-#
-# This call returns the seed data that contains the specified attributes,
-# and the specified attribute values.  It returns a hash with zero or more
-# entries.  The IDs of the object are the keys of the hash, and a hash
-# containing the object's attributes are the values.  Any empty hash will
-# be returned if no seed data could be found with the given attribute names
-# and values.
-#
-# === Creating an object
-#
-#   ApplicationSeeds.create_object!(Campaign, id, attributes)
-#
-# This call will create a new instance of the <tt>Campaign</tt> class, with the
-# specified id and attributes.
-#
-# === Rejecting specific attributes
 #
-#   ApplicationSeeds.create_object!(Campaign, id, attributes.reject_attributes(:unused_attribute))
-#
-# This call will create a new instance of the <tt>Campaign</tt> class without the
-# <tt>unused_attribute</tt> attribute.
-#
-# === Selecting specific attributes
-#
-#   ApplicationSeeds.create_object!(Campaign, id, attributes.select_attributes(:attribute1, :attribute2))
-#
-# This call will create a new instance of the <tt>Campaign</tt> class with only the
-# <tt>attribute1</tt> and <tt>attribute2</tt> attributes.
-#
-# === Mapping attribute names
-#
-#   ApplicationSeeds.create_object!(Campaign, id, attributes.map_attributes(
-#     :old_name1 => :new_name1, :old_name2 => :new_name2))
+# A library for managing a standardized set of seed data for applications in a non-production environment.
 #
-# This call will create a new instance of the <tt>Campaign</tt> class, using the
-# seed data for old_name1 as the attribute value for new_name1, and the
-# seed data for old_name2 as the attribute value for new_name2.  This
-# method let's you easly account for slight differences is attribute names
-# across applications.
+# See README.md for API documentation.
 #
 module ApplicationSeeds
   class << self
@@ -97,6 +33,13 @@ module ApplicationSeeds
       @_config ||= { :id_type => :integer }
     end
 
+    #
+    # Fetch data from the _config.yml files.
+    #
+    def config_value(key)
+      config_values[key.to_s]
+    end
+
     #
     # Specify the name of the gem that contains the application seed data.
     #
@@ -199,7 +142,7 @@ module ApplicationSeeds
     # been imported, then this should correct them.
     #
     def reset_sequence_numbers
-      result = Database.connection.exec("SELECT table_name FROM information_schema.tables WHERE table_schema = 'public';")
+      result = Database.connection.exec("SELECT table_name FROM information_schema.tables WHERE table_schema NOT IN ('pg_catalog', 'information_schema')")
       table_names = result.map { |row| row.values_at('table_name')[0] }
 
       table_names_with_id_column = table_names.select do |table_name|
@@ -244,7 +187,8 @@ module ApplicationSeeds
       @seed_data_files = []
       path = dataset_path(@dataset)
       while (seed_data_path != path) do
-        @seed_data_files.concat(Dir[File.join(path, "*.yml")])
+        files = Dir[File.join(path, "*.yml")].reject { |file| file =~ /\/_config.yml$/ }
+        @seed_data_files.concat(files)
         path.sub!(/\/[^\/]+$/, "")
       end
       @seed_data_files
@@ -263,6 +207,20 @@ module ApplicationSeeds
       @raw_seed_data
     end
 
+    def config_values
+      return @config_values unless @config_values.nil?
+
+      @config_values = {}
+      path = dataset_path(@dataset)
+      while (seed_data_path != path) do
+        config_file = Dir[File.join(path, "_config.yml")].first
+        values = config_file.nil? ? {} : YAML.load(ERB.new(File.read(config_file)).result)
+        @config_values = values.merge(@config_values)
+        path.sub!(/\/[^\/]+$/, "")
+      end
+      @config_values
+    end
+
     def seed_labels
       return @seed_labels unless @seed_labels.nil?
 
@@ -428,6 +386,7 @@ module ApplicationSeeds
       @processed_seed_data = nil
       @raw_seed_data = nil
       @seed_data_files = nil
+      @config_values = nil
     end
   end
 end

data/spec/application_seeds_spec.rb

@@ -237,6 +237,16 @@ describe "ApplicationSeeds" do
         end
       end
     end
+
+    describe "config values" do
+      it "can fetch config values for the dataset" do
+        expect(ApplicationSeeds.config_value(:num_companies)).to eql(15)
+        expect(ApplicationSeeds.config_value(:num_people)).to eql(100)
+      end
+      it "returns nil if no config value could be found by that name" do
+        expect(ApplicationSeeds.config_value(:whaa)).to be_nil
+      end
+    end
   end
 
   describe "with a nested dataset" do
@@ -283,6 +293,16 @@ describe "ApplicationSeeds" do
         expect(person['first_name']).to eql("Ken")
       end
     end
+
+    describe "merging config values" do
+      it "can merge data from different levels" do
+        expect(ApplicationSeeds.config_value(:num_companies)).to eql(5)
+        expect(ApplicationSeeds.config_value(:num_departments)).to eql(3)
+      end
+      it "gives the data in lower levels precendence" do
+        expect(ApplicationSeeds.config_value(:num_people)).to eql(10)
+      end
+    end
   end
 
   describe "with UUIDs configured for all seed types" do

data/spec/seed_data/test_data_set/_config.yml

@@ -0,0 +1,2 @@
+num_companies: 15
+num_people: 100

data/spec/seed_data/test_inheritable_data_set/_config.yml

@@ -0,0 +1,3 @@
+num_companies: 5
+num_people: 1
+num_departments: 3

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

@@ -0,0 +1,2 @@
+num_companies: 5
+num_people: 10

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: application_seeds
 version: !ruby/object:Gem::Version
-  version: 0.4.3
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-22 00:00:00.000000000 Z
+date: 2014-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,11 +98,14 @@ files:
 - lib/application_seeds/version.rb
 - spec/application_seeds_spec.rb
 - spec/attributes_spec.rb
+- spec/seed_data/test_data_set/_config.yml
 - 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/_config.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/_config.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
@@ -118,12 +121,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 632668571274566106
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 632668571274566106
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -134,11 +143,13 @@ summary: A library for managing a standardized set of seed data for applications
 test_files:
 - spec/application_seeds_spec.rb
 - spec/attributes_spec.rb
+- spec/seed_data/test_data_set/_config.yml
 - 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/_config.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/_config.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
-has_rdoc: