browsercms 3.4.0.rc2 → 3.4.0

data/.rvmrc

@@ -1,2 +1,2 @@
-rvm 1.9.3@r3.1
+rvm use 1.9.3@r3.1
 

data/COPYRIGHT.txt

@@ -1,4 +1,4 @@
-All BrowserCMS code is Copyright (C) 1998-2010 by BrowserMedia, LLC.
+All BrowserCMS code is Copyright (C) 1998-2012 by BrowserMedia, LLC.
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU Lesser General Public License as published by

data/Gemfile.lock

@@ -1,8 +1,9 @@
 PATH
   remote: .
   specs:
-    browsercms (3.4.0.rc2)
+    browsercms (3.4.0)
       ancestry (~> 1.2.4)
+      ckeditor_rails (~> 3.6.2.2)
       jquery-rails (~> 1.0.14)
       rails (~> 3.1.0)
       term-ansicolor
@@ -61,6 +62,9 @@ GEM
       xpath (~> 0.1.4)
     childprocess (0.2.2)
       ffi (~> 1.0.6)
+    ckeditor_rails (3.6.2.2)
+      railties (~> 3.0)
+      thor (~> 0.14)
     cucumber (1.1.0)
       builder (>= 2.1.2)
       diff-lcs (>= 1.1.2)
@@ -92,7 +96,7 @@ GEM
     json_pure (1.6.1)
     launchy (2.0.5)
       addressable (~> 2.2.6)
-    mail (2.3.2)
+    mail (2.3.3)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)

data/README.markdown

@@ -1,18 +1,18 @@
 # BrowserCMS: Humane Content Management for Rails
 
-BrowserCMS is a general purpose, open source Web Content Management System (CMS), written in Ruby on Rails. It is designed to support three distinct groups of people:
+BrowserCMS is a general purpose, open source Web Content Management System (CMS), written in Ruby on Rails. It's designed as a Mountable engine and works with Rails 3.1. It is designed to support three distinct groups of users:
 
 1. Non-technical web editors who want a humane system to manage their site, without needing to understand what HTML or even Rails is.
 2. Designers who want to create large and elegantly designed websites with no artificial constraints by the CMS.
 3. Developers who want to drop a CMS into their Rails projects, or create CMS driven websites for their clients.
 
 ## Features
-BrowserCMS is intended to offer features comparable to commercial CMS products, which can support larger teams of editors. This means having a robust set of features as part of its core, as well as the capability to customize it via modules. 
+BrowserCMS is intended to offer features comparable to commercial CMS products, which can support larger teams of editors. This means having a robust set of features as part of its core, as well as the capability to customize it via modules.
 
 Here's a quick overview of some of the more notable features:
 
-* It's just Rails: Each CMS project is a rails project that depends on the BrowserCMS gem. Developers can add new controllers, views, etc; just like any rails project.
-* Direct in context editing: Users can browse their site to locate content and change it right on the page itself.
+* Mountable Engine: Each CMS project is a rails project that depends on the BrowserCMS engine. Developers can add new controllers, views, etc; just like any rails project.
+* In Context Editing: Users can browse their site to locate content and change it right on the page itself.
 * Design friendly Templates: Pages aren't just a template and giant single chunk of HTML. Templates can be built to have multiple editable areas, to allow for rich designs that are still easy to manage by non-technical users.
 * Sitemap: An explorer/finder style view of sections and pages in a site allowing users to add and organize pages.
 * Content Library: Provides a standardized 'CRUD' interface to allow users to manage both core and custom content types.
@@ -21,21 +21,11 @@ Here's a quick overview of some of the more notable features:
 * Workflow: Supports larger website teams where some users can contribute, but not publish. Users can assign work to other publishers to review.
 * Page Caching: Full page caching allows the web server (Apache) to serve HTML statically when they don't change.
 
-## Browser Compatibility
-BrowserCMS can create websites that can work in any browser, depending on how developers implement their design as HTML templates. However, the administrator interface is limited to a select # of browsers, with Firefox being the most stable. Supported browsers include:
-
-1. FireFox 3+ (Mac, Windows, Linux) - This is currently the best choice for administering the CMS.
-2. Safari 3.2+ (Mac, Windows) - Works, with some minor layout problems.
-3. Internet Explorer 7+ (Windows) - Mostly functional, though there are a number of layout issues in the admin.
-
-The next releases will be aimed at tightening up the admin for both Safari and IE7+. We will not be supporting the admin UI for IE6, or other browsers not explicitly listed above.
-
 ## Getting Started
