RubyGems - strelka-cms - Versions diffs - 0.0.1.pre.15 - Mend

strelka-cms 0.0.1.pre.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (56) hide show

data.tar.gz.sig +0 -0
data/.gemtest +0 -0
data/ChangeLog +33 -0
data/History.rdoc +4 -0
data/Manifest.txt +52 -0
data/Procfile +4 -0
data/README.rdoc +74 -0
data/Rakefile +68 -0
data/data/strelka-cms/apps/content-feeds +194 -0
data/data/strelka-cms/apps/content-manager +159 -0
data/data/strelka-cms/templates/autoindex/default.tmpl +11 -0
data/data/strelka-cms/templates/layout.tmpl +58 -0
data/data/strelka-cms/templates/page.tmpl +21 -0
data/etc/mongrel.rb +34 -0
data/lib/strelka/cms.rb +42 -0
data/lib/strelka/cms/page.rb +322 -0
data/lib/strelka/cms/pagecatalog.rb +121 -0
data/lib/strelka/cms/pagefilter.rb +76 -0
data/lib/strelka/cms/pagefilter/autoindex.rb +140 -0
data/lib/strelka/cms/pagefilter/cleanup.rb +40 -0
data/lib/strelka/cms/pagefilter/editorial.rb +55 -0
data/lib/strelka/cms/pagefilter/example.rb +232 -0
data/lib/strelka/cms/pagefilter/strip.rb +30 -0
data/lib/strelka/cms/pagefilter/textile.rb +20 -0
data/public/humans.txt +8 -0
data/public/images/misc/button-gloss.png +0 -0
data/public/images/misc/button-overlay.png +0 -0
data/public/images/misc/custom-form-sprites.png +0 -0
data/public/images/misc/input-bg-outset.png +0 -0
data/public/images/misc/input-bg.png +0 -0
data/public/images/misc/modal-gloss.png +0 -0
data/public/images/misc/table-sorter.png +0 -0
data/public/images/orbit/bullets.jpg +0 -0
data/public/images/orbit/left-arrow.png +0 -0
data/public/images/orbit/loading.gif +0 -0
data/public/images/orbit/mask-black.png +0 -0
data/public/images/orbit/pause-black.png +0 -0
data/public/images/orbit/right-arrow.png +0 -0
data/public/images/orbit/rotator-black.png +0 -0
data/public/images/orbit/timer-black.png +0 -0
data/public/index.page +46 -0
data/public/javascripts/app.js +98 -0
data/public/javascripts/foundation.js +12 -0
data/public/javascripts/jquery.min.js +4 -0
data/public/javascripts/modernizr.foundation.js +4 -0
data/public/robots.txt +4 -0
data/public/stylesheets/app.css +30 -0
data/public/stylesheets/foundation.css +1424 -0
data/public/stylesheets/ie.css +13 -0
data/spec/data/test.page +22 -0
data/spec/lib/helpers.rb +58 -0
data/spec/strelka/cms/page_spec.rb +139 -0
data/spec/strelka/cms/pagecatalog_spec.rb +94 -0
data/spec/strelka/cms_spec.rb +27 -0
metadata +346 -0
metadata.gz.sig +0 -0

data/data/strelka-cms/templates/autoindex/default.tmpl ADDED Viewed

@@ -0,0 +1,11 @@
+<?import request ?>
+<!-- Autoindex filter default template $Id$ -->
+<div class="autoindex">
+	<ul>
+	<?for page in pages ?>
+		<li><a href="/[?call page.path.dirname
+		       ?]/[?call page.path.basename('.page') ?].html"><?escape page.title ?></a></li>
+	<?end for ?>
+	</ul>
+</div>

data/data/strelka-cms/templates/layout.tmpl ADDED Viewed

