phrender 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 092133a20cb9d29d3b2a8867224a38851c3dd891
-  data.tar.gz: 0a2f321d07614c3e4e744419c1df287d93588772
+  metadata.gz: ed3ad1d4b44735e82d185bca486adb853fb15fba
+  data.tar.gz: 1f37c26795b0cacf96926f1a3ebae75f41b15f4b
 SHA512:
-  metadata.gz: d4d79647ef74036f80da6c17ea500fea90893da54989e90146947180a3f2a40231a0c38e4b75c6160f8841ae38d9ee714cc8feea1f138b3ac1c89225e5b7154e
-  data.tar.gz: 33e1fa532034a483a3a7e3342c41a66be0b12008be3be5a7fba43e0e4a8fb7002d0072f99b664812bb1b16f81e9e949db4f83ddef99744a1de5341c24419025d
+  metadata.gz: 9b1dbdae233a0fb2754378696a7757beee1c2ee197cc5aa5a0dac36be76be5b867d9649688c24c23f84b80dbf9a1ea269dc7b113085c1b0fd09459721c65b7ee
+  data.tar.gz: 42bbbaac4dd4aedae6504f5c972b02794dab825a368e00ec8b88accb65a6cc667dbb87ed2ac29ca9fcbde96c341d34a16ad0b96f9f71602272695ba5861da262

data/README.md

@@ -22,8 +22,8 @@ Then install PhantomJS:
 
 ## Usage
 
