added integration specs using combustion, added specs for array methods

Author: fschwahn

Gemfile

@@ -1,3 +1,5 @@
 source :rubygems
 
 gemspec
+# fix for failing tests with combustion 0.3.1 and rails 3.2.0
+gem "rails", "~> 3.1.0"

activerecord-postgres-array.gemspec

@@ -17,7 +17,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = s.description
 
+  s.add_dependency "rails"
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec', '~> 2.0'
+  s.add_development_dependency 'pg'
+  s.add_development_dependency 'combustion', '~> 0.3.1'
 end
-

lib/activerecord-postgres-array/activerecord.rb

@@ -2,6 +2,30 @@ module ActiveRecord
   class ArrayTypeMismatch < ActiveRecord::ActiveRecordError
   end
 
+  class Base
+    def arel_attributes_values(include_primary_key = true, include_readonly_attributes = true, attribute_names = @attributes.keys)
+      attrs      = {}
+      klass      = self.class
+      arel_table = klass.arel_table
+
+      attribute_names.each do |name|
+        if (column = column_for_attribute(name)) && (include_primary_key || !column.primary)
+          if include_readonly_attributes || !self.class.readonly_attributes.include?(name)
+            value = read_attribute(name)
+            if column.type.to_s =~ /_array$/ && value && value.is_a?(Array)
+              value = value.to_postgres_array(new_record?)
+            elsif klass.serialized_attributes.include?(name)
+              value = @attributes[name].serialized_value
+            end
+            attrs[arel_table[name]] = value
+          end
+        end
+      end
+
+      attrs
+    end
+  end
+
   module ConnectionAdapters
     class PostgreSQLAdapter < AbstractAdapter
       POSTGRES_ARRAY_TYPES = %w( string text integer float decimal datetime timestamp time date binary boolean )
@@ -14,7 +38,7 @@ def native_database_types_with_array(*args)
       # Quotes a value for use in an SQL statement
       def quote_with_array(value, column = nil)
         if value && column && column.sql_type =~ /\[\]$/
-          raise ArrayTypeMismatch, "#{column.name} must have a valid array value (#{value})" unless value.kind_of?(Array) || value.valid_postgres_array?
+          raise ArrayTypeMismatch, "#{column.name} must be an Array or have a valid array value (#{value})" unless value.kind_of?(Array) || value.valid_postgres_array?
           return value.to_postgres_array
         end
         quote_without_array(value,column)
@@ -52,7 +76,6 @@ def type_cast_code_with_array(var_name)
       end
       alias_method_chain :type_cast_code, :array
 
-
       # Adds the array type for the column.
       def simplified_type_with_array(field_type)
         if field_type =~ /^numeric.+\[\]$/

lib/activerecord-postgres-array/array.rb

@@ -1,28 +1,28 @@
 class Array
-
   # Generates a single quoted postgres array string format. This is the format used
   # to insert or update stuff in the database.
   def to_postgres_array(omit_quotes = false)
     result = "#{omit_quotes ? '' : "'" }{"
-    
+
     result << collect do |value|
       if value.is_a?(Array)
         value.to_postgres_array(true)
