data_works 0.1.1

data/spec/helper/data_works_spec_helper.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+# data_works needs its own set of tables and ActiveRecord models to test with.
+require_relative 'test_tables'
+DataWorks::TestTables.create!
+require_relative 'test_models'
+
+module DataWorks
+  class StaleRelationshipChecker
+    def self.check!
+      true # For self testing purposes we can just state that the data model has not changed
+    end
+  end
+end
+
+DataWorks.configure do |config|
+
+config.necessary_parents = {
+    address:               [:pet_profile],
+    agency:                [],
+    bell_toy:              [{ :pet => :pet_bird }],
+    hooman_toy:            [:pet],
+    kind:                  [],
+    pet:                   [],
+    pet_bird:              [],
+    pet_food:              [],
+    pet_profile:           [:pet],
+    pet_sitter:            [:agency, :kind],
+    pet_sitting_patronage: [:pet_sitter, :pet],
+    tag:                   [:pet],
+    toy:                   [:pet],
+    album:                 [],
+    product:               [],
+    picture:               [{ :imageable => :product }, :album],
+  }
+
+  config.autocreated_children = {
+  }
+end
+
+class TheDataWorks < DataWorks::Base
+end
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end

data/spec/helper/test_models.rb

@@ -0,0 +1,106 @@
+#*******************************************************************************
+#  For testing basic associations.
+#*******************************************************************************
+
+class Pet < ActiveRecord::Base
+  has_many :toys
+  has_one :pet_tag
+  has_one :pet_profile
+  has_one :address, through: :pet_profile
+  # We explicitly name the join table so that this code works with both Rails 3 and Rails 4.
+  has_and_belongs_to_many :pet_foods, join_table: 'pet_foods_pets'
+  has_many :pet_sitting_patronages
+  has_many :pet_sitters, through: :pet_sitting_patronages
+end
+
+class Toy < ActiveRecord::Base
+  validates  :name, length: { minimum: 3 }
+  belongs_to :pet
+end
+
+class PetTag < ActiveRecord::Base
+  belongs_to :pet
+end
+
+class PetFood < ActiveRecord::Base
+  # Rails 3 expects the join table to be called pet_foods_pets
+  # Rails 4 expects the join table to be called pet_foods_pets
+  # We explicitly name the join table so that this code works with both Rails 3 and Rails 4.
+  has_and_belongs_to_many :pets, join_table: 'pet_foods_pets'
+end
+
+class Agency < ActiveRecord::Base
+  has_many :pet_sitters
+end
+
+class Kind < ActiveHash::Base
+  self.data = [
+    {:id => 1, :name => "Amateur"},
+    {:id => 2, :name => "Professional"}
+  ]
+end
+
+class PetSitter < ActiveRecord::Base
+  extend ActiveHash::Associations::ActiveRecordExtensions
+  belongs_to :kind
+  belongs_to :agency
+  has_many :pet_sitting_patronages
+  has_many :pets, through: :pet_sitting_patronages
+end
+
+class PetSittingPatronage < ActiveRecord::Base
+  belongs_to :pet
+  belongs_to :pet_sitter
+end
+
+class PetProfile < ActiveRecord::Base
+  belongs_to :pet
+  has_one :address
+end
+
+class Address < ActiveRecord::Base
+  belongs_to :pet_profile
+end
+
+#*******************************************************************************
+#  For testing polymorphic associations and custom-named foreign keys.
+#
+
+class Picture < ActiveRecord::Base
+  belongs_to :imageable, polymorphic: true
+  belongs_to :album, foreign_key: 'picture_album_id'
+end
+
+class Product < ActiveRecord::Base
+  has_many :pictures, as: :imageable
+end
+
+class Album < ActiveRecord::Base
+  has_many :pictures, foreign_key: 'picture_album_id'
+end
+
+
+
+# #*******************************************************************************
+# #  For testing denormalized data structures.
+# #
+
+# class Owner < ActiveRecord::Base
+#   has_many :vehicles
+#   has_many :amenities  # this is not normalized, you wouldn't normally do this
+# end
+
+# class Vehicle < ActiveRecord::Base
+#   has_many :amenities
+#   belongs_to  :owner
+# end
+
+# class Amenity < ActiveRecord::Base
+#   belongs_to :vehicle
+#   belongs_to :owner  # this is not normalized, you wouldn't normally do this
+#   has_one :warranty
+# end
+
+# class Warranty < ActiveRecord::Base
+#   belongs_to :amenity
+# end

data/spec/helper/test_tables.rb

