bcms_mobile 1.0.0

data/Gemfile

@@ -0,0 +1,19 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.11'
+
+gem 'sqlite3'
+
+
+group :test do
+  gem 'cucumber-rails'
+  gem 'database_cleaner'
+  # gem 'cucumber-browsercms' # This is what I want
+  gem 'bcms_support', :path=>"~/projects/bcms_support"
+
+  gem 'mocha'
+  gem 'launchy'
+  gem 'factory_girl_rails'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.markdown

@@ -0,0 +1,107 @@
+# Mobile Module for BrowserCMS
+
+A 'Mobile First' module that allows any BrowserCMS page to be served in a mobile optimized format for specific mobile devices. Pages can have mobile optimized templates that can reduce their download weight and layout for reduced screen/bandwidth platforms.
+
+## Features
+
+* Developers can define a mobile template for any existing .html.erb template on a project. These template are named the same as the existing templates, but are placed in a separate layouts/mobile directory.
+* View as Mobile: Editors should be able to preview the mobile templates. Once in 'mobile' mode, all pages should be viewed as mobile until they disable it.
+* Mobile assumes a m. subdomain will exist. It will return the mobile template for all requests to pages on that domain.
+* Fallback Templates: If page uses a template which has no mobile counterpart, it will display using its normal template.
+* Agent Redirection: Users on mobile devices can be automatically redirected to the m. site. (Handled via Apache User Agent detection.)
+* Mobile Site Opt Out: Users on mobile device can opt to be redirected to the desktop site if they want. (Handled via a cookie)
+* Mobile caching: The mobile and full sites have their own separate page cache, mean both can be served quickly by Apache.
+
+## Installation
+
+To install bcms_mobile, run the following commands in your browsercms project:
+
+```
+$ gem install bcms_mobile
+$ rails g cms:install bcms_mobile
+```
+
+This will add a new directory to the project, `app/views/layouts/mobile`. Delete the following line from your config/production.rb file:
+```
+# Delete this next line as it won't work if you make changes
+config.action_controller.page_cache_directory = File.join(Rails.root, 'public', 'cache')
+```
+
+### Configuring the Cache Directories
+
+Since this module requires a separate top level domain in production (m.), it needs a separate page cache from the 'full' site version. By default, these will be:
+
+public/cache -> Full site cache
+public/mobile_cache -> Mobile Cache
+
+To configure these directories, you can specify new locations in the production.rb via:
+
+```
+config.bcms_mobile_cache_directory = File.join(Rails.root, 'public', 'cache' 'mobile')
+config.browsercms_cache_directory = File.join(Rails.root, 'public', 'cache', 'full')
+```
+
+However, the defaults will be used even if you don't specify the cache directories.
+
+## Making a Mobile Template
+
+To make a mobile template, you can then copy any page template from your `app/views/layouts/templates` into the mobile directory. The file name should be the same. Make any necessary edits to 'mobilize' it (i.e. remove sidebars, image, etc). When you view a page in the CMS, you can toggle between the mobile and desktop templates.
+
+### Add Full/Mobile Site links
+
+Because the module will automatically redirect mobile users to the mobile site, they may want to visit the full site. So make sure they are conveniently placed on both mobile and full templates. You can do this with the following helpers:
+
+<%= link_to "See the Full Site", full_site_url %>
+<%= link_to "See the Mobile Site", mobile_site_url %>
+
+
+## Development
+
+### Things to improve
+
+* The Apache conf file has way too much logic in it. Specifically, the device types and matching rules really can't be tested, at all. We also have to have a 3rd virtual host for the m. site which isn't so hot.
+
+### Resources
+
+Mobilette - https://github.com/tscolari/mobylette
+Using m.subdomains - http://erniemiller.org/2011/01/05/mobile-devices-and-rails-maintaining-your-sanity/
+Presentation on Rails for Subdomains - http://www.slideshare.net/alberto.perdomo/rails-for-mobile-devices-conferencia-rails-2011-8613648
+Apache Mobile Filters - http://webdirect.no/mobile/apache-rewrite-rule-for-iphone-users/
+RailsCast - http://railscasts.com/episodes/199-mobile-devices?view=comments
+
+http://ryanbigg.com/2009/04/how-rails-works-2-mime-types-respond_to/
+http://blog.bigbinary.com/2010/11/23/mime-type-resolution-in-rails.html
+Verify if views exist - http://stackoverflow.com/questions/2853355/check-if-a-layout-exists-in-rails
+
+Excellent Cookie Setting solution for Apache: http://www.phillipadsmith.com/2011/11/note-to-self-a-simple-way-to-accomplish-mobile-site-redirection-using-mod-rewrite.html
+Modern Mobile Detection - http://ohryan.ca/blog/2011/01/21/modern-mobile-redirect-using-htaccess/
+Using Apache for User Agent/Detection - http://mobiledrupal.com/simple-apache-configuration-file-mobile-device-detection
+http://ohryan.ca/blog/2011/01/21/modern-mobile-redirect-using-htaccess/
+
+### Getting setup
+
+Working on the bcms_mobile and getting accurate testing requires subdomains enabled locally. If you [set up POW](http://pow.cx/), you can use the basic subdomains.
+
+Steps:
+
+```
+$ gem install powder
+$ cd bcms_mobile
+$ powder link bcms-mobile
+```
+
+This will make the following subdomains available for testing.
+
+m.bcms-mobile.dev
+www.bcms-mobile.dev
+cms.bcms-mobile.dev
+
+## Testing Agent Redirection with Passenger/Apache
+
+Using POW will not enable Agent Redirection, since that is configured via Apache. To adequately test this, you will need to enable Apache/Passenger and configure the virtual hosts as [documented here](https://github.com/browsermedia/bcms_mobile/wiki/Configuring-Apache). On OSX, you can can create a new file called /private/etc/apache2/other/bcms_mobile.conf . This [page here](https://github.com/browsermedia/bcms_mobile/wiki/Developing-bcms_mobile) has a sample configuration file
+
+To get configuration right, need Apache/Passenger so you can fool around with Apache specific rewrite rules. See these instructions for setting up Passenger on OSX.
+
+- http://www.robbyonrails.com/articles/2009/02/11/switch-to-passenger-mod_rails-in-development-on-osx-in-less-than-7-minutes-or-your-money-back
+- http://www.fngtps.com/2008/using-passenger-on-osx-for-rails-development/
+

data/app/views/bcms_mobile/_mobile_toggle.html.erb

@@ -0,0 +1,31 @@
+<style>
+    #mobile_toggle {
+        float: left;
+        text-transform: uppercase;
+        padding-left: 110px;
+        margin-top: 12px;
+        margin-right: 0px;
+        color: black;
+        font-weight: bold;
+        width: 200px;
+    }
+
+    #mobile_toggle div {
+        float: left;
+    }
+</style>
+<%
+   mobile_state = session[:mobile_mode] == true ? "ON" : "OFF"
+   button_text = session[:mobile_mode] == true ? "TURN OFF" : "TURN ON"
+   new_template = session[:mobile_mode] == true ? "full" : "mobile"
+%>
+
+<div id="mobile_toggle">
+  <div class="visual_editor_label">View As Mobile?:</div>
+  <div class="visual_editor_value_container">
+    <div><span id="visual_editor_state"><%= mobile_state %></span></div>
+  </div>
+  <div class="visual_editor_toggle_container">
+    <div class="sm_button"><%= link_to "<span id='visual_editor_action'>#{button_text}</span>".html_safe, "#{@page.path}?template=#{new_template}", :target => "_top", :class => "sm_button" %></div>
+  </div>
+</div>

