rails_sql_views 0.1.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.1.0 - 
+ * Initial release

data/README

@@ -0,0 +1,44 @@
+== Rails SQL Views
+
+Library which adds SQL Views to Rails. Adds create_view and drop_view to the ActiveRecord::ConnectionAdapters::AbstractAdapter.
+
+== Installation
+
+To install:
+
+  gem install rails_sql_views
+ 
+Then add the following to your Rails config/environment.rb:
+
+  require_gem 'rails_sql_views'
+  require 'rails_sql_views'
+
+== Usage
+
+You can then use create_view and drop_view in your migrations. For example:
+
+  class CreatePersonView < ActiveRecord::Migration
+    def self.up
+      create_view :v_people, "select * from people" do |t|
+        t.column :id
+        t.column :name
+        t.column :social_security
+      end
+    end
+
+    def self.down
+      drop_view :v_people
+    end
+  end
+  
+This extension also adds support for views in the ActiveRecord::SchemaDumper class, however currently only MySQL is supported.
+
+== Known Issues
+
+* None
+
+If you find any issues please send an email to anthonyeden@gmail.com .
+
+== Contributing
+
+If you would like to implement view support for other adapters then please drop me an email. Better yet, write up the adapter modifications and send them to me. :-)

data/Rakefile

@@ -0,0 +1,115 @@
+require 'rake'
+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')
+
+PKG_BUILD       = ENV['PKG_BUILD'] ? '.' + ENV['PKG_BUILD'] : ''
+PKG_NAME        = 'rails_sql_views'
+PKG_VERSION     = RailsSqlViews::VERSION::STRING + PKG_BUILD
+PKG_FILE_NAME   = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_DESTINATION = ENV["PKG_DESTINATION"] || "../#{PKG_NAME}"
+
+RELEASE_NAME  = "REL #{PKG_VERSION}"
+
+RUBY_FORGE_PROJECT = "activewarehouse"
+RUBY_FORGE_USER    = "aeden"
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the library.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation library.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rails SQL Views'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  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.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)
+  end
+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

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

@@ -0,0 +1,29 @@
+module RailsSqlViews
+  module ConnectionAdapters #:nodoc:
+    # Abstract definition of a View
+    class ViewDefinition
+      attr_accessor :columns, :select_query
+      
+      def initialize(base, select_query)
+        @columns = []
+        @base = base
+        @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
+        self
+      end
+      
+      def to_sql
+        @columns * ', '
+      end
+      
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module RailsSqlViews
+  module ConnectionAdapters # :nodoc:
+    module SchemaStatements
+      # Create a view.
+      # The +options+ hash can include the following keys:
+      # [<tt>:check_option</tt>]
+      #   Specify restrictions for inserts or updates in updatable views. ANSI SQL 92 defines two check option
+      #   values: CASCADED and LOCAL. See your database documentation for allowed values.
+      def create_view(name, select_query, options={})
+        view_definition = ViewDefinition.new(self, select_query)
+
+        yield view_definition
+
+        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 << " WITH #{options[:check_option]} CHECK OPTION" if options[:check_option]
+        execute create_sql
+      end
+      
+      # Drop a view.
+      # The +options+ hash can include the following keys:
+      # [<tt>:drop_behavior</tt>]
+      #   Specify the drop behavior. ANSI SQL 92 defines two drop behaviors, CASCADE and RESTRICT. See your
+      #   database documentation to determine what drop behaviors are available.
+      def drop_view(name, options={})
+        drop_sql = "DROP VIEW #{name}"
+        drop_sql << " #{options[:drop_behavior]}" if options[:drop_behavior]
+        execute drop_sql
+      end
+    end
+  end
+end

data/lib/rails_sql_views/connection_adapters/abstract_adapter.rb

@@ -0,0 +1,15 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class AbstractAdapter
+      # Subclasses should override and return true if they support views.
+      def supports_views?
+        return false
+      end
+      
+      # Get a list of all views for the current database
+      def views(name = nil) #:nodoc:
+        raise NotImplementedError, "views is an abstract method"
+      end
+    end
+  end
+end

data/lib/rails_sql_views/connection_adapters/mysql_adapter.rb

