postgres_ext 0.0.6 → 0.0.7

data/.gitignore

@@ -15,3 +15,6 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+bin/
+.rbenv-version*
+

data/.travis.yml

@@ -2,9 +2,12 @@ rvm:
   - 1.8.7
   - 1.9.2
   - 1.9.3
+  - jruby-18mode
+  - jruby-19mode
 
 before_script:
   - psql -c 'create database postgres_ext_test;' -U postgres
 
 notifications:
-  email: false
+  email: 
+    - git@danmcclain.net

data/CHANGELOG.md

@@ -1,8 +1,14 @@
+## 0.0.7
+
+Adds Arel predicate functions for array overlap operator (`&&`) and
+INET/CIDR contained within operator (`<<`)
+
 ## 0.0.6
 
 Lots of array related fixes:
  * Model creation should no longer fail when not assigning a value to an
    array column
  * Array columns follow database defaults
-Migration fix (rn0 and gilltots)
+
+Migration fix (rn0 and gilltots)  
 Typos in README (bcardarella)

data/README.md

@@ -2,7 +2,8 @@
 
 Adds support for missing PostgreSQL data types to ActiveRecord.
 
-## Current Status: [![Build Status](https://secure.travis-ci.org/dockyard/postgres_ext.png?branch=master)](http://travis-ci.org/dockyard/postgres_ext)
+[![Build Status](https://secure.travis-ci.org/dockyard/postgres_ext.png?branch=master)](http://travis-ci.org/dockyard/postgres_ext)
+[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/dockyard/postgres_ext)
 
 ## Roadmap
 
@@ -25,11 +26,20 @@ Or install it yourself as:
 
 ## Usage
 
-Just `require 'postgres_ext'` and use ActiveRecord as you normally would! postgres_ext extends
+Just `require 'postgres_ext'` and use ActiveRecord as you normally would! postgres\_ext extends
 ActiveRecord's data type handling.
 
  * [Migration/Schema.rb support](#migrationschemarb-support)
  * [Type Casting support](#type-casting-support)
+ * [Querying PostgreSQL datatypes](#querying-postgresql-datatypes)
+
+### Usage Notes
+Take care when dealing with arrays and other types that allow you to
+update their value in place. In place changes are not currently tracked
+in Rails (see [this issue](https://github.com/rails/rails/issues/6954)).
+To track changes that happen via `#<<` or other instance methods, be
+sure to call `<attribute>_will_change!` so that Active Record knows to
+persist the change.
 
 ## Migration/Schema.rb support
 
@@ -148,6 +158,101 @@ person_2.favorite_numbers.first.class
 # => Fixnum
 ```
 
+## Querying PostgreSQL datatypes
+
+  * [Arrays](#arrays-2)
+  * [INET/CIDR](#inetcidr)
+
+### Arrays
+
+  * [&& - Array Overlap operator](#---array-overlap-operator)
+  * [ANY or ALL functions](#any-or-all-functions)
+
+#### && - Array Overlap operator
+
+PostgreSQL implements the `&&` operator, known as the overlap operator,
+for arrays. The overlap operator returns `t` (true) when two arrays have
+one or more elements in common.
+
+```sql
+ARRAY[1,2,3] && ARRAY[4,5,6]
+-- f
+
+ARRAY[1,2,3] && ARRAY[3,5,6]
+-- t
+```
+
+Postgres\_ext defines `array_overlap`, an [Arel](https://github.com/rails/arel)
+predicate for the `&&` operator.
+
+```ruby
+user_arel = User.arel_table
+
+User.where(user_arel[:tags].array_overlap(['one','two'])).to_sql
+# => SELECT \"users\".* FROM \"users\" WHERE \"users\".\"tags\" && '{one,two}'
+```
+
+#### ANY or ALL functions
+
+When querying array columns, you have the ability to see if a predicate
+apply's to either *any* element in the array, or *all* elements of the
+array. The syntax for these predicates are slightly different then the
+normal `where` syntax in PostgreSQL. To see if an array contains the
+string `'test'` in any location, you would write the following in SQL
+
+```sql
+SELECT *
+FROM users
+WHERE 'test' = ANY(users.tags)
+```
+
+Notice that the column is on the right hand side of the predicate,
+instead of the left, because we have to call the `ANY` function on that
+column.
+
+We can generate the above query using [Arel](https://github.com/rails/arel)
+and generating the Node manually. We would use the following to
+accompish this:
+
+```ruby
+user_arel = User.arel_table
+
+any_tags_function = Arel::Nodes::NamedFunction.new('ANY', [user_arel[:tags]])
+predicate = Arel::Nodes::Equality('test', any_tags_function)
+
+User.where(predicate).to_sql
+#=> SELECT \"users\".* FROM \"users\" WHERE 'test' = ANY(\"users\".\"tags\")
+
+```
+
+The ALL version of this same predicate can be generated by swap `'ANY'`
+for `'ALL'` in the named function.
+
+### INET/CIDR
+
+#### `<<` -- Contained within operator
+
+PostgreSQL defines the `<<`, or contained within operator for INET and
+CIDR datatypes. The `<<` operator returns `t` (true) if a INET or CIDR
+address is contained within the given subnet. 
+
+```sql
+inet '192.168.1.6' << inet '10.0.0.0/24'
+-- f
+
+inet '192.168.1.6' << inet '192.168.1.0/24'
+-- t
+```
+
+Postgres\_ext defines `contained_within`, an [Arel](https://github.com/rails/arel)
+predicate for the `<<` operator.
+
+```ruby
+user_arel = User.arel_table
+
+User.where(user_arel[:ip_address].contained_witin('127.0.0.1/24')).to_sql
+# => SELECT \"users\".* FROM \"users\" WHERE \"users\".\"ip_address\" << '127.0.0.1/24'
+```
 ## Authors
 
 Dan McClain [twitter](http://twitter.com/_danmcclain) [github](http://github.com/danmcclain)

data/Rakefile

@@ -30,13 +30,4 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = 'spec/**/*_spec.rb'
 end
 
-require 'rvm-tester'
-RVM::Tester::TesterTask.new(:suite) do |t|
-  t.bundle_install = true                # updates Gemfile.lock, default is true
-  t.use_travis = true                    # looks for Rubies in .travis.yml (on by default)
-  t.command = "bundle exec rake spec"    # runs plain "rake" by default
-  t.env = {"VERBOSE" => "1"}             # set any ENV vars
-  t.verbose = true                       # shows more output, off by default
-end
-
 task :default => :spec

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

@@ -101,8 +101,6 @@ module ActiveRecord
           :cidr
         when 'macaddr'
           :macaddr
-        when /(\[\])$/
-          "#{simplified_type field_type[0..field_type.length - 3]}_array".to_sym
         else
           simplified_type_without_extended_types field_type
         end
@@ -205,6 +203,15 @@ module ActiveRecord
       end
       alias_method_chain :type_cast, :extended_types
 
+      def quote_with_extended_types(value, column = nil)
+        if [Array, IPAddr].include? value.class
+          "'#{type_cast(value, column)}'"
+        else
+          quote_without_extended_types(value, column)
+        end
+      end
+      alias_method_chain :quote, :extended_types
+
       private
 
       def ipaddr_to_string(value)

data/lib/postgres_ext/arel/nodes/contained_within.rb

@@ -1,9 +1,11 @@
+require 'arel/nodes/binary'
 module Arel
   module Nodes
     class ContainedWithin < Arel::Nodes::Binary
       def operator; :<< end
-      alias :operand1 :left
-      alias :operand2 :right
+    end
+
+    class ArrayOverlap < Arel::Nodes::Binary
     end
   end
 end

data/lib/postgres_ext/arel/predications.rb

@@ -2,8 +2,12 @@ require 'arel/predications'
 
 module Arel
   module Predications
-    def contained_within other
+    def contained_within(other)
       Nodes::ContainedWithin.new self, other
     end
+
+    def array_overlap(other)
+      Nodes::ArrayOverlap.new self, other
+    end
   end
 end

data/lib/postgres_ext/arel/visitors/to_sql.rb

@@ -7,6 +7,26 @@ module Arel
         "#{visit o.left} << #{visit o.right}"
       end
 
+      def visit_Arel_Nodes_ArrayOverlap o
+        if Array === o.right 
+          right = "{#{o.right.map{|v| change_string(visit(v))}.join(',')}}"
+          "#{visit o.left} && '#{right}'"
+        else
+          "#{visit o.left} && #{visit o.right}"
+        end
+      end
+
+      def visit_IPAddr value
+        "'#{value.to_s}/#{value.instance_variable_get(:@mask_addr).to_s(2).count('1')}'"
+      end
+
+      def change_string value
+        if value.match /"|,|\{/
+          value.gsub(/"/, "\"").gsub(/'/,'"')
+        else
+          value.gsub(/'/,'')
+        end
+      end
     end
   end
 end

data/lib/postgres_ext/version.rb

@@ -1,3 +1,3 @@
 module PostgresExt
-  VERSION = '0.0.6'
+  VERSION = '0.0.7'
 end

data/postgres_ext.gemspec

@@ -16,13 +16,16 @@ Gem::Specification.new do |gem|
   gem.version       = PostgresExt::VERSION
 
   gem.add_dependency 'activerecord', '~> 3.2.0'
-  gem.add_dependency 'pg_array_parser', '~> 0.0.1'
+  gem.add_dependency 'pg_array_parser', '~> 0.0.3'
 
   gem.add_development_dependency 'rails', '~> 3.2.0'
   gem.add_development_dependency 'rspec-rails', '~> 2.9.0'
   gem.add_development_dependency 'bourne', '~> 1.1.2'
-  gem.add_development_dependency 'pg', '~> 0.13.2'
+  if RUBY_PLATFORM =~ /java/
+    gem.add_development_dependency 'activerecord-jdbcpostgresql-adapter'
+  else
+    gem.add_development_dependency 'pg', '~> 0.13.2'
+  end
   gem.add_development_dependency 'debugger', '~> 1.1.2' if RUBY_VERSION == '1.9.3'
   gem.add_development_dependency 'fivemat'
-  gem.add_development_dependency 'rvm-tester'
 end

data/spec/arel/array_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe 'Array Column Predicates' do
+  let!(:adapter) { ActiveRecord::Base.connection }
+
+  before do
+    adapter.create_table :arel_arrays, :force => true do |t|
+      t.string :tags, :array => true
+    end
+
+    class ArelArray < ActiveRecord::Base
+      attr_accessible :tags
+    end
+  end
+
+  after do
+    adapter.drop_table :arel_arrays
+    Object.send(:remove_const, :ArelArray)
+  end
+
+  describe 'Array Overlap' do
+    it 'converts Arel array_overlap statment' do
+      arel_table = ArelArray.arel_table
+
+      arel_table.where(arel_table[:tags].array_overlap(['tag','tag 2'])).to_sql.should match /&& '\{tag,tag 2\}'/
+    end
+
+    it 'returns matched records' do
+      one = ArelArray.create!(:tags => ['one'])
+      two = ArelArray.create!(:tags => ['two'])
+      arel_table = ArelArray.arel_table
+
+      ArelArray.where(arel_table[:tags].array_overlap(['one'])).should include(one)
+      ArelArray.where(arel_table[:tags].array_overlap(['two'])).should include(two)
+      ArelArray.where(arel_table[:tags].array_overlap(['two','one'])).should include(two)
+      ArelArray.where(arel_table[:tags].array_overlap(['two','one'])).should include(one)
+    end
+  end
+end

data/spec/arel/inet_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe 'INET related AREL functions' do
+  let!(:adapter) { ActiveRecord::Base.connection }
+  before do
+    adapter.create_table :ip_addresses, :force => true do |t|
+      t.inet :address
+    end
+
+    class IpAddress < ActiveRecord::Base
+      attr_accessible :address
+    end
+  end
+
+  after do
+    adapter.drop_table :ip_addresses
+    Object.send(:remove_const, :IpAddress)
+  end
+
+  describe 'quoting IPAddr in sql statement' do
+    it 'properly converts IPAddr to quoted strings when passed as an argument to a where clause' do
+      IpAddress.where(:address => IPAddr.new('127.0.0.1')).to_sql.should include("'127.0.0.1/32'")
+    end
+  end
+
+  describe 'cotained with (<<) operator' do
+    it 'converts Arel contained_within statemnts to <<' do
+      arel_table = IpAddress.arel_table
+
+      arel_table.where(arel_table[:address].contained_within(IPAddr.new('127.0.0.1/24'))).to_sql.should match /<< '127.0.0.0\/24'/
+    end
+  end
+end

data/spec/models/array_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
 describe 'Models with array columns' do
-  context 'no default value, string array' do
-    let!(:adapter) { ActiveRecord::Base.connection }
+  let!(:adapter) { ActiveRecord::Base.connection }
 
+  context 'no default value, string array' do
     before do
       adapter.create_table :users, :force => true do |t|
         t.string :nick_names, :array => true
@@ -18,29 +18,45 @@ describe 'Models with array columns' do
       Object.send(:remove_const, :User)
     end
 
-    describe '#create' do
-      it 'creates a user when there is no array assignment' do
-        u = User.create()
-        u.reload
-        u.nick_names.should eq nil
-      end
+    context 'no default value, string array' do
+      describe '#create' do
+        it 'creates a user when there is no array assignment' do
+          u = User.create()
+          u.reload
+          u.nick_names.should eq nil
+        end
 
-      it 'creates a user with an empty array' do
-        u = User.create(:nick_names => [])
-        u.reload
-        u.nick_names.should eq []
+        it 'creates a user with an empty array' do
+          u = User.create(:nick_names => [])
+          u.reload
+          u.nick_names.should eq []
+        end
+
+        it 'creates a user with an array of some values' do
+          u = User.create(:nick_names => ['some', 'things'])
+          u.reload
+          u.nick_names.should eq ['some', 'things']
+        end
       end
+    end
 
-      it 'creates a user with an array of some values' do
-        u = User.create(:nick_names => ['some', 'things'])
-        u.reload
-        u.nick_names.should eq ['some', 'things']
+    context 'Setting values' do
+      describe 'setting a new value' do
+        it 'returns the value set when the record is retrieved' do
+          u = User.create(:nick_names => ['some', 'things'])
+          u.reload
+
+          u.nick_names = ['different', 'values']
+          u.save
+
+          u.reload
+          u.nick_names.should eq ['different', 'values']
+        end
       end
     end
   end
 
-  context 'default value, string array' do
-    let!(:adapter) { ActiveRecord::Base.connection }
+  context 'default values' do
     before do
       adapter.create_table :defaulted_users, :force => true do |t|
         t.string :nick_names, :array => true, :default => '{}'
@@ -55,23 +71,25 @@ describe 'Models with array columns' do
       Object.send(:remove_const, :DefaultedUser)
     end
 
-    describe '#create' do
-      it 'creates a user when there is no array assignment' do
-        u = DefaultedUser.create()
-        u.reload
-        u.nick_names.should eq []
-      end
+    context 'model creation' do
+      describe '#create' do
+        it 'creates a user when there is no array assignment' do
+          u = DefaultedUser.create()
+          u.reload
+          u.nick_names.should eq []
+        end
 
-      it 'creates a user with an nil' do
-        u = DefaultedUser.create(:nick_names => nil)
-        u.reload
-        u.nick_names.should eq nil
-      end
+        it 'creates a user with an nil' do
+          u = DefaultedUser.create(:nick_names => nil)
+          u.reload
+          u.nick_names.should eq nil
+        end
 
-      it 'creates a user with an array of some values' do
-        u = DefaultedUser.create(:nick_names => ['some', 'things'])
-        u.reload
-        u.nick_names.should eq ['some', 'things']
+        it 'creates a user with an array of some values' do
+          u = DefaultedUser.create(:nick_names => ['some', 'things'])
+          u.reload
+          u.nick_names.should eq ['some', 'things']
+        end
       end
     end
   end

data/spec/models/inet_spec.rb

@@ -0,0 +1,79 @@
+require 'spec_helper'
+
+describe 'Models with inet columns' do
+  let!(:adapter) { ActiveRecord::Base.connection }
+
+  context 'no default value, inet' do
+    before do
+      adapter.create_table :addresses, :force => true do |t|
+        t.inet :ip_address
+      end
+      class Address < ActiveRecord::Base
+        attr_accessible :ip_address
+      end
+    end
+
+    after do
+      adapter.drop_table :addresses
+      Object.send(:remove_const, :Address)
+    end
+
+    context 'no default value, inet' do
+      describe '#create' do
+        it 'creates an address when there is no assignment' do
+          address = Address.create()
+          address.reload
+          address.ip_address.should eq nil
+        end
+
+        it 'creates an address with an address string' do
+          address = Address.create( :ip_address => '192.168.0.1')
+          address.reload
+          address.ip_address.should eq IPAddr.new('192.168.0.1')
+        end
+
+        it 'creates an address with an IPAddr' do
+          ip_addr = IPAddr.new('192.168.0.1')
+          address = Address.create( :ip_address => ip_addr)
+          address.reload
+          address.ip_address.should eq ip_addr
+        end
+      end
+
+      describe 'inet assignment' do
+        it 'updates an address with an address string' do
+          address = Address.create( :ip_address => '192.168.0.1')
+          address.ip_address = '192.168.1.2'
+          address.save
+
+          address.reload
+          address.ip_address.should eq IPAddr.new('192.168.1.2')
+        end
+
+        it 'updates an address with an IPAddr' do
+          ip_addr_1 = IPAddr.new('192.168.0.1')
+          ip_addr_2 = IPAddr.new('192.168.1.2')
+          address = Address.create( :ip_address => ip_addr_1)
+          address.ip_address = ip_addr_2
+          address.save
+
+          address.reload
+          address.ip_address.should eq ip_addr_2
+        end
+      end
+
+      describe 'find_by_inet' do
+        let!(:address) { Address.create(:ip_address => '192.168.0.1') }
+
+        it 'finds address using string value' do
+          Address.find_by_ip_address('192.168.0.1').should eq address
+        end
+
+        it 'finds address using IPAddr' do
+          ip_addr = IPAddr.new '192.168.0.1'
+          Address.find_by_ip_address(ip_addr).should eq address
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -15,4 +15,11 @@ Dir[File.join(ENGINE_RAILS_ROOT, 'spec/support/**/*.rb')].each { |f| require f }
 RSpec.configure do |config|
   config.mock_with :mocha
   config.use_transactional_fixtures = true
+  config.backtrace_clean_patterns = [
+    #/\/lib\d*\/ruby\//,
+    #/bin\//,
+    #/gems/,
+    #/spec\/spec_helper\.rb/,
+    /lib\/rspec\/(core|expectations|matchers|mocks)/
+  ]
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postgres_ext
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-10 00:00:00.000000000 Z
+date: 2012-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.0.1
+        version: 0.0.3
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -139,22 +139,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rvm-tester
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Adds missing native PostgreSQL data types to ActiveRecord
 email:
 - git@danmcclain.net
@@ -183,6 +167,8 @@ files:
 - lib/postgres_ext/arel/visitors/to_sql.rb
 - lib/postgres_ext/version.rb
 - postgres_ext.gemspec
+- spec/arel/array_spec.rb
+- spec/arel/inet_spec.rb
 - spec/columns/array_spec.rb
 - spec/columns/inet_spec.rb
 - spec/dummy/.gitignore
@@ -243,6 +229,7 @@ files:
 - spec/migrations/macaddr_spec.rb
 - spec/migrations/uuid_spec.rb
 - spec/models/array_spec.rb
+- spec/models/inet_spec.rb
 - spec/schema_dumper/array_spec.rb
 - spec/schema_dumper/cidr_spec.rb
 - spec/schema_dumper/inet_spec.rb
@@ -263,7 +250,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1872786162985157385
+      hash: 169599389239444303
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -272,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1872786162985157385
+      hash: 169599389239444303
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -280,6 +267,8 @@ signing_key:
 specification_version: 3
 summary: Extends ActiveRecord to handle native PostgreSQL data types
 test_files:
+- spec/arel/array_spec.rb
+- spec/arel/inet_spec.rb
 - spec/columns/array_spec.rb
 - spec/columns/inet_spec.rb
 - spec/dummy/.gitignore
@@ -340,6 +329,7 @@ test_files:
 - spec/migrations/macaddr_spec.rb
 - spec/migrations/uuid_spec.rb
 - spec/models/array_spec.rb
+- spec/models/inet_spec.rb
 - spec/schema_dumper/array_spec.rb
 - spec/schema_dumper/cidr_spec.rb
 - spec/schema_dumper/inet_spec.rb