postgres_ext 0.3.1 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7e8eff00c75c70dcf28c108a470e187fb6c62d01
+  data.tar.gz: 41af271c607addeee1883185aa52602f37227767
+SHA512:
+  metadata.gz: 17fa65379b957864bb359d6ccccd85672422361b6f5126c78f113d8c05ea0c39595fa790d991c3d79d6778b1ce790f133fdb65458f9da8f99f395c2f5fe19bdf
+  data.tar.gz: 80a96500066d32ac9547f5960b3bced0a27a47a20a3c233f7a4c0d78ae06b7febd03be367b901b9ef62747d3f6258da5839ff9ed5d464c8055c6b7a9fe122c1c

data/.travis.yml

@@ -1,12 +1,22 @@
 rvm:
-  - 1.8.7
-  - 1.9.2
   - 1.9.3
-  - jruby-18mode
+  - 2.0.0
   - jruby-19mode
 
 before_script:
-  - psql -c 'create database postgres_ext_test;' -U postgres
+  - sudo /etc/init.d/postgresql stop
+  - sudo cp /etc/postgresql/9.1/main/pg_hba.conf ./
+  - sudo apt-get remove postgresql postgresql-9.1 -qq --purge
+  - source /etc/lsb-release
+  - echo "deb http://apt.postgresql.org/pub/repos/apt/ $DISTRIB_CODENAME-pgdg main" > pgdg.list
+  - sudo mv pgdg.list /etc/apt/sources.list.d/
+  - wget --quiet -O - http://apt.postgresql.org/pub/repos/apt/ACCC4CF8.asc | sudo apt-key add -
+  - sudo apt-get update -qq
+  - sudo apt-get -o Dpkg::Options::="--force-confdef" -o Dpkg::Options::="--force-confnew" install postgresql-9.2 postgresql-contrib-9.2 -qq
+  - sudo /etc/init.d/postgresql stop
+  - sudo cp ./pg_hba.conf /etc/postgresql/9.2/main
+  - sudo /etc/init.d/postgresql start
+  - psql -c 'create database postgres_ext_test;' -U postgres -h localhost
   - cp spec/dummy/config/database.yml.example spec/dummy/config/database.yml
   - RAILS_ENV=test rake db:migrate
 
@@ -15,4 +25,4 @@ notifications:
     - git@danmcclain.net
   campfire:
     rooms:
-      - secure: "yVESPleawl+fzvnzXw/W7rULyCjMEq3gPc3cEqcqM2SBBtEIDNXto2zoTAoR\nC5yqhijr+UtmVMsI7CxVK3XvfkmCJZN9P4DP0uas8XYx5DsSabCdPN0h3pka\nbaDCMCInU5QF4WswL2iuyLsOJeKDRwxh09adsHi1HpMgf0nTKPA="
+      - secure: "dNVxAfeOqRuA7k4Wu3H63deqV8Z1mmpVBdPEtkK2ry+mp+51RFHcO0cUJ/fI\nN4PXZu2wNWQlvz5LCMRPe+hxio/w8hTvgQxzBVvi0kuOh/22wXumdy7LR/RJ\nvyrrbP3+1hSxhzufyvIe/fOU11v31d3WRA1/q80ls9EkwzoDTNI="

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 0.4.0
+ * Adds support for (limited) support for PostgreSQL ranges - Dan McClain
+
 ## 0.3.1
 
  * Fixes issue with array -> string code - Dan McClain

data/Gemfile

@@ -5,8 +5,8 @@ gemspec
 unless ENV['CI']
   if RUBY_PLATFORM =~ /java/
     gem 'ruby-debug'
-  elsif RUBY_VERSION == '1.9.3' || RUBY_VERSION == '2.0.0'
-    gem 'debugger'
+  elsif RUBY_VERSION == '2.0.0'
+    gem 'byebug'
   end
 end
 gem 'fivemat'

data/README.md

