strelka-cms 0.0.1.pre.15

data/ChangeLog

@@ -0,0 +1,33 @@
+2012-06-29  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgignore, .pryrc, .rvm.gems, .rvmrc, History.rdoc, Manifest.txt,
+	Procfile, README.rdoc, Rakefile, data/strelka-cms/apps/content-
+	feeds, data/strelka-cms/apps/content-manager, data/strelka-
+	cms/templates/autoindex/default.tmpl, data/strelka-
+	cms/templates/layout.tmpl, data/strelka-cms/templates/page.tmpl,
+	etc/config.yml, etc/mongrel.rb, lib/strelka/cms.rb,
+	lib/strelka/cms/page.rb, lib/strelka/cms/pagecatalog.rb,
+	lib/strelka/cms/pagefilter.rb,
+	lib/strelka/cms/pagefilter/autoindex.rb,
+	lib/strelka/cms/pagefilter/cleanup.rb,
+	lib/strelka/cms/pagefilter/editorial.rb,
+	lib/strelka/cms/pagefilter/example.rb,
+	lib/strelka/cms/pagefilter/strip.rb,
+	lib/strelka/cms/pagefilter/textile.rb, public/humans.txt,
+	public/images/misc/button-gloss.png, public/images/misc/button-
+	overlay.png, public/images/misc/custom-form-sprites.png,
+	public/images/misc/input-bg-outset.png, public/images/misc/input-
+	bg.png, public/images/misc/modal-gloss.png, public/images/misc
+	/table-sorter.png, public/images/orbit/bullets.jpg,
+	public/images/orbit/left-arrow.png, public/images/orbit/loading.gif,
+	public/images/orbit/mask-black.png, public/images/orbit/pause-
+	black.png, public/images/orbit/right-arrow.png, public/images/orbit
+	/rotator-black.png, public/images/orbit/timer-black.png,
+	public/index.page, public/javascripts/app.js,
+	public/javascripts/foundation.js, public/javascripts/jquery.min.js,
+	public/javascripts/modernizr.foundation.js, public/robots.txt,
+	public/stylesheets/app.css, public/stylesheets/foundation.css,
+	public/stylesheets/ie.css, spec/data/test.page, spec/lib/helpers.rb,
+	spec/strelka/cms/page_spec.rb, spec/strelka/cms_spec.rb:
+	Initial commit
+	[5f4c4eb6ef5b] [tip]

data/History.rdoc

@@ -0,0 +1,4 @@
+== v0.0.1 [2012-06-29] Michael Granger <ged@FaerieMUD.org>
+
+Initial release.
+

data/Manifest.txt

@@ -0,0 +1,52 @@
+ChangeLog
+History.rdoc
+Manifest.txt
+Procfile
+README.rdoc
+Rakefile
+data/strelka-cms/apps/content-feeds
+data/strelka-cms/apps/content-manager
+data/strelka-cms/templates/autoindex/default.tmpl
+data/strelka-cms/templates/layout.tmpl
+data/strelka-cms/templates/page.tmpl
+etc/mongrel.rb
+lib/strelka/cms.rb
+lib/strelka/cms/page.rb
+lib/strelka/cms/pagecatalog.rb
+lib/strelka/cms/pagefilter.rb
+lib/strelka/cms/pagefilter/autoindex.rb
+lib/strelka/cms/pagefilter/cleanup.rb
+lib/strelka/cms/pagefilter/editorial.rb
+lib/strelka/cms/pagefilter/example.rb
+lib/strelka/cms/pagefilter/strip.rb
+lib/strelka/cms/pagefilter/textile.rb
+public/humans.txt
+public/images/misc/button-gloss.png
+public/images/misc/button-overlay.png
+public/images/misc/custom-form-sprites.png
+public/images/misc/input-bg-outset.png
+public/images/misc/input-bg.png
+public/images/misc/modal-gloss.png
+public/images/misc/table-sorter.png
+public/images/orbit/bullets.jpg
+public/images/orbit/left-arrow.png
+public/images/orbit/loading.gif
+public/images/orbit/mask-black.png
+public/images/orbit/pause-black.png
+public/images/orbit/right-arrow.png
+public/images/orbit/rotator-black.png
+public/images/orbit/timer-black.png
+public/index.page
+public/javascripts/app.js
+public/javascripts/foundation.js
+public/javascripts/jquery.min.js
+public/javascripts/modernizr.foundation.js
+public/robots.txt
+public/stylesheets/app.css
+public/stylesheets/foundation.css
+public/stylesheets/ie.css
+spec/data/test.page
+spec/lib/helpers.rb
+spec/strelka/cms/page_spec.rb
+spec/strelka/cms/pagecatalog_spec.rb
+spec/strelka/cms_spec.rb

