tandem 0.2.0.rc

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,205 @@
+= Tandem CMS
+
+Tandme is a content management system (CMS) for Rails 3.1+. We felt like it was 
+needed because too many of the CMS options for Rails are either 
+unpolished—something we wouldn't want to put in front of our clients or bloated
+and heavy, causing many headaches when trying to integrate into existing 
+applications. 
+
+Tandem was designed to be as simple as can be to integrate into a 
+larger application. It's a mountable engine that allows you to easily specify
+how it fits into a larger application and doesn't bring any opinions about how
+that application is architected.
+
+The simplicity doesn't stop there, though. It also has the end user in mind. 
+Through in-place editing, users simply navigate their site like they normally 
+would. If they want to edit something, they simply click on it, edit it, and go
+on their merry way.
+
+It's early in the life of Tandem and we have lots in store, but it's something 
+we find useful and hope you will too.
+
+== Getting Started / Installation
+
+Has it ever been easier to check off that "CMS functionality" feature story?
+
+This assumes you have a rails app already. If you don't, <tt>rails new tanem_app</tt>
+
+1. Add the tandem gem to your Gemfile
+
+    gem 'tandem'
+
+2. Install the gem
+
+    bundle install
+
+3. Generate the tandem files
+
+    rails g tandem
+
+4. Migrate
+
+    rake db:migrate
+
+5. Start your app and you're ready to go.
+
+    rails s
+
+== Upgrading
+
+Upgrade just like you would any other engine.
+
+1. Update the gem version to the latest version in your gemfile if you specify a version.
+
+    gem 'tandem', '~> 0.2'
+
+2. Install the updated gem
+
+    bundle update tandem
+
+3. Copy any new migrations from tandem
+
+    rake tandem:install:migrations
+
+4. Migrate
+
+    rake db:migrate
+
+5. Enjoy the new tandem goodness.
+
+    rails s
+
+== Usage
+
+By default, Tandem uses your application layout and Tandem's pages/show template to
+render pages. Both of these can be customized for an individual page.
+
+=== Custom pages
+
+With Tandem, you can easily insert editable content into your page by using the simple 
+helpers, <tt>tandem_text_tag</tt> and <tt>tandem_image_tag</tt>.
+
+Simply insert those into your templates where you want the user to be able to 
+edit content and Tandem will take care of the rest.
+
+    <div id="sidebar">
+      <%= tandem_image_tag(:sidebar_image)
+      <%= tandem_text_tag(:sidebar_text)
+    </div>
+
+The tandem_text_tag defaults to a basic text area. If you'd like to offer a WYSIWYG editor,
+you can set the <tt>editor</tt> option to <tt>:wysiwyg</tt>:
+
+    <%= tandem_text_tag(:sidebar_text, editor: :wysiwyg) %>
+
+=== Navigation
+
+Tandem comes with a helper method to add a navigation menu. It's not included in the default
+views, since it will most likely be used in your app's application layout. Adding it is easy,
+though.
+
+    <%= tandem_navigation_tag(@page) %>
+
+By default, Tandem will produce a nested tree of all your pages. If you just want the top level:
+
+    <%= tandem_navigation_tag(@page, Tandem::Page.top_level) %>
+
+If you want to show just the subnavication for a given page:
+
+    <%= tandem_navigation_tag(@page, @page.children) %>
+
+You can also create submenus easily by passing in a custom collection of pages, e.g.
+
+    <%= tandem_navigation_tag(@page, Tandem::Page.find_by_title('Services').children) %>
+
+== Authentication
+
+Now, most apps don't simply want to let anyone edit content. Tandem allows you to easily
+specify how it should control access.
+
+Inside config/initializers/tandem.rb, you can define procs for Tandem to use for 
+authentication and authorization.
+
+1. Tell Tandem how to find the current_user
+
+    Tandem::Configuration.current_user_proc { |request|
+      User.find(request.session['user_id']) unless request.session['user_id'].blank?
+    }
+
+2. Define what each user can do using CanCan
+
+    Tandem::Configuration.user_abilities_proc { |user|
+      user ||= User.new # guest user (not logged in)
+
+      if user.admin?
+        can :manage, :all
+      else
+        can :read, :all
+      end
+    }
+
+== Paperclip configuration
+
+Tandem uses paperclip for file uploads. If your application needs to modify its settings,
+simply set the Tandem::Configuration.paperclip_options in /config/initializers/tandem.rb
+
+For example, to store images on S3, add the aws-sdk gem to your Gemfile and set 
+paperclip_options to:
+
+    Tandem::Configuration.paperclip_options = { :styles => { :thumb => "150x150>" },
+                                                :storage => :s3,
+                                                :bucket => Proc.new { Rails.application.engine_name.gsub(/application$/, Rails.env) },
+                                                :s3_credentials => {
+                                                                     :access_key_id => ENV['S3_KEY'],
+                                                                     :secret_access_key => ENV['S3_SECRET']
+                                                } }
+
+== Other Options
+
+By default, Tandem mounts to the root of your application. We're not trying to be pushy, 
+it's just what we find ourselves doing 90% of the time. To change this, simply modify your
+config/routes.rb to something like:
+
+    mount Tandem::Engine => "/tandem"
+
+To change the url that you wish to serve unauthorized access errors supply a value to:
+
+    Tandem::Configuration.unauthorized_path
+
+By default, the tandem generator copies all tandem layouts to app/views/layouts/tandem. 
+If you wish to move your layouts to another location, supply a value to:
+
+    Tandem::Configuration.layouts_dir
+
+By default, the uploaded images directly in the asset pipeline at :rails_root/public. 
+To change this location, supply a value to:
+
+    Tandem::Configuration.uploaded_images_dir
+
+By default, the uploaded images are stored and accessed via the default "paperclip" 
+conventions (see paperclip gem). To change this behavior, supply a value to:
+
+    Tandem::Configuration.uploaded_images_template
+    
+=== Styling
+
+Every new Tandem default page created has pre-defined classes setup to use either Bootstrap or 960.gs. 
+
+Here's a preview of what the html looks like:
+
+  .container_12.row.clearfix
+    p#notice = notice
+    .grid_12.span12
+      = tandem_image_tag(@page, :default_image)
+    .grid_7.span7
+      = tandem_text_tag(@page, :tandem_text_block)
+    .grid_5.span5
+      = tandem_text_tag(@page, :tandem_sidebar)
+    
+If either of those grid systems are being used those styles will pull in accordingly.
+
+== License
+
+Tandem is released under the MIT license:
+
+* http://www.opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tandem'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'lib/tasks/tandem_tasks.rake'
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+
+

