pg_funcall 0.1.0

data/spec/lib/type_info_spec.rb

@@ -0,0 +1,147 @@
+require 'spec_helper'
+require 'pg_funcall/type_info'
+require 'pg_funcall/type_map'
+
+#
+# Test the utility class for calling database functions
+#
+
+describe PgFuncall::TypeInfo do
+  let :int4row do
+    {
+      "oid"=>"23",
+      "nspname"=>"pg_catalog",
+      "typname"=>"int4",
+      "typnamespace"=>"11",
+      "typowner"=>"10",
+      "typlen"=>"4",
+      "typbyval"=>"t",
+      "typtype"=>"b",
+      "typcategory"=>"N",
+      "typispreferred"=>"f",
+      "typisdefined"=>"t",
+      "typdelim"=>",",
+      "typrelid"=>"0",
+      "typelem"=>"0",
+      "typarray"=>"1007",
+      "typinput"=>"int4in",
+      "typoutput"=>"int4out",
+      "typreceive"=>"int4recv",
+      "typsend"=>"int4send",
+      "typmodin"=>"-",
+      "typmodout"=>"-",
+      "typanalyze"=>"-",
+      "typalign"=>"i",
+      "typstorage"=>"p",
+      "typnotnull"=>"f",
+      "typbasetype"=>"0",
+      "typtypmod"=>"-1",
+      "typndims"=>"0",
+      "typcollation"=>"0",
+      "typdefaultbin"=>nil,
+      "typdefault"=>nil,
+      "typacl"=>nil,
+      "nspowner"=>"10",
+      "nspacl"=>"{robertsanders=UC/robertsanders,=U/robertsanders}"
+    }
+  end
+
+  let :pg_connection do
+    ActiveRecord::Base.connection.raw_connection
+  end
+
+  #
+  # Array of string->string hashes representing known Postgres types
+  #
+  let :all_type_rows do
+    pg_connection.query(<<-SQL).to_a
+       SELECT pgt.oid, ns.nspname, *
+       FROM pg_type as pgt
+       JOIN pg_namespace as ns on pgt.typnamespace = ns.oid;
+    SQL
+  end
+
+  let :types_by_oid do
+    {}.tap do |hash|
+      all_type_rows.each do |row|
+        hash[row['oid'].to_i] = row
+      end
+    end
+  end
+
+  let :types_by_name do
+    {}.tap do |hash|
+      all_type_rows.each do |row|
+        raise "Entry for #{row['oid']} - #{row['typname']} already defined!" if hash.has_key?(row['typname'])
+        hash[row['typname']] = row
+      end
+    end
+  end
+
+  let :type_map do
+    PgFuncall::TypeMap.fetch(ActiveRecord::Base.connection)
+  end
+
+  let :ar_type do
+    type_map.lookup_ar_by_oid(row['oid'].to_i)
+  end
+
+  # currently inspected row; int4 by default
+  let :row do
+    int4row
+  end
+
+  subject do
+    described_class.new(row, ar_type)
+  end
+
+  context 'for int4 hardcoded row' do
+    it 'should return the correct OID' do
+      subject.oid.should == 23
+    end
+    it 'should return the simple name' do
+      subject.name.should == 'int4'
+    end
+    it 'should return a simple fqname' do
+      subject.fqname.should == 'int4'
+    end
+    it { should be_numeric }
+    it { should_not be_temporal }
+    it { should_not be_array }
+    it 'should have an array type' do
+      subject.array_type_oid.should_not be_nil
+    end
+    it 'should cast a string to integer when leaving DB' do
+      subject.cast_from_database('3211').should == 3211
+    end
+    it 'should cast from an integer to string form entering DB' do
+      subject.cast_to_database(3211).should == '3211'
+    end
+  end
+
+  context 'parsed from all_type_rows' do
+    let(:row) { types_by_name['_int4'] }
+
+    it 'should return the correct OID' do
+      subject.oid.should == 1007
+    end
+    it 'should return the simple name' do
+      subject.name.should == '_int4'
+    end
+    it 'should return a simple fqname' do
+      subject.fqname.should == '_int4'
+    end
+    it { should_not be_numeric }
+    it { should_not be_temporal }
+    it { should be_array }
+    it 'should have an element type' do
+      subject.element_type_oid.should == 23
+    end
+    it 'should cast from string form to array of integers' do
+      subject.cast_from_database('{1,1,2,3,5,8}').should == [1,1,2,3,5,8]
+    end
+    it 'should cast from string form to array of integers' do
+      subject.cast_to_database([1,1,2,3,5,8]).should == '{1,1,2,3,5,8}'
+    end
+  end
+end

data/spec/lib/type_map_spec.rb

