RubyGems - mhs-bcms_content_rotator - Versions diffs - 1.1.0 - Mend

mhs-bcms_content_rotator 1.1.0

Files changed (18) hide show

data/README.markdown +34 -0
data/app/controllers/application_controller.rb +10 -0
data/app/controllers/cms/slides_controller.rb +2 -0
data/app/helpers/application_helper.rb +3 -0
data/app/models/slide.rb +7 -0
data/app/portlets/content_rotator_portlet.rb +23 -0
data/app/portlets/helpers/content_rotator_portlet_helper.rb +5 -0
data/app/views/cms/slides/_form.html.erb +5 -0
data/app/views/cms/slides/render.html.erb +5 -0
data/app/views/layouts/templates/default.html.erb +18 -0
data/app/views/portlets/content_rotator/_form.html.erb +10 -0
data/app/views/portlets/content_rotator/render.html.erb +64 -0
data/db/migrate/20101111030324_create_slides.rb +21 -0
data/db/migrate/20110407193952_add_link_url_to_slide.rb +9 -0
data/lib/bcms_content_rotator.rb +1 -0
data/lib/bcms_content_rotator/routes.rb +7 -0
data/rails/init.rb +5 -0
metadata +64 -0

data/README.markdown ADDED Viewed

@@ -0,0 +1,34 @@
+# Content Rotator Module for BrowserCMS
+This module allows editors to create a rotating jquery based slideshow. Each rotator can have up to five slides, which can feature an image, title and text that can auto rotate, or allow users to click on a specific slide to view it. It is commonly used on home pages to feature lots of content within a small area, with some visual interest due to the rotation.
+## Features
+* _Rotator_ - Allows up to five slides in rotation. Staff can choose to enable autorotation, as well as how long between each slide.
+* _Slides_ - Each slide represents a single frame within the rotation.
+* _Preloading Slides_ - Editors can create as many slides as they like, and choose which slides should appear in the rotation and in what order.
+### Slide Content Type
+Each slide can consists of the following attributes:
+* Title (String)
+* Alt Text (String)
+* Image URL (URL)
+* Description (Html)
+* Link Url (URL) - Determines where the user goes when they click the slide.
+## Installation
+Follow the standard bcms module installation found here: http://guides.browsercms.org/installing_modules.html
+Since this module relies on jquery, manually the javascript_include_tag to your page templates for any page that the slide show will appear on, like so:
+	<head>
+	    ...
+		<%= javascript_include_tag 'jquery' %>
+		<%= yield :html_head %>
+	</head>
+Once this is complete, you can add a new "Content Rotator Portlet" to any page. Create several slides, and edit the content rotator to choose the order.

data/app/controllers/application_controller.rb ADDED Viewed

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/controllers/cms/slides_controller.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ class Cms::SlidesController < Cms::ContentBlockController
2	+ end

data/app/helpers/application_helper.rb ADDED Viewed

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/app/models/slide.rb ADDED Viewed

@@ -0,0 +1,7 @@
+class Slide < ActiveRecord::Base
+  acts_as_content_block
+  def has_link?
+    !link_url.blank?
+  end
+end

data/app/portlets/content_rotator_portlet.rb ADDED Viewed

@@ -0,0 +1,23 @@
+class ContentRotatorPortlet < Portlet
+  # Mark this as 'true' to allow the portlet's template to be editable via the CMS admin UI.
+  enable_template_editor true
+  def render
+    # Collect the list of slide_ids
+    @slide_ids = []
+    (1..5).each do |i|
+      s_id = self.send("slide_#{i}_id")
+      @slide_ids << s_id.to_i if (s_id && !s_id.empty?)
+    end
+    unsorted_slides = Slide.find(@slide_ids)
+    # Sort slides into explicit order based on slide_ids
+    @slides = []
+    @slide_ids.each do |id|
+      @slides << unsorted_slides.select{|item| item.id == id}.first
+    end
+  end
+end

data/app/portlets/helpers/content_rotator_portlet_helper.rb ADDED Viewed

@@ -0,0 +1,5 @@
+##
+# All methods from this helper will be available in the render.html.erb for ContentRotatorPortlet
+module ContentRotatorPortletHelper
+end

data/app/views/cms/slides/_form.html.erb ADDED Viewed

