empty_eye 0.4.4 → 0.4.5

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 0.4.5 / 2012-03-11 / Grady Griffin
+
+* refactored some validation logic code
+* reorganized code to clean up active record base
+* added generator to manage view versioning
+* removed old view versioning code
+* added view manager class to handle view versioning, creating  and updating
+
+# 0.4.4 / 2012-03-11 / Grady Griffin
+
+* added various connection adapters; only mysql tested
+
 # 0.4.3 / 2012-03-11 / Grady Griffin
 
 * major refactor to do less in active record base

data/README.md

@@ -2,6 +2,22 @@
 
 ActiveRecord based MTI gem powered by database views
 
+add to your Gemfile
+
+      gem 'empty_eye'
+      
+and bundle or
+
+      gem install empty_eye
+      
+when using rails run the optional migration generator and the migration
+
+this migration tracks view versions and its usage is highly recommended
+
+      rails generate empty_eye
+      =>  create  db/migrate/20120313042059_create_empty_eye_views_table.rb
+      rake db:migrate
+
 #Issues
 
 * No known issues major issues; has been successful within data structures of high complexity (MTI to MTI, MTI to STI to MTI relationships)

data/lib/empty_eye/active_record/base.rb

@@ -1,91 +1,7 @@
 module ActiveRecord
   class Base
-    
-    class << self
-    
-      #am i a mti class? easier than making a new class type ... i tried
-      def mti_class?
-        !!@shard_wrangler
-      end
-  
-      #interface for building mti_class
-      #primary table is not necessary if the table named correctly (Bar => bars_core)
-      #OR if the class inherits a primary table
-      #simply wrap your greasy associations in this block
-      def mti_class(primary_table = nil)
-        raise(EmptyEye::AlreadyExtended, "MTI class method already invoked") if mti_class?
-        self.primary_key = "id"
-        @shard_wrangler = EmptyEye::ShardWrangler.create(self, primary_table)
-        self.table_name = @shard_wrangler.compute_view_name
-        before_yield = reflect_on_multiple_associations(:has_one)
-        yield nil if block_given?
-        mti_ancestors = reflect_on_multiple_associations(:has_one) - before_yield
-        @shard_wrangler.wrangle_shards(mti_ancestors)
-        true
-      end
-    
-      #we need this when we add new associaton types to extend with
-      #we could use the baked in version for now
-      def reflect_on_multiple_associations(*assoc_types)
-        assoc_types.collect do |assoc_type| 
-          reflect_on_all_associations(assoc_type)
-        end.flatten.uniq
-      end
-
-      #we dont need no freakin' type condition
-      #the view handles this
-      def finder_needs_type_condition?
-        !mti_class? and super
-      end
-
-      #remove the schema_version for mti_class views
-      def column_names
-        @column_names ||= columns.map { |column| column.name } - (mti_class? ? ["schema_version"] : [])
-      end
-
-      #the class of primary shard
-      def shard_wrangler
-        @shard_wrangler
-      end
-    
-      def descends_from_active_record?
-        if superclass.abstract_class?
-          superclass.descends_from_active_record?
-        elsif mti_class?
-          superclass == Base
-        else
-          superclass == Base || !columns_hash.include?(inheritance_column)
-        end
-      end
-    
-      private
-      
-    end
-    
-    def valid?(context = nil)
-      context ||= (new_record? ? :create : :update)
-      output = super(context)
-      return errors.empty? && output unless mti_class?
-      shard_wrangler.valid?(context) && errors.empty? && output
-    end
-    
-    private
-    
-    #a pseudo association method mapping us back to instances primary shard
-    def shard_wrangler
-      @shard_wrangler ||= if new_record?
-        self.class.shard_wrangler.new(:mti_instance => self)
-      else
-        rtn = self.class.shard_wrangler.find_by_id(id)
-        rtn.mti_instance = self
-        rtn
-      end
-    end
-    
-    #is the instance an instance of mti_class?
-    def mti_class?
-      self.class.mti_class?
-    end
-    
+    include EmptyEye::Persistence
+    include EmptyEye::Relation
+    include EmptyEye::BaseMethods
   end
 end

data/lib/empty_eye/base_methods.rb