@@ -0,0 +1,110 @@
+require 'spec_helper'
+require 'pg_funcall/type_map'
+
+#
+# Test the utility class for calling database functions
+#
+
+describe PgFuncall::TypeMap do
+  subject do
+    PgFuncall::TypeMap.fetch(ActiveRecord::Base.connection)
+  end
+
+  before(:all) do
+    ActiveRecord::Base.connection.execute <<-SQL
+      CREATE OR REPLACE FUNCTION public.dbfspec_textfunc(arg1 text, arg2 text)
+      RETURNS text
+      LANGUAGE plpgsql
+      AS $function$
+      BEGIN
+        RETURN arg1 || ',' || arg2;
+      END;
+      $function$;
+    SQL
+
+    end
+
+    after(:all) do
+      ActiveRecord::Base.connection.execute <<-SQL
+        DROP FUNCTION IF EXISTS public.dbfspec_textfunc(text, text);
+      SQL
+    end
+
+
+  context 'creation' do
+    it { should be_a(PgFuncall::TypeMap) }
+  end
+
+  context '#resolve of TypeInfo' do
+    context 'by name' do
+      it 'should return the appropriate type for int4' do
+        subject.resolve('int4').should be_a(PgFuncall::TypeInfo)
+        subject.resolve('int4').name.should == 'int4'
+      end
+
+      it 'should contain reference to ar_type for Integer' do
+        subject.resolve('int4').ar_type.should be_a(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID::Integer)
+      end
+    end
+
+    context 'by oid' do
+      it 'should return the appropriate array type for 17 (bytea)' do
+        subject.resolve(17).should be_a(PgFuncall::TypeInfo)
+        subject.resolve(17).name.should == 'bytea'
+      end
+
+      it 'should return the appropriate array type for 1007 (int4 array)' do
+        typobj = subject.resolve(1007)
+        typobj.should be_array
+        typobj.element_type_oid.should == 23
+      end
+
+      it 'should contain reference to ar_type for intarray' do
+        subject.resolve(1007).ar_type.should be_a(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID::Array)
+        subject.resolve(1007).ar_type.subtype.should be_a(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID::Integer)
+      end
+    end
+  end
+
+  context 'lookup of AR types' do
+    context 'by name' do
+      it 'should return the appropriate type for int4' do
+        subject.lookup_ar_by_name('int4').should be_a(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID::Integer)
+      end
+    end
+
+    context 'by oid' do
+      it 'should return the appropriate array type for 17 (bytea)' do
+        subject.lookup_ar_by_oid(17).should be_a(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID::Bytea)
+      end
+
+      it 'should return the appropriate array type for 1007 (int4 array)' do
+        typobj = subject.lookup_ar_by_oid(1007)
+        typobj.should be_a(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID::Array)
+        typobj.subtype.should be_a(ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID::Integer)
+      end
+    end
+  end
+
+  context 'introspection' do
+    subject { PgFuncall.new(ActiveRecord::Base.connection).type_map }
+
+    context '#function_types' do
+      it 'returns expected types for qualified name' do
+        types = subject.function_types('public.dbfspec_textfunc')
+        types.ret_type.should == 25
+        types.arg_sigs.should include([25, 25])
+      end
+
+      it 'returns same types for unqualified name' do
+        subject.function_types('public.dbfspec_textfunc').
+            should == subject.function_types('dbfspec_textfunc', PgFuncall.default_instance.search_path)
+      end
+
+      it 'throws if non-namespaced function is specified without a search_path' do
+        expect { subject.function_types('dbfspec_textfunc', []) }.
+          to raise_error
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+if ENV['COVERAGE'] == 'true'
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'yaml'
+require 'active_record'
+configs = YAML.load(File.read("config/database.yml.example"))
+ActiveRecord::Base.establish_connection(configs['test'])
+
+require 'pg_funcall'
+
+begin
+  require 'pry'
+rescue LoadError
+  #
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: pg_funcall
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Sanders
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ipaddr_extensions
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wwtd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- robert@curioussquid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/database.yml
+- config/database.yml.example
+- gemfiles/rails40.gemfile
+- gemfiles/rails40.gemfile.lock
+- gemfiles/rails41.gemfile
+- gemfiles/rails41.gemfile.lock
+- gemfiles/rails42.gemfile
+- gemfiles/rails42.gemfile.lock
+- lib/pg_funcall.rb
+- lib/pg_funcall/ipaddr_monkeys.rb
+- lib/pg_funcall/type_info.rb
+- lib/pg_funcall/type_map.rb
+- lib/pg_funcall/version.rb
+- pg_funcall.gemspec
+- script/shell
+- spec/lib/pg_funcall_spec.rb
+- spec/lib/type_info_spec.rb
+- spec/lib/type_map_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/rsanders/pg_funcall
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Utility class for calling functions defined in a PostgreSQL database.
+test_files:
+- spec/lib/pg_funcall_spec.rb
+- spec/lib/type_info_spec.rb
+- spec/lib/type_map_spec.rb
+- spec/spec_helper.rb