execjs-rails 0.0.6.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7b3e545fec27d1e7906a4caa437b281dc5baa428
-  data.tar.gz: ddc613d20daefde8cf884e39363b0a080d8619b8
+  metadata.gz: bd08829f22d695edb626c57dd61c2f92ffdbf3e4
+  data.tar.gz: d3a747916c9e43939397b58f7793cbcdf4075c66
 SHA512:
-  metadata.gz: 818b63cf094c9f67d8c5a870d109b34c3d8c76c8daa4673b9109f56d85a22f41bda77cd0287200636136fbba8fcf61003a507f6511c85239c559f8f0fed66a24
-  data.tar.gz: 267e16e2129de9fdb041af3c0a88d057081cd5d1abfc0afab4a7762c9d922865c6a7afe890b42e1661142cb8e2fa69c9ff04e0695043a489fbf9488e268a9cef
+  metadata.gz: 4e022025803f228d07f54d092e149fe95029de065bc71d10e1370c50d472a5c830ccec37020a3c052d593b1b7ce3051f11bb0e1ec85bdce4beb785f7eda5a00b
+  data.tar.gz: c2d089814b88cba3536d68c7e804fb1a1032ddfa34b337babbeb9cf76f265340a7c5c388c0b3a5e4bc091c00c3a79d88270c99ac26aca5c0c610d8d5d78e5a18

data/README.md

@@ -3,22 +3,41 @@ execjs-rails
 
 # JavaScript-based rendering in Rails
 
-## WARNING: Early release. There will be many changes
+## Why render via JavaScript in Rails?
 
-## How to use it:
+There are some great JavaScript UI frameworks out there now. Writing most of your view layer in a JavaScript-based framework cuts down on a lot of repetition (and potential points of divergence) as opposed to having Rails output HTML one way and JavaScript output HTML another. Rendering JavaScript-based view code on the server preserves SEO and, if you care and you're diligent, backward compatibility with older browsers.
 
-Include `execjs-rails` in your Gemfile.
+## Why ExecJS Rails?
 
-Create a file named `app/assets/javascripts/server.js` which contains the following:
+ExecJS Rails has very few opinions. It's designed to get its opinions from your JavaScript code.
+
+It was originally written out of some frustration with `react-rails`, which bakes in a lot of opinions we don't share. Should a server-side JavaScript context have a global `window` object? We thought "no", and `react-rails` at some point decided "yes" and broke some of our conditional checks. It also didn't have any hooks to override what it injects into the server-side JavaScript context. So we thought what would really be nice is to have an underpinning rendering library that doesn't care if you use React or something else and is largely opinion-free.
+
+This view engine has one philosophy: Let JavaScript do it. Out of the box, it's configured to look for two JavaScript functions in your asset bundle: One to ask your JavaScript if it has a view for a given path, and another to actually return a rendered string. It's up to you to write JS code that will look up and render JS-based views. It's up to you how you want to build your JS bundle to accomplish that task. Or better yet, it's up to you to build a more opinionated framework on top of ExecJS Rails. Which is really what it's here for.
+
+## Quickstart Guide:
+
+Include `execjs-rails` in your Gemfile, and create a file named `app/assets/javascripts/server.js` which contains the following:
 ```javascript
+// This function will tell Rails whether or not ExecJS Rails has a view for this path.
+function execjs_rails_has_view(path) {
+  // `path` looks like "users/show"
+  return false; // Do something smarter that will return `true` once in a while.
+}
+
+// This function will render a view for the given path.
 function execjs_rails_handler(path, opts) {
   // `path` looks like "users/show"
-  // `opts` is a data object passed in from Rails
+  // `opts` is a data object passed in from Rails view assigns
+  return "Hello, World!"; // Do something smarter that returns HTML or something.
 }
 ```
+Then you have:
+* A Rails view helper, `execjs_render`, that will render output from your `execjs_rails_handler` JavaScript function.
+* A Rails template handler that will do the same. You can write your controller code the exact same way as if you were using ERB. If no ERB view exists, it will use `execjs_rails_has_view` to determine whether or not ExecJS Rails can handle the view. If so, it will render via `execjs_rails_handler`.
+
+That's pretty much it.
 
-Combine this approach with some fancy JavaScript UI frameworks and some smarty pants
-asset bundles, and you'll have shared client and server views for extra DRYness
-without sacrificing SEO.
+## Advanced Usage:
 
-Read the source for configuration options and more info.
+For now, just read the source for configuration options and more info. You can override a lot of the default behavior.

data/lib/assets/javascripts/server.js

@@ -1,3 +1,7 @@
+function execjs_rails_has_view(path) {
+  return false;
+}
+
 function execjs_rails_handler(path, opts) {
   var json = JSON.stringify(opts, null, "  ");
   var code = "execjs_rails_handler('"+path+"', "+json+");"

data/lib/execjs/rails/engine.rb

@@ -6,6 +6,7 @@ module ExecJS
       config.execjs_rails.memoize_context = ::Rails.env.production?
       config.execjs_rails.on_error = lambda { |error| raise error }
       config.execjs_rails.server_javascripts = ['server.js']
+      config.execjs_rails.has_view_function_name = 'execjs_rails_has_view'
       config.execjs_rails.handler_function_name = 'execjs_rails_handler'
 
       config.execjs_rails.view_to_function_options = lambda do |view, options|

data/lib/execjs/rails/renderer.rb

@@ -28,6 +28,10 @@ module ExecJS
         @@context.call(function, *args)
       end
 
+      def self.has_view(path)
+        @@context.call(@@config.has_view_function_name, path)
+      end
+
       def self.render(path, opts = {})
         output = self.call(@@config.handler_function_name, path, opts)
         fail "ExecJS call to render function `#{function}` returned null" if output.nil?

data/lib/execjs/rails/template_resolver.rb

@@ -3,8 +3,8 @@ module ExecJS
     class TemplateResolver < ::ActionView::Resolver
 
       def find_templates(name, prefix, partial, details)
-        if details[:formats].include?(:html)
-          path = "#{prefix}/#{name}"
+        path = "#{prefix}/#{name}"
+        if details[:formats].include?(:html) && Renderer.has_view(path)
           [::ActionView::Template.new(
             "<%= execjs_render('#{path}') %>",
             "ExecJS - #{path}",

data/lib/execjs/rails/version.rb

@@ -1,5 +1,5 @@
 module ExecJS
   module Rails
-    VERSION = '0.0.6.1'
+    VERSION = '0.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: execjs-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.6.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Revelry Labs, LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-25 00:00:00.000000000 Z
+date: 2014-12-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs