Skip to content
Concern::Instrumentation Plugin for React::Rails Render Benchmarking with a reference implementation
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
spec
.gitignore
.rspec
.travis.yml
CODE_OF_CONDUCT.md
Gemfile
LICENSE.txt
README.md
Rakefile
react-rails-benchmark_renderer.gemspec

README.md

React::Rails::BenchmarkRenderer

This gem is a plugin to react-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
  1. React::ServerRendering::BenchmarkRenderer
  • a reference implementation of React::ServerRendering::Concern::Instrumentation
Project React::Rails::BenchmarkRenderer
gem name react-rails-benchmark_renderer
license MIT
expert support Get help on Codementor
download rank Total Downloads
version Gem Version
dependencies Dependency Status
code quality Code Climate
inline documenation Inline docs
continuous integration Build Status
test coverage Coverage Status
homepage on Github.com
documentation on Rdoc.info
live chat Join the chat at https://gitter.im/pboling/react-rails-benchmark_renderer
Spread ♡ⓛⓞⓥⓔ♡ on Coderbits, on Coderwall

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 has changed considerably in latest master, so it is now quite easy to write a renderer as a plugin. Rewriting it as a modular plugin also allowed me to

  • Not be beholden to the Apache 2 license on react-rails
  • Not be beholden to the Facebook CLA
  • Own the code myself!
  • Kudos to Facebook for making react-rails more modular so I could easily write this plugin!

Installation

Add this line to your application's Gemfile:

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:

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.

Maintenance

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.

Versioning

This library aims to adhere to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions.

As a result of this policy, you can (and should) specify a dependency on this gem using the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency 'react-rails-benchmark_renderer', '~> 0.0'

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. Make sure to add tests!
  6. Create a new Pull Request

Contributors

See the Network View

You can’t perform that action at this time.