built_in_data 0.0.2 → 0.1.0

data/README.rdoc

@@ -12,6 +12,7 @@ It allows developers to deliver, update, and destroy data that is stored in the
 Add *built_in_key* to your model:
 
     ruby script/rails generate migration AddBuiltInKeyToYourModel built_in_key:string
+    rake db:migrate
 
 Include *BuiltInData* in your model:
 
@@ -22,19 +23,19 @@ Include *BuiltInData* in your model:
 Setup your data:
 There are two methods to load data
 
-* assign to *built_in_data_attributes*
-    YourModel.built_in_data_attributes = {
+* Pass as a hash to load_built_in_data!
+    YourModel.load_built_in_data!({
       :glacier => {
         :name => 'Glacier National Park',
       },
-  
+
       :yellowstone => {
         :name => 'Yellowstone National Park',
       }
-    }
+    })
 
 
-* OR create a yaml load file in *db/built_in_data* with the name of the model (ie. national_parks.yml)
+* Create a yaml load file in *db/built_in_data* with the name of the model (ie. national_parks.yml), and load the data with `YourModel.load_built_in_data!` without any arguments.
 
     glacier:
       name: Glacier National Park
@@ -42,7 +43,3 @@ There are two methods to load data
     yellowstone:
      name: Yellowstone National Park
 
-
-Load the data with *load_built_in_data!*:
-
-    YourModel.load_built_in_data!

data/Rakefile

@@ -20,14 +20,12 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-
-
-
 Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
+  system 'cd test/dummy; rake db:setup; rake db:test:prepare; cd ../../'
   t.libs << 'lib'
   t.libs << 'test'
   t.pattern = 'test/**/*_test.rb'

data/lib/built_in_data/version.rb

@@ -1,3 +1,3 @@
 module BuiltInData
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/lib/built_in_data.rb

@@ -1,73 +1,44 @@
 module BuiltInData
-  # add built_in_key to your model
-  # generate migration AddBuiltInKeyToYourModel built_in_key:string
-  #
-  # require in your model
-  # require BuiltInData
-  #
-  # there are two methods to load data
-  # 1) assign built_in_data_attributes
-  # YourModel.built_in_data_attributes = {
-  #   :glacier => {
-  #     :name => 'Glacier National Park',
-  #   },
-  #   
-  #   :yellowstone => {
-  #     :name => 'Yellowstone National Park',
-  #   }
-  # }
-  #
-  # 2) create a yaml load file in db/built_in_data with the name of the model (ie. national_parks.yml)
-  # glacier:
-  #   name: Glacier National Park
-  # 
-  # yellowstone:
-  #  name: Yellowstone National Park
-  #
-  #
-  # call load_built_in_data! to load
-  # YourModel.load_built_in_data!
-  
   extend ActiveSupport::Concern
-  
+
   included do
     # all built in data objects should have a built_in_key, model objects without a key will not be modified or removed
     validates_uniqueness_of :built_in_key, :allow_nil => true
-    
+
     scope :built_in, :conditions => 'built_in_key IS NOT NULL'
   end
-  
+
   module ClassMethods
-    def load_built_in_data!
+    def load_built_in_data!(hash = nil)
+      objects_hash = prepare_objects_hash(hash)
       Array.new.tap do |updated_objects|
-        
-        built_in_data_attributes.each do |key, attributes|
+
+        objects_hash.each do |key, attributes|
           updated_objects << create_or_update!(key, attributes)
         end
-        
+
         # destroy any built_in objects that have been removed from built_in_data_attributes
         self.built_in.each do |object|
-          object.destroy unless built_in_data_attributes.has_key?(object.built_in_key)
+          object.destroy unless objects_hash.has_key?(object.built_in_key)
         end
       end
     end
-    
-    def built_in_data_attributes
-      @built_in_data_attributes ||= load_yaml_data
-    end
-    
-    def built_in_data_attributes=(attributes)
-      @built_in_data_attributes = (attributes.respond_to?(:with_indifferent_access) ? attributes.with_indifferent_access : attributes)
-    end
-    
-    
+
     #######
     private
     #######
