rails_sql_views 0.6.1 → 0.8.0

data/CHANGELOG

@@ -15,4 +15,8 @@
 
 0.6.1 - Released June 6, 2007
  * Added test for union support
- * Updated tests to include new table to support union test
+ * Updated tests to include new table to support union test
+
+0.7.0
+ * Updated dependency versions to get on ActiveRecord 2.x. May not be compatible with Rails versions less than 2.x.
+ * Add nonview_tables support to *all* of the adapters (was missing from Postgres and SQLServer)

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2006-2008 Anthony Eden
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -3,7 +3,6 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 require 'rake/packagetask'
 require 'rake/gempackagetask'
-require 'rake/contrib/rubyforgepublisher'
 
 require File.join(File.dirname(__FILE__), 'lib/rails_sql_views', 'version')
 
@@ -28,6 +27,17 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
+namespace :rcov do
+  desc 'Measures test coverage'
+  task :test do
+    rm_f 'coverage.data'
+    mkdir 'coverage' unless File.exist?('coverage')
+    rcov = "rcov --aggregate coverage.data --text-summary -Ilib"
+    system("#{rcov} test/*_test.rb test/**/*_test.rb")
+    system("open coverage/index.html") if PLATFORM['darwin']
+  end
+end
+
 desc 'Generate documentation library.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
@@ -37,80 +47,28 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-PKG_FILES = FileList[
-  'CHANGELOG',
-  'README',
-  'Rakefile',
-  'bin/**/*',
-  'lib/**/*',
-] - [ 'test' ]
-
-spec = Gem::Specification.new do |s|
-  s.name = 'rails_sql_views'
-  s.version = PKG_VERSION
-  s.summary = "Adds SQL Views to Rails."
-  s.description = <<-EOF
-    Library which adds SQL Views to Rails.
-  EOF
-
-  s.add_dependency('activerecord', '>= 1.14.4')
-  s.add_dependency('rake', '>= 0.7.1')
-
-  s.rdoc_options << '--exclude' << '.'
-  s.has_rdoc = false
-
-  s.files = PKG_FILES.to_a.delete_if {|f| f.include?('.svn')}
-  s.require_path = 'lib'
-
-  s.author = "Anthony Eden"
-  s.email = "anthonyeden@gmail.com"
-  s.homepage = "http://activewarehouse.rubyforge.org/rails_sql_views"
-  s.rubyforge_project = "activewarehouse"
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-  pkg.need_tar = true
-  pkg.need_zip = true
-end
-
-desc "Generate code statistics"
-task :lines do
-  lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
-
-  for file_name in FileList["lib/**/*.rb"]
-    next if file_name =~ /vendor/
-    f = File.open(file_name)
-
-    while line = f.gets
-      lines += 1
-      next if line =~ /^\s*$/
-      next if line =~ /^\s*#/
-      codelines += 1
-    end
-    puts "L: #{sprintf("%4d", lines)}, LOC #{sprintf("%4d", codelines)} | #{file_name}"
-    
-    total_lines     += lines
-    total_codelines += codelines
-    
-    lines, codelines = 0, 0
-  end
-
-  puts "Total: Lines #{total_lines}, LOC #{total_codelines}"
-end
-
-desc "Publish the release files to RubyForge."
-task :release => [ :package ] do
-  `rubyforge login`
-
-  for ext in %w( gem tgz zip )
-    release_command = "rubyforge add_release activewarehouse #{PKG_NAME} 'REL #{PKG_VERSION}' pkg/#{PKG_NAME}-#{PKG_VERSION}.#{ext}"
-    puts release_command
-    system(release_command)
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "rails_sql_views"
+    s.summary = "Library which adds SQL Views to ActiveRecord."
+    s.email = "josh@technicalpickles.com"
+    s.homepage = "http://activewarehouse.rubyforge.org/rails_sql_views"
+    s.description = "Adds support for using SQL views within ActiveRecord"
+    s.authors = ["Anthony Eden"]
+    s.files =  FileList[
+      "CHANGELOG", 
+      "README",
+      "Rakefile",
+      "{bin,lib}/**/*"
+    ]
+    s.add_dependency 'activerecord'
   end
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
 desc "Publish the API documentation"
 task :pdoc => [:rdoc] do 
   Rake::SshDirPublisher.new("aeden@rubyforge.org", "/var/www/gforge-projects/activewarehouse/rails_sql_views/rdoc", "rdoc").upload