@@ -0,0 +1,22 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class MysqlAdapter
+      # Returns true as this adapter supports views.
+      def supports_views?
+        true
+      end
+      
+      def tables(name = nil) #:nodoc:
+        tables = []
+        execute("SHOW TABLE STATUS", name).each { |field| tables << field[0] if field[17] != 'VIEW' }
+        tables
+      end
+      
+      def views(name = nil) #:nodoc:
+        views = []
+        execute("SHOW TABLE STATUS", name).each { |field| views << field[0] if field[17] == 'VIEW' }
+        views
+      end
+    end
+  end
+end

data/lib/rails_sql_views/schema_dumper.rb

@@ -0,0 +1,62 @@
+module ActiveRecord
+  class SchemaDumper
+    
+    # A list of views which should not be dumped to the schema. 
+    # Acceptable values are strings as well as regexp.
+    # This setting is only used if ActiveRecord::Base.schema_format == :ruby
+    cattr_accessor :ignore_views 
+    @@ignore_views = []
+    
+    # Add views to the end of the dump stream
+    def dump_with_views(stream)
+      dump_without_views(stream)
+      views(stream)
+      stream
+    end
+    alias_method_chain :dump, :views
+    
+    # Add views to the stream
+    def views(stream)
+      @connection.views.sort.each do |v|
+        next if ["schema_info", ignore_views].flatten.any? do |ignored|
+          case ignored
+          when String: v == ignored
+          when Regexp: v =~ ignored
+          else
+            raise StandardError, 'ActiveRecord::SchemaDumper.ignore_views accepts an array of String and / or Regexp values.'
+          end
+        end 
+        view(v, stream)
+      end
+    end
+    
+    # Add the specified view to the stream
+    def view(view, stream)
+      columns = @connection.columns(view).collect { |c| c.name }
+      begin
+        v = StringIO.new
+
+        v.print "  create_view #{view.inspect}"
+        v.print ", :force => true"
+        v.puts " do |v|"
+
+        columns.each do |column|
+          v.print "    v.column :#{column}"
+          v.puts
+        end
+
+        v.puts "  end"
+        v.puts
+        
+        v.rewind
+        stream.print v.read
+      rescue => e
+        stream.puts "# Could not dump view #{view.inspect} because of following #{e.class}"
+        stream.puts "#   #{e.message}"
+        stream.puts
+      end
+      
+      stream
+    end
+  end
+end

data/lib/rails_sql_views/version.rb

@@ -0,0 +1,9 @@
+module RailsSqlViews
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/rails_sql_views.rb

@@ -0,0 +1,44 @@
+#--
+# Copyright (c) 2006 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.
+#++
+
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+  
+unless defined?(ActiveRecord)
+  begin
+    $:.unshift(File.dirname(__FILE__) + "/../../activerecord/lib")
+    require 'active_record'
+  rescue LoadError
+    require 'rubygems'
+    require_gem 'activerecord'
+  end
+end
+
+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/schema_dumper'
+
+class ActiveRecord::ConnectionAdapters::AbstractAdapter
+  include RailsSqlViews::ConnectionAdapters::SchemaStatements
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: rails_sql_views
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2006-12-27 00:00:00 -05:00
+summary: Adds SQL Views to Rails.
+require_paths: 
+- lib
+email: anthonyeden@gmail.com
+homepage: http://activewarehouse.rubyforge.org/rails_sql_views
+rubyforge_project: activewarehouse
+description: Library which adds SQL Views to Rails.
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Anthony Eden
+files: 
+- CHANGELOG
+- README
+- Rakefile
+- lib/rails_sql_views
+- lib/rails_sql_views.rb
+- lib/rails_sql_views/connection_adapters
+- lib/rails_sql_views/schema_dumper.rb
+- lib/rails_sql_views/version.rb
+- lib/rails_sql_views/connection_adapters/abstract
+- lib/rails_sql_views/connection_adapters/abstract_adapter.rb
+- lib/rails_sql_views/connection_adapters/mysql_adapter.rb
+- lib/rails_sql_views/connection_adapters/abstract/schema_definitions.rb
+- lib/rails_sql_views/connection_adapters/abstract/schema_statements.rb
+test_files: []
+
+rdoc_options: 
+- --exclude
+- .
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.14.4
+    version: