spreadhead 0.6.0

data/VERSION

@@ -0,0 +1 @@
+0.6.0

data/app/controllers/spreadhead/pages_controller.rb

@@ -0,0 +1,62 @@
+module Spreadhead
+  class PagesController < ApplicationController
+    unloadable
+    before_filter :filter, :except => [:show]
+    
+    def new
+      @page = ::Page.new    
+    end
+
+    def index 
+      @pages = ::Page.find(:all)
+    end
+
+    def show
+      @page = ::Page.published.find_by_url!(params[:url].to_a.join('/'))  
+    end
+    
+    def edit
+      @page = ::Page.find(params[:id])
+    end
+
+    def create
+      @page = ::Page.new(params[:page])
+      respond_to do |format|
+        if @page.save
+          format.html { redirect_to pages_url }
+          format.xml  { head :created, :location => pages_url }
+        else
+          format.html { render :action => "new" }
+          format.xml  { render :xml => @page.errors.to_xml }
+        end
+      end
+    end
+    
+    def update
+      @page = ::Page.find(params[:id])
+      respond_to do |format|
+        if @page.update_attributes(params[:page])
+          format.html { redirect_to pages_url }
+          format.xml  { head :ok }
+        else
+          format.html { render :action => "edit" }
+          format.xml  { render :xml => @page.errors.to_xml }
+        end
+      end
+    end
+    
+    def destroy
+      @page = ::Page.find(params[:id])
+      @page.destroy
+      respond_to do |format|
+        format.html { redirect_to pages_url }
+        format.xml  { head :ok }
+      end
+    end
+    
+  private
+    def filter
+      Spreadhead::PagesAuth.filter(self)    
+    end
+  end
+end

data/app/views/spreadhead/pages/_form.html.erb

@@ -0,0 +1,40 @@
+<div class="errors">
+  <%= form.error_messages %>
+</div>    
+
+<div class="text required unique">
+  <%= form.label :title %>
+  <%= form.text_field :title %>
+</div>
+<div class="text optional unique">
+  <%= form.label :url %>
+  <%= form.text_field :url %>
+</div>
+<div class="text optional">
+  <%= form.label :description %>
+  <%= form.text_field :description %>
+</div>
+<div class="text optional">
+  <%= form.label :keywords %>
+  <%= form.text_field :keywords %>
+</div>
+<div class="text optional">
+  <%= form.label :category %>
+  <%= form.text_field :category %>
+</div>
+<div class="textarea required">
+  <%= form.label :text %>
+  <%= form.text_area :text %>
+</div>
+<div class="syntax">
+  <a href="http://daringfireball.net/projects/markdown/syntax" target="_blank">Learn Markdown</a> |
+  <a href="http://hobix.com/textile/" target="_blank">Learn Textile</a>
+</div>
+<div class="select required">
+  <%= form.label :formatting %>
+  <%= form.select :formatting, [['Plain','plain'], ['Markdown', 'markdown'], ['Textile', 'textile']] %>
+</div>
+<div class="checkbox optional">
+  <%= form.label :published %>
+  <%= form.check_box :published %>
+</div>

data/app/views/spreadhead/pages/edit.html.erb

@@ -0,0 +1,8 @@
+<h2>Update page</h2>
+
+<% form_for @page do |form| %>
+  <%= render :partial => '/spreadhead/pages/form', :object => form %>
+  <div class="submit">
+    <%= form.submit 'Update', :disable_with => 'Please wait...' %>
+  </div>  
+<% end %>

data/app/views/spreadhead/pages/index.html.erb

@@ -0,0 +1,25 @@
+<h2>Pages</h2>
+
+<table class="pages">
+  <thead>
+    <tr>
+      <th class="title">Title</th>
+      <th class="path">Path</th>
+      <th class="published">Published</th>
+      <th class="commands"></th>
+    </tr>
+  </thead>
+  <tbody>  
+  <% for page in @pages %>
+    <tr class="<%= cycle("even","odd") -%>" >
+      <td class="title"><%= link_to page.title || 'No title', edit_page_url(page) %></td>
+      <td class="path"><%= page.url || 'No url' %></td>
+      <td class="published"><%=h page.published ? 'Y' : 'N' %></td>
+      <td class="commands"><%= link_to "View", page.url %> | <%= link_to 'Destroy', page_url(page), :confirm => 'Are you sure?', :method => :delete %></td>
+    </tr>
+  <% end %>
+  </tbody>
+</table>
+<div>
+  <%= link_to 'New page', new_page_url %>
+</div>

data/app/views/spreadhead/pages/new.html.erb

@@ -0,0 +1,8 @@
+<h2>New page</h2>
+
+<% form_for @page do |form| %>
+  <%= render :partial => '/spreadhead/pages/form', :object => form %>
+  <div class="submit">
+    <%= form.submit 'Create', :disable_with => 'Please wait...' %>
+  </div>  
+<% end %>