data/app/assets/javascripts/tandem/contents.js

@@ -0,0 +1,2 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.

data/app/assets/javascripts/tandem/current_image.jst.eco

@@ -0,0 +1,19 @@
+<% @resource_updated_at = new Date @resource_updated_at %>
+<% @formatted_resource_updated_at = "#{@resource_updated_at.getMonth() + 1}/#{@resource_updated_at.getDate()}/#{@resource_updated_at.getFullYear()}" %>
+
+<div class="clearfix" id="current-image">
+  <input id="content_image_image_id" name="content_image[image_id]" type="hidden" value="<%= @id %>" />
+
+  <h3 id="selected_image_title">Current Image</h3>
+
+  <div class="clearfix" id="selected_image_viewpane">
+    <img alt="<%= @resource_file_name %>" src="<%= if @thumb_url? then @thumb_url else '/assets/tandem/blank_image.jpg' %>" style="" />
+  </div>
+  
+  <% if @thumb_url?: %>
+    <ul id="tandem_image_attributes">
+      <li class="image_name"><%= @resource_file_name %></li>
+      <li>Last Modified: <%= @formatted_resource_updated_at %></li>
+    </ul>
+  <% end %>
+</div>

data/app/assets/javascripts/tandem/gallery_image.jst.eco

@@ -0,0 +1,10 @@
+<li>
+  <span>
+    <img alt="<%= @resource_file_name %>" data-id="<%= @id %>" data-resource_file_name="<%= @resource_file_name %>" data-resource_updated_at="<%= @resource_updated_at %>" data-thumb_url="<%= @thumb_url %>" src="<%= @thumb_url %>" />
+  </span>
+
+  <p>
+    <%= @resource_file_name %>
+    <!--<a class="delete_image" href="#"></a> -->
+  </p>
+</li>

data/app/assets/javascripts/tandem/images.coffee

@@ -0,0 +1,42 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+#= require tandem/current_image
+#= require tandem/gallery_image
+
+$(document).ready ->
+  $("#new_tandem_image input[type=file][name='image[resource]']").fileupload
+    dataType: 'json'
+    url: $(this).closest('form').attr('action')
+    
+    done: (e, data) ->
+      $('#tandem_image_gallery ul').prepend(window.JST['tandem/gallery_image'](data.result))
+      $('div#current-image').replaceWith(window.JST['tandem/current_image'](data.result))
+
+    progress: (e, data) ->
+      progress = parseInt(data.loaded / data.total * 100, 10) + '%'
+      $('div#tandem-upload-image div.loader div.range').css({width: progress})
+      $('div#tandem-upload-image div.loader div.range span').text(progress)
+
+    start: (e, data) ->
+      $('div#tandem-upload-image div.loader').show()
+      $(e.target).closest('form').find('section#error_explanation').hide()
+
+    always: (e, data) ->
+      $('div#tandem-upload-image div.loader').hide()
+
+    fail: (e, data) ->
+      errors = $.parseJSON(data.jqXHR.responseText)
+      errorSection = $(e.target).closest('form').find('section#error_explanation')
+      errorList = errorSection.find('ul')
+      errorList.html('')
+      errorSection.show()
+
+      $.each errors, (attribute, error) ->
+        errorList.append("<li>#{attribute} #{error}</li>")
+
+  $('section#tandem_image_gallery ul').click (event) ->
+    image = $(event.target).closest('li').find('img')
+
+    if image.length > 0
+      $('div#current-image').replaceWith(window.JST['tandem/current_image'](image.data()))
+

