shakespeare 0.2.2 → 0.3.0

data/README.md

@@ -1,89 +1,102 @@
-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)
-
+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.
+
+Format Method
+=============
+
+By default, pages can be accessed at "http://localhost:3000/pages/URL" ... `@page.content` is formatted with Rails's `simple_format` helper.
+
+You can choose not to format it with:
+
+    Shakespeare::Settings.format_method = nil
+    
+Or a choice of your own:
+
+    Shakespeare::Settings.format_method = 'textilize'
+
+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

@@ -25,7 +25,7 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |s|
     s.name = "shakespeare"
-    s.version = "0.2.2"
+    s.version = "0.3.0"
     s.author = "Paul Campbell"
     s.email = "paul@rslw.com"
     s.homepage = "http://www.github.com/paulca/shakespeare"

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

@@ -1,3 +1,7 @@
-<h2><%= @page.title %></h2>
-
-<%= @page.content %>
+<h2><%= @page.title %></h2>
+
+<%- if Shakespeare::Settings.format_method -%>
+  <%= send(Shakespeare::Settings.format_method, @page.content) %>
+<%- else -%>
+  <%= @page.content %>
+<%- end -%>

data/lib/shakespeare/settings.rb

@@ -1,30 +1,38 @@
-module Shakespeare
-  class Settings
-    class << self      
-      def layout
-        @layout ||= 'admin'
-      end
-      
-      def layout=(layout_choice)
-        @layout = layout_choice
-      end
-      
-      def before_filters
-        @before_filters ||= []
-      end
-      
-      def before_filters=(filters)
-        @before_filters ||= filters
-      end
-      
-      def allow_anonymous
-        @allow_anonymous ||= false
-      end
-      
-      def allow_anonymous=(boolean)
-        @allow_anonymous = boolean
-      end
-    end
-  end
-  
+module Shakespeare
+  class Settings
+    class << self      
+      def layout
+        @layout ||= 'admin'
+      end
+      
+      def layout=(layout_choice)
+        @layout = layout_choice
+      end
+      
+      def before_filters
+        @before_filters ||= []
+      end
+      
+      def before_filters=(filters)
+        @before_filters ||= filters
+      end
+      
+      def allow_anonymous
+        @allow_anonymous ||= false
+      end
+      
+      def allow_anonymous=(boolean)
+        @allow_anonymous = boolean
+      end
+      
+      def format_method
+        @format_method ||= 'simple_format'
+      end
+      
+      def format_method=(format_method_choice)
+        @format_method = format_method_choice
+      end
+    end
+  end
+  
 end