data/Procfile

@@ -0,0 +1,4 @@
+# Foreman Procfile
+mongrel: m2sh.rb -c strelka.sqlite start
+cms: strelka -l debug -c etc/config.yml start content-manager
+feeds: strelka -l debug -c etc/config.yml start content-feeds

data/README.rdoc

@@ -0,0 +1,74 @@
+= Strelka CMS
+
+home :: https://bitbucket.org/ged/strelka-cms
+github :: https://github.com/ged/strelka-cms
+docs :: http://deveiate.org/code/strelka-cms
+
+
+== Description
+
+This is a content-management application for Mongrel2 servers
+written as a Strelka plugin.
+
+
+== Prerequisites
+
+* Strelka
+* Ruby 1.9.3 or better
+
+
+== Installation
+
+    $ gem install strelka-cms
+    $ strelka setup --config mongrel2.sqlite \
+	                --server main \
+					--url /docs \
+					--append
+					strelka-cms content-manager
+
+
+== Contributing
+
+You can check out the current development source with Mercurial via its
+{project page}[https://bitbucket.org/ged/strelka-cms]. Or if you prefer Git, via 
+{its Github mirror}[https://github.com/ged/strelka-cms].
+
+After checking out the source, run:
+
+    $ rake newb
+
+This task will install any missing dependencies, run the tests/specs,
+and generate the API documentation.
+
+
+== License
+
+Copyright (c) 2012, Michael Granger
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the author/s, nor the names of the project's
+  contributors may be used to endorse or promote products derived from this
+  software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+

data/Rakefile

@@ -0,0 +1,68 @@
+#!/usr/bin/env rake
+
+require 'rake/clean'
+
+begin
+	require 'hoe'
+rescue LoadError
+	abort "This Rakefile requires 'hoe' (gem install hoe)"
+end
+
+Hoe.plugin :mercurial
+Hoe.plugin :signing
+Hoe.plugin :manualgen
+Hoe.plugin :deveiate
+
+Hoe.plugins.delete :rubyforge
+
+hoespec = Hoe.spec 'strelka-cms' do
+	self.readme_file = 'README.rdoc'
+	self.history_file = 'History.rdoc'
+	self.extra_rdoc_files = FileList[ '*.rdoc' ]
+
+	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
+
+	self.dependency 'strelka',       '~> 0.0'
+	self.dependency 'ratom',         '~> 0.6'
+	self.dependency 'RedCloth',      '~> 4.2'
+	self.dependency 'summarize',     '~> 1.0'
+	self.dependency 'nokogiri',      '~> 1.4'
+	self.dependency 'pluginfactory', '~> 1.0'
+	self.dependency 'tidy-ext',      '~> 0.1'
+	self.dependency 'rcodetools',    '~> 0.8'
+
+	self.dependency 'hoe-deveiate', '~> 0.1', :developer
+
+	self.spec_extras[:licenses] = ["BSD"]
+	self.spec_extras[:rdoc_options] = ['-f', 'fivefish', '-t', 'Strelka CMS']
+	self.require_ruby_version( '>=1.9.2' )
+	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
+	self.check_history_on_release = true if self.respond_to?( :check_history_on_release= )
+
+	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
+end
+
+ENV['VERSION'] ||= hoespec.spec.version.to_s
+
+# Ensure the specs pass before checking in
+task 'hg:precheckin' => [ :check_history, :check_manifest, :spec ]
+
+
+desc "Build a coverage report"
+task :coverage do
+	ENV["COVERAGE"] = 'yes'
+	Rake::Task[:spec].invoke
+end
+
+if Rake::Task.task_defined?( '.gemtest' )
+	Rake::Task['.gemtest'].clear
+	task '.gemtest' do
+		$stderr.puts "Not including a .gemtest until I'm confident the test suite is idempotent."
+	end
+end
+
+
+# Add admin app testing directories to the clobber list
+CLOBBER.include( 'static', 'run', 'logs', 'strelka.sqlite' )
+
+

data/data/strelka-cms/apps/content-feeds

@@ -0,0 +1,194 @@
+#!/usr/bin/ruby
+
+require 'pathname'
+require 'rss/maker'
+require 'atom'
+require 'uuidtools'
+require 'time'
+require 'socket'
+require 'configurability'
+
+require 'strelka'
+require 'strelka/mixins'
+
+require 'strelka/cms'
+require 'strelka/cms/pagecatalog'
+require 'strelka/cms/page'
+
+
+# The Feed applet -- generate RSS and Atom feeds for various things.
+class Strelka::CMS::ContentFeeds < Strelka::App
+	extend Configurability,
+	       Strelka::MethodUtilities
+	include UUIDTools
+
+
+	# Configurability API -- configure this app with the 'feeds' section of the
+	# config.
+	config_key :content_feeds
+
+
+	# Strelka app ID
+	ID = 'content-feeds'
+
+	# Configuration defaults
+	DEFAULT_CONFIG = {
+		uuid:        UUID.sha1_create( UUID_DNS_NAMESPACE, Socket.gethostname ).to_s,
+		entry_count: 10,
+		pageroot:    Pathname( __FILE__ ).dirname.parent.parent.parent + 'public',
+		paths:       [''],
+	}
+
+
+	# The feed's site UUID (for Atom feeds)
+	singleton_attr_accessor :uuid
+
+	# The number of entries to include in a feed
+	singleton_attr_accessor :entry_count
+
+	# The page root
+	singleton_attr_accessor :pageroot
+
+	# The paths, relative to the pageroot, that can be served as a feed
+	singleton_attr_accessor :paths
+
+
+	### Configurability API -- configure the app.
+	def self::configure( config=nil )
+		if config
+			self.uuid = config[:uuid]
+			self.entry_count = config[:entry_count]
+			self.pageroot = config[:pageroot]
+			self.paths = config[:paths]
+		end
+	end
+
+
+	### Set up the feeds app.
+	def initialize( * )
+		super
+		@catalog = Strelka::CMS::PageCatalog.new( self.class.pageroot )
+		@site_uuid = UUID.parse( self.class.uuid )
+	end
+
+	######
+	public
+	######
+
+	# The PageCatalog to use for building feeds
+	attr_reader :catalog
+
+
+	#
+	# Routing
+	#
+	plugin :routing
+
+    get 'rss' do |req|
+		feedpath = req.app_path[ %r{/rss/(.*)}, 1 ]
+		newest_pages = self.find_newest_pages( feedpath, req )
+
+		baseuri = req.uri
+		baseuri.path = ''
+
+		# Generate the feed out of the newest 10 pages
+		feed = RSS::Maker.make( '2.0' ) do |feed|
+			feed.channel.title       = "DevEiate: %s" % [ feedpath.capitalize ]
+			feed.channel.link        = "http://deveiate.org/#{feedpath}/"
+			feed.channel.description = "Making stuff up since 1994"
+			feed.items.do_sort       = true # sort items by date
+
+			newest_pages.each do |page|
+				entry_url = baseuri.dup
+				entry_url.path = '/' + File.join( feedpath, page.relative_html_path )
+
+				item = feed.items.new_item
+				item.title = page.title
+				item.link  = entry_url
+				item.date  = page.date
+			end
+		end
+
+		res = req.response
+
+		# Set the cache header and set the mimetype
+		res.headers.last_modified = newest_pages.first.date.httpdate
+		res.content_type = 'application/rss+xml'
+		res.body = feed.to_s
+
+		return res
+    end
+
+
+	### Action: Return an ATOM feed for the pages under the path made up of +pathparts+.
+	get 'atom' do |req|
+		feedpath = req.app_path[ %r{/atom/(.*)}, 1 ]
+		newest_pages = self.find_newest_pages( feedpath, req )
+		newest_page = newest_pages.first
+
+		baseuri = req.uri
+		baseuri.path = ''
+
+		feed = Atom::Feed.new do |feed|
+			feed.title   = "DevEiate: %s" % [ feedpath.capitalize ]
+			feed.links   << Atom::Link.new( :href => baseuri )
+			feed.updated = newest_page.date
+			feed.authors << Atom::Person.new( :name => 'Michael Granger' )
+			feed.id      = @site_uuid.to_uri
+
+			newest_pages.each do |page|
+				entry_url = baseuri.dup
+				entry_url.path = '/' + File.join( feedpath, page.relative_html_path )
+
+				feed.entries << Atom::Entry.new do |entry|
+					entry.title   = page.title
+					entry.id      = UUID.sha1_create( UUID_URL_NAMESPACE, entry_url.to_s ).to_uri
+					entry.updated = page.date
+					entry.summary = page.summary
+
+					entry.links << Atom::Link.new( :href => entry_url )
+				end
+			end
+		end
+
+		res = req.response
+
+		# Set the cache header and set the mimetype
+		res.headers.last_modified = newest_page.date.httpdate
+		res.content_type = 'application/atom+xml'
+		res.body = feed.to_xml
+
+		return res
+	end
+
+
+	#########
+	protected
+	#########
+
+	### Find the newest pages for the path of the +request+ and return them.
+	def find_newest_pages( feedpath, req )
+		self.log.debug "Looking for newest pages in feed path: %p" % [ feedpath ]
+		finish_with HTTP::NOT_FOUND unless self.class.paths.include?( feedpath )
+		feedpath.untaint
+
+		count = self.class.entry_count
+		newest_pages = self.catalog.relative_to( feedpath ).sort_by( &:date ).first( count )
+		newest_page = newest_pages.first
+
+		# Just 304 if the feed doesn't need to be updated
+		if req.headers.if_modified_since &&
+			Time.parse(req.headers.if_modified_since) > newest_page.date
+
+			self.log.info "Not modified since %s" % [ req.headers.if_modified_since ]
+			finish_with HTTP::NOT_MODIFIED, "No changes since %s" % [ req.headers.if_modified_since ]
+		end
+
+		return newest_pages
+	end
+
+
+end # class Strelka::CMS::Feeds
+
+Encoding.default_internal = Encoding::UTF_8
+Strelka::CMS::Feeds.run if __FILE__ == $0

data/data/strelka-cms/apps/content-manager

@@ -0,0 +1,159 @@
+#!/usr/bin/env ruby
+
+require 'loggability'
+require 'pathname'
+require 'redcloth'
+require 'mail'
+
+require 'strelka/app'
+require 'strelka/mixins'
+
+require 'strelka/cms'
+
+
+class Strelka::CMS::ContentManager < Strelka::App
+	extend Loggability,
+	       Configurability,
+	       Strelka::MethodUtilities
+
+	# Loggability API -- log to Strelka::CMS's logger
+	log_to :strelka_cms
+
+	# Configurability API -- use values from the 'cms' section of the config
+	config_key :content_manager
+
+
+	# Strelka App ID
+	ID = 'content-manager'
+
+	# The default directory to scan for pages
+	DEFAULT_CONFIG = {
+		pageroot: Pathname( __FILE__ ).dirname.parent.parent.parent + 'public'
+	}
+
+	# Pattern for untainting the page path
+	PAGE_PATH_PATTERN = %r{
+		\A
+			(?<path>(?:
+				[\w\-/]                       # Allow word characters, slashes, and hyphens
+			)*)
+			(?:\.(?<suffix>html|page))?       # optional suffix
+		\z
+	}x
+
+
+	##
+	# The configured catalog root
+	singleton_attr_accessor :pageroot
+
+	##
+	# The default content-type
+	default_type 'text/html'
+
+
+	# Strelka App setup
+	plugin :templating
+	layout 'layout.tmpl'
+	templates \
+		page:  'page.tmpl'
+
+	# Error-handler
+	plugin :fancyerrors
+
+
+	### Configurability API -- configure the CMS class once the config is loaded.
+	def self::configure( config=nil )
+		if config && config.member?( :pageroot )
+			self.log.debug "Config is: %p" % [ config ]
+			self.pageroot = Pathname( config.pageroot )
+		else
+			self.pageroot = DEFAULT_CONFIG[:pageroot]
+		end
+	end
+
+
+	### Create a new instance of the CMS handler application.
+	def initialize( * )
+		super
+		@catalog = Strelka::CMS::PageCatalog.new( self.class.pageroot )
+	end
+
+
+	#
+	# Handler Routes
+	#
+	plugin :routing
+
+	# /
+	# -> /.page
+	# -> /index.page
+
+	# /foo/
+	# -> /foo.page
+	# -> /foo/index.page
+
+	# /foo/project
+	# -> /foo/project.page
+	# -> /foo/project/index.page
+	# -> /foo/project.html (literal)
+	# -> /foo/project/index.html (literal)
+
+	get do |request|
+		unless path = request.app_path[ PAGE_PATH_PATTERN, :path ]
+			self.log.error "Invalid app_path: %p" % [ request.app_path ]
+			finish_with HTTP::NOT_FOUND
+		end
+
+		# Force the path to be relative and clean it up
+		path = Pathname( path.gsub(%r{\A\.?/+|/(?=/)|/+\z}, '') )
+		page = nil
+
+		# Try to find a matching .page file
+		self.log.debug "Page path is: %p" % [ path ]
+		if path.to_s.empty?
+			subcat = @catalog.matching_pattern( 'index.page' )
+			page = subcat.first
+		else
+			subcat = @catalog.relative_to( path.dirname ).
+				matching_pattern( "#{path.basename(path.extname)}{.page,/index.page}" )
+			page = subcat.first
+		end
+
+		# If there was a matching .page file, use that
+		if page
+			self.log.debug "  found page: %p" % [ page ]
+			return self.page_response( page )
+		end
+
+		# Try a literal HTML page
+		htmlpage = self.class.pageroot + path.sub_ext( '.html' )
+		if htmlpage.exist?
+			return self.raw_response( request, htmlpage )
+		end
+
+		# Give up
+		self.log.error "No pages matching %p" % [ path ]
+		finish_with HTTP::NOT_FOUND
+	end
+
+
+	### Package up the specified +page+ in the page template and return it.
+	def page_response( page )
+		tmpl = self.template( :page )
+		tmpl.page = page
+		return tmpl
+	end
+
+
+	### Package up the page at the specified +path+ in the response and return it.
+	def raw_response( request, pagepath )
+		response = request.response
+		response.body = pagepath.open( 'r', encoding: 'utf-8' )
+		return response
+	end
+
+end # class Strelka::CMS::ContentManager
+
+Encoding.default_internal = Encoding::UTF_8
+Strelka::CMS::ContentManager.run if __FILE__ == $0
+