data/app/assets/javascripts/tandem/pages.js.coffee

@@ -0,0 +1,32 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+
+$(document).ready ->
+  $('.page_link').colorbox()
+
+  if $('#tandem_page_links').length > 0
+    $('body').addClass('tandem-admin-bar')
+
+  $('div.tandem_content').on 
+    'mouseenter': ->
+      $('div.tandem_toolbar', $(this)).fadeIn('slow')
+  
+    'mouseleave': ->
+      $('div.tandem_toolbar', $(this)).fadeOut('slow')
+
+    'click': ->
+      $.fn.colorbox
+        href: $('a.tandem_edit_link', $(this)).attr('href')
+        iframe: true
+        width: '95%'
+        height: '90%'
+        open: true
+      return false
+
+  $(document).on 'ajax:success', 'form.tandem-page-form', (event, content, status, jqXHR) ->
+    returnedForm = $('form.tandem-page-form', content)
+
+    if returnedForm.find('#error_explanation').length > 0
+     $('form.tandem-page-form').replaceWith returnedForm
+    else
+      window.location.reload()

data/app/assets/javascripts/tandem/popup.js

@@ -0,0 +1,23 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+
+$().ready(function () {
+  $('form.tandem_content_editor').on('ajax:success', function(event, content, status, jqXHR){
+    $.get(parent.location.href, function(data, status, jqXHR){
+      var content_id = '#' + content.tag;
+
+      $(content_id, parent.document).html( $(content_id, data).html() );
+      parent.$.fn.colorbox.close();
+    });
+  });
+
+  $('.wymeditor').wymeditor({ wymPath: '/assets/tandem/wymeditor/jquery.wymeditor.min.js',
+                              basePath: '/assets/tandem/wymeditor/',
+                              skinPath: "/assets/tandem/wymeditor/skins/default/",
+                              jQueryPath: "/assets/jquery.js"
+  });
+
+  $('h3.settings-toggle').live('click', function () {
+    $('div.advanced-settings').slideToggle('slow');
+  });
+});

data/app/assets/javascripts/tandem.js

@@ -0,0 +1,16 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+//= require jquery
+//= require jquery_ujs
+//= require tandem/modernizr-2.5.3.min
+//= require tandem/jquery.colorbox
+//= require tandem/wymeditor/jquery.wymeditor.min
+//= require tandem/jquery.ui.widget
+//= require tandem/jquery-fileupload
+//= require tandem/pages
+//= require tandem/images
+//= require tandem/popup

data/app/assets/stylesheets/tandem/colorbox.css.erb