-*NOTE*: Ember users, there is a driver for ember. See the [Ember Driver](#Ember
-Driver) section.
+*NOTE*: Ember users, there is a driver for ember. See the [Ember Driver](#ember-driver)
+section.
 
 ### For completely static javascript sites:
 
@@ -32,23 +32,33 @@ In your rackup file:
 ```ruby
 require 'phrender'
 
-# Available options are timeout, which gets passed on to PhantomJS. The asset
-# root should reflect where your app is stored, as well as all images, fonts,
-# css, and other assets.
-phrender = Phrender::RackStatic.new("asset_root", options)
+# The asset root should reflect where your app is stored, as well as all images,
+# fonts, css, and other static files.
+asset_root = "./"
 
 # The index file should link to no javascript on its own, or include any script
 # tags.
-phrender.index_file 'phrender.html'
+index_file = 'phrender.html'
 
 # This is the main application. It may or may not also start up the app.
-phrender.add_javascript_file '/assets/application.js'
+javascript_files = [ '/assets/application.js' ]
 
 # This is just raw javascript. Typically the app boot code.
-phrender.add_javascript "MyApp.boot()"
+javascript = [ "MyApp.boot()" ]
+
+# Javascript files and raw javascript get concatenated. Files first, then raw
+# code in array order. This code is then run against the index file using
+# PhantomJS
 
 # Rackup!
-run phrender.rack_app
+run Phrender::RackStatic.new({
+  :asset_root => asset_root,
+  :index_file => index_file,
+  :javascript_files => javascript_files,
+  :javascript => javascript
+})
+# Additionally, you map pass the option :timeout, which gets passed on to
+# PhantomJS.
 ```
 
 ### For partially dynamic javascript sites:
@@ -63,23 +73,27 @@ In your rackup file:
 require 'phrender'
 require 'my_rack_app'
 
-# This is what you provide
-app = MyRackApp.new
-
-# Available options are timeout and ssl, if, for some reason, your rack app is
+# These options are the same as above, but instead of referencing actual files,
+# the paths are the request paths to send to the upstream application server.
+index_file = 'phrender.html'
+javascript_files = [ '/assets/application.js' ]
+javascript = [ "MyApp.boot()" ]
+
+use Phrender::RackMiddleware, {
+  :index_file => index_file,
+  :javascript_files => javascript_files,
+  :javascript => javascript
+}
+# Additional options are timeout and ssl, if, for some reason, your rack app is
 # serving up SSL encrypted pages. Run `phantomjs --help` to see available
 # options, or use something falsey to disable. Both options are passed to
 # phantom.
-phrender = Phrender::RackMiddleware.new(app, options)
 
-# These options are the same as above, but instead of referencing actual files,
-# the paths are the request paths to send to the upstream application server.
-phrender.index_file 'phrender.html'
-phrender.add_javascript_file '/assets/application.js'
-phrender.add_javascript "MyApp.boot()"
+# Include other middlewarn
+use Rack::Static, :urls => "/assets", :root => "./assets"
 
 # Rackup!
-run phrender.rack_app
+run MyRackApp.new
 ```
 
 ## Signalling Render Completion

data/lib/phrender/ember_driver.rb

@@ -1,4 +1,4 @@
 class Phrender
   EMBER_DRIVER = File.read(
-    File.expand_path('../phrender/support/ember_driver.js', __FILE__))
+    File.expand_path('../support/ember_driver.js', __FILE__))
 end

data/lib/phrender/phantom_js_engine.rb

@@ -3,6 +3,7 @@ require 'phrender/phantom_js_session'
 
 require 'open3'
 require 'multi_json'
+require 'tempfile'
 
 class Phrender::PhantomJSEngine
 
@@ -28,8 +29,17 @@ class Phrender::PhantomJSEngine
   end
 
   def render(html, javascript, url = nil)
-    command = app_cmd(html, javascript, url)
-    session = Phrender::PhantomJSSession.new command, @timeout
+    javascript_file = make_temp_file(javascript, 'file.js')
+    html_file = make_temp_file(html, 'file.html')
+    program_options = { :html => html_file.path,
+                        :javascript => javascript_file.path,
+                        :url => url,
+                        :timeout => @timeout * 1000.0 }
+
+    session = Phrender::PhantomJSSession.new @boot_cmd.join(' '), @timeout
+
+    session.stdin.puts MultiJson.dump(program_options)
+    session.stdin.close
 
     begin
       sleep @poll_interval
@@ -39,6 +49,10 @@ class Phrender::PhantomJSEngine
     # Clean up phantom
     session.shutdown
 
+    # Clean up temp files
+    javascript_file.unlink
+    html_file.unlink
+
     # Feed something out the chain
     if session.rendered
       session.page
@@ -51,17 +65,15 @@ class Phrender::PhantomJSEngine
     end
   end
 
-  def app_cmd(html, javascript, url)
-    program_options = { :html => html,
-                        :javascript => javascript,
-                        :url => url,
-                        :timeout => @timeout }
-    encoded_options = MultiJson.dump(MultiJson.dump(program_options))
-    "%s %s" % [ @boot_cmd.join(' '), encoded_options ]
-  end
-
   protected
 
+  def make_temp_file(data, name)
+    file = Tempfile.new(name)
+    file.write(data)
+    file.close
+    file
+  end
+
   def parse_output(session)
     output = session.stdout.gets
     begin

data/lib/phrender/phantom_js_session.rb

@@ -18,9 +18,12 @@ class Phrender::PhantomJSSession
   end
 
   def shutdown
-    @stdin.close
-    @stdout.close
-    @stderr.close
+    [ @stdin, @stdout, @stderr ].each do |pipe|
+      begin
+        pipe.close
+      rescue IOError
+      end
+    end
     begin
       Process.kill("TERM", @wait_thr.pid)
     rescue Errno::ESRCH

data/lib/phrender/rack_middleware.rb

@@ -1,41 +1,49 @@
 require 'phrender/phantom_js_engine'
-require 'phrender/rack_base'
 
 require 'rack'
 
-class Phrender::RackMiddleware < Phrender::RackBase
-  def initialize(backend, opts = {})
+class Phrender::RackMiddleware
+  def initialize(app, opts = {})
+    @app = app
+    @index_file = opts[:index_file]
+    @javascript_paths = opts[:javascript_files]
+    @raw_javascript = opts[:javascript].join(';')
     @phantom = Phrender::PhantomJSEngine.new(opts)
-    @backend = backend
-    super
   end
 
-  def rack_app
-    backend = @backend
-    @app ||= Rack::Builder.new do
-      use Proxy
-      run backend
+  def call(env)
+    status, headers, body = @app.call(env)
+    if (status == 404 || headers['Content-Type'] == 'text/html')
+      if (env['HTTP_USER_AGENT'].match(/PhantomJS/))
+        [ 500, { 'Content-Type'  => 'text/html' }, [
+        'Server Error: HTML file contains recursive lookup' ] ]
+      else
+        body = render(env['REQUEST_URI'])
+        [ 200, { 'Content-Type'  => 'text/html' }, [ body ] ]
+      end
+    else
+      [ status, headers, body ]
     end
   end
 
-  def render(path, app)
-    program = load_js(app)
-    html = load_html(app)
-    @phantom.render(html, program)
-  end
-
   protected
 
-  def load_html(app)
+  def render(request_uri)
+    program = load_js
+    html = load_html
+    @phantom.render(html, program, request_uri)
+  end
+
+  def load_html
     req = Rack::MockRequest.env_for('',
       'PATH_INFO' => @index_file,
       'REQUEST_METHOD' => 'GET'
     )
-    status, headers, body = app.call(req)
-    body
+    status, headers, body = @app.call(req)
+    parse_body body
   end
 
-  def load_js(app)
+  def load_js
     js_from_files = @javascript_paths.map do |path|
       if path == :ember_driver
         Phrender::EMBER_DRIVER
@@ -44,12 +52,22 @@ class Phrender::RackMiddleware < Phrender::RackBase
           'PATH_INFO' => path,
           'REQUEST_METHOD' => 'GET'
         )
-        status, headers, body = app.call(req)
-        body
+        status, headers, body = @app.call(req)
+        parse_body body
       end
     end.join(';')
     program = js_from_files + @raw_javascript
-    program
+    program.to_s
+  end
+
+  def parse_body(body)
+    if body.respond_to? :each
+      data = ''
+      body.each{ |part| data << part }
+      data
+    else
+      body.to_s
+    end
   end
 
 end

data/lib/phrender/rack_static.rb

@@ -1,45 +1,12 @@
 require 'phrender/phantom_js_engine'
-require 'phrender/rack_base'
+require 'phrender/rack_middleware'
 
 require 'rack'
 
-class Phrender::RackStatic < Phrender::RackBase
-  def initialize(root_directory, opts = {})
-    @phantom = Phrender::PhantomJSEngine.new(opts)
-    @root_directory = root_directory
-    super
+class Phrender::RackStatic < Phrender::RackMiddleware
+  def initialize(opts = {})
+    asset_root = opts.delete :asset_root
+    app = Rack::File.new(asset_root)
+    super(app, opts)
   end
-
-  def rack_app
-    static_directory = @root_directory
-    @app ||= Rack::Builder.new do
-      use Proxy
-      run Rack::File.new(static_directory)
-    end
-  end
-
-  def render(path, app)
-    program = load_js(app)
-    html = load_html(app)
-    @phantom.render(html, program)
-  end
-
-  protected
-
-  def load_html(app)
-    File.read File.join(@root_directory, @index_file)
-  end
-
-  def load_js(app)
-    js_from_files = @javascript_paths.map do |path|
-      if path == :ember_driver
-        Phrender::EMBER_DRIVER
-      else
-        File.read File.join(@root_directory, path)
-      end
-    end.join(';')
-    program = js_from_files + @raw_javascript
-    program
-  end
-
 end

data/lib/phrender/support/ember_driver.js

@@ -13,4 +13,3 @@ Ember.Route = Ember.Route.extend({
         this._super.apply(this, arguments);
     }
 });
-

data/lib/phrender/support/phantom_bridge.js

@@ -6,13 +6,13 @@ var system = require('system'),
 var stdout = system.stdout;
 
 // global opts
-var options = JSON.parse(system.args[system.args.length - 1]),
+var options = JSON.parse(fs.read("/dev/stdin")),
     globals = {
         "page": null,
         "timer": null,
         "expired": false,
         "rendered": false,
-        "html": options.html
+        "html": fs.read(options.html)
     };
 
 // functions
@@ -61,8 +61,9 @@ printPage = function(url) {
     // Log javascript console messages
     globals.page.onConsoleMessage = function(msg) {
         if (msg.trim() === "-- PHRENDER COMPLETE --"){
+            logMessage('phrender complete');
             globals.rendered = true;
-        } else {
+        } else if (!msg.match(/^\[✓\].+/)) {
             logMessage(msg);
         }
     };
@@ -70,9 +71,7 @@ printPage = function(url) {
     // capture errors
     globals.page.onError = logError;
 
-    globals.page.evaluate(function(code) {
-        eval(code);
-    }, options.javascript);
+    globals.page.injectJs(options.javascript);
 
     // Catch something
     globals.timer = setTimeout(writeHtml, options.timeout);

data/lib/phrender/version.rb

@@ -1,3 +1,3 @@
 class Phrender
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/phrender.rb

@@ -1,8 +1,8 @@
 require "phrender/version"
 require "phrender/logger"
+require "phrender/ember_driver"
 require "phrender/phantom_js_engine"
 require "phrender/phantom_js_session"
-require "phrender/rack_base"
 require "phrender/rack_middleware"
 require "phrender/rack_static"
 

data/spec/phrender/phantom_js_engine_spec.rb

@@ -14,16 +14,6 @@ describe 'Phrender::PhantomJSEngine' do
     File.read(File.expand_path('../phantom_js_engine/app.js', __FILE__))
   }
 
-  it 'generates a startup command with escaped json' do
-    command = phantom.app_cmd(index, app, 'http://localhost')
-    expect(command).to match(
-      /phantomjs (.+?)phrender\/lib\/phrender\/support\/phantom_bridge.js/
-    )
-    expect(command).to include("--ignore-ssl-errors=true")
-    expect(command).to include("<html>")
-    expect(command).to include("use strict")
-  end
-
   it 'renders a simple page' do
     whitespace_regex = /(\n|^ +)/
     html = <<-HTML.strip_heredoc.gsub(whitespace_regex, '')

data/spec/phrender/rack_middleware_spec.rb

@@ -10,11 +10,19 @@ describe 'Phrender::RackMiddleware' do
     b
   }
   let(:app) {
-    p = Phrender::RackMiddleware.new(backend)
-    p.index_file = 'phrender.html'
-    p.add_javascript_file 'app.js'
-    p.add_javascript 'App.run'
-    p.rack_app
+    _backend = backend # Needed because builder changes the block's context
+    Rack::Builder.new do
+      use Phrender::RackMiddleware, {
+        :index_file => 'phrender.html',
+        :javascript_files => [
+          'app.js'
+        ],
+        :javascript => [
+          "App.run()"
+        ]
+      }
+      run _backend
+    end
   }
 
   it 'runs the app contained in the referenced assets' do

data/spec/phrender/rack_static_spec.rb

@@ -4,11 +4,16 @@ require 'phrender/rack_static'
 describe 'Phrender::RackStatic' do
   let(:root) { File.expand_path '../rack_static', __FILE__ }
   let(:app) {
-    p = Phrender::RackStatic.new(root)
-    p.index_file = 'phrender.html'
-    p.add_javascript_file 'app.js'
-    p.add_javascript 'App.run'
-    p.rack_app
+    Phrender::RackStatic.new({
+      :asset_root => root,
+      :index_file => 'phrender.html',
+      :javascript_files => [
+        'app.js'
+      ],
+      :javascript => [
+        "App.run()"
+      ]
+    })
   }
 
   it 'runs the app contained in the referenced assets' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: phrender
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - M Smart, theScore Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-23 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -153,7 +153,6 @@ files:
 - lib/phrender/logger.rb
 - lib/phrender/phantom_js_engine.rb
 - lib/phrender/phantom_js_session.rb
-- lib/phrender/rack_base.rb
 - lib/phrender/rack_middleware.rb
 - lib/phrender/rack_static.rb
 - lib/phrender/support/ember_driver.js

data/lib/phrender/rack_base.rb

@@ -1,50 +0,0 @@
-class Phrender::RackBase
-  class Proxy
-    class << self
-      attr_accessor :host
-    end
-
-    def initialize(app)
-      @app = app
-    end
-
-    def call(env)
-      self.class.host.call(env, @app)
-    end
-  end
-
-  attr_accessor :index_file
-
-  def initialize(*args)
-    @javascript_paths = []
-    @raw_javascript = ''
-    Proxy.host = self
-  end
-
-  def rack_app
-    raise NotImplementedError
-  end
-
-  def render(path, app)
-    raise NotImplementedError
-  end
-
-  def call(env, app)
-    status, headers, body = app.call(env)
-    if status == 404
-      body = render(env['PATH_INFO'], app)
-      [ 200, { 'Content-Type'  => 'text/html' }, body ]
-    else
-      [ status, headers, body ]
-    end
-  end
-
-  def add_javascript_file(path)
-    @javascript_paths.push path
-  end
-
-  def add_javascript(code)
-    @raw_javascript << ';' + code
-  end
-
-end