darthapo-comatose 2.0

data/CHANGELOG

@@ -0,0 +1,171 @@
+- version: 2.0 (uber alpha)
+    - Removed controllers, models, and helpers from Comatose module. It was causing odd issues
+    - Initial support for Rails 2.1(ish)
+    - Fixed up slug generation to remove leading and trailing whitespace
+    - Moved to github
+    - Changed all the .rhtml files to .html.erb
+    - Adding support for use as a gem plugin
+    
+- version: 0.8.1
+  changes:
+    - All includes and helpers are loaded at the end of the ComatoseController and ComatoseAdminController classes
+    - Fixed the ComatoseController#show action to correctly send an HTTP status of 404 even if it finds, and renders, a page at '/404'
+    - Fixed the migration to default a page's full_path to '' instead of null
+    - Formalized ComatoseDrops. Use Comatose.define_drop "drop_name", do ... end. Every method within that block should return a value for use with a Liquid and/or ERB template. Usage in a comatose page: {{ drop_name.def_name }}
+    - Added support for a config.after_setup block that gets called after Comatose is setup (in the Dispatcher#to_prepare event)
+    - Added HTML comment output for calls that result in a method_missing on the ProcessingContext
+    - Updated page tree to remember collapsed/expanded nodes between page visits
+    - Fixed some errors that were caused by null revisions (usually happened after initial installation)
+    - Added my javascript test_runner lib for testing slugs generated by JavaScript. More JS tests to come.
+    - Bugfix #8640 (rubyforge bug)
+
+- version: 0.8
+  changes:
+    - Now ONLY supports Rails 1.2 (not even tested in Rails 1.1)
+    - New configuration system
+    - DEFER_COMATOSE_LOAD is gone -- Using Dispatcher.to_prepare replaces it
+    - You no longer extend the base classes to add functionality. You configure Comatose to include modules and send it symbols for providing said functionality. e.g. Comatose.config.includes << :authentiation_system; Comatose.config.authorization = :require_login
+    - The automatic loading of RAILS_ROOT/lib/comatose/*.rb files is NO longer supported. 
+    - In addition to mapping comatose_root in your routes.rb, you'll want to map.comatose_admin as well
+
+- version: 0.7.1
+  changes:
+    - A new DEFER_COMATOSE_LOAD flag is defined in the init.rb -- if you manually set it to `true`, you'll need to call Comatose.load in your environment.rb, but this should combat a lot of the plugin incompatiblities Coamtose has been suffering from
+    - The revisions link on the edit page is now only shown if you have revisions
+
+- version: 0.7
+  changes:
+    - Finally, page versioning via Rick Olsen's excellent acts_as_versioned! (included)
+    - Tries to load any text filters, tags/drops, or extensions under RAILS_ROOT/lib/comatose/ (actually it just `require`'s every .rb file in that folder) so you no longer need to muck around with adding stuff in your environment.rb file
+    - Previewing a page no longer updates it
+
+- version: 0.6.9
+  changes:
+    - The page context now supports page.next, page.last, page.first_child, page.last_child
+
+- version: 0.6.8
+  changes:
+    - Bugfix ComatoseController now references plugin_layout_path correctly from the class method
+    - Some HTML/CSS/JS cleanup on the administration view -- should degrade to straight HTML pretty well now
+
+- version: 0.6.7
+  changes:
+    - Removed Comatose::Page.record_timestamps = false -- it was breaking the magic. Override the record_timestamp methds instead
+    - AdminController was still referencing, in a few places, ComatoseController for page cache expiration 
+
+- version: 0.6.6
+  changes:
+    - The cache expiration code is now on the ComatoseAdminController, as it should have been in the first place
+    - Changed internal references from root_paths or cms_root to mount_point, since that's what I've started calling them... And it seems to make the most sense
+    - Cleaned up the class_options code
+    - Added initial support for pre-caching pages (generating static HTML), there's not a UI element for it yet, however
+    - Changes to content-type handling:
+    - Removed Comatose::Options.force_utf8
+    - Added Support for Comatose::Options.content_type = "utf-8" This will affect the HTTP headers, as well as the META tag in the admin views
+    - Changed this log file to yaml format. And yes, there's a method to my madness... Wait for it.
+
+- version: 0.6.5
+  changes:
+    - Fixed a bug in comatose_admin.js -- if you hid any of the meta_fields it would barf
+
+- version: 0.6.4
+  changes:
+    - Fixed a typo in comatose_admin_customize.rhtml
+    - Controller now keeps all information about mount points not just the :root (uri) and :index (page tree)
+
+- version: 0.6.3
+  changes:
+    - Fixed the customization tasks
+    - Added support for the new Routes system in Edge Rails
+    - Removed the getting started guide -- it's now available at: http://comatose.rubyforge.org/getting-started-guide
+
+- version: 0.6.2
+  changes:
+    - Fixed an issue with named_routes
+
+- version: 0.6.1
+  changes:
+    - Fixed a migration issue
+
+- version: 0.6
+  changes:
+    - Split out the admin from the ComatoseController into a new ComatoseAdminController class.
+    - Moved controllers/model into Comatose module, now ComatoseController extends Comatose::Controller, and ComatoseAdminController extends Comatose::AdminController. And they extend your ApplicationController ComatoseController
+    - Created a Comatose::Options class for configuration.
+    - Add Liquid support to Text Processing -- made it the default processor.
+    - Added support for adding 'tags' to processing context. They are Liquid Drops when using Liquid for processing, use like objects/methods when in ERB
+    - Changed comatose.css, comatose.js, and app/views/comatose to comatose_admin.css, comatose_admin.js, and app/views/comatose_admin
+    - Changed the names of some of the internals... ComatoseBinding is now Comatose::ProcessingContext, ComatosePageWrapper is Comatose::PageWrapper
+    - Bugfix: PostgreSQL need the scope to be a symbol instead of a string, eh? Fine -- it is so. (Thanks to Lyle for the fix)
+    - Added support for named routes... Anytime you use map.comatose_*, if * isn't 'root', it will use it as a named route
+
+- version: 0.5
+  changes:
+    - Added support for parameterized inline rendering of comatose pages. Uselike a partial: render :comatose=>'path', :locals=>{:username=>'stuff'} the locals hash will be sent to the ERB context for use when rendering the page.
+    - Support for a Hash ERB context exists all the way down to the TextFilters.
+    - Initial support for fragment caching for inline rendering. It's turned off by default. Send :use_cache=>true in the render :comatose=>'' tag to use it.  Caching will also not be used if you are sending the page parameters via the :locals hash. Oh, and don't forget to set your ActionController::Base.fragment_cache_store
+    - Return reloadable? false for the ComatoseController by default... This should prevent the development mode hassles people have been having.
+    - Updated data migration tasks to better support nested pages.
+    - comatose:data:export FROM=page_path TO_FILE=file_path
+    - comatose:data:import TO=page_path FROM_FILE=file_path
+    - FROM_FILE and TO_FILE default to 'db/comatose-pages.yml'
+    - FROM and TO default to '', the page tree root
+    - Fixed 'Clear Page Cache' bug -- it didn't handle the page root being an array like it should have.
+    - Removed :page_title and :page_keywords from session
+    - Updated the rails_version in the about.yml to 1.1+ -- just because I haven't tested it on anything less than that. If you have, and it works, let me know!
+    - Adds the utf8 header to all output (text/html; charset=utf-8). Use ComatoseController.force_utf8 = false to disable.
+    - Initial support for page reordering (via AJAX)
+    - Updated the administration look-n-feel.
+
+- version: 0.4
+  changes:
+    - Added keywords field
+    - Abstracted text filters into a micro plugin structure, default support for Textile, Markdown, and RDoc
+    - It will only show the filters as a choice in the admin if you have the necessary libraries for the filters to function.
+    - Added ComatoseController.hidden_meta_fields = [] as a way of showing/hiding the meta fields
+    - The comatose_migration generator now accepts an --upgrade flag which will create a micro migration that only has the new fields in it
+    - get_root_page will now support returning an array of root pages to show in the admin page list
+    - Created some initial tests... (Can you tell I'm not a test _first_ guy?)
+    - Inline rendering now handles :silent flag -- it will just return and empty string if :silent=>true
+    - Modified all the internal references to ComatoseController to self.class.The views reference controller.class. Redirects redirect to :controller=>self.controller_name or controller.controller_name (action and view respectively). This show allow you to sub-class the ComatoseController.
+
+- version: 0.3.1
+  changes:
+    - Abstracted retrieval of root comatose page to allow multi-user/limited view support
+    - Added redcloth so there are now no external dependencies... Other than Rails, of course ;-)
+    - DRYed up the folder structure a bit
+    - Added a Rakefile
+    - Made this ChangeLog more human-readable
+
+- version: 0.3
+  changes:
+    - Added support for running entirely from the plugin
+    - Added support for hierarchal pages
+    - Pages are pre-filtered by ERB, therefor ERB can generate Textile
+    - Comatose binding object
+    - Used with ERB context to protect AR model
+    - Has a few helper methods too: link, include
+    - Migration updated
+    - rendered_body removed, not much sense with ERB pre-processing and page-caching
+    - full_path added for easy access to child pages
+    - position, and author fields for future use
+    - Administration Updates
+    - Page listing is now a collapsible tree view
+    - Page edit supports previewing the content
+    - Preview textile only for new pages, full ERB previews for existing pages
+    - ERB errors show up as AR errors
+    - Shows Title and Body fields by default, clicking 'more...' makes Slug and Parent visible
+    - CSS updates to lighten it up a bit
+
+- version: 0.2
+  changes:
+    - Added support for rendering pages inline
+    - Added support for expiring entire page cache
+    - Added support for properly expiring pages when they are modified or deleted
+    - Update stylesheets, generally made it usable
+    - Fixed #new action
+    - Minor tweaks
+
+- version: 0.1
+  changes:
+    - First mostly-working version

data/INSTALL

@@ -0,0 +1,19 @@
+
+======================
+ Welcome to Comatose!
+======================
+
+From here you'll want to run:
+
+  $ ./script/generate comatose_migration
+
+When that's finished, run:
+
+  $ rake db:migrate
+
+That's it for the Comatose setup! Now just add the following line to the bottom of your config/routes.rb file:
+
+  map.comatose_admin
+  map.comatose_root ''
+
+Be sure to read the README file, and the 'Getting Started' guide. They are located at vendor/plugins/comatose/README and http://comatose.rubyforge.org/getting-started-guide respectively.

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2006 Matthew McCray [ http://www.mattmccray.com ]
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sub-license, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NON-INFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/MANIFEST

@@ -0,0 +1,91 @@
+about.yml
+bin/comatose
+CHANGELOG
+generators/comatose_migration/comatose_migration_generator.rb
+generators/comatose_migration/templates/migration.rb
+generators/comatose_migration/templates/v4_upgrade.rb
+generators/comatose_migration/templates/v6_upgrade.rb
+generators/comatose_migration/templates/v7_upgrade.rb
+generators/comatose_migration/USAGE
+init.rb
+INSTALL
+install.rb
+lib/acts_as_versioned.rb
+lib/comatose/comatose_drop.rb
+lib/comatose/configuration.rb
+lib/comatose/page_wrapper.rb
+lib/comatose/processing_context.rb
+lib/comatose/tasks/admin.rb
+lib/comatose/tasks/data.rb
+lib/comatose/tasks/setup.rb
+lib/comatose/version.rb
+lib/comatose.rb
+lib/comatose_admin_controller.rb
+lib/comatose_admin_helper.rb
+lib/comatose_controller.rb
+lib/comatose_helper.rb
+lib/comatose_page.rb
+lib/liquid/block.rb
+lib/liquid/context.rb
+lib/liquid/document.rb
+lib/liquid/drop.rb
+lib/liquid/errors.rb
+lib/liquid/extensions.rb
+lib/liquid/file_system.rb
+lib/liquid/htmltags.rb
+lib/liquid/standardfilters.rb
+lib/liquid/standardtags.rb
+lib/liquid/strainer.rb
+lib/liquid/tag.rb
+lib/liquid/template.rb
+lib/liquid/variable.rb
+lib/liquid.rb
+lib/redcloth.rb
+lib/support/class_options.rb
+lib/support/inline_rendering.rb
+lib/support/route_mapper.rb
+lib/text_filters/markdown.rb
+lib/text_filters/markdown_smartypants.rb
+lib/text_filters/none.rb
+lib/text_filters/rdoc.rb
+lib/text_filters/simple.rb
+lib/text_filters/textile.rb
+lib/text_filters.rb
+LICENSE
+MANIFEST
+rails/init.rb
+Rakefile
+README.rdoc
+resources/layouts/comatose_admin_template.html.erb
+resources/public/images/collapsed.gif
+resources/public/images/expanded.gif
+resources/public/images/no-children.gif
+resources/public/images/page.gif
+resources/public/images/spinner.gif
+resources/public/images/title-hover-bg.gif
+resources/public/javascripts/comatose_admin.js
+resources/public/stylesheets/comatose_admin.css
+SPECS
+tasks/comatose.rake
+test/behaviors.rb
+test/fixtures/comatose_pages.yml
+test/functional/comatose_admin_controller_test.rb
+test/functional/comatose_controller_test.rb
+test/javascripts/test.html
+test/javascripts/test_runner.js
+test/test_helper.rb
+test/unit/class_options_test.rb
+test/unit/comatose_page_test.rb
+test/unit/processing_context_test.rb
+test/unit/text_filters_test.rb
+views/comatose_admin/_form.html.erb
+views/comatose_admin/_page_list_item.html.erb
+views/comatose_admin/delete.html.erb
+views/comatose_admin/edit.html.erb
+views/comatose_admin/index.html.erb
+views/comatose_admin/new.html.erb
+views/comatose_admin/reorder.html.erb
+views/comatose_admin/versions.html.erb
+views/layouts/comatose_admin.html.erb
+views/layouts/comatose_admin_customize.html.erb
+views/layouts/comatose_content.html.erb

data/README.rdoc

@@ -0,0 +1,148 @@
+= Comatose
+
+Version:: 2.0 (uber-alpha)
+Author::  M@ McCray
+Website:: comatose.rubyforge.org
+Email::   matt at elucidata dot net
+
+
+*Comatose* is a micro CMS designed for being embedded into existing Rails 
+applications.
+
+It's intended for simple CMS support. Comatose supports 
+
+ * Nested pages
+ * Versioning
+ * Page markup in Textile, Markdown, RDoc, or easily add your own 
+ * Page processing through Liquid or ERb
+ * Generators for easy installation/migration
+ * Completely self-contained within plugin folder
+
+It's meant to be lean, mean, easily embedded, and easy to re-skin for 
+existing applications. If you need something more, I would recommend 
+looking into Radiant.
+
+For more information, see the 'Getting Started' guide: http://comatose.rubyforge.org
+
+=== Requirements
+
+ * Rails 2+ (2.1)
+ * <tt>acts_as_list</tt> and <tt>acts_as_tree</tt> plugins are required
+
+
+=== Development Notes
+
+*NOTE*: This is an active branch of Comatose that is built specifically for Rails 2.1.
+        I will *probably* remove any legacy support.
+
+ * Make comatose fully self-contained, which means removing acts_as_(tree|list)
+ * Move to gem plugin
+ * Comatose.configure needs to be an initializer (update docs)
+ * Go through bugs on 1x branch from google code and ensure they are fixed
+ * Give access to all the default rails helpers to Comatose Pages by default?
+
+
+== Installation
+
+*Note*: See the 'Upgrading' section if you already have an older version of 
+        the comatose plugin installed.
+
+  $ ./script/plugin source http://mattmccray.com/svn/rails/plugins
+  $ ./script/plugin install comatose
+  $ ./script/generate comatose_migration
+  $ rake migrate
+
+Open your <tt>routes.rb</tt> and add the comatose root route at the 
+bottom:
+
+  map.comatose_admin
+  map.comatose_root ''
+
+That's it, you're ready to go! You should be able to browse to 
+http://127.0.0.1:3000/comatose_admin and start adding pages to your CMS. 
+Browsing to http://127.0.0.1:3000/ will render your comatose pages if 
+routing doesn't match any of your controllers. 
+
+
+== Upgrading
+
+*NOTE*: This is an experimental 2.0 branch, so upgrading is possible at
+        the moment, but these instructions may not work for much longer.
+
+If you are upgrading from an older version of Comatose (version 0.3, 
+0.4, 0.5, or 0.6), then you will need to re-install the comatose 
+plugin and run:
+
+  $ ./script/plugin remove comatose
+  $ ./script/plugin install comatose
+  $ ./script/generate comatose_migration --upgrade --from=VERSION
+  $ rake migrate
+
+*Note*: Be sure to set the <tt>--from</tt> parameter to the version of
+Comatose you last had installed. Also, you only need to first two digits,
+including the dot, of the version you are upgrading from. For example, if
+you're upgrading from version 0.6.9 you can use:
+
+  $ ./script/generate comatose_migration --upgrade --from=0.6
+
+This will create the upgrade migration(s) for you. It just adds the new 
+fields, so you can keep the original migration comatose created.
+
+
+== Configuration
+
+You configure Comatose in your `config/environment.rb` file. Here is an example
+configuration block:
+
+	Comatose.configure do |config|
+	  # Sets the text in the Admin UI's title area
+	  config.admin_title = "Site Content"
+	  config.admin_sub_title = "Content for the rest of us..."
+	end
+
+Here's an example that uses the AuthentiationSystem as generated by the
+restful_authentication plugin:
+
+	Comatose.configure do |config|
+	  # Includes AuthenticationSystem in the ComatoseController
+	  config.includes << :authenticated_system
+
+	  # admin 
+	  config.admin_title = "Comatose - TESTING"
+	  config.admin_sub_title = "Content for the rest of us..."
+	
+	  # Includes AuthenticationSystem in the ComatoseAdminController
+	  config.admin_includes << :authenticated_system
+	  
+	  # Calls :login_required as a before_filter
+	  config.admin_authorization = :login_required
+	  # Returns the author name (login, in this case) for the current user
+	  config.admin_get_author do
+	    current_user.login
+	  end
+	end
+
+
+== Extra Credit
+
+This plugin includes the work of many wonderful contributors to the Railsphere. 
+Following are the specific libraries that are distributed with Comatose. If I've 
+missed someone/something please let me know.
+
+ * Liquid (http://home.leetsoft.com/liquid) by Tobias Luetke (http://blog.leetsoft.com) 
+ * RedCloth (http://whytheluckystiff.net/ruby/redcloth) by why the lucky stiff (http://whytheluckystiff.net)
+ * Acts as Versioned (http://ar-versioned.rubyforge.org) by Rick Olsen (http://weblog.techno-weenie.net)
+ * Behaviors (http://behaviors.rubyforge.org) by Atomic Object LLC -- very nice BDD-like testing library
+
+== Feedback
+
+I’ve released Comatose under the MIT license. Which basically means you 
+can use it however you want.
+
+Don't forget to read the 'Getting Started' guide located on the RubyForge
+project site: http://comatose.rubyforge.org/getting-started-guide
+
+If you like it, hate it, or have some ideas for new features, let me know!
+
+darthapo at gmail dot com
+