bf4-browsercms 3.1.0

data/rails_generators/browser_cms/browser_cms_generator.rb

@@ -0,0 +1,35 @@
+class BrowserCmsGenerator < Rails::Generator::Base
+  #We need to be able to define a different source root for each gem
+  #So we'll just set the baseline source root to "/",
+  #and append the appropriate path when we call file
+  def source_root
+    "/"
+  end
+  def manifest
+    record do |m|
+      #Cms.generator_paths is an Array of Arrays
+      #Each Array has the root as the first element
+      #and the array of "files" as the second element
+      #Each element in files is actually a Dir.glob pattern string
+      Cms.generator_paths.each do |src_root, files|
+         copy_files  m, src_root, files
+      end
+    end
+  end
+  def copy_files(m, src_root, files)
+    dirs = []
+    files.each do |d|
+      Dir[File.join(src_root, d)].each do |f|
+        if File.file?(f)
+          dir = File.dirname(f.gsub("#{src_root}/",''))
+          unless dirs.include?(dir)
+            m.directory dir
+            dirs << dir
+          end
+          relative_dest_file_name = f.gsub("#{src_root}/", "")
+          m.file Cms.scrub_path(f), relative_dest_file_name
+        end
+      end
+    end
+  end
+end

data/rails_generators/browser_cms/templates/README

@@ -0,0 +1 @@
+All the files are copied out of the actual public, lib, and db directories, not here

data/rails_generators/browser_cms_demo_site/USAGE

@@ -0,0 +1 @@
+Will install an example CMS demo site

data/rails_generators/browser_cms_demo_site/browser_cms_demo_site_generator.rb

@@ -0,0 +1,63 @@
+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/rails_generators/browser_cms_demo_site/templates/migration.rb

@@ -0,0 +1,21 @@
+class LoadDemoSiteData < ActiveRecord::Migration
+  extend Cms::DataLoader
+  
+  def self.up
+<%= data %>
+
+    # Create templates
+    <% page_templates.each do |pt| %>
+<%= pt %>
+    <% end %>
+
+    # Create partials
+    <% page_partials.each do |pp| %>
+<%= pp %>
+    <% end %>
+  end
+  
+  def self.down
+  end
+  
+end

data/rails_generators/content_block/USAGE

@@ -0,0 +1,32 @@
+Description:
+    Stubs out a new content block. Pass the content block name, either CamelCased or
+    under_scored, and an optional list of attribute pairs as arguments.
+
+    Attribute pairs are column_name:sql_type arguments specifying the
+    model's attributes. Timestamps are added by default, so you don't have to
+    specify them by hand as 'created_at:datetime updated_at:datetime'. The name:string
+    attribute is also implicitly generated as part of the migration and to the forms,
+    but you can override it by specifying a different type, like name:text.
+
+    This generates a model, controller, several partial views, a migration and tests
+    in the appropriate directories.
+
+Examples:
+    `./script/generate content_block 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.
+
+    `./script/generate content_block 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/rails_generators/content_block/content_block_generator.rb

