rails_render_service 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5de96b404daed0a944ff3eadf8d00f2ec73f52c3
+  data.tar.gz: 6d3663f4a9ba101423cb182224f47b5737a4c59d
+SHA512:
+  metadata.gz: e7eb4d7d02b8575d96ee0b139f1253fe4c9b3ea52e08749e3e7a22d48f9a61a6188abf416cfb8d0b933796a449596fb59135ffea8f9bb8d1df4224754ad6ad4e
+  data.tar.gz: 531e0426c3dab9ba428c4094f19251d5ce58347b8a754120c9ae560254ed08172d9c24d4ca809722bbfe2735f04a2a1d332d06b1f0eba80f8f8146660aee0160

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Revelry Labs, LLC
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RailsRenderService'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/rails_render_service.rb

@@ -0,0 +1,6 @@
+require "rails_render_service/engine"
+require "rails_render_service/renderer"
+require "rails_render_service/renderer_patch"
+require "rails_render_service/view_helper"
+require "rails_render_service/template_resolver"
+require "rails_render_service/concern"

data/lib/rails_render_service/concern.rb

@@ -0,0 +1,8 @@
+module RailsRenderService
+  module Concern
+    extend ActiveSupport::Concern
+    included do
+      prepend_view_path TemplateResolver.new
+    end
+  end
+end

data/lib/rails_render_service/engine.rb

@@ -0,0 +1,23 @@
+require 'action_controller'
+require 'action_controller/metal/renderers'
+
+module RailsRenderService
+  class Engine < ::Rails::Engine
+
+    config.rails_render_service = ActiveSupport::OrderedOptions.new
+
+    config.rails_render_service.get_uri = lambda do
+      "unix://#{Rails.root.join 'sockets', 'http.sock'}"
+    end
+
+    # initializer 'rails_render_service.start' do
+    #   Renderer.start
+    # end
+
+    initializer 'rails_render_service.setup_view_helpers' do
+      ActiveSupport.on_load(:action_view) do
+        include ViewHelper
+      end
+    end
+  end
+end

data/lib/rails_render_service/renderer.rb

@@ -0,0 +1,63 @@
+require 'net_http_unix'
+
+module RailsRenderService
+  class Renderer
+
+    # def self.start
+    #   pid = spawn("NODE_ENV=#{Rails.env} npm run #{Rails.env}")
+    #   trap('TERM') do
+    #     kill pid
+    #     shutdown()
+    #   end
+    # end
+
+    def self.server_uri
+      @@server_uri ||= Rails.application.config.rails_render_service.get_uri.call
+    end
+
+    def self.client
+      NetX::HTTPUnix.new server_uri
+    end
+
+    def self.with_retry(backoff_times = [0.2, 0.5, 1, 2, 3, 4, 5], &block)
+      begin
+        yield block
+      rescue Errno::ECONNREFUSED, Errno::ENOENT => e
+        raise e if backoff_times.empty?
+        backoff_time = backoff_times.shift
+        puts "Waiting for render service. Retry in #{backoff_time}s..."
+        sleep backoff_time
+        retry
+      end
+    end
+
+    def self.has_template(key)
+      with_retry do
+        req = Net::HTTP::Get.new "/#{key}"
+        res = client.request req
+        case res.code
+        when '200' then true
+        when '404' then false
+        else
+          puts res.body
+          raise "Attempt to find `#{key}` resulted in an error response from the rendering service"
+        end
+      end
+    end
+
+    def self.render_template(json)
+      with_retry do
+        req = Net::HTTP::Post.new "/", initheader = {'Content-Type'=>'application/json'}
+        req.body = json
+        res = client.request req
+        case res.code
+        when '200' then res.body
+        when '404' then raise "Missing React template for `#{JSON.parse(req.body)['name']}`"
+        else
+          puts res.body
+          raise "Attempt to render `#{JSON.parse(req.body)['name']}` resulted in an error response from the rendering service"
+        end
+      end
+    end
+  end
+end

data/lib/rails_render_service/renderer_patch.rb

@@ -0,0 +1,22 @@
+module RailsRenderService
+  class RendererPatch < Rails::Railtie
+    initializer 'rails_render_service.add_virtual_path_to_renderer' do
+      ::ActionView::TemplateRenderer.class_eval do
+        def render(context, options)
+          @view    = context
+          @details = extract_details(options)
+          template = determine_template(options)
+
+          prepend_formats(template.formats)
+
+          @lookup_context.rendered_format ||= (template.formats.first || formats.first)
+
+          locals = (options[:locals] || {}).reverse_merge(
+            virtual_path: template.virtual_path,
+          )
+          render_template(template, options[:layout], locals)
+        end
+      end
+    end
+  end
+end

data/lib/rails_render_service/template_resolver.rb

@@ -0,0 +1,21 @@
+module RailsRenderService
+  class TemplateResolver < ::ActionView::Resolver
+    # See `https://github.com/rails/rails/issues/23243` re: `throwaway_flag`
+    def find_templates(name, prefix, partial, details, throwaway_flag=false)
+      path = "#{prefix}/#{name}"
+      if details[:formats].include?(:html) && Renderer.has_template(path)
+        [::ActionView::Template.new(
+          "<%= render_service('#{path}') %>",
+          "Revelry - #{path}",
+          ActionView::Template.registered_template_handler(:erb),
+          {
+            format: Mime[:erb],
+            virtual_path: path
+          }
+        )]
+      else
+        []
+      end
+    end
+  end
+end

data/lib/rails_render_service/version.rb

@@ -0,0 +1,3 @@
+module RailsRenderService
+  VERSION = "0.0.1"
+end

data/lib/rails_render_service/view_helper.rb

@@ -0,0 +1,16 @@
+module RailsRenderService
+  module ViewHelper
+    def current_layout
+      layout = controller.send(:_layout)
+      if layout.instance_of? String
+        layout
+      else
+        File.basename(layout.identifier).split('.').first
+      end
+    end
+    def render_service(path)
+      json = raw render(layout: "layouts/#{current_layout}", template: path, formats: :json)
+      Renderer.render_template(json).html_safe
+    end
+  end
+end

data/lib/tasks/rails_render_service_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rails_render_service do
+#   # Task goes here
+# end

data/test/controllers/widgets_controller_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+# module RenderService
+class WidgetsControllerTest < ActionController::TestCase
+  # setup do
+  #   @routes = Engine.routes
+  # end
+
+  test 'should render index' do
+    get :index
+    assert_response :success
+  end
+
+  test 'should render show' do
+    get :show, id: 1234
+    assert_response :success
+  end
+
+  test 'should raise `ActionView::MissingTemplate` for `new` action' do
+    assert_raises ActionView::MissingTemplate do
+      get :new
+    end
+  end
+
+end
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/widgets_controller.rb

@@ -0,0 +1,6 @@
+class WidgetsController < ApplicationController
+  include RailsRenderService::Concern
+  def index; end
+  def show; end
+  def new; end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,26 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "rails_render_service"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # Do not swallow errors in after_commit/after_rollback callbacks.
+    config.active_record.raise_in_transactional_callbacks = true
+  end
+end
+