-      else
+      elsif value.is_a?(String)
         value = value.gsub(/\\/, '\&\&')
         value = value.gsub(/'/, "''")
         value = value.gsub(/"/, '\"')
         value = "\"#{ value }\""
         value
+      else
+        value
       end
-    end.join(", ")
-    
+    end.join(",")
+
     result << "}#{omit_quotes ? '' : "'" }"
   end
 
   # If the method from_postgres_array is called in an Array, it just returns self.
   def from_postgres_array(base_type = :string)
     self
   end
-
 end

lib/activerecord-postgres-array/string.rb

@@ -8,28 +8,27 @@ def to_postgres_array
   # * A string like '{10000, 10000, 10000, 10000}'
   # * TODO A multi dimensional array string like '{{"meeting", "lunch"}, {"training", "presentation"}}'
   def valid_postgres_array?
-    quoted_string_regexp = /"[^"\\]*(?:\\.[^"\\]*)*"|'[^'\\]*(?:\\.[^'\\]*)*'/
+    string_regexp = /[^",\\]+/
+    quoted_string_regexp = /"[^"\\]*(?:\\.[^"\\]*)*"/
     number_regexp = /[-+]?[0-9]*\.?[0-9]+/
-    !!match(/^\s*(\{\s*(#{number_regexp}|#{quoted_string_regexp})(\s*\,\s*(#{number_regexp}|#{quoted_string_regexp}))*\})?\s*$/)
+    validation_regexp = /\{\s*(#{number_regexp}|#{quoted_string_regexp}|#{string_regexp})(\s*\,\s*(#{number_regexp}|#{quoted_string_regexp}|#{string_regexp}))*\}/
+    !!match(/^\s*('#{validation_regexp}'|#{validation_regexp})?\s*$/)
   end
 
   # Creates an array from a postgres array string that postgresql spits out.
   def from_postgres_array(base_type = :string)
     if empty?
-      return []
+      []
     else
-      elements = match(/^\{(.+)\}$/).captures.first.split(",")
+      elements = match(/\{(.*)\}/).captures.first.gsub(/\\"/, '$ESCAPED_DOUBLE_QUOTE$').split(/(,)(?=(?:[^"]|"[^"]*")*$)/).reject {|e| e == ',' }
       elements = elements.map do |e|
-        e = e.gsub(/\\"/, '"')
-        e = e.gsub(/^\"/, '')
-        e = e.gsub(/\"$/, '')
-        e = e.strip
+        e.gsub('$ESCAPED_DOUBLE_QUOTE$', '"').gsub("\\\\", "\\").gsub(/^"/, '').gsub(/"$/, '').gsub("''", "'").strip
       end
-      
+
       if base_type == :decimal
-        return elements.collect(&:to_d)
+        elements.collect(&:to_d)
       else
-        return elements
+        elements
       end
     end
   end

spec/array_ext_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'activerecord-postgres-array/array'
+
+describe "Array" do
+  describe "#to_postgres_array" do
+    it "returns '{}' if used on an empty array" do
+      [].to_postgres_array.should == "'{}'"
+    end
+
+    it "returns a correct array if used on a numerical array" do
+      [1,2,3].to_postgres_array.should == "'{1,2,3}'"
+    end
+
+    it "returns a correct array if used on a string array" do
+      ["Ruby","on","Rails"].to_postgres_array.should == "'{\"Ruby\",\"on\",\"Rails\"}'"
+    end
+
+    it "escapes double quotes correctly" do
+      ["Ruby","on","Ra\"ils"].to_postgres_array.should == "'{\"Ruby\",\"on\",\"Ra\\\"ils\"}'"
+    end
+
+    it "escapes backslashes correctly" do
+      ["\\","\""].to_postgres_array.should == '\'{"\\\\","\\""}\''
+    end
+  end
+end

spec/integration_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Article do
+  describe ".create" do
+    it "builds valid arrays" do
+      article = Article.create(:languages => ["English", "German"])
+      article.reload
+      article.languages_before_type_cast.should == "{English,German}"
+      article.languages.should == ["English", "German"]
+    end
+
+    it "escapes single quotes correctly" do
+      article = Article.create(:languages => ["English", "Ger'man"])
+      article.reload
+      article.languages_before_type_cast.should == "{English,Ger''man}"
+      article.languages.should == ["English", "Ger'man"]
+    end
+
+    it "escapes double quotes correctly" do
+      article = Article.create(:languages => ["English", "Ger\"man"])
+      article.reload
+      article.languages_before_type_cast.should == "{English,\"Ger\\\"man\"}"
+      article.languages.should == ["English", "Ger\"man"]
+    end
+
+    it "handles commas correctly" do
+      article = Article.create(:languages => ["English", "Ger,man"])
+      article.reload
+      article.languages_before_type_cast.should == "{English,\"Ger,man\"}"
+      article.languages.should == ["English", "Ger,man"]
+    end
+
+    it "handles backslashes correctly" do
+      article = Article.create(:languages => ["\\","\""])
+      article.reload
+      article.languages_before_type_cast.should == '{"\\\\","\\""}'
+      article.languages.should == ["\\","\""]
+    end
+  end
+  
+  describe ".update" do
+    before(:each) do
+      @article = Article.create
+    end
+
+    it "builds valid arrays" do
+      @article.languages = ["English", "German"]
+      @article.save
+      @article.reload
+      @article.languages_before_type_cast.should == "{English,German}"
+    end
+
+    it "escapes single quotes correctly" do
+      @article.languages = ["English", "Ger'man"]
+      @article.save
+      @article.reload
+      @article.languages_before_type_cast.should == "{English,Ger'man}"
+      @article.languages.should == ["English", "Ger'man"]
+    end
+
+    it "escapes double quotes correctly" do
+      @article.languages = ["English", "Ger\"man"]
+      @article.save
+      @article.reload
+      @article.languages_before_type_cast.should == "{English,\"Ger\\\"man\"}"
+      @article.languages.should == ["English", "Ger\"man"]
+    end
+
+    it "handles commas correctly" do
+      @article.languages = ["English", "Ger,man"]
+      @article.save
+      @article.reload
+      @article.languages_before_type_cast.should == "{English,\"Ger,man\"}"
+      @article.languages.should == ["English", "Ger,man"]
+    end
+
+    it "handles backslashes correctly" do
+      @article.languages = ["\\","\""]
+      @article.save
+      @article.reload
+      @article.languages_before_type_cast.should == '{"\\\\","\\""}'
+      @article.languages.should == ["\\","\""]
+    end
+  end
+
+end

spec/internal/app/models/article.rb

@@ -0,0 +1,2 @@
+class Article < ActiveRecord::Base
+end

spec/internal/config/database.yml

@@ -0,0 +1,6 @@
+test:
+  adapter: postgresql
+  encoding: unicode
+  database: apa_test
+  username: apa_test
+  password:

spec/internal/db/schema.rb

@@ -0,0 +1,6 @@
+ActiveRecord::Schema.define do
+  create_table(:articles, :force => true) do |t|
+    t.string       :name
+    t.string_array :languages
+  end
+end

spec/internal/log/.gitignore

@@ -0,0 +1 @@
+*.log

spec/spec_helper.rb

@@ -1,3 +1,10 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, :development
+
+Combustion.initialize! :active_record
+
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true

spec/string_ext_spec.rb

@@ -27,6 +27,10 @@
       "{213,}".should_not be_valid_postgres_array
     end
 
+    it 'allows enclosing single quotes' do
+      '\'{"ruby", "on", "rails"}\''.should be_valid_postgres_array
+    end
+
     it 'returns false for an array without enclosing curly brackets' do
       "213, 1234".should_not be_valid_postgres_array
     end
@@ -35,16 +39,58 @@
       '{"ruby", "on", "rails"}'.should be_valid_postgres_array
     end
 
-    it 'returns true for a valid postgres string array with single quotes' do
-      "{'ruby', 'on', 'rails'}".should be_valid_postgres_array
+    it 'returns true for a postgres string array with escaped double quote' do
+      '{"ruby", "on", "ra\"ils"}'.should be_valid_postgres_array
+    end
+
+    it 'returns false for a postgres string array with wrong quotation' do
+      '{"ruby", "on", "ra"ils"}'.should_not be_valid_postgres_array
+    end
+
+    it 'returns true for string array without quotes' do
+      "{ruby, on, rails}".should be_valid_postgres_array
     end
 
-    it 'returns false for string array without quotes' do
-      "{ruby, on, rails}".should_not be_valid_postgres_array
+    it 'returns false for array consisting of commas' do
+      "{,,}".should_not be_valid_postgres_array
     end
 
     it 'returns false for concatenated strings' do
       '{"ruby""on""rails"}'.should_not be_valid_postgres_array
     end
+
+    it "returns false if single quotes are not closed" do
+      '\'{"ruby", "on", "rails"}'.should_not be_valid_postgres_array
+    end
+  end
+
+  describe "#from_postgres_array" do
+    it 'returns an empty array if string is empty' do
+      "".from_postgres_array.should == []
+    end
+
+    it 'returns an empty array if empty postgres array is given' do
+      "{}".from_postgres_array.should == []
+    end
+
+    it 'returns an correct array if a valid postgres array is given' do
+      "{Ruby,on,Rails}".from_postgres_array.should == ["Ruby", "on", "Rails"]
+    end
+
+    it 'correctly handles commas' do
+      '{Ruby,on,"Rails,"}'.from_postgres_array.should == ["Ruby", "on", "Rails,"]
+    end
+
+    it 'correctly handles single quotes' do
+      "{Ruby,on,Ra'ils}".from_postgres_array.should == ["Ruby", "on", "Ra'ils"]
+    end
+
+    it 'correctly handles double quotes' do
+      "{Ruby,on,\"Ra\\\"ils\"}".from_postgres_array.should == ["Ruby", "on", 'Ra"ils']
+    end
+
+    it 'correctly handles backslashes' do
+      '\'{"\\\\","\\""}\''.from_postgres_array.should == ["\\","\""]
+    end
   end
 end