data/app/views/spreadhead/pages/show.html.erb

@@ -0,0 +1,5 @@
+<% content_for(:title) do %><%= @page.title || '' %><% end %>
+<% content_for(:keywords) do %><%= @page.keywords || '' %><% end %>
+<% content_for(:description) do %><%= @page.description || '' %><% end %>
+<!-- Updated: <%= @page.updated_at %> -->
+<%= spreadhead @page %>

data/config/spreadhead_routes.rb

@@ -0,0 +1,4 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :pages, :controller => 'spreadhead/pages'
+  map.connect '*url', :controller => 'spreadhead/pages', :action => 'show'
+end

data/generators/spreadhead/USAGE

@@ -0,0 +1 @@
+script/generate spreadhead

data/generators/spreadhead/lib/insert_commands.rb

@@ -0,0 +1,33 @@
+# Mostly pinched from http://github.com/ryanb/nifty-generators/tree/master
+
+Rails::Generator::Commands::Base.class_eval do
+  def file_contains?(relative_destination, line)
+    File.read(destination_path(relative_destination)).include?(line)
+  end
+end
+
+Rails::Generator::Commands::Create.class_eval do
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+    unless options[:pretend] || file_contains?(file, line)
+      gsub_file file, /^(class|module) .+$/ do |match|
+        "#{match}\n  #{line}"
+      end
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def insert_into(file, line)
+    logger.remove "#{line} from #{file}"
+    unless options[:pretend]
+      gsub_file file, "\n  #{line}", ''
+    end
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def insert_into(file, line)
+    logger.insert "#{line} into #{file}"
+  end
+end

data/generators/spreadhead/lib/rake_commands.rb

@@ -0,0 +1,22 @@
+Rails::Generator::Commands::Create.class_eval do
+  def rake_db_migrate
+    logger.rake "db:migrate"
+    unless system("rake db:migrate")
+      logger.rake "db:migrate failed. Rolling back"      
+      command(:destroy).invoke!
+    end
+  end
+end
+
+Rails::Generator::Commands::Destroy.class_eval do
+  def rake_db_migrate
+    logger.rake "db:rollback"  
+    system "rake db:rollback"  
+  end
+end
+
+Rails::Generator::Commands::List.class_eval do
+  def rake_db_migrate
+    logger.rake "db:migrate"    
+  end
+end

data/generators/spreadhead/spreadhead_generator.rb

@@ -0,0 +1,42 @@
+require File.expand_path(File.dirname(__FILE__) + "/lib/insert_commands.rb")
+require File.expand_path(File.dirname(__FILE__) + "/lib/rake_commands.rb")
+
+class SpreadheadGenerator < Rails::Generator::Base
+
+  def manifest
+    record do |m|
+      m.insert_into "app/controllers/application_controller.rb", 
+        "include Spreadhead::Render"
+
+      page_model = "app/models/page.rb"
+      if File.exists?(page_model)
+        m.insert_into page_model, "include Spreadhead::Page"
+      else
+        m.directory File.join("app", "models")
+        m.file "page.rb", page_model
+      end
+
+      m.directory File.join("test", "factories")
+      m.file "factories.rb", "test/factories/spreadhead.rb"      
+
+      m.directory File.join("config", "initializers")
+      m.file "initializer.rb", "config/initializers/spreadhead.rb"      
+
+      m.migration_template "migrations/#{migration_name}.rb", 'db/migrate',
+        :migration_file_name => "spreadhead_#{migration_name}"
+
+      m.readme "README"
+    end
+  end
+
+  private
+
+  def migration_name
+    if ActiveRecord::Base.connection.table_exists?(:pages)
+      'update_pages'
+    else
+      'create_pages'
+    end
+  end
+
+end

data/generators/spreadhead/templates/README

@@ -0,0 +1,24 @@
+
+*******************************************************************************
+
+Ok, enough fancy automatic stuff. Time for some old school monkey copy-pasting.
+
+By default, Spreadhead restricts access to page creation, updating and deleting. 
+To implement this you will need to modify
+
+  config/initializers/spreadhead.rb
+  
+If you want to define an extension point in a view simply add:
+
+  <%= spreadhead "PAGE_URL" %> or <%= spreadhead @page %>
+
+By default, Spreadhead tries to insert the content_for the title, description,
+and keywords on your page. You can make use of these by inserting the following
+into the head section in your application layout:
+
+  <title><%= yield :title %></title>
+  <meta name="Description" content="<%= yield :description %>" />
+  <meta name="Keywords" content="<%= yield :keywords %>" />
+ 
+
+*******************************************************************************

data/generators/spreadhead/templates/factories.rb

