fir 0.0.9 → 0.0.10

data/README.markdown

@@ -1,7 +1,9 @@
-Fir Isn't Rails
-===============
+Fir
+===
 
-Fir Isn't Rails is a minimalist Ruby framework for small, static sites. It's Rack-based, so it runs on Phusion Passenger.
+Fir is a minimalist Ruby framework for small, mostly-static sites. It provides an optimized workflow for sites where a CMS would be overkill, but static HTML would be like a return to the dark ages.
+
+It's Rack-based, so it runs on Phusion Passenger. But even if your web host doesn't support Ruby, fear not! Fir allows you to export static HTML to a live server with a single command. That means it works with every web host that supports SSH and mod_rewrite.
 
 Warning: Alpha Release
 ======================
@@ -98,19 +100,42 @@ Most of us will be perfectly happy managing content by editing the files in the
 
 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).
 
+As of yet, no Fir client exists, though one is in development. And anyone can make one.
+
 Fir's API uses HTTP basic authentication. The users list is stored in `users.yml`. To create a user or change an existing user's password, run:
 
 	rake users:add user=username pass=password
 
-## Exporting to HTML ##
+## Exporting HTML to a Remote Server ##
 
-You can export your whole site to static HTML. If you deploy that, the only thing you'll need on your server is mod_rewrite. To export:
+If your web host doesn't support Passenger, you can still enjoy (almost) all the goodness of Fir. Fir makes it dead-simple to export your entire site to static HTML on a remote server.
 
-	rake export dir=~/sites/exported_example
+To make this work, you'll need rsync and ssh. Make sure they're in your path. In other words, you must be able to run `rsync` and `ssh` from the command line. You don't need to know how to use them; they just need to be installed.
+
+Setup `deploy.yml` in the root directory of your Fir project. It should look something like this:
+
+    # deploy.yaml
+    host: example.com
+    user: your_username
+    path: /home/your_username/public_html
+
+Now you can run this convenient Rake task to deploy a static version of your site to the server:
+
+    rake export_to_server
 
-The export task boots a Rackup server and accesses each page to generate the cache. It then copies the cache and the rest of the public folder to the output directory. By default, Rackup runs on port 9292. You can make it use a different port like this:
+You can also skip `deploy.yml` and run the Rake task like this:
 
-	rake export dir=~/sites/exported_example port=3000
+    rake export_to_server dest=your_username@example.com:/home/your_username/public_html
+
+Behind the scenes, the export task accesses each page to generate the cache. It copies the cache and the rest of the public files to your server using rsync.
+
+There's one obvious downside to this approach: you'll lose any dynamic features you may have built in, as well as Fir's admin API.
+
+## Exporting to HTML Locally ##
+
+You can also export your whole site to static HTML on your local machine. If you To export:
+
+	rake export dir=~/sites/exported_example
 
 Webserver Support
 =================

data/bin/fir

@@ -1,17 +1,12 @@
 #!/usr/bin/env ruby
 
-$:.unshift '/Users/jarrettcolby/apps/fir/lib'
+# When developing the gem, we want to be able to run this executable using the
+# source in our development directory instead of the installed gem. The tests must
+# run "export TESTING_FIR_BIN=1" before invoking this executable.
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib') if ENV['TESTING_FIR_BIN'] == '1'
+
 require 'rubygems'
 require 'fir'
-include FileUtils
-
-unless ARGV.length >= 1
-	raise 'Usage: fir path'
-end
+require 'fir/generator'
 
-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}"
+Fir.generate!(ARGV)

data/example/Rakefile

@@ -1,6 +1,9 @@
 FIR_ROOT = File.expand_path(File.dirname(__FILE__))
 
-#$:.unshift File.expand_path(File.join(File.dirname(__FILE__), '../lib')) # Enable this to run against the code in the parent directory instead of the intalled gem
+# When developing the gem, we want to be able to run Rake tasks using the
+# source in our development directory instead of the installed gem. The tests must
+# run "export TESTING_FIR_TASKS=1" before invoking this executable.
+$:.unshift File.expand_path(File.join(File.dirname(__FILE__), '../lib')) if ENV['TESTING_FIR_TASKS'] == '1'
 require 'rubygems'
 require 'fir'
 

data/example/deploy.yml

@@ -0,0 +1,3 @@
+host: example.com
+user: me
+path: /www-root

data/example/public/cache/404.html

