shakespeare 0.1.0

data/README.md

@@ -0,0 +1,85 @@
+Shakespeare
+===========
+
+Shakespeare is a Ruby on Rails content manager plugin.
+
+Shakespeare allows:
+
+- User-editable page titles, descriptions, meta info and content blocks for dynamic requests
+- User editable content-only pages
+
+Shakespeare is a super simple bolt-on CMS for any Rails app.
+
+Installation
+============
+
+Shakespeare is easy to install.
+
+As a plugin:
+
+    ./script/plugin install git://github.com/paulca/shakespeare.git
+
+Or as a gem. Add this to your environment.rb:
+
+    config.gem 'shakespeare'
+
+Then generate the migration to create the pages table:
+
+    ./script/generate shakespeare
+
+And run the migration:
+
+    rake db:migrate
+
+Basic Usage
+===========
+
+Once Shakespeare is installed, every controller action can now have its own content. You an access this content in the controller or the view with the `page_content` method.
+
+View Helpers
+============
+
+In your views, you have access to a number of helpers for generating your page meta-data.
+
+- `page_title` is the title of the page
+- `keywords_meta_tag` generates a <meta> tag for the page keywords, or returns nil if it's left blank
+- `description_meta_tag` generates a <meta> tag for the page description, or returns nil if it's left blank
+- `robots_meta_tag` generates a <meta> tag for the robots no-index and/or nofollow meta tag options, or returns nil if it's left blank
+- `canonical_link_tag` generates a <link> tag with the canonical URL for the page, if `enable_canonical` is set to true
+
+Web Interface
+=============
+
+Using Rails' Engines feature, Shakespeare comes with a web interface that is available to your app straight away at `http://localhost:3000/admin/pages`.
+
+By default, this comes with no styling, but you can create a layout in `app/layouts/admin.html.erb`, or set a layout by setting `Shakespare::Settings.layout`
+
+For example, to use your standard application layout, create a `config/initializers/shakespeare.rb` like this:
+
+    Shakespeare::Settings.layout = 'application'
+
+You can also add before_filters to protect the controller from outsiders:
+
+    Shakespeare::Settings.before_filters << 'require_admin_user'
+    
+By default, in production, if `Shakespeare::Settings.before_filters` is empty, `/admin/pages` is protected. You can disable this protection by setting `Behavior::Settings.allow_anonymous` to true.
+
+Running the tests
+=================
+
+You can run the tests by checking out the code into vendor/plugins of a Rails app and running:
+
+    rake
+
+It also comes with a set of cucumber features:
+
+    cucumber
+
+About me
+========
+
+I'm Paul Campbell. I'm an avid Ruby on Rails web developer. Follow my ramblings at [http://www.pabcas.com](http://www.pabcas.com)
+
+Follow me on Twitter [http://twitter.com/paulca](http://twitter.com/paulca)
+
+Copyright (c) 2009 Paul Campbell, released under the MIT license

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'app/**/*',
+  'generators/**/*',
+  'config/*',
+  'lib/**/*',
+  'rails/**/*',
+  'spec/**/*',
+  'features/**/*'
+]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "shakespeare"
+    s.version = "0.1.0"
+    s.author = "Paul Campbell"
+    s.email = "paul@rslw.com"
+    s.homepage = "http://www.github.com/paulca/shakespeare"
+    s.platform = Gem::Platform::RUBY
+    s.summary = "A Rails drop in CMS."
+    s.files = PKG_FILES.to_a
+    s.require_path = "lib"
+    s.has_rdoc = false
+    s.extra_rdoc_files = ["README.md"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+Jeweler::GemcutterTasks.new

data/app/controllers/admin/pages_controller.rb

@@ -0,0 +1,47 @@
+class Admin::PagesController < ApplicationController
+  
+  
+  Shakespeare::Settings.before_filters.each do |filter|
+    before_filter filter
+  end
+  before_filter :protect_in_production if Shakespeare::Settings.before_filters.empty?
+  
+  layout Shakespeare::Settings.layout
+  
+  def index
+    @pages = Page.all
+  end
+  
+  def new
+    @page = Page.new
+  end
+  
+  def create
+    @page = Page.new(params[:page])
+    if @page.save
+      redirect_to admin_pages_path
+    else
+      render :new
+    end
+  end
+  
+  def edit
+    @page = Page.find(params[:id])
+  end
+  
+  def update
+    @page = Page.find(params[:id])
+    if @page.update_attributes(params[:page])
+      redirect_to admin_pages_path
+    else
+      render :edit
+    end
+  end
+  
+  def destroy
+    @page = Page.find(params[:id])
+    @page.destroy
+    redirect_to admin_pages_path
+  end
+
+end

data/app/controllers/pages_controller.rb

@@ -0,0 +1,5 @@
+class PagesController < ApplicationController
+  def show
+    @page = Page.find(params[:id])
+  end
+end

data/app/models/page.rb

@@ -0,0 +1,10 @@
+class Page < ActiveRecord::Base
+  
+  def robots
+    out = []
+    out << 'noindex' if noindex?
+    out << 'nofollow' if nofollow?
+    out.join(', ')
+  end
+
+end

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

@@ -0,0 +1,38 @@
+<% form_for [:admin, @page] do |f| -%>
+  
+  <%= f.error_messages %>
+ 
+  <fieldset>
+    <%= f.label :url, "URL" %> <%= f.text_field :url %> <em><%= t('page.maps_to') %></em> <br />
+  </fieldset>
+ 
+  <fieldset>
+    <%= f.label :title, "Title" %> 
+    <%= f.text_field :title %> <br />
+  <fieldset>
+    <legend>Robots</legend>
+    
+    <%= f.check_box :noindex %>
+    <%= f.label :noindex, "No-Index", :class => 'inline' %>
+    
+    <%= f.check_box :nofollow %>
+    <%= f.label :nofollow, "No-follow", :class => 'inline' %>
+    
+    <%= f.check_box :enable_canonical %>
+    <%= f.label :enable_canonical, "Set Canonical Tag?", :class => 'inline' %>
+    
+    <%= f.label :canonical, "Canonical URL" %>
+    <%= f.text_field :canonical %> <br />
+ 
+ 
+    <%= f.label :description, "Description" %> <%= f.text_area :description, :class => "small-text" %> <br />
+    <%= f.label :keywords, "Keywords" %> <%= f.text_field :keywords %> <br />
+  </fieldset>
+  
+  <fieldset>
+    <%= f.label :content, "Content" %> <%= f.text_area :content %> <br />
+  </fieldset>
+  
+  
+  <%= f.submit "Save" %> or  <%= link_to "Cancel", admin_pages_path %>
+<% end -%>

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

@@ -0,0 +1,3 @@
+<h2>Edit Page</h2>
+
+<%= render 'form' %>

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

@@ -0,0 +1,24 @@
+<h2>Pages</h2>
+
+<ul>
+  <li><%= link_to "Add a New Page", new_admin_page_path %></li>
+</ul>
+
+<%- if @pages.empty? -%>
+  <p>No pages have been added yet.</p>
+<%- else -%>
+  <table>
+    <tr>
+      <th>Title</th>
+      <th>&nbsp;</th>
+    </tr>
+  
+    <%- @pages.each do |page| -%>
+      <tr>
+        <td><%= page.title %> (<%= link_to "Edit", edit_admin_page_path(page) %>)</td>
+        <td><%= link_to "Delete", admin_page_path(page), :method => :delete %></td>
+      </tr>
+    <%- end -%>
+  
+  </table>
+<%- end -%>

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

@@ -0,0 +1,3 @@
+<h2>Add a New Page</h2>
+
+<%= render 'form' %>

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

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <title>Admin</title>
+  </head>
+  <body>
+    <h1>Admin</h1>
+    <%= yield %>
+  </body>
+</html>

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

@@ -0,0 +1,3 @@
+<h2><%= @page.title %></h2>
+
+<%= @page.content %>

data/config/cucumber.yml

@@ -0,0 +1,7 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format progress features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "#{rerun_opts} --format rerun --out rerun.txt --strict --tags ~@wip"
+%>
+default: <%= std_opts %>
+wip: --tags @wip:3 --wip features

data/config/routes.rb

@@ -0,0 +1,8 @@
+ActionController::Routing::Routes.draw do |map|
+  
+  map.resources :pages
+  
+  map.namespace :admin do |admin|
+    admin.resources :pages
+  end
+end

data/features/admin_pages.feature

@@ -0,0 +1,38 @@
+Feature: Managing Pages
+  In order to update the site
+  As an admin
+  I want to add, edit and delete pages
+  
+  Scenario: I'm on the admin layout
+    When I am on the pages admin page
+    Then I should see "Admin"
+  
+  Scenario: New Page
+    Given I am on the pages admin page
+    When I follow "Add a New Page"
+      And I fill in "Title" with "Harry and the Hendersons"
+      And I fill in "Keywords" with "80s, movie"
+      And I check "No-index"
+      And I check "No-follow"
+      And I check "Set Canonical Tag?"
+      And I fill in "Canonical URL" with "http://hendersons.com"
+      And I press "Save"
+    Then I should see "Harry and the Hendersons"
+    
+  Scenario: Edit Page
+    Given a page titled "Harry and the Hendersons"
+      And I am on the pages admin page
+    When I follow "Edit"
+      And I fill in "Title" with "Three Men and a Baby"
+      And I press "Save"
+    Then I should see "Three Men and a Baby"
+      And I should not see "Harry and the Hendersons"
+    
+  Scenario: Delete Page
+    Given a page titled "The Departed"
+    When I am on the pages admin page
+    Then I should see "The Departed"
+
+    When I follow "Delete"
+    Then I should not see "The Departed"
+      

data/features/public_pages.feature

@@ -0,0 +1,12 @@
+Feature: Public Pages
+  In order to find out more information
+  As a user
+  I want to be able to see what's on a page
+  
+  Scenario: A public page
+    Given a page titled "Mr. MacAllister's Christmas"
+      And page "Mr. MacAllister's Christmas" has content "I was Home Alone"
+    
+    When I am on the page for "Mr. MacAllister's Christmas"
+    
+    Then I should see "I was Home Alone"

data/features/step_definitions/page_steps.rb

@@ -0,0 +1,7 @@
+Given /^a page titled "([^\"]*)"$/ do |title|
+  Page.make(:title => title)
+end
+
+Given /^page "([^\"]*)" has content "([^\"]*)"$/ do |title, content|
+  Page.find_by_title(title).update_attribute(:content, content)
+end

data/features/step_definitions/web_steps.rb

@@ -0,0 +1,259 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a 
+# newer version of cucumber-rails. Consider adding your own code to a new file 
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+
+# Commonly used webrat steps
+# http://github.com/brynary/webrat
+
+Given /^(?:|I )am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^(?:|I )press "([^\"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^(?:|I )follow "([^\"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^(?:|I )follow "([^\"]*)" within "([^\"]*)"$/ do |link, parent|
+  click_link_within(parent, link)
+end
+
+When /^(?:|I )fill in "([^\"]*)" with "([^\"]*)"$/ do |field, value|
+  fill_in(field, :with => value)
+end
+
+When /^(?:|I )fill in "([^\"]*)" for "([^\"]*)"$/ do |value, field|
+  fill_in(field, :with => value)
+end
+
+# Use this to fill in an entire form with data from a table. Example:
+#
+#   When I fill in the following:
+#     | Account Number | 5002       |
+#     | Expiry date    | 2009-11-01 |
+#     | Note           | Nice guy   |
+#     | Wants Email?   |            |
+#
+# TODO: Add support for checkbox, select og option
+# based on naming conventions.
+#
+When /^(?:|I )fill in the following:$/ do |fields|
+  fields.rows_hash.each do |name, value|
+    When %{I fill in "#{name}" with "#{value}"}
+  end
+end
+
+When /^(?:|I )select "([^\"]*)" from "([^\"]*)"$/ do |value, field|
+  select(value, :from => field)
+end
+
+# Use this step in conjunction with Rail's datetime_select helper. For example:
+# When I select "December 25, 2008 10:00" as the date and time
+When /^(?:|I )select "([^\"]*)" as the date and time$/ do |time|
+  select_datetime(time)
+end
+
+# Use this step when using multiple datetime_select helpers on a page or
+# you want to specify which datetime to select. Given the following view:
+#   <%= f.label :preferred %><br />
+#   <%= f.datetime_select :preferred %>
+#   <%= f.label :alternative %><br />
+#   <%= f.datetime_select :alternative %>
+# The following steps would fill out the form:
+# When I select "November 23, 2004 11:20" as the "Preferred" date and time
+# And I select "November 25, 2004 10:30" as the "Alternative" date and time
+When /^(?:|I )select "([^\"]*)" as the "([^\"]*)" date and time$/ do |datetime, datetime_label|
+  select_datetime(datetime, :from => datetime_label)
+end
+
+# Use this step in conjunction with Rail's time_select helper. For example:
+# When I select "2:20PM" as the time
+# Note: Rail's default time helper provides 24-hour time-- not 12 hour time. Webrat
+# will convert the 2:20PM to 14:20 and then select it.
+When /^(?:|I )select "([^\"]*)" as the time$/ do |time|
+  select_time(time)
+end
+
+# Use this step when using multiple time_select helpers on a page or you want to
+# specify the name of the time on the form.  For example:
+# When I select "7:30AM" as the "Gym" time
+When /^(?:|I )select "([^\"]*)" as the "([^\"]*)" time$/ do |time, time_label|
+  select_time(time, :from => time_label)
+end
+
+# Use this step in conjunction with Rail's date_select helper.  For example:
+# When I select "February 20, 1981" as the date
+When /^(?:|I )select "([^\"]*)" as the date$/ do |date|
+  select_date(date)
+end
+
+# Use this step when using multiple date_select helpers on one page or
+# you want to specify the name of the date on the form. For example:
+# When I select "April 26, 1982" as the "Date of Birth" date
+When /^(?:|I )select "([^\"]*)" as the "([^\"]*)" date$/ do |date, date_label|
+  select_date(date, :from => date_label)
+end
+
+When /^(?:|I )check "([^\"]*)"$/ do |field|
+  check(field)
+end
+
+When /^(?:|I )uncheck "([^\"]*)"$/ do |field|
+  uncheck(field)
+end
+
+When /^(?:|I )choose "([^\"]*)"$/ do |field|
+  choose(field)
+end
+
+# Adds support for validates_attachment_content_type. Without the mime-type getting
+# passed to attach_file() you will get a "Photo file is not one of the allowed file types."
+# error message 
+When /^(?:|I )attach the file "([^\"]*)" to "([^\"]*)"$/ do |path, field|
+  type = path.split(".")[1]
+
+  case type
+  when "jpg"
+    type = "image/jpg" 
+  when "jpeg"
+    type = "image/jpeg" 
+  when "png"
+    type = "image/png" 
+  when "gif"
+    type = "image/gif"
+  end
+  
+  attach_file(field, path, type)
+end
+
+Then /^(?:|I )should see "([^\"]*)"$/ do |text|
+  if defined?(Spec::Rails::Matchers)
+    response.should contain(text)
+  else
+    assert_contain text
+  end
+end
+
+Then /^(?:|I )should see "([^\"]*)" within "([^\"]*)"$/ do |text, selector|
+  within(selector) do |content|
+    if defined?(Spec::Rails::Matchers)
+      content.should contain(text)
+    else
+      assert content.include?(text)
+    end
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  if defined?(Spec::Rails::Matchers)
+    response.should contain(regexp)
+  else
+    assert_contain regexp
+  end
+end
+
+Then /^(?:|I )should see \/([^\/]*)\/ within "([^\"]*)"$/ do |regexp, selector|
+  within(selector) do |content|
+    regexp = Regexp.new(regexp)
+    if defined?(Spec::Rails::Matchers)
+      content.should contain(regexp)
+    else
+      assert content =~ regexp
+    end
+  end
+end
+
+Then /^(?:|I )should not see "([^\"]*)"$/ do |text|
+  if defined?(Spec::Rails::Matchers)
+    response.should_not contain(text)
+  else
+    assert_not_contain text
+  end
+end
+
+Then /^(?:|I )should not see "([^\"]*)" within "([^\"]*)"$/ do |text, selector|
+  within(selector) do |content|
+    if defined?(Spec::Rails::Matchers)
+        content.should_not contain(text)
+    else
+        assert !content.include?(text)
+    end
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  if defined?(Spec::Rails::Matchers)
+    response.should_not contain(regexp)
+  else
+    assert_not_contain regexp
+  end
+end
+
+Then /^(?:|I )should not see \/([^\/]*)\/ within "([^\"]*)"$/ do |regexp, selector|
+  within(selector) do |content|
+    regexp = Regexp.new(regexp)
+    if defined?(Spec::Rails::Matchers)
+      content.should_not contain(regexp)
+    else
+      assert content !~ regexp
+    end
+  end
+end
+
+Then /^the "([^\"]*)" field should contain "([^\"]*)"$/ do |field, value|
+  if defined?(Spec::Rails::Matchers)
+    field_labeled(field).value.should =~ /#{value}/
+  else
+    assert_match(/#{value}/, field_labeled(field).value)
+  end
+end
+
+Then /^the "([^\"]*)" field should not contain "([^\"]*)"$/ do |field, value|
+  if defined?(Spec::Rails::Matchers)
+    field_labeled(field).value.should_not =~ /#{value}/
+  else
+    assert_no_match(/#{value}/, field_labeled(field).value)
+  end
+end
+
+Then /^the "([^\"]*)" checkbox should be checked$/ do |label|
+  if defined?(Spec::Rails::Matchers)
+    field_labeled(label).should be_checked
+  else
+    assert field_labeled(label).checked?
+  end
+end
+
+Then /^the "([^\"]*)" checkbox should not be checked$/ do |label|
+  if defined?(Spec::Rails::Matchers)
+    field_labeled(label).should_not be_checked
+  else
+    assert !field_labeled(label).checked?
+  end
+end
+
+Then /^(?:|I )should be on (.+)$/ do |page_name|
+  if defined?(Spec::Rails::Matchers)
+    URI.parse(current_url).path.should == path_to(page_name)
+  else
+    assert_equal path_to(page_name), URI.parse(current_url).path
+  end
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end