execjs-rails 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15aa169f6282f399f6ecb0e811d6837ce70173ed
-  data.tar.gz: a783a4e814d655b2b58ac73ba1bd0e12f55be5dc
+  metadata.gz: 20b99d427d6dd48dcb8e08bd8e9fbbd055adb87c
+  data.tar.gz: a207fbce620184b1280d37530ace7ead33361a1d
 SHA512:
-  metadata.gz: 8199aa2b6d3a26cb15008b19c961213bc5a4d09e7d9c7dce27c3f1b70706a0b3e3dc0c1f552a5d9aa5f20ad7e2dbccbf21925c0f4ceb82df098bd68f9f2efb4d
-  data.tar.gz: 70cde193cefcd7664b397cca6de3dbd4e5276cdd9c4d58b4103b448141179d8bc2f9209ca0c8b60375970dae166df46e59e6f18877399882375d43abff79fd42
+  metadata.gz: 218addd8d037f808de2dfd41ac491dbe6f40541b65dc52fb797760c20d7f77a312c582421f99b758d5439d16949fda86a8bc330f0b4dc13f2f919920532999c6
+  data.tar.gz: 77ad4ced87fb69cebc8842ed06846fc131ed9b3f314f869076e1a2b2b31c8dbe182874823a88c38d32ea8beb7c6f7aabf66fa9354f9e0caec0eafa4a4ed6c933

data/README.md

@@ -0,0 +1,24 @@
+execjs-rails
+============
+
+# JavaScript-based rendering in Rails
+
+## WARNING: Early release. There will be many changes
+
+## How to use it:
+
+Include `execjs-rails` in your Gemfile.
+
+Create a file named `app/assets/javascripts/server.js` which contains the following:
+```javascript
+function execjs_rails_handler(path, opts) {
+  // `path` looks like "users/show"
+  // `opts` is a data object passed in from Rails
+}
+```
+
+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.
+
+Read the source for configuration options and more info.

data/lib/assets/javascripts/server.js

@@ -0,0 +1,15 @@
+function execjs_rails_handler(path, opts) {
+  var json = JSON.stringify(opts, null, "  ");
+  var code = "execjs_rails_handler('"+path+"', "+json+");"
+  return "" +
+    "<h1>Hello, I'm execjs-rails!</h1>" +
+    "<h2>There are many ways to configure me.</h2>" +
+    "<p>Provide your own <code>server.js</code>.</p>" +
+    "<p>Or create an initializer to set<br><code>config.execjs_rails.server_javascripts = ['my_javascript.js']</code>.</p>" +
+    "<p>By default, the template handler and helper call the JavaScript function <code>execjs_rails_handler</code>.</p>" +
+    "<p>You can override the function name with<br><code>config.execjs_rails.handler_function_name = 'my_handler'</code></p>" +
+    "<p>This is the exact JavaScript code being called to generate this page:</p>" +
+    "<p><pre><code>"+code+"</code></pre></p>" +
+    "<p>For more configuration options, see <code>execjs-rails/lib/execjs/rails/engine.rb</code></p>" +
+    "";
+}

data/lib/execjs/rails/concern.rb

@@ -0,0 +1,17 @@
+module ExecJS
+  module Rails
+    module Concern
+      extend ActiveSupport::Concern
+      included do
+
+        append_view_path TemplateResolver.new
+        append_before_filter :reset_execjs_renderer
+
+        def reset_execjs_renderer
+          Renderer.reset!
+        end
+        
+      end
+    end
+  end
+end

data/lib/execjs/rails/engine.rb

