browsercms 3.1.5 → 3.3.0.beta

data/lib/cms/version.rb

@@ -1,6 +1,6 @@
 ##
-# Allows the precise version of BrowserCMS to be determined programmatically.
+# Allows the precise version of BrowserCMS to be determined problematically.
 #
 module Cms
-  VERSION = "3.1.5"
+  VERSION = "3.3.0.beta"
 end

data/lib/generators/browser_cms.rb

@@ -0,0 +1,12 @@
+require 'rails/generators/base'
+
+module BrowserCms
+  module Generators
+    # Base class for generators that work on copying files out of the Gem into projects.
+    class Base < Rails::Generators::Base
+      def self.source_root
+        @_browsercms_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), '../../'))
+      end
+    end
+  end
+end

data/lib/generators/browser_cms/cms/USAGE

@@ -0,0 +1,2 @@
+Description:
+    Copies migrations from the browsercms gem into the application.

data/lib/generators/browser_cms/cms/cms_generator.rb

@@ -0,0 +1,36 @@
+require 'generators/browser_cms'
+module BrowserCms
+  module Generators
+
+    # For creating a new BrowserCMS project (Used in conjunction with the blank, demo and module templates.
+    class CmsGenerator < Base
+
+
+      def enable_static_asset_serving
+        application do
+          code = "# BrowserCMS should serve static CMS assets (js, css, images) from the Gem\n"
+          code = code + "config.serve_static_assets = true"
+        end
+      end
+
+      def copy_migrations_and_custom_js_files
+
+        files_to_copy = [
+        # For FCKEditor customization. Not sure this is even necessary anymore
+        'public/site/customconfig.js',
+
+        # Migrations/seed data
+        'db/migrate/20080815014337_browsercms_3_0_0.rb',
+        'db/migrate/20091109175123_browsercms_3_0_5.rb',
+        'db/seeds.rb'
+        ]
+
+        files_to_copy.each do |file|
+          copy_file file, file
+        end
+
+      end
+
+    end
+  end
+end

data/lib/generators/browser_cms/demo_site/demo_site_generator.rb