@@ -13,6 +13,10 @@ the gem please ask the question on
 [Stack Overflow](http://stackoverflow.com). Be sure to tag the
 question with `DockYard` so we can find it.
 
+## Note ##
+PostgresExt is dropping support for Ruby 1.8.7 with the next minor
+release.
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/docs/type_casting.md

@@ -49,3 +49,22 @@ person_2.favorite_numbers
 person_2.favorite_numbers.first.class
 # => Fixnum
 ```
+
+## Ranges
+Like array objects, postgres\_ext supports range types as well.
+Numrange, in4range, int8range, daterange, tsrange, and tstzrange are all
+supported, but there are some notable caveats.
+
+### Int and Date ranges
+As integers and days are discrete measurements, PostgreSQL will
+normalize these ranges as they are store in the database. PostgreSQL
+will convert end-inclusive ranges to end-exclusive, meaning that `0..4`
+becomes `0...5`. Developers should be aware of this when using integer
+and date ranges, since ruby will treat these ranges differently from
+PostgreSQL. 
+
+### Timestamp with and without timezone
+Ruby/Rails 3.2.x does not support datetime ranges that begin or end with
+infinity. Rails 4 has patched datetime and time so that infinity
+terminated ranges work, but currently postgres\_ext has not patched the
+required methods.

data/lib/postgres_ext/active_record/connection_adapters/postgres_adapter.rb

@@ -43,7 +43,10 @@ module ActiveRecord
           value
         else
           case type
-          when :inet, :cidr   then klass.string_to_cidr_address(value)
+          when :inet, :cidr                    then klass.string_to_cidr_address(value)
+          when :numrange,:int4range,:int8range then klass.string_to_numeric_range(value,type)
+          when :daterange                      then klass.string_to_date_range(value)
+          when :tsrange,:tstzrange             then klass.string_to_datetime_range(value)
           else
             type_cast_without_extended_types(value)
           end
@@ -81,7 +84,10 @@ module ActiveRecord
           "#{klass}.new('#{self.name}', #{self.default.nil? ? 'nil' : "'#{self.default}'"}, '#{self.sql_type}').string_to_array(#{var_name})"
         else
           case type
-          when :inet, :cidr   then "#{klass}.string_to_cidr_address(#{var_name})"
+          when :inet, :cidr                    then "#{klass}.string_to_cidr_address(#{var_name})"
+          when :numrange,:int4range,:int8range then "#{klass}.string_to_numeric_range(#{var_name},#{type.inspect})"
+          when :daterange                      then "#{klass}.string_to_date_range(#{var_name})"
+          when :tsrange,:tstzrange             then "#{klass}.string_to_datetime_range(#{var_name})"
           else
             type_cast_code_without_extended_types(var_name)
           end
@@ -89,7 +95,33 @@ module ActiveRecord
       end
       alias_method_chain :type_cast_code, :extended_types
 
+      if RUBY_PLATFORM =~ /java/
+        def default_value_with_extended_types(default)
+          case default
+          when /\A'(.*)'::(?:(num|int[48]|date|ts(tz)?)range)\z/
+            $1
+          else
+            default_value_without_extended_types(default)
+          end
+
+        end
+        alias_method_chain :default_value, :extended_types
+      end
+
       class << self
+        unless RUBY_PLATFORM =~ /java/
+          def extract_value_from_default_with_extended_types(default)
+            case default
+            when /\A'(.*)'::(?:(num|int[48]|date|ts(tz)?)range)\z/
+              $1
+            else
+              extract_value_from_default_without_extended_types(default)
+            end
+
+          end
+          alias_method_chain :extract_value_from_default, :extended_types
+        end
+
         def string_to_cidr_address(string)
           return string unless String === string
 
@@ -97,6 +129,51 @@ module ActiveRecord
             IPAddr.new(string)
           end
         end
+
+        def string_to_numeric_range(value, type)
+          if type == :numrange
+            extract_range(value) do |end_value|
+              end_value.to_f
+            end
+          else
+            extract_range(value) do |end_value|
+              end_value.to_i
+            end
+          end
+        end
+
+        def string_to_date_range(value)
+          extract_range(value) do |end_value|
+            Date.parse(end_value)
+          end
+        end
+
+        def string_to_datetime_range(value)
+          extract_range(value) do |end_value|
+            Time.parse(end_value)
+          end
+        end
+
+        private
+
+        def extract_range(value, &conversion)
+          if Range === value
+            value
+          else
+            # Until 1.8.7 support is dropped, must use group numbers instead of named groups
+            #range_regex = /\A(?<open>\[|\()(?<start>.*?),(?<end>.*?)(?<close>\]|\))\z/
+            range_regex = /\A(\[|\()(.*?),(.*?)(\]|\))\z/
+            if match = value.match(range_regex)
+              if match = value.match(range_regex)
+                start_value = match[2].empty? ? -(1.0/0.0) : conversion.call(match[2])
+                end_value   = match[3].empty? ? (1.0/0.0)  : conversion.call(match[3])
+
+                end_exclusive = end_value != (1.0/0.0) && match[4] == ')'
+                Range.new start_value, end_value, end_exclusive
+              end
+            end
+          end
+        end
       end
 
       private
@@ -121,6 +198,18 @@ module ActiveRecord
           :macaddr
         when 'ean13'
           :ean13
+        when 'int4range'
+          :int4range
+        when 'int8range'
+          :int8range
+        when 'numrange'
+          :numrange
+        when 'daterange'
+          :daterange
+        when 'tsrange'
+          :tsrange
+        when 'tstzrange'
+          :tstzrange
         else
           simplified_type_without_extended_types field_type
         end
@@ -133,7 +222,8 @@ module ActiveRecord
       class UnsupportedFeature < Exception; end
 
       EXTENDED_TYPES = { :inet => {:name => 'inet'}, :cidr => {:name => 'cidr'}, :macaddr => {:name => 'macaddr'},
-                         :uuid => {:name => 'uuid'}, :citext => {:name => 'citext'}, :ean13 => {:name => 'ean13'} }
+                         :uuid => {:name => 'uuid'}, :citext => {:name => 'citext'}, :ean13 => {:name => 'ean13'}, :numrange => {:name => 'numrange'},
+                         :daterange => {:name => 'daterange'}, :int4range => {:name => 'int4range'}, :int8range => {:name => 'int8range'}, :tsrange => {:name => 'tsrange'}, :tstzrange => {:name => 'tstzrange'} }
 
       class ColumnDefinition < ActiveRecord::ConnectionAdapters::ColumnDefinition
         attr_accessor :array
@@ -203,6 +293,8 @@ module ActiveRecord
         @database_encoding ||= case ActiveRecord::Base.connection.encoding
                                when 'UTF8'
                                  'UTF-8'
+                               when 'SQL_ASCII'
+                                 'ASCII'
                                else
                                  ActiveRecord::Base.connection.encoding
                                end
@@ -279,6 +371,22 @@ module ActiveRecord
           else
             type_cast_without_extended_types(value, column)
           end
+        when Float
+          if [:numrange,:int4range,:int8range,:daterange].include?(column.type)&& value.abs == (1.0/0.0)
+            ''
+          else
+            type_cast_without_extended_types(value, column)
+          end
+        when Date, DateTime, Time
+          if column.type == :tstzrange
+            quoted_date(value)
+          elsif column.type == :tsrange
+            value.to_s(:db)
+          else
+            type_cast_without_extended_types(value, column)
+          end
+        when Range
+          range_to_string(value, column)
         when Array
           if column.array
             array_to_string(value, column)
@@ -304,6 +412,8 @@ module ActiveRecord
           "'#{array_to_string(value, column, true)}'"
         elsif column.respond_to?(:array) && column.array && value =~ /^\{.*\}$/
           "'#{value}'"
+        elsif value.is_a? Range
+          "'#{type_cast(value, column)}'"
         else
           quote_without_extended_types(value, column)
         end
@@ -370,6 +480,22 @@ module ActiveRecord
         select_rows('select extname from pg_extension', 'extensions').map { |row| row[0] }.delete_if {|name| name == 'plpgsql'}
       end
 
+      def change_column_with_extended_types(table_name, column_name, type, options = {})
+        if options[:array]
+          clear_cache!
+          quoted_table_name = quote_table_name(table_name)
+
+          execute "ALTER TABLE #{quoted_table_name} ALTER COLUMN #{quote_column_name(column_name)} TYPE #{type_to_sql(type, options[:limit], options[:precision], options[:scale])}[]"
+
+          change_column_default(table_name, column_name, options[:default]) if options_include_default?(options)
+          change_column_null(table_name, column_name, options[:null], options[:default]) if options.key?(:null)
+        else
+          change_column_without_extended_types(table_name, column_name, type, options)
+        end
+      end
+
+      alias_method_chain :change_column, :extended_types
+
       private
 
       def ipaddr_to_string(value)
@@ -380,6 +506,26 @@ module ActiveRecord
         "{#{value.map { |val| item_to_string(val, column, encode_single_quotes) }.join(',')}}"
       end
 
+      def range_to_string(value, column)
+        "#{range_lower_bound_character value}#{type_cast value.begin, column},#{type_cast value.end, column}#{range_upper_bound_character value}"
+      end
+
+      def range_lower_bound_character(value)
+        if value.begin == -(1.0/0.0)
+          '('
+        else
+          '['
+        end
+      end
+
+      def range_upper_bound_character(value)
+        if value.end == (1.0/0.0) || value.exclude_end?
+          ')'
+        else
+          ']'
+        end
+      end
+
       def item_to_string(value, column, encode_single_quotes = false)
         return 'NULL' if value.nil?
 

data/lib/postgres_ext/active_record/relation/predicate_builder.rb

@@ -29,7 +29,7 @@ module ActiveRecord
             value = value.select(value.klass.arel_table[value.klass.primary_key]) if value.select_values.empty?
             attribute.in(value.arel.ast)
           when Array, ActiveRecord::Associations::CollectionProxy
-            column_definition = engine.columns.find { |col| col.name == column }
+            column_definition = engine.connection.columns(table.name).find { |col| col.name == column }
 
             if column_definition.respond_to?(:array) && column_definition.array
               attribute.eq(value)

data/lib/postgres_ext/version.rb

@@ -1,3 +1,3 @@
 module PostgresExt
-  VERSION = '0.3.1'
+  VERSION = '0.4.0'
 end

data/spec/columns/array_spec.rb

@@ -9,7 +9,7 @@ describe 'Array column' do
   let!(:adapter) { ActiveRecord::Base.connection }
 
   context 'string array' do
-    describe '#type_class' do
+    describe '#type_cast' do
       context 'has null value' do
         it 'converts the PostgreSQL value to an array with a nil value' do
           string_array_column.type_cast('{1,NULL,"NULL"}').should eq ['1',nil,'NULL']
@@ -47,7 +47,7 @@ describe 'Array column' do
   end
 
   context 'text array' do
-    describe '#type_class' do
+    describe '#type_cast' do
       context 'has null value' do
         it 'converts the PostgreSQL value to an array with a nil value' do
           text_array_column.type_cast('{1,NULL,"NULL"}').should eq ['1',nil,'NULL']
@@ -88,7 +88,7 @@ describe 'Array column' do
   end
 
   context 'integer array' do
-    describe '#type_class' do
+    describe '#type_cast' do
       context 'has null value' do
         it 'converts a Postgres Array with nulls in it' do
           integer_array_column.type_cast('{1,NULL,2}').should eq [1,nil,2]
@@ -116,5 +116,4 @@ describe 'Array column' do
       end
     end
   end
-
 end

data/spec/columns/ranges/daterange_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe 'daterange column' do
+  let!(:adapter) { ActiveRecord::Base.connection }
+  let!(:date_range_column) { ActiveRecord::ConnectionAdapters::PostgreSQLColumn.new 'field', nil, 'daterange'}
+
+  describe '#type_class' do
+    it 'converts an end-inclusive PostgreSQL integer range to a Ruby range' do
+      date_range_column.type_cast('[2011-01-01,2012-01-31]').should eq Date.new(2011,01,01)..Date.new(2012,01,31)
+    end
+
+    it 'converts an end-exclusive PostgreSQL integer range to a Ruby range' do
+      date_range_column.type_cast('[2011-01-01,2012-01-31)').should eq Date.new(2011,01,01)...Date.new(2012,01,31)
+    end
+
+    it 'converts an infinite PostgreSQL integer range to a Ruby range' do
+      # Cannot have a range from -Infinity to a date
+      # date_range_column.type_cast('(,2011-01-01)').should eq -(1.0/0.0)...4
+      date_range_column.type_cast('[2011-01-01,)').should eq Date.new(2011,01,01)..(1.0/0.0)
+    end
+  end
+
+  describe 'date range to SQL statment conversion' do
+    it 'returns an end-inclusive PostgreSQL range' do
+      value = date_range_column.type_cast('[2011-01-01,2012-01-31]')
+      adapter.type_cast(value, date_range_column).should eq '[2011-01-01,2012-01-31]'
+    end
+    it 'returns an end-exclusive PostgreSQL range' do
+      value = date_range_column.type_cast('[2011-01-01,2012-01-31)')
+      adapter.type_cast(value, date_range_column).should eq '[2011-01-01,2012-01-31)'
+    end
+    it 'converts an infinite PostgreSQL integer range to a Ruby range' do
+      value = date_range_column.type_cast('[2011-01-01,)')
+      adapter.type_cast(value, date_range_column).should eq '[2011-01-01,)'
+    end
+  end
+end

data/spec/columns/ranges/int4range_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe 'int4range column' do
+  let!(:adapter) { ActiveRecord::Base.connection }
+  let!(:int4_range_column) { ActiveRecord::ConnectionAdapters::PostgreSQLColumn.new 'field', nil, 'int4range'}
+
+  describe '#type_class' do
+    it 'converts an end-inclusive PostgreSQL integer range to a Ruby range' do
+      int4_range_column.type_cast('[0,4]').should eq 0..4
+    end
+
+    it 'converts an end-exclusive PostgreSQL integer range to a Ruby range' do
+      int4_range_column.type_cast('[0,4)').should eq 0...4
+    end
+
+    it 'converts an infinite PostgreSQL integer range to a Ruby range' do
+      int4_range_column.type_cast('(,4)').should eq -(1.0/0.0)...4
+      int4_range_column.type_cast('[0,)').should eq 0..(1.0/0.0)
+    end
+  end
+
+  describe 'int4 range to SQL statment conversion' do
+    it 'returns an end-inclusive PostgreSQL range' do
+      value = int4_range_column.type_cast('[0,4]')
+      adapter.type_cast(value, int4_range_column).should eq '[0,4]'
+    end
+    it 'returns an end-exclusive PostgreSQL range' do
+      value = int4_range_column.type_cast('[0,4)')
+      adapter.type_cast(value, int4_range_column).should eq '[0,4)'
+    end
+    it 'converts an infinite PostgreSQL integer range to a Ruby range' do
+      value = int4_range_column.type_cast('(,4)')
+      adapter.type_cast(value, int4_range_column).should eq '(,4)'
+      value = int4_range_column.type_cast('[0,)')
+      adapter.type_cast(value, int4_range_column).should eq '[0,)'
+    end
+  end
+end