tilt-react 0.1.0

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+- 2.3.0
+deploy:
+  provider: rubygems
+  api_key:
+  gem: tilt-react
+  on:
+    tags: true
+    repo: jphastings/tilt-react
+addons:
+  code_climate:
+    secure: "NLJ1KBW8QcBQLY2R8qYgr+M4MgaGr1NZFBBffPvsQf/fqHo+n26B+z42SoMQIUaGm40Y9fDB3FgloumG5GGCNsdQ+6mIec2948Fjh9BsBy8ZDdpOypcsX5cAtBwHAhOa1tUv/nOU1udMEExT9dFQ7FCae+Z/ivw2EvpgaZuOd5bDwZWvnPiDAybVwlwusTWOPxQhTR3OEd1y0WnXfoVtdT0ACdp6mLxzy7ERs8uEuoOBHq/Q4Ai807beseNtZs9H+2K4L48fi3u65/p7c9WpyzCUVeEpUXPBjLl43NzWXqC8Zj6sOL5gRzj4gV3y7a+NTBzDyOHEAqNvnNe83AHS38AMLidvbmnLWSf2GvKBHr9oSdiQzyBxiHVdZXgP/1FjrVu2JC7MAYVKz5va9Pri4Ey38qjdT1JrR+9meXCq9nTMyPVWxdiO6AysoXBG+7YaNqZjvvxpT60UfKc9pzYf+YxHNEgmYvK0AbjiY2A+wX7f5+mT/BgwKIr6LHSy136Y9IuduUKfuhsdeKn1LBD68ox6pmB24oz2XNJPJ2cLPgIARGMj55ZYg/3zrccaqa/sHBp/XvQ7r+MsR6gCZ7Kedfhevq7JimSsbN6FkNrzIPlzAMxOIQCuSLtwc52FVMMrznmihbN2TmWssdBvAyua5dkqlwqgOUYKDP69m3gI2Bc="

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 JP Hastings-Spital
+
+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,43 @@
+# Tilt::React
+
+Use react components as view templates in Sinatra and other frameworks using Tilt.
+
+Bonus feature: RSpec::React, a helpful framework for writing unit tests for the server generated HTML your components produce.
+
+This is proof-of-concept code, there are some limitations:
+
+* Only server-side rendering is supported at the moment
+* There's some hacky code around the place (search for FIXME)
+* There aren't any tests for the actual library…
+
+There's an example of using this library with Sinatra in the `examples` directory.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tilt-react'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tilt-react
+
+## 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/jphastings/tilt-react/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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "tilt/react"
+
+# 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.
+
+require "pry"
+Pry.start

data/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

data/examples/sinatra/.gitignore

@@ -0,0 +1,2 @@
+/node_modules/
+/public/js/components.js

data/examples/sinatra/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format progress

data/examples/sinatra/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'sinatra', '~> 1.4'
+gem 'capybara', '~> 2.6'
+gem 'rspec', '~> 3.4'
+gem 'rspec-its', '~> 1.2'
+gem 'rspec-as_fixture', '~> 0.1'
+gem 'tilt-react', path: '../..'

data/examples/sinatra/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: ../..
+  specs:
+    tilt-react (0.1.0)
+      babel-transpiler (~> 0.7)
+      commonjs (~> 0.2)
+      therubyracer (~> 0.12)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    babel-source (5.8.35)
+    babel-transpiler (0.7.0)
+      babel-source (>= 4.0, < 6)
+      execjs (~> 2.0)
+    capybara (2.6.2)
+      addressable
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      xpath (~> 2.0)
+    commonjs (0.2.7)
+    diff-lcs (1.2.5)
+    execjs (2.6.0)
+    libv8 (3.16.14.13)
+    mime-types (3.0)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0221)
+    mini_portile2 (2.0.0)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    rack (1.6.4)
+    rack-protection (1.5.3)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    ref (2.0.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-as_fixture (0.1.2)
+      rspec (~> 3.4)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    sinatra (1.4.7)
+      rack (~> 1.5)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    therubyracer (0.12.2)
+      libv8 (~> 3.16.14.0)
+      ref
+    tilt (2.0.2)
+    xpath (2.0.0)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara (~> 2.6)
+  rspec (~> 3.4)
+  rspec-as_fixture (~> 0.1)
+  rspec-its (~> 1.2)
+  sinatra (~> 1.4)
+  tilt-react!

data/examples/sinatra/README.md

@@ -0,0 +1,19 @@
+# An example Sinatra App
+
+This example app demonstrates how to use React Components as view templates in your sinatra app.
+
+## Go go gadget example app
+
+You'll need to download React in order to get this example to work. [Install NPM](https://docs.npmjs.com/getting-started/installing-node), install the npm dependencies, then run the app:
+
+```bash
+npm install
+rackup
+```
+You should be set! Try visiting http://127.0.0.1:9292/?name=world
+
+## Writing unit tests for your components
+
+There are also simple tests demonstrating how to write unit tests for the HTML your components produce.
+
+If you declare `type: :component` on the root `describe` block of your test suite, then that component is loaded, rendered with the `props` given, and the subject of the test becomes a Nokogiri HTML object, which allows easy assertion with `rspec-its` etc.

data/examples/sinatra/app.rb

@@ -0,0 +1,10 @@
+require 'sinatra/base'
+require 'sinatra/react'
+
+class ExampleApp < Sinatra::Base
+  register Sinatra::React
+
+  get '/' do
+    react :home_page, locals: { name: params['name'] || 'you' }
+  end
+end

data/examples/sinatra/components/home_page.jsx

@@ -0,0 +1,13 @@
+import React, { PropTypes } from 'react';
+
+class HomePage extends React.Component {
+  render() {
+    return (
+      <h1>Hello {this.props.name || 'you'}</h1>
+    );
+  }
+}
+
+HomePage.propTypes = { name: PropTypes.string };
+
+export default HomePage;

data/examples/sinatra/config.ru

@@ -0,0 +1,3 @@
+require File.join(__dir__, 'app.rb')
+
+run ExampleApp

data/examples/sinatra/package.json

@@ -0,0 +1,7 @@
+{
+  "dependencies": {
+    "fbjs": "^0.7",
+    "react": "^0.14",
+    "react-dom": "^0.14"
+  }
+}

data/examples/sinatra/spec/fixtures/home_page.yml

@@ -0,0 +1,3 @@
+- title: when addressing the world
+  props:
+    name: world

data/examples/sinatra/spec/home_page_spec.rb

@@ -0,0 +1,24 @@
+require 'rspec/its'
+require 'rspec/react'
+require 'rspec/as_fixture'
+
+RSpec.describe 'HomePage', type: :component do
+  context 'when addressing the world', :as_fixture do
+    its(:content) { should include('Hello world') }
+  end
+
+  context 'when no props are given' do
+    let(:props) { {} }
+
+    its(:content) { should include('Hello you') }
+  end
+
+  context 'when invalid props are sent' do
+    let(:props) { { name: -1 } }
+
+    # It would be nice if React's PropTypes worked in a way that meant
+    # I could capture props of incorrect types and raise errors for them
+    # but I haven't yet figured out how to do this.
+    xit { expect { rendered_component }.to raise_error(ArgumentError) }
+  end
+end

data/examples/sinatra/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec/as_fixture'
+require 'rspec/react'
+
+# This is the default, here only to be explicit
+RSpec::React.js_libs = ['node_modules']

data/examples/sinatra/views/layout.erb

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Tilt::React Example</title>
+  </head>
+  <body>
+    <%= yield %>
+    <script src="js/components.js"></script>
+  </body>
+</html>

data/ext/tilt-react.js

@@ -0,0 +1,12 @@
+React = require('react');
+DOMServer = require('react-dom/server');
+
+var tiltReact = {
+  render: function(componentName, props) {
+    var component = React.createFactory(tiltReact.components[componentName]);
+    return DOMServer.renderToString(component(props));
+  },
+  components: {}
+};
+
+module.exports = tiltReact;

data/lib/commonjs/require_string.rb

@@ -0,0 +1,12 @@
+module CommonJS
+  class Environment
+    def require_string(module_id, js)
+      raise "#{module_id} has already been loaded" if @modules[module_id]
+      load_js = "( function(module, require, exports) {\n#{js}\n} )"
+      load = @runtime.eval(load_js)
+      @modules[module_id] = mod = Module.new(module_id, self)
+      load.call(mod, mod.require_function, mod.exports)
+      mod.exports
+    end
+  end
+end

data/lib/rspec/react.rb

@@ -0,0 +1,5 @@
+require "rspec/react/component_helpers"
+
+RSpec.configure do |config|
+  config.include RSpec::React::ComponentHelpers, type: :component
+end

data/lib/rspec/react/component_helpers.rb

@@ -0,0 +1,65 @@
+require 'tilt/react'
+require 'capybara/rspec'
+
+module RSpec
+  module React
+    class << self
+      attr_writer :js_libs, :components
+
+      def js_libs
+        @js_libs || 'node_modules'
+      end
+
+      def components
+        @components || 'components'
+      end
+    end
+
+    module ComponentHelpers
+      def self.included(klass)
+        include Capybara::RSpecMatchers
+
+        Tilt::ReactTemplate.load_context(RSpec::React.js_libs)
+
+        klass.around do |example|
+          group = example.metadata[:example_group]
+          loop do
+            break if group[:parent_example_group].nil?
+            group = group[:parent_example_group]
+          end
+
+          component = group[:description]
+          snake_cased = component.gsub(/::/, '/').
+            gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+            gsub(/([a-z\d])([A-Z])/,'\1_\2').
+            tr("-", "_").
+            downcase
+          filename = File.expand_path("#{snake_cased}.jsx", RSpec::React.components)
+
+          Tilt::ReactTemplate.compile(filename)
+          @template = Tilt::ReactTemplate.new(filename)
+          
+          example.run
+        end
+
+        klass.subject(:rendered_component) { html_from_component(props) }
+      end
+
+      # Renders the component defined in the describe block using the given props blob.
+      #
+      # This returns a Nokogiri element, so you can do the following to make your tests clean:
+      #
+      #     let(:props) { { name: 'JP' } }
+      #     subject { html_from_component(props) }
+      #     its(:content) { should include('JP') }
+      #
+      # @return [Nokogiri::XML::Element] The (necessarily singular) root HTML element that the component returns as a parsed XML object
+      def html_from_component(props = {})
+        fragment = Nokogiri::HTML.fragment(@template.render(nil, props))
+
+        # React components can only ever have one top-level element, so we just return that
+        fragment.children.first
+      end
+    end
+  end
+end

data/lib/sinatra/react.rb

@@ -0,0 +1,47 @@
+require 'sinatra/base'
+require 'tilt/react'
+
+module Sinatra
+  module React
+    module Helpers
+      def react(*args)
+        render :jsx, *args
+      end
+
+      def find_template(views, name, engine, &block)
+        if engine == Tilt::ReactTemplate
+          views = settings.components
+        end
+        super(views, name, engine, &block)
+      end
+    end
+
+    def self.registered(app)
+      app.helpers(Helpers)
+      app.set :components, Proc.new { root && File.join(root, 'components') }
+      app.set :js_libs, Proc.new { root && File.join(root, 'node_modules') }
+      app.set :component_bundles, { '*.jsx' => 'js/components.js' }
+      app.set :jsx, layout_engine: :erb
+
+      app.configure do |config|
+        # FIXME: I don't like this following line. Apparently this block gets called
+        # multiple times, once without the settings above returning nil, and a second
+        # time with them being what they should be. Because this block configures the
+        # JS context calling it without js_libs means no libraries are loaded, so we
+        # must wait until js_libs has content. 
+        next unless config.settings.js_libs
+
+        Tilt::ReactTemplate.js_libs = config.settings.js_libs
+        Tilt::ReactTemplate.load_context
+        Tilt::ReactTemplate.compile_bundles(config.settings.component_bundles.map { |glob, bundle|
+          [
+            File.expand_path(glob, config.settings.components),
+            File.expand_path(bundle, config.settings.public_folder)
+          ]
+        })
+      end
+    end
+  end
+
+  register React
+end