-end
+end

data/TODO

@@ -0,0 +1,2 @@
+
+- Use pre-existing Adapter#supports_views? where possible

data/lib/active_record/view.rb

@@ -0,0 +1,76 @@
+
+# A base class for database views.
+# It is primarily useful for views that are centered around a single table/model.
+module ActiveRecord # :nodoc:
+  class View < Base
+    self.abstract_class = true
+    
+    def readonly?
+      true
+    end
+    
+    class << self
+      # Clones all applicable associations from +model+ to this view
+      # and provides an instance method
+      # <tt>to_<em>model</em></tt>
+      # that casts a view object to an object of the kind view is
+      # based on. This latter object may be missing attributes; to fill
+      # them in, call #reload.
+      def based_on(model)
+        define_method("to_#{model.name.demodulize.underscore}") do
+          becomes(model)
+        end
+        
+        model.reflect_on_all_associations.each do |assoc|
+          clone_association(model, assoc)
+        end
+      end
+      
+      # Clone one or more associations from +model+ to this view class.
+      #
+      # NOTE: Currently only <tt>belongs_to</tt>, <tt>has_many</tt> (withouth
+      # <tt>:through</tt>), and <tt>has_and_belongs_to_many</tt> associations
+      # are supported.
+      def clone_association(model, *associations)
+        associations.each do |association|
+          r = case association
+              when String, Symbol
+                model.reflect_on_association(association.to_sym)
+              when ActiveRecord::Reflection::AssociationReflection
+                association
+              else
+                raise ArgumentError, "Unrecognized association #{association.inspect}; must be a Symbol, String, or AssociationReflection."
+              end
+          case r.macro
+          when :belongs_to
+            if self.column_names.include?(r.primary_key_name.to_s)
+              if !r.options[:foreign_type] || self.column_names.include?(r.options[:foreign_type])
+                options = r.options.merge(
+                  :class_name => r.class_name,
+                  :foreign_key => r.primary_key_name
+                )
+                belongs_to r.name, options
+              end
+            end
+          when :has_many
+            ### TODO :through assocications
+            options = r.options.merge(
+              :class_name => r.class_name,
+              :foreign_key => r.primary_key_name
+            )
+            has_many r.name, options
+          when :has_and_belongs_to_many
+            options = r.options.merge(
+              :class_name => r.class_name,
+              :foreign_key => r.primary_key_name,
+              :association_foreign_key => r.association_foreign_key
+            )
+            has_and_belongs_to_many r.name, options
+          when :has_one
+            ### TODO
+          end
+        end
+      end
+    end
+  end
+end

data/lib/core_ext/module.rb

@@ -1,11 +1,13 @@
 # This is required for 1.1.6 support
-class Module
-  def alias_method_chain(target, feature)
-    # Strip out punctuation on predicates or bang methods since
-    # e.g. target?_without_feature is not a valid method name.
-    aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
-    yield(aliased_target, punctuation) if block_given?
-    alias_method "#{aliased_target}_without_#{feature}#{punctuation}", target
-    alias_method target, "#{aliased_target}_with_#{feature}#{punctuation}"
+unless Module.respond_to?(:alias_method_chain)
+  class Module
+    def alias_method_chain(target, feature)
+      # Strip out punctuation on predicates or bang methods since
+      # e.g. target?_without_feature is not a valid method name.
+      aliased_target, punctuation = target.to_s.sub(/([?!=])$/, ''), $1
+      yield(aliased_target, punctuation) if block_given?
+      alias_method "#{aliased_target}_without_#{feature}#{punctuation}", target
+      alias_method target, "#{aliased_target}_with_#{feature}#{punctuation}"
+    end
   end
-end
+end

data/lib/rails_sql_views.rb