@@ -0,0 +1,69 @@
+class ContentBlockGenerator < Rails::Generator::NamedBase
+  default_options :skip_timestamps => false, :skip_migration => false
+
+  def manifest
+    record do |m|
+      # Check for class naming collisions.
+      m.class_collisions class_path, class_name
+
+      # Create the content block
+      m.directory File.join('app/models')
+      m.template 'content_block.rb', File.join('app/models', "#{file_name}.rb")
+
+      # Create the unit test for the model
+      m.directory File.join('test/unit/models')
+      m.template 'unit_test.erb', File.join('test/unit/models', "#{file_name}_test.rb")
+      
+      # Create the controller
+      m.directory File.join('app/controllers/cms')
+      m.template 'controller.rb', File.join('app/controllers/cms', "#{file_name.pluralize}_controller.rb")
+
+      # Create the edit form for the content type
+      m.directory File.join('app/views/cms/', file_name.pluralize)
+      m.template '_form.html.erb', File.join('app/views/cms/', file_name.pluralize, "_form.html.erb")
+      m.template 'render.html.erb', File.join('app/views/cms/', file_name.pluralize, "render.html.erb")
+
+      # Create functional test for the controller
+      m.directory File.join('test/functional/cms/')
+      m.template 'functional_test.erb', File.join('test/functional/cms/', "#{file_name.pluralize}_controller_test.rb")
+
+      # Create the routes for the content block
+      logger.route "map.content_blocks :#{file_name.pluralize}"
+      sentinel = 'ActionController::Routing::Routes.draw do |map|'
+      m.gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+        "#{match}\n  map.namespace('cms') {|cms| cms.content_blocks :#{file_name.pluralize} }\n"
+      end
+
+      unless options[:skip_migration]
+        m.migration_template 'migration.rb', 'db/migrate', :assigns => {
+          :migration_name => "Create#{class_name.pluralize.gsub(/::/, '')}",
+        }, :migration_file_name => "create_#{file_path.gsub(/\//, '_').pluralize}"
+      end
+    end
+  end
+
+  protected
+    def banner
+      "Usage: #{$0} #{spec.name} ModelName [field:type, field:type]"
+    end
+
+    def add_options!(opt)
+      opt.separator ''
+      opt.separator 'Options:'
+      opt.on("--skip-migration", 
+             "Don't generate a migration file for this model") { |v| options[:skip_migration] = v }
+    end
+    
+    def route_countent_block(name)
+      resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+      sentinel = 'ActionController::Routing::Routes.draw do |map|'
+
+      logger.route "map.resources #{resource_list}"
+      unless options[:pretend]
+        gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+          "#{match}\n  map.resources #{resource_list}\n"
+        end
+      end
+    end
+    
+end

data/rails_generators/content_block/templates/_form.html.erb

@@ -0,0 +1,22 @@
+<% # This 'unless' can be removed if :name is no longer assumed to be a default attribute.
+   unless attributes.find {|attr| attr.name == 'name'}
+%><%%= f.cms_text_field :name %>
+<% end %>
+<% for attribute in attributes -%>
+<%%= f.cms_<%= 
+case attribute.type
+when :attachment
+  "file_field :#{attribute.name}_file, :label => \"File\""
+when :category
+  "drop_down :category_id, categories_for('#{class_name.titleize}').map{|c| [c.path, c.id]}"
+when :date
+  "date_picker :#{attribute.name}"
+when :datetime
+  "datetime_select :#{attribute.name}"
+when :html
+  "text_editor :#{attribute.name}"
+else
+  "#{attribute.field_type} :#{attribute.name}"
+end 
+-%> %>
+<% end -%>

data/rails_generators/content_block/templates/content_block.rb

@@ -0,0 +1,27 @@
+class <%= class_name %> < ActiveRecord::Base
+  acts_as_content_block
+  <% for attribute in attributes %><%= 
+    case attribute.type
+    when :attachment
+      %Q{belongs_to_attachment
+        
+        def set_attachment_file_path
+          # The default behavior is use /attachments/file.txt for the attachment path,
+          # assuming file.txt was the name of the file the user uploaded
+          # You should override this with your own strategy for setting the attachment path
+          super
+        end
+
+        def set_attachment_section
+          # The default behavior is to put all attachments in the root section
+          # Override this method if you would like to change that
+          super
+        end}
+    when :category
+      "belongs_to_category\n"
+    when :belongs_to
+      "belongs_to :#{attribute.name}\n"
+    end
+%><% end %>
+
+end

data/rails_generators/content_block/templates/controller.rb

@@ -0,0 +1,2 @@
+class Cms::<%= class_name.pluralize %>Controller < Cms::ContentBlockController
+end

data/rails_generators/content_block/templates/functional_test.erb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '/../../test_helper')
+
+class Cms::<%= class_name.pluralize %>ControllerTest < ActionController::TestCase
+
+  test "Add_test_here" do
+
+  end
+
+
+
+end

data/rails_generators/content_block/templates/migration.rb

@@ -0,0 +1,38 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    create_content_table :<%= table_name %> do |t|
+<% for attribute in attributes -%>
+      <%= 
+        case attribute.type
+        when :category
+          @category_type = class_name.titleize
+          "t.belongs_to :category"
+        when :attachment
+          @attachment_section = class_name.titleize
+          "t.belongs_to :attachment" +
+          "\n      t.integer :attachment_version"
+        when :html
+          "t.text :#{attribute.name}, :size => (64.kilobytes + 1)"
+        else
+          "t.#{attribute.type} :#{attribute.name}"
+        end
+      -%> 
+<% end -%>
+    end
+    <% if @category_type %>unless CategoryType.named('<%= @category_type %>').exists?
+      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 %>', :group_ids => Group.all(&:id))
+    end<% end %>
+    ContentType.create!(:name => "<%= class_name %>", :group_name => "<%= class_name %>")
+  end
+
+  def self.down
+    ContentType.delete_all(['name = ?', '<%= class_name %>'])
+    CategoryType.all(:conditions => ['name = ?', '<%= class_name.titleize %>']).each(&:destroy)
+    #If you aren't creating a versioned table, be sure to comment this out.
+    drop_table :<%= table_name.singularize %>_versions
+    drop_table :<%= table_name %>
+  end
+end

