activerecord-postgres-composite-types 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b627568edb4af7a5cf7f1fd39a177bf6d63dbe5b
+  data.tar.gz: d8207155ee161a0bd76cc55568fe49454c91e18b
+SHA512:
+  metadata.gz: ec183d3ddc32a9362c6239dccfa4a33413f52c1936808387ebf42ea8d4f018ec65d084c2571ab5c41341853c8441c3235aa633b6ff7db574572f81f46c745f20
+  data.tar.gz: 56b778cecddabaf1ade15c3389b849c36fa8241e0831fa02c01876c82c5dafefe675fa2497ef66266eaf0017d04e1452bd831b0ebff53113e05228f233f7cad7

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+addons:
+  postgresql: "9.3"
+before_script:
+  - cp test/internal/config/database.yml.travis test/internal/config/database.yml

data/Gemfile

@@ -0,0 +1,18 @@
+source 'http://rubygems.org'
+
+AR_VERSION = '3.2.0'
+
+gem 'activerecord', ">= #{AR_VERSION}"
+gem 'pg', '>= 0.17.0'
+
+group :development do
+	gem 'test-unit', '~> 2.1'
+	gem 'shoulda', '>= 0'
+	gem 'rdoc', '~> 3.12'
+	gem 'rake', '~> 10.3'
+	gem 'bundler', '~> 1.0'
+	gem 'jeweler', '~> 2.0.1' unless RUBY_PLATFORM =~ /mswin/
+	gem 'simplecov', '>= 0'
+	gem 'combustion', '~> 0.5.2'
+	gem 'tzinfo-data' if AR_VERSION > '3.2.0'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 PuzzleFlow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Rafał Bigaj
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,67 @@
+{<img src="https://codeclimate.com/github/PuzzleFlow/activerecord-postgres-composite-types/badges/gpa.svg" />}[https://codeclimate.com/github/PuzzleFlow/activerecord-postgres-composite-types]
+{<img src="https://travis-ci.org/PuzzleFlow/activerecord-postgres-composite-types.svg?branch=master" alt="Build Status" />}[https://travis-ci.org/PuzzleFlow/activerecord-postgres-composite-types]
+{<img src="http://inch-ci.org/github/PuzzleFlow/activerecord-postgres-composite-types.png?branch=master" alt="Inline docs" />}[http://inch-ci.org/github/PuzzleFlow/activerecord-postgres-composite-types]
+{<img src="https://badge.fury.io/rb/activerecord-postgres-composite-types.svg" alt="Gem Version" />}[http://badge.fury.io/rb/activerecord-postgres-composite-types]
+
+= ActiveRecord PostgreSQL Composite Types
+
+This gem adds support to the ActiveRecord (3.x and 4.x) for composite types.
+
+One of PostgreSQL interesting feature is composite types — it basically allows to group related columns into a single type declaration like this:
+
+  create type complex as (
+    number real,
+    title text
+  );
+
+Form this moment a type 'complex' is a regular PostgreSQL type and can be used in functions, column definitions, other types definition, etc.
+ActiveRecord, especially from version 4.0, has extended set of supported types like arrays, hstore, json, range, ...
+But there is no support for user defined composite types.
+
+== The Goal
+
+For my composite type 'complex' and table like this:
+
+  create_table :foos, :id => false do |t|
+    t.column :comp, :complex, default: "(0,\"\")"
+  end
+
+I can access my data in simple and natural way:
+
+  class Foo < ActiveRecord::Base
+  end
+
+  foo = Foo.create!(:comp => {:number => 1.2, :title => "Cool!"})
+
+or
+
+  foo = Foo.create!(:comp => [1.2, "Cool!"])
+
+and then
+
+  foo.comp.number # => 1.2
+  foo.comp.title # => "Cool!"
+
+To achieve this goal I only have to define my composite type in a following way:
+
+  class ComplexType < PostgresCompositeType
+    register_type :complex
+  end
+
+That's all folks.
+
+== Contributing to ActiveRecord PostgreSQL Composite Types
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2014 Rafał Bigaj. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+unless RUBY_PLATFORM =~ /mswin/
+	require 'jeweler'
+	Jeweler::Tasks.new do |gem|
+		# gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+		gem.name = "activerecord-postgres-composite-types"
+		gem.homepage = "http://github.com/puzzleflow/activerecord-postgres-composite-types"
+		gem.license = "MIT"
+		gem.summary = %Q{ActiveRecord composite types support}
+		gem.description = %Q{This gem adds support to the ActiveRecord (3.x and 4.x) for composite types.}
+		gem.email = "rafal.bigaj@puzzleflow.com"
+		gem.authors = ["Rafal Bigaj"]
+		# dependencies defined in Gemfile
+	end
+	Jeweler::RubygemsDotOrgTasks.new
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['test'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "activerecord-postgres-custom-types #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.1

data/activerecord-postgres-composite-types.gemspec

@@ -0,0 +1,92 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "activerecord-postgres-composite-types"
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rafal Bigaj"]
+  s.date = "2014-09-09"
+  s.description = "This gem adds support to the ActiveRecord (3.x and 4.x) for composite types."
+  s.email = "rafal.bigaj@puzzleflow.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".travis.yml",
+    "Gemfile",
+    "LICENSE",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "activerecord-postgres-composite-types.gemspec",
+    "activerecord-postgres-custom-types.gemspec",
+    "lib/activerecord-postgres-composite-types.rb",
+    "lib/activerecord-postgres-composite-types/active_record.rb",
+    "lib/activerecord-postgres-composite-types/active_record_3.rb",
+    "lib/activerecord-postgres-composite-types/active_record_4.rb",
+    "lib/activerecord-postgres-composite-types/composite_type_parser.rb",
+    "lib/activerecord-postgres-composite-types/postgres_composite_type.rb",
+    "lib/activerecord-postgres-composite-types/railties.rb",
+    "test/composite_types.rb",
+    "test/helper.rb",
+    "test/internal/config/database.yml",
+    "test/internal/config/database.yml.travis",
+    "test/internal/db/schema.rb",
+    "test/test_composite_type_class.rb",
+    "test/test_nested_types.rb",
+    "test/test_postgres_composite_types.rb"
+  ]
+  s.homepage = "http://github.com/puzzleflow/activerecord-postgres-composite-types"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "ActiveRecord composite types support"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.2.0"])
+      s.add_runtime_dependency(%q<pg>, [">= 0.17.0"])
+      s.add_development_dependency(%q<test-unit>, ["~> 2.1"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<rake>, ["~> 10.3"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<combustion>, ["~> 0.5.2"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.2.0"])
+      s.add_dependency(%q<pg>, [">= 0.17.0"])
+      s.add_dependency(%q<test-unit>, ["~> 2.1"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<rake>, ["~> 10.3"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<combustion>, ["~> 0.5.2"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.2.0"])
+    s.add_dependency(%q<pg>, [">= 0.17.0"])
+    s.add_dependency(%q<test-unit>, ["~> 2.1"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<rake>, ["~> 10.3"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<combustion>, ["~> 0.5.2"])
+  end
+end
+

data/activerecord-postgres-custom-types.gemspec

@@ -0,0 +1,91 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "activerecord-postgres-custom-types"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Rafal Bigaj"]
+  s.date = "2014-09-09"
+  s.description = "This gem adds support to the ActiveRecord (3.x and 4.x) for composite types."
+  s.email = "rafal.bigaj@puzzleflow.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".travis.yml",
+    "Gemfile",
+    "LICENSE",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "activerecord-postgres-custom-types.gemspec",
+    "lib/activerecord-postgres-composite-types.rb",
+    "lib/activerecord-postgres-composite-types/active_record.rb",
+    "lib/activerecord-postgres-composite-types/active_record_3.rb",
+    "lib/activerecord-postgres-composite-types/active_record_4.rb",
+    "lib/activerecord-postgres-composite-types/composite_type_parser.rb",
+    "lib/activerecord-postgres-composite-types/postgres_composite_type.rb",
+    "lib/activerecord-postgres-composite-types/railties.rb",
+    "test/composite_types.rb",
+    "test/helper.rb",
+    "test/internal/config/database.yml",
+    "test/internal/config/database.yml.travis",
+    "test/internal/db/schema.rb",
+    "test/test_composite_type_class.rb",
+    "test/test_nested_types.rb",
+    "test/test_postgres_composite_types.rb"
+  ]
+  s.homepage = "http://github.com/rafalbigaj/activerecord-postgres-custom-types"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "2.0.3"
+  s.summary = "ActiveRecord composite types support"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.2.0"])
+      s.add_runtime_dependency(%q<pg>, [">= 0.17.0"])
+      s.add_development_dependency(%q<test-unit>, ["~> 2.1"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<rake>, ["~> 10.3"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<combustion>, ["~> 0.5.2"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 3.2.0"])
+      s.add_dependency(%q<pg>, [">= 0.17.0"])
+      s.add_dependency(%q<test-unit>, ["~> 2.1"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<rake>, ["~> 10.3"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<combustion>, ["~> 0.5.2"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 3.2.0"])
+    s.add_dependency(%q<pg>, [">= 0.17.0"])
+    s.add_dependency(%q<test-unit>, ["~> 2.1"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<rake>, ["~> 10.3"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<combustion>, ["~> 0.5.2"])
+  end
+end
+

data/lib/activerecord-postgres-composite-types.rb

@@ -0,0 +1,13 @@
+require 'active_record'
+require 'active_record/connection_adapters/postgresql_adapter'
+
+if defined? Rails
+	require "activerecord-postgres-composite-types/railties"
+else
+	ActiveSupport.on_load :active_record do
+		require "activerecord-postgres-composite-types/active_record"
+	end
+end
+
+require "activerecord-postgres-composite-types/postgres_composite_type"
+require "activerecord-postgres-composite-types/composite_type_parser"

data/lib/activerecord-postgres-composite-types/active_record.rb

@@ -0,0 +1,166 @@
+# Extends AR to add composite types functionality.
+module ActiveRecord
+
+	module ConnectionAdapters
+
+		class PostgreSQLAdapter
+
+			# Quotes the column value to help prevent {SQL injection attacks}
+			def quote_with_composite_types(value, column = nil)
+				if value.class < PostgresCompositeType
+					"'#{PostgreSQLColumn.composite_type_to_string(value, self).gsub(/'/, "''")}'"
+				else
+					quote_without_composite_types(value, column)
+				end
+			end
+
+			alias_method_chain :quote, :composite_types
+
+			class << self
+				def register_composite_type_class(klass)
+					self.composite_type_classes[klass.type] = klass
+					TableDefinition.register_composite_type klass.type
+					Table.register_composite_type klass.type
+					register_arel_visitor klass
+					register_oid_type klass
+				end
+
+				def register_arel_visitor(klass)
+					Arel::Visitors::ToSql.class_eval <<-RUBY
+						def visit_#{klass}(o, a=nil)
+							@connection.quote(o) + '::#{klass.type}'
+						end
+					RUBY
+				end
+
+				def register_oid_type(klass)
+					# only AR 4.X
+				end
+
+				# removes composite types definition (for testing)
+				def unregister_composite_types(*composite_types)
+					composite_types.each { |type| unregister_composite_type type }
+				end
+
+				# removes composite type definition (for testing)
+				def unregister_composite_type(type)
+					self.composite_type_classes.delete(type.to_sym)
+					TableDefinition.unregister_composite_type type
+					Table.unregister_composite_type type
+				end
+
+				def composite_type_classes
+					@composite_type_classes ||= {}
+				end
+			end
+		end
+
+		class PostgreSQLColumn < Column
+			# Adds composite type for the column.
+
+			def composite_type_class
+				PostgreSQLAdapter.composite_type_classes[type]
+			end
+
+			def klass_with_composite_types
+				composite_type_klass = PostgreSQLAdapter.composite_type_classes[type]
+				composite_type_klass || klass_without_composite_types
+			end
+
+			alias_method_chain :klass, :composite_types
+
+			def self.string_to_composite_type(klass, string)
+				return string unless String === string
+				if string.present?
+					klass.new(string)
+				end
+			end
+
+			def self.string_to_composite_type(klass, string)
+				return string unless String === string
+				if string.present?
+					fields = CompositeTypeParser.parse_data(string).map.with_index {|val, i| type_cast_composite_type_field(klass, i, val)}
+					klass.new(fields)
+				end
+			end
+
+			def self.type_cast_composite_type_field(klass, i, value)
+				klass.initialize_column_definition
+
+				column = klass.columns[i]
+				raise "Invalid column index: #{i}" unless column
+				cv = column.type_cast(value)
+				if cv.is_a?(String)
+					# unquote
+					cv = cv.upcase == 'NULL' ? nil : cv.gsub(/\A"(.*)"\Z/m) { $1.gsub(/\\(.)/, '\1') }
+				end
+				cv
+			end
+
+			private
+
+			def simplified_type_with_composite_types(field_type)
+				type = field_type.to_sym
+				if PostgreSQLAdapter.composite_type_classes.has_key?(type)
+					type
+				else
+					simplified_type_without_composite_types(field_type)
+				end
+			end
+
+			alias_method_chain :simplified_type, :composite_types
+		end
+
+		class << TableDefinition
+			# Adds composite type for migrations. So you can add columns to a table like:
+			#   create_table :people do |t|
+			#     ...
+			#     t.composite_type :composite_value
+			#     ...
+			#   end
+			def register_composite_type(composite_type)
+				class_eval <<-RUBY
+					def #{composite_type}(*args)
+						options = args.extract_options!
+						column_names = args
+						column_names.each { |name| column(name, '#{composite_type}', options) }
+					end
+				RUBY
+			end
+
+			# Removes composite types from migrations (for testing)
+			def unregister_composite_type(composite_type)
+				remove_method composite_type
+			end
+		end
+
+		class << Table
+
+			# Adds composite type for migrations. So you can add columns to a table like:
+			#   change_table :people do |t|
+			#     ...
+			#     t.composite_type :composite_value
+			#     ...
+			#   end
+			def register_composite_type(composite_type)
+				class_eval <<-RUBY
+					def #{composite_type}(*args)
+						options = args.extract_options!
+						column_names = args
+						column_names.each { |name| column(name, '#{composite_type}', options) }
+					end
+				RUBY
+			end
+
+			# Removes composite types from migrations (for testing)
+			def unregister_composite_type(composite_type)
+				remove_method composite_type
+			end
+
+		end
+
+	end
+
+end
+
+require_relative "active_record_#{ActiveRecord::VERSION::MAJOR}"