@@ -0,0 +1,5 @@
+<%= f.cms_text_field :name %>
+<%= f.cms_text_field :image_url, :label=>"Image URL" %>
+<%= f.cms_text_field :alt_text %>
+<%= f.cms_text_field :link_url, :label=>"Link URL", :instructions=>"Set a URL (http://...) here to make the slide clickable, leave blank otherwise." %>
+<%= f.cms_text_editor :description %>

data/app/views/cms/slides/render.html.erb ADDED Viewed

@@ -0,0 +1,5 @@
+<p><b>Name:</b> <%= h @content_block.name %></p>
+<p><b>Image Url:</b> <%= h @content_block.image_url %></p>
+<p><b>Alt Text:</b> <%= h @content_block.alt_text %></p>
+<p><b>Description:</b> <%= @content_block.description %></p>
+<p><b>Link Url:</b> <%= @content_block.link_url %>

data/app/views/layouts/templates/default.html.erb ADDED Viewed

@@ -0,0 +1,18 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+    <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.3.2/jquery.min.js"></script>
+    <title><%= page_title %></title>
+    <%= yield :html_head %>
+  </head>
+  <body style="margin: 0; padding: 0; text-align: center;">
+    <%= cms_toolbar %>
+    <div id="wrapper" style="width: 700px; margin: 0 auto; text-align: left; padding: 30px">
+      Breadcrumbs: <%= render_breadcrumbs %>
+      Main Menu: <%= render_menu %>
+      <h1><%= page_title %></h1>
+      <%= container :main %>
+    </div>
+  </body>
+</html>

data/app/views/portlets/content_rotator/_form.html.erb ADDED Viewed

@@ -0,0 +1,10 @@
+<% @slides = Slide.all %>
+<%= f.cms_text_field :name %>
+<%= f.cms_drop_down :slide_1_id, @slides.map{|c| [c.name, c.id.to_s]}, :label=>"Slide 1", :include_blank=>"[No slide selected]" %>
+<%= f.cms_drop_down :slide_2_id, @slides.map{|c| [c.name, c.id.to_s]}, :label=>"Slide 2", :include_blank=>"[No slide selected]" %>
+<%= f.cms_drop_down :slide_3_id, @slides.map{|c| [c.name, c.id.to_s]}, :label=>"Slide 3", :include_blank=>"[No slide selected]" %>
+<%= f.cms_drop_down :slide_4_id, @slides.map{|c| [c.name, c.id.to_s]}, :label=>"Slide 4", :include_blank=>"[No slide selected]" %>
+<%= f.cms_drop_down :slide_5_id, @slides.map{|c| [c.name, c.id.to_s]}, :label=>"Slide 5", :include_blank=>"[No slide selected]" %>
+<%= f.cms_check_box :autorotate, :label => "Automatically rotate" %>
+<%= f.cms_text_field :rotate_interval, :label => "Rotation delay", :instructions => "in seconds (has no effect if autorotate is off)" %>
+<%= f.cms_template_editor :template %>

data/app/views/portlets/content_rotator/render.html.erb ADDED Viewed

@@ -0,0 +1,64 @@
+<script type="text/javascript">
+//<![CDATA[
+$(function() {
+  var slides = $('#slides div.slide'),
+      currentItem = 0,
+      rotateInterval = <%= @portlet.rotate_interval.to_i %> * 1000,
+      autorotate = <%= @portlet.autorotate %>,
+      runSlideShow = function() {
+        var item = $('#slides ul#controls li a:eq('+currentItem+')');
+          if (item.length) {
+            item.trigger('click', ['timer']);
+            currentItem++;
+          } else {
+            currentItem = 0;
+          }
+      },
+      selectSlide = function(e) {
+        if ($(this).parent().hasClass('on')) {
+          return false;
+        } else {
+          $('#slides ul#controls li').removeClass('on');
+          $(this).parent().addClass('on');
+          slides.hide();
+          slides.filter(this.hash).show();
+          return false;
+        }
+      };
+  slides.hide();
+  slides.filter(':first').show();
+  $('#slides #controls li').filter(':first').addClass('on');
+  $('#slides ul#controls li a').bind('click', {}, selectSlide).
+    each(function(i) { this.slideIndex=i; });
+  if (autorotate) {
+    setInterval(runSlideShow, (rotateInterval < 1000 ? 1000 : rotateInterval));
+  }
+});
+//]]>
+</script>
+<div id="slides">
+  <ul id="controls">
+    <% @slides.each_with_index do |slide, i| %>
+        <li><a href="#slide-<%= i %>"><%= h slide.name %></a></li>
+    <% end %>
+  </ul>
+  <% @slides.each_with_index do |slide, i| %>
+      <div id="slide-<%= i %>" class="slide">
+        <div class="info">
+          <div class="pad">
+            <h3><%= h slide.name %></h3>
+            <%= slide.description %>
+          </div>
+        </div>
+        <% unless slide.image_url.blank? %>
+          <%= link_to_if(slide.has_link?, image_tag(slide.image_url, :alt => h(slide.alt_text)), slide.link_url) %>
+        <% end %>
+      </div>
+  <% end %>
+</div>