data/rails_generators/content_block/templates/render.html.erb

@@ -0,0 +1,14 @@
+<% # This 'unless' can be removed if :name is no longer assumed to be a default attribute.
+   unless attributes.find {|attr| attr.name == 'name'}
+%><p><b>Name:</b> <%%= @content_block.name %></p>
+<% end %>
+<%- for attribute in attributes -%>
+  <%- case attribute.type
+    when :attachment -%>
+<p><b>Attachment:</b> <%%= link_to @content_block.attachment_file_path, @content_block.attachment_link %></p>
+    <%- when :category -%>
+<p><b>Category:</b> <%%= @content_block.category_name %></p>
+    <%- else -%>
+<p><b><%= attribute.name.titleize %>:</b> <%%= @content_block.<%= attribute.name %> %></p>
+  <%- end -%>
+<% end %>

data/rails_generators/content_block/templates/unit_test.erb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '/../../test_helper')
+
+class <%= class_name %>Test < ActiveSupport::TestCase
+
+  test "should be able to create new block" do
+    assert <%= class_name %>.create!
+  end
+  
+end

data/rails_generators/portlet/USAGE

@@ -0,0 +1,37 @@
+Description:
+    Stubs out a new portlet and its views. Pass the portlet name, either CamelCased or
+    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
+    attributes, so don't specify them.
+
+    This generates a portlet class in app/portlets, a form in app/view/portlets and
+    a default view to render the portlet in app/view/portlets, and a unit test in
+    test/unit/portlets.
+    
+    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
+            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`
+
+        A portlet to display a specific number of articles, as specified in the admin UI.
+            Portlet:            app/portlets/find_top_x_articles_portlet.rb
+            Form View:          app/views/portlets/find_top_x_articles/_form.html.erb
+            Default Template:   app/views/portlets/find_top_x_articles/render.html.erb
+            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.

data/rails_generators/portlet/portlet_generator.rb

@@ -0,0 +1,31 @@
+class PortletGenerator < Rails::Generator::NamedBase
+
+  def manifest
+    record do |m|
+      portlet_class_name = "#{class_name}Portlet"
+      portlet_file_name = "#{file_name}_portlet"
+      
+      # Check for class naming collisions.
+      m.class_collisions class_path, portlet_class_name
+
+      # Create the unit test for the model
+      m.directory File.join('test/unit/portlets')
+      m.template 'unit_test.erb', File.join('test/unit/portlets', "#{portlet_file_name}_test.rb")
+
+      # Create the content block
+      m.directory File.join('app/portlets', class_path)
+      m.template 'portlet.rb', File.join('app/portlets', class_path, "#{portlet_file_name}.rb")
+
+      # Create the edit form for the content type
+      m.directory File.join('app/views/portlets', file_name)
+      m.template '_form.html.erb', File.join('app/views/portlets/', file_name, "_form.html.erb")
+      m.template 'render.html.erb', File.join('app/views/portlets/', file_name, "render.html.erb")
+    end
+  end
+
+  protected
+    def banner
+      "Usage: #{$0} #{spec.name} PortletName [field:type, field:type]"
+    end
+
+end

data/rails_generators/portlet/templates/_form.html.erb

@@ -0,0 +1,5 @@
+<%%= f.cms_text_field :name %>
+<% for attribute in attributes -%>
+<%%= f.cms_text_field :<%= attribute.name %> %>
+<% end -%>
+<%%= f.cms_template_editor :template %>

data/rails_generators/portlet/templates/portlet.rb

@@ -0,0 +1,10 @@
+class <%= class_name %>Portlet < Portlet
+
+  # Mark this as 'true' to allow the portlet's template to be editable via the CMS admin UI.
+  enable_template_editor false
+     
+  def render
+    # Your Code Goes Here
+  end
+    
+end