activerecord-postgresql-extensions 0.0.9 → 0.0.10

data/Rakefile

@@ -4,7 +4,15 @@
 require 'rubygems'
 require 'rubygems/package_task'
 require 'rake/testtask'
-require 'rdoc/task'
+require 'rake/rdoctask'
+
+if RUBY_VERSION >= '1.9'
+  begin
+    gem 'psych'
+  rescue Exception => e
+    # it's okay, fall back on the bundled psych
+  end
+end
 
 $:.push 'lib'
 

data/VERSION

@@ -1 +1 @@
-0.0.9
+0.0.10

data/activerecord-postgresql-extensions.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{activerecord-postgresql-extensions}
-  s.version = "0.0.9"
+  s.name = "activerecord-postgresql-extensions"
+  s.version = "0.0.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{J Smith}]
-  s.date = %q{2011-07-14}
-  s.description = %q{A whole bunch of extensions the ActiveRecord PostgreSQL adapter.}
-  s.email = %q{code@zoocasa.com}
+  s.authors = ["J Smith"]
+  s.date = "2011-10-05"
+  s.description = "A whole bunch of extensions the ActiveRecord PostgreSQL adapter."
+  s.email = "code@zoocasa.com"
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
     "lib/postgresql_extensions/postgresql_indexes.rb",
     "lib/postgresql_extensions/postgresql_languages.rb",
     "lib/postgresql_extensions/postgresql_permissions.rb",
+    "lib/postgresql_extensions/postgresql_roles.rb",
     "lib/postgresql_extensions/postgresql_rules.rb",
     "lib/postgresql_extensions/postgresql_schemas.rb",
     "lib/postgresql_extensions/postgresql_sequences.rb",
@@ -45,16 +46,17 @@ Gem::Specification.new do |s|
     "test/index_test.rb",
     "test/languages_test.rb",
     "test/permissions_test.rb",
+    "test/roles_test.rb",
     "test/rules_test.rb",
     "test/schemas_test.rb",
     "test/sequences_test.rb",
     "test/tables_test.rb",
     "test/test_helper.rb"
   ]
-  s.homepage = %q{http://github.com/zoocasa/activerecord-postgresql-extensions}
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.5}
-  s.summary = %q{A whole bunch of extensions the ActiveRecord PostgreSQL adapter.}
+  s.homepage = "http://github.com/zoocasa/activerecord-postgresql-extensions"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "A whole bunch of extensions the ActiveRecord PostgreSQL adapter."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/lib/activerecord-postgresql-extensions.rb

@@ -21,6 +21,7 @@ dirname = File.join(File.dirname(__FILE__), 'postgresql_extensions')
   postgresql_views
   postgresql_geometry
   postgresql_types
+  postgresql_roles
   foreign_key_associations
 }.each do |file|
   require File.join(dirname, file)

data/lib/postgresql_extensions/postgresql_adapter_extensions.rb

@@ -426,6 +426,43 @@ module ActiveRecord
         SQL
       end
 
+      def roles(name = nil)
+        query(<<-SQL, name).map { |row| row[0] }
+          SELECT rolname
+          FROM pg_roles
+        SQL
+      end
+
+      def role_exists?(name)
+        roles.include?(name)
+      end
+
+      # Sets the current database role/user. The :duration option can be set to
+      # :session or :local as described in the PostgreSQL docs.
+      def set_role(role, options = {})
+        duration = if options[:duration]
+          if [ :session, :local ].include?(options[:duration])
+            options[:duration].to_s.upcase
+          else
+            raise ArgumentError.new("The :duration option must be one of :session or :local.")
+          end
+        end
+
+        sql = 'SET '
+        sql << "#{duration} " if duration
+        sql << "ROLE #{quote_role(role)}"
+        execute(sql, "Setting current role")
+      end
+
+      def reset_role
+        execute('RESET ROLE')
+      end
+
+      def current_role
+        execute('SELECT current_role')
+      end
+      alias :current_user :current_role
+
       # Returns an Array of tables to ignore.
       def ignored_tables(name = nil)
         query(<<-SQL, name).map { |row| row[0] }

data/lib/postgresql_extensions/postgresql_roles.rb