-    
+
+    def prepare_objects_hash(hash)
+      return hash.nil? ? load_yaml_data : hash.with_indifferent_access
+    end
+
+    def load_yaml_data
+      YAML.load_file(Rails.root.join('db', 'built_in_data', "#{table_name}.yml"))
+    end
+
     def create_or_update!(key, attributes)
       attributes.merge!(:built_in_key => key.to_s)
-      
+
       object = find_by_built_in_key(key)
       if object
         object.update_attributes!(attributes)
@@ -76,9 +47,6 @@ module BuiltInData
         result = create!(attributes)
       end
     end
-    
-    def load_yaml_data
-      YAML.load_file(Rails.root.join('db', 'built_in_data', "#{table_name}.yml"))
-    end
+
   end
 end

data/test/built_in_data_test.rb

@@ -1,90 +1,71 @@
 require 'test_helper'
 
 class BuiltInDataTest < ActiveSupport::TestCase
-  
+  HASH_DATA = {
+    :test => {
+      :name => 'Yellowstone National Park',
+      :established => '1872-03-01',
+      :url => 'http://www.nps.gov/yell/index.htm'
+    }
+  }
+
   test "should load built in data" do
     assert_difference 'NationalPark.count' do
-      load_test_data
+      load_hash_data
     end
-    
+
     assert_equal 'Yellowstone National Park', NationalPark.find_by_built_in_key('test').name
   end
-  
+
   test "should remove built in data" do
-    load_test_data
-    NationalPark.built_in_data_attributes = {}
-    
+    load_hash_data
+
     assert_difference 'NationalPark.count', -1 do
-      NationalPark.load_built_in_data!
+      NationalPark.load_built_in_data!({})
     end
-    
+
     assert_nil NationalPark.find_by_built_in_key('test')
   end
-  
-  test "should not add or remove records" do
-    load_test_data
-    
-    assert_no_difference "NationalPark.count" do
-      NationalPark.load_built_in_data!
-    end
-  end
-  
+
   test "should not remove a record without a built_in_key" do
     park = NationalPark.create(:name => 'Testing')
-    
+
     assert_difference 'NationalPark.count', 1 do
-      load_test_data
+      load_hash_data
     end
     assert_equal 'Testing', park.reload.name
   end
-  
+
   test "should update existing built in data" do
-    load_test_data
-    NationalPark.built_in_data_attributes[:test][:url] = 'http://en.wikipedia.org/wiki/Yellowstone_National_Park'
-    
-    NationalPark.load_built_in_data!
+    load_hash_data
+    assert_not_equal 'http://en.wikipedia.org/wiki/Yellowstone_National_Park', NationalPark.find_by_built_in_key('test').url
+    modified_hash = HASH_DATA.dup
+    modified_hash[:test][:url] = 'http://en.wikipedia.org/wiki/Yellowstone_National_Park'
+    NationalPark.load_built_in_data!(modified_hash)
     assert_equal 'http://en.wikipedia.org/wiki/Yellowstone_National_Park', NationalPark.find_by_built_in_key('test').url
   end
-  
-  
-  # loading from a yaml file
-  test "should load data from yaml file" do
-    NationalPark.built_in_data_attributes = nil
-    assert_equal 2, NationalPark.built_in_data_attributes.length
-  end
-  
+
   test "should load built in data from yaml file" do
-    NationalPark.built_in_data_attributes = nil
-    
     assert_difference 'NationalPark.count', 2 do
       NationalPark.load_built_in_data!
     end
   end
-  
+
   test "should load elements from file only once" do
-    NationalPark.built_in_data_attributes = nil
     NationalPark.load_built_in_data!
-    NationalPark.built_in_data_attributes = nil
-    
+
     assert_no_difference 'NationalPark.count' do
       NationalPark.load_built_in_data!
     end
   end
-  
-  
+
+
   #######
   private
   #######
-  
-  def load_test_data
-    NationalPark.built_in_data_attributes = {
-      :test => {
-        :name => 'Yellowstone National Park',
-        :established => '1872-03-01',
-        :url => 'http://www.nps.gov/yell/index.htm'
-      }
-    }
-    
-    NationalPark.load_built_in_data!
+
+  def load_hash_data
+    NationalPark.load_built_in_data!(HASH_DATA)
   end
+
 end

data/test/dummy/db/schema.rb

@@ -17,9 +17,9 @@ ActiveRecord::Schema.define(:version => 20121024201818) do
     t.string   "name"
     t.date     "established"
     t.string   "url"
