fir 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jarrett Colby
+
+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, sublicense, 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
+NONINFRINGEMENT. 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/README.markdown

@@ -0,0 +1,109 @@
+Fir Isn't Rails
+===============
+
+Fir Isn't Rails is a minimalist Ruby framework for small, static sites. It's Rack-based, so it runs on Phusion Passenger.
+
+Warning: Alpha Release
+======================
+
+Fir is still in alpha. It has only been lightly tested. You may very well encounter bugs. If you do, please visit Fir's GitHub repository and tell us what happened.
+
+Installation
+============
+
+	sudo gem intall fir
+	fir my_fir_site
+
+The second command runs the Fir generator, creating a skeleton Fir site in the directory `my_fir_site`.
+
+Before we set up Passenger, let's test the site with Rackup:
+
+	cd my_fir_site
+	rackup config.ru -p 3000
+
+The `-p` option tells Rackup which port to listen on. This can be anything you want. (Obviously, if you're already running Rails or anything else on port 3000, you need to give Rack a different port.)
+
+Open your browser and visit:
+
+	http://localhost:3000
+
+You should see the home page. If you don't, something is wrong. Please visit Fir's GitHub repository and tell us what happened.
+
+Rackup is recommended when you're developing your site locally. Press ctrl-c to kill Rackup. 
+
+Now we're ready to make it work with Passenger, which you're encouraged to use in production. At this point, the instructions become a little iffy, because so much depends on your individual system (e.g. how Apache is configured, whether you can `sudo`). If you're on shared hosting, you'll probably need to contact support and have them perform some of these steps for you.
+
+For now, let's assume you're on a Mac with the default Apache installation.
+
+If you haven't done so, [install Passenger](http://www.modrails.com/documentation/Users%20guide.html). You should also read "[Deploying a Rack-based Ruby application](http://www.modrails.com/documentation/Users%20guide.html#_deploying_a_rack_based_ruby_application)" in the Passenger Users' Guide.
+
+In `httpd.conf`, add a virtual host:
+
+	<VirtualHost *:80>
+		ServerName example.com
+		DocumentRoot /absolute/path/to/my_fir_site/public
+		RackBaseURI /
+		<Directory "/absolute/path/to/my_fir_site/public">
+			Options Indexes FollowSymLinks
+			Order Deny,Allow
+			Allow from all
+		</Directory>
+	</VirtualHost>
+
+Make sure you edit the correct `httpd.conf`! Some systems may have more than one copy of Apache installed.
+
+Check `httpd.conf` syntax and restart Apache:
+
+	sudo apachectl configtest
+	sudo apachectl graceful
+
+That should do it.
+
+Basic Usage
+===========
+
+See the [example app](http://github.com/jarrett/fir-example) to get you started.
+
+## Editing the layout ##
+
+Each page will be rendered inside `application.html.erb` in the `layouts` directory. (That name was chosen because it will no doubt be familiar to Rails developers.)
+
+The current version does not support alternate layouts. Such a feature may be added in the future if there's a need.
+
+## Creating Pages ##
+
+Pages live in the `pages` directory, or in a subdirectory thereof. If you create a page called `my-page.markdown` in `pages`, Fir will map it to this URL: `http://youdomain.com/my-page`. Similarly, if you create a subdirectory in `pages` called `subdir`, and put `my-page.markdown` in there, this URL will be used: `http://youdomain.com/subdir/my-page`.
+
+Pages can have the following extensions:
+
+	.html
+	.html.erb
+	.markdown
+
+Markdown pages get passed through ERB before the Markdown is transformed to HTML. Thus, you can make Markdown pages dynamic. Remember: ERB runs **before** Markdown, so whatever your ERB tags spit out will be interpreted as Markdown.
+
+## Configuring Pages ##
+
+`pages.yml` contains all per-page configurations. Page titles, meta descriptions, and other configs can be specified there. Each page config property will be made available to the templates as an instance variable.
+
+## Mapping URLs ##
+
+You can override the default URL mapping in `pages.yml`. Just add a `path` property to a page, and the page will be made available under the path you specify.
+
+## Content Management ##
+
+Most of us will be perfectly happy managing content by editing the files in the `pages` directory. But for the sake of our clients, Fir offers another way.
+
+Fir isn't a CMS. Instead, it exposes a minimal, RESTful API for managing content. The idea is that content should be managed with specially-designed Fir clients, rather than through Fir itself. You can see how this works by downloading the [example app](http://github.com/jarrett/fir-example), booting it, and visiting `/manage-content.html` in your browser. The source of that page is available [on GitHub](http://github.com/jarrett/fir-example/blob/master/public/manage-content.html).
+
+Webserver Support
+=================
+
+Fir is designed primarily for Phusion Passenger. As a Rack-based framework, it theoretically supports Mongrel, CGI, FastCGI, and a host of others. But as of this writing, Fir has only been tested with Rackup and Passenger. If you get Fir working with anything else, please visit Fir's GitHub repository and let us know how you did it.
+
+Unicode and Others
+==================
+
+Fir doesn't change the character encoding of your content, so you can technically use any encoding scheme you want. That being said, UTF-8 is recommended. As always, make sure your HTML template correctly identifies the encoding scheme. (See [The Absolute Minimum Every Software Developer Absolutely, Positively Must Know About Unicode and Character Sets](http://www.joelonsoftware.com/articles/Unicode.html) for more information.)
+
+Don't use non-English characters in your URLs. They don't play nice with the filesystem, and they have to be percent-encoded anyway, resulting in ugly URLs. Avoid special characters other than `-` and `_`.

data/bin/fir

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+
+$:.unshift '/Users/jarrettcolby/apps/fir/lib'
+require 'rubygems'
+require 'fir'
+require 'fileutils'
+include FileUtils
+
+unless ARGV.length >= 1
+	raise 'Usage: fir path'
+end
+
+fir_root = ARGV[0]
+if File.exists?(fir_root)
+	raise "#{fir_root} already exists! Aborting."
+end
+cp_r FIR_SKELETON_ROOT, fir_root
+puts "Created new Fir site in #{fir_root}"

data/example/Rakefile

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'fir'
+
+::Fir::Tasks.define

data/example/boot_example.rb

@@ -0,0 +1,7 @@
+# This file is NOT normally part of a Fir deployment. It only exists so that we can
+# run the example app against the Fir code in this particular gem distribution,
+# instead of against whatever version of the Fir gem (if any) happens to be installed
+# on the local system.
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__), '../lib'))
+puts `rackup config.ru -p 3001 -e "$:.unshift '#{lib_dir}'"`

