empty_eye 0.4.0

data/lib/empty_eye/view_extension_collection.rb

@@ -0,0 +1,222 @@
+module EmptyEye
+  class ViewExtensionCollection
+    
+    #a collection of all the view_extensions
+    #these are wranglers for the shards
+    #uses 'array' as a proxy
+    #performs array methods by passing things off in method missing
+    
+    def initialize(parent)
+      @parent = parent
+      @array = []
+    end
+    
+    #the proxy object for instances
+    def array
+      @array
+    end
+    
+    #we want to see the proxy object not the class info
+    def inspect
+      array.inspect
+    end
+    
+    #the class to which the instance belongs
+    def parent
+      @parent
+    end
+    
+    def descend(klass)
+      @parent = klass
+      self
+    end
+    
+    #add extensions based on association from parent
+    def association(assoc)
+      new_extension = ViewExtension.new(assoc)
+      reject! {|extension| new_extension.name == extension.name}
+      push(new_extension)
+      new_extension
+    end
+    
+    #add primary extension; needs a table only
+    def primary_table(table)
+      push(@primary = PrimaryViewExtension.new(table, parent))
+    end
+    
+    #generates view sql
+    def create_view_sql
+      #determine what shard will handle what columns
+      map_attribute_management
+      #start with primary table
+      query = primary_arel_table
+      
+      #build select clause with correct table handling the appropriate columns
+      arel_columns.each do |arel_column|
+        query = query.project(arel_column)
+      end
+      
+      #build joins
+      without_primary.each do |ext|
+        current = ext.arel_table
+        key = ext.foreign_key.to_sym
+        if ext.type_column
+          query = query.join(current).on(
+            primary.key.eq(current[key]), ext.type_column.eq(ext.type_value)
+          )
+        else
+          query = query.join(current).on(
+            primary.key.eq(current[key])
+          )
+        end
+      end
+      
+      #we dont need to keep this data
+      free_arel_columns
+      
+      #STI condition if needed
+      if primary.sti_also?
+        query.where(primary.type_column.eq(primary.type_value))
+      end
+      
+      #build veiw creation statement
+      "CREATE VIEW #{parent.table_name} AS\n#{query.to_sql}"
+    end
+    
+    #takes the name of extension and a hash of intended updates from master instance
+    #returns a subset of hash with only values the extension handles
+    def delegate_map(name, hash)
+      keys = update_mapping[name] & hash.keys
+      keys.inject({}) do |res, col|
+        res[col] = hash[col] if hash[col]
+        res
+      end
+    end
+    
+    #in the end this will be an array of argument arrays
+    #[[:validates_presence_of, :name, {}]] 
+    #parent will call the method and associated args inheriting validations
+    def validations
+      @validations ||= []
+    end
+
+    #the primary extension
+    def primary
+      @primary
+    end
+    
+    #array of shard classes
+    def shards
+      map(&:shard)
+    end
+    
+    #this object responds to array methods
+    def respond_to?(m)
+      super || array.respond_to?(m)
+    end
+    
+    #delegate to the array proxy when the method is missing
+    def method_missing(m, *args, &block)
+      if respond_to?(m)
+        array.send(m, *args, &block)
+      else
+        super
+      end
+    end
+    
+    private
+    
+    #all of the arel columns mapped to the right arel tables
+    def arel_columns
+      @arel_columns ||= []
+    end
+    
+    #we dont need to keep this data
+    def free_arel_columns
+      @arel_columns = nil
+    end
+    
+    #tracks the attributes with the view extension that will handle it
+    def update_mapping
+      @update_mapping ||= {}
+    end
+    
+    #generate a foreign_key if it is missing
+    def default_foreign_key
+      view_name = parent.table_name.singularize
+      "#{view_name}_id"
+    end
+    
+    #the primary arel table
+    def primary_arel_table
+      primary.arel_table
+    end
+    
+    #all the tables
+    def tables
+      map(&:table)
+    end
+    
+    #map the columns to the extension that will handle it
+    def map_attribute_management
+      #clear out what we know
+      arel_columns.clear
+      #use this to track and remove dupes
+      tracker = {}
+      each do |ext|
+        #mimic the parent's associations through primary shard
+        primary.have_one(ext)
+        ext.columns.each do |col|
+          column = col.to_sym
+          #skip if we already have this column
+          next if tracker[column]
+          #set to true so we wont do again
+          tracker[column] = true
+          #add the column based on the extension's arel_table
+          arel_columns << ext.arel_table[column]
+          #later we need to know how to update thing correctly
+          update_mapping[ext.name] = update_mapping[ext.name].to_a << col
+          #delegate the setter for column to shard of extension through primary shard
+          primary.delegate_to(column, ext) unless ext.primary
+          #mti class must inherit validations
+          add_validations(column, ext) 
+        end
+      end
+    end
+    
+    #tried a cleaner solution but it wouldnt work
+    #here i am stealing the arguments needed from the shards
+    #to call the same validation on the master class (parent)
+    def add_validations(column, ext)
+      return unless ext.shard._validators[column].present?
+      #primary either has no validations or they have already been inherited
+      return if ext.primary
+      rtn = ext.shard._validators[column].each do |validator|
+        meth = case validator.class.to_s
+        when /presence/i then :validates_presence_of
+        when /acceptance/i then :validates_acceptance_of
+        when /numericality/i then :validates_numericality_of
+        when /length/i then :validates_length_of
+        when /inclusion/i then :validates_inclusion_of
+        when /format/i then :validates_format_of
+        when /exclusion/i then :validates_exclusion_of
+        when /confirmation/i then :validates_confirmation_of
+        when /uniqueness/i then :validates_uniqueness_of
+        else nil
+        end
+        if meth
+          args = []
+          args << meth
+          args << column
+          args << validator.options
+          validations << args
+        end
+      end
+    end
+    
+    #return a list of extensions without primary
+    def without_primary
+      array.select {|ext| ext != primary}
+    end
+  end
+end

