staticify 0.1.1

data/README.rdoc

@@ -0,0 +1,50 @@
+= Staticify
+
+Staticify is a tool for creating static sites in Ruby.
+
+There are lots of tools out there already for creating static sites, eg:
+Jekyll::       http://jekyllrb.com
+StaticMatic::  http://staticmatic.rubyforge.org
+webgen::       http://webgen.rubyforge.org
+Webby::        http://webby.rubyforge.org
+
+The problem with these tools, in my opinion, is that they make you code 
+your sites in a certain way.
+
+What if you want to code your blog in Rails or Sinatra or something?
+
+Staticify is intended to solve this problem for you.  If you want 
+to code your static site in any Rack-based web framework, go right ahead! 
+
+You can use Staticify to statically cache responses to your app.
+
+== Installation
+
+  $ gem sources -a http://gems.github.com
+  $ sudo gem install remi-staticify
+
+== Usage
+
+Simple script for staticifying your Rack applications
+
+  staticify == %{ For staticifying your Rack applications }
+
+    Usage:
+      echo 'paths' | staticify      # print this usage information
+      echo 'paths' | staticify .    # staticify Rack app in current directory
+
+    Note:
+      staticify expects to get the paths to hit via STDIN
+
+    Options:
+      -d, --dir some/directory   # directory to save files to
+      -a, --app "MyApp.new"      # ruby to eval to get Rack app
+      -r, --require file[.rb]    # ruby file(s) to require
+
+== Notes
+
+Checks for config.ru / Rails by default, otherwise you can:
+
+  $ staticify -r myapp.rb --app 'lambda {|env| [200, {}, "hi!"] }' info
+  $ staticify -r myapp.rb,another-file.rb --app 'Sinatra::Application' get '/'
+  $ staticify -r myapp --app 'MyApp.new' '/'

data/Rakefile

@@ -0,0 +1,69 @@
+require 'rake'
+require 'rubygems'
+require 'rake/rdoctask'
+require 'spec/rake/spectask'
+
+puts "\nGem: staticify\n\n"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name        = 'staticify'
+    s.summary     = 'Tool for staticly caching Ruby web applications'
+    s.email       = 'remi@remitaylor.com'
+    s.homepage    = 'http://github.com/remi/staticify'
+    s.description = 'Tool for staticly caching Ruby web applications (based on Rack::Staticifier)'
+    s.authors     = %w( remi )
+    s.files       = FileList['[A-Z]*', '{lib,spec,bin,examples}/**/*'] 
+    s.add_dependency 'remi-rackbox'
+    s.add_dependency 'remi-rack-staticifier'
+    # s.executables << 'staticify'
+    # s.rubyforge_project = 'gemname'
+    # s.extra_rdoc_files = %w( README.rdoc )
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+end
+
+# require 'hanna'
+# require 'darkfish-rdoc'
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'staticify'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  # rdoc.options += ["--template=#{`allison --path`}"]  # sudo gem install allison
+  # rdoc.options += %w( -f darkfish )                   # sudo gem install darkfish-rdoc
+  # rdoc.options += %w( -T hanna )                      # sudo gem install mislav-hanna
+  rdoc.options += %w( -m README.rdoc ) # the initial page displayed
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc 'Confirm that gemspec is $SAFE'
+task :safe do
+  require 'yaml'
+  require 'rubygems/specification'
+  data = File.read('staticify.gemspec')
+  spec = nil
+  if data !~ %r{!ruby/object:Gem::Specification}
+    Thread.new { spec = eval("$SAFE = 3\n#{data}") }.join
+  else
+    spec = YAML.load(data)
+  end
+  spec.validate
+  puts spec
+  puts "OK"
+end
+
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/bin/staticify

