application_seeds 0.0.1 → 0.1.1

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+v0.1.0, 2013-12-13
+------------------
+
+  * Prevent the `application_seeds` table from showing up in a Rails
+    project's `schema.rb` file.
+
+
+v0.0.1, 2013-07-26
+------------------
+
+  * Initial release.
+

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 John Wood
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -6,33 +6,93 @@ in a non-production environment.
 
 ## Requirements
 
-* Postgresql - This library currently only works with the Postgresql
-database.
+* Rails
+* Postgresql (This library currently only works with the Postgresql database)
 
 
 ## Usage
 
 #### Include the gem in your Gemfile
 
-    group :development, :test, :integration, :staging do
+    group :development do
       gem 'application_seeds', :git => 'git@github.com:centro/application_seeds.git'
     end
 
+You should add this gem to any environment group that would need access
+to the seed data (like an "integration" environment, for example).
+
+
+#### Create a shared data set
+
+This library operates on a set of YAML files that represent your shared
+data set.  The dataset can be provided two different ways.
+
+##### Via a gem
+
+In order to easily share the seed data between apps, you can package
+the YAML files into a gem.  The gem should have the following directory
+structure:
+
+```
+lib
+ +-- seeds
+      |-- seed_data_set_1
+      |    |-- some_data.yml
+      |    +-- some_other_data.yml
+      +-- seed_data_set_2  
+           |-- some_data.yml
+           +-- some_other_data.yml
+```
+
+The gem may contain any number of datasets.  The above example has two datasets,
+`seed_data_set_1` and `seed_data_set_2`.  The YAML files are located in the
+dataset directories.
+
+You will need to include the gem containing your seed data in your `Gemfile`.
+
+Use the `data_gem_name` API method to specify where your seed data is located.
+
+```ruby
+ApplicationSeeds.data_gem_name = "my-seed-data-gem"
+```
+
+##### Via the filesystem
+
+The dataset may also exist on the filesystem.  The directory structure should
+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
+ |    |-- some_data.yml
+ |    +-- some_other_data.yml
+ +-- seed_data_set_2  
+      |-- some_data.yml
+      +-- some_other_data.yml
+```
+
+Use the `data_directory` API method to specify the path to your seed data on the filesystem.
+
+```ruby
+ApplicationSeeds.data_directory = "/path/to/seeds"
+```
 
 #### Create a rake task to create data model objects from the seed data
 
-**The application** needs to create objects from the common seed data.  To
-do this, the application will need to create Rake task (such as the one
-below) that reads the seed data, and uses it to create the objects in
+**The application** needs to create objects from the common seed data. To
+do this, you will need to create a Rake task (such as the one
+below) for your application that reads the seed data, and uses it to create the objects in
 the application's own data model.
 
 `ApplicationSeeds` provides an API to allow for the easy retrieveal of
-seed data.  See blow for more information about the API.
+seed data.  See below for more information about the API.
 
 ```ruby
 namespace :application_seeds do
   desc 'Dump the development database and load it with standardized application seed data'
   task :load, [:dataset] => ['db:drop', 'db:create', 'db:migrate', :environment] do |t, args|
+    ApplicationSeeds.data_gem_name = "my-seed-data-gem"
     ApplicationSeeds.dataset = args[:dataset]
 
     seed_campaigns