data/lib/empty_eye.rb

@@ -0,0 +1,30 @@
+require "active_record"
+require "arel"
+
+require "empty_eye/version"
+
+require "empty_eye/persistence"
+require "empty_eye/relation"
+require "empty_eye/errors"
+require "empty_eye/view_extension"
+require "empty_eye/primary_view_extension"
+require "empty_eye/view_extension_collection"
+require "empty_eye/shard"
+require "empty_eye/associations/builder/shard_has_one"
+require "empty_eye/associations/shard_has_one_association"
+require "empty_eye/associations/shard_association_scope"
+require "empty_eye/shard_association_reflection"
+
+require "empty_eye/active_record/base"
+require "empty_eye/active_record/schema_dumper"
+require "empty_eye/active_record/connection_adapter"
+
+module EmptyEye
+  # Your code goes here...
+end
+
+::ActiveRecord::Base.send :include, EmptyEye::Persistence
+::ActiveRecord::Base.send :include, EmptyEye::Relation
+::ActiveRecord::Associations::Builder::HasOne.valid_options += [:except, :only]
+::ActiveRecord::Associations::Builder::BelongsTo.valid_options += [:except, :only]
+

data/spec/configuration_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'bundler/setup'
+
+class SmallMechanic < ActiveRecord::Base
+  mti_class :mechanics_core do |t|
+    has_one :garage, :foreign_key => :mechanic_id, :except => 'specialty'
+  end
+end
+
+class TinyMechanic < ActiveRecord::Base
+  mti_class :mechanics_core do |t|
+    has_one :garage, :foreign_key => :mechanic_id, :only => 'specialty'
+  end
+end
+
+describe ActiveRecord::Base do
+  
+  describe "MTI class configuration" do
+    it "should exclude columns with except option" do
+      mechanic_columns = Mechanic.column_names
+      small_mechanic_columns = SmallMechanic.column_names
+      delta = mechanic_columns - small_mechanic_columns
+      delta.should eq(["specialty"])
+    end
+  end
+  
+  describe "MTI class configuration" do
+    it "should restrict columns with only option" do
+      garage_columns = Garage.column_names
+      tiny_mechanic_columns = TinyMechanic.column_names
+      intersection = garage_columns & tiny_mechanic_columns
+      intersection.should eq(["id", "specialty"])
+    end
+  end
+end

data/spec/mti_crud_spec.rb