@@ -0,0 +1,127 @@
+
+require 'active_record/connection_adapters/postgresql_adapter'
+
+module ActiveRecord
+  class InvalidRoleAction < ActiveRecordError #:nodoc:
+    def initialize(action)
+      super("Invalid role action - #{action}")
+    end
+  end
+
+  module ConnectionAdapters
+    class PostgreSQLAdapter < AbstractAdapter
+      def create_role(name, options = {})
+        execute PostgreSQLRole.new(self, :create, name, options).to_sql
+      end
+      alias :create_user :create_role
+
+      def alter_role(name, options = {})
+        execute PostgreSQLRole.new(self, :alter, name, options).to_sql
+      end
+      alias :alter_user :alter_role
+
+      def drop_role(name, options = {})
+        sql = 'DROP ROLE '
+        sql << 'IF EXISTS ' if options[:if_exists]
+        sql << Array(name).collect { |r| quote_role(r) }.join(', ')
+        execute sql
+      end
+      alias :drop_user :drop_role
+    end
+
+    # This is a base class for PostgreSQLGrantPrivilege and
+    # PostgreSQLRevokePrivilege and is not meant to be used directly.
+    class PostgreSQLRole
+      attr_accessor :base, :action, :name, :options
+
+      def initialize(base, action, name, options = {}) #:nodoc:
+        assert_valid_action(action)
+
+        @base, @action, @name, @options = base, action, name, options
+      end
+
+      def to_sql #:nodoc:
+        sql = Array.new
+        if action == :create
+          sql << 'CREATE'
+        else
+          sql << 'ALTER'
+        end
+        sql << "ROLE #{base.quote_role(name)}"
+
+        if options[:superuser]
+          sql << 'SUPERUSER'
+        end
+
+        if options[:create_db]
+          sql << 'CREATEDB'
+        end
+
+        if options[:create_role]
+          sql << 'CREATEROLE'
+        end
+
+        if options.has_key?(:inherit) && !options[:inherit]
+          sql << 'NOINHERIT'
+        end
+
+        if options[:login]
+          sql << 'LOGIN'
+        end
+
+        if options[:connection_limit]
+          sql << "CONNECTION LIMIT #{options[:connection_limit].to_i}"
+        end
+
+        if options[:password]
+          if options.has_key?(:encrypted_password)
+            if options[:encrypted_password]
+              sql << 'ENCRYPTED'
+            else
+              sql << 'UNENCRYPTED'
+            end
+          end
+
+          sql << 'PASSWORD'
+          sql << base.quote(options[:password])
+        end
+
+        if options[:valid_until]
+          sql << 'VALID UNTIL'
+          timestamp = case options[:valid_until]
+            when Date, Time, DateTime
+              options[:valid_until].to_s(:sql)
+            else
+              options[:valid_until].to_s
+          end
+          sql << base.quote(timestamp)
+        end
+
+        if options[:in_role].present?
+          sql << 'IN ROLE'
+          sql << Array(options[:in_role]).collect { |r| base.quote_role(r) }.join(', ')
+        end
+
+        if options[:role].present?
+          sql << 'ROLE'
+          sql << Array(options[:role]).collect { |r| base.quote_role(r) }.join(', ')
+        end
+
+        if options[:admin].present?
+          sql << 'ADMIN'
+          sql << Array(options[:admin]).collect { |r| base.quote_role(r) }.join(', ')
+        end
+
+        sql.join(' ')
+      end
+      alias :to_s :to_sql
+
+      private
+        def assert_valid_action(action) #:nodoc:
+          if ![ :create, :alter ].include?(action)
+            raise ActiveRecord::InvalidRoleAction.new(action)
+          end
+        end
+    end
+  end
+end

data/test/adapter_test.rb

@@ -50,4 +50,35 @@ class AdapterExtensionTests < Test::Unit::TestCase
     assert_equal(:integer, col.send(:simplified_type, 'integer'))
     assert_equal(nil, col.send(:simplified_type, 'complete_nonsense'))
   end
+
+  def test_set_role
+    ARBC.set_role('foo')
+    ARBC.set_role('foo', :duration => :local)
+    ARBC.set_role('foo', :duration => :session)
+
+    assert_equal([
+      %{SET ROLE "foo"},
+      %{SET LOCAL ROLE "foo"},
+      %{SET SESSION ROLE "foo"}
+    ], ARBC.statements)
+
+    assert_raise(ArgumentError) do
+      ARBC.set_role('foo', :duration => :nonsense)
+    end
+  end
+
+  def test_reset_role
+    ARBC.reset_role
+    assert_equal([ 'RESET ROLE' ], ARBC.statements)
+  end
+
+  def test_current_role
+    ARBC.current_role
+    ARBC.current_user
+
+    assert_equal([
+      'SELECT current_role',
+      'SELECT current_role'
+    ], ARBC.statements)
+  end
 end

data/test/functions_test.rb

@@ -6,11 +6,11 @@ class FunctionsTests < Test::Unit::TestCase
   include PostgreSQLExtensionsTestHelper
 
   def test_create_function
-    Mig.create_function(:test, :integer, :integer, :sql) do
+    ARBC.create_function(:test, :integer, :integer, :sql) do
       "select 10;"
     end
 