@@ -160,7 +220,7 @@ does not.
 ```ruby
 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.
@@ -260,7 +320,7 @@ another application, the key specified by the client must be in the server's
 data set, along with the other data associated with the key that the
 client is requesting.
 
-Often, each application will have its own, sioled seed data, making
+Often, each application will have its own, siloed seed data, making
 inter-app communication impossible.  In order to get all of the
 application data in sync, developers will often resort to populating
 their development databases with production data.  Production data on a
@@ -316,4 +376,3 @@ couple applications.  The goal of a service oriented
 architecture is to prevent this.  With great power comes great
 responsibility.  Carefully consider the trade offs any time you
 introduce an API call to fetch data from a remote service.
-

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/application_seeds.gemspec

@@ -11,6 +11,7 @@ Gem::Specification.new do |gem|
   gem.description   = %q{A library for managing standardized application seed data}
   gem.summary       = %q{A library for managing a standardized set of seed data for applications in a non-production environment}
   gem.homepage      = "https://github.com/centro/application_seeds"
+  gem.license       = 'MIT'
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

data/lib/application_seeds/attributes.rb

@@ -9,12 +9,12 @@ module ApplicationSeeds
 
     def select_attributes(*attribute_names)
       attribute_names.map!(&:to_s)
-      select { |k,v| attribute_names.include?(k) }
+      Attributes.new(select { |k,v| attribute_names.include?(k) })
     end
 
     def reject_attributes(*attribute_names)
       attribute_names.map!(&:to_s)
-      reject { |k,v| attribute_names.include?(k) }
+      Attributes.new(reject { |k,v| attribute_names.include?(k) })
     end
 
     def map_attributes(mapping)

data/lib/application_seeds/database.rb

@@ -18,6 +18,9 @@ module ApplicationSeeds
       end
 
       def create_metadata_table
+        if defined?(ActiveRecord)
+          ActiveRecord::SchemaDumper.ignore_tables = ["application_seeds"]
+        end
         connection.exec('DROP TABLE IF EXISTS application_seeds;')
         connection.exec('CREATE TABLE application_seeds (dataset varchar(255));')
       end

data/lib/application_seeds/version.rb

@@ -1,3 +1,3 @@
 module ApplicationSeeds
-  VERSION = "0.0.1"
+  VERSION = "0.1.1"
 end

data/lib/application_seeds.rb

@@ -126,9 +126,7 @@ module ApplicationSeeds
         raise error_message
       end
 
-      Database.create_metadata_table
-      Database.connection.exec("INSERT INTO application_seeds (dataset) VALUES ('#{dataset}');")
-
+      store_dataset(dataset)
       @dataset = dataset
     end
 
@@ -251,5 +249,10 @@ module ApplicationSeeds
       Attributes.new(data)
     end
 
+    def store_dataset(dataset)
+      Database.create_metadata_table
+      Database.connection.exec("INSERT INTO application_seeds (dataset) VALUES ('#{dataset}');")
+    end
+
   end
 end

data/spec/application_seeds_spec.rb

@@ -1,5 +1,14 @@
 require 'application_seeds'
 
+class Person
+  attr_accessor :attributes, :id, :saved
+  attr_accessor :first_name, :last_name, :company_id, :start_date
+
+  def save!(options={})
+    @saved = true
+  end
+end
+
 describe "ApplicationSeeds" do
   before do
     ApplicationSeeds.data_directory = File.join(File.dirname(__FILE__), "seed_data")
@@ -80,4 +89,78 @@ describe "ApplicationSeeds" do
     end
   end
 
+  context "with a valid dataset" do
+    before do
+      ApplicationSeeds.stub(:store_dataset)
+      ApplicationSeeds.dataset = "test_data_set"
+    end
+
+    describe "#create_object" do
+      before do
+        @attributes = ApplicationSeeds.people(1)
+        @object = ApplicationSeeds.create_object!(Person, @attributes['id'], @attributes)
+      end
+      it "assigns the id" do
+        @object.id.should == 1
+      end
+      it "assigns the attributes" do
+        @object.attributes.should == @attributes.reject { |k,v| k == "bogus_attribute" }
+      end
+      it "saves the object in the database" do
+        @object.saved.should be_true
+      end
+    end
+
+    describe "fetching all seed data" do
+      before do
+        @people = ApplicationSeeds.people
+      end
+      it "returns all people" do
+        @people.size.should == 3
+      end
+      it "returns the attributes for each person" do
+        person = @people[2]
+        person['first_name'].should == "Jane"
+        person['last_name'].should == "Doe"
+      end
+    end
+
+    describe "fetching seed data by id" do
+      it "returns the attributes for each person" do
+        @person = ApplicationSeeds.people(2)
+        @person['first_name'].should == "Jane"
+        @person['last_name'].should == "Doe"
+      end
+      it "raises an error if no data could be found with the specified id" do
+        expect { ApplicationSeeds.people(404) }.to raise_error(RuntimeError)
+      end
+    end
+
+    describe "fetching seed data by property values" do
+      it "returns the found person" do
+        @people = ApplicationSeeds.people(:last_name => 'Walsh', :company_id => 2)
+        @people.size.should == 1
+        @people.values.first['first_name'].should == "John"
+        @people.values.first['last_name'].should == "Walsh"
+      end
+      it "returns multiple people if there are multiple matches" do
+        @people = ApplicationSeeds.people(:company_id => 1)
+        @people.size.should == 2
+        @people.values.first['first_name'].should == "Joe"
+        @people.values.last['first_name'].should == "Jane"
+      end
+      it "returns an empty hash if no matches could be found" do
+        @people = ApplicationSeeds.people(:last_name => '404')
+        @people.should == {}
+      end
+    end
+
+    describe "ERB" do
+      it "processes ERB snippets in the fixtures" do
+        @person = ApplicationSeeds.people(1)
+        @person['start_date'].should == 2.months.ago.to_date
+      end
+    end
+  end
+
 end

data/spec/attributes_spec.rb

@@ -0,0 +1,45 @@
+require 'application_seeds'
+
+describe "Attributes" do
+  before do
+    @attributes = ApplicationSeeds::Attributes.new("first_name" => "Billy",
+                                                   "last_name"  => "Bob",
+                                                   "occupation" => "Bus Driver")
+  end
+
+  describe "#select_attributes" do
+    before do
+      @selected_attributes = @attributes.select_attributes(:first_name, :occupation)
+    end
+    it "returns only the select attributes" do
+      @selected_attributes.should == { "first_name" => "Billy", "occupation" => "Bus Driver" }
+    end
+    it "returns a new instance of the Attributes class" do
+      @selected_attributes.is_a?(ApplicationSeeds::Attributes).should be_true
+    end
+  end
+
+  describe "#reject_attributes" do
+    before do
+      @rejected_attributes = @attributes.reject_attributes(:first_name, :last_name)
+    end
+    it "returns only the select attributes" do
+      @rejected_attributes.should == { "occupation" => "Bus Driver" }
+    end
+    it "returns a new instance of the Attributes class" do
+      @rejected_attributes.is_a?(ApplicationSeeds::Attributes).should be_true
+    end
+  end
+
+  describe "#map_attributes" do
+    before do
+      @mapped_attributes = @attributes.map_attributes(:first_name => :fname, :last_name => :lname)
+    end
+    it "returns only the select attributes" do
+      @mapped_attributes.should == { "fname" => "Billy", "lname" => "Bob", "occupation" => "Bus Driver" }
+    end
+    it "returns a new instance of the Attributes class" do
+      @mapped_attributes.is_a?(ApplicationSeeds::Attributes).should be_true
+    end
+  end
+end

data/spec/seed_data/test_data_set/people.yml

@@ -3,16 +3,19 @@
   last_name: Smith
   company_id: 1
   start_date: <%= 2.months.ago.to_date %>
+  bogus_attribute: foo
 
 - id: 2
   first_name: Jane
   last_name: Doe
   company_id: 1
   start_date: <%= 10.months.ago.to_date %>
+  bogus_attribute: foo
 
 - id: 3
   first_name: John
   last_name: Walsh
   company_id: 2
   start_date: <%= 10.years.ago.to_date %>
+  bogus_attribute: foo
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: application_seeds
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-26 00:00:00.000000000 Z
+date: 2013-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -83,7 +83,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - application_seeds.gemspec
@@ -93,9 +95,11 @@ files:
 - lib/application_seeds/database.rb
 - lib/application_seeds/version.rb
 - spec/application_seeds_spec.rb
+- spec/attributes_spec.rb
 - spec/seed_data/test_data_set/people.yml
 homepage: https://github.com/centro/application_seeds
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -108,7 +112,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2100833736178153226
+      hash: -2507870664277068952
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -117,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2100833736178153226
+      hash: -2507870664277068952
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -127,4 +131,5 @@ summary: A library for managing a standardized set of seed data for applications
   a non-production environment
 test_files:
 - spec/application_seeds_spec.rb
+- spec/attributes_spec.rb
 - spec/seed_data/test_data_set/people.yml