@@ -0,0 +1,58 @@
+<!DOCTYPE html>
+<!-- paulirish.com/2008/conditional-stylesheets-vs-css-hacks-answer-neither/ -->
+<!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7" lang="en"> <![endif]-->
+<!--[if IE 7]>    <html class="no-js lt-ie9 lt-ie8" lang="en"> <![endif]-->
+<!--[if IE 8]>    <html class="no-js lt-ie9" lang="en"> <![endif]-->
+<!--[if gt IE 8]><!--> <html class="no-js" lang="en"> <!--<![endif]-->
+<head>
+	<meta charset="utf-8" />
+	<!-- Set the viewport width to device width for mobile -->
+	<meta name="viewport" content="width=device-width" />
+	<title>Strelka CMS Demo: <?attr title ?></title>
+	<!-- Included CSS Files -->
+	<link rel="stylesheet" href="/stylesheets/foundation.css">
+	<link rel="stylesheet" href="/stylesheets/app.css">
+	<!--[if lt IE 9]>
+		<link rel="stylesheet" href="/stylesheets/ie.css">
+	<![endif]-->
+	<script src="/javascripts/modernizr.foundation.js"></script>
+	<!-- Included JS Files -->
+	<script src="/javascripts/jquery.min.js" defer="defer"></script>
+	<script src="/javascripts/foundation.js" defer="defer"></script>
+	<script src="/javascripts/app.js" defer="defer"></script>
+	<!-- IE Fix for HTML5 Tags -->
+	<!--[if lt IE 9]>
+		<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+	<![endif]-->
+</head>
+<body>
+	<!-- container -->
+	<div class="container">
+		<div class="row">
+			<div class="twelve columns">
+				<h2>Strelka CMS Demo</h2>
+				<p><?attr title ?></p>
+				<hr />
+			</div>
+		</div>
+		<div class="row">
+			<?attr body ?>
+		</div>
+	</div>
+	<!-- container -->
+</body>
+</html>

data/data/strelka-cms/templates/page.tmpl ADDED Viewed

@@ -0,0 +1,21 @@
+<section class="row">
+	<div class="eight columns">
+		<?attr page ?>
+	</div>
+	<div class="four columns">
+		<aside id="about">
+			<header>
+				<h2>Strelka CMS</h2>
+			</header>
+			<dl>
+				<dt>Home</dt>
+				<dd><a href="http://bitbucket.org/ged/strelka-cms">http://bitbucket.org/ged/strelka-cms</a></dd>
+			</dl>
+		</aside>
+	</div>
+</section>

data/etc/mongrel.rb ADDED Viewed

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+require 'socket'
+require 'pathname'
+require 'mongrel2'
+require 'mongrel2/config'
+server 'cms-demo' do
+    name 'Strelka CMS Demo'
+	chroot '.'
+    access_log '/logs/access.log'
+    error_log  '/logs/error.log'
+    pid_file '/run/mongrel2.pid'
+	port 8080
+    default_host 'localhost'
+    host 'localhost' do
+		route '/stylesheets/(.)', directory( 'public/stylesheets/' )
+		route '/javascripts/(.)', directory( 'public/javascripts/' )
+		route '/images/(.)', directory( 'public/images/' )
+		route '/feed', handler( 'tcp://127.0.0.1:9946', 'content-feeds' )
+		route '/', handler( 'tcp://127.0.0.1:9948', 'content-manager' )
+	end
+end
+mkdir_p 'logs'
+mkdir_p 'run'

data/lib/strelka/cms.rb ADDED Viewed

@@ -0,0 +1,42 @@
+#!/usr/bin/ruby
+require 'loggability'
+require 'configurability'
+require 'strelka'
+# Toplevel namespace of the Strelka CMS class library
+module Strelka::CMS
+	extend Loggability,
+	       Configurability
+	# Loggability API -- set up a logger that will serve DevEiate libraries
+	log_as :strelka_cms
+	# Configurability API -- get configuration values from the 'cms' section of the config
+	config_key :cms
+	# Version string
+	VERSION = '0.0.1'
+	# Version-control revision constant
+	REVISION = %q$Revision: e90e841548bc $
+	require 'strelka/cms/page'
+	require 'strelka/cms/pagefilter'
+	require 'strelka/cms/pagecatalog'
+	### Get the library version. If +include_buildnum+ is true, the version string will
+	### include the VCS rev ID.
+	def self::version_string( include_buildnum=false )
+		vstring = "%s %s" % [ self.name, VERSION ]
+		vstring << " (build %s)" % [ REVISION[/: ([[:xdigit:]]+)/, 1] || '0' ] if include_buildnum
+		return vstring
+	end
+end # module Strelka::CMS

data/lib/strelka/cms/page.rb ADDED Viewed