-Before you can use BrowserCMS, you will need to install the gem. See the [Getting Started](https://github.com/browsermedia/browsercms/wiki/Getting-Started) guide.
+See the [Getting Started](https://github.com/browsermedia/browsercms/wiki/Getting-Started) guide for instructions on how to install and start a project with BrowserCMS.
 
 ## License
-BrowserCMS is released under a LGPL license, and is copyright 1998-2011 BrowserMedia. The complete copyright can be found in COPYRIGHT.txt, and copy of the license can be found in LICENSE.txt.
-
+BrowserCMS is released under a LGPL license, and is copyright 1998-2012 BrowserMedia. The complete copyright can be found in COPYRIGHT.txt, and copy of the license can be found in LICENSE.txt.
 
 ## Documentation / Support
 The user documentation and guides for this version of the application can be found at:

data/{vendor/assets/javascripts/bcms/ckeditor/editor.js → app/assets/javascripts/bcms/ckeditor.js}

@@ -1,13 +1,16 @@
 //
-// Generic functions for loading WYSIWYG editors for BrowserCMS
+//  Manifest file for loading the CKeditor JS. Loads it from ckeditor-rails gem.
+//  See /assets/ckeditor/config.js for default configuration.
 //
+//= require ckeditor-jquery
+
 jQuery(function($){
   $('textarea.editor').each(function(e){
     if(editorEnabled()) {
       loadEditor(this.id)
     }
   });
-})
+});
 
 function editorEnabled() {
   return $.cookie('editorEnabled') ? $.cookie('editorEnabled') == "true" : true
@@ -51,4 +54,4 @@ function loadEditor(id) {
   } else {
     return false
   }
-}
+}

data/{vendor/assets/javascripts/bcms → app/assets/javascripts}/ckeditor/config.js

