diff --git a/contrib/react-rails/Gemfile b/contrib/react-rails/Gemfile new file mode 100644 index 00000000000..d65e2a66952 --- /dev/null +++ b/contrib/react-rails/Gemfile @@ -0,0 +1,3 @@ +source 'http://rubygems.org' + +gemspec diff --git a/contrib/react-rails/LICENSE b/contrib/react-rails/LICENSE new file mode 100644 index 00000000000..261eeb9e9f8 --- /dev/null +++ b/contrib/react-rails/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/contrib/react-rails/README.md b/contrib/react-rails/README.md new file mode 100644 index 00000000000..b9eb9733451 --- /dev/null +++ b/contrib/react-rails/README.md @@ -0,0 +1,72 @@ +# React-Rails + +React/JSX adapter for the Ruby on Rails asset pipeline. + +## Installation + +React-Rails has only been tested with versions of Rails using `Gemfile`s. Use otherwise at your own risk. + +Add the following to your `Gemfile` and be sure to `bundle install` after. We suggest only adding the dependency to the `:assets` group so that if you precompile your assets, you aren't requiring extra gems unnecessarily. + +```ruby +# Gemfile +group :assets do + gem 'react-rails' +end +``` + + +## Usage + +### JSX + +To transform your JSX into JS, simply create `.jsx.js` files, and ensure that the file has the `/** @jsx React.DOM */` docblock. + + +### React + +Since we don't put `react.js` into `assets/javascript`, you must explicitly include it. There are 2 ways to do this. + +You can `require` it in your manifest: + +```js +// app/assets/application.js + +//= require react +``` + +Or you can include it explicitly as a separate script tag: + +```erb +// app/views/layouts/application.erb.html +<%= javascript_include_tag "react" %> +``` + + + + +## Configuring + +There are 2 variants available. `:development` gives you the unminified version of React. This provides extra debugging and error prevention. `:production` gives you the minified version of React which strips out comments and helpful warnings, and minifies. + +```ruby +# config/environments/development.rb +MyApp::Application.configure do + config.react.variant = :development +end + +# config/environments/production.rb +MyApp::Application.configure do + config.react.variant = :production +end +``` + + +## TODO + +* [ ] Write tests +* [ ] Ajax requests? +* [ ] `somefile.jsx.erb.js`? +* [ ] Consider removing the config entirely. +* [ ] Do what jquery-rails is doing to intercept loads, instead of tmp dir magic +* [ ] Build sample app diff --git a/contrib/react-rails/VERSION b/contrib/react-rails/VERSION new file mode 100644 index 00000000000..267577d47e4 --- /dev/null +++ b/contrib/react-rails/VERSION @@ -0,0 +1 @@ +0.4.1 diff --git a/contrib/react-rails/lib/react-rails.rb b/contrib/react-rails/lib/react-rails.rb new file mode 100644 index 00000000000..35928b4ebc0 --- /dev/null +++ b/contrib/react-rails/lib/react-rails.rb @@ -0,0 +1,3 @@ +require 'react/jsx' +require 'react/rails' + diff --git a/contrib/react-rails/lib/react/jsx.rb b/contrib/react-rails/lib/react/jsx.rb new file mode 100644 index 00000000000..5560d8fc4e3 --- /dev/null +++ b/contrib/react-rails/lib/react/jsx.rb @@ -0,0 +1,17 @@ +require 'react/source' +require 'react/jsx/template' + +module React + module JSX + def self.context + # TODO: create React::Source::contents_for + contents = File.read(React::Source.bundled_path_for('JSXTransformer.js')) + @context ||= ExecJS.compile(contents) + end + + def self.transform(code) + result = context.call('JSXTransformer.transform', code) + return result['code'] + end + end +end diff --git a/contrib/react-rails/lib/react/jsx/template.rb b/contrib/react-rails/lib/react/jsx/template.rb new file mode 100644 index 00000000000..ac454ae59c5 --- /dev/null +++ b/contrib/react-rails/lib/react/jsx/template.rb @@ -0,0 +1,18 @@ +require 'sprockets' +require 'sprockets/engines' + +module React + module JSX + + class Template < Tilt::Template + self.default_mime_type = 'application/javascript' + + def prepare + end + + def evaluate(scopre, locals, &block) + @output ||= JSX::transform(data) + end + end + end +end diff --git a/contrib/react-rails/lib/react/rails.rb b/contrib/react-rails/lib/react/rails.rb new file mode 100644 index 00000000000..53973dea2c7 --- /dev/null +++ b/contrib/react-rails/lib/react/rails.rb @@ -0,0 +1,2 @@ +require 'react/rails/railstie' +require 'react/rails/engine' diff --git a/contrib/react-rails/lib/react/rails/engine.rb b/contrib/react-rails/lib/react/rails/engine.rb new file mode 100644 index 00000000000..8ac21fa0704 --- /dev/null +++ b/contrib/react-rails/lib/react/rails/engine.rb @@ -0,0 +1,15 @@ +require 'sprockets' +require 'sprockets/engines' +# require 'react/jsx/template' + +module React + module Rails + class Engine < ::Rails::Engine + config.before_initialize do |app| + # force autoloading? what? + Sprockets::Engines + Sprockets.register_engine '.jsx', React::JSX::Template + end + end + end +end diff --git a/contrib/react-rails/lib/react/rails/railstie.rb b/contrib/react-rails/lib/react/rails/railstie.rb new file mode 100644 index 00000000000..fd28c8068f9 --- /dev/null +++ b/contrib/react-rails/lib/react/rails/railstie.rb @@ -0,0 +1,33 @@ +require 'rails' + +module React + module Rails + class Railtie < ::Rails::Railtie + config.react = ActiveSupport::OrderedOptions.new + + initializer "react_rails.setup_vendor" do |app| + variant = app.config.react.variant + + # Mimic behavior of ember-rails... + # We want to include different files in dev/prod. The unminified builds + # contain console logging for invariants and logging to help catch + # common mistakes. These are all stripped out in the minified build. + if variant = app.config.react.variant || ::Rails.env.test? + variant ||= :development + # Copy over the variant into a path that sprockets will pick up. + # We'll always copy to 'react.js' so that no includes need to change. + # We'll also always copy of JSXTransformer.js + tmp_path = app.root.join('tmp/react-rails') + filename = 'react' + (variant == :production ? '.min.js' : '.js') + FileUtils.mkdir_p(tmp_path) + FileUtils.cp(::React::Source.bundled_path_for(filename), + tmp_path.join('react.js')) + FileUtils.cp(::React::Source.bundled_path_for('JSXTransformer.js'), + tmp_path.join('JSXTransformer.js')) + # Make sure it can be found + app.assets.append_path(tmp_path) + end + end + end + end +end diff --git a/contrib/react-rails/lib/react/rails/version.rb b/contrib/react-rails/lib/react/rails/version.rb new file mode 100644 index 00000000000..cb3d9dad473 --- /dev/null +++ b/contrib/react-rails/lib/react/rails/version.rb @@ -0,0 +1,8 @@ +module React + module Rails + # Version numbers will track react-source, but we'll add another level so + # that we can increment, but have some amount of stability. + VERSION = '0.4.1.0' + end +end + diff --git a/contrib/react-rails/react-rails.gemspec b/contrib/react-rails/react-rails.gemspec new file mode 100644 index 00000000000..693d36bb72d --- /dev/null +++ b/contrib/react-rails/react-rails.gemspec @@ -0,0 +1,27 @@ +# encoding: utf-8 + +$:.push File.expand_path('../lib', __FILE__) +require 'react/rails/version' + +Gem::Specification.new do |s| + s.name = 'react-rails' + s.version = React::Rails::VERSION + s.summary = 'React/JSX adapter for the Ruby on Rails asset pipeline.' + s.description = 'Compile your JSX on demand or precompile for production.' + s.homepage = 'https://github.com/facebook/react-rails' + s.license = 'APL 2.0' + + s.author = ['Paul O’Shannessy'] + s.email = ['paul@oshannessy.com'] + + s.add_dependency 'execjs' + s.add_dependency 'railties', '>= 3.1' + s.add_dependency 'react-source', '0.4.1' + + s.files = Dir[ + 'lib/**/*', + 'README.md' + ] + + s.require_paths = ['lib'] +end