data/example/config.rb

@@ -0,0 +1,8 @@
+# This is the main config file for your site. Add any "require" statements or any other global directives here.
+
+require 'maruku' # Comment out if you don't want to use Markdown
+
+Fir.config do |config|
+	config.site_name = 'Acme Co.'
+	config.perform_caching = false
+end

data/example/config.ru

@@ -0,0 +1,12 @@
+# This file tells Rack how to boot Fir. It's the point of entry for the whole framework.
+# You shouldn't have to modify this file. If you came here looking for the app's config
+# file, you're in the wrong place. Look at config.rb instead.
+
+FIR_ROOT = File.expand_path(File.dirname(__FILE__))
+
+require 'fir.rb'
+require 'config.rb'
+
+# This is where it all begins.
+# See boot.rb in the Fir gem if you're curious about what happens next.
+instance_eval(&Fir.boot_proc)

data/example/layouts/application.html.erb

@@ -0,0 +1,34 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+
+<head>
+	<title>
+		<% if @title and !@title.empty? %>
+			<%= h @title %> - 
+		<% end %>
+		Acme Co.
+	</title>
+	<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
+	<% if @description and !@description.empty? %>
+		<meta name="description" content="<%= h @page_description %>"/>
+	<% end %>
+	<link href="/stylesheets/style.css" rel="stylesheet" type="text/css"/>
+</head>
+
+<body>
+
+<div id="container">
+	<ul id="top_nav">
+		<% menu('top') do |item, current_page| %>
+			<!-- current_page is true if the menu item links to the current page, false otherwise.
+			It's usually not necessary, since you'll automatically get either an <a> or <span class="selected">.-->
+			<li><%= item %></li>
+		<% end %>
+	</ul>
+	
+	<%= yield %>
+</div>
+
+</body>
+</html>

data/example/menus.yml

@@ -0,0 +1,6 @@
+# You must restart your server after editing this file.
+
+top:
+- Home:
+- Products: products
+- Contact Us: contact-us

data/example/pages.yml

@@ -0,0 +1,15 @@
+# You must restart your server after editing this file.
+
+index:
+  title: Home
+  description: Acme Co. sells all the widgets you need to capture road runners and other desert fauna
+products/index:
+  title: Products
+  description: Acme Company's products
+products/dynamite:
+  title: Dynamite
+products/dynamite-plus:
+  title: Dynamite
+  path: products/dynamite+ # Override the default user-visible path. Note that you need to percent-encode the + in URLs.
+products/mouse-trap:
+  title: Mouse Trap

data/example/pages/404.html.erb

@@ -0,0 +1 @@
+<h1>Sorry, there is nothing at this address. (404 Not Found)</h1>

data/example/pages/contact-us.markdown

@@ -0,0 +1,6 @@
+Contact Us
+==========
+
+555-123-4567
+98765 Runner Road
+Coyote, AZ

data/example/pages/index.markdown

@@ -0,0 +1,4 @@
+Home
+====
+
+Welcome to Acme Company!

data/example/pages/products/dynamite-plus.html.erb

