rails_on_pg 0.0.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Alex Tretyakov
+
+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/README.rdoc

@@ -0,0 +1,53 @@
+h1. RailsOnPG
+
+This is timesaver for middle/large Rails application which used PostgreSQL as database.
+Create/drop Views, Functions, Triggers, Foreign keys in your migrations using ruby syntax.
+
+h2. Installation
+
+<pre>
+  script/plugin install git://github.com/alex3t/rails_on_pg.git
+</pre>
+
+h2. Views
+
+<pre>
+  create_view :active_patients do |view|
+    view.select 'p.patient_id as id' ,'p.id as visit_id'
+    view.from 'patients as p'
+    view.join 'left join demographics d on d.visit_id=v.id'
+    view.conditions 'p.status'=>'active','p.name' => 'John' #or "p.status='active' and p.name='John'"
+  end
+</pre>
+
+h2. Functions
+
+<pre>
+  create_function 'format_name', {:returns=>'character varying'}, 'first_name character varying(125)', 'middle_name character varying(15)', "last_name character varying(20)" do
+    "RETURN COALESCE(last_name, 'no last name') || ', ' || COALESCE(first_name, 'no first name');"
+  end
+</pre>
+
+h2. Triggers
+
+<pre>
+  create_trigger "update_status", :before, "users", "insert","update"
+    #update status function body here
+  end
+</pre>
+
+h2. Foreign keys
+
+<pre>
+  add_foreign_key :order_items, :product_id, :orders, :on_delete=>""
+</pre>
+
+For more details see rdoc or tests
+
+
+h3. Todo
+
+Make as gem
+
+
+Copyright (c) 2009 Alex Tretyakov, released under MIT license

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rails_on_pg"
+    gem.summary = %Q{Add PostgreSQL functionality to create/drop views, functions, triggers and foreign keys in migrations.}
+    gem.description = %Q{This is timesaver for middle/large Rails application which used PostgreSQL as database. Create/drop Views, Functions, Triggers, Foreign keys in your migrations using ruby syntax.}
+    gem.email = "marcus.wyatt@visfleet.com"
+    gem.homepage = "http://github.com/alex3t/rails_on_pg"
+    gem.authors = ["Alex Tretyakov"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rails_on_pg #{version}"
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/rails_on_pg.rb

@@ -0,0 +1,10 @@
+
+require "rails_on_pg/foreign_keys"
+require "rails_on_pg/views"
+require "rails_on_pg/functions"
+
+ActiveRecord::Migration.send(:extend, RailsOnPg::ForeignKeys)
+ActiveRecord::Migration.send(:extend, RailsOnPg::Views)
+ActiveRecord::Migration.send(:extend, RailsOnPg::Functions)
+
+

data/lib/rails_on_pg/foreign_keys.rb

@@ -0,0 +1,38 @@
+module RailsOnPg
+  module ForeignKeys
+  
+    # Define new foreign key
+    # Example:
+    #   add_foreign_key :order_items,:product_id,:orders
+    # where orders is orders is referenced table and order_items is referencing table
+    # foreign key will be: 'fk_order_items_product_id'
+    # optional options: 
+    #   <tt>:on_delete</tt>
+    #   <tt>:on_update</tt>
+    #   <tt>:column</tt>
+    def add_foreign_key(from_table, from_column, to_table, options={})
+      # default delete and on update actions
+      options.reverse_merge!({:on_delete=>'NO ACTION', :on_update=>'NO ACTION',:column=>'id'})
+      constraint_name = "fk_#{from_table}_#{from_column}"
+
+      execute %{ALTER TABLE #{from_table}
+                ADD CONSTRAINT #{constraint_name}
+                FOREIGN KEY (#{from_column})
+                REFERENCES #{to_table}(#{options[:column]}) 
+                ON UPDATE #{options[:on_update]} 
+                ON DELETE #{options[:on_delete]} }
+    end
+  
+    # Remove prev created key
+    def remove_foreign_key(from_table, from_column, to_table)
+      constraint_name = "fk_#{from_table}_#{from_column}"
+      # check if constraint already exist
+      count = ActiveRecord::Base.connection.select_value("select count(1) from pg_constraint where conname='#{constraint_name}'")
+
+      unless count.to_i == 0
+        execute %{ALTER TABLE #{from_table} DROP CONSTRAINT #{constraint_name}}
+      end
+    end
+  
+  end
+end

data/lib/rails_on_pg/functions.rb

@@ -0,0 +1,62 @@
+module RailsOnPg
+  module Functions
+    
+    # Create new plpgsql function
+    # Example:
+    #  create_function 'format_name', {:returns=>'character varying'}, 'first_name character varying(125)', 'middle_name character varying(15)', "last_name character varying(20)" do
+    #    "RETURN COALESCE(last_name, 'no last name') || ', ' || COALESCE(first_name, 'no first name') || ' ' || COALESCE(middle_name || '.','');"
+    #  end    
+    def create_function name, options={}, *params
+      options.reverse_merge!({:as=>'$$'})
+      returns = options[:returns]
+      declare = %{DECLARE 
+                  #{options[:declare].join(';')}} if options[:declare]
+      drop_function name, params
+      # execute
+      set_lang
+      execute %{CREATE FUNCTION #{name}(#{params.join(',')}) RETURNS #{returns} AS #{options[:as]}
+      #{declare}
+      BEGIN
+        #{yield}
+      END;
+      #{options[:as]} LANGUAGE 'plpgsql';
+      }
+    end
+    
+    # drop function   
+    def drop_function name, *params
+      execute "DROP FUNCTION IF EXISTS #{name}(#{params.join(',')}) CASCADE"    
+    end
+   
+    # Create trigger function for it
+    # <tt>name</tt> - trigger name
+    # <tt>type</tt> - :before or :after
+    # <tt>table_name</tt> - table name
+    # <tt>actions</tt> - "insert","update","delete"
+    # Example:
+    #    create_trigger "some_tr", :before, "users", "insert","update"
+    def create_trigger name, type, table_name, *actions
+      create_function "#{name}_f", :returns=>'trigger',:as=>'$BODY$' do
+        yield
+      end
+      execute %{CREATE TRIGGER #{name} #{type.to_s.upcase} #{actions.map{|str|str.upcase}.join(' OR ')}
+      ON "#{table_name}" FOR EACH ROW
+      EXECUTE PROCEDURE #{name}_f();}
+    end
+    
+    # Drop trigger
+    def drop_trigger name, table_name
+      execute "DROP TRIGGER #{name} on #{table_name} CASCADE"    
+    end
+   
+   private
+    def set_lang lang='plpgsql'
+      begin
+        execute("CREATE LANGUAGE #{lang}")
+      rescue ActiveRecord::StatementInvalid => ex      
+      end
+    end
+   
+    
+  end
+end

data/lib/rails_on_pg/views.rb

@@ -0,0 +1,115 @@
+module RailsOnPg
+  module Views
+    
+    # Create new view
+    # <tt>name</tt> - name of view 
+    # Example:     
+    #   create_view :active_patients do |v|
+    #     v.select 'p.patient_id as id' ,'p.id as visit_id'
+    #     v.from 'patients as p'
+    #     v.join 'left join demographics d on d.visit_id=v.id'
+    #     v.join 'left join diagnoses di on di.visit_id=v.id and di.row_index=0'
+    #     v.conditions 'p.status'=>'active','p.name' => 'John' #or "p.status='active' and p.name='John'"
+    #   end
+    # See ViewDefinition class
+    def create_view name, options={}, &block      
+      view_def = ViewDefinition.new name, &block
+      
+      drop_views name, options[:dependent_views]      
+      execute view_def.to_sql
+    end
+    
+    # Update view's select columns
+    # <tt>name</tt> - name of existed view 
+    # <tt>type</tt> - type of action(:add,:remove or :replace) 
+    # <tt>columns</tt> - array of columns or string
+    # <tt>options</tt> - options
+    # Options:
+    # <tt>:dependent_views</tt> - if view has dependent views(views where current view used) then you need list them here
+    # Example:
+    #   update_view :active_patients, :add, ['p.first_name as name','p.age as dob']
+    #   update_view :active_patients, :add, 'p.first_name as name', :dependent_views=>['view0','view1']
+    #   update_view :active_patients, :remove, 'p.first_name as name', :dependent_views=>['view0','view1']
+    #   update_view :active_patients, :replace, ['p.first_name as name','p.age as dob'] #replace all select columns
+    def update_view name, type, columns, options={}
+      view_structure = ActiveRecord::Base.connection.select_value("select definition from pg_views where viewname='#{name}'")
+      raise ViewNotExistException("View #{name} does not exist in current db") unless view_structure
+      
+      columns_str = columns.is_a?(Array) ? columns.join(',') : columns
+      
+      select_pattern = /select (.*) from/i
+      select_str = view_structure[select_pattern,1]
+
+      case type
+        when :add
+          view_structure.gsub!(select_pattern, "SELECT #{select_str}, #{columns_str} FROM")
+        when :remove
+          select_str.gsub!(", #{columns_str}", '')
+          view_structure.gsub!(select_pattern, "SELECT #{select_str} FROM")
+        when :replace
+          view_structure.gsub!(select_pattern, "SELECT #{columns_str} FROM")
+      end
+
+      drop_views name, options[:dependent_views] 
+      execute "CREATE VIEW #{name} AS #{view_structure};"
+    end
+    
+    # drop dependent views before if exists
+    # Options
+    # <tt>:dependent_views</tt> - if view has dependent views(views where current view used) then you need list them here    
+    def drop_views name, defs=nil
+      defs = defs.delete(:dependent_views) if defs.is_a?(Hash)
+      defs.each do |dependent_view|
+        execute "DROP VIEW IF EXISTS #{dependent_view}"
+      end if defs
+      
+      execute "DROP VIEW IF EXISTS #{name}"
+
+    end
+    
+    # recreate view without changes
+    def recreate_view name
+      view_structure = ActiveRecord::Base.connection.select_value("select definition from pg_views where viewname='#{name}'")
+      if view_structure
+        execute "DROP VIEW IF EXISTS #{name}"
+        execute "CREATE VIEW #{name} AS #{view_structure};"
+      end
+    end
+    
+    # ===========
+    # = Classes =
+    # ===========
+    class ViewNotExistException < Exception; end    
+    
+    # View definition, see create_view dsl
+    class ViewDefinition
+      def initialize name, &block
+        @joins = []
+        @name = name
+        instance_eval &block
+      end
+      
+      def select *columns
+        @select = columns.join(',')
+      end
+      def from *tables
+        @from = tables.join(',')
+      end
+      def join value
+        @joins << value
+      end
+      def conditions cond
+
+        @where = cond.collect{ |attrib, value| "#{attrib} = #{value}"}.join(" AND ") if cond.is_a?(Hash)
+        @where = cond if cond.is_a?(String)
+      end
+
+      def to_sql
+        @where ||= '1=1'
+        "CREATE VIEW #{@name} AS SELECT #{@select} FROM #{@from} #{@joins.join(' ')} WHERE #{@where};"
+      end
+    end
+    
+        
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'rails_on_pg'

data/test/foreign_keys_test.rb

@@ -0,0 +1,14 @@
+require 'test_helper'
+
+
+
+class ForeignKeysTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "should create new foreign key" do
+    MigrationTest.remove_foreign_key :projects, :user_id, :users
+    MigrationTest.add_foreign_key :projects, :user_id, :users
+    fk_name = 'fk_projects_user_id'
+    count = ActiveRecord::Base.connection.select_value("select count(1) from pg_constraint where conname='#{fk_name}'")
+    assert_equal 1, count.to_i
+  end
+end

data/test/functions_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+class FunctionsTest < ActiveSupport::TestCase
+	def setup
+	  
+  
+	end
+	
+  test "should create new function" do
+    MigrationTest.create_function 'format_name', {:returns=>'character varying'}, 'first_name character varying(125)', 'middle_name character varying(15)', "last_name character varying(20)" do
+      "RETURN COALESCE(last_name, 'no last name') || ', ' || COALESCE(first_name, 'no first name') || ' ' || COALESCE(middle_name || '.','');"
+    end    
+    f_count = ActiveRecord::Base.connection.select_value(
+    "select count(1) from pg_proc where proname='format_name'")
+    assert_equal 1, f_count.to_i
+  end
+  
+  test "should succefully drop function" do
+    MigrationTest.drop_function 'format_name', 'first_name character varying(125)', 'middle_name character varying(15)', "last_name character varying(20)"
+    f_count = ActiveRecord::Base.connection.select_value(
+    "select count(1) from pg_proc where proname='format_name'")
+    assert_equal 0, f_count.to_i
+  end
+
+  test "should create new trigger" do
+    MigrationTest.create_trigger "some_tr", :before, "users", "insert","update" do
+      
+    end
+    f_count = ActiveRecord::Base.connection.select_value(
+    "select count(1) from pg_trigger where tgname='some_tr'")
+    assert_equal 1, f_count.to_i
+  end
+  
+  test "should succefully drop trigger" do
+    MigrationTest.drop_trigger 'some_tr','users'
+    f_count = ActiveRecord::Base.connection.select_value(
+    "select count(1) from pg_trigger where tgname='some_tr'")
+    assert_equal 0, f_count.to_i
+  end
+  
+	
+	
+end

data/test/helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'active_record'
+require 'test/unit'
+
+# ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+
+
+# config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+ActiveRecord::Base.logger = Logger.new(File.dirname(__FILE__) + "/debug.log")
+
+
+# ActiveRecord::Base.establish_connection(config['test'])
+
+ActiveRecord::Base.establish_connection({
+  :adapter => 'postgresql',
+  :database => 'test2',
+  :username => 'postgres',
+  :password => 'postgres',
+  :host => 'localhost',
+})
+
+
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+class MigrationTest < ActiveRecord::Migration
+end

data/test/schema.rb

@@ -0,0 +1,26 @@
+ActiveRecord::Schema.define(:version => 0) do
+
+  create_table "projects", :force => true do |t|
+    t.string   "name"
+    t.integer  "user_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "tasks", :force => true do |t|
+    t.string   "value"
+    t.integer  "project_id"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  create_table "users", :force => true do |t|
+    t.string   "login"
+    t.string   "email"
+    t.text     "about"
+    t.boolean  "is_active"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+  
+end

data/test/views_test.rb

@@ -0,0 +1,59 @@
+require 'test_helper'
+
+class ViewsTest < ActiveSupport::TestCase
+	def setup
+	  
+    MigrationTest.create_view 'active_users' do |v|
+      v.select 'u.id','u.login'
+      v.from 'users as u'
+      v.conditions 'is_active'=>'true'
+    end	  
+	end
+	  
+
+  test "create view" do
+    
+    def_expected = %{SELECT u.id, u.login FROM users u WHERE (u.is_active = true);}
+    def_created = ActiveRecord::Base.connection.select_value("select definition from pg_views where viewname='active_users'")
+    assert_equal def_expected, def_created 
+    MigrationTest.drop_views 'active_users'
+  end
+
+  test "add column to view" do
+    
+    MigrationTest.update_view 'active_users', :add, 'u.email', :dependent_views=>[:active_test_users]
+    def_expected = %{SELECT u.id, u.login, u.email FROM users u WHERE (u.is_active = true);}
+    def_created = ActiveRecord::Base.connection.select_value("select definition from pg_views where viewname='active_users'")
+    assert_equal def_expected, def_created 
+    MigrationTest.drop_views 'active_users'
+  end
+  test "remove column to view" do
+    
+    MigrationTest.update_view 'active_users', :remove, 'u.login', :dependent_views=>[:active_test_users]
+    def_expected = %{SELECT u.id FROM users u WHERE (u.is_active = true);}
+    def_created = ActiveRecord::Base.connection.select_value("select definition from pg_views where viewname='active_users'")
+    assert_equal def_expected, def_created 
+    MigrationTest.drop_views 'active_users'
+  end
+  test "replace columns" do
+    
+    MigrationTest.update_view 'active_users', :replace, 'u.login,u.email', :dependent_views=>[:active_test_users]
+    def_expected = %{SELECT u.login, u.email FROM users u WHERE (u.is_active = true);}
+    def_created = ActiveRecord::Base.connection.select_value("select definition from pg_views where viewname='active_users'")
+    assert_equal def_expected, def_created 
+    MigrationTest.drop_views 'active_users'
+  end
+  
+  test "drop dependent views" do
+    MigrationTest.create_view 'active_test_users' do |v|
+      v.select '*'
+      v.from 'active_users'
+      v.conditions "active_users.login like '%test%'"
+    end	  
+    MigrationTest.drop_views 'active_users', :dependent_views=>[:active_test_users]
+    count_active_test_users = ActiveRecord::Base.connection.select_value("select count(1) from pg_views where viewname='active_test_users'")
+    assert_equal 0, count_active_test_users.to_i
+    count_active_users = ActiveRecord::Base.connection.select_value("select count(1) from pg_views where viewname='active_users'")
+    assert_equal 0, count_active_users.to_i
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: rails_on_pg
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Alex Tretyakov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-19 00:00:00 +13:00
+default_executable: 
+dependencies: []
+
+description: This is timesaver for middle/large Rails application which used PostgreSQL as database. Create/drop Views, Functions, Triggers, Foreign keys in your migrations using ruby syntax.
+email: marcus.wyatt@visfleet.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rails_on_pg.rb
+- lib/rails_on_pg/foreign_keys.rb
+- lib/rails_on_pg/functions.rb
+- lib/rails_on_pg/views.rb
+- rails/init.rb
+- test/foreign_keys_test.rb
+- test/functions_test.rb
+- test/helper.rb
+- test/schema.rb
+- test/views_test.rb
+has_rdoc: true
+homepage: http://github.com/alex3t/rails_on_pg
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Add PostgreSQL functionality to create/drop views, functions, triggers and foreign keys in migrations.
+test_files: 
+- test/foreign_keys_test.rb
+- test/functions_test.rb
+- test/helper.rb
+- test/schema.rb
+- test/views_test.rb