schema_qualified_tables 1.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.gemspec
+pkg
+coverage

data/CHANGELOG.markdown

@@ -0,0 +1,37 @@
+1.0.0
+=====
+- Split out from NUBIC internal `bcdatabase` project.
+  (Changelog entries below reflect the relevant changes & version numbers from that project.)
+
+0.6.2
+=====
+- Fix infinite recursion bug when schema-qualified tables are enabled on a
+  database which doesn't support sequences.
+
+0.6.1
+=====
+- Schema-qualified names are dynamically determined, removing the order
+  dependency between setting ActiveRecord::Base.schemas and defining any
+  particular model.  Side effect: schema-qualified names do not work with
+  anonymous models at all (previously they only worked in certain
+  circumstances).
+
+0.6.0
+=====
+- Make the schema part of SchemaQualifiedTables inherited so that it can be
+  set just once in a base class for a whole hierarchy.
+- Ensure that set_schema does not throw an exception when invoked before the
+  connection is established.
+
+0.5.2
+=====
+- Works with CPKs
+
+0.5.1
+=====
+- Support schema-qualified sequence names in SchemaQualifiedTables, too
+
+0.5.0
+=====
+- Extension Bcdatabase:Rails::SchemaQualifiedTables to add schema-qualified 
+  table name support to active record.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rhett Sutphin and Peter Nyberg
+
+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.markdown