@@ -0,0 +1,7 @@
+<h1>Dynamite Plus!</h1>
+
+<p><%= link_to 'Back to products', '/products' %></p>
+
+<p>Like our popular <%= link_to 'Dynamite', '/products/dynamite' %>, but even more powerful!</p>
+
+<p>Released: Feb 1st 1956 (<%= Date.today.year - 1956 %> years ago)</p>

data/example/pages/products/dynamite.html.erb

@@ -0,0 +1,7 @@
+<h1>Dynamite</h1>
+
+<p><%= link_to 'Back to products', '/products' %></p>
+
+<p>Acme's most popular product! Suitable for all forms of demolition and hunting road runners.</p>
+
+<p>Released: Jan 19th 1956 (<%= Date.today.year - 1956 %> years ago)</p>

data/example/pages/products/index.markdown

@@ -0,0 +1,6 @@
+Products
+========
+
+- [Dynamite](/products/dynamite)
+- [Dynamite Plus!](/products/dynamite%2B)
+- [Mouse Trap](/products/mouse-trap)

data/example/pages/products/mouse-trap.html.erb

@@ -0,0 +1,7 @@
+<h1>Mouse Trap</h1>
+
+<p><%= link_to 'Back to products', '/products' %></p>
+
+<p>Catch those varmints!</p>
+
+<p>Released: May 12th 1964 (<%= Date.today.year - 1964 %> years ago)</p>

data/example/public/manage-content.html

