browsercms 3.3.0.beta → 3.3.0

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--exclude lib/generators/cms/portlet/templates/*
+--exclude lib/generators/cms/content_block/templates/*
+app/**/*.rb
+lib/**/*.rb

data/README.markdown

@@ -28,30 +28,30 @@ BrowserCMS can create websites that can work in any browser, depending on how de
 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 tightning 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.
+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 guide at http://browsercms.org/doc/guides/html/getting_started.html, or packaged with this source code (under doc/guides/html/getting_started.html)
+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.
 
 ## License
-BrowserCMS is released under a LGPL license, and is copyright 1998-2009 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-2011 BrowserMedia. The complete copyright can be found in COPYRIGHT.txt, and copy of the license can be found in LICENSE.txt.
 
 
 ## Documentation
 The user documentation and guides for this version of the application can be found at:
 
-1. http://browsercms.org/doc/guides/html/index.html - User guides and manuals that cover the features and general functionality of the project. (Found locally at doc/guides/html/index.html)
-2. http://browsercms.org/doc/app/index.html - The RDoc API documenation (locally at doc/app/index.html)
-3. http://wiki.github.com/browsermedia/browsercms - The project wiki
+1. [Guides and Wiki](http://wiki.github.com/browsermedia/browsercms)
+2. [API Docs](http://rubydoc.info/gems/browsercms/)
 
-## Modifying the source
+
+## Working on the core project source
 If you want to experiment with the source code, the BrowserCMS project can bootstrap itself as a web application. This allows developers who want to contribute to the project to easily alter and test changes. To run the application itself, do the following:
 
-    cd /path/to/browsercms_source_code
-    rake reset
-    script/server
+    cd /path/to/browsercms
+    rake db:setup
+    rails server
 
-This will drop the 'browsercms_development' database, loads the same sample data from the demo.rb template. By default, the core project is setup to use mysql as the database, but you can change that via the database.yml files.
+This will create and populate the BrowserCMS database with the minimal seed data for testing. By default, the core project is setup to use mysql as the database, but you can change that via the database.yml files.
 
 ## Support
 The homepage for the BrowserCMS project is http://browsercms.org. From there you can find links to the discussion groups and our twitter account. If you have questions about the project or want to get involved, the Google group is the best way to do so. If you would like to report a bug, please do so at https://browsermedia.lighthouseapp.com/projects/28481-browsercms-30

data/app/helpers/cms/page_helper.rb

@@ -26,7 +26,7 @@ module Cms
     # Note: As of Jan 19, 2010, all render.html.erb templates must handle marking their content as 'html_safe'. This is
     # bit of a pain, but I can't figure out how (or if) i can globally do that or not.
     #
-    # @returns [String] The HTML content for the container.
+    # @return [String] The HTML content for the container.
     def container(name)
       page_content = instance_variable_get("@_content_for")
       content = page_content[name]

data/app/models/page_route.rb

@@ -24,6 +24,15 @@ class PageRoute < ActiveRecord::Base
 
   after_save :reload_routes
 
+
+  # Determines if its safe to call any persistent methods on PageRoutes. This can be false if either the database doesn't exist,
+  # or the page_routes table doesn't yet exist.
+  #
+  # @return [Boolean] Whether its safe to call any ActiveRecord persistent method or not.
+  def self.can_be_loaded?
+    database_exists? && table_exists?
+  end
+
   # Force Rails to reload the routes. Allows modules to call this without concern that the Rails classes are going to change again.
   def self.reload_routes
     Rails.application.reload_routes!

data/app/models/portlet.rb

@@ -3,8 +3,8 @@ class Portlet < ActiveRecord::Base
   validates_presence_of :name
   is_searchable
 
-  #These are here simply to temporarily hold these values
-  #Makes it easy to pass them through the process of selecting a portlet type
+  # These are here simply to temporarily hold these values
+  # Makes it easy to pass them through the process of selecting a portlet type
   attr_accessor :connect_to_page_id, :connect_to_container
 
   attr_accessor :controller

data/app/models/section.rb

@@ -146,7 +146,7 @@ class Section < ActiveRecord::Base
 
   ##
   # Set which groups are allowed to access this section.
-  # @params [Symbol] code Set of groups to allow (Options :all, :none) Defaults to :none
+  # @param [Symbol] code Set of groups to allow (Options :all, :none) Defaults to :none
   def allow_groups=(code=:none)
     if code == :all
       self.groups = Group.all

data/app/views/cms/form_builder/_cms_text_area.html.erb

@@ -1,4 +1,4 @@
-<div class="fields text_editor_fields">
+<div class="fields textarea_fields">
   <% if cms_options[:label] %>
     <%= f.label method, cms_options[:label] %>
   <% else %>
@@ -6,8 +6,5 @@
   <% end %>
   <br />
   <%= f.text_area method, options %>
-  <% if cms_options[:instructions] %>
-    <div class="instructions"><%=h cms_options[:instructions] %></div>
-    <br clear="all"/>  
-  <% end %>  
+  <%= f.cms_instructions cms_options[:instructions] %>
 </div>

data/app/views/cms/form_builder/_cms_text_editor.html.erb

@@ -15,4 +15,5 @@
   <div class="editor">
     <%= f.text_editor method, options %>
   </div>
+  <%= f.cms_instructions cms_options[:instructions] %>
 </div>

data/app/views/cms/pages/_form.html.erb

@@ -33,14 +33,6 @@
   </div>
 </div>
 
-<div class="fields textarea_fields">
-  <%= f.label :description %>
-  <%= f.text_area :description, :size => "80x5", :tabindex => next_tabindex %>
-</div>
-
-<div class="fields textarea_fields">
-  <%= f.label :keywords %>
-  <%= f.text_area :keywords, :size => "80x3", :tabindex => next_tabindex %>
-</div>
-
+<%= f.cms_text_area :description, :size=>"80x5", :instructions=>"(Optional) Often used for the meta-description element of the page." %>
+<%= f.cms_text_area :keywords, :size=>"80x3", :instructions=>"(Optional) Often used for the meta-keyword meta element of the page. Most search engine will ignore this however." %>
 <%= f.cms_text_field :language %>

data/bin/bcms

@@ -1,6 +1,117 @@
 #!/usr/bin/env ruby
 
-##
-# Just a shorter version of 'browsercms' command.
+require 'rubygems'
+require 'thor'
+require 'term/ansicolor'
+require 'rails/generators/actions'
+require 'active_support/core_ext/string/inflections'
+require 'cms/version'
+
+class String
+  include Term::ANSIColor
+end
+
+
+class App < Thor
+  include Thor::Actions
+  include Rails::Generators::Actions
+  source_root File.expand_path('../../lib/generators/cms/upgrade_module/templates', __FILE__)
+
+  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)"
+  end
+
+  desc "new", "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)
+  end
+
+
+  desc 'demo', "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)
+  end
+
+
+  desc 'module', "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)
+  end
+
+  desc 'version', 'Show BrowserCMS version'
+  map "-v" => :version, "--version" => :version
+  def version
+    puts "BrowserCMS #{Cms::VERSION}"
+  end
+
+  private
+
+  def start_working_in_rails_directory(name)
+    self.destination_root = (File.join(destination_root, name))
+  end
+
+  def create_rails_app(name)
+    rails_cmd = "rails new #{name}"
+    if options[:template]
+      rails_cmd += " -m #{options[:template]}"
+    end
+    if options[:database]
+      rails_cmd += " -d #{options[:database]}"
+    end
+    run(rails_cmd)
+  end
+
+
+  def echo_next_steps(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"
+    environment 'SITE_DOMAIN="localhost:3000"', :env => "development"
+    environment 'SITE_DOMAIN="localhost:3000"', :env => "test"
+    environment 'SITE_DOMAIN="localhost:3000"', :env => "production"
+
+    insert_into_file "config/environments/production.rb", :after => "Application.configure do\n" do
+      <<-CODE
+  config.action_view.cache_template_loading = false
+  config.action_controller.page_cache_directory = Rails.root + '/public/cache/'
+      CODE
+    end
+    initializer 'browsercms.rb', <<-CODE
+Cms.attachment_file_permission = 0640
+    CODE
+
+    generate "cms:template", "default"
+  end
+end
+
+App.start
 
-load File.join(File.dirname(__FILE__), 'browsercms')

data/bin/browsercms

@@ -1,73 +1,4 @@
-#!/usr/bin/env ruby
+##!/usr/bin/env ruby
 
-##
-# A fancy wrapper around 'rails' that creates a BrowserCMS project.
-#
-require File.join(File.dirname(__FILE__), "..", 'lib/command_line')
-require 'optparse'
-
-
-ARGV << "-h" if ARGV.empty?
-
-# Using optsparse primarily for help messages, since most options just get passed directly to rails.
-options = {}
-ARGV.clone.options do |opts|
-  opts.banner =    "Usage: browsercms /path/to/your/cms/project [options]"
-
-  # While Rails supports more databases, BrowserCMS has really only been tested against the following:
-  opts.on("-d", "--database=name", String, "Preconfigure for selected database (options: mysql/postgresql/sqlite3)", "Default: sqlite3")
-  opts.on("-m", "--template=path", String, "BrowserCMS application type to create (options: module, demo)", "Default: blank")
-
-  opts.separator(" ")
-  opts.separator("BrowserCMS Info:")
-  opts.on("-h", "--help", String, "Show this help message and quit.") { puts opts; exit }
-  opts.on("-v", "--version", String, "Shows the rails version number and quit.") { system("rails -v"); exit }
-
-  # These are copy&paste from the 'rails' options. Repeated here because I'm not sure its possible to reuse their options automatically.
-  opts.separator(" ")
-  opts.separator("Rails Options:")
-  opts.on("-r", "--ruby=path", String, "Path to the Ruby binary of your choice (otherwise scripts use env, dispatchers current path).", "Default: /usr/local/bin/ruby")
-  opts.on("-D", "--with-dispatchers", "Add CGI/FastCGI/mod_ruby dispatches code to generated application skeleton", "Default: false")
-  opts.on("-f", "--freeze", "Freeze Rails in vendor/rails from the gems generating the skeleton.", "Default: false")
-  opts.on("-p", "--pretend", "Run but do not make any changes.")
-  opts.on("--force", "--force", "Overwrite files that already exist.")
-  opts.on("-s", "--skip", "Skip files that already exist.")
-  opts.on("-q", "--quiet", "Suppress normal output.")
-  opts.on("-t", "--backtrace", "Debugging: show backtrace on errors.")
-  opts.on("-c", "--svn", "Modify files with subversion. (Note: svn must be in path)")
-  opts.on("-g", "--git", "Modify files with git. (Note: git must be in path)")
-
-  opts.separator(" ")
-  opts.separator("Description:")
-  opts.separator("    The 'browsercms' command creates a new BrowserCMS application with a default directory structure ")
-  opts.separator("    and configuration at the path you specify. It will create and migrate the database with the schema")
-  opts.separator("    and seed data.")
-  opts.separator(" ")
-  opts.separator("Example:")
-  opts.separator("    browsercms ~/projects/website_name")
-  opts.separator("    This generates a blank BrowserCMS project. Suitable for starting a new website project.")
-  opts.separator(" ")
-  opts.separator("    browsercms website_name -m demo")
-  opts.separator("    Generates a BrowserCMS application with a sample demo website. Suitable for learning BrowserCMS.")
-  opts.separator(" ")
-  opts.separator("    browsercms bcms_my_module -m module")
-  opts.separator("    Generates a BrowserCMS module. Used to create code that can be shared between BrowserCMS projects.")
-  opts.separator("    (Note: Module name MUST start with 'bcms_'.)")
-
-  opts.parse!
-end
-
-# Replace short hand versions of the templates with the absolute path on the local machine.
-CommandLine.set_template(ARGV)
-command = (RUBY_PLATFORM =~ /mswin32/ ? "cmd /c " : "")
-command += "rails new #{ARGV.join(" ")}"
-success = system(command)
-
-project_name = ARGV[0]
-if (success)
-  puts "\nCreated new BrowserCMS project '#{project_name}'."
-  puts "    To get started, type 'cd #{project_name}'"
-  puts "    then 'rails server' and open your browser to 'http://localhost:3000'."
-else
-  puts "\n Unable to create BrowserCMS project '#{project_name}'."
-end
+# Alias to bcms CLI
+load File.join(File.dirname(__FILE__), 'bcms')

data/browsercms.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |s|
 
   s.files = Dir["rails/*.rb"]
   s.files += Dir["browsercms.gemspec"]
+  s.files += Dir[".yardopts"]
   s.files += Dir["doc/app/**/*"]
   s.files += Dir["doc/guides/html/**/*"]
   s.files += Dir["app/**/*"]
@@ -29,6 +30,8 @@ Gem::Specification.new do |s|
   s.files += Dir["db/demo/**/*"]
   s.files += Dir["db/seeds.rb"]
   s.files += Dir["lib/**/*"]
+  s.files -= Dir["lib/tasks/cucumber.rake"]
+  s.files -= Dir["lib/tasks/cms.rake"]
   s.files += Dir["public/stylesheets/cms/**/*"]
   s.files += Dir["public/javascripts/jquery*"]
   s.files += Dir["public/javascripts/cms/**/*"]
@@ -36,10 +39,9 @@ Gem::Specification.new do |s|
   s.files += Dir["public/site/**/*"]
   s.files += Dir["public/images/cms/**/*"]
   s.files += Dir["public/themes/**/*"]
-  s.files += Dir["templates/*.rb"]
   s.files -= Dir['test/dummy/*']
 
-  s.add_dependency('rails', "~> 3.0.5")
+  s.add_dependency('rails', "~> 3.0.7")
 
   # Required only for bcms-upgrade
   s.add_dependency('term-ansicolor')

data/lib/cms/behaviors/soft_deleting.rb

@@ -10,9 +10,8 @@ module Cms
           !!@uses_soft_delete
         end
 
-        def handle_missing_table_error_during_startup(e)
-          puts e.inspect
-          Rails.logger.info e.inspect
+        def handle_missing_table_error_during_startup(message, e)
+          Rails.logger.debug "#{message}: #{e.inspect}"
         end
 
         def uses_soft_delete(options={})
@@ -29,9 +28,9 @@ module Cms
           # By default, all queries for blocks should filter out deleted rows.
           begin
             default_scope where(:deleted => false)
-          # This may fail during gem loading, if no DB exists. Log it and move on.
+          # This may fail during gem loading, if no DB or the table does not exist. Log it and move on.
           rescue StandardError => e
-            handle_missing_table_error_during_startup(e)
+            handle_missing_table_error_during_startup("Can't set a default_scope for soft_deleting", e)
           end
         end
       end

data/lib/cms/extensions/active_record/base.rb

@@ -1,6 +1,7 @@
 module Cms
   module Extensions
     module ActiveRecord
+
       module Base
         def updated_on_string(fmt="%b %e, %Y")
           if respond_to?(:updated_at) && updated_at
@@ -10,7 +11,27 @@ module Cms
           end
         end
       end
+
+      module ClassMethods
+        # Determines if the database for this Rails App exists yet. Useful for methods which might be called during
+        # rake tasks or initialize where a database not yet being created is not fatal, but should be ignored.
+        #
+        # @return [Boolean] false if it does not exist.
+        def database_exists?
+          begin
+            connection
+            return true
+          rescue StandardError # Hopefully this works with MySql, MySql2 and SQLite
+            logger.warn "Attempted to establish a connection with the database, but could not do so."
+            return false
+          end
+
+        end
+      end
     end
   end
 end
-ActiveRecord::Base.send(:include, Cms::Extensions::ActiveRecord::Base)
+ActiveRecord::Base.send(:include, Cms::Extensions::ActiveRecord::Base)
+ActiveRecord::Base.extend(Cms::Extensions::ActiveRecord::ClassMethods)
+
+

data/lib/cms/routes.rb

@@ -4,7 +4,7 @@ module Cms::Routes
   # Adds all necessary routes to manage a new content type. Works very similar to the Rails _resources_ method, adding basic CRUD routes, as well as additional ones
   #   for CMS specific routes (like versioning)
   #
-  # @params [Symbol] content_block_name - The plural name of a new Content Type. Should match the name of the content_block, like :dogs or :donation_statuses
+  # @param [Symbol] content_block_name - The plural name of a new Content Type. Should match the name of the content_block, like :dogs or :donation_statuses
   def content_blocks(content_block_name, options={}, & block)
     content_block = content_block_name.to_s.classify.constantize
     resources content_block_name do
@@ -126,16 +126,13 @@ module Cms::Routes
       get 'cache', :to=>'cache#show', :as=>'cache'
       delete 'cache', :to=>'cache#destroy'
 
-      # This is only for testing, and should be moved to the config/routes.rb file eventually.
-#      content_blocks :sample_blocks
-
       match  "/routes", :to => "routes#index", :as=>'routes'
 
     end
 
     # Loads all Cms PageRoutes from the database
     # TODO: Needs a integration/functional level test to verify that a page route w/ constraints will be correctly mapped.
-    if PageRoute.table_exists?
+    if PageRoute.can_be_loaded?
       PageRoute.all(:order => "page_routes.name").each do |r|
         match r.pattern, :to=>r.to, :as=>r.route_name, :_page_route_id=>r.page_route_id, :via=>r.via, :constraints=>r.constraints
       end