data/shakespeare.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{shakespeare}
-  s.version = "0.2.2"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul Campbell"]
-  s.date = %q{2010-02-15}
+  s.date = %q{2010-03-09}
   s.email = %q{paul@rslw.com}
   s.extra_rdoc_files = [
     "README.md"
@@ -64,7 +64,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://www.github.com/paulca/shakespeare}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.6}
   s.summary = %q{A Rails drop in CMS.}
   s.test_files = [
     "spec/blueprints.rb",

data/spec/debug.log

@@ -2446,3 +2446,92 @@
   Page Load (0.2ms)   SELECT * FROM "pages" WHERE ("pages"."url" = '/') LIMIT 1
   Page Load (0.2ms)   SELECT * FROM "pages" 
   Page Create (0.5ms)   INSERT INTO "pages" ("canonical", "created_at", "title", "updated_at", "url", "enable_canonical", "content", "nofollow", "description", "noindex", "enable_keywords", "keywords") VALUES(NULL, '2010-02-15 14:24:06', 'Harry B', '2010-02-15 14:24:06', 'harry-b', NULL, NULL, NULL, NULL, NULL, NULL, NULL)
+  SQL (0.3ms)   select sqlite_version(*)
+  SQL (1.5ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (26.9ms)   DROP TABLE "pages"
+  SQL (1.2ms)   CREATE TABLE "pages" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "url" varchar(255), "keywords" text, "description" text, "content" text, "created_at" datetime, "updated_at" datetime, "noindex" boolean, "nofollow" boolean, "canonical" varchar(255), "enable_canonical" boolean, "enable_keywords" boolean) 
+  SQL (0.3ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.2ms)   SELECT version FROM "schema_migrations"
+  Page Load (0.3ms)   SELECT * FROM "pages" 
+  Page Load (0.2ms)   SELECT * FROM "pages" 
+  Page Create (0.4ms)   INSERT INTO "pages" ("canonical", "created_at", "title", "updated_at", "url", "enable_canonical", "content", "nofollow", "description", "noindex", "enable_keywords", "keywords") VALUES('http://hendersons.com', '2010-03-09 17:50:25', 'Harry and the Hendersons', '2010-03-09 17:50:25', '', 't', '', 't', '', 't', NULL, '80s, movie')
+  Page Load (0.3ms)   SELECT * FROM "pages" 
+  Page Create (0.4ms)   INSERT INTO "pages" ("canonical", "created_at", "title", "updated_at", "url", "enable_canonical", "content", "nofollow", "description", "noindex", "enable_keywords", "keywords") VALUES(NULL, '2010-03-09 17:50:25', 'Harry and the Hendersons', '2010-03-09 17:50:25', 'kundesmith.co.uk', NULL, NULL, NULL, NULL, NULL, NULL, NULL)
+  Page Load (0.3ms)   SELECT * FROM "pages" WHERE ("pages"."id" = 1) 
+  Page Load (0.3ms)   SELECT * FROM "pages" 
+  Page Load (0.3ms)   SELECT * FROM "pages" WHERE ("pages"."url" = 'kundesmith.co.uk') LIMIT 1
+  Page Load (0.4ms)   SELECT * FROM "pages" WHERE ("pages"."url" = 'kundesmith.co.uk') LIMIT 1
+  Page Update (0.1ms)   UPDATE "pages" SET "keywords" = '', "updated_at" = '2010-03-09 17:50:25', "title" = 'Three Men and a Baby', "content" = '', "nofollow" = 'f', "canonical" = '', "description" = '', "noindex" = 'f', "enable_canonical" = 'f' WHERE "id" = 1
+  Page Load (0.3ms)   SELECT * FROM "pages" 
+  Page Create (0.4ms)   INSERT INTO "pages" ("canonical", "created_at", "title", "updated_at", "url", "enable_canonical", "content", "nofollow", "description", "noindex", "enable_keywords", "keywords") VALUES(NULL, '2010-03-09 17:50:25', 'The Departed', '2010-03-09 17:50:25', 'kautzergoyette.name', NULL, NULL, NULL, NULL, NULL, NULL, NULL)
+  Page Load (0.3ms)   SELECT * FROM "pages" WHERE ("pages"."id" = 1) 
+  Page Load (0.4ms)   SELECT * FROM "pages" 
+  Page Load (0.4ms)   SELECT * FROM "pages" WHERE ("pages"."url" = 'kautzergoyette.name') LIMIT 1
+  Page Destroy (0.1ms)   DELETE FROM "pages" WHERE "id" = 1
+  Page Load (0.2ms)   SELECT * FROM "pages" 
+  Page Create (0.4ms)   INSERT INTO "pages" ("canonical", "created_at", "title", "updated_at", "url", "enable_canonical", "content", "nofollow", "description", "noindex", "enable_keywords", "keywords") VALUES(NULL, '2010-03-09 17:50:25', 'Mr. MacAllister''s Christmas', '2010-03-09 17:50:25', 'gutmann.ca', NULL, NULL, NULL, NULL, NULL, NULL, NULL)
+  Page Load (0.4ms)   SELECT * FROM "pages" WHERE ("pages"."id" = 1) 
+  Page Load (0.3ms)   SELECT * FROM "pages" WHERE ("pages"."title" = 'Mr. MacAllister''s Christmas') LIMIT 1
+  Page Update (0.1ms)   UPDATE "pages" SET "updated_at" = '2010-03-09 17:50:25', "content" = 'I was Home Alone' WHERE "id" = 1
+  Page Load (2.1ms)   SELECT * FROM "pages" WHERE ("pages"."title" = 'Mr. MacAllister''s Christmas') LIMIT 1
+  Page Load (0.3ms)   SELECT * FROM "pages" WHERE ("pages"."url" = 'gutmann.ca') LIMIT 1
+  SQL (0.2ms)   select sqlite_version(*)
+  SQL (0.5ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (2.8ms)   DROP TABLE "pages"
+  SQL (1.5ms)   CREATE TABLE "pages" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "url" varchar(255), "keywords" text, "description" text, "content" text, "created_at" datetime, "updated_at" datetime, "noindex" boolean, "nofollow" boolean, "canonical" varchar(255), "enable_canonical" boolean, "enable_keywords" boolean) 
+  SQL (0.3ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.2ms)   SELECT version FROM "schema_migrations"
+  Page Load (0.2ms)   SELECT * FROM "pages" 
+  Page Load (0.2ms)   SELECT * FROM "pages" 
+  Page Create (3.2ms)   INSERT INTO "pages" ("canonical", "created_at", "title", "updated_at", "url", "enable_canonical", "content", "nofollow", "description", "noindex", "enable_keywords", "keywords") VALUES('http://hendersons.com', '2010-03-09 17:53:13', 'Harry and the Hendersons', '2010-03-09 17:53:13', '', 't', '', 't', '', 't', NULL, '80s, movie')
+  Page Load (0.4ms)   SELECT * FROM "pages" 
+  Page Create (0.4ms)   INSERT INTO "pages" ("canonical", "created_at", "title", "updated_at", "url", "enable_canonical", "content", "nofollow", "description", "noindex", "enable_keywords", "keywords") VALUES(NULL, '2010-03-09 17:53:13', 'Harry and the Hendersons', '2010-03-09 17:53:13', 'kundesmith.co.uk', NULL, NULL, NULL, NULL, NULL, NULL, NULL)
+  Page Load (0.3ms)   SELECT * FROM "pages" WHERE ("pages"."id" = 1) 
+  Page Load (0.4ms)   SELECT * FROM "pages" 
+  Page Load (0.4ms)   SELECT * FROM "pages" WHERE ("pages"."url" = 'kundesmith.co.uk') LIMIT 1
+  Page Load (0.4ms)   SELECT * FROM "pages" WHERE ("pages"."url" = 'kundesmith.co.uk') LIMIT 1
+  Page Update (0.2ms)   UPDATE "pages" SET "keywords" = '', "updated_at" = '2010-03-09 17:53:14', "title" = 'Three Men and a Baby', "content" = '', "nofollow" = 'f', "canonical" = '', "description" = '', "noindex" = 'f', "enable_canonical" = 'f' WHERE "id" = 1
+  Page Load (0.4ms)   SELECT * FROM "pages" 
+  Page Create (0.6ms)   INSERT INTO "pages" ("canonical", "created_at", "title", "updated_at", "url", "enable_canonical", "content", "nofollow", "description", "noindex", "enable_keywords", "keywords") VALUES(NULL, '2010-03-09 17:53:14', 'The Departed', '2010-03-09 17:53:14', 'kautzergoyette.name', NULL, NULL, NULL, NULL, NULL, NULL, NULL)
+  Page Load (0.4ms)   SELECT * FROM "pages" WHERE ("pages"."id" = 1) 
+  Page Load (0.4ms)   SELECT * FROM "pages" 
+  Page Load (0.4ms)   SELECT * FROM "pages" WHERE ("pages"."url" = 'kautzergoyette.name') LIMIT 1
+  Page Destroy (0.1ms)   DELETE FROM "pages" WHERE "id" = 1
+  Page Load (0.2ms)   SELECT * FROM "pages" 
+  Page Create (0.6ms)   INSERT INTO "pages" ("canonical", "created_at", "title", "updated_at", "url", "enable_canonical", "content", "nofollow", "description", "noindex", "enable_keywords", "keywords") VALUES(NULL, '2010-03-09 17:53:14', 'Mr. MacAllister''s Christmas', '2010-03-09 17:53:14', 'gutmann.ca', NULL, NULL, NULL, NULL, NULL, NULL, NULL)
+  Page Load (0.4ms)   SELECT * FROM "pages" WHERE ("pages"."id" = 1) 
+  Page Load (0.3ms)   SELECT * FROM "pages" WHERE ("pages"."title" = 'Mr. MacAllister''s Christmas') LIMIT 1
+  Page Update (0.2ms)   UPDATE "pages" SET "updated_at" = '2010-03-09 17:53:14', "content" = 'I was Home Alone' WHERE "id" = 1
+  Page Load (0.4ms)   SELECT * FROM "pages" WHERE ("pages"."title" = 'Mr. MacAllister''s Christmas') LIMIT 1
+  Page Load (0.4ms)   SELECT * FROM "pages" WHERE ("pages"."url" = 'gutmann.ca') LIMIT 1
+  SQL (0.2ms)   select sqlite_version(*)
+  SQL (0.4ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (1.7ms)   DROP TABLE "pages"
+  SQL (1.6ms)   CREATE TABLE "pages" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "url" varchar(255), "keywords" text, "description" text, "content" text, "created_at" datetime, "updated_at" datetime, "noindex" boolean, "nofollow" boolean, "canonical" varchar(255), "enable_canonical" boolean, "enable_keywords" boolean) 
+  SQL (0.3ms)    SELECT name
+ FROM sqlite_master
+ WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+
+  SQL (0.2ms)   SELECT version FROM "schema_migrations"
+  Page Load (0.2ms)   SELECT * FROM "pages" WHERE ("pages"."url" = '/') LIMIT 1
+  Page Load (0.2ms)   SELECT * FROM "pages" WHERE ("pages"."url" = '/') LIMIT 1
+  Page Load (1.7ms)   SELECT * FROM "pages" WHERE ("pages"."url" = '/') LIMIT 1
+  Page Load (0.2ms)   SELECT * FROM "pages" WHERE ("pages"."url" = '/') LIMIT 1
+  Page Load (0.3ms)   SELECT * FROM "pages" WHERE ("pages"."url" = '/') LIMIT 1
+  Page Load (0.2ms)   SELECT * FROM "pages" 
+  Page Create (2.0ms)   INSERT INTO "pages" ("canonical", "created_at", "title", "updated_at", "url", "enable_canonical", "content", "nofollow", "description", "noindex", "enable_keywords", "keywords") VALUES(NULL, '2010-03-09 17:53:25', 'Harry B', '2010-03-09 17:53:25', 'harry-b', NULL, NULL, NULL, NULL, NULL, NULL, NULL)

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: shakespeare
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Paul Campbell
@@ -9,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-15 00:00:00 +00:00
+date: 2010-03-09 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -79,18 +84,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A Rails drop in CMS.