@@ -0,0 +1,89 @@
+module EmptyEye
+  module BaseMethods
+    
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+    
+      #am i a mti class? easier than making a new class type ... i tried
+      def mti_class?
+        !!@shard_wrangler
+      end
+  
+      #interface for building mti_class
+      #primary table is not necessary if the table named correctly (Bar => bars_core)
+      #OR if the class inherits a primary table
+      #simply wrap your greasy associations in this block
+      def mti_class(primary_table = nil)
+        raise(EmptyEye::AlreadyExtended, "MTI class method already invoked") if mti_class?
+        self.primary_key = "id"
+        @shard_wrangler = EmptyEye::ShardWrangler.create(self, primary_table)
+        self.table_name = @shard_wrangler.compute_view_name
+        before_yield = reflect_on_multiple_associations(:has_one)
+        yield nil if block_given?
+        mti_ancestors = reflect_on_multiple_associations(:has_one) - before_yield
+        @shard_wrangler.wrangle_shards(mti_ancestors)
+        true
+      end
+    
+      #we need this when we add new associaton types to extend with
+      #we could use the baked in version for now
+      def reflect_on_multiple_associations(*assoc_types)
+        assoc_types.collect do |assoc_type| 
+          reflect_on_all_associations(assoc_type)
+        end.flatten.uniq
+      end
+
+      #we dont need no freakin' type condition
+      #the view handles this
+      def finder_needs_type_condition?
+        !mti_class? and super
+      end
+
+      #the class of primary shard
+      def shard_wrangler
+        @shard_wrangler
+      end
+    
+      def descends_from_active_record?
+        if superclass.abstract_class?
+          superclass.descends_from_active_record?
+        elsif mti_class?
+          superclass == ActiveRecord::Base
+        else
+          superclass == ActiveRecord::Base || !columns_hash.include?(inheritance_column)
+        end
+      end
+    
+      private
+      
+    end
+    
+    def valid?(context = nil)
+      context ||= (new_record? ? :create : :update)
+      output = super(context)
+      return errors.empty? && output unless mti_class?
+      shard_wrangler.valid?(context) && errors.empty? && output
+    end
+    
+    private
+    
+    #a pseudo association method mapping us back to instances primary shard
+    def shard_wrangler
+      @shard_wrangler ||= if new_record?
+        self.class.shard_wrangler.new(:master_instance => self)
+      else
+        rtn = self.class.shard_wrangler.find_by_id(id)
+        rtn.master_instance = self
+        rtn
+      end
+    end
+    
+    #is the instance an instance of mti_class?
+    def mti_class?
+      self.class.mti_class?
+    end
+  end
+end

data/lib/empty_eye/persistence.rb

@@ -1,6 +1,5 @@
 module EmptyEye
   module Persistence
-    extend ActiveSupport::Concern
     
     #if it is not a mti_class do what you do
     #else let the primary shard do the saving

data/lib/empty_eye/shard_collection.rb

@@ -112,9 +112,6 @@ module EmptyEye
         end
       end
       
-      self.schema_version = Digest::MD5.hexdigest(query.to_sql)
-      query.project("'#{schema_version}' AS mti_schema_version")
-      
       #we dont need to keep this data
       free_arel_columns
       

data/lib/empty_eye/shard_wrangler.rb

@@ -37,13 +37,13 @@ module EmptyEye
     #we usually know the master instance ahead of time
     #so we should take care to set this manually
     #we want to avoid the lookup
-    def mti_instance
-      @mti_instance || master_class.find_by_id(id)
+    def master_instance
+      @master_instance || master_class.find_by_id(id)
     end
     
     #setter used to associate the wrangler with the master instance
-    def mti_instance=(instance)
-      @mti_instance = instance
+    def master_instance=(instance)
+      @master_instance = instance
     end
     
     #special save so that the wrangler can keep the master's instance tables consistent
@@ -52,8 +52,8 @@ module EmptyEye
       #this will autosave shards
       save
       #reset the id and then reload
-      mti_instance.id = id
-      mti_instance.reload
+      master_instance.id = id
+      master_instance.reload
     end
     
     #reflection on master class; this should never change
@@ -66,7 +66,8 @@ module EmptyEye
       write_attributes
       output = super(context)
       errors.each do |attr, message|