@@ -1,3 +1,5 @@
+// Default configuration for the CKeditor in BrowseCMS projects.
+
 CKEDITOR.config.toolbar_CMS = [
   ['Source','-','Cut','Copy','Paste','PasteText','PasteFromWord','-','SpellChecker','Scayt','-','Undo','Redo','Find','Replace','RemoveFormat','-','NumberedList','BulletedList','Outdent','Indent','HorizontalRule'],
   '/',

data/app/assets/javascripts/cms/application.js

@@ -1,5 +1,5 @@
 //
-//  Javascript librarys required for the Admin area of the CMS.
+//  Javascript libraries required for the Admin area of the CMS.
 //
 //= require jquery
 //= require jquery-ui

data/app/assets/javascripts/cms/{core_library.js → core_library.js.erb}

@@ -101,6 +101,11 @@ jQuery(function($) {
 
 });
 
+// Automatically enable date_picker controls
+$(function() {
+    $('input.date_picker').datepicker({ changeFirstDay: false, changeMonth:true, changeYear:true, closeText:'', showButtonPanel: true, dateFormat: '<%= Cms::DatePicker.jquery_format %>' });
+});
+
 //CookieSet allows us to treat one cookie value as a set of values
 jQuery(function($) {
     var sep = '|'

data/app/assets/stylesheets/cms/form_layout.css.erb

@@ -19,6 +19,7 @@ font-size: 100%;
 }
 
 .fields {
+clear:both;
 padding: 10px 0;
 background: url(<%= asset_path "cms/dashed.gif" %>) repeat-x 100% 100%;
 }

data/app/controllers/cms/links_controller.rb

@@ -11,7 +11,7 @@ class LinksController < Cms::BaseController
   end
 
   def create
-    @link = Link.new(params[:cms_link])
+    @link = Link.new(params[:link])
     @link.section = @section
     if @link.save
       flash[:notice] = "Link was '#{@link.name}' created."
@@ -22,7 +22,7 @@ class LinksController < Cms::BaseController
   end
   
   def update
-    if @link.update_attributes(params[:cms_link])
+    if @link.update_attributes(params[:link])
       flash[:notice] = "Link '#{@link.name}' was updated"
       redirect_to @link.section
     else

data/app/controllers/cms/tasks_controller.rb

@@ -9,7 +9,7 @@ class TasksController < Cms::BaseController
   end
   
   def create
-    @task = @page.tasks.build(params[:cms_task])
+    @task = @page.tasks.build(params[:task])
     @task.assigned_by = current_user
     if @task.save
       flash[:notice] = "Page was assigned to '#{@task.assigned_to.login}'"

data/app/controllers/cms/users_controller.rb

@@ -41,7 +41,7 @@ class UsersController < Cms::ResourceController
   end
 
   def update_password
-    if user.update_attributes(params[:cms_user])
+    if user.update_attributes(params[:user])
       flash[:notice] = "Password for '#{user.login}' was changed"
       redirect_to(current_user.able_to?(:administrate) ? users_path : user_path(user))
     else

data/app/helpers/cms/ui_elements_helper.rb

@@ -11,6 +11,12 @@ module Cms
       end
     end
 
+    # For simple publish buttons
+    def publish_button(type)
+      html = %Q{<button type="submit" name="#{type}[publish_on_save]" value="true" class="submit"><span>Save And Publish</span></button>'}
+      lt_button_wrapper html.html_safe
+    end
+
 
     def select_content_type_tag(type, &block)
       options = {:rel => "select-#{type.key}"}

data/app/views/cms/links/edit.html.erb

@@ -7,7 +7,7 @@
 <%= form_for(@link) do |f| %>
   <%= render :partial => 'form', :locals => {:f => f} %>
   <div class="buttons">
-    <%= lt_button_wrapper('<button type="submit" name="cms_link[publish_on_save]" value="true" class="submit"><span>Save And Publish</span></button>') %>
+    <%= publish_button "link" %>
     <%= lt_button_wrapper(f.submit("Save", :class => "submit")) %>
   </div>
 <% end %>

data/app/views/cms/links/new.html.erb

@@ -8,7 +8,7 @@
   <%= hidden_field_tag :section_id, @link.section_id %>
   <%= render :partial => 'form', :locals => {:f => f} %>
   <div class="buttons">
-    <%= lt_button_wrapper(%Q{<button type="submit" name="cms_link[publish_on_save]" value="true" class="submit" tabindex="#{next_tabindex}"><span>Save And Publish</span></button>}) %>
+    <%= publish_button "link" %>
     <%= lt_button_wrapper(f.submit("Save", :class => "submit", :tabindex => next_tabindex )) %>
   </div>
 <% end %>

data/app/views/cms/tasks/new.html.erb

@@ -9,7 +9,7 @@
   <br clear="all"/>
 <% end %>
 
-<%= form_for(@task, :url => @task.new_record? ? cms_page_tasks_path(@page) : cms_page_task_path(@page, @task)) do |f| %>
+<%= form_for(@task, :url => @task.new_record? ? page_tasks_path(@page) : page_task_path(@page, @task)) do |f| %>
 
   <%= f.cms_error_messages %>
   <div class="fields text_fields">

data/app/views/layouts/cms/_head.html.erb

@@ -5,12 +5,12 @@
   <title><%= @page_title %></title>
   <%= stylesheet_link_tag 'cms/application', 'cms/date_picker', 'cms/sitemap', 'cms/taglist' %>
   <%= javascript_include_tag "cms/application", cms_content_editor %>
+  <%= csrf_meta_tags %>
   <script type="text/javascript">
     jQuery(function($){
       <% if protect_against_forgery? %>      
         $.cms.authenticity_token = '<%= form_authenticity_token %>'
       <% end %>
-      $('input.date_picker').datepicker({ changeFirstDay: false, changeMonth:true, changeYear:true, closeText:'', showButtonPanel: true, dateFormat: '<%= Cms::DatePicker.jquery_format %>' })
     })
   </script>
   <%= yield :html_head %>

data/app/views/layouts/cms/login.html.erb

@@ -7,6 +7,7 @@
     <%= stylesheet_link_tag 'cms/login' %>
   <%= javascript_include_tag 'jquery', 'jquery-ui', 'jquery.cookie.js' %>
   <%= javascript_include_tag 'cms/application' %>
+  <%= csrf_meta_tags %>
   <% if protect_against_forgery? %><script type="text/javascript">
     jQuery(function($){
       $.cms.authenticity_token = '<%= form_authenticity_token %>'

data/app/views/layouts/cms/toolbar.html.erb

@@ -6,6 +6,7 @@
     <%= stylesheet_link_tag 'cms/application' %>
     <%= stylesheet_link_tag 'cms/page_toolbar' %>
     <%= javascript_include_tag 'cms/toolbar' %>
+    <%= csrf_meta_tags %>
     <% if protect_against_forgery? %><script type="text/javascript">
       jQuery(function($){
         $.cms.authenticity_token = '<%= form_authenticity_token %>'

data/bin/bcms

@@ -7,6 +7,7 @@ require 'rails/generators/actions'
 require 'active_support/core_ext/string/inflections'
 require 'cms/version'
 require 'cms/commands/actions'
+require 'cms/upgrades/v3_4_0'
 # This seems to be required only due to a bug in Thor documented here:
 #   https://rails.lighthouseapp.com/projects/8994/tickets/4692-error-when-creating-app-from-template-undefined-method-wrap-for-arrayclass
 # If this bug is fixed the following line can probably be removed.
@@ -22,7 +23,7 @@ class Cms::Install < Thor
   include Thor::Actions
   include Rails::Generators::Actions
   include Cms::Commands::Actions
-
+  include Cms::Upgrades::V3_4_0
 
   def self.common_options
     method_option :database, :aliases => "-d", :desc => "Preconfigure for selected database (options: mysql/oracle/postgresql/sqlite3/frontbase/ibm_db) [Default: sqlite3]"
@@ -38,7 +39,6 @@ class Cms::Install < Thor
     display_instructions(name)
   end
 
-
   desc 'demo [NAME]', "Generates a BrowserCMS application with a sample demo website. Suitable for learning BrowserCMS."
   common_options
 
@@ -68,6 +68,26 @@ class Cms::Install < Thor
     display_instructions(name)
   end
 
+  desc "upgrade", "Upgrades a BrowserCMS project to v#{Cms::VERSION}"
+  method_option :skip_rails, :aliases => "--skip-rails", :desc => "Skip running `rake rails:update`.", :default => false, :type => :boolean
+  def upgrade
+    update_browsercms_gem_version
+    comment_out_rails_in_gemfile
+    run_bundle_install
+    install_migrations
+    rake "rails:update" unless options[:skip_rails]
+    generate_rails_3_4_0_migration
+    install_cms_seed_data
+
+    instructions = <<TEXT
+Upgrade is nearly complete. Review https://github.com/browsermedia/browsercms/wiki/Upgrading-to-3.4.x-from-3.3.x before proceeding.
+Next Steps:
+1. Revert/undo the changes (see the 3.4.x Upgrade guide for details)
+2. Run `rake db:migrate`
+TEXT
+    puts instructions
+  end
+
   desc 'version', 'Show BrowserCMS version'
   map "-v" => :version, "--version" => :version
 
@@ -99,20 +119,49 @@ Cms.table_prefix = "cms_"
     remove_file "MIT-LICENSE"
   end
 
-  # i.e. cd project_name
-  def work_in_project_root_directory(name=@project_name)
+  # i.e. Change the working directory (i.e. cd [name])
+  def cd_to(name=@project_name)
     self.destination_root = (File.join(destination_root, name))
   end
 
   def create_rails_app(name)
-    rails_cmd = "rails new #{name} --skip-bundle"
+    rails_options = {:skip_bundle => true}
     if options[:template]
-      rails_cmd += " -m #{options[:template]}"
+      rails_options[:template] = options[:template]
     end
     if options[:database]
-      rails_cmd += " -d #{options[:database]}"
+      rails_options[:database] = options[:database]
     end
-    run(rails_cmd)
+
+    require 'rails/generators'
+    require 'rails/generators/rails/app/app_generator'
+
+    # We invoke this programmatically, rather than via shell (`rails new #{name}`) so we get EXACT version of rails we want. (Works for Rails 3.1 or later)
+    rails_script = Rails::Generators::AppGenerator.new([name], rails_options)
+    rails_script.invoke_all
+
+  end
+
+  def create_rails_plugin(name)
+    require 'rails/generators'
+    require 'rails/generators/rails/plugin_new/plugin_new_generator'
+
+    rails_options = {:skip_bundle => true}
+    rails_options[:mountable] = true
+    plugin_script = Rails::Generators::PluginNewGenerator.new([name], rails_options)
+    plugin_script.invoke_all
+
+  end
+
+  def create_mountable_app(name = @project_name)
+    create_rails_plugin(name)
+    cd_to(name)
+
+    gemspec "browsercms", :version => "~> #{::Cms::VERSION}"
+    add_browsercms_dependency
+    include_cms_module
+    remove_rails_dependency
+    run_bundle_install
   end
 
   def display_instructions(name)
@@ -130,33 +179,8 @@ Cms.table_prefix = "cms_"
     end
   end
 
-  # In Rails 3.0, we needed to disable xsendfile, since it was by default on in production.
-  # In 3.1, this should be unnecessary because the default seems to have this commented out.
-  #
-  # Leaving here as unused for now in case later versions of Rails change this configuration.
-  def disable_xsendfile
-    insert_into_file "config/environments/production.rb", :before => 'config.action_dispatch.x_sendfile_header = "X-Sendfile"' do
-      <<-CODE
-# If you want to enable webservers to send binary files, you will need to uncomment X-Sendfile line below and configure Apache mod_sendfile
-# See http://codequest.eu/articles/rails3-apache-passenger-and-empty-file-using-send-file for details
-      CODE
-    end
-
-    gsub_file "config/environments/production.rb", /(config\.action_dispatch\.x_sendfile_header = "X-Sendfile")/, '  # \1'
-  end
-
-  # For Rails 3.0, we needed to turn on static asset serving in production, to allow assets to be served.
-  # In 3.1, this should be unnecessary because of the asset pipeline.
-  #
-  # Leaving here as unused for now.
-  def enable_static_asset_serving
-    insert_into_file "config/environments/production.rb", :before => 'config.serve_static_assets = false' do
-      <<-COMMENT
-# This allows bcms to serve static assets (like admin css files) from the gem
-      COMMENT
-    end
-
-    gsub_file "config/environments/production.rb", /(config\.serve_static_assets =) false/, '  \1 true'
+  def enable_asset_precompiling
+    gsub_file "config/environments/production.rb", /config\.assets\.compile = false/, 'config.assets.compile = true'
   end
 
   def configure_mail_server
@@ -179,20 +203,22 @@ SITE_DOMAIN="localhost:3000"
   end
 
   def generate_browsercms_project
-    rake 'cms:install:migrations'
-    generate "browser_cms:cms"
+    install_migrations
 
     inside rails_app do
+      install_cms_seed_data
       add_route_to_end("mount_browsercms")
       add_sitedomain_constant_to_environment_files
       configure_default_cache_directory
       configure_mail_server
       create_browsercms_initializer
+      enable_asset_precompiling
     end
   end
 
   def generate_demo_project
-    self.class.source_root(File.expand_path(File.join(__FILE__, '../../lib/generators/browser_cms/demo_site/templates')))
+    source_paths << File.expand_path(File.join(__FILE__, '../../lib/generators/browser_cms/demo_site/templates'))
+
     inside rails_app do
       copy_file 'logo.jpg', "public/themes/blue_steel/images/logo.jpg"
       copy_file 'splash.jpg', "public/themes/blue_steel/images/splash.jpg"
@@ -238,12 +264,6 @@ SITE_DOMAIN="localhost:3000"
     generate_browsercms_project
   end
 
-  def run_bundle_install
-    inside project_root do
-      run "bundle install" unless options[:skip_bundle]
-    end
-  end
-
   def generate_default_template
     generate 'cms:template', "default"
   end
@@ -252,17 +272,6 @@ SITE_DOMAIN="localhost:3000"
     "Cms.attachment_file_permission = 0640"
   end
 
-  def create_mountable_app(name = @project_name)
-    run("rails plugin new #{name} --mountable --skip-bundle")
-    work_in_project_root_directory(name)
-
-    gemspec "browsercms", :version => "~> #{::Cms::VERSION}"
-    add_browsercms_dependency
-    include_cms_module
-    remove_rails_dependency
-    run_bundle_install
-  end
-
   def generate_seeds_rb
     create_file "db/seeds.rb", "# Load BrowserCMS seed data\n"
   end
@@ -273,7 +282,7 @@ SITE_DOMAIN="localhost:3000"
 
   def create_blank_cms_project(name)
     create_rails_app(name)
-    work_in_project_root_directory(name)
+    cd_to(name)
 
     # Unsure if this handles windows specific removal of files
     remove_file("public/index.html")