shakespeare 0.1.0 → 0.1.1

data/README.md

@@ -1,85 +1,89 @@
-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)
-
+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
+
+You also get access to route helpers:
+
+- `admin_pages_path` and `admin_pages_url` point to the pages admin interface
+
+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

@@ -1,43 +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
-
+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.1"
+    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

@@ -1,47 +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
-
+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

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

data/app/models/page.rb

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

@@ -1,38 +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 %>
+<% form_for [:admin, @page] do |f| -%>
+  
+  <%= f.error_messages %>
+ 
+  <fieldset>
+    <%= f.label :url, "URL" %> <%= f.text_field :url %> <em>This can be an existing controller_name/action_name combo, or a completely new URL.</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 -%>