render-react 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22ce4866889dc01d43ca995ae1e3e37a32998597
-  data.tar.gz: aac9d3480e383e37d89b70bff5fea4e47c44e710
+  metadata.gz: 0601736fa6ccfc71f59c1b6b4917615d23ad10ce
+  data.tar.gz: c424e643224f08d78117d85ba5b1f6a9b3b5cd8c
 SHA512:
-  metadata.gz: ddd52e5d4ac7f09c2b814666a9f8bbe464b7d8329c098c8cf3a51b29da3ec22ddf46b2855726bb47f399a2a19aa68e5b243cd7ff4552c1c2285972edcda4b99d
-  data.tar.gz: 361771ec138830c5df3c84cf63b9160bb3fdf795b63a7271fce2e20e9e9a08ec3f1f82b2a2db37e69d0089aae777407c55828ef5d36280deb9cec8eacad59cd6
+  metadata.gz: f7fb9e86dd55826c6984beb8ee247450d6d4c8e50c03d732a589d3537f806bb2c4ac3eef0c3604e5613f2660f7c21308606edf2eaab88720ea5ea8235cf9f81c
+  data.tar.gz: 7257db251438a7b46d1913dc145aa0aed6e1361fb5dd48cb0313a543ac4b9dfecbc092bf8732670f39c4978fb3d8b8508a3116cdc1b948895c808e95ab74a1e2

data/README.md

@@ -1,41 +1,75 @@
-# Render::React
+### Work in progress, please beware.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/render/react`. To experiment with that code, run `bin/console` for an interactive prompt.
+## Overview
+This gem renders [React](https://facebook.github.io/react/) components into your views!
 
-TODO: Delete this and the text above, and describe your gem
+It's plain Ruby so you can use it with almost every Ruby framework out there.
 
-## Installation
+## Design
+It uses [V8 engine](https://developers.google.com/v8/) as dynamic library for JavaScript execution. On application load React components are discovered, compiled from ES6 to ES5 and executed into memory. When you call `render_react` from your view - rendering is done from preloaded components at speeds comparable to native Ruby partials.
 
-Add this line to your application's Gemfile:
+## Installation
+Just add render-react to your Gemfile and you're done.
+```bash
+echo 'gem render-react' >> Gemfile
+bundle install
+```
 
+## Usage (Rails)
+1. Include Render::React into your ApplicationHelper
 ```ruby
-gem 'render-react'
+module ApplicationHelper
+  include Render::React
+  ...
 ```
 
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install render-react
-
-## Usage
+2. Create initializer config/initializers/render_react.rb
+```ruby
+Render::React::Config.path File.join(Rails.root, 'app/assets/javascripts/components-local')
+Render::React::Config.path File.join(Rails.root, 'some/other/directory')
+```
+or
+```ruby
+Render::React::Config.path(
+  File.join(Rails.root, 'app/assets/javascripts/components-other'),
+  File.join(Rails.root, 'some/other/directory')
+)
+```
 
-TODO: Write usage instructions here
+3. Render react component into your view (e.g. slim):
+```ruby
+== render_react 'Card', \
+  className: 'city-block swiper-slide', \
+  href: city_path(city.slug), \
+  text: city.location, \
+  name: city.name, \
+  cover: image_path(city.cover.square_thumb), \
+  count: city.compilations.length
+```
 
-## Development
+## Debugging
+To be sure that everything is tip-top.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+In terms of rendering time:
+```ruby
+- start = Time.now
+== render_react 'ComponentName', \
+  className: 'city-block swiper-slide', \
+  ...
+- finish = Time.now
+- Rails.logger.warn "Render::React durability: #{Render::React::Compiler.instance_variable_get(:@durability)} time: #{finish - start}"
+```
 
-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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+In terms of memory.
+```bash
+ps x -o rss,command  | grep "unicorn" | grep -v grep | sort
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/render-react. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/rambler-digital-solutions/render-react. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/render/react/version.rb

@@ -1,5 +1,5 @@
 module Render
   module React
-    VERSION = '0.0.5'.freeze
+    VERSION = '0.0.6'.freeze
   end
 end

data/render-react.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Alexander Krasnoschekov"]
   spec.email         = ["akrasnoschekov@gmail.com"]
 
-  spec.summary       = "Gem that renders react components into views"
-  spec.homepage      = "https://gitlab.rambler.ru/rnd/render-react"
+  spec.summary       = "Renders React.js components into your Ruby views"
+  spec.homepage      = "https://github.com/rambler-digital-solutions/render-react"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: render-react
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Alexander Krasnoschekov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-08-30 00:00:00.000000000 Z
+date: 2016-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: therubyracer
@@ -107,7 +107,7 @@ files:
 - lib/render/react/transpiler.rb
 - lib/render/react/version.rb
 - render-react.gemspec
-homepage: https://gitlab.rambler.ru/rnd/render-react
+homepage: https://github.com/rambler-digital-solutions/render-react
 licenses:
 - MIT
 metadata: {}
@@ -130,5 +130,5 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Gem that renders react components into views
+summary: Renders React.js components into your Ruby views
 test_files: []