@@ -0,0 +1,44 @@
+module ExecJS
+  module Rails
+    class Engine < ::Rails::Engine
+
+      config.execjs_rails = ActiveSupport::OrderedOptions.new
+      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.handler_function_name = 'execjs_rails_handler'
+
+      config.execjs_rails.view_to_function_options = lambda do |view, options|
+        view.assigns.stringify_keys.merge!({
+          controller: view.controller_name,
+          action: view.action_name,
+          csrf_token: view.form_authenticity_token || nil,
+          current_user: view.current_user || nil
+        }).merge!(options.stringify_keys).as_json
+      end
+
+      initializer "execjs_rails.setup_view_helpers" do
+        ActiveSupport.on_load(:action_view) do
+          include ViewHelper
+        end
+      end
+
+      initializer "execjs_rails.setup_controller_concern" do
+        ActiveSupport.on_load(:action_controller) do
+          include Concern
+        end
+      end
+
+      config.after_initialize do |app|
+        app.config.execjs_rails.build_source ||= lambda do
+          app.config.execjs_rails.server_javascripts.map do |filename|
+            app.assets.resolve(filename)
+            app.assets[filename].to_s
+          end.join(";")
+        end
+        Renderer.setup!(app.config.execjs_rails)
+      end
+
+    end
+  end
+end

data/lib/execjs/rails/renderer.rb

@@ -0,0 +1,39 @@
+module ExecJS
+  module Rails
+    module Renderer
+
+      @@config = nil
+      @@context = nil
+
+      def self.setup!(config = {})
+        @@config = config
+        self.reset!
+      end
+
+      def self.config
+        @@config
+      end
+
+      def self.reset!
+        unless @@config.memoize_context? && !@@context.nil?
+          begin
+            @@context = ExecJS.compile(@@config.build_source.call())
+          rescue V8::Error => error
+            @@config.on_error.call(error)
+          end
+        end
+      end
+
+      def self.call(function, *args)
+        @@context.call(function, *args)
+      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?
+        output.html_safe
+      end
+
+    end
+  end
+end

data/lib/execjs/rails/template_resolver.rb

@@ -0,0 +1,20 @@
+module ExecJS
+  module Rails
+    class TemplateResolver < ::ActionView::Resolver
+
+      def find_templates(name, prefix, partial, details)
+        path = "#{prefix}/#{name}"
+        [::ActionView::Template.new(
+          "<%= execjs_render('#{path}') %>",
+          "ExecJS - #{path}",
+          ActionView::Template.registered_template_handler(:erb),
+          {
+            format: Mime[:erb],
+            virtual_path: path
+          }
+        )]
+      end
+
+    end
+  end
+end

data/lib/execjs/rails/version.rb

@@ -0,0 +1,5 @@
+module ExecJS
+  module Rails
+    VERSION = '0.0.6'
+  end
+end

data/lib/execjs/rails/view_helper.rb

@@ -0,0 +1,15 @@
+module ExecJS
+  module Rails
+    module ViewHelper
+
+      def execjs_call(function, *args)
+        Renderer.call(function, *args)
+      end
+
+      def execjs_render(path, opts = {})
+        Renderer.render(path, Renderer.config.view_to_function_options.call(self, opts))
+      end
+
+    end
+  end
+end

data/lib/execjs/rails.rb

@@ -0,0 +1,5 @@
+require 'execjs/rails/engine'
+require 'execjs/rails/renderer'
+require 'execjs/rails/view_helper'
+require 'execjs/rails/concern'
+require 'execjs/rails/template_resolver'

data/lib/execjs-rails.rb

@@ -0,0 +1 @@
+require 'execjs/rails'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: execjs-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Revelry Labs, LLC
@@ -44,7 +44,17 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/assets/javascripts/server.js
+- lib/execjs/rails/concern.rb
+- lib/execjs/rails/engine.rb
+- lib/execjs/rails/renderer.rb
+- lib/execjs/rails/template_resolver.rb
+- lib/execjs/rails/version.rb
+- lib/execjs/rails/view_helper.rb
+- lib/execjs/rails.rb
+- lib/execjs-rails.rb
+- README.md
 homepage: https://github.com/revelrylabs/execjs-rails
 licenses:
 - MIT