activerecord-postgres-array 0.0.2 → 0.0.3

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/LICENSE

@@ -0,0 +1,14 @@
+Copyright (c) 2011 Tim Connor <tlconnor@gmail.com>
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+

data/README.textile

@@ -0,0 +1,36 @@
+h2. Postgres array support for activerecord
+
+Add basic support for postgres arrays to activerecord, with special attention to getting rails migrations / schema dumps working nicely.
+
+
+h2. Installation
+
+<pre><code>gem install activerecord-postgres-array</code></pre>
+
+or if you use bundler
+<pre><code>gem 'activerecord-postgres-array'</code></pre>
+
+h2. Usage
+
+* In your migrations you can define postgres array fields such as:
+<pre><code>create_table :people do |t|
+  ...
+  t.string_array :real_energy
+  t.decimal_array :real_energy, :precision => 18, :scale => 6
+  ...
+end
+</code></pre>
+
+* When queried, the postgres arrays will be returned as ruby arrays, and vice versa.
+
+
+h2. Current limitations
+
+* Validation of serialised postgres array strings is currently not implemented.
+* Parsing of multi-dimensional postgres array strings is currently not implemented.
+* String and Decimal arrays have been tested, but other array types have not been.  Type casting will need to be implemented for booleans, dates, etc
+
+h3. Future enhancements
+
+* Arel like querying of values within arrays
+* Arel like aggregate functions

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/activerecord-postgres-array.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name = "activerecord-postgres-array"
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tim Connor"]
+  s.date = %q{2012-02-08}
+  s.description = "Adds support for postgres arrays to ActiveRecord"
+  s.email = "tlconnor@gmail.com"
+  s.homepage = "https://github.com/tlconnor/activerecord-postgres-array"
+  s.files = ["Gemfile", "LICENSE", "Rakefile", "README.textile", "activerecord-postgres-array.gemspec"] + Dir['**/*.rb']
+  s.require_paths = ["lib"]
+  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

data/lib/activerecord-postgres-array/activerecord.rb

@@ -1,21 +1,46 @@
+require 'active_record/connection_adapters/postgresql_adapter'
+
 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 )
 
       def native_database_types_with_array(*args)
-        native_database_types_without_array.merge(POSTGRES_ARRAY_TYPES.inject(Hash.new) {|h, t| h.update("#{t}_array".to_sym => {:name => "#{t}_array"})})
+        native_database_types_without_array.merge(POSTGRES_ARRAY_TYPES.inject(Hash.new) {|h, t| h.update("#{t}_array".to_sym => {:name => "#{native_database_types_without_array[t.to_sym][:name]}[]"})})
       end
       alias_method_chain :native_database_types, :array
 
-    
       # 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 Hash or 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)
@@ -53,13 +78,14 @@ module ActiveRecord
       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.+\[\]$/
           :decimal_array
+        elsif field_type =~ /character varying.*\[\]/
+          :string_array
         elsif field_type =~ /\[\]$/
-          field_type.gsub(/\[\]/, '_array')
+          field_type.gsub(/\[\]/, '_array').to_sym
         else
           simplified_type_without_array(field_type)
         end

data/lib/activerecord-postgres-array/array.rb

@@ -1,14 +1,23 @@
 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|
-      value.is_a?(Array) ? value.to_postgres_array(true) : value
-    end.join(", ")
-    
+      if value.is_a?(Array)
+        value.to_postgres_array(true)
+      elsif value.is_a?(String)
+        value = value.gsub(/\\/, '\&\&')
+        value = value.gsub(/'/, "''")
+        value = value.gsub(/"/, '\"')
+        value = "\"#{ value }\""
+        value
+      else
+        value
+      end
+    end.join(",")
+
     result << "}#{omit_quotes ? '' : "'" }"
   end
 
@@ -16,5 +25,4 @@ class Array
   def from_postgres_array(base_type = :string)
     self
   end
-
 end

data/lib/activerecord-postgres-array/string.rb

@@ -1,5 +1,4 @@
 class String
-
   def to_postgres_array
     self
   end
@@ -9,22 +8,28 @@ class String
   # * A string like '{10000, 10000, 10000, 10000}'
   # * TODO A multi dimensional array string like '{{"meeting", "lunch"}, {"training", "presentation"}}'
   def valid_postgres_array?
-    # TODO validate formats above
-    true
+    string_regexp = /[^",\\]+/
+    quoted_string_regexp = /"[^"\\]*(?:\\.[^"\\]*)*"/
+    number_regexp = /[-+]?[0-9]*\.?[0-9]+/
+    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(",").collect(&:strip)
-      
+      elements = match(/\{(.*)\}/).captures.first.gsub(/\\"/, '$ESCAPED_DOUBLE_QUOTE$').split(/(,)(?=(?:[^"]|"[^"]*")*$)/).reject {|e| e == ',' }
+      elements = elements.map do |e|
+        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
-end
+end

data/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

data/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

data/spec/internal/app/models/article.rb

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

data/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

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+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
+  config.filter_run :focus
+end

data/spec/string_ext_spec.rb

@@ -0,0 +1,105 @@
+require 'spec_helper'
+require 'activerecord-postgres-array/string'
+
+describe "String" do
+  describe "#valid_postgres_array?" do
+    it 'returns true for an empty string' do
+      "".should be_valid_postgres_array
+    end
+
+    it 'returns true for a string consisting only of whitespace' do
+      "   ".should be_valid_postgres_array
+    end
+
+    it 'returns true for a valid postgres integer array' do
+      "{10000, 10000, 10000, 10000}".should be_valid_postgres_array
+    end
+
+    it 'returns true for a valid postgres float array' do
+      "{10000.2, .5, 10000, 10000.9}".should be_valid_postgres_array
+    end
+
+    it 'returns true for a valid postgres numerical array with irregular whitespace' do
+      "{   10000,   10000  ,  10000,10000}".should be_valid_postgres_array
+    end
+
+    it 'returns false for an array with invalid commas' do
+      "{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
+
+    it 'returns true for a valid postgres string array' do
+      '{"ruby", "on", "rails"}'.should be_valid_postgres_array
+    end
+
+    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 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
+
+    it "returns true for an empty postgres array" do
+      "{}".should be_valid_postgres_array
+    end
+
+    it "returns false for postgres array beginning with ," 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

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: activerecord-postgres-array
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: 
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Tim Connor
@@ -15,12 +15,84 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-15 00:00:00 +12:00
+date: 2012-02-08 00:00:00 +13:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 0
+        version: "2.0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: pg
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: combustion
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 17
+        segments: 
+        - 0
+        - 3
+        - 1
+        version: 0.3.1
+  type: :development
+  version_requirements: *id005
 description: Adds support for postgres arrays to ActiveRecord
-email: tim@youdo.co.nz
+email: tlconnor@gmail.com
 executables: []
 
 extensions: []
@@ -28,12 +100,23 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- lib/activerecord-postgres-array.rb
+- Gemfile
+- LICENSE
+- Rakefile
+- README.textile
+- activerecord-postgres-array.gemspec
 - lib/activerecord-postgres-array/activerecord.rb
 - lib/activerecord-postgres-array/array.rb
 - lib/activerecord-postgres-array/string.rb
+- lib/activerecord-postgres-array.rb
+- spec/array_ext_spec.rb
+- spec/integration_spec.rb
+- spec/internal/app/models/article.rb
+- spec/internal/db/schema.rb
+- spec/spec_helper.rb
+- spec/string_ext_spec.rb
 has_rdoc: true
-homepage: 
+homepage: https://github.com/tlconnor/activerecord-postgres-array
 licenses: []
 
 post_install_message: