react-sinatra 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ff3f7ac7e65e474e927285731ff48c025090e88
+  data.tar.gz: f9539bf7704022157a4b16210bb61add72e281a2
+SHA512:
+  metadata.gz: f361c16cef519f84addbdff5d049de26b08a6f55407971c9ec615e18b506d9a94a458bfb2816ca11fa30e06f26ef29be6b932f364810f59863b660a3eb715fe7
+  data.tar.gz: be72c4dfef7dabce8f939038c4a357d1a8e4cee7d037bd3cabe2289464a764e1eedd78c4ffc17383a62d5d3adab0c074ee0a8d6cad88ea974e82fa830efc7dcf

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: required
+dist: trusty
+language: ruby
+addons:
+  apt:
+    sources:
+      - ubuntu-toolchain-r-test
+    packages:
+      - g++-4.8
+rvm:
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+before_install: gem install bundler -v 1.13.6

data/.yardopts

@@ -0,0 +1,4 @@
+--exclude lib/react/sinatra/templates/
+-
+lib/**/*.rb
+lib/react/sinatra/runtime.rb

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+gem 'test-unit'
+gem 'mocha'
+gem 'rack-test'
+
+gem 'mini_racer'
+gem 'execjs'
+
+gem 'yard'
+
+# Specify your gem's dependencies in react-sinatra.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 namusyaka
+
+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/README.md

@@ -0,0 +1,147 @@
+# react-sinatra
+
+[![Build Status](https://travis-ci.org/namusyaka/react-sinatra.svg?branch=master)](https://travis-ci.org/namusyaka/react-sinatra)
+
+`react-sinatra` makes it easy to use React in your Sinatra and Padrino application.
+
+Please see [a sample](https://github.com/namusyaka/react-sinatra-sample).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'react-sinatra'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install react-sinatra
+
+## Anti-Features
+
+`react-sinatra` does not:
+
+- transform `.jsx` files or JSX syntax.
+- transpile asset using babel.
+- support asset-pipeline.
+- have generator for registering this extension.
+
+I think those features should be solved by using [webpack](https://webpack.github.io/), or other build tools.
+
+## Usage
+
+### Sinatra Plug-in
+
+It's easy to register `react-sinatra` in your application, next section will describe three steps for introduction.
+
+#### 1. Add react-sinatra and runtime into your Gemfile
+
+```ruby
+source 'https://rubygems.org'
+
+gem 'react-sinatra'
+gem 'execjs'
+gem 'mini_racer' # also `therubyracer` may be available, but mini_racer is simpler and faster.
+```
+
+#### 2. Register react-sinatra and configure.
+
+```ruby
+class App < Sinatra::Base
+  register React::Sinatra
+
+  configure do
+    React::Sinatra.configure do |config|
+      # configures for bundled React.js
+      config.use_bundled_react = true
+      config.env = ENV['RACK_ENV'] || :development
+      config.addon = true
+
+      # The asset should be able to be compiled by your server side runtime.
+      # react-sinatra does not transform jsx into js, also ES2015 may not be worked through.
+      config.asset_path = File.join('client', 'dist', 'server.js')
+      config.runtime = :execjs
+    end
+  end
+end
+```
+
+#### 3. Use `react_component` on your view or sinatra application.
+
+```erb
+<%= react_component('Hello', { name: 'namusyaka' }, prerender: true) %>
+```
+
+```ruby
+get '/:name' do |name|
+  component = react_component('Hello', { name: name }, prerender: true)
+  # ...
+end
+```
+
+The react component **must** be able to be referred from global scope, so you should be careful for your asset javascript.
+In the above example, you need to provide an asset that puts the component called `Hello` in a state that it can be referred to from the global.
+
+```javascript
+class Hello extends React.Component {
+  render() {
+    return (
+      <div className="hello">
+        Hello, {this.props.name}!
+      </div>
+    );
+  }
+}
+
+global.Hello = Hello;
+```
+
+### React.js
+
+#### Bundled React.js
+
+You can use bundled React.js by specifying configurations.
+
+```ruby
+React::Sinatra.configure do |config|
+  config.use_bundled_react = true # Defaults to false
+end
+```
+
+You can also specify `addon` and `env` for each environments.
+
+```ruby
+React::Sinatra.configure do |config|
+  config.addon = false # Defaults to false
+  config.env = ENV['RACK_ENV'] || :development
+end
+```
+
+#### Note
+
+**If you want to use your own react, you must include React.js and react-server source code in the asset.**
+
+```ruby
+React::Sinatra.configure do |config|
+  config.asset_path = 'client/dist/*.js'
+end
+```
+
+### TODO
+
+- Support nodejs as a runtime
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/namusyaka/react-sinatra.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.warning = false
+  test.test_files = Dir['test/**/test_*.rb']
+end
+
+task default: :test

data/lib/react-sinatra.rb

@@ -0,0 +1 @@
+require 'react/sinatra'

data/lib/react/sinatra.rb

@@ -0,0 +1,32 @@
+module React
+  # Namespace for the react-sinatra library.
+  #
+  # This module is a Sinatra extension and is used with the `register` keyword.
+  module Sinatra
+    # Method for the `register` keyword hook on your application.
+    # @param [Sinatra::Base] app
+    def self.registered(app)
+      app.helpers Helpers
+    end
+
+    # Configures react-sinatra by using {React::Sinatra::Configuration}.
+    # @see [React::Sinatra::Configuration]
+    # @yieldparam [React::Sinatra::Configuration]
+    def self.configure
+      yield config
+    end
+
+    # Returns configuration instance using Singleton module.
+    # @see [React::Sinatra::Configuration]
+    # @return [React::Sinatra::Configuration]
+    def self.config
+      Configuration.instance
+    end
+  end
+end
+
+require 'react/sinatra/version'
+require 'react/sinatra/configuration'
+require 'react/sinatra/helpers'
+require 'react/sinatra/template'
+require 'react/sinatra/runtime'

data/lib/react/sinatra/component.rb

@@ -0,0 +1,97 @@
+require 'json'
+require 'padrino-helpers'
+require 'active_support/core_ext/hash/reverse_merge'
+require 'active_support/core_ext/string/inflections'
+require 'react/sinatra/pool'
+
+module React
+  module Sinatra
+    # Class for expressing react component.
+    #
+    # This is main entrypoint for rendering react component
+    #   and is referred from {React::Sinatra::Helpers#react_component}.
+    class Component
+      include Padrino::Helpers::OutputHelpers
+      include Padrino::Helpers::TagHelpers
+
+      attr_reader :component, :props, :prerender
+
+      # Renders react component from given arguments.
+      #
+      # @example
+      #   React::Sinatra::Component.render('Hello', { name: 'namusyaka' }, prerender: true)
+      #
+      # @param [String] component The name for component must be able to be referred from asset javascript.
+      # @param [Hash] props The props for rendering react-dom
+      # @param [TrueClass, FalseClass] prerender Whether server side rendering is enabled or not.
+      # @param [TrueClass, FalseClass] camelize_props Whether camelization is enabled or not.
+      # @param [String, Symbol] tag The tag name for rendering react root element. Defaults to :div
+      #
+      # @raise [React::Sinatra::RuntimeError] Raised if server side rendering is enabled and failed
+      # @return [ActiveSupport::SafeBuffer] safe string for rendering in application views
+      def self.render(component, props, prerender: false, **options)
+        new(component, prerender: prerender).render(props, **options)
+      end
+
+      # Camelizes props for enabling {camelize_props} option.
+      #
+      # @param [Hash] props The props for rendering react-dom
+      # @return [Hash] camelized props
+      def self.camelize_props(props)
+        case props
+        when Hash
+          props.each_with_object({}) do |(key, value), new_props|
+            new_key = key.to_s.camelize(:lower)
+            new_value = camelize_props(value)
+            new_props[new_key] = new_value
+          end
+        when Array
+          props.map(&method(:camelize_props))
+        else
+          props
+        end
+      end
+
+      # Constructs an instance of React::Sinatra::Component.
+      #
+      # @param [String] component The name for component must be able to be referred from asset javascript
+      # @param [TrueClass, FalseClass] prerender Whether server side rendering is enabled or not.
+      # @return [React::Sinatra::Component]
+      def initialize(component, prerender: false, **options)
+        @component = component
+        @prerender = prerender
+      end
+
+      # Renders react component from given arguments and component.
+      #
+      # @param [Hash] props The props for rendering react-dom
+      # @param [TrueClass, FalseClass] camelize_props Whether camelization is enabled or not
+      # @param [String, Symbol] tag The tag name for rendering react root element. Defaults to :div
+      # @see https://github.com/padrino/padrino-framework/blob/master/padrino-helpers/lib/padrino-helpers/tag_helpers.rb#L119
+      # @return [ActiveSupport::SafeBuffer] safe string for rendering in application views
+      def render(props, camelize_props: false, tag: :div, **options, &block)
+        props = self.class.camelize_props(props) if camelize_props
+        block = -> {
+          concat React::Sinatra::Pool.render(component, props.to_json)
+        } if prerender?
+
+        options.reverse_merge!(data: {})
+        options[:data].tap do |data|
+          data[:react_class] = component
+          data[:react_props] = props.is_a?(String) ? props : props.to_json
+        end unless prerender == :static
+
+        content_tag(tag, '', options, &block)
+      end
+
+      # Returns true if the :prerender option is enabled.
+      #
+      # @return [TrueClass, FalseClass]
+      def prerender?
+        !! prerender
+      end
+
+      private :prerender?
+    end
+  end
+end

data/lib/react/sinatra/configuration.rb

@@ -0,0 +1,39 @@
+require 'react/sinatra/runtime'
+require 'singleton'
+
+module React
+  module Sinatra
+    # Class for expressing configuration delegated from classes.
+    #
+    # This #instance entrypoint is referred from application.
+    class Configuration
+      include Singleton
+
+      attr_accessor :pool_size, :pool_timeout, :asset_path, :use_bundled_react, :env, :addon
+
+      # Assigns runtime by given name.
+      #
+      # @param [String, Symbol] name The name of runtime
+      # @see React::Sinatra::Runtime.[]
+      # @return [React::Sinatra::Runtime::RuntimeBased]
+      def runtime=(name)
+        @runtime = Runtime[name.to_sym]
+      end
+
+      # Returns current runtime.
+      # @return [React::Sinatra::Runtime::RuntimeBased]
+      def runtime
+        @runtime
+      end
+
+      # Assigns default values for use in server-side rendering.
+      instance.pool_size    = 5
+      instance.pool_timeout = 10
+      instance.runtime      = :execjs
+
+      instance.use_bundled_react = false
+      instance.env = ENV['RACK_ENV'] || :development
+      instance.addon = false
+    end
+  end
+end

data/lib/react/sinatra/error.rb

@@ -0,0 +1,11 @@
+module React
+  module Sinatra
+    class RuntimeError < ::RuntimeError
+      def initialize(component, props, message:, **options)
+        message = ["Encountered error \"#{message}\" when prerendering #{component} with #{props}",
+          message.backtrace.join(?\n)].join(?\n)
+        super(message)
+      end
+    end
+  end
+end

data/lib/react/sinatra/helpers.rb

@@ -0,0 +1,18 @@
+require 'react/sinatra/component'
+
+module React
+  module Sinatra
+    # Module for registering Sinatra application.
+    #
+    # This is main entrypoint for integration on Sinatra.
+    module Helpers
+      # Renders react component from given arguments.
+      #
+      # @see {React::Sinatra::Component.render}
+      # @return [ActiveSupport::SafeBuffer] safe string for rendering in application views
+      def react_component(*args)
+        React::Sinatra::Component.render(*args)
+      end
+    end
+  end
+end

data/lib/react/sinatra/pool.rb

@@ -0,0 +1,80 @@
+require 'forwardable'
+
+module React
+  module Sinatra
+    # Class for expressing connection pool.
+    #
+    # @example
+    #   pool = React::Sinatra::Pool.new
+    #   pool.render('Hello', { name: 'bob' }, prerender: true)
+    #   pool.reset
+    #
+    # @!visibility private
+    class Pool
+      # Utility for runtime renderer
+      #
+      # @see {#render}
+      # @!visibility private
+      def self.render(*args, **options)
+        pool.render(*args, **options)
+      end
+
+      # Returns an instance of React::Sinatra::Pool as a singleton.
+      #
+      # @return [React::Sinatra::Pool]
+      # @!visibility private
+      def self.pool
+        @pool ||= Pool.new
+      end
+
+      extend Forwardable
+      instance_delegate %i[pool_size pool_timeout runtime] => 'React::Sinatra.config'
+
+      # Detects runtime from pool, and its runtime
+      # renders react component by using server side runtime.
+      #
+      # @see React::Sinatra::Runtime::RuntimeBased#render
+      # @!visibility private
+      def render(*args, **options)
+        pool.with { |runtime| runtime.render(*args, **options) }
+      end
+
+      # Resets current connection pool.
+      #
+      # @!visibility private
+      def reset
+        @pool = nil
+        pool
+      end
+
+      # Returns an instance of ConnectionPool.
+      #
+      # @see https://github.com/mperham/connection_pool
+      # @return [Connectionpool]
+      # @!visibility private
+      def pool
+        @pool ||= ConnectionPool.new(size: size, timeout: timeout) { runtime.new }
+      end
+
+      # Returns the globally set pool size or default pool size.
+      #
+      # @see React::Sinatra::Configuration#pool_size
+      # @return [Integer]
+      # @!visibility private
+      def size
+        pool_size || 5
+      end
+
+      # Returns the globally set pool timeout or default pool timeout.
+      #
+      # @see React::Sinatra::Configuration#pool_timeout
+      # @return [Integer]
+      # @!visibility private
+      def timeout
+        pool_timeout || 10
+      end
+
+      private :pool, :size, :timeout
+    end
+  end
+end