@@ -0,0 +1,130 @@
+require 'spec_helper'
+require 'bundler/setup'
+
+
+describe ActiveRecord::Base do
+  before(:each) do
+    exec_sql "truncate bars_core"
+    exec_sql "truncate businesses"
+    
+    @bar = Bar.create(
+      :music_genre => "Latin", :best_nights => "Tuesdays", :dress_code => "casual", # bar_core attributes
+      :address => "1904 Easy Kaley Orlando, FL 32806", :name => 'Chicos', :phone => '123456789' #business attributes
+    )
+  end
+  
+  describe "create" do
+    it "should create a mti class correctly" do
+      @bar.music_genre.should eq("Latin")
+      @bar.best_nights.should eq("Tuesdays")
+      @bar.dress_code.should eq("casual")
+      @bar.address.should eq("1904 Easy Kaley Orlando, FL 32806")
+      @bar.name.should eq("Chicos")
+      @bar.phone.should eq("123456789")
+    end
+    
+    it "should create associations correctly" do
+      @bar.business.class.should eq(Business)
+      
+      @bar.business.address.should eq("1904 Easy Kaley Orlando, FL 32806")
+      @bar.business.name.should eq("Chicos")
+      @bar.business.phone.should eq("123456789")
+    end
+  end
+  
+  describe "read" do
+    it "should find a mti class correctly" do
+      @found_bar = Bar.find_by_id(@bar.id)
+      @bar.should eq(@found_bar)
+    end
+  end
+  
+  describe "update" do
+    it "should update a mti class correctly with update_attributes" do
+      @bar.phone.should eq("123456789")
+      @bar.update_attributes(:phone => '987654321') #attribute from business
+      @bar.reload
+      @bar.phone.should eq("987654321")
+      @bar.business.phone.should eq("987654321")
+    end
+    
+    it "should update a mti class correctly with assignment" do
+      @bar.phone.should eq("123456789")
+      @bar.phone = '987654321' #attribute from business
+      @bar.save
+      @bar.reload
+      @bar.phone.should eq("987654321")
+      @bar.business.phone.should eq("987654321")
+    end
+    
+    it "should update a mti class correctly with Class.update" do
+      Bar.update(@bar.id, :name => 'Betos')
+      @bar.reload
+      @bar.name.should eq('Betos')
+    end
+    
+    it "should update a mti class correctly with Class.update_all" do
+      rtn = Bar.update_all(:name => 'Betos')
+      @bar.reload
+      rtn.should eq(1)
+      @bar.name.should eq('Betos')
+    end
+    
+    it "should not update a mti class incorrectly with Class.update_all" do
+      rtn = Bar.update_all({:name => 'Betos'}, ["id = ?", @bar.id + 1]) #choose the wrong one
+      @bar.reload
+      rtn.should eq(0)
+      @bar.name.should eq('Chicos')
+    end
+  end
+  
+  describe "delete" do
+    it "should destroy a mti class correctly" do
+      @business = @bar.business
+      @bar.destroy
+      @bar.destroyed?.should eq(true)
+      Bar.find_by_id(@bar.id).should eq(nil)
+      Business.find_by_id(@business.id).should eq(nil)
+    end
+    
+    it "should destroy_all mti class correctly" do
+      Bar.count.should eq(1)
+      Business.count.should eq(1)
+      Bar.destroy_all
+      Bar.count.should eq(0)
+      Business.count.should eq(0)
+    end
+    
+    it "should not destroy_all mti class incorrectly" do
+      Bar.count.should eq(1)
+      Business.count.should eq(1)
+      Bar.destroy_all(:id => @bar.id + 1) #choose the wrong one
+      Bar.count.should eq(1)
+      Business.count.should eq(1)
+    end
+    
+    it "should delete a mti class correctly" do
+      @bar.delete
+      @bar.destroyed?.should eq(true)
+      Bar.find_by_id(@bar.id).should eq(nil)
+    end
+    
+    it "should delete_all mti class correctly" do
+      Bar.count.should eq(1)
+      Business.count.should eq(1)
+      rtn = Bar.delete_all
+      rtn.should eq(1)
+      Bar.count.should eq(0)
+      Business.count.should eq(0)
+    end
+    
+    it "should not delete_all mti class incorrectly" do
+      Bar.count.should eq(1)
+      Business.count.should eq(1)
+      rtn = Bar.delete_all(:id => @bar.id + 1) #choose the wrong one
+      rtn.should eq(0)
+      Bar.count.should eq(1)
+      Business.count.should eq(1)
+    end
+  end
+end

data/spec/mti_to_sti_to_mti_crud_spec.rb