-        mti_instance.errors.add(attr, message)
+        attr = attr.to_s.partition('.').last if attr.to_s =~ /\./
+        master_instance.errors.add(attr, message)
       end
       errors.empty? && output
     end
@@ -75,10 +76,11 @@ module EmptyEye
     
     def write_attributes
       #make sure all the shards are there
-      cascade_build_associations
+      cascade_build_associations if master_instance.new_record?
       #this will propagate setters to the appropriate shards
       assign_attributes(mti_safe_attributes)
       self.type = master_class.name if respond_to?("type=")
+      self.updated_at = Time.now if respond_to?("updated_at=") and not changed?
       self
     end
     
@@ -88,21 +90,17 @@ module EmptyEye
   
     #make sure the primary shard only tries to update what he should
     def mti_safe_attributes
-      mti_instance.attributes.except(
+      master_instance.attributes.except(
         *self.class.primary_shard.exclude
       )
     end
   
-    #all the instance shards should exist but lets be certain
-    #using an autobuild would be more efficient here
-    #we shouldnt load associations we dont need to
+    #all the instance shards should exist
     def cascade_build_associations
       #go through each shard making sure it is exists and is loaded
       shards.each do |shard|
         next if shard.primary
-        assoc = send(shard.name)
-        assoc ||= send("build_#{shard.name}")
-        send("#{shard.name}=", assoc)
+        send(shard.name) || send("build_#{shard.name}")
       end
     end
     
@@ -166,7 +164,7 @@ module EmptyEye
         mti_ancestors.each do |assoc|
           shards.create_with(assoc)
         end
-        create_view if create_view?
+        create_view
         master_class.reset_column_information
       end
       
@@ -239,46 +237,11 @@ module EmptyEye
       def mti_clear_identity_map
         ActiveRecord::IdentityMap.repository[symbolized_base_class].clear if ActiveRecord::IdentityMap.enabled?
       end
-      
-      #get the schema version
-      #we shouldnt recreate views that we donth have to
-      def mti_schema_version
-        check_for_name_error
-        return nil unless connection.table_exists?(compute_view_name)
-        return nil unless mti_view_versioned?
-        t = Arel::Table.new(compute_view_name)
-        q = t.project(t[:mti_schema_version])
-        connection.select_value(q.to_sql)
-      rescue
-        nil
-      end
-
-      #determine if what we want to name our view already exists
-      def check_for_name_error
-        if connection.tables_without_views.include?(compute_view_name)
-          raise(EmptyEye::ViewNameError, "MTI view cannot be created because a table named '#{compute_view_name}' already exists")
-        end
-      end
-      
-      #we need to create the sql first to determine the schema_version
-      #if the current schema version is the same as the old dont recreate the view
-      #if it is nil then recreate
-      def create_view?
-        shards.create_view_sql
-        schema_version = mti_schema_version
-        schema_version.nil? or schema_version != shards.schema_version
-      end
-      
-      #always recreate
-      def mti_view_versioned?
-        connection.columns(compute_view_name).any? {|c| c.name == 'mti_schema_version'}
-      end
     
       #drop the view; dont check if we can, just rescue any errors
       #create the view
       def create_view
-        connection.execute("DROP VIEW #{compute_view_name}") rescue nil
-        connection.execute(shards.view_sql)
+        EmptyEye::ViewManager.create_view(compute_view_name, shards.create_view_sql)
       end
       
       #build the arel query once and memoize it

data/lib/empty_eye/version.rb

@@ -2,7 +2,7 @@ module EmptyEye
   module VERSION
     MAJOR = 0
     MINOR = 4
-    TINY = 4
+    TINY = 5
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/empty_eye/view_manager.rb

@@ -0,0 +1,82 @@
+module EmptyEye
+  class ViewManager < ActiveRecord::Base
+    self.table_name = "empty_eye_views"
+    
+    attr_accessor :sql
+      
+    def self.create_view(view_name, sql)
+      if table_exists?
+        manager = find_by_view_name(view_name) 
+        manager ||= new(:view_name => view_name)
+        manager.sql = sql
+        manager.create_view
+      else
+        drop_view(view_name)
+        execute_view(sql)
+      end
+    end
+    
+    def self.execute_view(sql)
+      connection.execute(sql)
+    end
+    
+    def self.drop_view(view_name)
+      connection.execute %{DROP VIEW #{view_name}} rescue nil
+    end
+  
+    def create_view
+      return unless create_view? 
+      drop_view if view_exists?
+      self.version = compute_version
+      save
+      execute_view_sql
+    end
+    
+    private
+      
+    def execute(sql)
+      self.class.connection.execute(sql)
+    end
+    
+    def table_exists?
+      self.class.connection.table_exists?(view_name)
+    end
+    
+    def ordinary_table_exists?
+      self.class.connection.tables_without_views.include?(view_name)
+    end
+    
+    def compute_version
+      Digest::MD5.hexdigest(sql)
+    end
+  
+    def version_current?
+      compute_version == version
+    end
+    
+    def view_exists?
+      table_exists? and !ordinary_table_exists?
+    end
+    
+    def create_view?
+      check_for_name_error
+      !(version_current? and view_exists?)
+    end
+    
+    def drop_view
+      self.class.drop_view(view_name)
+    end
+    
+    def execute_view_sql
+      self.class.execute_view(sql)
+    end
+
+    #determine if what we want to name our view already exists
+    def check_for_name_error
+      if ordinary_table_exists?
+        raise(EmptyEye::ViewNameError, "MTI view cannot be created because a table named '#{view_name}' already exists")
+      end
+    end
+    
+  end
+end

data/lib/empty_eye.rb

@@ -6,7 +6,10 @@ require "empty_eye/version"
 
 require "empty_eye/persistence"
 require "empty_eye/relation"
+require "empty_eye/base_methods"
 require "empty_eye/errors"
+
+require "empty_eye/view_manager"
 require "empty_eye/shard"
 require "empty_eye/primary_shard"
 require "empty_eye/shard_collection"
@@ -30,8 +33,6 @@ module EmptyEye
 
 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]
+#::ActiveRecord::Associations::Builder::BelongsTo.valid_options += [:except, :only]
 

data/lib/rails/generators/empty_eye/empty_eye_generator.rb

@@ -0,0 +1,13 @@
+module EmptyEye
+  module Generators
+    class EmptyEyeGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+      
+      def add_migration
+        timestamp = Time.now.utc.strftime("%Y%m%d%H%M%S")
+        template("migration.rb", "db/migrate/#{timestamp}_create_empty_eye_views_table.rb")
+      end
+  
+    end
+  end
+end

data/lib/rails/generators/empty_eye/templates/migration.rb

@@ -0,0 +1,14 @@
+class CreateEmptyEyeViewsTable < ActiveRecord::Migration
+  def up
+    create_table :empty_eye_views, :force => true do |t|
+      t.string :view_name, :null => false
+      t.string :version, :limit => 32, :null => false
+    end
+    
+    add_index :empty_eye_views, :view_name
+  end
+  
+  def down
+    drop_table :empty_eye_views  
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: empty_eye
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 5
   prerelease: 
   segments: 
   - 0
   - 4
-  - 4
-  version: 0.4.4
+  - 5
+  version: 0.4.5
 platform: ruby
 authors: 
 - thegboat
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-12 00:00:00 -04:00
+date: 2012-03-13 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -108,6 +108,7 @@ files:
 - lib/empty_eye/associations/builder/shard_has_one.rb
 - lib/empty_eye/associations/shard_association_scope.rb
 - lib/empty_eye/associations/shard_has_one_association.rb
+- lib/empty_eye/base_methods.rb
 - lib/empty_eye/errors.rb
 - lib/empty_eye/persistence.rb
 - lib/empty_eye/primary_shard.rb
@@ -117,6 +118,9 @@ files:
 - lib/empty_eye/shard_collection.rb
 - lib/empty_eye/shard_wrangler.rb
 - lib/empty_eye/version.rb
+- lib/empty_eye/view_manager.rb
+- lib/rails/generators/empty_eye/empty_eye_generator.rb
+- lib/rails/generators/empty_eye/templates/migration.rb
 - spec/configuration_spec.rb
 - spec/mti_crud_spec.rb
 - spec/mti_to_sti_to_mti_crud_spec.rb