data/app/views/layouts/_page_toolbar.html.erb

@@ -0,0 +1,121 @@
+<% if (logged_in? && @page && !@hide_page_toolbar) %>
+    <% status = @page.live? ? 'published' : 'draft' %>
+    <%= image_tag "cms/page_toolbar/page_toolbar_l.gif", :style => "float: left;" %>
+    <%= image_tag "cms/page_toolbar/status_#{status}_l.gif", :style => "float: left;" %>
+    <%= image_tag "cms/page_toolbar/page_toolbar_r.gif", :style => "float: right;" %>
+    <div id="page_toolbar">
+      <div id="status_div" class="<%= status %> page_attribute_div">
+        <div class="page_attribute_label">Status:</div>
+        <div id="<%= status %>_page_status_container" class="page_attribute_value_container">
+          <%= image_tag "cms/page_toolbar/page_toolbar_inset_#{ status }_l.gif", :style => "float: left;" %>
+          <div id="page_status" class="page_attribute_value"><%= status %></div>
+          <%= image_tag "cms/page_toolbar/page_toolbar_inset_#{ status }_r.gif", :style => "float: left;" %>
+        </div>
+      </div>
+      <div class="page_attribute_div">
+        <div class="page_attribute_label">Section:</div>
+        <div class="page_attribute_value_container">
+          <%= image_tag "cms/page_toolbar/page_toolbar_inset_l.gif", :style => "float: left;" %>
+          <div id="section_link" class="page_attribute_value"><%= link_to h(@page.section.name), cms_sections_path(:page_id => @page), :target => "_top" %></div>
+          <%= image_tag "cms/page_toolbar/page_toolbar_inset_r.gif", :style => "float: left;" %>
+        </div>
+      </div>
+      <div class="page_attribute_div">
+        <div class="page_attribute_label">Page:</div>
+        <div class="page_attribute_value_container">
+          <%= image_tag "cms/page_toolbar/page_toolbar_inset_l.gif", :style => "float: left;" %>
+          <div class="page_attribute_value"><%= h(@page.name) %></div>
+          <%= image_tag "cms/page_toolbar/page_toolbar_inset_r.gif", :style => "float: left;" %>
+        </div>
+      </div>
+      <div class="page_attribute_div">
+        <div class="page_attribute_label">Template:</div>
+        <div class="page_attribute_value_container">
+          <%= image_tag "cms/page_toolbar/page_toolbar_inset_l.gif", :style => "float: left;" %>
+          <div class="page_attribute_value"><%= h(@page.template_name) %></div>
+          <%= image_tag "cms/page_toolbar/page_toolbar_inset_r.gif", :style => "float: left;" %>
+        </div>
+      </div>
+      <div class="page_attribute_div">
+        <div class="page_attribute_label">Version:</div>
+        <div class="page_attribute_value_container">
+          <%= image_tag "cms/page_toolbar/page_toolbar_inset_l.gif", :style => "float: left;" %>
+          <div class="page_attribute_value"><%= h(@page.version) %><%= ' (LIVE)' if @page.live_version && @page.version == @page.live_version.version %></div>
+          <%= image_tag "cms/page_toolbar/page_toolbar_inset_r.gif", :style => "float: left;" %>
+        </div>
+      </div>
+    </div>
+    <div class="buttons">
+
+      <%= link_to "<span>Publish</span>".html_safe,
+                  @page.live? ? '#' : publish_cms_page_path(@page),
+                  :id => "publish_button",
+                  :class => "http_put button#{' disabled' if !current_user.able_to?(:publish_content) || !current_user.able_to_edit?(@page) || @page.version != @page.draft.version || @page.live?} left",
+                  :target => "_top" %>
+
+      <%= link_to "<span>Assign</span>".html_safe,
+                  new_cms_page_task_path(@page),
+                  :id => "assign_button",
+                  :class => "button#{ ' disabled' if @page.assigned_to == current_user || !current_user.able_to_edit?(@page) } middle",
+                  :target => "_top" %>
+
+      <%= link_to "<span>Complete Task</span>".html_safe,
+                  @page.current_task ? complete_cms_task_path(@page.current_task) : '#',
+                  :id => "complete_task_button",
+                  :class => "http_put button#{ ' disabled' if @page.assigned_to != current_user || !current_user.able_to_edit?(@page) } right",
+                  :target => "_top" %>
+
+      <%= link_to "<span>Edit Properties</span>".html_safe,
+                  [:edit, :cms, @page],
+                  :id => "edit_properties_button",
+                  :class => "spacer button#{ ' disabled' unless current_user.able_to_edit?(@page) }",
+                  :target => "_top" %>
+
+      <%= link_to "<span>List Versions</span>".html_safe,
+                  versions_cms_page_path(@page),
+                  :class => "spacer button#{ ' disabled' unless current_user.able_to_edit?(@page) }",
+                  :target => "_top" %>
+
+      <%= able_to? :publish_content do %>
+          <% if @page.draft_version? %>
+              <%= link_to "<span><span class=\"delete_img\">&nbsp;</span>Delete</span>".html_safe,
+                          [:cms, @page],
+                          :id => "delete_button",
+                          :title => "Are you sure you want to delete '#{@page.name}'?",
+                          :target => "_top",
+                          :class => "spacer button confirm_with_title http_delete#{ ' disabled' unless current_user.able_to_publish?(@page) }" %>
+          <% else %>
+              <%= link_to "<span>Revert to this Version</span>".html_safe,
+                          revert_to_cms_page_path(@page, @page.version),
+                          :id => "revert_button",
+                          :class => "button http_put",
+                          :target => "_top" %>
+          <% end %>
+      <% end %>
+      <%= render :partial => "bcms_mobile/mobile_toggle" %>
+      <div id="visual_editor_toggle">
+        <% if @page.version == @page.draft.version %>
+            <div class="visual_editor_label">Visual Editor:</div>
+            <div class="visual_editor_value_container">
+              <% if @mode == "edit" %>
+                  <div>
+                    <span id="visual_editor_state"<%= ' title="You don\'t have permission to edit this page"' unless current_user.able_to_edit?(@page) %>>ON<%= '*' unless current_user.able_to_edit?(@page) %></span>
+                  </div>
+              <% else %>
+                  <div><span id="visual_editor_state">OFF</span></div>
+              <% end %>
+            </div>
+            <div class="visual_editor_toggle_container">
+              <% if @mode == "edit" %>
+                  <div class="sm_button"><%= link_to '<span id="visual_editor_action">TURN OFF</span>'.html_safe, url_with_mode(request.referrer, "view"), :target => "_top", :class => "sm_button" %></div>
+              <% else %>
+                  <div class="sm_button"><%= link_to '<span id="visual_editor_action">TURN ON</span>'.html_safe, url_with_mode(request.referrer, "edit"), :target => "_top", :class => "sm_button" %></div>
+              <% end %>
+            </div>
+        <% else %>
+            </div>
+            <%= link_to("<span>View Current Version</span>".html_safe, @page.path, :class => "button current_version", :target => "_top") %>
+        <% end %>
+        </div>
+    </div>
+<% end %>