@@ -0,0 +1,120 @@
+module DataWorks
+  class TestTables
+
+    def self.create!
+      return if @already_created_tables
+      ActiveRecord::Migration.class_eval do
+        suppress_messages do
+
+          create_table :agencies, force: true do |t|
+            t.string :name, null: false
+            t.timestamps null: false
+          end
+
+          create_table :addresses, force: true do |t|
+            t.string   :street,          null: false
+            t.string   :city,            null: false
+            t.string   :state,           null: false
+            t.integer  :pet_profile_id,  null: false
+            t.timestamps null: false
+          end
+
+          create_table :pet_foods, force: true do |t|
+            t.string :name, null: false
+            t.timestamps null: false
+          end
+
+          create_table :pet_foods_pets, force: true, id: false do |t|
+            t.integer :pet_id,      null: false
+            t.integer :pet_food_id, null: false
+          end
+
+          create_table :pet_profiles, force: true do |t|
+            t.string   :description,     null: false
+            t.string   :nickname
+            t.integer  :pet_id, null: false
+            t.timestamps null: false
+          end
+
+          create_table :pet_sitters, force: true do |t|
+            t.string   :name, null: false
+            t.integer  :agency_id, null: false
+            t.integer  :kind_id, null: false
+            t.timestamps null: false
+          end
+
+          create_table :pet_sitting_patronages, force: true do |t|
+            t.integer  :pet_id,        null: false
+            t.integer  :pet_sitter_id, null: false
+            t.timestamps null: false
+          end
+
+          create_table :pet_tags, force: true do |t|
+            t.string   :registered_name, null: false
+            t.integer  :pet_id, null: false
+            t.timestamps null: false
+          end
+
+          create_table :pets, force: true do |t|
+            t.string  :name,        null: false
+            t.string  :kind,        null: false
+            t.integer :birth_year
+            t.timestamps null: false
+          end
+
+          create_table :toys, force: true do |t|
+            t.string   :name
+            t.string   :kind
+            t.integer  :pet_id
+            t.timestamps null: false
+          end
+
+          create_table :albums, force: true do |t|
+            t.string :name, null: false
+            t.timestamps null: false
+          end
+
+          create_table :pictures, force: true do |t|
+            t.string  :name
+            t.integer :imageable_id
+            t.string  :imageable_type
+            t.integer :picture_album_id
+            t.timestamps null: false
+          end
+
+          create_table :products, force: true do |t|
+            t.string  :name
+            t.timestamps null: false
+          end
+
+          # create_table :amenities, force: true do |t|
+          #   t.string   :name
+          #   t.integer  :vehicle_id
+          #   t.integer  :owner_id
+          #   t.timestamps null: false
+          # end
+
+          # create_table :owners, force: true do |t|
+          #   t.string :name, null: false
+          #   t.timestamps null: false
+          # end
+
+          # create_table :vehicles, force: true do |t|
+          #   t.string  :name
+          #   t.integer :owner_id
+          #   t.timestamps null: false
+          # end
+
+          # create_table :warranties, force: true do |t|
+          #   t.string   :name
+          #   t.integer  :amenity_id
+          #   t.timestamps null: false
+          # end
+
+        end
+      end
+      @already_created_tables = true
+    end
+
+  end
+end

data/spec/lib/data_faker.rb

@@ -0,0 +1,37 @@
+# Anywhere you need fake string data, use this method.
+def fake_string
+  words = []
+  (rand(2)+2).times { words << DataFaker.hawaiian_word }
+  words.join(' ')
+end
+
+# Don't use this method, use fake_string instead.
+# Ok, you win, in the situation you described fake_word
+# makes more sense.  Here you go, use it if you need to.
+def fake_word
+  DataFaker.hawaiian_word
+end
+
+# Basically, this is the faker gem + a shrink ray.
+class DataFaker
+
+  HAWAIIAN_VOWELS = %w( a e i o u )
+
+  HAWAIIAN_CONSONANTS = %w( h k l m n p t w )
+
+  def self.hawaiian_syllable
+    s = ''
+    if rand(100) < 90
+      s << HAWAIIAN_CONSONANTS.sample
+    end
+    s << HAWAIIAN_VOWELS.sample
+    s
+  end
+
+  def self.hawaiian_word
+    word = ''
+    (rand(3)+3).times { word << hawaiian_syllable }
+    word
+  end
+
+end

data/spec/relationships_spec.rb