@@ -21,32 +21,27 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-  
-require 'rubygems'
-unless Kernel.respond_to?(:gem)
-  Kernel.send :alias_method, :gem, :require_gem
-end
-  
-unless defined?(ActiveRecord)
-  begin
-    $:.unshift(File.dirname(__FILE__) + "/../../activerecord/lib")
-    require 'active_record'
-  rescue LoadError
-    gem 'activerecord'
-  end
-end
+$:.unshift(File.dirname(__FILE__))
+
+require 'active_record'
 
 require 'core_ext/module'
 
 require 'rails_sql_views/connection_adapters/abstract/schema_definitions'
 require 'rails_sql_views/connection_adapters/abstract/schema_statements'
-require 'rails_sql_views/connection_adapters/mysql_adapter'
-require 'rails_sql_views/connection_adapters/postgresql_adapter'
-require 'rails_sql_views/connection_adapters/sqlserver_adapter'
+require 'rails_sql_views/connection_adapters/abstract_adapter'
 require 'rails_sql_views/schema_dumper'
+require 'rails_sql_views/loader'
 
-class ActiveRecord::ConnectionAdapters::AbstractAdapter
+ActiveRecord::ConnectionAdapters::AbstractAdapter.class_eval do
   include RailsSqlViews::ConnectionAdapters::SchemaStatements
-end
+  def self.inherited(sub)
+    RailsSqlViews::Loader.load_extensions
+  end
+end
+
+ActiveRecord::SchemaDumper.class_eval do
+  include RailsSqlViews::SchemaDumper
+end
+
+RailsSqlViews::Loader.load_extensions

data/lib/rails_sql_views/connection_adapters/abstract/schema_definitions.rb

@@ -10,10 +10,6 @@ module RailsSqlViews
         @select_query = select_query
       end
       
-      def [](name)
-        @columns[name.to_s]
-      end
-      
       def column(name)
         column = name.to_s
         @columns << column unless @columns.include? column
@@ -21,7 +17,7 @@ module RailsSqlViews
       end
       
       def to_sql
-        @columns * ', '
+        @columns.collect { |c| @base.quote_column_name(c) } * ', '
       end
       
     end
@@ -64,4 +60,4 @@ module RailsSqlViews
       end
     end
   end
-end
+end

data/lib/rails_sql_views/connection_adapters/abstract/schema_statements.rb

@@ -1,6 +1,10 @@
 module RailsSqlViews
   module ConnectionAdapters # :nodoc:
     module SchemaStatements
+      def self.included(base)
+        base.alias_method_chain :drop_table, :cascade
+      end
+
       # Create a view.
       # The +options+ hash can include the following keys:
       # [<tt>:check_option</tt>]
@@ -9,17 +13,23 @@ module RailsSqlViews
       def create_view(name, select_query, options={})
         if supports_views?
           view_definition = ViewDefinition.new(self, select_query)
-
-          yield view_definition
+          
+          if block_given?
+            yield view_definition
+          end
 
           if options[:force]
             drop_view(name) rescue nil
           end
 
           create_sql = "CREATE VIEW "
-          create_sql << "#{name} ("
-          create_sql << view_definition.to_sql
-          create_sql << ") AS #{view_definition.select_query}"
+          create_sql << "#{quote_table_name(name)} "
+          if supports_view_columns_definition? && !view_definition.to_sql.blank?
+            create_sql << "("
+            create_sql << view_definition.to_sql
+            create_sql << ") " 
+          end
+          create_sql << "AS #{view_definition.select_query}"
           create_sql << " WITH #{options[:check_option]} CHECK OPTION" if options[:check_option]
           execute create_sql
         end
@@ -40,10 +50,17 @@ module RailsSqlViews
           drop_view(new_name) rescue nil
         end
 
-        view_sql = "CREATE VIEW #{new_name} (#{mapper.view_cols.join(', ')}) "
-        view_sql << "AS SELECT #{mapper.select_cols.join(', ')} FROM #{old_name}"
+        view_sql = "CREATE VIEW #{new_name} "
+        if supports_view_columns_definition?
+          view_sql << "(#{mapper.view_cols.collect { |c| quote_column_name(c) }.join(', ')}) "
+        end
+        view_sql << "AS SELECT #{mapper.select_cols.collect { |c| quote_column_name(c) }.join(', ')} FROM #{old_name}"
         execute view_sql
       end