@@ -0,0 +1,83 @@
+
+/*
+    ColorBox Core Style:
+    The following CSS is consistent between example themes and should not be altered.
+*/
+#colorbox, #cboxOverlay, #cboxWrapper{position:absolute; top:0; left:0; z-index:9999; overflow:hidden;}
+#cboxOverlay{position:fixed; width:100%; height:100%;}
+#cboxMiddleLeft, #cboxBottomLeft{clear:left;}
+#cboxContent{position:relative;}
+#cboxLoadedContent{overflow:auto;}
+#cboxTitle{margin:0;}
+#cboxLoadingOverlay, #cboxLoadingGraphic{position:absolute; top:0; left:0; width:100%; height:100%;}
+#cboxPrevious, #cboxNext, #cboxClose, #cboxSlideshow{cursor:pointer;}
+.cboxPhoto{float:left; margin:auto; border:0; display:block;}
+.cboxIframe{width:100%; height:100%; display:block; border:0;}
+
+/*
+    User Style:
+    Change the following styles to modify the appearance of ColorBox.  They are
+    ordered & tabbed in a way that represents the nesting of the generated HTML.
+*/
+#cboxOverlay{background:#fff;}
+#colorbox{}
+    #cboxTopLeft{width:25px; height:25px; background:url('<%=image_path('tandem/colorbox/border1.png')%>') no-repeat 0 0;}
+    #cboxTopCenter{height:25px; background:url('<%=image_path('tandem/colorbox/border1.png')%>') repeat-x 0 -50px;}
+    #cboxTopRight{width:25px; height:25px; background:url('<%=image_path('tandem/colorbox/border1.png')%>') no-repeat -25px 0;}
+    #cboxBottomLeft{width:25px; height:25px; background:url('<%=image_path('tandem/colorbox/border1.png')%>') no-repeat 0 -25px;}
+    #cboxBottomCenter{height:25px; background:url('<%=image_path('tandem/colorbox/border1.png')%>') repeat-x 0 -75px;}
+    #cboxBottomRight{width:25px; height:25px; background:url('<%=image_path('tandem/colorbox/border1.png')%>') no-repeat -25px -25px;}
+    #cboxMiddleLeft{width:25px; background:url('<%=image_path('tandem/colorbox/border2.png')%>') repeat-y 0 0;}
+    #cboxMiddleRight{width:25px; background:url('<%=image_path('tandem/colorbox/border2.png')%>') repeat-y -25px 0;}
+    #cboxContent{background:#fff; overflow:hidden;}
+        .cboxIframe{background:#fff;}
+        #cboxError{padding:50px; border:1px solid #ccc;}
+        #cboxLoadedContent{margin-bottom:20px;}
+        #cboxTitle{position:absolute; bottom:0px; left:0; text-align:center; width:100%; color:#999;}
+        #cboxCurrent{position:absolute; bottom:0px; left:100px; color:#999;}
+        #cboxSlideshow{position:absolute; bottom:0px; right:42px; color:#444;}
+        #cboxPrevious{position:absolute; bottom:0px; left:0; color:#444;}
+        #cboxNext{position:absolute; bottom:0px; left:63px; color:#444;}
+        #cboxLoadingOverlay{background:#fff url('<%=image_path('tandem/colorbox/loading.gif')%>') no-repeat 5px 5px;}
+        #cboxClose{position:absolute; bottom:0; right:0; display:block; color:#444;}
+
+/*
+  The following fixes a problem where IE7 and IE8 replace a PNG's alpha transparency with a black fill
+  when an alpha filter (opacity change) is set on the element or ancestor element.  This style is not applied to or needed in IE9.
+  See: http://jacklmoore.com/notes/ie-transparency-problems/
+*/
+.cboxIE #cboxTopLeft,
+.cboxIE #cboxTopCenter,
+.cboxIE #cboxTopRight,
+.cboxIE #cboxBottomLeft,
+.cboxIE #cboxBottomCenter,
+.cboxIE #cboxBottomRight,
+.cboxIE #cboxMiddleLeft,
+.cboxIE #cboxMiddleRight {
+    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr=#00FFFFFF,endColorstr=#00FFFFFF);
+}
+
+/*
+  The following provides PNG transparency support for IE6
+  Feel free to remove this and the /ie6/ directory if you have dropped IE6 support.
+*/
+.cboxIE6 #cboxTopLeft{background:url('<%=image_path('tandem/colorbox/ie6/borderTopLeft.png')%>');}
+.cboxIE6 #cboxTopCenter{background:url('<%=image_path('tandem/colorbox/ie6/borderTopCenter.png')%>');}
+.cboxIE6 #cboxTopRight{background:url('<%=image_path('tandem/colorbox/ie6/borderTopRight.png')%>');}
+.cboxIE6 #cboxBottomLeft{background:url('<%=image_path('tandem/colorbox/ie6/borderBottomLeft.png')%>');}
+.cboxIE6 #cboxBottomCenter{background:url('<%=image_path('tandem/colorbox/ie6/borderBottomCenter.png')%>');}
+.cboxIE6 #cboxBottomRight{background:url('<%=image_path('tandem/colorbox/ie6/borderBottomRight.png')%>');}
+.cboxIE6 #cboxMiddleLeft{background:url('<%=image_path('tandem/colorbox/ie6/borderMiddleLeft.png')%>');}
+.cboxIE6 #cboxMiddleRight{background:url('<%=image_path('tandem/colorbox/ie6/borderMiddleRight.png')%>');}
+
+.cboxIE6 #cboxTopLeft,
+.cboxIE6 #cboxTopCenter,
+.cboxIE6 #cboxTopRight,
+.cboxIE6 #cboxBottomLeft,
+.cboxIE6 #cboxBottomCenter,
+.cboxIE6 #cboxBottomRight,
+.cboxIE6 #cboxMiddleLeft,
+.cboxIE6 #cboxMiddleRight {
+    _behavior: expression(this.src = this.src ? this.src : this.currentStyle.backgroundImage.split('"')[1], this.style.background = "none", this.style.filter = "progid:DXImageTransform.Microsoft.AlphaImageLoader(src=" + this.src + ", sizingMethod='scale')");
+}
+