view-model 0.0.1 → 0.0.2

data/README

@@ -1,6 +1,6 @@
 = ViewModel
 
-Some model magic for ActiveRecord Models & Postgresql 8.x
+Some model magic for ActiveRecord Models & Postgresql >= 8.2
 
 Usage:
 In your Model:
@@ -24,4 +24,20 @@ Warning: There is no automatic versioning support and no fallback functionality.
 = Depending Views:
 
 If you have depending views which would block a "DROP VIEW", ViewModel automatically searches the models,
-checks if they have a view_definition, drops them and recreates them after the current view is migrated.
+checks if they have a view_definition, drops them and recreates them after the current view is migrated.
+
+= Creating an Adapter for your database:
+  - check how to get view dependencies on your desired database
+  - create a new adapter under adapters/
+  - name the class after the ActiveRecord adapter name
+    Get it with: 
+    	ActiveRecord::Base.connection.class.to_s.demodulize
+  - require view_model
+
+
+= TODO:
+
+- document code!
+- create tests!
+- support more databases?
+

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake/gempackagetask'
 
 spec = Gem::Specification.new do |s| 
   s.name = "view-model"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
   s.author = "Joachim Glauche"
   s.email = "jg@connection-net.de"
   s.homepage = "http://rubyforge.org/projects/view-model/"

data/init.rb

@@ -1 +1 @@
-require "view_model"
+require "view_model"

data/lib/adapters/abstract_adapter.rb

@@ -0,0 +1,14 @@
+module ViewModel 
+
+  class AbstractAdapter
+    
+    def self.get_model(sym)
+      sym.to_s.classify.constantize
+    end
+    
+    def self.get_dependencies(connection, table_name)
+    end
+     
+  end
+  
+end

data/lib/adapters/postgresql_adapter.rb

@@ -0,0 +1,25 @@
+module ViewModel 
+
+  class PostgreSQLAdapter < AbstractAdapter
+
+    # returns an Array of Dependent models
+    def self.get_dependencies(connection, table_name)
+      sql = "select distinct(cl2.relname) from pg_depend dep
+            join pg_class cl ON dep.refobjid = cl.oid
+            join pg_rewrite on dep.objid = pg_rewrite.oid
+            join pg_class cl2 on pg_rewrite.ev_class = cl2.oid
+            where cl.relname='#{table_name}' and cl2.relname != '#{table_name}' and deptype='n' "
+      result = connection.execute(sql)
+      view_dependencies = []
+      result.each do |row|
+        view_dependencies << get_model(row["relname"])
+      end
+      if view_dependencies.size > 0
+        puts "found dependencies: "
+        puts view_dependencies.inspect
+      end
+      view_dependencies      
+    end    
+        
+  end
+end

data/lib/view_model.rb

@@ -1,37 +1,36 @@
+# = ViewModel
+# See README for details
+require "adapters/abstract_adapter"
+require "adapters/postgresql_adapter"
+
+
 module ViewModel 
 
-  def self.included(model)
+  def self.included(model)   
     model.extend self 
   end
   
-  # obsolete!
-  # If in any case you have other views depending on this view,
-  # define them in depending_views.
-  # If the current view is migrated, it will drop the views depending on this one.
-  # 
-  # TODO: find a better solution to store this information. 
-#  def depending_views(*opts)
-#    @view_dependencies ||= []
-#    unless opts.kind_of? Array
-#      @view_dependencies << get_model(opts)
-#    else
-#      @view_dependencies += opts.map{|o| get_model(o)}
-#    end
-#  end
-#  alias :depending_view :depending_views
-#  
-  def get_model(sym)
-    sym.to_s.classify.constantize
-  end
-  
+  # sets the view_definition in the model
   def view_definition(sql)
     @view_definition = sql
   end
   
+  # shortcut for connection.execute(sql)
   def execute(sql)
     connection.execute(sql)
   end
   
+  # gets the adapter needed which has a custom method to get its dependencies
+  def get_adapter
+    adapter = connection.class.to_s.demodulize
+    begin
+     return ("ViewModel::"+adapter).constantize
+    rescue
+      raise "ViewModel: can't find adapter for ConnectionAdapter #{adapter}"
+    end
+  end
+  
+  # checks for dependent views
   def check_dependencies
     return if @view_dependencies == nil
     @view_dependencies.each do |dep|
@@ -41,6 +40,7 @@ module ViewModel
     end 
   end
   
+  # drops all dependent views
   def drop_dependencies!
     return if @view_dependencies == nil
     @view_dependencies.each do |dep|
@@ -48,6 +48,7 @@ module ViewModel
     end 
   end
   
+  # create all dependent views
   def create_dependencies!
     return if @view_dependencies == nil
     @view_dependencies.each do |dep|
@@ -61,41 +62,30 @@ module ViewModel
   
   # checks Postgresql relations for any view that uses current view.
   def get_dependencies
-    sql = "select distinct(cl2.relname) from pg_depend dep
-          join pg_class cl ON dep.refobjid = cl.oid
-          join pg_rewrite on dep.objid = pg_rewrite.oid
-          join pg_class cl2 on pg_rewrite.ev_class = cl2.oid
-          where cl.relname='#{table_name}' and cl2.relname != '#{table_name}' and deptype='n' "
-    result = execute(sql)
-    @view_dependencies = []
-    result.each do |row|
-      @view_dependencies << get_model(row["relname"])
-    end
-    if @view_dependencies.size > 0
-      puts "found dependencies: "
-      puts @view_dependencies.inspect
-    end
-
+    @view_dependencies = get_adapter.get_dependencies(connection, table_name)
   end
   
   def migrate!
     raise "Please provide a view_definition inside the model" if !view_definition_set?
-      get_dependencies
-      check_dependencies
-      drop_dependencies!
-      drop_view!
-      create_view!
-      create_dependencies!
-      true
-    end
-
-    def create_view!
-      puts "creating view #{table_name}"
+    get_dependencies
+    check_dependencies
+    drop_dependencies!
+    drop_view!
+    create_view!
+    create_dependencies!
+    true
+  end
+  
+  # Create the model's view according to it's definition.
+  def create_view!
+    puts "creating view #{table_name}"
     sql = "CREATE OR REPLACE VIEW #{table_name} AS "
     sql << @view_definition
     execute(sql)
   end
     
+  # Drops a view if exists.
+  # note: "if exists" works only on Postgresql 8.2 or later. Older versions are not supported.
   def drop_view!
     puts "dropping view #{table_name}"
     execute("DROP VIEW if exists #{table_name}")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: view-model
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Joachim Glauche
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-12 00:00:00 +01:00
+date: 2009-01-21 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -23,6 +23,9 @@ extra_rdoc_files:
 - README
 files: 
 - lib/view_model.rb
+- lib/adapters
+- lib/adapters/abstract_adapter.rb
+- lib/adapters/postgresql_adapter.rb
 - init.rb
 - LICENSE
 - README