@@ -0,0 +1,138 @@
+require 'generators/browser_cms'
+require 'rails/generators/migration'
+module BrowserCms
+  module Generators
+    class DemoSiteGenerator < Base
+      include Rails::Generators::Migration
+      
+      def create_demo_site
+        # Copy all public files
+        Dir["#{Cms.root}/public/themes/blue_steel/**/*"].each do |f|
+          if File.file?(f)
+            file_name = f.sub("#{Cms.root}/", '')
+            directory File.dirname(file_name)
+            copy_file Cms.scrub_path(f), file_name
+          end
+        end
+
+        copy_file 'lib/generators/browser_cms/demo_site/templates/demo_site.rake', 'db/migrate/demo_site.rake'
+
+        template templates_dir('migration.erb'), 'db/demo_site_seeds.rb', :assigns => {
+          :data => data,
+          :page_templates => page_templates,
+          :page_partials => page_partials
+        } 
+               
+      end
+
+      private
+      def templates_dir(file=nil)
+        f = File.expand_path(File.join(File.dirname(__FILE__), "templates", file))
+        Cms.scrub_path(f)
+      end      
+      def data
+        open(File.join(Cms.root, "db", "demo", "data.rb")){|f| f.read}
+      end
+      
+      # Returns an array of strings that are ruby code.
+      # Each string is a hash that should be passed to the create_page_template method
+      # in the migration
+      def page_templates
+        Dir["#{Cms.root}/db/demo/page_templates/*.erb"].map do |f|
+          name, format, handler = File.basename(f).split('.')
+          %Q{create_page_template(:#{name}, 
+            :name => "#{name}", :format => "#{format}", :handler => "#{handler}", 
+            :body => <<-HTML
+    #{open(f){|f| f.read}}
+          HTML
+          )}
+        end
+      end
+      
+      def page_partials
+        Dir["#{Cms.root}/db/demo/page_partials/*.erb"].map do |f|
+          name, format, handler = File.basename(f).split('.')
+          %Q{create_page_partial(:#{name}, 
+            :name => "#{name}", :format => "#{format}", :handler => "#{handler}", 
+            :body => <<-HTML
+    #{open(f){|f| f.read}}
+          HTML
+          )}
+        end
+      end      
+
+      # FIXME: Should be proxied to ActiveRecord::Generators::Base
+      # Implement the required interface for Rails::Generators::Migration.
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+    end
+  end
+end
+# class BrowserCmsDemoSiteGenerator < Rails::Generator::Base
+#   
+#   def source_root
+#     "/"
+#   end
+#   
+#   def templates_dir(file=nil)
+#     f = File.expand_path(File.join(File.dirname(__FILE__), "templates", file))
+#     Cms.scrub_path(f)
+#   end
+#   
+#   def manifest
+#     record do |m|
+#       # Copy all public files
+#       Dir["#{Cms.root}/public/themes/blue_steel/**/*"].each do |f|
+#         if File.file?(f)
+#           file_name = f.sub("#{Cms.root}/", '')
+#           m.directory File.dirname(file_name)
+#           m.file Cms.scrub_path(f), file_name
+#         end
+#       end
+#       
+#       m.migration_template templates_dir('migration.rb'), 'db/migrate', :assigns => {
+#         :data => data,
+#         :page_templates => page_templates,
+#         :page_partials => page_partials
+#       }, :migration_file_name => "load_demo_site_data"
+#       
+#     end
+#   end
+#   
+#   def data
+#     open(File.join(Cms.root, "db", "demo", "data.rb")){|f| f.read}
+#   end
+#   
+#   # Returns an array of strings that are ruby code.
+#   # Each string is a hash that should be passed to the create_page_template method
+#   # in the migration
+#   def page_templates
+#     Dir["#{Cms.root}/db/demo/page_templates/*.erb"].map do |f|
+#       name, format, handler = File.basename(f).split('.')
+#       %Q{create_page_template(:#{name}, 
+#         :name => "#{name}", :format => "#{format}", :handler => "#{handler}", 
+#         :body => <<-HTML
+# #{open(f){|f| f.read}}
+#       HTML
+#       )}
+#     end
+#   end
+#   
+#   def page_partials
+#     Dir["#{Cms.root}/db/demo/page_partials/*.erb"].map do |f|
+#       name, format, handler = File.basename(f).split('.')
+#       %Q{create_page_partial(:#{name}, 
+#         :name => "#{name}", :format => "#{format}", :handler => "#{handler}", 
+#         :body => <<-HTML
+# #{open(f){|f| f.read}}
+#       HTML
+#       )}
+#     end
+#   end
+#   
+# end

data/lib/generators/browser_cms/demo_site/templates/demo_site.rake

@@ -0,0 +1,11 @@
+require 'find'
+
+namespace :db do
+
+  desc 'Load the demo site seed data from db/seeds.rb'
+  task :seed_demo_site => 'db:abort_if_pending_migrations' do
+    demo_seed_file = File.join(Rails.root, 'db', 'demo_site_seeds.rb')
+    load(demo_seed_file) if File.exist?(demo_seed_file)
+  end
+  
+end

data/{rails_generators/browser_cms_demo_site/templates/migration.rb → lib/generators/browser_cms/demo_site/templates/migration.erb}

@@ -1,7 +1,6 @@
-class LoadDemoSiteData < ActiveRecord::Migration
-  extend Cms::DataLoader
+require 'cms/data_loader'
+include Cms::DataLoader
   
-  def self.up
 <%= data %>
 
     # Create templates
@@ -13,9 +12,4 @@ class LoadDemoSiteData < ActiveRecord::Migration
     <% page_partials.each do |pp| %>
 <%= pp %>
     <% end %>