@@ -0,0 +1,108 @@
+require_relative "helper/data_works_spec_helper"
+
+describe DataWorks::Relationships do
+  describe "#necessary_parents_for" do
+    describe "pet" do
+      it "returns an empty collection" do
+        expect(DataWorks::Relationships.necessary_parents_for(:pet)).to be_empty
+      end
+    end
+
+    describe "pet_food" do
+      it "returns an empty collection" do
+        expect(DataWorks::Relationships.necessary_parents_for(:pet_food)).to be_empty
+      end
+    end
+
+    describe "agency" do
+      it "returns an empty collection" do
+        expect(DataWorks::Relationships.necessary_parents_for(:agency)).to be_empty
+      end
+    end
+
+    describe "toy" do
+      it "returns a collection with a single parent object " do
+        expect(DataWorks::Relationships.necessary_parents_for(:toy).count).to eq 1
+      end
+      it "returns a parent object with #association_name => pet" do
+        parents = DataWorks::Relationships.necessary_parents_for(:toy)
+        expect(parents.first.association_name).to eq(:pet)
+      end
+      it "returns a parent object with #model_name => pet" do
+        parents = DataWorks::Relationships.necessary_parents_for(:toy)
+        expect(parents.first.model_name).to eq(:pet)
+      end
+    end
+
+    describe "tag" do
+      it "returns a collection with a single parent object " do
+        expect(DataWorks::Relationships.necessary_parents_for(:tag).count).to eq 1
+      end
+      it "returns a parent object with #association_name => pet" do
+        parents = DataWorks::Relationships.necessary_parents_for(:tag)
+        expect(parents.first.association_name).to eq(:pet)
+      end
+      it "returns a parent object with #model_name => pet" do
+        parents = DataWorks::Relationships.necessary_parents_for(:tag)
+        expect(parents.first.model_name).to eq(:pet)
+      end
+    end
+
+    describe "pet_profile" do
+      it "returns a collection with a single parent object " do
+        expect(DataWorks::Relationships.necessary_parents_for(:pet_profile).count).to eq 1
+      end
+      it "returns a parent object with #association_name => pet" do
+        parents = DataWorks::Relationships.necessary_parents_for(:pet_profile)
+        expect(parents.first.association_name).to eq(:pet)
+      end
+      it "returns a parent object with #model_name => pet" do
+        parents = DataWorks::Relationships.necessary_parents_for(:pet_profile)
+        expect(parents.first.model_name).to eq(:pet)
+      end
+    end
+
+    describe "pet_sitter" do
+      it "returns a collection with a single parent object " do
+        expect(DataWorks::Relationships.necessary_parents_for(:pet_sitter).count).to eq 2
+      end
+      it "returns a parent object with #association_name => agency" do
+        parents = DataWorks::Relationships.necessary_parents_for(:pet_sitter)
+        expect(parents.first.association_name).to eq(:agency)
+      end
+      it "returns a parent object with #model_name => agency" do
+        parents = DataWorks::Relationships.necessary_parents_for(:pet_sitter)
+        expect(parents.first.model_name).to eq(:agency)
+      end
+    end
+
+    describe "address" do
+      it "returns a collection with a single parent object " do
+        expect(DataWorks::Relationships.necessary_parents_for(:address).count).to eq 1
+      end
+      it "returns a parent object with #association_name => pet_profile" do
+        parents = DataWorks::Relationships.necessary_parents_for(:address)
+        expect(parents.first.association_name).to eq(:pet_profile)
+      end
+      it "returns a parent object with #model_name => pet_profile" do
+        parents = DataWorks::Relationships.necessary_parents_for(:address)
+        expect(parents.first.model_name).to eq(:pet_profile)
+      end
+    end
+
+    describe "pet_sitting_patronage" do
+      it "returns a collection with two parent objects" do
+        expect(DataWorks::Relationships.necessary_parents_for(:pet_sitting_patronage).count).to eq 2
+      end
+      it "returns an array of parent objects with #association_names => pet_sitter, pet" do
+        parents = DataWorks::Relationships.necessary_parents_for(:pet_sitting_patronage)
+        expect(parents.map(&:association_name)).to contain_exactly(:pet_sitter, :pet)
+      end
+      it "returns an array of parent objects with #model_names => pet_sitter, pet" do
+        parents = DataWorks::Relationships.necessary_parents_for(:pet_sitting_patronage)
+        expect(parents.map(&:model_name)).to contain_exactly(:pet_sitter, :pet)
+      end
+    end
+  end
+end
+

data/spec/restricted_parentage_spec.rb

@@ -0,0 +1,35 @@
+require_relative "helper/data_works_spec_helper"
+
+describe 'DataWorks#set_restriction' do
+  let!(:data) { TheDataWorks.new }
+
+  describe 'setting a restriction using the metheod/registry option'do
+    let!(:darth_cuddles) { data.add_pet }
+    let!(:kittylo_ren) { data.add_pet }
+
+    it 'restricts the parent record for new children to the given object' do
+      death_star = data.add_toy
+      data.set_restriction(for_model: :pet, to: kittylo_ren)
+      star_killer = data.add_toy
+      expect(death_star.pet).to eq darth_cuddles
+      expect(star_killer.pet).to eq kittylo_ren
+    end
+  end
+
+  describe 'setting a restriction using the block option'do
+    let!(:darth_cuddles) { data.add_pet }
+    let!(:kittylo_ren) { data.add_pet }
+
+    it 'restricts the parent record for new children to the given object' do
+      death_star = data.add_toy
+      star_killer = data.set_restriction(for_model: :pet, to: kittylo_ren) do
+        data.add_toy
+      end
+      wookie_doll = data.add_toy
+      expect(death_star.pet).to eq darth_cuddles
+      expect(wookie_doll.pet).to eq darth_cuddles
+      expect(star_killer.pet).to eq kittylo_ren
+    end
+  end
+end
+