[3.4 Upgrade Script] Writing migrations for v3.4

Developers should be able to use migrations to move their bcms 3.3/earlier sites to v3.4. Add migrations for v3.4. * Correct database to add namespacing to models/types that have class names in the database. * Fixed issue where projects with no cms table namespacing couldn't create portlets. * Define migration for upgrading to v3.4.0 * Changed naming convention of migration upgrades since Rails 3.1.x automatically compresses files names like browsercms_3_4_0 into browsercms340 (uses camelize) when it copies. * Use cms:install:migrations instead of copying using a generator * Update tests for generators

Author: peakpg

.gitignore

@@ -21,3 +21,4 @@ doc/api
 .yardoc/*
 .rvmrc
 .bundle/*
+test/dummy/db/backups/*

Gemfile

@@ -4,11 +4,7 @@ source 'http://rubygems.org'
 gemspec
 
 gem 'jquery-rails'
-gem 'rack', '1.3.3' # At least until 1.3.5 is out. Avoids warnings about already defined constants.
 gem "mysql2"
-
-
-
 gem 'yard', :groups=>[:development, :test]
 gem 'bluecloth', :groups=>[:development, :test] # For YARD
 

Gemfile.lock

@@ -9,38 +9,36 @@ PATH
 GEM
  remote: http://rubygems.org/
  specs:
- actionmailer (3.1.0)
- actionpack (= 3.1.0)
+ actionmailer (3.1.3)
+ actionpack (= 3.1.3)
  mail (~> 2.3.0)
- actionpack (3.1.0)
- activemodel (= 3.1.0)
- activesupport (= 3.1.0)
+ actionpack (3.1.3)
+ activemodel (= 3.1.3)
+ activesupport (= 3.1.3)
  builder (~> 3.0.0)
  erubis (~> 2.7.0)
  i18n (~> 0.6)
- rack (~> 1.3.2)
- rack-cache (~> 1.0.3)
+ rack (~> 1.3.5)
+ rack-cache (~> 1.1)
  rack-mount (~> 0.8.2)
  rack-test (~> 0.6.1)
- sprockets (~> 2.0.0)
- activemodel (3.1.0)
- activesupport (= 3.1.0)
- bcrypt-ruby (~> 3.0.0)
+ sprockets (~> 2.0.3)
+ activemodel (3.1.3)
+ activesupport (= 3.1.3)
  builder (~> 3.0.0)
  i18n (~> 0.6)
- activerecord (3.1.0)
- activemodel (= 3.1.0)
- activesupport (= 3.1.0)
+ activerecord (3.1.3)
+ activemodel (= 3.1.3)
+ activesupport (= 3.1.3)
  arel (~> 2.2.1)
  tzinfo (~> 0.3.29)
- activeresource (3.1.0)
- activemodel (= 3.1.0)
- activesupport (= 3.1.0)
- activesupport (3.1.0)
+ activeresource (3.1.3)
+ activemodel (= 3.1.3)
+ activesupport (= 3.1.3)
+ activesupport (3.1.3)
  multi_json (~> 1.0)
  addressable (2.2.6)
  arel (2.2.1)
- bcrypt-ruby (3.0.1)
  bluecloth (2.1.0)
  builder (3.0.0)
  capybara (1.1.1)
@@ -77,55 +75,56 @@ GEM
  jquery-rails (1.0.14)
  railties (~> 3.0)
  thor (~> 0.14)
- json (1.6.1)
+ json (1.6.3)
  json_pure (1.6.1)
  launchy (2.0.5)
  addressable (~> 2.2.6)
  mail (2.3.0)
  i18n (>= 0.4.0)
  mime-types (~> 1.16)
  treetop (~> 1.4.8)
- mime-types (1.16)
+ mime-types (1.17.2)
  mocha (0.9.8)
  rake
- multi_json (1.0.3)
+ multi_json (1.0.4)
  mysql2 (0.3.10)
  nokogiri (1.5.0)
- polyglot (0.3.2)
- rack (1.3.3)
- rack-cache (1.0.3)
+ polyglot (0.3.3)
+ rack (1.3.5)
+ rack-cache (1.1)
  rack (>= 0.4)
  rack-mount (0.8.3)
  rack (>= 1.0.0)
  rack-ssl (1.3.2)
  rack
  rack-test (0.6.1)
  rack (>= 1.0)
- rails (3.1.0)
- actionmailer (= 3.1.0)
- actionpack (= 3.1.0)
- activerecord (= 3.1.0)
- activeresource (= 3.1.0)
- activesupport (= 3.1.0)
+ rails (3.1.3)
+ actionmailer (= 3.1.3)
+ actionpack (= 3.1.3)
+ activerecord (= 3.1.3)
+ activeresource (= 3.1.3)
+ activesupport (= 3.1.3)
  bundler (~> 1.0)
- railties (= 3.1.0)
- railties (3.1.0)
- actionpack (= 3.1.0)
- activesupport (= 3.1.0)
+ railties (= 3.1.3)
+ railties (3.1.3)
+ actionpack (= 3.1.3)
+ activesupport (= 3.1.3)
  rack-ssl (~> 1.3.2)
  rake (>= 0.8.7)
  rdoc (~> 3.4)
  thor (~> 0.14.6)
- rake (0.9.2)
- rdoc (3.9.4)
+ rake (0.9.2.2)
+ rdoc (3.11)
+ json (~> 1.4)
  ruby-prof (0.10.8)
  rubyzip (0.9.4)
  selenium-webdriver (2.8.0)
  childprocess (>= 0.2.1)
  ffi (>= 1.0.7)
  json_pure
  rubyzip
- sprockets (2.0.0)
+ sprockets (2.0.3)
  hike (~> 1.2)
  rack (~> 1.0)
  tilt (~> 1.1, != 1.3.0)
@@ -139,7 +138,7 @@ GEM
  treetop (1.4.10)
  polyglot
  polyglot (>= 0.3.1)
- tzinfo (0.3.29)
+ tzinfo (0.3.31)
  xpath (0.1.4)
  nokogiri (~> 1.3)
  yard (0.7.2)
@@ -159,7 +158,6 @@ DEPENDENCIES
  launchy
  mocha (= 0.9.8)
  mysql2
- rack (= 1.3.3)
  ruby-prof
  sqlite3-ruby
  test-unit (= 2.1.1)

Rakefile

@@ -67,6 +67,13 @@ task :test => 'app:test:prepare' do
  end
 end
 
-#task :test => ['test:units', 'test:functionals', 'test:integration', 'features']
-
 task :default => :test
+
+# Sample tasks to load sample data. This is unworking pseudocode at the moment.
+#task 'db:load' do
+ # `mysql --user=root --password name_of_database < test/dummy/db/backups/name_of_file.sql`
+#end
+
+#task 'db:dump' do
+ # `mysqldump --user=name_of_user --password --database name_of_database > name_of_file.sql`
+#end

app/models/cms/portlet.rb

@@ -18,9 +18,10 @@ def self.inherited(subclass)
  ensure
  subclass.class_eval do
 
+ # Using the table prefix here is NOT tested, since unloading classes is hard during tests.
  has_dynamic_attributes :class_name => "CmsPortletAttribute",
  :foreign_key => "portlet_id",
- :table_name => Cms::Portlet.table_name,
+ :table_name => Namespacing.prefix("portlet_attributes"),
  :relationship_name => :portlet_attributes
 
  acts_as_content_block(

bin/bcms

@@ -166,6 +166,7 @@ SITE_DOMAIN="localhost:3000"
  run_bundle_install(name)
  generate :jdbc if defined?(JRUBY_VERSION)
  route "mount_browsercms"
+ rake 'cms:install:migrations'
  generate "browser_cms:cms"
  add_sitedomain_constant_to_environment_files
  configure_default_cache_directory

db/migrate/20111130221145_browsercms340.rb

@@ -0,0 +1,52 @@
+# Upgrade to Browsercms v3.4.0
+class Browsercms340 < ActiveRecord::Migration
+
+ def change
+ # Prefix the correct namespace where class_names are not prefixed
+ %w[HtmlBlock Category CategoryType Portlet FileBlock ImageBlock Tag].each do |content_type|
+ update_content_types(content_type)
+ update_connectors_table(content_type)
+ end
+
+ update_sitemap
+ update_files
+
+ end
+
+
+ private
+
+ def prefix(name)
+ "Cms::#{name}"
+ end
+
+ def update_files
+ %w[FileBlock ImageBlock].each do |content_type|
+ Cms::AbstractFileBlock.update_all("type = '#{prefix(content_type)}'", "type = '#{content_type}'")
+ end
+ end
+
+ def update_sitemap
+ %w[Section Page Link Attachment].each do |addressable|
+ Cms::SectionNode.where(:node_type=>addressable).each do |node|
+ node.node_type = prefix(addressable)
+ node.save!
+ end
+ end
+ end
+
+ def update_content_types(name)
+ found = Cms::ContentType.named(name).first
+ if found
+ found.name = prefix(name)
+ found.save!
+ end
+ end
+
+ def update_connectors_table(name)
+ Cms::Connector.where(:connectable_type => name).each do |connector|
+ connector.connectable_type = prefix(name)
+ connector.save!
+ end
+ end
+end

doc/upgrading_notes.txt

@@ -1,3 +1,7 @@
+# Upgrading to bcms 3.4
+
+* Ensure there is no table prefix set (i.e. tables will in versions prior to 3.4 were not prefixed with cms_
+
 New Project using 3.3
 ===============
 gem install browsercms

lib/cms/behaviors/dynamic_attributes.rb

@@ -127,7 +127,7 @@ def has_dynamic_attributes(options={})
  @has_dynamic_attributes = true
  include InstanceMethods
 
-  # Provide default options
+ # Provide default options
  options[:class_name] ||= self.model_name + 'Attribute'
  options[:table_name] ||= options[:class_name].tableize
  options[:relationship_name] ||= options[:class_name].tableize.to_sym
@@ -150,6 +150,7 @@ def has_dynamic_attributes(options={})
  rescue
  Object.const_set(options[:class_name],
  Class.new(ActiveRecord::Base)).class_eval do
+ set_table_name options[:table_name]
  def self.reloadable? #:nodoc:
  false
  end
@@ -171,7 +172,6 @@ def self.reloadable? #:nodoc:
  class_eval do
  has_many options[:relationship_name],
  :class_name => options[:class_name],
- :table_name => options[:table_name],
  :foreign_key => options[:foreign_key],
  :dependent => :destroy
 
@@ -180,9 +180,8 @@ def self.reloadable? #:nodoc:
 
  # Carry out delayed actions before save
  after_validation :save_modified_dynamic_attributes
-# after_validation_on_update :save_modified_dynamic_attributes
 
-# Make attributes seem real
+ # Make attributes seem real
  alias_method :method_missing_without_dynamic_attributes, :method_missing
  alias_method :method_missing, :method_missing_with_dynamic_attributes
 

lib/generators/browser_cms/cms/cms_generator.rb

@@ -5,14 +5,10 @@ module Generators
  # For creating a new BrowserCMS project (Used in conjunction with the blank, demo and module templates.
  class CmsGenerator < Base
 
- def copy_migrations_and_custom_js_files
+ def copy_seed_files
 
  files_to_copy = [
- # Migrations/seed data
- 'db/migrate/20080815014337_browsercms_3_0_0.rb',
- 'db/migrate/20091109175123_browsercms_3_0_5.rb',
- 'db/migrate/20100705083859_browsercms_3_3_0.rb',
- 'db/browsercms.seeds.rb'
+ 'db/browsercms.seeds.rb'
  ]
 
  files_to_copy.each do |file|