-  end
   
-  def self.down
-  end
-  
-end

data/lib/generators/cms/content_block/USAGE

@@ -0,0 +1,22 @@
+Description:
+    Create a new content block, along with controller, tests and migrations.
+
+Examples:
+    `rails generate cms:content article`
+
+        Creates an Article model, controller, views, tests, and migration:
+            Model:              app/models/article.rb
+            Unit Test:          test/unit/models/article_test.rb
+            Migration:          db/migrate/XXX_create_article.rb
+            Controller:         app/controllers/cms/article_controller.rb
+            Functional Test:    test/functional/cms/article_controler_test.rb
+            Form Partials:      app/views/cms/articles/_form.html.erb
+                                app/views/cms/articles/render.html.erb
+
+        This block will have a single attribute, name:string and a form with text_field
+        to edit the name.
+
+    `rails generate content Article name:string body:text published:boolean`
+
+        Creates an Article model with a string name, text body, and published flag.
+        It will create form fields for these attributes in _form.html.erb.

data/lib/generators/cms/content_block/content_block_generator.rb

@@ -0,0 +1,55 @@
+require 'rails/generators/active_record/migration'
+
+module Cms
+  module Generators
+    # Allows developers to create new Content Blocks for their projects.
+    #
+    class ContentBlockGenerator < Rails::Generators::NamedBase
+
+      source_root File.expand_path('../templates', __FILE__)
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+      class_option :migration, :type => :boolean, :default=>true
+
+      include Rails::Generators::Migration
+      extend ActiveRecord::Generators::Migration
+
+      # Don't check for class collision as overwriting content blocks is fine.
+      # check_class_collision
+
+      def create_content_block
+        template 'content_block.rb', File.join('app/models', "#{file_name}.rb")
+      end
+
+      def create_model_test
+        template 'unit_test.erb', File.join('test', 'unit', 'models', "#{file_name}_test.rb")
+      end
+
+      def create_controller_and_views
+        template 'controller.rb', File.join('app/controllers/cms', "#{file_name.pluralize}_controller.rb")
+        template '_form.html.erb', File.join('app/views/cms/', file_name.pluralize, "_form.html.erb")
+        template 'render.html.erb', File.join('app/views/cms/', file_name.pluralize, "render.html.erb")
+      end
+
+      def create_functional_test
+        template 'functional_test.erb', File.join('test/functional/cms/', "#{file_name.pluralize}_controller_test.rb")
+      end
+
+      def create_routes
+        route "namespace :cms  do content_blocks :#{file_name.pluralize} end\n"
+      end
+
+      def create_migration_file
+        return unless options[:migration]
+        migration_template "migration.erb", "db/migrate/create_#{table_name}.rb"
+      end
+
+      private
+
+      # Used by migration.rb to fill in class name.
+      def migration_name
+        "Create#{class_name.pluralize.gsub(/::/, '')}"
+      end
+
+    end
+  end
+end

data/{rails_generators/content_block/templates/migration.rb → lib/generators/cms/content_block/templates/migration.erb}

@@ -23,7 +23,7 @@ class <%= migration_name %> < ActiveRecord::Migration
       CategoryType.create!(:name => "<%= @category_type %>")
     end<% end %>
     <% if @attachment_section %>unless Section.with_path('/<%= file_name.pluralize %>').exists?
-      Section.create!(:name => "<%= @attachment_section %>", :parent => Section.system.first, :path => '/<%= file_name.pluralize %>', :allow_groups=>:all)
+      Section.create!(:name => "<%= @attachment_section %>", :parent => Section.system_section.first, :path => '/<%= file_name.pluralize %>', :allow_groups=>:all)
     end<% end %>
     ContentType.create!(:name => "<%= class_name %>", :group_name => "<%= class_name %>")
   end

