fir 0.0.5 → 0.0.7

data/README.markdown

@@ -59,6 +59,8 @@ Check `httpd.conf` syntax and restart Apache:
 
 That should do it.
 
+If you can't make this work, there's a workaround: you can export your whole site to static HTML. See "Exporting to HTML" below.
+
 Basic Usage
 ===========
 
@@ -100,6 +102,16 @@ Fir's API uses HTTP basic authentication. The users list is stored in `users.yml
 
 	rake users:add user=username pass=password
 
+## Exporting to HTML ##
+
+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:
+
+	rake export dir=~/sites/exported_example
+
+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:
+
+	rake export dir=~/sites/exported_example port=3000
+
 Webserver Support
 =================
 
@@ -107,7 +119,7 @@ Fir is designed primarily for Phusion Passenger. As a Rack-based framework, it t
 
 As of this writing, Fir has only been tested with Rackup, Passenger, and CGI. If you get Fir working with anything else, please visit Fir's GitHub repository and let us know how you did it.
 
-By the way, using CGI in production is **not** recommended. CGI boots a new Fir instance on every request. Fir is a pretty lightweight framework, so the load time isn't huge, but that doesn't mean CGI is a good idea. If you understand the issues with CGI and still want to use it, go ahead and take a look at [`dispatch.cgi`](http://github.com/jarrett/fir-example/blob/master/public/dispatch.cgi) in the example.
+By the way, using CGI in production is **not** recommended. CGI boots a new Fir instance on every request. Fir is a pretty lightweight framework, so the load time isn't huge, but that doesn't mean CGI is a good idea. If you understand the issues with CGI and still want to use it, go ahead and take a look at [`dispatch.cgi`](http://github.com/jarrett/fir-example/blob/master/public/dispatch.cgi) in the example site.
 
 Unicode and Others
 ==================

data/example/Rakefile

@@ -1,3 +1,5 @@
+FIR_ROOT = File.expand_path(File.dirname(__FILE__))
+
 require 'rubygems'
 require 'fir'
 

data/lib/fir/boot.rb

@@ -7,6 +7,10 @@ module Fir
 			# directory fixes that.
 			Dir.chdir(FIR_ROOT)
 			::Fir.validate_config
+			# This allows us to invoke Rackup with -e "FORCE_CACHING = true"
+			if defined?(FORCE_CACHING) and FORCE_CACHING
+				Fir.config.perform_caching = true
+			end
 			#use ::Rack::Reloader # Only when developing the Fir gem
 			use ::Rack::ContentLength
 			use ::Fir::Static

data/lib/fir/tasks.rb

@@ -27,6 +27,95 @@ module Fir
 					end
 				end
 			end
+			desc 'Export the site to static HTML. (For web hosts that can\'t support Rack. But mod_rewrite must be enabled for .htaccess!) ' +
+				'This will temporarily run Rackup on port 3000 or another port you specify. Usage: rake export dir=path_to_export_to [port=3000]'
+			task :export do
+				require 'fileutils'
+				
+				if !ENV.has_key?('dir') or ENV['dir'].empty?
+					raise(ArgumentError, 'Usage: rake export dir=path_to_export_to [port=3000]')
+				end
+				
+				port = ENV['port'] || 9292
+				
+				pid_file = 'cache_gen_server.pid'
+				
+				puts 'Starting Rackup with caching turned on...'
+				fork do
+					exec %Q{rackup -p #{port} -e "FORCE_CACHING = true" -D --pid #{pid_file}}
+				end
+				sleep(1) # Give the server a moment to boot
+				
+				page_config = YAML.load(File.read(File.join(FIR_ROOT, 'pages.yml')))
+				path_mappings = page_config.inject({}) do |mappings, (page, configs)|
+					mappings[configs['path']] = page if configs['path']
+					mappings
+				end
+				inverted_path_mappings = path_mappings.invert
+				
+				pages_dir = File.join(FIR_ROOT, 'pages')
+				# Get all the page files without extensions
+				paths = Dir.glob(pages_dir + '/**/**').inject([]) do |result, file|
+					file.gsub!(pages_dir + '/', '')
+					file.gsub!(/#{File.extname(file)}$/, '')
+					unless inverted_path_mappings.has_key?(file)
+						result << file
+					end
+					result
+				end + path_mappings.keys
+				
+				puts 'Getting each page to generate the cache...'
+				
+				paths.each do |path|
+					getter = lambda { Net::HTTP.get(URI.parse("http://localhost:#{port}/#{path}")) }
+					failure_count = 0
+					giving_up = false
+					success = false
+					while failure_count <= 3 and !success
+						puts '  GET ' + path
+						begin
+							getter.call
+							success = true
+						rescue
+							failure_count += 1
+							if failure_count <= 3
+								puts '    Could not connect. Retrying.'
+								sleep(1)
+							else
+								puts '    Could not connect. Giving up.'
+								giving_up = true
+							end
+						end
+					end
+					break if giving_up
+				end
+				
+				server_pid = File.read(pid_file).to_i
+				Process.kill('SIGINT', server_pid)
+				File.delete(pid_file)
+				
+				copy_from = File.join(FIR_ROOT, 'public', '.')
+				copy_to = ENV['dir']
+				unless File.exists?(copy_to)
+					Dir.mkdir(copy_to)
+				end
+				FileUtils.cp_r(copy_from, copy_to)
+				FileUtils.cp_r(File.join(copy_to, 'cache', '.'), copy_to)
+				FileUtils.rm_rf(File.join(copy_to, 'cache'))
+				['.htaccess', 'dispatch.cgi'].each do |file|
+					File.delete(File.join(copy_to, file))
+				end
+				# Create a simple .htaccess file to enable pretty URLs
+				htaccess =
+				"DirectoryIndex index.html\n" +
+				"RewriteEngine On\n" +
+				"RewriteCond %{REQUEST_FILENAME} !-f\n" +
+				"RewriteCond %{REQUEST_FILENAME} !-d\n" +
+				"RewriteRule (.*) $1.html"
+				File.open(File.join(copy_to, '.htaccess'), 'w') do |f|
+					f.write(htaccess)
+				end
+			end
 		end
 	end
 end

data/skeleton/Rakefile

@@ -1,3 +1,5 @@
+FIR_ROOT = File.expand_path(File.dirname(__FILE__))
+
 require 'rubygems'
 require 'fir'
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 7
+  version: 0.0.7
 platform: ruby
 authors: 
 - jarrett