+
+      def drop_table_with_cascade(table_name, options = {})
+        execute "DROP TABLE #{quote_table_name(table_name)} CASCADE"
+      end
       
       # Drop a view.
       # The +options+ hash can include the following keys:
@@ -52,11 +69,11 @@ module RailsSqlViews
       #   database documentation to determine what drop behaviors are available.
       def drop_view(name, options={})
         if supports_views?
-          drop_sql = "DROP VIEW #{name}"
+          drop_sql = "DROP VIEW #{quote_table_name(name)}"
           drop_sql << " #{options[:drop_behavior]}" if options[:drop_behavior]
           execute drop_sql
         end
       end
     end
   end
-end
+end

data/lib/rails_sql_views/connection_adapters/abstract_adapter.rb

@@ -1,10 +1,31 @@
-module ActiveRecord
+module RailsSqlViews
   module ConnectionAdapters
-    class AbstractAdapter
+    module AbstractAdapter
+      def self.included(base)
+        base.alias_method_chain :disable_referential_integrity, :views_excluded
+      end
+
       # Subclasses should override and return true if they support views.
       def supports_views?
         return false
       end
+
+      # Subclasses should override and return false if they don't support CASCADE
+      def supports_drop_table_cascade?
+        return true
+      end
+      
+      def disable_referential_integrity_with_views_excluded(&block)
+        self.class.send(:alias_method, :original_tables_method, :tables)
+        self.class.send(:alias_method, :tables, :base_tables)
+        disable_referential_integrity_without_views_excluded(&block)
+      ensure
+        self.class.send(:alias_method, :tables, :original_tables_method)
+      end
+      
+      def supports_view_columns_definition?
+        true
+      end
       
       # Get a list of all views for the current database
       def views(name = nil)
@@ -17,4 +38,4 @@ module ActiveRecord
       end
     end
   end
-end
+end

data/lib/rails_sql_views/connection_adapters/mysql_adapter.rb

@@ -1,29 +1,56 @@
-module ActiveRecord
+module RailsSqlViews
   module ConnectionAdapters
-    class MysqlAdapter
+    module MysqlAdapter
+      def self.included(base)
+        if base.private_method_defined?(:supports_views?)
+          base.send(:public, :supports_views?)
+        end
+      end
+
       # Returns true as this adapter supports views.
       def supports_views?
         true
       end
       
-      def tables(name = nil) #:nodoc:
+      def base_tables(name = nil) #:nodoc:
         tables = []
-        execute("SHOW TABLE STATUS", name).each { |row| tables << row[0] if row[17] != 'VIEW' }
+        execute("SHOW FULL TABLES WHERE TABLE_TYPE='BASE TABLE'").each{|row| tables << row[0]}
         tables
       end
+      alias nonview_tables base_tables
       
       def views(name = nil) #:nodoc:
         views = []
-        execute("SHOW TABLE STATUS", name).each { |row| views << row[0] if row[17] == 'VIEW' }
+        execute("SHOW FULL TABLES WHERE TABLE_TYPE='VIEW'").each{|row| views << row[0]}
         views
       end
+
+      def tables_with_views_included(name = nil)
+        nonview_tables(name) + views(name)
+      end
       
+      def structure_dump
+        structure = ""
+        base_tables.each do |table|
+          structure += select_one("SHOW CREATE TABLE #{quote_table_name(table)}")["Create Table"] + ";\n\n"
+        end
+
+        views.each do |view|
+          structure += select_one("SHOW CREATE VIEW #{quote_table_name(view)}")["Create View"] + ";\n\n"
+        end
+
+        return structure
+      end
+
       # Get the view select statement for the specified table.
       def view_select_statement(view, name=nil)
-        row = execute("SHOW CREATE VIEW #{view}", name).each do |row|
-          return convert_statement(row[1]) if row[0] == view
+        begin
+          row = execute("SHOW CREATE VIEW #{view}", name).each do |row|
+            return convert_statement(row[1]) if row[0] == view
+          end
+        rescue ActiveRecord::StatementInvalid => e
+          raise "No view called #{view} found"
         end
-        raise "No view called #{view} found"
       end
       
       private
@@ -32,4 +59,4 @@ module ActiveRecord
       end
     end
   end
-end
+end