-    Mig.create_function(:test, :integer, :integer, :sql, {
+    ARBC.create_function(:test, :integer, :integer, :sql, {
       :force => true,
       :delimiter => '$__$',
       :behavior => :immutable,
@@ -43,8 +43,8 @@ LANGUAGE "sql"
   end
 
   def test_drop_function
-    Mig.drop_function(:test, :integer)
-    Mig.drop_function(:test, :integer, :if_exists => true, :cascade => true)
+    ARBC.drop_function(:test, :integer)
+    ARBC.drop_function(:test, :integer, :if_exists => true, :cascade => true)
 
     assert_equal([
       "DROP FUNCTION \"test\"(integer)",
@@ -53,7 +53,7 @@ LANGUAGE "sql"
   end
 
   def test_rename_function
-    Mig.rename_function(:test, 'integer, text', :foo)
+    ARBC.rename_function(:test, 'integer, text', :foo)
 
     assert_equal([
       "ALTER FUNCTION \"test\"(integer, text) RENAME TO \"foo\""
@@ -61,7 +61,7 @@ LANGUAGE "sql"
   end
 
   def test_alter_function_owner
-    Mig.alter_function_owner(:test, 'integer, text', :admin)
+    ARBC.alter_function_owner(:test, 'integer, text', :admin)
 
     assert_equal([
       "ALTER FUNCTION \"test\"(integer, text) OWNER TO \"admin\""
@@ -69,7 +69,7 @@ LANGUAGE "sql"
   end
 
   def test_alter_function_schema
-    Mig.alter_function_schema(:test, 'integer, text', :geospatial)
+    ARBC.alter_function_schema(:test, 'integer, text', :geospatial)
 
     assert_equal([
       "ALTER FUNCTION \"test\"(integer, text) SET SCHEMA \"geospatial\""
@@ -77,9 +77,9 @@ LANGUAGE "sql"
   end
 
   def test_alter_function
-    Mig.alter_function('my_function', 'integer', :rename_to => 'another_function')
-    Mig.alter_function('another_function', 'integer', :owner_to => 'jdoe')
-    Mig.alter_function('my_function', 'integer') do |f|
+    ARBC.alter_function('my_function', 'integer', :rename_to => 'another_function')
+    ARBC.alter_function('another_function', 'integer', :owner_to => 'jdoe')
+    ARBC.alter_function('my_function', 'integer') do |f|
       f.rename_to 'another_function'
       f.owner_to 'jdoe'
       f.set_schema 'foo'

data/test/languages_test.rb

@@ -6,8 +6,8 @@ class LanguagesTests < Test::Unit::TestCase
   include PostgreSQLExtensionsTestHelper
 
   def test_create_language
-    Mig.create_language(:foo)
-    Mig.create_language(
+    ARBC.create_language(:foo)
+    ARBC.create_language(
       :foo,
       :trusted => true,
       :call_handler => 'plpgsql',
@@ -21,8 +21,8 @@ class LanguagesTests < Test::Unit::TestCase
   end
 
   def test_drop_language
-    Mig.drop_language(:foo)
-    Mig.drop_language(:foo, :if_exists => true, :cascade => true)
+    ARBC.drop_language(:foo)
+    ARBC.drop_language(:foo, :if_exists => true, :cascade => true)
 
     assert_equal([
       "DROP PROCEDURAL LANGUAGE \"foo\"",
@@ -31,7 +31,7 @@ class LanguagesTests < Test::Unit::TestCase
   end
 
   def test_alter_language_name
-    Mig.alter_language_name(:foo, :bar)
+    ARBC.alter_language_name(:foo, :bar)
 
     assert_equal([
       "ALTER PROCEDURAL LANGUAGE \"foo\" RENAME TO \"bar\""
@@ -39,7 +39,7 @@ class LanguagesTests < Test::Unit::TestCase
   end
 
   def test_alter_language_owner
-    Mig.alter_language_owner(:foo, :bar)
+    ARBC.alter_language_owner(:foo, :bar)
 
     assert_equal([
       "ALTER PROCEDURAL LANGUAGE \"foo\" OWNER TO \"bar\""

data/test/roles_test.rb

@@ -0,0 +1,63 @@
+
+$: << File.dirname(__FILE__)
+require 'test_helper'
+
+class RolesTests < Test::Unit::TestCase
+  include PostgreSQLExtensionsTestHelper
+
+  def test_create_role
+    ARBC.create_role('foo')
+    ARBC.create_role('foo', {
+      :superuser => true,
+      :create_db => true,
+      :create_role => true,
+      :inherit => false,
+      :login => true,
+      :connection_limit => 10,
+      :password => 'testing',
+      :encrypted_password => true,
+      :valid_until => Date.parse('2011-10-12'),
+      :in_role => 'bar',
+      :role => 'baz',
+      :admin => 'blort'
+    })
+
+    assert_equal([
+      'CREATE ROLE "foo"',
+      %{CREATE ROLE "foo" SUPERUSER CREATEDB CREATEROLE NOINHERIT LOGIN CONNECTION LIMIT 10 ENCRYPTED PASSWORD 'testing' VALID UNTIL '2011-10-12' IN ROLE "bar" ROLE "baz" ADMIN "blort"}
+    ], statements)
+  end
+
+  def test_alter_role
+    ARBC.alter_role('foo', {
+      :superuser => true,
+      :create_db => true,
+      :create_role => true,
+      :inherit => false,
+      :login => true,
+      :connection_limit => 10,
+      :password => 'testing',
+      :encrypted_password => true,
+      :valid_until => Date.parse('2011-10-12'),
+      :in_role => 'bar',
+      :role => 'baz',
+      :admin => 'blort'
+    })
+
+    assert_equal([
+      %{ALTER ROLE "foo" SUPERUSER CREATEDB CREATEROLE NOINHERIT LOGIN CONNECTION LIMIT 10 ENCRYPTED PASSWORD 'testing' VALID UNTIL '2011-10-12' IN ROLE "bar" ROLE "baz" ADMIN "blort"}
+    ], statements)
+  end
+
+  def test_drop_role
+    ARBC.drop_role('foo')
+    ARBC.drop_role(%w{ foo bar baz })
+    ARBC.drop_role(%w{ foo bar baz }, :if_exists => true)
+
+    assert_equal([
+      'DROP ROLE "foo"',
+      'DROP ROLE "foo", "bar", "baz"',
+      'DROP ROLE IF EXISTS "foo", "bar", "baz"',
+    ], statements)
+  end
+end

data/test/rules_test.rb

@@ -6,10 +6,10 @@ class RulesTests < Test::Unit::TestCase
   include PostgreSQLExtensionsTestHelper
 
   def test_create_rule
-    Mig.create_rule(
+    ARBC.create_rule(
       :ignore_root, :update, :users, :instead, :nothing, :conditions => 'user_id = 0'
     )
-    Mig.create_rule(
+    ARBC.create_rule(
       :ignore_root, :update, :users, :instead, 'SELECT * FROM non_admins', {
         :force => true,
         :conditions => 'user_id > 0'
@@ -23,7 +23,7 @@ class RulesTests < Test::Unit::TestCase
   end
 
   def test_drop_rule
-    Mig.drop_rule(:foo, :bar)
+    ARBC.drop_rule(:foo, :bar)
 
     assert_equal([
       "DROP RULE \"foo\" ON \"bar\"",

data/test/test_helper.rb

@@ -8,8 +8,6 @@ require 'active_record'
 require 'test/unit'
 require File.join(File.dirname(__FILE__), *%w{ .. lib activerecord-postgresql-extensions })
 
-puts "Testing against ActiveRecord #{Gem.loaded_specs['activerecord'].version.to_s}"
-
 ActiveRecord::Base.configurations = {
   'arunit' => {
     :adapter => 'postgresql',
@@ -24,6 +22,11 @@ ActiveRecord::Base.establish_connection 'arunit'
 
 ARBC = ActiveRecord::Base.connection
 
+puts "Testing against ActiveRecord #{Gem.loaded_specs['activerecord'].version.to_s}"
+if postgresql_version = ARBC.query('SELECT version()').flatten.to_s
+  puts "PostgreSQL info from version(): #{postgresql_version}"
+end
+
 class ActiveRecord::ConnectionAdapters::PostgreSQLAdapter
   def statements
     @statements ||= []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgresql-extensions
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-14 00:00:00.000000000Z
+date: 2011-10-05 00:00:00.000000000 Z
 dependencies: []
 description: A whole bunch of extensions the ActiveRecord PostgreSQL adapter.
 email: code@zoocasa.com
@@ -32,6 +32,7 @@ files:
 - lib/postgresql_extensions/postgresql_indexes.rb
 - lib/postgresql_extensions/postgresql_languages.rb
 - lib/postgresql_extensions/postgresql_permissions.rb
+- lib/postgresql_extensions/postgresql_roles.rb
 - lib/postgresql_extensions/postgresql_rules.rb
 - lib/postgresql_extensions/postgresql_schemas.rb
 - lib/postgresql_extensions/postgresql_sequences.rb
@@ -47,6 +48,7 @@ files:
 - test/index_test.rb
 - test/languages_test.rb
 - test/permissions_test.rb
+- test/roles_test.rb
 - test/rules_test.rb
 - test/schemas_test.rb
 - test/sequences_test.rb
@@ -72,7 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: A whole bunch of extensions the ActiveRecord PostgreSQL adapter.