initial release

Author: pboling

.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.2
+before_install: gem install bundler -v 1.10.4

Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in react-rails-benchmark_renderer.gemspec
+gemspec

README.md

@@ -0,0 +1,69 @@
+# React::Rails::BenchmarkRenderer
+
+This idea started with a PR I sent to actual react-rails before it hit 1.0 release.  I didn't have time to finish it then,
+and the structure of the react-rails codebase changed considerably, so it is now quite easy to write a renderer as a plugin.
+
+This gem is a plugin to ract-rails providing two things:
+
+1. `React::ServerRendering::Concern::Instrumentation`
+  - benchmarking instrumentation of the sort found in rails view rendering
+  - can be included into any Renderer to add Benchmarking to it
+2. `React::ServerRendering::BenchmarkRenderer`
+  - a reference implementation of `React::ServerRendering::Concern::Instrumentation`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'react-rails-benchmark_renderer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install react-rails-benchmark_renderer
+
+## Usage
+
+To simply use the reference implementation, just edit your application.rb with:
+
+```
+    config.react.server_renderer = React::ServerRendering::BenchmarkRenderer
+```
+
+To roll your own renderer:
+
+Use `Concern::Implementation` to enhance any React ServerRendering Renderer with benchmarking.  
+
+Usage is just like you can see in the reference implementation:
+
+```ruby
+require "react/server_rendering/concerns/instrumentation"
+# Extends SprocketsRenderer for benchmarking in the Rails environment
+# - benchmarks rendering in the same manner as Rails view rendering is benchmarked by Rails
+module React
+  module ServerRendering
+    class BenchmarkRenderer < SprocketsRenderer
+      include Concerns::Instrumentation
+    end
+  end
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/react-rails-benchmark_renderer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "react/rails/benchmark_renderer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

lib/react-rails-benchmark_renderer.rb

@@ -0,0 +1 @@
+require "react/rails/benchmark_renderer"

lib/react/rails/benchmark_renderer.rb

@@ -0,0 +1,3 @@
+require "react/rails/benchmark_renderer/version"
+require "react/server_rendering/concerns/instrumentation"
+require "react/server_rendering/benchmark_renderer"

lib/react/rails/benchmark_renderer/version.rb

@@ -0,0 +1,7 @@
+module React
+  module Rails
+    module BenchmarkRenderer
+      VERSION = "0.1.0"
+    end
+  end
+end

lib/react/server_rendering/benchmark_renderer.rb

@@ -0,0 +1,11 @@
+require "react/server_rendering/concerns/instrumentation"
+
+# Extends SprocketsRenderer for benchmarking in the Rails environment
+# - benchmarks rendering in the same manner as Rails view rendering is benchmarked by Rails
+module React
+  module ServerRendering
+    class BenchmarkRenderer < SprocketsRenderer
+      include Concerns::Instrumentation
+    end
+  end
+end

lib/react/server_rendering/concerns/instrumentation.rb

@@ -0,0 +1,40 @@
+module React
+  module ServerRendering
+    module Concerns
+      module Instrumentation
+        extend ActiveSupport::Concern
+
+        attr_internal :view_runtime
+
+        included do
+          prepend RenderWithBenchmark
+        end
+
+        module RenderWithBenchmark
+          # Ripped mostly from actionpack/lib/action_controller/metal/instrumentation.rb
+          def render(*args)
+            render_output = nil
+            self.view_runtime = cleanup_view_runtime do
+              Benchmark.ms { render_output = super }
+            end
+            ::Rails.logger.info("#{self.class}#render(#{args.join(", ")} in %.1fms" % view_runtime.to_f)
+            render_output
+          end
+
+          # Ripped directly from actionpack/lib/action_controller/metal/instrumentation.rb
+          # A hook which allows you to clean up any time taken into account in
+          # views wrongly, like database querying time.
+          #
+          #   def cleanup_view_runtime
+          #     super - time_taken_in_something_expensive
+          #   end
+          #
+          # :api: plugin
+          def cleanup_view_runtime #:nodoc:
+            yield
+          end
+        end
+      end
+    end
+  end
+end

react-rails-benchmark_renderer.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'react/rails/benchmark_renderer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "react-rails-benchmark_renderer"
+  spec.version       = React::Rails::BenchmarkRenderer::VERSION
+  spec.authors       = ["Peter Boling"]
+  spec.email         = ["[email protected]"]
+
+  spec.summary       = %q{Concern::Instrumentation Plugin for React::Rails Render Benchmarking with a reference implementation}
+  spec.description   = %q{Concern::Instrumentation Plugin for React::Rails Render Benchmarking with a reference implementation}
+  spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 3.2"
+  spec.add_dependency "react-rails", ">= 1.0"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

spec/react/rails/benchmark_renderer_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe React::Rails::BenchmarkRenderer do
+  it 'has a version number' do
+    expect(React::Rails::BenchmarkRenderer::VERSION).not_to be nil
+  end
+
+  it 'does something useful' do
+    expect(false).to eq(true)
+  end
+end

spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'react/rails/benchmark_renderer'