regulate 0.0.1 → 0.1.0

data/.gitignore

@@ -11,4 +11,5 @@ doc
 docs
 .yardoc
 test/dummy/tmp/**/*
+test/tmp/**/*
 

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    regulate (0.0.1)
+    regulate (0.1.0)
+      abstract_auth (~> 0.1.0)
       grit (~> 2.3.0)
       rails (~> 3.0.0)
 
@@ -9,6 +10,8 @@ GEM
   remote: http://rubygems.org/
   specs:
     abstract (1.0.0)
+    abstract_auth (0.1.0)
+      module_ext (~> 0.1.0)
     actionmailer (3.0.3)
       actionpack (= 3.0.3)
       mail (~> 2.2.9)
@@ -67,6 +70,7 @@ GEM
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.16)
+    module_ext (0.1.0)
     nokogiri (1.4.4)
     polyglot (0.3.1)
     rack (1.2.1)
@@ -107,6 +111,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  abstract_auth (~> 0.1.0)
   bluecloth (~> 2.0.9)
   bundler (~> 1.0.0)
   capybara (~> 0.4.0)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Quick Left, Inc.
+Copyright (c) 2011 Quick Left, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,3 +1,79 @@
-#Regulate
+Regulate
+===========
+Rails 3 engine that provides a Git backed CMS that allows for an admin to define editable regions in a page view.
+
+
+### Why
+We often have applications that need fairly basic CMS solutions but the
+client may not have someone on staff that knows HTML.  We needed a CMS
+that wasn't bloated, lived as an engine, allowed us to regulate what
+parts of a page could be editable, and we wanted it to be Git backed so
+we could have version control over the edits. We also designed regulate
+to work with any authentication / authorization service.
+
+## How it works
+Video coming soon!
+
+### Quick Start
+
+Add regulate to your Rails 3 Gemfile
+
+    gem "regulate"
+
+    bundle install
+
+Install the initializer
+
+    rails g regulate:mount_up
+
+You MUST edit the initializer located in `config/initializers/regulate.rb`.  Please read the comments located in the regulate initializer for details on configuring regulate to work with your authentication and authorization systems and for defining custom routes. NOTHING works until you do this!
+
+
+### Options
+
+More than likely you will want to customize the views in regulate.  To copy the view files, javascript in the admin and the git repo config yaml file simply run...
+
+    rails g regulate:strap
+
+The `strap` generator will copy the following files into your Rails application like so.
+
+    create  app/views/regulate
+    create  app/views/regulate/admin/pages/_form.html.haml
+    create  app/views/regulate/admin/pages/edit.html.haml
+    create  app/views/regulate/admin/pages/index.html.haml
+    create  app/views/regulate/admin/pages/new.html.haml
+    create  app/views/regulate/pages/show.html.haml
+    create  public/javascripts/regulate_admin.js
+    create  config/regulate.yml
+
+
+
+### Issues
+
+Please report issues to the [Regulate issue tracker](http://github.com/quickleft/regulate/issues/).
+
+
+### Patches/Pull Requests
+
+* Fork it.
+* Add tests for it.
+* Make your changes.
+* Commit.
+* Send a pull request.
+
+
+### Thanks
+
+Thanks to mojombo for writing grit and gollum. We use grit to talk to Git and reading the source of gollum was a major help. Thanks to brennandunn for inspiring
+us with rack-cms. Thanks to josevalim for writing devise, it is an excellent example of a Rails 3 engine. Thanks to Nate Dogg and Warren G for insipiring the name.
+
+
+### Copyright
+
+Copyright (c) 2011 Quick Left. We regulate any stealing of his property (actually we don't it's MIT). See LICENSE for details.
+
+Regulators we regulate any stealing of his property and we damn good too But you can't be any geek off the street, gotta be handy with the steel if you know what I mean, earn your keep!
+
+
+REGULATORS!!! MOUNT UP!
 
-The CMS we always wanted.

data/app/controllers/regulate/admin/pages_controller.rb

@@ -5,6 +5,12 @@ module Regulate
 
     # Standard CRUD Controller
     class PagesController < ActionController::Base
+      # Check that a user is authenticated
+      before_filter :is_authorized?
+      # Check that the user is an admin
+      before_filter :is_admin?, :only => [:new, :create, :destroy]
+      # Check that the user is at least an editor
+      before_filter :is_editor?, :not => [:new, :create, :destroy]
       # Load in our page object based on the ID
       before_filter :load_page, :only => [:edit,:update,:destroy]
 
@@ -23,6 +29,7 @@ module Regulate
 
       # PUT method to persist changes to a Page object
       def update
+        params[:page].delete(:view) if !@is_admin
         if @page.update_attributes(params[:page])
           flash[:notice] = "Successfully updated #{params[:page][:title]}"
           redirect_to regulate_admin_regulate_pages_path
@@ -56,6 +63,22 @@ module Regulate
 
       private
 
+      def is_authorized?
+        @authorized_user = AbstractAuth.invoke(:authorized_user)
+        @is_admin = AbstractAuth.invoke(:is_admin)
+        # Uncomment the following line to test out admin interface
+        #@is_admin = true
+        @is_editor = AbstractAuth.invoke(:is_editor)
+      end
+
+      def is_editor?
+        redirect_to root_path if !@is_editor
+      end
+
+      def is_admin?
+        redirect_to regulate_admin_regulate_pages_path if !@is_admin
+      end
+
       # Grab a page resource based on the ID passed to the URI
       def load_page
         @page = Regulate::Page.find(params[:id])

data/app/views/regulate/admin/pages/_form.html.erb

@@ -20,10 +20,17 @@ textarea {height:250px;}
         Title: <%= @page.title %>
       </div>
     <% end %>
-    <div class="form_row">
-      <%= f.label :view %>
-      <%= f.text_area :view %>
-    </div>
+    <% if @is_admin %>
+      <div class="form_row">
+        <%= f.label :view %>
+        <%= f.text_area :view %>
+      </div>
+    <% else %>
+      <div class="form_row">
+        View:<br /> <%= @page.view %>
+        <%= f.hidden_field :view %>
+      </div>
+    <% end %>
     <div id="edit_regions"></div>
     <div class="form_row">
       <%= f.submit "Save" %>

data/app/views/regulate/admin/pages/index.html.erb

@@ -1,10 +1,19 @@
 <h2>Pages</h2>
-<%= link_to "New Page", new_regulate_admin_regulate_page_path %>
+<% if @is_admin %>
+  <%= link_to "New Page", new_regulate_admin_regulate_page_path %>
+<% end %>
 <ul>
   <% @pages.each do |page| %>
     <li>
       <%= page.title %>
-      <%= link_to "Edit" , edit_regulate_admin_regulate_page_path(page.id) %>
+      <%= link_to "Edit" , edit_regulate_admin_regulate_page_path(page) %>
+      <% if @is_admin %>
+        <%= link_to "Delete" , regulate_admin_regulate_page_path(page), :confirm => 'Are you sure?', :method => :delete, :class => 'delete_link' %>
+      <% end %>
     </li>
   <% end %>
 </ul>
+<% if @is_admin %>
+  <%= javascript_include_tag "jquery.min.js" %>
+  <%= javascript_include_tag "regulate_index.js" %>
+<% end %>

data/lib/generators/regulate/{install_generator.rb → mount_up_generator.rb}

@@ -4,27 +4,12 @@ module Regulate
   module Generators
 
     # Standard install that lets a user copy files over so they can override some functionality
-    class InstallGenerator < Rails::Generators::Base
+    class MountUpGenerator < Rails::Generators::Base
 
       # Tell Rails where to find our templates
       source_root File.expand_path("../../templates", __FILE__)
 
-      desc "Copies files to your application that regulate needs."
-
-      # Copy over our CSS
-      def copy_css
-        template "regulate.css", "public/stylesheets/regulate.css"
-      end
-
-      # Copy over our JS
-      def copy_js
-        template "regulate.js", "public/javascripts/regulate.js"
-      end
-
-      # Copy over the repo config YAML file
-      def copy_yml
-        template "regulate.yml", "config/regulate.yml"
-      end
+      desc "Copies the regulate initializer because you can't be any geek off the street."
 
       # Copy over the Regulate initializer
       def copy_initializer

data/lib/generators/regulate/{views_generator.rb → strap_generator.rb}

@@ -3,12 +3,11 @@ module Regulate
   module Generators
 
     # Class lifted from Devise.  Thanks josevalim!
-    class ViewsGenerator < Rails::Generators::Base
+    class StrapGenerator < Rails::Generators::Base
 
       # Tell Rails where our view files are
-      source_root File.expand_path("../../../../app/views", __FILE__)
-      desc "Copies all Regulate views to your application in app/views/pages."
-
+      source_root File.expand_path("../../../..", __FILE__)
+      desc "Copies all Regulate views, js, and yaml files to your application in app/views/regulate/."
       class_option :template_engine, :type => :string, :aliases => "-t",
                                      :desc => "Template engine for the views. Available options are 'erb' and 'haml'."
 
@@ -20,10 +19,20 @@ module Regulate
           verify_haml_version
           create_and_copy_haml_views
         else
-          directory "pages", "app/views/pages"
+          directory "app/views/regulate", "app/views/regulate"
         end
       end
 
+      # Copy over our JS
+      def copy_js
+        template "public/javascripts/regulate_admin.js", "public/javascripts/regulate_admin.js"
+      end
+
+      # Copy over the repo config YAML file
+      def copy_yml
+        template "config/regulate.yml", "config/regulate.yml"
+      end
+
     protected
 
       # Check whether the current environment has HAML
@@ -47,7 +56,7 @@ module Regulate
       # Copy over the HAML files
       def create_and_copy_haml_views
         require 'tmpdir'
-        html_root = "#{self.class.source_root}/pages"
+        html_root = "#{self.class.source_root}/app/views/regulate"
 
         Dir.mktmpdir("regulate-haml.") do |haml_root|
           Dir["#{html_root}/**/*"].each do |path|
@@ -61,7 +70,7 @@ module Regulate
             end
           end
 
-          directory haml_root, "app/views/pages"
+          directory haml_root, "app/views/regulate"
         end
       end
 

data/lib/generators/templates/regulate.rb

@@ -11,3 +11,22 @@ Regulate.setup do |config|
 
 end
 
+# AbstractAuth Implementations
+# You NEED to set these methods appropriately for Regulate to function
+# This method should return a the currently authenticated resource
+#AbstractAuth.implement :authorized_user do
+  #::ApplicationController.send('current_user')
+#end
+# This method should return whether the currently authenticated resource is an admin or not
+# Admins are able to edit the view field on a CMS page and define the editable regions
+# If you want any authenticated user to be able to have this ability, simply return true in your implementation
+#AbstractAuth.implement :is_admin do
+  #::ApplicationController.send('current_user').is_admin?
+#end
+# This method should return whether the currently authenticated resource is an admin or not
+# Editors only have the ability to change the content of editable regions on the page
+# If you want any authenticated user to be able to have this ability, simply return true in your implementation
+#AbstractAuth.implement :is_editor do
+  #::ApplicationController.send('current_user').is_editor?
+#end
+

data/lib/generators/templates/regulate.yml

@@ -1,10 +1,10 @@
 development:
   repo: db/repos/development.git
 test: &test
-  repo: db/repos/test.git  
+  repo: db/repos/test.git
 production:
   repo: db/repos/production.git
 daily:
   repo: db/repos/daily.git
 cucumber:
-  <<: *test
+  <<: *test

data/lib/generators/templates/regulate_admin.js

@@ -0,0 +1,167 @@
+(function( $ ) {
+
+  var timer,
+      stored_keys = null,
+
+  Regulate = {
+
+    longPoll: function longPoll( force, callback ){
+      var i, text = $('#page_view').val(),
+
+          // This RegEx will catch anything inside the `{{ }}`
+          m = /\{\{(\w|\s)*\}\}/g,
+          // A more generic mustache `{ }` grab
+          clean_key = /[\{,\}]/g,
+
+          keys = [],
+          invalid_keys = [],
+          deleted_keys = [],
+
+          // To import data, we've attached an object to `window.existing_custom_fields`
+          existing_keys = existing_custom_fields || {},
+
+          // Define a blacklist of keys we know we'll never want
+          blacklist = ['{{view}}', '{{title}}'],
+
+          // This assigns our initial match of all keys in the textarea
+          initial_match = text.match( m ) || [],
+
+          // This allows to skip the early return
+          f = force || false;
+
+      // Prevent this core of this from running while someone's typing
+      if( $('#page_view').hasClass('active') && f === false) {
+        // Set the timer agains and return early
+        timer = setTimeout( longPoll , 1e3);
+        return false;
+      }
+
+      // Loop through the keys that our regex grabbed, and determine if they're ok to use
+      $.each( initial_match, function( i, v ) {
+          var invalid = false;
+
+          // Keys can't be in the blacklist, also don't double up the errors
+          if( ~blacklist.indexOf( v ) && !~invalid_keys.indexOf( v ) ) {
+            invalid = true;
+            invalid_keys.push({ 'key':v, 'msg': 'The key '+v+' is reserved.' });
+          }
+
+          // Keys can't contain spaces
+          if( /\s/.test(v) && !~invalid_keys.indexOf( v ) ) {
+            invalid = true;
+            invalid_keys.push({ 'key':v, 'msg': 'The key '+v+' contains a space. It can\'t do that.' });
+          }
+
+          // Keys can't start with a number
+          if( /\{\{\d/.test(v) && !~invalid_keys.indexOf( v ) ) {
+            invalid = true;
+            invalid_keys.push({ 'key':v, 'msg': 'The key '+v+' starts with a number. It can\'t do that.' });
+          }
+
+          // If we're still valid after this, add the key into the keys array
+          if( invalid === false ) {
+            keys.push( v );
+          }
+      });
+
+      // Loops through the stored keys and checks for any deleted keys
+      // stored_key[] - keys[] == any deleted keys
+      if( stored_keys !== null ) {
+        i = stored_keys.length;
+        while(i--){
+          if( ! ~keys.indexOf( stored_keys[i] ) ) {
+            deleted_keys.push( stored_keys[i] );
+            // Remove the label and text area within #edit_regions
+            $('#edit_regions .'+ stored_keys[i].replace( clean_key, "") ).remove();
+          }
+        }
+      }
+
+      // Loop through the valid keys and add labels and textareas for them
+      $.each( keys, function( i, v ) {
+        var new_key = v.replace( clean_key, ""),
+
+            textarea = $("<textarea>", {
+              'name': 'page[edit_regions][' + new_key + ']',
+              'class': new_key,
+              'value': existing_keys[new_key] || 'Default Text for '+v
+            }),
+
+            label = $("<label>", {
+              'for': 'page[edit_regions][' + new_key + ']',
+              'text': new_key.replace('_', " "),
+              'class': new_key
+            });
+
+        if( $('textarea').hasClass( new_key )) {
+          return;
+        }
+
+        // Add our textarea to the end of #edit_regions, and inset it's label before it
+        textarea.appendTo('#edit_regions').before(label);
+      });
+
+      // Make any old errors go away
+      $('#custom_field_errors').empty();
+
+      // Add error messages for an invalid keys
+      $.each( invalid_keys, function( i, v ) {
+        if( v.key !== "{{title}}" ) {
+          $('#custom_field_errors').append(v.msg+"</br>");
+        }
+      });
+
+      // Globally persist our keys for the next pass
+      stored_keys = keys;
+
+      // Set a 1 second timer
+      timer = setTimeout( longPoll , 1e3);
+
+      if( $.isFunction( callback ) ){
+        callback();
+      }
+    },
+
+    init: function(){
+      var buffer;
+
+      // Start the party with checking the form's inital value
+      Regulate.longPoll();
+
+      // Forces the longPoll to run one more time before you submit the form
+      $('form').bind('submit', function( e ){
+        e.preventDefault();
+
+        var f = e.target;
+
+        clearTimeout( timer );
+
+        Regulate.longPoll( null, function(){
+          $(f).unbind('submit').submit();
+        });
+
+      });
+
+      // Runs the longPoll if `}}` is entered into the form
+      $(window).bind('keyup', function(e) {
+        if( e.keyCode == 221 && buffer == 221 ) {
+          Regulate.longPoll( true );
+        }
+
+        buffer = e.keyCode;
+      });
+
+      // Prevents the longPoll from running if you're focused on the textarea
+      $('#page_view').bind('focus blur', function(e){
+        $(this).toggleClass('active');
+      });
+    }
+
+  };
+
+  $( Regulate.init );
+
+  window.Regulate = Regulate;
+
+})(jQuery);
+