rackstatic 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 267eb64b9764c46b88ca1dbc1abe8da58f8bfbc1
-  data.tar.gz: f2fdca89188299c54260aad0190633055b46ef6a
+  metadata.gz: bc1751213160fd605d7884ac94edf263ba7c2050
+  data.tar.gz: e783ebc5fe72cd0a64b5ba01641690fd9d6fb8f2
 SHA512:
-  metadata.gz: 953fa14a5ca0e27abe4b9f4e85aef692c047bfff162e274c04722ce296ff69b415252ddf3833f01f95bd376f1a0bdcb25415d0cd3d7a61511914def4c1281f74
-  data.tar.gz: 4983596a3936314c19b67d0a81ce1bd1f67b33f0a0ab545ad2b51dba5ce12bf9ba84159c3c17867d2fa95026fcae9c95e9a8d4a8f0bb9a10fcd7f97d989c0cb6
+  metadata.gz: 19284839fe275f71d4e42f23d511a197af1a0ff5d7f5a866ea5ea30f98a90d63093e31dda37a3e442103e82d8dffc2e097a4716552b498d28e956a942a6c89ac
+  data.tar.gz: 72dc00451eee38e4afb170e3ba76e7e09c7163d9b7391d5c3f5dcd2b16fc14aef9ebc5f59d8580047a28eb5ecbd795c4c566251b525db5c35e911061847e931b

data/README.md