@@ -0,0 +1,46 @@
+<!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>
+		
+		Acme Co.
+	</title>
+	<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
+	
+	
+	<!--[if !IE 6]><!-->
+	<link href="http://yui.yahooapis.com/2.8.0r4/build/reset/reset-min.css" rel="stylesheet" type="text/css">
+	<link href="/stylesheets/style.css" rel="stylesheet" type="text/css"/>
+	<!--<![endif]-->
+
+	<!--[if lte IE 6]>
+	<link rel="stylesheet" type="text/css" media="screen, projection" href="http://universal-ie6-css.googlecode.com/files/ie6.0.3.css" />
+	<![endif]-->
+</head>
+
+<body>
+
+<div id="container">
+	<ul id="top_nav">
+		
+			<!-- 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><a href="/">Home</a></li>
+		
+			<!-- 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><a href="/products">Products</a></li>
+		
+			<!-- 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><a href="/contact-us">Contact Us</a></li>
+		
+	</ul>
+	
+	<h1>Sorry, there is nothing at this address. (404 Not Found)</h1>
+</div>
+
+</body>
+</html>

data/example/public/cache/contact-us.html

@@ -0,0 +1,48 @@
+<!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>
+		
+		Acme Co.
+	</title>
+	<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
+	
+	
+	<!--[if !IE 6]><!-->
+	<link href="http://yui.yahooapis.com/2.8.0r4/build/reset/reset-min.css" rel="stylesheet" type="text/css">
+	<link href="/stylesheets/style.css" rel="stylesheet" type="text/css"/>
+	<!--<![endif]-->
+
+	<!--[if lte IE 6]>
+	<link rel="stylesheet" type="text/css" media="screen, projection" href="http://universal-ie6-css.googlecode.com/files/ie6.0.3.css" />
+	<![endif]-->
+</head>
+
+<body>
+
+<div id="container">
+	<ul id="top_nav">
+		
+			<!-- 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><a href="/">Home</a></li>
+		
+			<!-- 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><a href="/products">Products</a></li>
+		
+			<!-- 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><span class="selected">Contact Us</span></li>
+		
+	</ul>
+	
+	<h1 id='contact_us'>Contact Us</h1>
+
+<p>555-123-4567 98765 Runner Road Coyote, AZ</p>
+</div>
+
+</body>
+</html>

data/example/public/cache/index.html

@@ -0,0 +1,52 @@
+<!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>
+		
+			Home - 
+		
+		Acme Co.
+	</title>
+	<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
+	
+		<meta name="description" content="Acme Co. sells all the widgets you need to capture road runners and other desert fauna"/>
+	
+	
+	<!--[if !IE 6]><!-->
+	<link href="http://yui.yahooapis.com/2.8.0r4/build/reset/reset-min.css" rel="stylesheet" type="text/css">
+	<link href="/stylesheets/style.css" rel="stylesheet" type="text/css"/>
+	<!--<![endif]-->
+
+	<!--[if lte IE 6]>
+	<link rel="stylesheet" type="text/css" media="screen, projection" href="http://universal-ie6-css.googlecode.com/files/ie6.0.3.css" />
+	<![endif]-->
+</head>
+
+<body>
+
+<div id="container">
+	<ul id="top_nav">
+		
+			<!-- 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><a href="/">Home</a></li>
+		
+			<!-- 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><a href="/products">Products</a></li>
+		
+			<!-- 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><a href="/contact-us">Contact Us</a></li>
+		
+	</ul>
+	
+	<h1 id='home'>Home</h1>
+
+<p>Welcome to Acme Company!</p>
+</div>
+
+</body>
+</html>

data/example/public/cache/products/dynamite-plus.html

@@ -0,0 +1,52 @@
+<!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>
+		
+		Acme Co.
+	</title>
+	<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
+	
+	
+	<!--[if !IE 6]><!-->
+	<link href="http://yui.yahooapis.com/2.8.0r4/build/reset/reset-min.css" rel="stylesheet" type="text/css">
+	<link href="/stylesheets/style.css" rel="stylesheet" type="text/css"/>
+	<!--<![endif]-->
+
+	<!--[if lte IE 6]>
+	<link rel="stylesheet" type="text/css" media="screen, projection" href="http://universal-ie6-css.googlecode.com/files/ie6.0.3.css" />
+	<![endif]-->
+</head>
+
+<body>
+
+<div id="container">
+	<ul id="top_nav">
+		
+			<!-- 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><a href="/">Home</a></li>
+		
+			<!-- 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><a href="/products">Products</a></li>
+		
+			<!-- 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><a href="/contact-us">Contact Us</a></li>
+		
+	</ul>
+	
+	<h1>Dynamite Plus!</h1>
+
+<p><a href="/products">Back to products</a></p>
+
+<p>Like our popular <a href="/products/dynamite">Dynamite</a>, but even more powerful!</p>
+
+<p>Released: Feb 1st 1956 (54 years ago)</p>
+</div>
+
+</body>
+</html>

data/example/public/cache/products/dynamite.html

@@ -0,0 +1,52 @@
+<!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>
+		
+		Acme Co.
+	</title>
+	<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
+	
+	
+	<!--[if !IE 6]><!-->
+	<link href="http://yui.yahooapis.com/2.8.0r4/build/reset/reset-min.css" rel="stylesheet" type="text/css">
+	<link href="/stylesheets/style.css" rel="stylesheet" type="text/css"/>
+	<!--<![endif]-->
+
+	<!--[if lte IE 6]>
+	<link rel="stylesheet" type="text/css" media="screen, projection" href="http://universal-ie6-css.googlecode.com/files/ie6.0.3.css" />
+	<![endif]-->
+</head>
+
+<body>
+
+<div id="container">
+	<ul id="top_nav">
+		
+			<!-- 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><a href="/">Home</a></li>
+		
+			<!-- 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><a href="/products">Products</a></li>
+		
+			<!-- 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><a href="/contact-us">Contact Us</a></li>
+		
+	</ul>
+	
+	<h1>Dynamite</h1>
+
+<p><a href="/products">Back to products</a></p>
+
+<p>Acme's most popular product! Suitable for all forms of demolition and hunting road runners.</p>
+
+<p>Released: Jan 19th 1956 (54 years ago)</p>
+</div>
+
+</body>
+</html>

data/example/public/cache/products/index.html

@@ -0,0 +1,58 @@
+<!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>
+		
+			Products - 
+		
+		Acme Co.
+	</title>
+	<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
+	
+		<meta name="description" content="Acme Company's products"/>
+	
+	
+	<!--[if !IE 6]><!-->
+	<link href="http://yui.yahooapis.com/2.8.0r4/build/reset/reset-min.css" rel="stylesheet" type="text/css">
+	<link href="/stylesheets/style.css" rel="stylesheet" type="text/css"/>
+	<!--<![endif]-->
+
+	<!--[if lte IE 6]>
+	<link rel="stylesheet" type="text/css" media="screen, projection" href="http://universal-ie6-css.googlecode.com/files/ie6.0.3.css" />
+	<![endif]-->
+</head>
+
+<body>
+
+<div id="container">
+	<ul id="top_nav">
+		
+			<!-- 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><a href="/">Home</a></li>
+		
+			<!-- 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><a href="/products">Products</a></li>
+		
+			<!-- 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><a href="/contact-us">Contact Us</a></li>
+		
+	</ul>
+	
+	<h1 id='products'>Products</h1>
+
+<ul>
+<li><a href='/products/dynamite'>Dynamite</a></li>
+
+<li><a href='/products/dynamite%2B'>Dynamite Plus!</a></li>
+
+<li><a href='/products/mouse-trap'>Mouse Trap</a></li>
+</ul>
+</div>
+
+</body>
+</html>

data/example/public/cache/products/mouse-trap.html

@@ -0,0 +1,52 @@
+<!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>
+		
+		Acme Co.
+	</title>
+	<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
+	
+	
+	<!--[if !IE 6]><!-->
+	<link href="http://yui.yahooapis.com/2.8.0r4/build/reset/reset-min.css" rel="stylesheet" type="text/css">
+	<link href="/stylesheets/style.css" rel="stylesheet" type="text/css"/>
+	<!--<![endif]-->
+
+	<!--[if lte IE 6]>
+	<link rel="stylesheet" type="text/css" media="screen, projection" href="http://universal-ie6-css.googlecode.com/files/ie6.0.3.css" />
+	<![endif]-->
+</head>
+
+<body>
+
+<div id="container">
+	<ul id="top_nav">
+		
+			<!-- 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><a href="/">Home</a></li>
+		
+			<!-- 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><a href="/products">Products</a></li>
+		
+			<!-- 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><a href="/contact-us">Contact Us</a></li>
+		
+	</ul>
+	
+	<h1>Mouse Trap</h1>
+
+<p><a href="/products">Back to products</a></p>
+
+<p>Catch those varmints!</p>
+
+<p>Released: May 12th 1964 (46 years ago)</p>
+</div>
+
+</body>
+</html>