data/db/migrate/20101111030324_create_slides.rb ADDED Viewed

@@ -0,0 +1,21 @@
+class CreateSlides < ActiveRecord::Migration
+  def self.up
+    create_content_table :slides do |t|
+      t.string :name
+      t.string :image_url
+      t.string :alt_text
+      t.text :description
+    end
+    ContentType.create!(:name => "Slide", :group_name => "Content Rotator")
+  end
+  def self.down
+    ContentType.delete_all(['name = ?', 'Slide'])
+    CategoryType.all(:conditions => ['name = ?', 'Slide']).each(&:destroy)
+    #If you aren't creating a versioned table, be sure to comment this out.
+    drop_table :slide_versions
+    drop_table :slides
+  end
+end

data/db/migrate/20110407193952_add_link_url_to_slide.rb ADDED Viewed

@@ -0,0 +1,9 @@
+class AddLinkUrlToSlide < ActiveRecord::Migration
+  def self.up
+    add_content_column :slides, :link_url, :string
+  end
+  def self.down
+    remove_column :slides, :link_url
+  end
+end

data/lib/bcms_content_rotator.rb ADDED Viewed

	@@ -0,0 +1 @@
1	+ require 'bcms_content_rotator/routes'

data/lib/bcms_content_rotator/routes.rb ADDED Viewed

@@ -0,0 +1,7 @@
+module Cms::Routes
+  def routes_for_bcms_content_rotator
+    namespace(:cms) do
+      content_blocks :slides
+    end
+  end
+end

data/rails/init.rb ADDED Viewed

@@ -0,0 +1,5 @@
+require 'browsercms'
+gem_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Cms.add_to_rails_paths gem_root
+Cms.add_generator_paths gem_root, "db/migrate/[0-9]*_*.rb"
+Cms.add_generator_paths gem_root, "public/bcms/content_rotator/**/*"

metadata ADDED Viewed

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: mhs-bcms_content_rotator
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease:
+platform: ruby
+authors:
+- BrowserMedia
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2011-09-12 00:00:00.000000000Z
+dependencies: []
+description: A BrowserCMS module for creating a Slideshow/Homepage rotator designed
+  to showcase site content using jQuery.
+email: github@browsermedia.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.markdown
+files:
+- app/controllers/application_controller.rb
+- app/controllers/cms/slides_controller.rb
+- app/helpers/application_helper.rb
+- app/models/slide.rb
+- app/portlets/content_rotator_portlet.rb
+- app/portlets/helpers/content_rotator_portlet_helper.rb
+- app/views/cms/slides/_form.html.erb
+- app/views/cms/slides/render.html.erb
+- app/views/layouts/templates/default.html.erb
+- app/views/portlets/content_rotator/_form.html.erb
+- app/views/portlets/content_rotator/render.html.erb
+- db/migrate/20101111030324_create_slides.rb
+- db/migrate/20110407193952_add_link_url_to_slide.rb
+- lib/bcms_content_rotator.rb
+- lib/bcms_content_rotator/routes.rb
+- rails/init.rb
+- README.markdown
+homepage: https://github.com/browsermedia/bcms_content_rotator
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: mhs-bcms_content_rotator
+rubygems_version: 1.8.8
+signing_key:
+specification_version: 3
+summary: A BrowserCMS for creating a Slideshow/Homepage rotator designed to showcase
+  site content using jQuery.
+test_files: []