@@ -1,7 +1,54 @@
-# Usage
+# Introduction
+
+There's this category of web framework called "static-site generators", or "SSGs" for short. We, as developers, use them because it's easier than the alternative: writing a regular server, then launching it, mirroring the contents using some arcane `wget` incantation, and shutting it back down afterward.
+
+But while SSGs eliminate *this* particular hassle, they come with their own: they require you to organize everything their own persnickety way; they don't follow common web-development practices; you have to write special plugins for them if you want to use any templating library or database adapter or whatever else that would "just work" anywhere else. It's almost less work to use `wget`.
+
+`rackstatic` cuts this Gordian knot. Using `rackstatic`, you can develop your static website in, say, [Sinatra](https://github.com/sinatra/sinatra). Or any Rack-compatible web framework (yes, even Rails, if you really really want.) And it's just as easy as using an SSG.
+
+## Here's the deal:
 
     $ gem install rackstatic
     $ cd your_rack_app/
-    $ rackstatic
+    $ rackstatic dist/
+
+A static mirror-copy of your website will now exist under `your_rack_app/dist/`.
+
+If your repo is layed out such that your application files (`config.ru` et al) exist under `your_repo/app/`, you can build from above it to keep things clean and separate:
+
+    $ gem install rackstatic
+    $ cd your_repo/
+    $ rackstatic dist/
+
+This will use the app in `your_repo/app/` to build `your_repo/dist/`.
+
+## How does it work?
+
+`rackstatic` uses the mock Rack session functionality of [rack-test](https://github.com/brynary/rack-test). Except, not so much for testing :grinning:. Instead, the values returned in each request are written to disk, then spidered (using [nokogiri](https://github.com/sparklemotion/nokogiri) to find more URLs to request.
+
+## What about static files?
+
+Some files aren't linked anywhere: `robots.txt`, `crossdomain.xml`, `favicon.ico`, and so forth. A regular spidering-based mirroring process would miss these.
+
+To prevent this, `rackstatic` will attempt to request anything it sees under `your_rack_app/public/` (e.g. `your_rack_app/public/robots.txt` -> `GET /robots.txt`), as if they had been linked to. You can change what subdirectory of your app is looked under using the `-s` switch:
+
+    $ rackstatic -s static/ dist/
+
+## It's probably better to...
+
+add `rackstatic` to your Gemfile. Then, when you pull down your app from its repo, it's as simple as:
+
+    $ bundle install
+    $ bundle exec rackstatic dist/
+
+## Programmatic usage
+
+You can add a deploy task to your Rakefile that calls `rackstatic`. Rather than messing with shell commands, try this:
+
+    task :deploy do
+      require 'rack/static-builder'
+      Rack::StaticBuilder.new(:app_dir => 'app/', :dest_dir => 'dist/').build!
+
+      # now push dist/ to S3 or Github or where-ever you like
+    end
 
-A static mirror-copy of your website will now be exist under `your_rack_app/build/`.

data/bin/rackstatic

@@ -8,11 +8,11 @@ require 'rack/static-builder'
 opts = {}
 opts[:app_dir] = 'app'
 opts[:app_static_dir] = 'public'
-opts[:dest_dir] = 'build'
+opts[:dest_dir] = 'dist'
 opts[:noisy] = true
 
 OptionParser.new do |op|
-  op.banner = "Usage: rackstatic [opts]"
+  op.banner = "Usage: rackstatic [opts] [destination]"
 
   op.on("-a", "--app DIRECTORY", "Application directory (where config.ru is)"){ |v| opts[:app_dir] = v }
   op.on("-s", "--static SUBDIRECTORY", "Directory within the app dir where static files are kept"){ |v| opts[:app_static_dir] = v }
@@ -20,11 +20,19 @@ OptionParser.new do |op|
   op.on("-d", "--dest DIRECTORY", "Build output directory"){ |v| opts[:dest_dir] = v }
 
   op.on("-q", "--quiet", "Build quietly"){ opts[:noisy] = false }
+
+  op.on_tail("-h", "--help", "Show this message") { puts opts; exit }
+  op.on_tail("--version", "Show version") { puts Rack::StaticBuilder::VERSION }
 end.parse!
 
+if ARGV.length == 1
+  opts[:dest_dir] = ARGV.shift
+end
+  
 begin
-  Rack::StaticBuilder.new(opts).build!
+  status = Rack::StaticBuilder.new(opts).build!
+  Kernel.exit( status ? 0 : 1 )
 rescue ArgumentError
-  $stderr.puts "rackstatic: must be run within a rack-compatible application directory"
+  $stderr.puts "rackstatic: must be run within or above a rack-compatible application directory"
   Kernel.exit 1
 end

data/lib/rack/static-builder.rb

@@ -6,7 +6,7 @@ require 'rack/test'
 require 'nokogiri'
 
 class Rack::StaticBuilder
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 
 
   class RequestPathQueue
@@ -19,8 +19,11 @@ class Rack::StaticBuilder
     def enqueue(url)
       path = URI.parse(url).path
 
+      # discard URNs like data: and magnet:
+      return false unless path
+
       if path[0] != '/'
-        path = (@active || '/').sub(/\/[^\/]*$/, '') + '/' + path
+        path = URI.parse( (@active || '/').sub(/\/[^\/]*$/, '') + '/' + path ).path
       end
 
       @queue << path
@@ -40,7 +43,7 @@ class Rack::StaticBuilder
     raise ArgumentError unless @app_dir
 
     @app_dir = Pathname.new(@app_dir).expand_path.cleanpath
-    @dest_dir = Pathname.new(opts.delete(:dest_dir) || 'build').expand_path.cleanpath
+    @dest_dir = Pathname.new(opts.delete(:dest_dir) || 'dist').expand_path.cleanpath
     @app_static_dir = (@app_dir + (opts.delete(:static_dir) || 'public')).expand_path.cleanpath
 
     @noisy = opts.delete(:noisy)
@@ -53,6 +56,8 @@ class Rack::StaticBuilder
 
     enqueue_static_assets(queue)
 
+    counts = {true => 0, false => 0}
+
     with_rack_client do |client|
 
       queue.drain do |req_path|
@@ -61,6 +66,7 @@ class Rack::StaticBuilder
         if @noisy
           channel = (resp.status == 200) ? $stdout : $stderr
           channel.puts("#{resp.status} #{req_path}")
+          counts[(resp.status == 200)] += 1
         end
 
         next unless resp.status == 200
@@ -72,6 +78,12 @@ class Rack::StaticBuilder
       end
 
     end
+
+    if @noisy and counts[false] > 0
+      $stderr.puts "\nFAILED: #{ counts[false] } requests returned non-200 and were discarded"
+    end
+
+    (counts[false] > 0)
   end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rackstatic
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sean Keith McAuley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2013-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack