browsercms 3.4.0.rc2 → 3.4.0

data/bin/bcms-upgrade

@@ -6,6 +6,7 @@ require 'term/ansicolor'
 require 'rails/generators/actions'
 require 'active_support/core_ext/string/inflections'
 require 'cms/commands/actions'
+require 'cms/version'
 
 class String
   include Term::ANSIColor
@@ -16,9 +17,7 @@ class App < Thor
   include Rails::Generators::Actions
   include Cms::Commands::Actions
 
-
   desc "check", "Checks the existing module to determine what needs to done."
-
   def check
     puts "The following issues are preventing a BrowserCMS/Rails 3 upgrade.\n".red.bold
 
@@ -52,9 +51,9 @@ TEXT
     puts instructions
   end
 
-  desc 'v3_3_0', "Upgrades BrowserCMS files from 3.1.x to 3.3.0 (Back up first)"
+  desc 'v3_3_x', "Upgrades BrowserCMS files from 3.1.x to 3.3.x (Back up first)"
 
-  def v3_3_0
+  def v3_3_x
     upgrade_to_3_3_0
   end
 

data/browsercms.gemspec

@@ -2,33 +2,34 @@ require File.dirname(__FILE__) + "/lib/cms/version.rb"
 
 Gem::Specification.new do |s|
   s.platform = Gem::Platform::RUBY
-  s.name = %q{browsercms}
+  s.name = "browsercms"
   s.version = Cms::VERSION
 
   s.authors = ["BrowserMedia"]
   s.summary = %q{BrowserCMS is a a general purpose, open source Web Content Management System (CMS), written using Ruby on Rails.}
   s.description = %q{Web Content Management in Rails.}
   s.email = %q{github@browsermedia.com}
-  s.extra_rdoc_files = [
-      "LICENSE.txt",
-      "README.markdown"
-  ]
+  s.extra_rdoc_files = %w{
+      LICENSE.txt
+      README.markdown
+  }
   s.required_ruby_version = '>= 1.9.2'
 
   s.files         = `git ls-files`.split("\n")
-  s.files         -= Dir['test/dummy/*']
+  s.files         -= Dir["test/dummy/*"]
   s.files -= Dir["lib/tasks/cucumber.rake"]
   s.files -= Dir["lib/tasks/cms.rake"]
   s.files -= Dir["lib/tasks/core_tasks.rake"]
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
 
-  s.add_dependency('rails', "~> 3.1.0 ")
+  s.add_dependency "rails", "~> 3.1.0 "
   s.add_dependency "ancestry", "~> 1.2.4"
+  s.add_dependency "ckeditor_rails", "~> 3.6.2.2"
+  s.add_dependency "jquery-rails", "~> 1.0.14"
 
   # Required only for bcms-upgrade
-  s.add_dependency('term-ansicolor')
-  s.add_dependency("jquery-rails", "~> 1.0.14")
+  s.add_dependency "term-ansicolor"
 
 end
 

data/db/migrate/20111130221145_browsercms340.rb

@@ -1,5 +1,7 @@
 # Upgrade to Browsercms v3.4.0
+require 'cms/upgrades/v3_4_0'
 class Browsercms340 < ActiveRecord::Migration
+  include Cms::Upgrades::V3_4_0::SchemaStatements
 
   def change
     # Prefix the correct namespace where class_names are not prefixed
@@ -51,9 +53,9 @@ class Browsercms340 < ActiveRecord::Migration
   end
 
   def standardize_foreign_keys_from_versions_tables_to_original_table
-    tables = %w[attachment dynamic_view file_block html_block link page ]
-    tables.each do |table|
-      rename_column(prefix("#{table}_versions"), "#{table}_id", :original_record_id) if column_exists?(prefix("#{table}_versions"), "#{table}_id")
+    models = %w[attachment dynamic_view file_block html_block link page ]
+    models.each do |model|
+      standardize_version_id_column(model)
     end
   end
 end