@@ -0,0 +1,160 @@
+require 'spec_helper'
+require 'bundler/setup'
+
+
+describe ActiveRecord::Base do
+  before(:each) do
+    exec_sql "truncate eating_venues_core"
+    exec_sql "truncate restaurants"
+    exec_sql "truncate businesses"
+    
+    @venue = EatingVenue.create(
+      :api_venue_id => 'abcdefg', :latitude => '122.11111', :longitude => '-81,11111', # eating venue attributes
+      :kids_area => false, :wifi => true, :food_genre => "mexican", # restaurant attributes
+      :address => "1904 Easy Kaley Orlando, FL 32806", :name => 'Chicos', :phone => '123456789' #business attributes
+    )
+  end
+  
+  describe "create" do
+    it "should create a mti to sti to mti class correctly" do
+      @venue.api_venue_id.should eq('abcdefg')
+      @venue.latitude.should eq('122.11111')
+      @venue.longitude.should eq('-81,11111')
+      @venue.kids_area.should eq(false)
+      @venue.wifi.should eq(true)
+      @venue.food_genre.should eq("mexican")
+      @venue.address.should eq("1904 Easy Kaley Orlando, FL 32806")
+      @venue.name.should eq("Chicos")
+      @venue.phone.should eq("123456789")
+    end
+    
+    it "should create mti to sti to mti associations correctly" do
+      @venue.mexican_restaurant.class.should eq(MexicanRestaurant)
+      
+      @venue.mexican_restaurant.kids_area.should eq(false)
+      @venue.mexican_restaurant.wifi.should eq(true)
+      @venue.mexican_restaurant.food_genre.should eq("mexican")
+      @venue.mexican_restaurant.address.should eq("1904 Easy Kaley Orlando, FL 32806")
+      @venue.mexican_restaurant.name.should eq("Chicos")
+      @venue.mexican_restaurant.phone.should eq("123456789")
+    end
+  end
+  
+  describe "read" do
+    it "should find a mti to sti to mti class correctly" do
+      @found_venue = EatingVenue.find_by_id(@venue.id)
+      @venue.should eq(@found_venue)
+    end
+  end
+  
+  describe "update" do
+    it "should update a mti to sti to mti class correctly with update_attributes" do
+      @venue.phone.should eq("123456789")
+      @venue.wifi.should eq(true)
+      @venue.update_attributes(:phone => '987654321', :wifi => false) #attribute from business
+      @venue.reload
+      @venue.phone.should eq("987654321")
+      @venue.wifi.should eq(false)
+      @venue.mexican_restaurant.phone.should eq("987654321")
+      @venue.mexican_restaurant.wifi.should eq(false)
+    end
+    
+    it "should update a mti to sti to mti class correctly with assignment" do
+      @venue.phone.should eq("123456789")
+      @venue.wifi.should eq(true)
+      @venue.wifi = false
+      @venue.phone = '987654321' #attribute from business
+      @venue.save
+      @venue.reload
+      @venue.wifi.should eq(false)
+      @venue.phone.should eq("987654321")
+      @venue.mexican_restaurant.phone.should eq("987654321")
+      @venue.mexican_restaurant.wifi.should eq(false)
+    end
+    
+    it "should update a mti to sti to mti class correctly with Class.update" do
+      EatingVenue.update(@venue.id, :name => 'Betos', :food_genre => 'Italian')
+      @venue.reload
+      @venue.name.should eq('Betos')
+      @venue.food_genre.should eq('Italian')
+    end
+    
+    it "should update a mti class correctly with Class.update_all" do
+      rtn = EatingVenue.update_all(:name => 'Betos', :food_genre => 'Italian')
+      @venue.reload
+      rtn.should eq(1)
+      @venue.name.should eq('Betos')
+      @venue.food_genre.should eq('Italian')
+    end
+    
+    it "should not update a mti to sti to mti class incorrectly with Class.update_all" do
+      rtn = EatingVenue.update_all({:name => 'Betos', :food_genre => 'Italian'}, ["id = ?", @venue.id + 1]) #choose the wrong one
+      @venue.reload
+      rtn.should eq(0)
+      @venue.name.should eq('Chicos')
+      @venue.food_genre.should eq('mexican')
+    end
+  end
+  
+  describe "delete" do
+    it "should destroy a mti to sti to mti class correctly" do
+      @restaurant = @venue.mexican_restaurant
+      @venue.destroy
+      @venue.destroyed?.should eq(true)
+      EatingVenue.find_by_id(@venue.id).should eq(nil)
+      @restaurant.business.should eq(nil)
+      MexicanRestaurant.find_by_id(@restaurant.id).should eq(nil)
+    end
+    
+    it "should destroy_all mti to sti to mti class correctly" do
+      EatingVenue.count.should eq(1)
+      Business.count.should eq(1)
+      MexicanRestaurant.count.should eq(1)
+      EatingVenue.destroy_all
+      EatingVenue.count.should eq(0)
+      Business.count.should eq(0)
+      MexicanRestaurant.count.should eq(0)
+    end
+    
+    it "should not destroy_all mti to sti to mti class incorrectly" do
+      EatingVenue.count.should eq(1)
+      Business.count.should eq(1)
+      EatingVenue.destroy_all(:id => @venue.id + 1) #choose the wrong one
+      EatingVenue.count.should eq(1)
+      Business.count.should eq(1)
+      MexicanRestaurant.count.should eq(1)
+    end
+    
+    it "should delete a mti to sti to mti class correctly" do
+      Business.count.should eq(1)
+      MexicanRestaurant.count.should eq(1)
+      @venue.delete
+      @venue.destroyed?.should eq(true)
+      EatingVenue.find_by_id(@venue.id).should eq(nil)
+      Business.count.should eq(0)
+      MexicanRestaurant.count.should eq(0)
+    end
+    
+    it "should delete_all mti to sti to mti class correctly" do
+      EatingVenue.count.should eq(1)
+      Business.count.should eq(1)
+      MexicanRestaurant.count.should eq(1)
+      rtn = EatingVenue.delete_all
+      rtn.should eq(1)
+      EatingVenue.count.should eq(0)
+      Business.count.should eq(0)
+      MexicanRestaurant.count.should eq(0)
+    end
+    
+    it "should not delete_all mti to sti to mti class incorrectly" do
+      EatingVenue.count.should eq(1)
+      Business.count.should eq(1)
+      MexicanRestaurant.count.should eq(1)
+      rtn = EatingVenue.delete_all(:id => @venue.id + 1) #choose the wrong one
+      rtn.should eq(0)
+      EatingVenue.count.should eq(1)
+      Business.count.should eq(1)
+      MexicanRestaurant.count.should eq(1)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,120 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'empty_eye'
+
+# RSpec.configure do |config|
+#   # some (optional) config here
+# end
+
+ActiveRecord::Base.establish_connection(
+:adapter => "mysql2",
+:database => "empty_eye_test"
+)
+
+def exec_sql(sql)
+  ActiveRecord::Base.connection.execute sql
+end
+
+ActiveRecord::Migration.create_table :restaurants, :force => true do |t|
+  t.string :type
+  t.boolean :kids_area
+  t.boolean :wifi
+  t.integer :eating_venue_id
+  t.string :food_genre
+  t.datetime :created_at
+  t.datetime :updated_at
+  t.datetime :deleted_at
+end
+
+ActiveRecord::Migration.create_table :bars_core, :force => true do |t|
+  t.string :music_genre
+  t.string :best_nights
+  t.string :dress_code
+  t.datetime :created_at
+  t.datetime :updated_at
+  t.datetime :deleted_at
+end
+
+ActiveRecord::Migration.create_table :businesses, :force => true do |t|
+  t.integer :biz_id
+  t.string :biz_type
+  t.string :name
+  t.string :address
+  t.string :phone
+end
+
+ActiveRecord::Migration.create_table :eating_venues_core, :force => true do |t|
+  t.string :api_venue_id
+  t.string :latitude
+  t.string :longitude
+end
+
+ActiveRecord::Migration.create_table :eating_venues_core, :force => true do |t|
+  t.string :api_venue_id
+  t.string :latitude
+  t.string :longitude
+end
+
+ActiveRecord::Migration.create_table :garages, :force => true do |t|
+  t.boolean :privately_owned
+  t.integer :max_wait_days
+  t.string :specialty
+  t.string :email
+  t.integer :mechanic_id
+end
+
+ActiveRecord::Migration.create_table :mechanics_core, :force => true do |t|
+  t.string :name
+end
+
+class Business < ActiveRecord::Base
+  belongs_to  :biz, :polymorphic => true
+end
+
+class Restaurant < ActiveRecord::Base
+  belongs_to  :foursquare_venue
+end
+
+class MexicanRestaurant < Restaurant
+  mti_class do |t|
+    has_one :business, :as => :biz
+  end
+end
+
+class Bar < ActiveRecord::Base
+  mti_class do |t|
+    has_one :business, :as => :biz
+  end
+end
+
+class EatingVenue < ActiveRecord::Base
+  mti_class do |t|
+    has_one :mexican_restaurant
+  end
+end
+
+class Garage < ActiveRecord::Base
+  belongs_to :mechanic, :foreign_key => :mechanic_id
+  
+  validates_presence_of :privately_owned
+  validates_numericality_of :max_wait_days
+  validates_length_of :email, :minimum => 7
+  validates_format_of :email, :with => /\A([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})\Z/i
+  validates_uniqueness_of :email
+  validates_inclusion_of :specialty, :in => %w{foreign domestic antique something_crazy}
+  validates_exclusion_of :specialty, :in => %{ something_crazy }
+end
+
+class Mechanic < ActiveRecord::Base
+  mti_class :mechanics_core do |t|
+    has_one :garage, :foreign_key => :mechanic_id
+  end
+  
+  validates_presence_of :name
+  validates_uniqueness_of :name
+end
+
+
+
+