@@ -0,0 +1,55 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+
+<head>
+	<title>Content Management API</title>
+	<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
+	<link href="/stylesheets/style.css" rel="stylesheet" type="text/css"/>
+	<style type="text/css">
+		form { border: 2px solid #a0a0a0; padding: 8px; background: #f0f0f0; }
+	</style>
+</head>
+
+<body>
+
+<div id="container">
+
+<h1>Content Management API</h1>
+
+<p>This page exists to demonstrate Fir's content management API. It would normally not be included in a Fir site. Instead, you would use a more user-friendly Fir client.</p>
+
+<p>Fir exposes a simple RESTful API. It uses HTTP basic authentication. The credentials for this site, as defined in <code>users.yml</code>, are:</p>
+
+<p><pre>username: johndoe
+password: foo
+</pre></p>
+
+<p>This is why FIR isn't really a CMS&mdash;it doesn't provide a user-friendly content management interface. Instead, it exposes a machine-friendly API that's meant to be accessed by remote clients. Anyone can build a Fir client by following the examples on this page.</p>
+
+<h2>Listing Pages</h2>
+
+<p>An XML feed of pages is available at:</p>
+<p><code><a href="/-admin/pages">/-admin/pages</a></code></p>
+
+<h2>Downloading Pages</h2>
+
+<p>Download the source code of individual pages from URLs like this:</p>
+<p><code><a href="/-admin/pages/index.markdown">/-admin/pages/index.markdown</a></code></p>
+<p><code><a href="/-admin/pages/products/dynamite.html.erb">/-admin/pages/products/dynamite.html.erb</a></code></p>
+
+<h2>Updating Pages</h2>
+
+<p>Update page source code by POSTing to the same URLs that are used to download the pages:</p>
+
+<form action="/-admin/pages/index.markdown" method="post">
+	<p>This form POSTs to:<br/><code>/-admin/pages/index.markdown</code></p>
+	
+	<p><textarea name="content" rows="5" cols="80">Whatever you enter here will replace the existing content of index.markdown. This textarea's name is "content."</textarea></p>
+	
+	<p><input type="submit" value="Submit"/></p>
+</form>
+
+</div><!-- container -->
+</body>
+</html>

data/example/public/static.txt

@@ -0,0 +1 @@
+This is static.txt. It exists to prove that you can access static files in the public folder.

data/example/public/stylesheets/style.css

@@ -0,0 +1,8 @@
+body { font-family: helvetica, arial, verdana, sans-serif; font-size: 83%; text-align: center; }
+/* General typography */
+h1 { font-size: 2em; }
+h2 { font-size: 1.7em; }
+h3 { font-size: 1.5em; }
+/* Layout elements */
+div#container { width: 960px; margin-left: auto; margin-right: auto; text-align: left; }
+/* Specific pages */

data/example/tmp/restart.txt

@@ -0,0 +1 @@
+Run "touch tmp/restart.txt" to restart Passenger. (This doesn't work if you stared Fir using rackup.)

data/example/users.yml

@@ -0,0 +1,5 @@
+--- 
+johndoe: 
+  salt: b64e9a6e7e2c187a81a30de2d0
+  # Password is "foo"
+  crypted_password: f8463d3c8d229f4daec934d23db3b6f1d5b5eedc56a965c6721ed8b697e60a7d4dfe7a9e249eb3fc02d00c9528852b20bda276ff6ec05e972e7f5f338b1aa59e

data/lib/fir.rb

@@ -0,0 +1,17 @@
+require 'rack'
+require 'ostruct'
+require 'yaml'
+require 'digest'
+require 'erb'
+require 'builder'
+require 'maruku'
+
+require 'fir/admin.rb'
+require 'fir/boot.rb'
+require 'fir/helpers.rb'
+require 'fir/pages.rb'
+require 'fir/static.rb'
+require 'fir/tasks.rb'
+require 'fir/util.rb'
+
+FIR_SKELETON_ROOT = File.join(File.expand_path(File.dirname(__FILE__)), '..', 'skeleton')

data/lib/fir/admin.rb

@@ -0,0 +1,150 @@
+module Fir
+	module AdminMiddleware
+		def admin_path?(env)
+			!!env['PATH_INFO'].chomp('/').match(/^\/?-admin/)
+		end
+	end
+	
+	class AdminAuth < ::Rack::Auth::Basic
+		include AdminMiddleware
+		
+		def initialize(*args)
+			super
+			if File.exists?('users.yml')
+				@users = YAML::load(File.read('users.yml'))
+				@users = {} unless @users.is_a?(Hash) # In case of an invalid YAML file
+			else
+				@users = {}
+			end
+			@authenticator = lambda do |username, password|
+				if @users[username]
+					salt     = @users[username]['salt']
+					expected = @users[username]['crypted_password']
+					actual   = Fir.encrypt_password(password, salt)
+					expected == actual
+				else
+					false
+				end
+			end
+		end
+		
+		def call(env)
+			if admin_path?(env)
+				super(env)
+			else
+				@app.call(env)
+			end
+		end
+	end
+	
+	class AdminInterface
+		include AdminMiddleware
+		
+		def initialize(app)
+			@app = app
+			@file_server = ::Rack::File.new(File.join(FIR_ROOT, 'public'))
+		end
+		
+		def call(env)
+			session = env['rack.session']
+			path = env['PATH_INFO'].chomp('/')
+			if admin_path?(env)
+				match = path.match(/^\/?-admin\/pages\/(.+)/)
+				if match
+					page = Fir.sanitize_page(match[1])
+					page_path = File.join(FIR_ROOT, 'pages', page)
+					if File.exists?(page_path)
+						case env['REQUEST_METHOD'].downcase
+						when 'get'
+							retrieve_page(page_path)
+						when 'post'
+							update_page(page_path, env)
+						else
+							return method_not_allowed('Only GET and POST are allowed')
+						end
+					else
+						not_found
+					end
+				elsif path.match(/^\/?-admin\/pages$/)
+					page_index
+				else
+					not_found
+				end
+			else
+				return @app.call(env)
+			end
+		end
+		
+		protected
+		
+		def page_index
+			builder = Builder::XmlMarkup.new(:indent => 2)
+			builder.instruct!
+			xml = builder.pages do |pages|
+				recurse = lambda do |dir, node|
+					dir.each do |entry|
+						if entry[0].chr != '.'
+							path = File.join(dir.path, entry)
+							if File.file?(path)
+								node.page do |page|
+									page.name entry
+								end
+							else # Directory
+								node.folder do |folder|
+									folder.name entry
+									folder.pages do |folder_pages|
+										recurse.call(Dir.new(path), folder_pages)
+									end
+								end
+							end
+						end
+					end
+				end
+				recurse.call(Dir.new('pages'), pages)
+			end
+			[200, {'Content-Type' => 'text/xml'}, xml]
+		end
+		
+		def retrieve_page(page_path)
+			if File.readable?(page_path)
+				source = File.read(page_path)
+				directory, filename, ext = Fir.split_path(page_path)
+				filename_with_ext = filename + '.' + ext
+				[200, {'Content-Type' => 'text/plain', 'Content-Disposition' => "attachment; #{filename_with_ext}"}, source]
+			else
+				internal_server_error('File exists on disk, but is not readable. Are the permissions wrong?')
+			end
+		end
+		
+		def update_page(page_path, env)
+			if File.writable?(page_path)
+				File.open(page_path, 'w') do |file|
+					request = ::Rack::Request.new(env)
+					file.write(request.POST['content'])
+				end
+				Fir.clear_cache(page_path)
+				[200, {'Content-Type' => 'text/plain'}, "#{page_path} has been saved."]
+			else
+				internal_server_error('File exists on disk, but is not writeable. Are the permissions wrong?')
+			end
+		end
+		
+		### HTTP Response Codes ###
+		
+		def bad_request(explanation = nil)
+			[400, {'Content-Type' => 'text/plain'}, "400 Bad Request #{explanation}" ]
+		end
+		
+		def method_not_allowed(explanation = nil)
+			[405, {'Content-Type' => 'text/plain'}, "405 Method Not Allowed #{explanation}" ]
+		end
+		
+		def not_found(explanation = nil)
+			[404, {'Content-Type' => 'text/plain'}, "404 Not Found #{explanation}" ]
+		end
+		
+		def internal_server_error(explanation = nil)
+			[500, {'Content-Type' => 'text/plain'}, "500 Internal Server Error #{explanation}" ]
+		end
+	end
+end

data/lib/fir/boot.rb

@@ -0,0 +1,14 @@
+module Fir
+	def self.boot_proc
+		# This get called in config.ru. Thus, Passenger can eval the contents of config.ru the way it wants to
+		lambda do
+			::Fir.validate_config
+			#use ::Rack::Reloader # Only when developing the Fir gem
+			use ::Rack::ContentLength
+			use ::Fir::Static
+			use ::Fir::AdminAuth
+			use ::Fir::AdminInterface
+			run ::Fir::PageRenderer.new
+		end
+	end
+end

data/lib/fir/helpers.rb

@@ -0,0 +1,41 @@
+module Fir
+	module Helpers
+		include ::ERB::Util
+		
+		def absolutize(path)
+			File.join(Fir.config.relative_url_root, path)
+		end
+		
+		def content_tag(name, content_or_options = {}, options = {})
+			if content_or_options.is_a?(Hash)
+				options = content_or_options
+				content = nil
+			else
+				content = content_or_options
+			end
+			Builder::XmlMarkup.new.tag!(name, content, options)
+		end
+		
+		def link_to(text, url)
+			content_tag('a', text, 'href' => url)
+		end
+		
+		class MenuNotDefined < StandardError; end
+		def menu(name, options = {})
+			raise(ArgumentError, 'menu requires a block') unless block_given?
+			options = {:link_to_current => false}.merge(options)
+			items = @menus[name] || raise(MenuNotDefined, "Menu '#{name}' is not defined. Define it in menus.yml.")
+			items.each do |pair|
+				# pair looks like: {'Menu Text' => 'path' } or {'Menu Text' => {'link' => 'path', 'other_option' => 'value'}}
+				text = pair.keys.first
+				item_options = pair[text]
+				path = absolutize((item_options.is_a?(Hash) ? item_options['link'] : item_options) || '')
+				if options[:link_to_current] or path != @request.path_info
+					yield link_to(text, path), true
+				else
+					yield content_tag('span', text, 'class' => 'selected'), false
+				end
+			end
+		end
+	end
+end

data/lib/fir/pages.rb

@@ -0,0 +1,178 @@
+module Fir
+	module TemplateLoading
+		protected
+		
+		def load_template(path, base_dir = 'pages')
+			directory, filename, ext = Fir.split_path(path)
+			path_without_extension = File.join(FIR_ROOT, base_dir, directory, filename)
+			path_and_extension = template_extensions(base_dir).collect do |ext|
+				[path_without_extension + '.' + ext, ext]
+			end.detect do |full_path, ext|
+				File.exists?(full_path)
+			end
+			return nil if path_and_extension.nil?
+			full_path = path_and_extension[0]
+			extension = path_and_extension[1]
+			template_formats[base_dir][extension].new(full_path)
+		end
+		
+		def template_extensions(base_dir)
+			template_formats[base_dir].keys
+		end
+		
+		# Must return a hash with the following structure. The top-level keys map to directories, e.g. pages and layouts.
+		# The second-level keys are file extensions, and the second-level values are subclasses up TemplateAdapter.
+		def template_formats
+			{
+				'pages' => {'html.erb' => ErbAdapter, 'html' => NoOpAdapter, 'markdown' => MarkdownAdapter},
+				'layouts' => {'html.erb' => ErbAdapter}
+			}			
+		end
+	end
+	
+	class PageRenderer
+		include TemplateLoading
+		
+		def initialize
+			@page_config = yaml_or_empty('pages.yml')
+			@path_mappings = @page_config.inject({}) do |mappings, (page, configs)|
+				mappings[configs['path']] = page if configs['path']
+				mappings
+			end
+			@menus = yaml_or_empty('menus.yml')
+		end
+		
+		def call(env)
+			status = 200
+			content_type = 'text/html'
+			body = ''
+			path = ::Rack::Utils.unescape(env['PATH_INFO']).chomp('/').gsub(/^\//, '')
+			path = Fir.sanitize_page(path) # path now looks like 'folder/page-name'
+			if @path_mappings.has_key?(path)
+				path = @path_mappings[path]
+			end
+			template_options = {:menus => @menus, :request => Rack::Request.new(env)}
+			if directory?(path)
+				# This is like Apache's DirectoryIndex: if the request is for
+				# a directory, look for a page called "index" in that directory.
+				path = File.join(path, 'index').gsub(/^\//, '') # path now looks like 'folder/index' or just 'index'
+			end
+			if template = load_template(path)
+				body = template.render_with_layout(template_options.merge(:page_config => page_config(path)))
+				if Fir.config.perform_caching
+					cache_result(path, body)
+				end
+			elsif template = load_template('404')
+				# Page not found. Render 404 template.
+				status = 404
+				body = template.render_with_layout(template_options)
+			else
+				# Page not found, and neither was the 404 template! Render a simple message.
+				content_type = 'text/plain'
+				status = 404
+				body = 'Sorry, there is nothing at this address. (404 Not Found)'
+			end
+			[status, {'Content-Type' => content_type}, body ]
+		end
+		
+		protected
+		
+		def cache_result(path, body)
+			directory, filename, ext = Fir.split_path(path)
+			path = File.join(FIR_ROOT, 'public/cache', directory, filename + '.html')
+			File.open(path, 'w') do |file|
+				file.write(body)
+			end
+		end
+		
+		def directory?(path)
+			File.directory?(File.join('pages', path))
+		end
+		
+		def page_config(path)
+			@page_config[path] || {}
+		end
+		
+		# Load the YAML file, or return an empty hash if the file can't be loaded
+		def yaml_or_empty(file)
+			(File.exists?(file) and File.readable?(file)) ?
+				YAML::load(File.read(file)) || {} : {}
+		end
+	end
+	
+	class TemplateAdapter
+		include TemplateLoading
+		
+		def initialize(template_path)
+			# ERB uses the template adapter's bindings, so we don't want to pollute the
+			# namespace any more than we have too. Thus the two preceding underscores.
+			@__path = template_path
+		end
+		
+		def render_with_layout(options)
+			wrapper_template.render(options) do
+				# This block will be called where "yield" appears in the wrapper template.
+				# See comment on ErbAdapter#render.
+				render(options)
+			end
+		end
+		
+		protected
+		
+		# Returns an instance of ErbAdapter
+		def wrapper_template
+			load_template('application', 'layouts') || raise('layouts/application.html.erb must exist!')
+		end
+		
+		def source
+			File.read(@__path)
+		end
+	end
+	
+	# Passes through the content as-is.
+	# This is desirable for, e.g., .html files.
+	class NoOpAdapter < TemplateAdapter
+		def render(options)
+			source
+		end
+	end
+	
+	class ErbAdapter < TemplateAdapter
+		include ::Fir::Helpers
+		
+		# If a block is given, it will be included in ERB's binding. Thus, if the template yields,
+		# the block given to render will be called.
+		def render(options, &block)
+			render_erb(source, options, &block)
+		end
+		
+		protected
+		
+		def render_erb(__erb_source, __options)
+			if __options[:page_config]
+				__options[:page_config].each do |key, value|
+					instance_variable_set('@' + key, value)
+				end
+			end
+			@menus = __options[:menus]
+			@request = __options[:request]
+			ERB.new(__erb_source).result(binding)
+		end
+	end
+	
+	# Uses Maruku
+	class MarkdownAdapter < ErbAdapter
+		def render(options)
+			render_markdown(render_erb(source, options), options)
+		end
+		
+		protected
+		
+		def render_markdown(markdown_source, options)
+			unless defined?(Maruku)
+				raise 'Markdown requires Maruku. "gem install maruku" if necessary, then "require \'maruku\'" in config.rb'
+			end
+			Maruku.new(markdown_source).to_html
+		end
+	end
+end

data/lib/fir/static.rb

@@ -0,0 +1,45 @@
+module Fir
+	class Static
+		FORBIDDEN_DIRS = ['.svn', '.git']
+		
+		def initialize(app)
+			@app = app
+			@file_server = ::Rack::File.new(File.join(FIR_ROOT, 'public'))
+		end
+		
+		def call(env)
+			path   = Fir.sanitize_page(::Rack::Utils.unescape(env['PATH_INFO']).chomp('/'))
+			method = env['REQUEST_METHOD']
+			if method == 'GET'
+				if static_exists?(path, true)
+					return @file_server.call(env)
+				elsif Fir.config.perform_caching
+					cached_path = File.join('cache', path)
+					# Change PATH_INFO because @file_server uses that variable to find the file
+					if static_exists?(cached_path, false) # Is it a directory?
+						index_path = File.join(cached_path, 'index.html')
+						if static_exists?(index_path, true)
+							env['PATH_INFO'] = index_path							
+							return @file_server.call(env)
+						else # If the directory index isn't cached, pass on the request so PageRenderer can look for an index file.
+							return @app.call(env)
+						end
+					elsif static_exists?(cached_path + '.html', true) # Is it a file?
+						env['PATH_INFO'] = cached_path + '.html'
+						return @file_server.call(env)
+					end
+				end
+			end
+			return @app.call(env)
+		end
+		
+		protected
+		
+		# If look_for_files is true, use File.file?, else use File.directory?
+		def static_exists?(path, look_for_files)
+			return false unless (path.split('/') & FORBIDDEN_DIRS).empty?
+			path = File.join(@file_server.root, path)
+			(look_for_files ? File.file?(path) : File.directory?(path)) and File.readable?(path)
+        end
+	end
+end

data/lib/fir/tasks.rb

@@ -0,0 +1,32 @@
+module Fir
+	module Tasks
+		def self.define
+			namespace :users do
+				desc 'Add a user for the content management API. If the user already exists, the password is overwritten. ' +
+					'You must restart your server for the change to take effect. Usage: rake add_user user=username pass=password'
+				task :add do
+					require 'fir'
+					require 'active_support/secure_random'
+					unless (ENV.has_key?('user') or ENV.has_key?('USER')) and (ENV.has_key?('pass') or ENV.has_key?('PASS'))
+						raise 'usage: rake users:add user=username pass=password'
+					end
+					user = ENV['user'] || ENV['USER']
+					pass = ENV['pass'] || ENV['PASS']
+					
+					if File.exists?('users.yml')
+						pairs = YAML::load(File.read('users.yml')) || {}
+					else
+						pairs = {}
+					end
+					
+					salt = ActiveSupport::SecureRandom.hex(13)
+					pairs[user] = {'crypted_password' => Fir.encrypt_password(pass, salt), 'salt' => salt}
+					
+					File.open('users.yml', 'w') do |file|
+						file.write(YAML::dump(pairs))
+					end
+				end
+			end
+		end
+	end
+end

data/lib/fir/util.rb

@@ -0,0 +1,52 @@
+module Fir
+	# Page is a path such as you would find in a URL, not a local filesystem path
+	def self.clear_cache(page)
+		directory, filename, ext = Fir.split_path(page)
+		path = File.join(FIR_ROOT, 'public/cache', directory, filename + '.html')
+		if File.exists?(path)
+			File.delete(path)
+		end
+	end
+	
+	def self.config
+		@config ||= OpenStruct.new
+		yield @config if block_given?
+		# Default configs go here
+		@config.perform_caching ||= false
+		@config.relative_url_root ||= ''
+		@config
+	end
+	
+	def self.encrypt_password(password, salt)
+		crypted_password = password + salt
+		3.times do
+			crypted_password = Digest::SHA512.hexdigest(crypted_password)
+		end
+		crypted_password
+	end
+	
+	def self.sanitize_page(page)
+		page.gsub('../', '')
+	end
+	
+	# returns [directories, name w/o extension, extension]
+	def self.split_path(path)
+		ext = File.extname(path)
+		dirname = File.dirname(path)
+		dirname = '' if dirname == '.'
+		[dirname, File.basename(path, ext), ext]
+	end
+	
+	def self.validate_config
+		unless @config
+			raise 'Fir cannot start unless you call Fir.config in config.rb.'
+		end
+		missing_options = [:site_name, :perform_caching, :relative_url_root].inject([]) do |missing, opt|
+			missing << opt if @config.send(opt).nil?
+			missing
+		end
+		unless missing_options.empty?
+			raise "Fir.config (in config.rb) is missing the following options: #{missing_options.join(', ')}"
+		end
+	end
+end

data/skeleton/Rakefile

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'fir'
+
+::Fir::Tasks.define

data/skeleton/config.rb

@@ -0,0 +1,8 @@
+# This is the main config file for your site. Add any "require" statements or any other global directives here.
+
+require 'maruku' # Comment out if you don't want to use Markdown
+
+Fir.config do |config|
+	config.site_name = 'Change me in config.rb'
+	config.perform_caching = false
+end

data/skeleton/config.ru

@@ -0,0 +1,12 @@
+# This file tells Rack how to boot Fir. It's the point of entry for the whole framework.
+# You shouldn't have to modify this file. If you came here looking for the app's config
+# file, you're in the wrong place. Look at config.rb instead.
+
+FIR_ROOT = File.expand_path(File.dirname(__FILE__))
+
+require 'fir.rb'
+require 'config.rb'
+
+# This is where it all begins.
+# See boot.rb in the Fir gem if you're curious about what happens next.
+instance_eval(&Fir.boot_proc)

data/skeleton/layouts/application.html.erb

@@ -0,0 +1,34 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+
+<head>
+	<title>
+		<% if @title and !@title.empty? %>
+			<%= h @title %> - 
+		<% end %>
+		My Site
+	</title>
+	<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
+	<% if @description and !@description.empty? %>
+		<meta name="description" content="<%= h @page_description %>"/>
+	<% end %>
+	<link href="/stylesheets/style.css" rel="stylesheet" type="text/css"/>
+</head>
+
+<body>
+
+<div id="container">
+	<ul id="top_nav">
+		<% menu('main') do |item, current_page| %>
+			<!-- current_page is true if the menu item links to the current page, false otherwise.
+			It's usually not necessary, since you'll automatically get either an <a> or <span class="selected">.-->
+			<li><%= item %></li>
+		<% end %>
+	</ul>
+	
+	<%= yield %>
+</div>
+
+</body>
+</html>

data/skeleton/menus.yml

@@ -0,0 +1,5 @@
+# You must restart your server after editing this file.
+
+main:
+- Home: 
+- Contact: contact

data/skeleton/pages.yml

@@ -0,0 +1,6 @@
+# You must restart your server after editing this file.
+
+index:
+  title: Home
+contact:
+  title: Contact

data/skeleton/pages/404.html.erb

@@ -0,0 +1 @@
+<h1>Sorry, there is nothing at this address. (404 Not Found)</h1>

data/skeleton/pages/contact.markdown

@@ -0,0 +1,2 @@
+Contact
+=======

data/skeleton/pages/index.markdown

@@ -0,0 +1,2 @@
+Home
+====

data/skeleton/public/stylesheets/style.css

@@ -0,0 +1,8 @@
+body { font-family: helvetica, arial, verdana, sans-serif; font-size: 83%; text-align: center; }
+/* General typography */
+h1 { font-size: 2em; }
+h2 { font-size: 1.7em; }
+h3 { font-size: 1.5em; }
+/* Layout elements */
+div#container { width: 960px; margin-left: auto; margin-right: auto; text-align: left; }
+/* Specific pages */

data/skeleton/tmp/restart.txt

@@ -0,0 +1 @@
+Run "touch tmp/restart.txt" to restart Passenger. (This doesn't work if you stared Fir using rackup.)

data/spec/fir_spec.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe 'Fir' do
+	it 'returns static files in the public directory'
+	
+	it 'returns static files in subdirectories of the public directory'
+	
+	it 'does not allow access to files above the pages directory'
+	
+	it 'maps pretty URLs to files in the pages directory'
+	
+	it 'maps pretty URLs to files in subdirectories of the pages directory'
+	
+	it 'returns 404 for bad URLs'
+	
+	context 'with caching on' do
+		it 'uses the cached page for pages in the root directory'
+		
+		it 'uses the cached page for pages in subdirectories'
+		
+		it 'writes to the cache when a page is accessed'
+	end
+	
+	describe 'page_config.yml' do
+		it 'can override URL mappings'
+		
+		it 'can specify page titles (if implemented in the layout)'
+		
+		it 'can specify meta descriptions (if implemented in the layout)'
+	end
+	
+	describe 'admin interface' do
+		it 'returns 404 for bad URLs'
+		
+		describe 'GET pages' do
+			it 'requires HTTP auth'
+			
+			it 'does not accept bad user/pass combos'
+			
+			it 'returns an XML feed with each directory and page'
+		end
+		
+		describe 'GET page/pagename' do
+			it 'requires HTTP auth'
+			
+			it 'does not accept bad user/pass combos'
+			
+			it 'returns the source code of the page'
+			
+			it 'sets Content-Type to text/plain'
+			
+			it 'sets Content-Disposition to attachment'
+			
+			it 'sets Content-Disposition filename to the source filename'
+		end
+		
+		describe 'POST page/pagename' do
+			it 'requires HTTP auth'
+			
+			it 'does not accept bad user/pass combos'
+			
+			it 'creates the page if none exists'
+			
+			it 'overwrites the page if it exists'
+			
+			it 'clears the cache if caching is on'
+			
+			it "clears the cache even if caching is off (in case it's off temporarily)"
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'fir'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+	
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification 
+name: fir
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- jarrett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-01 00:00:00 -06:00
+default_executable: fir
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 1
+        version: 1.0.1
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 1
+        - 2
+        version: 2.1.2
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: maruku
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  version_requirements: *id004
+description: Rack-based, Passenger-compatible, with pretty URLs and simple HTTP API for managing content
+email: jarrett@uchicago.edu
+executables: 
+- fir
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- bin/fir
+- example/Rakefile
+- example/boot_example.rb
+- example/config.rb
+- example/config.ru
+- example/layouts/application.html.erb
+- example/menus.yml
+- example/pages.yml
+- example/pages/404.html.erb
+- example/pages/contact-us.markdown
+- example/pages/index.markdown
+- example/pages/products/dynamite-plus.html.erb
+- example/pages/products/dynamite.html.erb
+- example/pages/products/index.markdown
+- example/pages/products/mouse-trap.html.erb
+- example/public/manage-content.html
+- example/public/static.txt
+- example/public/stylesheets/style.css
+- example/tmp/restart.txt
+- example/users.yml
+- lib/fir.rb
+- lib/fir/admin.rb
+- lib/fir/boot.rb
+- lib/fir/helpers.rb
+- lib/fir/pages.rb
+- lib/fir/static.rb
+- lib/fir/tasks.rb
+- lib/fir/util.rb
+- skeleton/Rakefile
+- skeleton/config.rb
+- skeleton/config.ru
+- skeleton/layouts/application.html.erb
+- skeleton/menus.yml
+- skeleton/pages.yml
+- skeleton/pages/404.html.erb
+- skeleton/pages/contact.markdown
+- skeleton/pages/index.markdown
+- skeleton/public/stylesheets/style.css
+- skeleton/tmp/restart.txt
+- LICENSE
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/jarrett/fir
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A minimalist Ruby framework for small, static sites
+test_files: 
+- spec/fir_spec.rb
+- spec/spec_helper.rb