@@ -0,0 +1,82 @@
+SchemaQualifiedTables
+=====================
+
+`Bcdatabase::ActiveRecord::SchemaQualifiedTables` is a mix-in for [ActiveRecord][].  It makes it easier to use AR in an application which contains models which map to tables in different schemas.
+
+[ActiveRecord]: http://api.rubyonrails.org/files/vendor/rails/activerecord/README.html
+
+For example
+===========
+
+Say you have an application using a legacy schema that has models like this:
+
+    class Surgery < ActiveRecord::Base
+      belongs_to :surgeon, :class_name => "Person", :foreign_key => "surgeon_id"
+      set_table_name "t_surgeries"
+    end
+
+    class Person < ActiveRecord::Base
+      set_table_name "hr.t_personnel"
+    end
+
+These models map to tables in two schemas: the default schema, which contains `t_surgeries`; and the schema `hr`, which contains `t_personnel`.  
+
+Contention
+----------
+
+Being explicit about the schema name works for production, but what about development?  You'll need separate database instances for development deployment and for test.  Depending on what database you're using, this can be more or less fun (I'm looking at you, Oracle).
+
+Also consider continuous integration:  if you have several applications in CI which all refer to the `hr` schema, their test data sets will stomp all over each other if you try to run them in parallel.
+
+Solution
+--------
+
+`SchemaQualifiedTables` solves this problem by letting you configure a logical schema name for your models which is resolved into the actual schema name based on runtime configuration.  In this case, you'd re-write `Person` like so:
+
+    class Person < ActiveRecord::Base
+      set_schema :hr
+      set_table_name :t_personnel
+    end
+
+Then, if you need to override the actual schema name in some environments, configure `ActiveRecord::Base.schemas`:
+
+    # in test.rb
+    config.after_initialize do
+      ActiveRecord::Base.schemas = {
+        :hr => 'hr_test',
+      }
+    end
+
+This way in the test environment, AR will map `Person` to `hr_test.t_personnel`.  In any environment where you don't provide an explicit override, the logical schema name will be used as the actual schema name &mdash; i.e., in development and production, AR will map `Person` to `hr.t_personnel`.
+
+Installing
+==========
+
+Install the gem:
+
+    $ gem install schema_qualified_tables
+
+If you're using rails, configure it in environment.rb:
+
+    config.gem 'schema_qualified_tables', :version => '>= 1.0.0',
+      :lib => 'bcdatabase/active_record/schema_qualified_tables',
+      :source => 'http://gemcutter.org'
+
+Otherwise, just require 'bcdatabase/activerecord/schema_qualified_tables' sometime during initialization (before your models are loaded).
+
+Problems?
+=========
+
+Please send any questions to Rhett Sutphin (rhett@detailedbalance.net).
+
+Credits
+=======
+
+`SchemaQualifiedTables` was developed at the [Northwestern University Biomedical Informatics Center][NUBIC].
+
+[NUBIC]: http://www.nucats.northwestern.edu/centers/nubic/index.html
+
+Copyright
+---------
+
+Copyright (c) 2009 Rhett Sutphin and Peter Nyberg. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "schema_qualified_tables"
+    gem.summary = %Q{Logical schema names for ActiveRecord models}
+    gem.description = %Q{An ActiveRecord mix-in that makes it easier to use AR in an application which contains models which map to tables in different schemas.}
+    gem.email = "rhett@detailedbalance.net"
+    gem.homepage = "http://github.com/rsutphin/schema_qualified_tables"
+    gem.authors = ["Rhett Sutphin", "Peter Nyberg"]
+    gem.add_development_dependency "rspec", ">= 1.2"
+    gem.add_dependency 'activerecord', '>= 2.3'
+
+    gem.files.include("lib/**/*")
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+  # rcov can't tell that /Library/Ruby is a system path
+  spec.rcov_opts = ['--exclude', "spec/*,/Library/Ruby/*"]
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "schema_qualified_tables #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Disable github release since I don't want to commit the gemspec
+Rake::Task[:release].prerequisites.delete 'github:release'
+
+task :build => [:gemspec]

data/VERSION.yml

@@ -0,0 +1,5 @@
+--- 
+:major: 1
+:minor: 0
+:build: 
+:patch: 0

data/lib/bcdatabase/active_record/schema_qualified_tables.rb

@@ -0,0 +1,80 @@
+require 'active_record'
+
+module Bcdatabase
+  module ActiveRecord
+    module SchemaQualifiedTables
+      def self.included(clz)
+        clz.instance_eval do
+          extend ClassMethods
+          class_inheritable_accessor :schema
+
+          class << self
+            alias_method_chain :set_table_name, :schema
+            alias_method_chain :set_sequence_name, :schema
+          end
+        end
+      end
+
+      module ClassMethods
+        attr_accessor :schemas
+
+        def set_schema(schema)
+          self.schema = schema
+          unless abstract_class?
+            begin
+              update_qualified_table_name
+              update_qualified_sequence_name unless self.respond_to?(:primary_keys)
+            rescue ::ActiveRecord::ConnectionNotEstablished
+              # Defer
+            end
+          end
+        end
+
+        def set_table_name_with_schema(name)
+          update_qualified_table_name(name)
+        end
+
+        def set_sequence_name_with_schema(name)
+          if name
+            update_qualified_sequence_name(name)
+          else
+            set_sequence_name_without_schema(name)
+          end
+        end
+
+        def schemas
+          @schemas ||= { }
+        end
+
+        protected
+
+        def schema_name
+          ::ActiveRecord::Base.schemas[self.schema] || self.schema
+        end
+
+        def update_qualified_table_name(table = nil)
+          update_qualified(:table_name, table)
+        end
+
+        def update_qualified_sequence_name(sequence = nil)
+          update_qualified(:sequence_name, sequence)
+        end
+
+        def update_qualified(thing, new_value)
+          unless new_value
+            current = self.send(thing) # invoke once only because of side effects
+            new_value =
+              if current.respond_to?(:include?) && current.include?('.')
+                current.split('.', 2).last
+              else
+                current
+              end
+          end
+          self.send(:"set_#{thing}_without_schema", nil) { new_value ? [schema_name, new_value].compact.join('.') : nil }
+        end
+      end
+    end
+  end
+end
+
+::ActiveRecord::Base.send(:include, Bcdatabase::ActiveRecord::SchemaQualifiedTables)

data/spec/bcdatabase/active_record/schema_qualified_tables_spec.rb

@@ -0,0 +1,357 @@
+require File.expand_path("../../spec_helper", File.dirname(__FILE__))
+require 'active_record'
+ActiveRecord.load_all! if ActiveRecord.respond_to?(:load_all!)  # Lazy loading of active_record was added to rails 2.3.2
+                                                                # so we have to explicitly load it this way for cpk to work.
+require 'composite_primary_keys'
+require 'bcdatabase/active_record/schema_qualified_tables'
+
+describe "SchemaQualifiedTables" do
+  before do
+    @conn = mock(ActiveRecord::ConnectionAdapters::AbstractAdapter)
+    @conn.stub!(:default_sequence_name).and_return("default_sequence_name")
+    ActiveRecord::Base.connection_handler.stub!(:retrieve_connection).and_return(@conn)
+  end
+
+  after do
+    Object.class_eval do
+      %w(ReadingMaterialBase Book Magazine Newspaper Pamphlet).each do |clazz|
+        remove_const clazz if const_defined? clazz
+      end
+    end
+  end
+
+  describe "tables" do
+    describe "with no schema name" do
+      it "uses the inferred table name" do
+        class Book < ActiveRecord::Base
+        end
+
+        Book.table_name.should == 'books'
+      end
+
+      it "uses just the explicit tablename" do
+        class Novel < ActiveRecord::Base
+          set_table_name "books"
+        end
+
+        Novel.table_name.should == 'books'
+      end
+    end
+
+    describe "with schema name" do
+      it "uses the inferred table name" do
+        class Magazine < ActiveRecord::Base
+          set_schema :reading_material
+        end
+
+        Magazine.table_name.should == 'reading_material.magazines'
+      end
+
+      it "uses the explicit table name, if first" do
+        class Magazine < ActiveRecord::Base
+          set_table_name "some_magazines"
+          set_schema :reading_material
+        end
+
+        Magazine.table_name.should == "reading_material.some_magazines"
+      end
+
+      it "uses the explicit table name, if second" do
+        class Magazine < ActiveRecord::Base
+          set_schema :reading_material
+          set_table_name "some_magazines"
+        end
+
+        Magazine.table_name.should == "reading_material.some_magazines"
+      end
+
+      it "preserves the schema name if the table name is set several times" do
+        class Magazine < ActiveRecord::Base
+          set_schema :reading_material
+          set_table_name "some_magazines"
+
+          set_table_name "other_magazines"
+        end
+
+        Magazine.table_name.should == "reading_material.other_magazines"
+      end
+
+      it "uses the last schema if set several times" do
+        class Magazine < ActiveRecord::Base
+          set_schema :reading_material
+          set_table_name "some_magazines"
+          set_schema :periodicals
+        end
+
+        Magazine.table_name.should == "periodicals.some_magazines"
+      end
+
+      it "works if set_schema is called without a connection" do
+        ActiveRecord::Base.connection_handler.should_receive(:retrieve_connection).
+          and_raise(ActiveRecord::ConnectionNotEstablished)
+        lambda {
+          class Magazine < ActiveRecord::Base
+            set_schema :periodicals
+          end
+        }.should_not raise_error
+
+        Magazine.table_name.should == "periodicals.magazines"
+      end
+
+      describe "from the parent" do
+        before do
+          class ReadingMaterialBase < ActiveRecord::Base
+            self.abstract_class = true
+            set_schema :reading_material
+          end
+        end
+
+        it "inherits the schema from its parent class" do
+          class Magazine < ReadingMaterialBase
+            set_table_name "some_magazines"
+          end
+
+          Magazine.schema.should == :reading_material
+          Magazine.table_name.should == "reading_material.some_magazines"
+        end
+
+        it "uses the inferred table name for a child" do
+          pending "bug in ActiveRecord::Base.reset_table_name"
+                  # Fails because the first call to reset_table_name
+                  # always returns just the inferred table name.  Usually
+                  # the first call is during set_table_name or set_schema.
+                  # In this spec, it is in the call to table_name, below.
+          class Newspaper < ReadingMaterialBase; end
+
+          Newspaper.schema.should == :reading_material
+          Newspaper.table_name.should == "reading_material.newspapers"
+        end
+
+        it "uses separate schemas for subclasses" do
+          class Magazine < ReadingMaterialBase
+            set_table_name "some_magazines"
+            set_schema :periodicals
+          end
+          class Newspaper < ReadingMaterialBase
+            set_schema :deprecated
+          end
+
+          Magazine.table_name.should == "periodicals.some_magazines"
+          Newspaper.table_name.should == "deprecated.newspapers"
+        end
+      end
+
+      describe "with name overrides" do
+        before do
+          ActiveRecord::Base.schemas = {
+            :reading_material => 'reading_material_test'
+          }
+        end
+
+        after do
+          ActiveRecord::Base.schemas.clear
+        end
+
+        it "uses the inferred table name" do
+          class Pamphlet < ActiveRecord::Base
+            set_schema :reading_material
+          end
+
+          Pamphlet.table_name.should == 'reading_material_test.pamphlets'
+        end
+
+        it "uses the explicit table name, if first" do
+          class Pamphlet < ActiveRecord::Base
+            set_table_name "some_pamphlets"
+            set_schema :reading_material
+          end
+
+          Pamphlet.table_name.should == "reading_material_test.some_pamphlets"
+        end
+
+        it "uses the explicit table name, if second" do
+          class Pamphlet < ActiveRecord::Base
+            set_schema :reading_material
+            set_table_name "some_pamphlets"
+          end
+
+          Pamphlet.table_name.should == "reading_material_test.some_pamphlets"
+        end
+
+        it "applies name overrides that come after the model is loaded" do
+          class Newspaper < ActiveRecord::Base
+            set_table_name "newspaperos"
+            set_schema :periodicals
+          end
+
+          ActiveRecord::Base.schemas = { :periodicals => "periodicals_test" }
+
+          Newspaper.table_name.should == "periodicals_test.newspaperos"
+        end
+
+        it "applies name overrides that come after the model is loaded when using the inferred table name" do
+          class Newspaper < ActiveRecord::Base
+            set_schema :periodicals
+          end
+
+          ActiveRecord::Base.schemas = { :periodicals => "periodicals_test" }
+
+          Newspaper.table_name.should == "periodicals_test.newspapers"
+        end
+      end
+    end
+  end
+
+  # TODO: bad, bad, bad copying
+  describe "sequences" do
+    describe "with no schema name" do
+      it "uses the inferred sequence name" do
+        class Book < ActiveRecord::Base
+        end
+
+        Book.sequence_name.should == 'default_sequence_name'
+      end
+
+      it "uses just the explicit sequencename" do
+        class Novel < ActiveRecord::Base
+          set_sequence_name "books"
+        end
+
+        Novel.sequence_name.should == 'books'
+      end
+
+      it "gives nil if the adapter doesn't specify a default sequence name" do
+        conn = mock(ActiveRecord::ConnectionAdapters::AbstractAdapter)
+        conn.stub!(:default_sequence_name).and_return(nil)
+        ActiveRecord::Base.connection_handler.stub!(:retrieve_connection).and_return(conn)
+
+        class Book < ActiveRecord::Base
+        end
+
+        Book.sequence_name.should be_nil
+      end
+    end
+
+    describe "with schema name" do
+      it "uses the inferred sequence name" do
+        class Magazine < ActiveRecord::Base
+          set_schema :reading_material
+        end
+
+        Magazine.sequence_name.should == 'reading_material.default_sequence_name'
+      end
+
+      it "gives nil if the adapter doesn't specify a default sequence name" do
+        conn = mock(ActiveRecord::ConnectionAdapters::AbstractAdapter)
+        conn.stub!(:default_sequence_name).and_return(nil)
+        ActiveRecord::Base.connection_handler.stub!(:retrieve_connection).and_return(conn)
+
+        class Book < ActiveRecord::Base
+          set_schema :reading_material
+        end
+
+        Book.sequence_name.should be_nil
+      end
+
+      describe "with CPK" do
+        it "doesn't fail when setting the schema" do
+          class Newspaper < ActiveRecord::Base
+            set_primary_keys "address", "telephone"
+            set_schema :reading_material
+          end
+        end
+      end
+
+      it "uses the explicit sequence name, if first" do
+        class Magazine < ActiveRecord::Base
+          set_sequence_name "some_magazines_seq"
+          set_schema :reading_material
+        end
+
+        Magazine.sequence_name.should == "reading_material.some_magazines_seq"
+      end
+
+      it "uses the explicit sequence name, if second" do
+        class Magazine < ActiveRecord::Base
+          set_schema :reading_material
+          set_sequence_name "some_magazines_seq"
+        end
+
+        Magazine.sequence_name.should == "reading_material.some_magazines_seq"
+      end
+
+      it "preserves the schema name if the sequence name is set several times" do
+        class Magazine < ActiveRecord::Base
+          set_schema :reading_material
+          set_sequence_name "some_magazines_seq"
+
+          set_sequence_name "other_magazines_seq"
+        end
+
+        Magazine.sequence_name.should == "reading_material.other_magazines_seq"
+      end
+
+      it "uses the last schema if set several times" do
+        class Magazine < ActiveRecord::Base
+          set_schema :reading_material
+          set_sequence_name "some_magazines_seq"
+          set_schema :periodicals
+        end
+
+        Magazine.sequence_name.should == "periodicals.some_magazines_seq"
+      end
+
+      it "works if set_schema is called without a connection" do
+        ActiveRecord::Base.connection_handler.should_receive(:retrieve_connection).
+          and_raise(ActiveRecord::ConnectionNotEstablished)
+        lambda {
+          class Magazine < ActiveRecord::Base
+            set_schema :periodicals
+            set_sequence_name 'mag_seq'
+          end
+        }.should_not raise_error
+
+        Magazine.sequence_name.should == "periodicals.mag_seq"
+      end
+
+      describe "with name overrides" do
+        before do
+          ActiveRecord::Base.schemas = {
+            :reading_material => 'reading_material_test'
+          }
+        end
+
+        after do
+          ActiveRecord::Base.schemas.clear
+        end
+
+        it "uses the inferred sequence name" do
+          class Pamphlet < ActiveRecord::Base
+            set_schema :reading_material
+          end
+
+          Pamphlet.sequence_name.should == 'reading_material_test.default_sequence_name'
+        end
+
+        it "uses the explicit sequence name, if first" do
+          class Pamphlet < ActiveRecord::Base
+            set_sequence_name "some_pamphlets"
+            set_schema :reading_material
+          end
+
+          Pamphlet.sequence_name.should == "reading_material_test.some_pamphlets"
+        end
+
+        it "uses the explicit sequence name, if second" do
+          class Pamphlet < ActiveRecord::Base
+            set_schema :reading_material
+            set_sequence_name "some_pamphlets"
+          end
+
+          Pamphlet.sequence_name.should == "reading_material_test.some_pamphlets"
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'spec'
+require 'spec/autorun'
+require 'rubygems'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: schema_qualified_tables
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Rhett Sutphin
+- Peter Nyberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-07 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.2"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.3"
+    version: 
+description: An ActiveRecord mix-in that makes it easier to use AR in an application which contains models which map to tables in different schemas.
+email: rhett@detailedbalance.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- CHANGELOG.markdown
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION.yml
+- lib/bcdatabase/active_record/schema_qualified_tables.rb
+- spec/bcdatabase/active_record/schema_qualified_tables_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/rsutphin/schema_qualified_tables
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Logical schema names for ActiveRecord models
+test_files: 
+- spec/bcdatabase/active_record/schema_qualified_tables_spec.rb
+- spec/spec_helper.rb