browsercms 3.3.4 → 3.4.0.rc1

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

@@ -5,8 +5,7 @@
     <title><%= @page_title %></title>
     <%= stylesheet_link_tag 'cms/application' %>
     <%= stylesheet_link_tag 'cms/page_toolbar' %>
-    <%= javascript_include_tag 'jquery', 'jquery.selectbox-0.5.js' %>
-    <%= javascript_include_tag 'cms/application' %>
+    <%= javascript_include_tag 'cms/toolbar' %>
     <% if protect_against_forgery? %><script type="text/javascript">
       jQuery(function($){
         $.cms.authenticity_token = '<%= form_authenticity_token %>'

data/app/views/portlets/email_page/_form.html.erb

@@ -3,5 +3,4 @@
   :default_value => "A link you might be interested in" %>
 <%= f.cms_text_field :success_url, 
   :instructions => "Leave blank to return the same page" %>
-<%= f.cms_text_area :template, 
-  :default_value => EmailPagePortlet.default_template %>
+<%= f.cms_text_area :template,  :default_value => EmailPagePortlet.default_template  %>

data/app/views/portlets/email_page/render.html.erb

@@ -1,6 +1,6 @@
 <div class="email-page-portlet">
-  <%= form_for @email_message, :url => cms_handler_path(@portlet, "deliver") do |f| %>
-    <%= hidden_field_tag :email_page_portlet_url, @email_page_portlet_url %> 
+  <%= form_for @email_message, :url => handler_path(@portlet, "deliver") do |f| %>
+    <%= hidden_field_tag :email_page_portlet_url, @email_page_portlet_url %>
     <%= f.cms_error_messages %>
     <p>
       <%= f.label :recipients %>

data/app/views/portlets/login/render.html.erb

@@ -2,11 +2,11 @@
   <% if logged_in? %>
     <p>Welcome, <%= current_user.login %></p>
     <p><%= link_to "Logout", '' %></p>
-    <p><%#= link_to "Logout", cms_logout_path %></p>
+    <p><%#= link_to "Logout", cms.logout_path %></p>
   <% else %>
     <div class="error"><%= flash[:login_error] %></div>
     <%= form_tag '' do %>
-    <%#= form_tag cms_login_path do %>
+    <%#= form_tag cms.login_path do %>
       <%= hidden_field_tag :success_url, @success_url %>
       <%= hidden_field_tag :failure_url, @failure_url %>    
       <p>

data/app/views/portlets/portlets/_form.html.erb

@@ -1,6 +1,6 @@
-<% if @block.class == Portlet %>
+<% if @block.class == Cms::Portlet %>
   <% page_title "Content Library / Select Portlet Type" %>
-  <% Portlet.types.each do |portlet_type| %>
+  <% Cms::Portlet.types.each do |portlet_type| %>
     <div style="margin-bottom: 20px;">
       <%
         link_params = {:type => portlet_type.underscore}
@@ -9,11 +9,11 @@
           link_params["#{portlet_type.underscore}[connect_to_container]"] = params[:portlet][:connect_to_container]
         end
       %>
-      <%= link_to h(portlet_type.titleize), new_cms_portlet_path(link_params) %>
+      <%= link_to h(portlet_type.titleize), new_portlet_path(link_params) %>
     </div>
   <% end %>
   <% @hide_buttons = true %>
 <% else %>
   <%= hidden_field_tag :type, @block.class.name.underscore, :id => "portlet_type_field" %>
   <%= render :partial => @block.class.form, :locals => {:f => f} %>
-<% end %>
+<% end %>

data/app/views/portlets/reset_password/_form.html.erb

@@ -1,3 +1,3 @@
 <%= f.cms_text_field :name %>
-<%= f.cms_drop_down :handler, ActionView::Template.template_handler_extensions, :default => "erb" %>
-<%= f.cms_text_area :template, :default_value => @block.class.default_template %>
+<%= f.cms_template_editor :template %>
+

data/bin/bcms

@@ -6,64 +6,106 @@ require 'term/ansicolor'
 require 'rails/generators/actions'
 require 'active_support/core_ext/string/inflections'
 require 'cms/version'
+require 'cms/commands/actions'
+# 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.
+require 'active_support/core_ext/array/wrap'
+
 
 class String
   include Term::ANSIColor
 end
 
 
-class App < Thor
+class Cms::Install < Thor
   include Thor::Actions
   include Rails::Generators::Actions
-  source_root File.expand_path('../../lib/generators/cms/upgrade_module/templates', __FILE__)
+  include Cms::Commands::Actions
+
 
   def self.common_options
     method_option :database, :aliases => "-d", :desc => "Preconfigure for selected database (options: mysql/oracle/postgresql/sqlite3/frontbase/ibm_db) [Default: sqlite3]"
     method_option :template, :aliases => "-m", :desc => "Path to an application template (can be a filesystem path or URL)"
+    method_option :skip_bundle, :aliases => "--skip-bundle", :desc => "Don't run bundle install", :default => false, :type => :boolean
   end
 
-  desc "new", "Creates a blank BrowserCMS project with a single default template. Suitable for starting a new website project."
+  desc "new [NAME]", "Creates a blank BrowserCMS project with a single default template. Suitable for starting a new website project."
   common_options
+
   def new(name)
     create_blank_cms_project(name)
-    echo_next_steps(name)
+    display_instructions(name)
   end
 
 
-  desc 'demo', "Generates a BrowserCMS application with a sample demo website. Suitable for learning BrowserCMS."
+  desc 'demo [NAME]', "Generates a BrowserCMS application with a sample demo website. Suitable for learning BrowserCMS."
   common_options
+
   def demo(name)
     create_blank_cms_project(name)
-    generate "browser_cms:demo_site"
-    echo_next_steps(name)
+    generate_demo_project
+    display_instructions(name)
   end
 
-
-  desc 'module', "Generates a BrowserCMS module for sharing code between BrowserCMS projects. (Name must start with bcms_)"
+  desc 'module [NAME]', "Generates a BrowserCMS module for sharing code between BrowserCMS projects. (Name must start with bcms_)"
   common_options
+
   def module(name)
-    create_blank_cms_project(name)
-    generate 'cms:upgrade_module', name
-    template 'COPYRIGHT.txt'
-    template 'LICENSE.txt'
-    template 'GPL.txt'
-    echo_next_steps(name)
+    @project_name = name
+    create_mountable_app
+    create_license_files
+
+    inside rails_app do
+      generate_seeds_rb
+    end
+
+    add_rake_tasks_for_module
+    generate_browsercms_project
+    generate_installation_script
+    generate_default_template
+
+    display_instructions(name)
   end
 
   desc 'version', 'Show BrowserCMS version'
   map "-v" => :version, "--version" => :version
+
   def version
     puts "BrowserCMS #{Cms::VERSION}"
   end
 
+  desc 'install', "Adds BrowserCMS to an existing rails application."
+
+  def install
+    common_setup('.')
+    prefix_cms_tables
+    generate_default_template
+    puts "BrowserCMS has been installed. Run rake db:install to add the tables then restart your server."
+  end
+
   private
 
-  def start_working_in_rails_directory(name)
+  def prefix_cms_tables
+    append_to_file "config/initializers/browsercms.rb", <<-CODE
+Cms.table_prefix = "cms_"
+    CODE
+  end
+
+  def create_license_files
+    template 'COPYRIGHT.txt'
+    template 'LICENSE.txt'
+    template 'GPL.txt'
+    remove_file "MIT-LICENSE"
+  end
+
+  # i.e. cd project_name
+  def work_in_project_root_directory(name=@project_name)
     self.destination_root = (File.join(destination_root, name))
   end
 
   def create_rails_app(name)
-    rails_cmd = "rails new #{name}"
+    rails_cmd = "rails new #{name} --skip-bundle"
     if options[:template]
       rails_cmd += " -m #{options[:template]}"
     end
@@ -73,52 +115,41 @@ class App < Thor
     run(rails_cmd)
   end
 
-
-  def echo_next_steps(name)
+  def display_instructions(name)
     puts "\nCreated new BrowserCMS project '#{name}'."
     puts "    To get started, type 'cd #{name}'"
     puts "    then type 'rake db:install'"
     puts "    then type 'rails server' and open your browser to 'http://localhost:3000'."
   end
 
-  def create_blank_cms_project(name)
-    create_rails_app(name)
-    start_working_in_rails_directory(name)
-
-    # Unsure if this handles windows specific removal of files
-    remove_file("public/index.html")
-    remove_file("db/seeds.rb")
-
-    gem 'browsercms', :version=>::Cms::VERSION
-
-    generate :jdbc if defined?(JRUBY_VERSION)
-    route "routes_for_browser_cms"
-
-    generate "browser_cms:cms"
-
-    %w{development test production}.each do |env|
-      prepend_to_file "config/environments/#{env}.rb" do
-        <<-CODE
-SITE_DOMAIN="localhost:3000"
-        CODE
-      end
-    end
-
+  def configure_default_cache_directory
     insert_into_file "config/environments/production.rb", :after => "Application.configure do\n" do
       <<-CODE
-  config.action_controller.page_cache_directory = File.join(Rails.root, 'public', 'cache')
+  config.action_controller.page_cache_directory = File.join(Rails.root,'public','cache')
       CODE
     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
+# 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
@@ -126,20 +157,154 @@ SITE_DOMAIN="localhost:3000"
     end
 
     gsub_file "config/environments/production.rb", /(config\.serve_static_assets =) false/, '  \1 true'
+  end
 
+  def configure_mail_server
     insert_into_file "config/environments/production.rb", :after => "config.active_support.deprecation = :notify" do
       %q{
 
   # Configure your mail server's address below
   config.action_mailer.smtp_settings = {:address => 'mail.yourmailserver.com', :domain => "#{SITE_DOMAIN}"}}
     end
+  end
 
+  def add_sitedomain_constant_to_environment_files
+    %w{development test production}.each do |env|
+      prepend_to_file "config/environments/#{env}.rb" do
+        <<-CODE
+SITE_DOMAIN="localhost:3000"
+        CODE
+      end
+    end
+  end
+
+  def generate_browsercms_project
+    rake 'cms:install:migrations'
+    generate "browser_cms:cms"
+
+    inside rails_app do
+      add_route_to_end("mount_browsercms")
+      add_sitedomain_constant_to_environment_files
+      configure_default_cache_directory
+      configure_mail_server
+      create_browsercms_initializer
+    end
+  end
+
+  def generate_demo_project
+    self.class.source_root(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"
+      copy_file 'style.css', "public/themes/blue_steel/stylesheets/style.css"
+
+      copy_file 'demo_site.rake', 'lib/tasks/demo_site.rake'
+      copy_file 'demo.seeds.rb', 'db/demo_site_seeds.rb'
+    end
+  end
+
+  def add_rake_tasks_for_module
+    copy_file 'module_tasks.rake', 'lib/tasks/module_tasks.rake'
+    append_to_file 'Rakefile', "\nload 'lib/tasks/module_tasks.rake'"
+    insert_into_file "#{current_project}.gemspec", "  s.files -= Dir['lib/tasks/module_tasks.rake']\n  ", :before => "s.test_files"
+  end
+
+  # When working with modules, the 'root' is the dummy application
+  def in_root
+    inside(rails_app) { yield }
+  end
+
+  def rails_app
+    if @project_name
+      "test/dummy"
+    else
+      @destination_stack.first
+    end
+  end
+
+  def project_root
+    if @project_name
+      @project_name
+    else
+      @destination_stack.first
+    end
+  end
+
+  # For both creating new bcms project and adding bcms to existing rails projects.
+  def common_setup(name)
+    gem 'browsercms', :version => ::Cms::VERSION
+    run_bundle_install
+    generate :jdbc if defined?(JRUBY_VERSION)
+    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
+
+  def standard_file_permissions
+    "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
+
+  def add_browsercms_dependency
+    prepend_file "lib/#{@project_name}/engine.rb", "require 'browsercms'\n"
+  end
+
+  def create_blank_cms_project(name)
+    create_rails_app(name)
+    work_in_project_root_directory(name)
+
+    # Unsure if this handles windows specific removal of files
+    remove_file("public/index.html")
+
+    common_setup name
+    create_browsercms_initializer
+    generate_default_template
+
+  end
+
+  def create_browsercms_initializer
     initializer 'browsercms.rb', <<-CODE
-Cms.attachment_file_permission = 0640
+#{standard_file_permissions}
     CODE
+  end
+
+  def gemspec_file
+    "#{@project_name}.gemspec"
+  end
+
+  # Add a dependency to the project gemspec file.
+  def gemspec(name, options={})
+    text = <<-RUBY
+      s.add_dependency "#{name}", "#{options[:version]}"\n
+    RUBY
+    insert_into_file(gemspec_file(), text, :after => "Gem::Specification.new do |s|\n")
+  end
 
-    generate "cms:template", "default"
+  def remove_rails_dependency
+    insert_into_file gemspec_file, "# Depend on BrowserCMS,rather than Rails \n # ", :before => "s.add_dependency \"rails\""
   end
 end
 
-App.start
+Cms::Install.start

data/bin/bcms-upgrade

@@ -5,6 +5,7 @@ require 'thor'
 require 'term/ansicolor'
 require 'rails/generators/actions'
 require 'active_support/core_ext/string/inflections'
+require 'cms/commands/actions'
 
 class String
   include Term::ANSIColor
@@ -13,8 +14,8 @@ end
 class App < Thor
   include Thor::Actions
   include Rails::Generators::Actions
+  include Cms::Commands::Actions
 
-  source_root(File.join(__FILE__, '../../lib/generators/cms/upgrade_module/templates'))
 
   desc "check", "Checks the existing module to determine what needs to done."
 
@@ -52,22 +53,23 @@ TEXT
   end
 
   desc 'v3_3_0', "Upgrades BrowserCMS files from 3.1.x to 3.3.0 (Back up first)"
+
   def v3_3_0
     upgrade_to_3_3_0
   end
 
-  desc 'module', "Upgrade a module from Rails 2 to Rails 3. (Backup before running this)"
+  desc 'module', "Upgrades a module. "
   def module
-    new_rails
-    cleanup_rails2_files
-    cleanup_rails_3
-    cleanup_module
-    upgrade_to_3_3_0
-    generate_bcms_module
-    next_steps
+    unless project_is_module?
+      say "This does not appear to be a BrowserCMS module. Skipping update."
+      exit 0
+    end
+    upgrade_module_from_3_1_x_to_3_3_x if project_is_3_1_x?
+    upgrade_from_3_3_x_to_3_4_x
   end
 
   desc 'next_steps', "Reprints instructions on final steps (Use after 'upgrade')"
+
   def next_steps
     header = <<TEXT
 Next Steps:
@@ -103,6 +105,17 @@ TEXT
     run "rails new . -f"
   end
 
+  def upgrade_module_from_3_1_x_to_3_3_x
+    puts "Upgrading to BrowserCMS 3.3.x..."
+    new_rails
+    cleanup_rails2_files
+    cleanup_rails_3
+    cleanup_module
+    upgrade_to_3_3_0
+    generate_bcms_module_for_3_3_x
+    next_steps
+  end
+
   # Removes any files which are Rails 2 specific
   def cleanup_rails2_files
     %w{about console dbconsole destroy generate performance plugin runner server}.each do |script_name|
@@ -132,6 +145,86 @@ TEXT
     git :checkout => 'config/database.yml'
   end
 
+
+  def upgrade_from_3_3_x_to_3_4_x
+    remove_dir "script" # Wipe out any old scripts, using new Rails 3.1 mountable script.
+    remove_file 'config.ru'
+    run "rails plugin new . --mountable --force"
+    revert "lib/#{name_of_module}/engine.rb"
+    revert "lib/#{name_of_module}/version.rb"
+    revert "#{name_of_module}.gemspec"
+
+    remove_file "MIT-LICENSE"
+    remove_file "README.rdoc"
+    move_file "config/database.yml", "test/dummy/config/database.yml"
+
+    move_file "config/routes.rb", "tmp/routes.rb" # Backup to avoid getting overwritten by plugin
+    remove_dir "config"
+    empty_directory "config"
+    move_file "tmp/routes.rb", "config/routes.rb"
+
+    prepend_to_file "lib/#{name_of_module}/engine.rb", "require 'browsercms'\n"
+    include_cms_module
+
+    remove_dir "app/views/layouts"
+    remove_file "app/controllers/application_controller.rb"
+    remove_file "app/helpers/application_helper.rb"
+
+    move_dir "public/bcms/#{name_of_module.gsub("bcms_", "")}", "app/assets"
+    remove_dir "public"
+
+    append_to_file "test/dummy/config/routes.rb", "\tmount_browsercms\n", :after=>"/#{name_of_module}\"\n"
+
+    # Clean up db/ folder
+    remove_file "db/schema.rb"
+    remove_file "db/seeds.rb"
+    remove_files "db/migrate/*_browsercms*.rb"
+    remove_files "db/*.sqlite3"
+
+    # Create a seed data file
+    create_file "test/dummy/db/seeds.rb", "# Add seed data here"
+
+  end
+
+  # Does a git revert of a file.
+  def revert(file)
+    git :checkout => file
+  end
+
+  # Move all the contents of a given directory into the specified directory
+  # @param [String] src Relative name of src directory (with project)
+  # @param [String] dest Relative name of dest directory (with project)
+  # @param [Hash] config
+  def move_dir(src, dest, config={})
+    src_path = File.expand_path(src, destination_root)
+
+    Dir.glob(File.join(src_path, '*')).each do |file|
+      to = File.join(destination_root, dest, File.basename(file))
+      FileUtils.mv file, to
+      say_status :mv, "#{relative_to_original_destination_root(file)} -> #{relative_to_original_destination_root(to)}", config.fetch(:verbose, true)
+
+    end
+  end
+
+  # Remove a set of files matching a glob pattern.
+  # @param [String] pattern i.e. db/migrate/*_browsercms_*.rb
+  def remove_files(pattern)
+    Dir.glob(File.join(destination_root, pattern)).each do |file|
+      remove_file file
+    end
+  end
+
+  # Move a file within the destination directory
+  # @param [String] src
+  # @param [String] dest
+  # @param [Hash] config
+  def move_file(src, dest, config={})
+    src_path = File.expand_path(src, destination_root)
+    dest_path = File.expand_path(dest, destination_root)
+    say_status :mv, "#{relative_to_original_destination_root(src_path)} -> #{relative_to_original_destination_root(dest_path)}", config.fetch(:verbose, true)
+    FileUtils.mv(src_path, dest_path)
+  end
+
   def upgrade_to_3_3_0
     # Remove public files where are now served from CMS core.
     remove_file 'public/bcms/ckeditor'
@@ -142,10 +235,9 @@ TEXT
       remove_file "public/javascripts/#{js}.js"
     end
 
-    copy_file '20100705083859_browsercms_3_3_0.rb', 'db/migrate/20100705083859_browsercms_3_3_0.rb'
   end
 
-  def generate_bcms_module
+  def generate_bcms_module_for_3_3_x
     gem 'browsercms'
     gem 'mysql'
     gem 'jeweler', :group=>:development
@@ -153,17 +245,14 @@ TEXT
     # Allows gem to be loaded as a engine for testing.
     append_to_file 'Gemfile', 'gemspec'
 
-
-    template 'engine.erb', "lib/#{name_of_module}/engine.rb"
+    create_file "lib/#{name_of_module}/engine.rb", "# Engine goes here"
     prepend_to_file "lib/#{name_of_module}.rb" do
       "require '#{name_of_module}/engine'\n"
     end
-    route "routes_for_browser_cms"
+    route "mount_browsercms"
     route "routes_for_#{name_of_module}"
 
-    template 'install.erb', "lib/generators/#{name_of_module}/install/install_generator.rb"
-    template 'USAGE.erb', "lib/generators/#{name_of_module}/install/USAGE"
-    empty_directory "lib/generators/#{name_of_module}/install/templates"
+    generate_installation_script
 
 
     run "rails g browser_cms:cms -f"
@@ -227,6 +316,18 @@ TEXT
   ensure
     puts "".reset
   end
+
+  # Determines if the current projects is a BrowserCMS module or not.
+  def project_is_module?
+    module_file = File.expand_path(File.join(destination_root, "lib", "#{name_of_module}.rb"))
+    File.exists?(module_file)
+  end
+
+  def project_is_3_1_x?
+    rails_console = File.expand_path(File.join(destination_root, "script", "console"))
+    File.exists?(rails_console)
+  end
 end
 
+
 App.start