@@ -0,0 +1,110 @@
+#! /usr/bin/env ruby
+#
+# Simple script for staticifying your Rack applications
+#
+# Checks for config.ru / Rails by default, otherwise you can:
+#
+#   $ staticify -r myapp.rb --app 'lambda {|env| [200, {}, "hi!"] }' info
+#   $ staticify -r myapp.rb,another-file.rb --app 'Sinatra::Application' get '/'
+#   $ staticify -r myapp --app 'MyApp.new' '/'
+#
+%w( rubygems rackbox optparse fileutils rack-staticifier ).each {|lib| require lib }
+
+def usage
+  puts <<USAGE
+
+  staticify == %{ For staticifying your Rack applications }
+
+    Usage:
+      echo 'paths' | staticify      # print this usage information
+      echo 'paths' | staticify .    # staticify Rack app in current directory
+
+    Note:
+      staticify expects to get the paths to hit via STDIN
+
+    Options:
+      -d, --dir some/directory   # directory to save files to
+      -a, --app "MyApp.new"      # ruby to eval to get Rack app
+      -r, --require file[.rb]    # ruby file(s) to require
+      -p, --paths "/,/foo,/bar"  # specify paths (instead of STDIN)
+      -y, --dry-run              # just print what we *would* do
+      -s, --save                 # don't delete dir before running
+
+USAGE
+end
+
+if ARGV.empty?
+  usage
+  exit
+end
+
+#### ==== Option Parsing ==== ####
+
+files_to_require  = []
+ruby_to_run       = nil
+path_to_cache_to  = '.site'
+paths_to_cache    = []
+dry_run           = false
+overwrite_dir     = true
+
+opts = OptionParser.new do |opts|
+  opts.on('-r', '--require [file]') {|x| files_to_require << x            }
+  opts.on('-a', '--app [ruby]')     {|x| ruby_to_run       = x            }
+  opts.on('-d', '--dir [dir]')      {|x| path_to_cache_to  = x            }
+  opts.on('-p', '--paths [paths]')  {|x| paths_to_cache    = x.split(',') }
+  opts.on('-y', '--dry-run')        {    dry_run           = true         }
+  opts.on('-s', '--save')           {    overwrite_dir     = false        }
+end
+opts.parse! ARGV
+
+app_directory = ARGV.shift
+unless File.directory? app_directory
+   puts "App directory not found: #{ app_directory }\n\n"
+   usage
+   exit
+end
+FileUtils.cd app_directory
+
+files_to_require.each {|file| require file }
+if ruby_to_run
+  begin
+    RackBox.app = eval(ruby_to_run)
+  rescue Exception => ex
+    puts "Tried running Ruby code to set Rack app: #{ ruby_to_run.inspect }"
+    raise ex
+  end
+end
+
+unless RackBox.app(:silent => true)
+  puts "Cannot find your Rack application\n\n"
+  usage
+  exit
+end
+
+#### ==== Get Routes to Cache ==== ####
+
+if paths_to_cache.empty?
+  while path = gets
+    paths_to_cache << path.strip
+  end
+end
+
+puts "Caching to #{ path_to_cache_to }"
+
+puts "#{ paths_to_cache.length } paths to cache:"
+
+#### ==== Cache the Routes ==== ####"
+
+puts "rm -rf #{ path_to_cache_to }" if overwrite_dir
+FileUtils.rm_rf path_to_cache_to if overwrite_dir && !dry_run
+
+RackBox.app = Rack::Staticifier.new(RackBox.app, :root => path_to_cache_to)
+
+paths_to_cache.each do |path|
+  if dry_run
+    puts "  #{ path }"
+  else
+    response = RackBox.request path
+    puts "  #{ response.status }  #{ path }"
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: staticify
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- remi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-15 00:00:00 -07:00
+default_executable: staticify
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack-staticifier
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Tool for staticly caching Ruby web applications (based on Rack::Staticifier)
+email: remi@remitaylor.com
+executables: 
+- staticify
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/staticify
+has_rdoc: true
+homepage: http://github.com/remi/staticify
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Tool for staticly caching Ruby web applications
+test_files: []
+