@@ -0,0 +1,322 @@
+#!/usr/bin/env ruby
+require 'time'
+require 'nokogiri'
+require 'summarize'
+require 'loggability'
+require 'inversion'
+require 'strelka/cms' unless defined?( Strelka::CMS )
+# An abstraction of a page with markup. This class provides rendering
+# and introspection facilities for page files on disk. A page file
+# is a plain file with a .page extension that contains some content
+# to be rendered for the docs site, and is of the form:
+#
+#   ---                                     | - YAML document separator
+#   title: My Brilliant Document            | - An optional YAML header, see
+#   filters:                                |
+#     - apilinks                            |
+#     - links                               |
+#     - syntax                              |
+#     - editorial                           |
+#     - textile                             |
+#                                           |
+#   ---                                     | - Document separator
+#   h1. My Brilliant Document               | - Document contents which will
+#                                           |   will be transformed by the
+#   This is a document with some stuff in   |   configured filters.
+#   it. It rules you. Like my teeth.        |
+#                                           |
+#
+class Strelka::CMS::Page
+	extend Loggability
+	# Loggability API -- log to the strelka/cms logger
+	log_to :strelka_cms
+	require 'strelka/cms/pagefilter'
+	# Pattern to match a source page with a YAML header
+	PAGE_WITH_YAML_HEADER = /
+		\A---\s*$	# It should should start with three hyphens
+		(.*?)		# ...have some YAML stuff
+		^---\s*$	# then have another three-hyphen line,
+		(.*)\Z		# then the rest of the document
+	  /xm
+	# The default page options.
+	DEFAULT_OPTIONS = {
+		'title'    => '(Untitled)',
+		'filters'  => %w[strip textile],
+		'tags'     => [],
+	}
+	#################################################################
+	###	C L A S S   M E T H O D S
+	#################################################################
+	### Read page source from the file at the given +path+ and return a new Page object.
+	def self::load( path, catalog=nil )
+		page = File.open( path, 'r', encoding: 'utf-8' ) do |io|
+			self.read( io, catalog )
+		end
+		page.path = path
+		return page
+	end
+	### Read page source from the given +io+ and return a new Page object.
+	def self::read( io, catalog=nil )
+		source = io.read
+		self.log.debug "Read %d bytes from %p" % [ source.length, io ]
+		page = self.parse( source, catalog )
+	end
+	### Parse the given +source+ and return a new Page object.
+	def self::parse( source, catalog=nil )
+		options = nil
+		if source =~ PAGE_WITH_YAML_HEADER
+			self.log.debug "Parsing page with YAML header..."
+			options = YAML.load( $1 )
+			source = $2
+			self.log.debug "  YAML header options: %p" % [ options ]
+		else
+			self.log.debug "Parsing page with no header."
+			options = {}
+		end
+		return new( source, catalog, options )
+	end
+	#################################################################
+	###	I N S T A N C E   M E T H O D S
+	#################################################################
+	### Create a new Page with the specified +content+ and +options+.
+	def initialize( content, catalog=nil, options={} )
+		# If there's no catalog, the options might be in its place
+		if catalog.is_a?( Hash )
+			options = catalog
+			catalog = nil
+		end
+		@content  = content
+		@catalog  = catalog
+		options   = DEFAULT_OPTIONS.merge( options )
+		@tags     = options.delete( 'tags' ) || options.delete( 'keywords' )
+		@title    = options.delete( 'title' )
+		@filters  = options.delete( 'filters' )
+		@template = options.delete( 'template' )
+		@options  = options
+		@created  = Time.now
+		@summary  = nil
+		@topics   = nil
+		@path     = nil
+	end
+	######
+	public
+	######
+	# The page's content
+	attr_accessor :content
+	# The page's catalog (if it was loaded via one)
+	attr_accessor :catalog
+	# The Array of page tags specified in the page config
+	attr_reader :tags
+	alias_method :keywords, :tags
+	# The page title given in the page config
+	attr_accessor :title
+	# The Array of filter names that will be applied to the rendered output, in
+	# the order they will be applied.
+	attr_reader :filters
+	# The path to the Inversion template to wrap the page content in
+	attr_reader :template
+	# The path to the page (if loaded from a file, nil otherwise)
+	attr_reader :path
+	# Any additional options in the header
+	attr_reader :options
+	# The Time the page object was instantiated
+	attr_reader :created
+	### Set the path to the page.
+	def path=( newpath )
+		@path = Pathname( newpath )
+	end
+	### Return the page's path relative to its catalog.
+	def relative_path
+		catalog = self.catalog or return nil
+		path = self.path or return nil
+		return path.relative_path_from( catalog.basedir )
+	end
+	### Return the page's HTML path.
+	def relative_html_path
+		pagepath = self.relative_path or return nil
+		return pagepath.to_s.sub(/\.page$/, '.html')
+	end
+	### Apply the filters corresponding to the given +filter_names+ and return the modified
+	### +content+.
+	def apply_filters( content )
+		filters = self.filter_objects
+		self.log.debug "Applying %d filters to %d bytes of content: %p" %
+			[ filters.length, content.length, content[0,100] ]
+		return filters.inject( self.content.dup ) do |filtered_content, filter|
+			begin
+				filter.process( filtered_content, self )
+			rescue => err
+				self.log.error "%s while applying the %s filter: %s" %
+					[ err.class.name, filter.name, err.message ]
+				self.log.debug "  " + err.backtrace.join("\n  ")
+				filtered_content
+			end
+		end
+	end
+	### Return the page's filters as instances of Strelka::CMS::PageFilter.
+	def filter_objects
+		return self.filters.map do |filter_name|
+			filter_name.untaint
+			Strelka::CMS::PageFilter.create( filter_name )
+		end
+	end
+	### Return the contents of the first heading from the rendered page.
+	def first_heading
+		self.log.debug "Fetching page title from rendered page"
+		doc = Nokogiri::HTML( self.to_s )
+		if heading = doc.css( 'h1,h2,h3' ).first
+			self.log.debug "  got first heading: %s" % [ heading ]
+			return heading.content
+		else
+			self.log.debug "  couldn't find a heading."
+			return nil
+		end
+	end
+	### Return the page rendered as HTML after applying filters and wrapping
+	### it in its configured template if it has one.
+	def render( * )
+		if path = self.template
+			tmpl = Inversion::Template.load( path )
+			tmpl.page = self
+			return tmpl
+		else
+			return self.to_s
+		end
+	end
+	### Render the page content, filtering it with its configured filters. Note
+	### that this does not wrap it in its template.
+	def to_s
+		return self.apply_filters( self.content )
+	end
+	alias_method :to_html, :to_s
+	### Return the page content with tags stripped.
+	def stripped_content
+		return self.content.gsub( /<.*?>/, '' )
+	end
+	### Extract a Hash of fields to be indexed from the page and return it.
+	def index_fields
+		return {
+		    :title         => self.title,
+		    :first_heading => self.first_heading,
+			:tags          => self.tags.join( ', ' ),
+		    :content       => self.stripped_content,
+			:modified      => self.modified,
+			:created       => self.created,
+		}
+	end
+	### Return the Time the page was last modified. This is derived from its 'date' header
+	### if it has one, or its mtime if it was loaded from a file, or its #created date
+	### if neither of those are available.
+	def modified
+		if headerdate = self.options['date']
+			headerdate = Time.parse( headerdate ) unless headerdate.is_a?( Time )
+			return headerdate
+		elsif self.path
+			return self.path.mtime
+		else
+			return self.created
+		end
+	end
+	alias_method :date, :modified
+	### Return a summary of the page.
+	def summary
+		self.summarize unless @summary
+		return @summary
+	end
+	### Return an Array of topics for the page.
+	def summary_topics
+		self.summarize unless @topics
+		return @topics
+	end
+	### Return a human-readable representation of the receiving object.
+	def inspect
+		return %|#<%s:%#0x %p %p [%s] {filters: %s}>| % [
+			self.class.name,
+			self.object_id / 2,
+			self.path,
+			self.title,
+			self.tags.join(', '),
+			self.filters.join('+'),
+		]
+	end
+	#########
+	protected
+	#########
+	### Derive a summary and topics from the stripped contents of the page. This
+	### populates #summary and #summary_topics.
+	def summarize
+		@summary, @topics = self.stripped_content.summarize( :topics => true )
+	end
+end # class Strelka::CMS::Page