updateable_views_inheritance 1.1.1 → 1.1.2

data/.gitignore

@@ -1,3 +1,7 @@
-test/*.log
+Gemfile.lock
+.bundle/
+html/*
 pkg/*
-html/*
+test/dummy/log/*.log
+test/dummy/tmp/
+test/dummy/.sass-cache

data/CHANGELOG.md

@@ -0,0 +1,28 @@
+## 1.1.2 (14 June 2013)
+
+Bugfixes:
+
+  - fixed generating migration on installation
+  
+Documentation:
+
+  - README brought up to date
+
+## 1.1.1 (14 June 2013)
+
+Features:
+
+  - gemified and released on rubygems.org
+
+## 1.1.0 (13 June 2013)
+
+Features:
+
+  - updated for rails 3.2.x
+
+## 1.0.0 (14 September 2009)
+
+Features:
+  
+  - class_table_inheritance plugin has behaved stably in production for a year
+  - supports rails 2.1, 2.2 and 2.3

data/README.rdoc

@@ -3,7 +3,7 @@
 Class Table Inheritance for ActiveRecord using updateable views.
 
 More about the pattern on http://www.martinfowler.com/eaaCatalog/classTableInheritance.html. This gem messes very little with Rails inheritance mechanism. 
-Instead it relies on updatable views in the database to represent classes in the inheritance chain. The approach was first {suggested by John 
+Instead it relies on updatable views in the database to represent classes in the inheritance chain. The approach was {first suggested by John 
 Wilger}[http://web.archive.org/web/20060408145717/johnwilger.com/articles/2005/09/29/class-table-inheritance-in-rails-with-postgresql].
 
 
@@ -16,21 +16,26 @@ Ruby: tested with 1.8.7 and 1.9.3
 Database: PostgreSQL 8.1+ only. Patches for other DBMS are welcome. Note that you are not required to use updateable views, children relations can be tables (with some triggers involved) or materialized views.
 
 ==Install
-
+Run
   gem install updateable_views_inheritance
 
 ==Usage
 
 ===Setup
 
-In Gemfile
+* In <tt>Gemfile</tt> add <tt>gem 'updateable_views_inheritance'</tt>
+* Run <tt>rails generate updateable_views_inheritance:install && rake db:migrate</tt>
+* In <tt>config/database.yml</tt> аdd to every environment
+
+    prepared_statements: false
+
+ActiveRecord's postgresql adapter has subtle problems with prepared statements that cause strange errors every now and then.
+* In <tt>config/environment.rb</tt> set <tt>config.active_record.schema_format = :sql</tt>
+* In case you're using fixtures, don't forget to run
 
-  gem 'updateable_views_inheritance'
+    rake updateable_views_inheritance:fixture
 
-Keep in mind that only PostgreSQL is currently supported.
-1. <tt>rake updateable_views_inheritance:setup</tt> to create a migration.
-1. <tt>rake db:migrate</tt>.
-1. In <tt>config/environment.rb</tt> set <tt>config.active_record.schema_format = :sql</tt>. Database views and rules are not supported in default schema.rb.
+after every change to the class hierarchy. Otherwise tests may fail.
 
 ===Example
 
@@ -98,13 +103,14 @@ Note that you should remove only leaf classes (i.e. those that do not have desce
 
 ==Compatibility with Single Table Inheritance
 
-The approach of this gem is completely independent from Rails single table inheritance. STI and CLTI can safely be mixed in one inheritance chain.
+The approach of this gem is completely independent from Rails built-in Single Table Inheritance. STI and CLTI can safely be mixed in one inheritance chain.
 
 ==Testing Your App
 
-Run <tt>rake updateable_views_inheritance:fixture</tt> to generate fixture for the updateable_views_inheritance table. <b>Without it primary key sequence for 
-inheritors' tables won't be bumped to the max and it might not be possible to save objects!</b>
+If you use fixtures, you must run <tt>rake updateable_views_inheritance:fixture</tt> to generate fixture for the updateable_views_inheritance table after you add/remove
+classes from the hierarchy or change underlying table or view names. <b>Without it primary key sequence for inheritors' tables won't be bumped to the max and it might not be possible to save objects!</b> If you don't use fixtures for the classes in the hierarchy you don't need to do that.
 
-This gem re-enables referential integrity on fixture loading, so if you are using foreign keys you will have to explicitly declare fixture load order in test_helper.rb like this:
+This gem re-enables referential integrity on fixture loading, so if you are using foreign keys you will have to explicitly declare fixture load order in test_helper.rb, for
+example:
 
   fixtures(:roots, :trunks, :leafs, ...)

data/Rakefile

@@ -9,6 +9,8 @@ Rake::TestTask.new(:test => 'test:rebuild_database') do |t|
   t.verbose = true
 end
 
+task :default => :test
+
 desc 'Generate documentation'
 Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'html'

data/lib/generators/updateable_views_inheritance/install_generator.rb

@@ -0,0 +1,20 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+require 'rails/generators/active_record'
+
+module UpdateableViewsInheritance
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      extend ActiveRecord::Generators::Migration
+      
+      desc "Creates a migration that creates a special table used by the updateable_views_inheritance gem."
+      source_root File.expand_path('../templates', __FILE__)
+      
+      def create_migration
+        migration_file = "create_updateable_views_inheritance.rb"
+        migration_template migration_file, "db/migrate/#{migration_file}"
+      end
+    end
+  end
+end

data/lib/generators/{updateable_views_inheritance_migration/templates/migration.rb → updateable_views_inheritance/templates/create_updateable_views_inheritance.rb}

@@ -1,5 +1,5 @@
-class <%= class_name %> < ActiveRecord::Migration
-  def self.up
+class CreateUpdateableViewsInheritance < ActiveRecord::Migration
+  def up
     create_table(:updateable_views_inheritance, :id => false) do |t|
       t.column :parent_relation, :string, :null => false
       t.column :child_aggregate_view, :string, :null => false
@@ -11,7 +11,7 @@ class <%= class_name %> < ActiveRecord::Migration
     execute "ALTER TABLE updateable_views_inheritance ADD UNIQUE (parent_relation, child_aggregate_view)"
   end
 
-  def self.down
+  def down
     drop_table :updateable_views_inheritance
   end
 end

data/lib/updateable_views_inheritance/version.rb

@@ -1,3 +1,3 @@
-module Uvi
-  VERSION = "1.1.1"
+module UpdateableViewsInheritance
+  VERSION = "1.1.2"
 end

data/tasks/updateable_views_inheritance_tasks.rake

@@ -8,12 +8,4 @@ namespace :updateable_views_inheritance do
                  }.to_yaml)
     f.close
   end
-  
-  desc 'Generate migration to create special table for the updateable_views_inheritance gem'
-  task :setup => :environment do
-    raise "Task unavailable to this database (no migration support)" unless ActiveRecord::Base.connection.supports_migrations?
-    require 'rails_generator'
-    require 'rails_generator/scripts/generate'
-    Rails::Generator::Scripts::Generate.new.run(["updateable_views_inheritance_migration", ENV["MIGRATION"] || "AddUpdatebleViewsInheritance"])
-  end
 end

data/test/content_test.rb

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
-class ClassTableInheritanceContentTest < ActiveSupport::TestCase
+class UpdateableViewsInheritanceContentTest < ActiveSupport::TestCase
   def setup
     ActiveRecord::Migrator.up(File.dirname(__FILE__) + '/fixtures/migrations/', 5)
     # order of fixtures is important for the test - last loaded should not be with max(id)

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/bicycle.rb

@@ -0,0 +1,3 @@
+class Bicycle < WheeledVehicle
+  self.table_name =  'bicycles'
+end

data/test/dummy/app/models/boat.rb

@@ -0,0 +1,3 @@
+class Boat < Vehicle
+  self.table_name =  'boats'
+end

data/test/dummy/app/models/car.rb

@@ -0,0 +1,3 @@
+class Car < WheeledVehicle
+  self.table_name =  'cars'
+end

data/test/dummy/app/models/electric_locomotive.rb

@@ -0,0 +1,3 @@
+class ElectricLocomotive < Locomotive
+  self.table_name =  'electric_locomotives'
+end

data/test/dummy/app/models/electric_train.rb

@@ -0,0 +1,3 @@
+class ElectricTrain < Train
+  self.table_name =  'electric_trains'
+end

data/test/{app → dummy/app}/models/locomotive.rb

@@ -1,3 +1,3 @@
 class Locomotive < ActiveRecord::Base
-
+  abstract_class = true
 end

data/test/{app → dummy/app}/models/maglev_locomotive.rb

@@ -1,3 +1,3 @@
 class MaglevLocomotive < ElectricLocomotive
-
+  self.table_name =  'maglev_locomotives'
 end

data/test/dummy/app/models/maglev_train.rb

@@ -0,0 +1,3 @@
+class MaglevTrain < ElectricTrain
+  self.table_name =  'maglev_trains'
+end

data/test/dummy/app/models/rack_locomotive.rb

@@ -0,0 +1,3 @@
+class RackLocomotive < Locomotive
+  self.table_name =  'rack_locomotives'
+end

data/test/dummy/app/models/rack_train.rb

@@ -0,0 +1,3 @@
+class RackTrain < Train
+  self.table_name =  'rack_trains'
+end

data/test/dummy/app/models/railed_vehicle.rb

@@ -0,0 +1,3 @@
+class RailedVehicle < Vehicle
+  self.table_name =  'railed_vehicles'
+end

data/test/dummy/app/models/steam_locomotive.rb

@@ -0,0 +1,3 @@
+class SteamLocomotive < Locomotive
+  self.table_name =  'steam_locomotives'
+end

data/test/dummy/app/models/steam_train.rb

@@ -0,0 +1,3 @@
+class SteamTrain < Train
+  self.table_name =  'steam_trains'
+end

data/test/dummy/app/models/train.rb

@@ -0,0 +1,3 @@
+class Train < RailedVehicle
+  self.table_name =  'trains'
+end

data/test/{app → dummy/app}/models/vehicle.rb

@@ -1,3 +1,4 @@
 class Vehicle < ActiveRecord::Base
+  abstract_class = true
   self.inheritance_column = :vehicle_type
 end

data/test/dummy/app/models/wheeled_vehicle.rb

@@ -0,0 +1,3 @@
+class WheeledVehicle < Vehicle
+  self.table_name =  'wheeled_vehicles'
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    "application", :media => "all" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,59 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "updateable_views_inheritance"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+
+    # Enable escaping HTML in JSON.
+    config.active_support.escape_html_entities_in_json = true
+
+    # Use SQL instead of Active Record's schema dumper when creating the database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Enforce whitelist mode for mass assignment.
+    # This will create an empty whitelist of attributes available for mass-assignment for all models
+    # in your app. As such, your models will need to explicitly whitelist or blacklist accessible
+    # parameters by using an attr_accessible or attr_protected declaration.
+    config.active_record.whitelist_attributes = false
+
+    # Enable the asset pipeline
+    config.assets.enabled = true
+
+    # Version of your assets, change this if you want to expire all your assets
+    config.assets.version = '1.0'
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/{database.yml → dummy/config/database.yml}

@@ -1,4 +1,4 @@
-postgresql:
+test:
   adapter: postgresql
   username: postgres
   password: postgres

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/dummy/config/environments/development.rb

@@ -0,0 +1,37 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+
+  # Raise exception on mass assignment protection for Active Record models
+  config.active_record.mass_assignment_sanitizer = :strict
+
+  # Log the query plan for queries taking more than this (works
+  # with SQLite, MySQL, and PostgreSQL)
+  config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+  # Do not compress assets
+  config.assets.compress = false
+
+  # Expands the lines which load the assets
+  config.assets.debug = true
+end