data/doc/release_notes.md

@@ -1,39 +1,47 @@
-v3.4.0.rc1
+v3.4.0
 ======
 
-The first release candidate of BrowserCMS 3.4.0 brings two major additions:
-1. Rails 3.1.x compatibility
+It's done! After roughly a years worth of work, along with some excellent contributions from the community (thanks Brian King, James Prior and Neil Middleton), BrowserCMS 3.4 is done. This release contains two major additions:
+
+1. It's now Rails 3.1.x compatible
 2. Mountable App: BrowserCMS can be now be added to existing Rails applications.
 
-Note: We also recommend using Ruby 1.9.3 with this release (though Ruby 1.9.2 will probably still work)
+Note: We recommend using Ruby 1.9.3 with this release (though Ruby 1.9.2 will probably still work)
+
+Improved Updating
+-----------------
+
+A primary goal of this project is have a simple upgrade path for existing projects. As such, we have baked in the support for upgrading your project right into the core tool itself. See the [Upgrade Guide](https://github.com/browsermedia/browsercms/wiki/Upgrading-a-BrowserCMS-project) for more details, but upgrading a CMS project is now (nearly) as simple as running the following command in your project:
+
+    $ bcms upgrade
+
+
+CMSifying your Rails project
+----------------------------
 
-Rails 3.1.x and Mountable Apps
-------------------------------
+The entire project was reworked to become a Mountable Engine, meaning it should easier to add to an existing Rails project via running the following command in your Rails project. You can now add BrowserCMS to your Rails 3.1.x project by running:
 
-BrowserCMS has been rewritten as a Mountable App, bringing all the power of engines from Rails 3.1. This mean it should easier to add to an existing Rails project via running the following command in your Rails project.
+    $ bcms install
 
-$ bcms install
+Integrating with the CMS
+------------------------
+
+Once the CMS is installed, you can integrate with the existing templates, users, groups and pages. See [Adding BrowserCMS to an existing Rails project](https://github.com/browsermedia/browsercms/wiki/Adding-BrowserCMS-to-an-existing-Rails-project) for details on how you can integrate them. While User authentication/authorization is definitely something that needs more refinement, this release adds some support for modifying your existing User objects to behave as though they were a CMS User (and get access to CMS pages, etc).
+
+Namespacing/Prefixing
+---------------------
 
-Some notable changes:
-* Add bcms install method that will add browsercms to an existing Rails project.
 * Most core files in the CMS are namespaced under Cms:: . This should reduce the chance of conflicting classes (i.e. what was User is now Cms::User)
 * Table names can optionally be namespaced. By default, there is no namespace for standalone BrowserCMS projects. You can set: Cms.table_prefix = "cms_" to change this.
 * Prefixing tables will be reflected in cms migrations (like create_content_table) automatically. Passing :prefix=>false will add no prefix.
-* For creating tables (using create_table), you can use prefix() to apply the current prefix. i.e.
+* When defining migrations for cms tables, (using create_table), you can use prefix() to apply the current prefix. i.e.
 
     create_table prefix(:users)
 
-* Added some basic support for making other 'user' objects act like CMS users via Cms::Acts::User.
-For example, the following would make a custom non-CMS user gain permission to act like an admin.
-
-class MyCustomUser < ActiveRecord::Base
-  acts_as_cms_user :groups => [Cms::Group.find_by_code('admin')]
-end
-
-User authentication/authorization is definately something that needs more refinement, especially with regard to how Engines and Applications interact.
-
-Other Fixes
------------
+Other Notable Fixes
+-------------------
+* [#301] New `bcms upgrade` script for updating BrowserCMS projects.
+* [#433] Starting new projects should work regardless of whether later versions of Rails are installed (i.e. Rails 3.2).
 * [#3] Asset Pipeline: All bcms assets are now served using the assets pipeline.
 * [#443] Removed two primitive javascript and stylesheets in favor of asset pipeline (where needed).
 * [#448] Mountable Engines - BrowserCMS is now a mountable engine, which should make integrating it with other projects easier.
@@ -41,6 +49,9 @@ Other Fixes
 * [#480] Standardized Version Column - Changed how version tables point back to their 'original' record to make working with namespaces easier. Module developers will need to update their migrations for the next release of their modules.
 * [#466] Generate blocks with attachments correctly - When generating blocks that have an attachment, the initially generated code should work correctly without addition customization or tweaking.
 * [#450] Generate Engines - BrowserCMS modules are created as Mountable Engines when running `bcms module`.
+* [#487] CKEditor Gem - Replace the built in CKeditor gem with the Asset pipeline aware ckeditor_rails gem.
+
+See the [detailed changelog](https://github.com/browsermedia/browsercms/compare/v3.3.3...v3.4.0) for a complete list of changes, as well as the [Closed Tickets for 3.4.0](https://github.com/browsermedia/browsercms/issues?milestone=1&state=closed) for a complete list of closed items.
 
 v3.3.3
 ======

data/features/acts_as_content_page.feature

@@ -9,6 +9,19 @@ Feature: Acts as Content Page
     Given the cms database is populated
     And I am a guest
 
+  Scenario: Use CMS templates with Rails Controllers
+    When I visit /content-page
+    Then the response should be 200
+    And I should see a page titled "Content Page"
+    And I should see the following content:
+      | Dummy Site Template |
+
+  Scenario: Set a Page Title
+    When I visit /custom-page
+    Then I should see a page titled "My Custom Page"
+    And I should see the following content:
+    | Some Custom Content |
+
   Scenario: Content Page
     When I visit /tests/open
     Then the response should be 200
@@ -16,6 +29,7 @@ Feature: Acts as Content Page
       | Open Page                     |
       | You can see this public page. |
 
+
   Scenario: Error Page
     When I am at /tests/error
     Then the response should be 500

data/features/add_content_to_pages.feature

@@ -17,7 +17,6 @@ Feature: Add Content to Pages
     And I click the Select Existing Content button
     Then I should see the following content:
       | Hello World |
-#  I want to test selecting content, but that requires javascript drivers
 
   Scenario: Add Html/Text to a page
     Given there is a page with:
@@ -36,11 +35,11 @@ Feature: Add Content to Pages
     When I follow "Text"
     Then I should see a page titled "Content Library / Add New Text"
     And I should see the following content:
-    | Name |
-    | Text |
+      | Name |
+      | Text |
     When I fill in "Name" with "Hello"
     And I fill in "Content" with "I'm some new content"
     And I press "Save"
     Then I should see a page titled "Some Page"
     And I should see the following content:
-    | I'm some new content |
+      | I'm some new content |

data/features/commands/new_projects.feature

@@ -1,3 +1,4 @@
+@cli
 Feature: New Project Generator
   Developers should be able to create new projects from the command line.
 
@@ -7,17 +8,11 @@ Feature: New Project Generator
     When I run `bcms -v`
     Then the output should contain "BrowserCMS 3.4.0"
 
-  # `bcms new` does more than this, so could be more detailed.
   Scenario: Create a new BrowserCMS project
     When I create a new BrowserCMS project named "hello"
     Then a rails application named "hello" should exist
     And a file named "public/index.html" should not exist
-    And the output should contain "rake  cms:install:migrations"
-    And the output should contain "Copied migration"
-    And the output should contain "browsercms300.rb from cms"
-    And the output should contain "browsercms305.rb from cms"
-    And the output should contain "browsercms330.rb from cms"
-    And the output should contain "browsercms340.rb from cms"
+    And it should copy all the migrations into the project
     And the file "hello/config/routes.rb" should contain "mount_browsercms"
     And the file "hello/db/seeds.rb" should contain "require File.expand_path('../browsercms.seeds.rb', __FILE__)"
     And a file named "hello/db/browsercms.seeds.rb" should exist
@@ -25,6 +20,18 @@ Feature: New Project Generator
     And a file named "hello/app/views/layouts/templates/default.html.erb" should exist
     And the output should not contain "identical"
     And BrowserCMS should be added the Gemfile
+    And the correct version of Rails should be added to the Gemfile
+    And the production environment should be configured with reasonable defaults
+
+  Scenario: With a specific database
+    When I run `bcms new hello_world -d mysql`
+    Then the file "hello_world/Gemfile" should contain "mysql2"
+
+  Scenario: With an application template
+      The exact template is irrelevant, so long as bcms command passes it to rails.
+
+      When I run `bcms new hello_world -m sometemplate.rb`
+      Then the output should contain "sometemplate.rb] could not be loaded"
 
   Scenario: Creating a new CMS project without a  name
     When I run `bcms new`

data/features/commands/upgrade_project_to_3_4_0_from_3_3_x.feature

@@ -0,0 +1,52 @@
+@cli
+Feature:
+  Assuming there is BrowserCMS project that is currently running 3.3.x
+  the upgrade script should handle generating, and/or manipulating files to make upgrading simple
+
+  # Note: We skip running `rake rails:update` as part of these tests since it requires an interactive
+  # command as part a separate process to overwrite files, so its very hard to wait for the exact timing.
+
+  Background:
+    Given I am working on a BrowserCMS v3.3.x project named "petstore"
+
+  Scenario: Upgrade Project
+    When I run `bcms upgrade --skip-rails`
+    Then Gemfile should have the correct version of BrowserCMS
+    And it should comment out Rails in the Gemfile
+    And it should run bundle install
+    And it should copy all the migrations into the project
+    And it should add the seed data to the project
+    And it should display instructions to the user
+
+  Scenario: Projects with Content Block
+    Given the project has a "turtle" block
+    When I run `bcms upgrade --skip-rails`
+    Then I should have a migration for updating the "turtle" versions table
+
+  Scenario: Projects with Content Blocks and Models
+    Rails models (that aren't blocks) should not have a migration generated for them.
+
+    Given the project has a "turtle" block
+    And the project has a "category" model
+    When I run `bcms upgrade --skip-rails`
+    Then I should have a migration for updating the "turtle" versions table
+
+  Scenario: Updates version table
+    Given the project has a "turtle" block
+    When I run `bcms upgrade  --skip-rails`
+    When I run `rake db:migrate`
+    Then the migration should update the version table for "turtle" block
+
+  Scenario: Migrations work for new project
+    Given the project has a "turtle" block which hasn't ever been migrated
+    When I run `bcms upgrade  --skip-rails`
+    When I run `rake db:migrate`
+    Then the migration should not update the version table for "turtle" block
+
+
+
+
+
+
+
+

data/features/commands/upgrading_modules.feature

@@ -13,8 +13,9 @@ Feature: Upgrading BrowserCMS
     And the following files should exist:
       | config.ru |
 
-  Scenario: Avoid accidently updating projects
-    Given I am working on a BrowserCMS v3.3.x project named "petstore"
+  Scenario: Avoid accidentally updating projects
+    Given I cd to ".."
+    And I am working on a BrowserCMS v3.3.x project named "petstore"
     When I run `bcms-upgrade module`
     Then the output should contain "This does not appear to be a BrowserCMS module. Skipping update"
     And the following files should exist:

data/features/manage_tasks.feature

@@ -0,0 +1,25 @@
+Feature: Manage Tasks
+  Content Editors should be able to assign and complete tasks.
+
+  Background:
+    Given the cms database is populated
+    And I am logged in as a Content Editor
+
+  Scenario: Assign Home Page as a Task
+    When I assign the home page as a task
+    Then I should see a page titled "Assign Page 'Home'"
+    When I select "CMS Administrator (cmsadmin)" from "Assign To"
+    And I press "Save"
+    Then I should see a page titled "Home"
+    And I should not see the following content:
+      | error |
+    When I request /cms/dashboard
+    Then I should see the following content:
+      | Home |
+    And I should not see the following content:
+      | You currently have no assigned tasks. |
+   
+
+
+
+

data/features/manage_users.feature

@@ -0,0 +1,38 @@
+Feature: Manage Users
+  CMS Admins should be able to add/edit/disable users via the Admin UI.
+
+  Background:
+    Given the cms database is populated
+    And I am logged in as a Content Editor
+
+  Scenario: Add User
+    Given I request /cms/users
+    And I click on "ADD USER"
+    Then I should see a page titled "New User"
+    When fill valid fields for a new user named "testuser"
+    Then I should see a page titled "User Browser"
+    And I should see the following content:
+      | testuser |
+
+
+  Scenario: Change Password
+    Given the following content editor exists:
+      | username | password | first_name | last_name |
+      | testuser | abc123   | Mr         | Blank     |
+    When I request /cms/users
+    And I click on "Mr Blank"
+    And I click on "Change Password"
+    And I fill in "Password" with "different"
+    And I fill in "Confirm Password" with "different"
+    And I press "Save"
+    Then I should see a page titled "User Browser"
+    When I login as:
+      | login    | password  |
+      | testuser | different |
+    Then I should see a page titled "Home"
+
+
+
+
+
+

data/features/sitemap/manage_links.feature

@@ -0,0 +1,29 @@
+Feature: Manage Links
+  Content Editors should be able to create links on the sitemap in order to have menu items that go to URLs that are
+  served by CMS pages.
+
+  Background:
+    Given the cms database is populated
+    And I am logged in as a Content Editor
+
+  Scenario: Add Link
+    When I am adding a link on the sitemap
+    And I fill in "Name" with "A New Link"
+    And I fill in "Url" with "http://www.browsercms.com"
+    And I click on "Save"
+    Then I should see a page titled "Sitemap"
+    Then I should see the following content:
+      | A New Link |
+
+
+  Scenario: Update And Publish Link
+    Given the following link exists:
+      | name | url                | section |
+      | CMS  | www.browsercms.com | /       |
+    When I edit that link
+    And I change the link name to "A more well tested CMS"
+    Then I should see a page titled "Sitemap"
+    Then I should see the following content:
+      | A more well tested CMS |
+
+

data/features/step_definitions/command_line_steps.rb

@@ -9,11 +9,9 @@ end
 
 Given /^a rails application named "([^"]*)" exists$/ do |name|
   create_rails_project(name)
+  append_to_file "#{name}/db/seeds.rb", "# Some sample seed data here"
 end
 
-When /^BrowserCMS should be added the Gemfile$/ do
-  check_file_content("#{project_name}/Gemfile", 'gem "browsercms"', true)
-end
 When /^I create a new BrowserCMS project named "([^"]*)"$/ do |name|
   self.project_name = name
   cmd = "bcms new #{project_name} --skip-bundle"
@@ -38,6 +36,7 @@ Then /^BrowserCMS should be installed in the project$/ do
   # This is a not a really complete check but it at least verifies the generator completes.
   check_file_content('config/initializers/browsercms.rb', 'Cms.table_prefix = "cms_"', true)
   check_file_content('config/routes.rb', 'mount_browsercms', true)
+  verify_seed_data_requires_browsercms_seeds
 end
 
 Then /^a demo project named "([^"]*)" should be created$/ do |project|
@@ -106,10 +105,108 @@ Then /^it should seed the BrowserCMS database$/ do
 end
 
 When /^it should seed the demo data$/ do
-  assert_partial_output  "Cms::PagePartial(:_header)", all_output
+  assert_partial_output "Cms::PagePartial(:_header)", all_output
   # This output is ugly, but it verifies that seed data completely runs
 end
 
 When /^the file "([^"]*)" should contain:$/ do |file, partial_content|
   check_file_content(file, partial_content, true)
 end
+
+When /^the correct version of Rails should be added to the Gemfile$/ do
+  check_file_content("#{project_name}/Gemfile", "gem 'rails', '#{Rails::VERSION::STRING}'", true)
+end
+
+When /^BrowserCMS should be added the Gemfile$/ do
+  check_file_content("#{project_name}/Gemfile", 'gem "browsercms"', true)
+end
+
+Then /^Gemfile should have the correct version of BrowserCMS$/ do
+  check_file_content("Gemfile", %!gem "browsercms", "3.4.0.rc3"!, true)
+end
+
+When /^the production environment should be configured with reasonable defaults$/ do
+  check_file_content "#{project_name}/config/environments/production.rb", "config.assets.compile = true", true
+end
+
+When /^it should comment out Rails in the Gemfile$/ do
+  check_file_content("Gemfile", "# gem 'rails', '3.1.3'", true)
+end
+
+When /^it should run bundle install$/ do
+  assert_partial_output "Your bundle is complete!", all_output
+end
+
+When /^it should copy all the migrations into the project$/ do
+  expected_outputs = %w{
+    rake  cms:install:migrations
+    Copied migration
+    browsercms300.rb from cms
+    browsercms305.rb from cms
+    browsercms330.rb from cms
+    browsercms340.rb from cms
+  }
+  expected_outputs.each do |expect|
+    assert_partial_output expect, all_output
+  end
+end
+
+When /^it should add the seed data to the project$/ do
+  check_file_presence ["db/browsercms.seeds.rb"], true
+  verify_seed_data_requires_browsercms_seeds
+end
+
+When /^it should display instructions to the user$/ do
+  expected = %w{
+      Next Steps:
+      Review https://github.com/browsermedia/browsercms/wiki/Upgrading-to-3.4.x-from-3.3.x
+    }
+  expected.each do |expect|
+    assert_partial_output expect, all_output
+  end
+end
+
+Given /^the project has a "([^"]*)" block(| which hasn't ever been migrated)$/ do |block_name, been_migrated|
+  # Generate a 3.3.x block and migration (Done here so as to EXACTLY preserve how block datastructure existed in this version)
+  block_content = <<RUBY
+  class #{block_name.capitalize} < ActiveRecord::Base
+    acts_as_content_block
+  end
+RUBY
+  write_file "app/models/#{block_name}.rb", block_content
+
+
+  been_migrated_line = (been_migrated == "" ? "rename_column :#{block_name}_versions, :original_record_id, :#{block_name}_id" : "")
+  content = <<RUBY
+  class Create#{block_name.capitalize}s < ActiveRecord::Migration
+    def change
+      create_content_table :#{block_name}s, :prefix=>false do |t|
+        t.timestamps
+      end
+      #{been_migrated_line}
+    end
+  end
+RUBY
+  write_file "db/migrate/001_create_#{block_name}s.rb", content
+end
+
+Then /^I should have a migration for updating the "([^"]*)" versions table$/ do |block_name|
+  migration = find_migration_with_name "update_version_id_columns.rb"
+  check_file_content migration, "models = %w{#{block_name}}", true
+  check_file_content migration, "require 'cms/upgrades/v3_4_0'", true
+end
+
+When /^the project has a "([^"]*)" model$/ do |model_name|
+  run "rails g model #{model_name}"
+end
+
+Then /^the migration (should|should not) update the version table for "([^"]*)" block$/ do |should, block|
+  did_migration = %!rename_column("#{block}_versions", "#{block}_id", :original_record_id)!
+
+  assert_partial_output "UpdateVersionIdColumns: migrated", all_output
+  if should == "should"
+    assert_partial_output did_migration, all_output
+  else
+    assert_no_partial_output did_migration, all_output
+  end
+end