activerecord-postgres-array 0.0.1

data/lib/activerecord-postgres-array.rb

@@ -0,0 +1,15 @@
+require 'rails'
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class ActiveRecordPostgresArray < Rails::Railtie
+
+  initializer 'activerecord-postgres-array' do
+    ActiveSupport.on_load :active_record do
+      require "activerecord-postgres-array/activerecord"
+    end
+  end
+end
+
+require "activerecord-postgres-array/string"
+require "activerecord-postgres-array/array"

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

@@ -0,0 +1,70 @@
+module ActiveRecord
+  class ArrayTypeMismatch < ActiveRecord::ActiveRecordError
+  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"})})
+      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?          
+          return value.to_postgres_array
+        end
+        quote_without_array(value,column)
+      end
+      alias_method_chain :quote, :array
+    end
+
+    class TableDefinition
+      # Adds array type for migrations. So you can add columns to a table like:
+      #   create_table :people do |t|
+      #     ...
+      #     t.string_array :real_energy
+      #     t.decimal_array :real_energy, :precision => 18, :scale => 6
+      #     ...
+      #   end
+      PostgreSQLAdapter::POSTGRES_ARRAY_TYPES.each do |column_type|
+        define_method("#{column_type}_array") do |*args|
+          options = args.extract_options!
+          base_type = @base.type_to_sql(column_type.to_sym, options[:limit], options[:precision], options[:scale])
+          column_names = args
+          column_names.each { |name| column(name, "#{base_type}[]", options) }
+        end
+      end
+    end
+
+    class PostgreSQLColumn < Column
+      # Does the type casting from array columns using String#from_postgres_array or Array#from_postgres_array.
+      def type_cast_code_with_array(var_name)
+        if type =~ /_array$/
+          base_type = type.gsub(/_array/, '')
+          "#{var_name}.from_postgres_array(:#{base_type})"
+        else
+          type_cast_code_without_array(var_name)
+        end
+      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 =~ /\[\]$/
+          field_type.gsub(/\[\]/, '_array')
+        else
+          simplified_type_without_array(field_type)
+        end
+      end
+      alias_method_chain :simplified_type, :array
+    end
+  end
+end

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

@@ -0,0 +1,20 @@
+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(", ")
+    
+    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

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

@@ -0,0 +1,30 @@
+class String
+
+  def to_postgres_array
+    self
+  end
+
+  # Validates the array format. Valid formats are:
+  # * An empty 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
+  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)
+      
+      if base_type == :decimal
+        return elements.collect(&:to_d)
+      else
+        return elements
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: activerecord-postgres-array
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tim Connor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-14 00:00:00 +12:00
+default_executable: 
+dependencies: []
+
+description: Adds support for postgres arrays to ActiveRecord
+email: tim@youdo.co.nz
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/activerecord-postgres-array.rb
+- lib/activerecord-postgres-array/activerecord.rb
+- lib/activerecord-postgres-array/array.rb
+- lib/activerecord-postgres-array/string.rb
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Adds support for postgres arrays to ActiveRecord
+test_files: []
+