-    t.string   "built_in_key"
     t.datetime "created_at",   :null => false
     t.datetime "updated_at",   :null => false
+    t.string   "built_in_key"
   end
 
 end

data/test/dummy/log/development.log

@@ -1,17 +1,75 @@
 Connecting to database specified by database.yml
+   (20.1ms)  select sqlite_version(*)
+   (147.2ms)  CREATE TABLE "national_parks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "established" date, "url" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL, "built_in_key" varchar(255)) 
+   (108.1ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.1ms)  PRAGMA index_list("schema_migrations")
+   (91.7ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (124.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20121024201818')
+   (108.5ms)  INSERT INTO "schema_migrations" (version) VALUES ('20121024195810')
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
 Connecting to database specified by database.yml
-   (0.1ms)  select sqlite_version(*)
-   (14.7ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
-   (0.0ms)  PRAGMA index_list("schema_migrations")
-   (5.5ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
-   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
-Migrating to CreateNationalParks (20121024195810)
-   (0.0ms)  begin transaction
-   (0.4ms)  CREATE TABLE "national_parks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "established" date, "url" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL) 
-   (0.1ms)  INSERT INTO "schema_migrations" ("version") VALUES ('20121024195810')
-   (1.3ms)  commit transaction
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
    (0.2ms)  select sqlite_version(*)
+   (145.0ms)  CREATE TABLE "national_parks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "established" date, "url" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL, "built_in_key" varchar(255)) 
+   (133.2ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.1ms)  PRAGMA index_list("schema_migrations")
+   (116.7ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (116.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('20121024201818')
+   (117.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20121024195810')
+Connecting to database specified by database.yml
+   (19.0ms)  select sqlite_version(*)
+   (195.5ms)  DROP TABLE "national_parks"
+   (116.6ms)  CREATE TABLE "national_parks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "established" date, "url" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL, "built_in_key" varchar(255)) 
+   (0.1ms)  SELECT version FROM "schema_migrations"
    (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
-   (0.0ms)  PRAGMA index_list("national_parks")
 Connecting to database specified by database.yml
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.3ms)  select sqlite_version(*)
+   (160.3ms)  CREATE TABLE "national_parks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "established" date, "url" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL, "built_in_key" varchar(255)) 
+   (116.5ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.1ms)  PRAGMA index_list("schema_migrations")
+   (108.4ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (149.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20121024201818')
+   (92.0ms)  INSERT INTO "schema_migrations" (version) VALUES ('20121024195810')
+Connecting to database specified by database.yml
+   (18.3ms)  select sqlite_version(*)
+   (137.1ms)  DROP TABLE "national_parks"
+   (116.6ms)  CREATE TABLE "national_parks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "established" date, "url" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL, "built_in_key" varchar(255)) 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
 Connecting to database specified by database.yml
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.3ms)  select sqlite_version(*)
+   (135.2ms)  CREATE TABLE "national_parks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "established" date, "url" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL, "built_in_key" varchar(255)) 
+   (116.5ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.1ms)  PRAGMA index_list("schema_migrations")
+   (91.7ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (83.0ms)  INSERT INTO "schema_migrations" (version) VALUES ('20121024201818')
+   (118.3ms)  INSERT INTO "schema_migrations" (version) VALUES ('20121024195810')
+Connecting to database specified by database.yml
+   (0.1ms)  select sqlite_version(*)
+   (127.3ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.1ms)  PRAGMA index_list("schema_migrations")
+   (99.9ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Connecting to database specified by database.yml
+   (18.7ms)  select sqlite_version(*)
+   (152.0ms)  CREATE TABLE "national_parks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "established" date, "url" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL, "built_in_key" varchar(255)) 
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (117.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20121024201818')
+   (116.9ms)  INSERT INTO "schema_migrations" (version) VALUES ('20121024195810')
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+Connecting to database specified by database.yml
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.2ms)  select sqlite_version(*)
+   (142.2ms)  CREATE TABLE "national_parks" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" varchar(255), "established" date, "url" varchar(255), "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL, "built_in_key" varchar(255)) 
+   (116.4ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.1ms)  PRAGMA index_list("schema_migrations")
+   (91.7ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.1ms)  SELECT version FROM "schema_migrations"
+   (91.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20121024201818')
+   (83.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('20121024195810')