activerecord-postgres-composite-types 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a672371db2d4c5253b4d0366fffacb81ca9a1f9
-  data.tar.gz: 95d2bc56e7de9667483dbff0b820b8a56c67b064
+  metadata.gz: 3f1180c2f69bc0bcff969b4d5a0a8fc62ff6c2fd
+  data.tar.gz: 6a94bec2dccd909fa613e66a50eee379dea61298
 SHA512:
-  metadata.gz: 996d82110e931d65a4d7ebff634614240f88f3c099b5daee3feda515ee670c14f6c60593b629d772e9bfc2bb7a369a04a59c379f919001fc39072f89ac2ad15d
-  data.tar.gz: db42a073c0563bafe9bd25d7c486e84cdc26df04a8e0a2e9fca6dae4020e21deb10f3db6275ea162a4627eaf835a2bb6e171cb32cfc827d56098d357117d0f6d
+  metadata.gz: e87be224bc26e25a18ba0a641b2f764da2ff7708c1b17f667f1977cc17f1f75e19dff6996e6e9f6279490b1c8a79b14949af23f5d44cddf528ceaf5bbb455e3b
+  data.tar.gz: cd42315a520c43ea636876e796d99730d848de9069adb0b22beadb0ebf64a6e53bb73ad0fab52f4ce380423762d8ca4459f464026a6d482d1893e9eb4605fb9f

data/README.rdoc

@@ -44,10 +44,26 @@ and then
 
 To achieve this goal I only have to define composite type class in a following way:
 
+  require 'postgres_composite_type'
   class ComplexType < PostgresCompositeType
     register_type :complex
   end
 
+This class must be loaded before any ActiveRecord model is instantializated, but NOT before
+ActiveRecord is loaded. Load your classes with ActiveRecord hook:
+
+  ActiveSupport.on_load :active_record do
+    require 'complex_type'
+  end
+
+You can of course put this code in your railtie initializer:
+
+  initialize :complexy_type do
+    ActiveSupport.on_load :active_record do
+      require 'complex_type'
+    end
+  end
+
 That's all folks.
 
 == Contributing to ActiveRecord PostgreSQL Composite Types

data/VERSION

@@ -1 +1 @@
-0.2.2
+0.2.3

data/activerecord-postgres-composite-types.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "activerecord-postgres-composite-types"
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Rafal Bigaj"]
-  s.date = "2014-09-11"
+  s.date = "2014-09-12"
   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 = [
@@ -25,14 +25,13 @@ Gem::Specification.new do |s|
     "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",
+    "lib/activerecord-postgres-composite-types/railtie.rb",
+    "lib/postgres_composite_type.rb",
     "test/composite_types.rb",
     "test/helper.rb",
     "test/internal/config/database.yml",

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

@@ -1,13 +1,10 @@
 require 'active_record'
-require 'active_record/connection_adapters/postgresql_adapter'
 
 if defined? Rails
-	require "activerecord-postgres-composite-types/railties"
+	require "activerecord-postgres-composite-types/railtie"
 else
 	ActiveSupport.on_load :active_record do
 		require "activerecord-postgres-composite-types/active_record"
+		require 'postgres_composite_type'
 	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

@@ -1,4 +1,8 @@
 # Extends AR to add composite types functionality.
+
+require 'active_record/connection_adapters/postgresql_adapter'
+require 'activerecord-postgres-composite-types/composite_type_parser'
+
 module ActiveRecord
 
 	module ConnectionAdapters

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

@@ -0,0 +1,17 @@
+require 'rails'
+
+# = Postgres Composite Types Railtie
+#
+# Creates a new railtie to initialize ActiveRecord properly
+
+class PostgresCompositeTypesRailtie < Rails::Railtie
+
+	initializer 'activerecord-postgres-composite-types' do
+		ActiveSupport.on_load :active_record do
+			require "activerecord-postgres-composite-types/active_record"
+			require 'postgres_composite_type'
+		end
+	end
+
+end
+

data/lib/{activerecord-postgres-composite-types/postgres_composite_type.rb → postgres_composite_type.rb}

@@ -1,29 +1,52 @@
+require 'activerecord-postgres-composite-types/active_record'
+
 class PostgresCompositeType
 	include Comparable
 
 	class << self
-		# TODO: doc
+		# The PostgreSQL type name as symbol
 		attr_reader :type
-		# TODO: doc
+		# Column definition read from db schema
 		attr_reader :columns
 
+		# Link PostgreSQL type given by the name with this class.
+		# Usage:
+		#
+		# class ComplexType < PostgresCompositeType
+		#   register_type :complex
+		# end
+		#
+		# @param [Symbol] :type the PostgreSQL type name
 		def register_type(type)
 			@type = type.to_sym
 			ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.register_composite_type_class(self)
 		end
 
+		# Be default the ActiveRecord::Base connection is used when reading type definition.
+		# If you want to use connection linked with another class use this method.
+		# Usage
+		#
+		# class ComplexType < PostgresCompositeType
+		#   register_type :complex
+		#   use_connection_class MyRecordConnectedToDifferentDB
+		# end
+		#
+		# @param [Class] :active_record_class the ActiveRecord model class
 		def use_connection_class(active_record_class)
 			@connection_class = active_record_class
 		end
 
+		# :nodoc:
 		def connection
 			(@connection_class || ActiveRecord::Base).connection
 		end
 
+		# :nodoc:
 		def connected?
 			(@connection_class || ActiveRecord::Base).connected?
 		end
 
+		# :nodoc:
 		def initialize_column_definition
 			unless @columns
 				@columns = self.connection.columns(type)

data/test/composite_types.rb

@@ -1,3 +1,4 @@
+require 'postgres_composite_type'
 
 if ActiveRecord::VERSION::MAJOR > 3
 	ActiveRecord::ConnectionAdapters::PostgreSQLAdapter::OID.alias_type 'rgb_color', 'text'

data/test/helper.rb

@@ -30,8 +30,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'activerecord-postgres-composite-types'
 
 ActiveSupport.on_load :active_record do
-	require 'activerecord-postgres-composite-types/active_record'
-	require_relative 'composite_types.rb'
+	require_relative 'composite_types'
 end
 
 Combustion.path = 'test/internal'

data/test/internal/config/database.yml

@@ -1,5 +1,5 @@
 test:
   adapter:  postgresql
-  database: pg_composite_types_test
-  username: postgres
-  password: postgres
+  database: <%= ENV['DATABASE_NAME_TEST'] %>
+  username: <%= ENV['DATABASE_USERNAME'] %>
+  password: <%= ENV['DATABASE_PASSWORD'] %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-postgres-composite-types
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Rafal Bigaj
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-11 00:00:00.000000000 Z
+date: 2014-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -167,14 +167,13 @@ files:
 - 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
+- lib/activerecord-postgres-composite-types/railtie.rb
+- lib/postgres_composite_type.rb
 - test/composite_types.rb
 - test/helper.rb
 - test/internal/config/database.yml

data/activerecord-postgres-custom-types.gemspec

@@ -1,91 +0,0 @@
-# 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/railties.rb

@@ -1,16 +0,0 @@
-require 'rails'
-
-# = Postgres Composite Types Railtie
-#
-# Creates a new railtie to initialize ActiveRecord properly
-
-class PostgresCompositeTypesRailtie < Rails::Railtie
-
-  initializer 'activerecord-postgres-composite-types' do
-    ActiveSupport.on_load :active_record do
-      require "activerecord-postgres-composite-types/active_record"
-    end
-  end
-
-end
-