data/db/migrate/20100117144039_browsercms315.rb

@@ -0,0 +1,94 @@
+class Browsercms315 < ActiveRecord::Migration
+  def self.up
+    generate_ancestry_from_section_id
+    update_latest_version_cache
+
+    INDEXES.each do |index|
+      add_index *index
+    end
+  end
+
+  def self.down
+    # This migration is not reversible since it removes the original section_id column.
+  end
+
+  # Add some very commonly used indexes to improve the site performance as the # of pages/content grows (i.e. several thousand pages)
+  INDEXES = [
+      [:pages, :deleted],
+      [:pages, :path],
+      [:pages, :version],
+      [:page_versions, :page_id],
+      [:groups, :code],
+      [:groups, :group_type_id],
+      [:group_types, :cms_access],
+      [:group_sections, :section_id],
+      [:group_sections, :group_id],
+      [:users, :expires_at],
+      [:user_group_memberships, :group_id],
+      [:user_group_memberships, :user_id],
+      [:group_permissions, :group_id],
+      [:group_permissions, :permission_id],
+      [:group_permissions, [:group_id, :permission_id]],
+      [:section_nodes, :node_type],
+      [:section_nodes, :ancestry],
+      [:connectors, :page_id],
+      [:connectors, :page_version],
+      [:html_blocks, :deleted],
+      [:html_block_versions, :html_block_id],
+      [:html_block_versions, :version],
+      [:portlet_attributes, :portlet_id],
+      [:portlets, :name],
+      [:sections, :path],
+      [:redirects, :from_path],
+      [:connectors, :connectable_version],
+      [:connectors, :connectable_type],
+      [:content_types, :content_type_group_id],
+      [:content_types, :name],
+      [:file_block_versions, :file_block_id],
+      [:file_block_versions, :version],
+      [:file_blocks, :deleted],
+      [:file_blocks, :type],
+      [:attachment_versions, :attachment_id],
+      [:tasks, :page_id],
+      [:tasks, :completed_at],
+      [:tasks, :assigned_to_id],
+  ]
+
+  private
+
+  # v3.1.5 uses Ancestry to manage the parent child relationship between sections and their children.
+  # This converts the data from the old section_id to use the ancestry column.
+  def self.generate_ancestry_from_section_id
+    add_column :section_nodes, :ancestry, :string
+    add_column :section_nodes, :temp_parent_id, :integer
+
+    SectionNode.reset_column_information
+    root_section = Section.root.first
+    SectionNode.create!(:node => root_section) if root_section
+
+    all_nodes_but_root = SectionNode.find(:all, :conditions=>["section_id IS NOT NULL"])
+    all_nodes_but_root.each do |sn|
+      parent_node = SectionNode.find(:first, :conditions => ["node_id = ? and node_type = 'Section'", sn.section_id])
+      sn.temp_parent_id = parent_node.id
+      sn.save!
+    end
+    rename_column :section_nodes, :temp_parent_id, :parent_id # Ancestry works off the 'parent_id' column.
+
+    SectionNode.build_ancestry_from_parent_ids!
+    remove_column :section_nodes, :section_id
+    remove_column :section_nodes, :parent_id
+    SectionNode.reset_column_information
+  end
+
+  # Adds a 'latest_version' pointer to pages and links. Greatly reduces the number of queries the sitemap requires to determine if pages are in draft/published mode
+  def self.update_latest_version_cache
+    add_column :pages, :latest_version, :integer
+    add_column :links, :latest_version, :integer
+    Page.all.each do |p|
+      p.update_latest_version
+    end
+    Link.all.each do |link|
+      link.update_latest_version
+    end
+  end
+end