data/lib/generators/cms/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Installs the given module into your current browsercms project.
+
+Example:
+    rails generate cms:install_module bcms_name_of_module
+
+    This will create:
+        what/will/it/create

data/lib/generators/cms/install/install_generator.rb

@@ -0,0 +1,20 @@
+require 'generators/browser_cms/cms/cms_generator'
+
+module Cms
+
+  # A generic generator for installing BrowserCMS modules into a project. This will do the following:
+  #
+  # 1. Add the Gem to your Gemfile
+  # 2. Call the name_of_module:install generator for that gem.
+  # 3. Add the routes to the project
+  class InstallGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('../templates', __FILE__)
+
+    def add_and_install_module
+      gem name
+      generate("#{name}:install")
+      route "routes_for_#{name}"
+    end
+
+  end
+end

data/{rails_generators → lib/generators/cms}/portlet/USAGE

@@ -3,7 +3,7 @@ Description:
     under_scored, and an optional list of attribute pairs as arguments.
 
     Attribute pairs are column_name:sql_type arguments specifying the
-    model's attributes. By default, portlets include name:string and template:text
+    model's attributes. By default, portlets includes a Name (String) and template (Template Editor)
     attributes, so do not specify them.
 
     This generates a portlet class in app/portlets, a form in app/view/portlets and
@@ -13,20 +13,7 @@ Description:
     The name you supply will have "portlet" added to it, much the same way controllers work.
 
 Example:
-    `./script/generate portlet ListRecentArticles`
-
-        A portlet to find and display a list of recent Article blocks.
-            Portlet:            app/portlets/list_recent_articles_portlet.rb
-            Helper:             app/portlets/helpers/list_recent_articles_portlet_helper.rb
-            Form View:          app/views/portlets/list_recent_articles/_form.html.erb
-            Default Template:   app/views/portlets/list_recent_articles/render.html.erb
-            Unit Test:          test/unit/portlets/list_recent_articles_portlet_test.rb
-
-        The _form.html.erb will have two fields, a text_field for name, and text_area for
-        the default template, which will plug in whatever is in render.html.erb.
-
-Example with attributes:
-    `./script/generate portlet find_top_x_articles number_to_show:integer description:string`
+    `rails generate cms:portlet find_top_x_articles number_to_show:integer description:string`
 
         A portlet to display a specific number of articles, as specified in the admin UI.
             Portlet:            app/portlets/find_top_x_articles_portlet.rb
@@ -36,4 +23,4 @@ Example with attributes:
             Unit Test:          test/unit/portlets/find_top_x_articles_portlet_test.rb
 
         The _form.html.erb will have text_fields for name, number_to_show and description, as
-        well as a text_area for template.
+        well as a template_editor for template.

data/lib/generators/cms/portlet/portlet_generator.rb

@@ -0,0 +1,38 @@
+module Cms
+  module Generators
+    class PortletGenerator < Rails::Generators::NamedBase
+
+      source_root File.expand_path('../templates', __FILE__)
+      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+      check_class_collision
+
+      def create_portlet
+        template 'portlet.rb', File.join('app/portlets', class_path, "#{portlet_file_name}.rb")
+      end
+
+      def create_helper
+        template 'portlet_helper.rb', File.join('app/portlets/helpers', class_path, "#{portlet_file_name}_helper.rb")
+      end
+
+      def create_views
+        template '_form.html.erb', File.join('app/views/portlets/', file_name, "_form.html.erb")
+        template 'render.html.erb', File.join('app/views/portlets/', file_name, "render.html.erb")
+      end
+
+      def create_tests
+        template 'unit_test.erb', File.join('test/unit/portlets', "#{portlet_file_name}_test.rb")
+      end
+
+      private
+
+      def portlet_class_name
+        "#{class_name}Portlet"
+      end
+
+      def portlet_file_name
+        "#{file_name}_portlet"
+      end
+    end
+  end
+end
+