@@ -0,0 +1,12 @@
+Factory.sequence :page_title do |n|
+  "Mr. Smith's #{n}th Request"
+end
+
+Factory.define :page do |page|
+  page.title                 { Factory.next :page_title }
+  page.text                  { "Paging Mrs. Smith" }
+  page.description           { "What Mr. Smith Says" }
+  page.keywords              { "smith paging" }
+  page.formatting            { "plain" }
+  page.published             { true }
+end

data/generators/spreadhead/templates/initializer.rb

@@ -0,0 +1,27 @@
+# Spreadhead Initializer
+#
+# In this file you can do any kind of initialization you need but it is mainly
+# for controlling which users get access to create, edit, destroy and update
+# pages. By default, any user can modify the pages. If only logged in users can 
+# do this, while everyone else can view the  pages then you can add a before 
+# filter. If you are using a toolkit like Clearance, then you can use the 
+# following:
+#
+#   module Spreadhead
+#     module PagesAuth
+#       def self.filter(controller)
+#         controller.redirect_to_root unless signed_in?
+#       end
+#     end  
+#   end    
+#
+# By default all access to creating an modifying pages is forbidden. You need
+# to make sure you trust the people creating pages because they can easily
+# inject malicious scripts using this tool.
+module Spreadhead
+  module PagesAuth
+    def self.filter(controller)
+      controller.send(:head, 403)
+    end
+  end  
+end    

data/generators/spreadhead/templates/migrations/create_pages.rb

@@ -0,0 +1,20 @@
+class SpreadheadCreatePages < ActiveRecord::Migration
+  def self.up
+    create_table(:pages) do |t|
+      t.string   :url, :null => false
+      t.string   :text, :null => false
+      t.string   :title, :null => false
+      t.string   :keywords
+      t.string   :description
+      t.string   :formatting
+      t.string   :category
+      t.boolean  :published, :default => false, :null => false
+      t.timestamps
+    end
+    add_index :pages, [:url, :id, :published]
+  end
+
+  def self.down
+    drop_table :pages
+  end
+end

data/generators/spreadhead/templates/migrations/update_pages.rb

@@ -0,0 +1,41 @@
+class SpreadheadUpdatePages < ActiveRecord::Migration
+  def self.up
+<% 
+      existing_columns = ActiveRecord::Base.connection.columns(:pages).collect { |each| each.name }
+      columns = [
+        [:url,              't.string :url, :null => false'],
+        [:text,             't.string :text, :null => false'],
+        [:title,            't.string :title, :null => false'],
+        [:keywords,         't.string :keywords'],
+        [:description,      't.string :description'],
+        [:category,         't.string :category'],
+        [:formatting,       't.string :formatting, :default => "plain", :null => false'],
+        [:published,        't.boolean :published, :default => false, :null => false']
+      ].delete_if {|c| existing_columns.include?(c.first.to_s)} 
+-%>
+    change_table(:pages) do |t|
+<% columns.each do |c| -%>
+      <%= c.last %>
+<% end -%>
+    end
+    
+<%
+    existing_indexes = ActiveRecord::Base.connection.indexes(:pages)
+    index_names = existing_indexes.collect { |each| each.name }
+    new_indexes = [
+      [:index_pages_on_id_and_url_and_published, 'add_index :pages, [:id, :url, :published]']
+    ].delete_if { |each| index_names.include?(each.first.to_s) }
+-%>
+<% new_indexes.each do |each| -%>
+    <%= each.last %>
+<% end -%>
+  end
+  
+  def self.down
+    change_table(:pages) do |t|
+<% unless columns.empty? -%>
+      t.remove <%= columns.collect { |each| ":#{each.first}" }.join(',') %>
+<% end -%>
+    end
+  end
+end

data/generators/spreadhead/templates/page.rb

@@ -0,0 +1,3 @@
+class Page < ActiveRecord::Base
+  include Spreadhead::Page
+end

data/lib/spreadhead.rb

@@ -0,0 +1,7 @@
+require 'stringex'
+require 'redcloth'
+require 'bluecloth'
+require 'spreadhead/extensions/routes'
+require 'spreadhead/page'
+require 'spreadhead/filter'
+

data/lib/spreadhead/extensions/routes.rb

@@ -0,0 +1,14 @@
+if defined?(ActionController::Routing::RouteSet)
+  class ActionController::Routing::RouteSet
+    def load_routes_with_spreadhead!
+      lib_path = File.dirname(__FILE__)
+      spreadhead_routes = File.join(lib_path, *%w[.. .. .. config spreadhead_routes.rb])
+      unless configuration_files.include?(spreadhead_routes)
+        add_configuration_file(spreadhead_routes)
+      end
+      load_routes_without_spreadhead!
+    end
+
+    alias_method_chain :load_routes!, :spreadhead
+  end
+end

data/lib/spreadhead/filter.rb

@@ -0,0 +1,7 @@
+module Spreadhead
+  module PagesAuth
+    def self.filter(controller)
+      controller.send(:head, 403)
+    end
+  end  
+end