Merge pull request #171 from reactrb/feature/react-source

New way to load reactjs sources

Author: zetachang

CHANGELOG.md

@@ -20,6 +20,14 @@ Whitespace conventions:
 
 ## [0.9.0] - Unreleased
 
+### Added
+
+- `react/react-source` is the suggested way to include ReactJS sources now. Simply require `react/react-source` immediately before the `require "reactrb"` in your Opal code will make it work.
+
+### Deprecated
+
+- `react-latest` & `react-v1x` is deprecated. Use `react/react-source` instead.
+
 ### Removed
 
 - `opal-browser` is removed from runtime dependency. (#133)

README.md

@@ -1,4 +1,4 @@
-# Reactrb / Reactive-Ruby 
+# Reactrb / Reactive-Ruby
 
 [![Join the chat at https://gitter.im/reactrb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/reactrb/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Build Status](https://travis-ci.org/reactrb/reactrb.svg?branch=master)](https://travis-ci.org/reactrb/reactrb)
@@ -72,13 +72,10 @@ It is very unlikely that there will be any more releases of the `reactive-ruby`
 There are no syntactic or semantic breaking changes between `reactrb` v 0.8.x and
 previous versions, however the `reactrb` gem does *not* include the react-js source as previous versions did.  This allows you to pick the react js source compatible with other gems and react js components you may be using.
 
-To upgrade, replace `reactive-ruby` with `reactrb`, both in your Gemfile, and in any `requires` in your code.   You will also need to require react-js as this is no longer included in the gem.  
+Follow these steps to upgrade:
 
-If you are using react-rails then simply find anyplace where you `require 'reactrb'` and immediately before this do a `require 'react'` which will load the compatible react js file.
-
-If you are using webpack then add `react` to your manifest.
-
-If you are not using react-rails then find where you `require 'reactrb'` and immediately before this do a `require 'react-latest'` (or 'react-v13', 'react-v14' or 'react-v15')
+1. Replace `reactive-ruby` with `reactrb` both in **Gemfile** and any `require`s in your code.
+2. To include the React.js source, the suggested way is to add `require 'react/react-source'` before `require 'reactrb'`. This will use the copy of React.js source from `react-rails` gem.
 
 # Roadmap
 

Rakefile

@@ -9,15 +9,9 @@ ENV['REAL_BUNDLE_GEMFILE'] = ENV['BUNDLE_GEMFILE']
 require 'rspec/core/rake_task'
 require 'opal/rspec/rake_task'
 
-begin
-  require "react-rails"
-rescue NameError
-end
-
 RSpec::Core::RakeTask.new('ruby:rspec')
 
 Opal::RSpec::RakeTask.new('opal:rspec') do |s, task|
-  s.append_path React::Rails::AssetVariant.new(addons: true).react_directory
   s.append_path 'spec/vendor'
   s.index_path = 'spec/index.html.erb'
   task.timeout = 80000 if task

config.ru

@@ -4,26 +4,19 @@ Bundler.require
 require "opal/rspec"
 require "opal-jquery"
 
-begin
-  require "react-rails"
-rescue NameError
-end
-
 if Opal::RSpec.const_defined?("SprocketsEnvironment")
   sprockets_env = Opal::RSpec::SprocketsEnvironment.new
   sprockets_env.cache = Sprockets::Cache::FileStore.new("tmp")
   sprockets_env.add_spec_paths_to_sprockets
   run Opal::Server.new(sprockets: sprockets_env) { |s|
     s.main = 'opal/rspec/sprockets_runner'
-    s.append_path React::Rails::AssetVariant.new(addons: true).react_directory
     s.debug = false
     s.append_path 'spec/vendor'
     s.index_path = 'spec/index.html.erb'
   }
 else
   run Opal::Server.new { |s|
     s.main = 'opal/rspec/sprockets_runner'
-    s.append_path React::Rails::AssetVariant.new(addons: true).react_directory
     s.append_path 'spec'
     s.append_path 'spec/vendor'
     s.debug = false

spec/vendor/react-server.js renamed to lib/react-sources/react-server.js

@@ -1,2 +1,2 @@
 // A placeholder file to prevent file not found error of requireing
-// `react-server` in spec_helper.rb.
+// `react-server` in react/react-source

lib/react/react-source.rb

@@ -0,0 +1,9 @@
+if RUBY_ENGINE == 'opal'
+  require 'react.js'
+  require "react-server.js"
+else
+  require "react/rails/asset_variant"
+  react_directory = React::Rails::AssetVariant.new(addons: true).react_directory
+  Opal.append_path react_directory.untaint
+  Opal.append_path File.expand_path('../../react-sources/', __FILE__).untaint
+end

lib/reactive-ruby.rb

@@ -5,17 +5,12 @@
     raise [
       "No React.js Available",
       "",
-      "React.js must be defined before requiring 'reactive-ruby'",
-      "'reactive-ruby' has been tested with react v13, v14, and v15.",
+      "A global `React` must be defined before requiring 'reactive-ruby'",
       "",
-      "IF USING 'react-rails':",
-      "   add 'require \"react\"' immediately before the 'require \"reactive-ruby\" directive in 'views/components.rb'.",
+      "To USE THE BUILT-IN SOURCE: ",
+      "   add 'require \"react/react-source\"' immediately before the 'require \"reactive-ruby\" directive.",
       "IF USING WEBPACK:",
-      "   add 'react' to your webpack manifest.",
-      "OTHERWISE TO GET THE LATEST TESTED VERSION",
-      "   add 'require \"react-latest\"' immediately before the require of 'reactive-ruby',",
-      "OR TO USE A SPECIFIC VERSION",
-      "   add 'require \"react-v1x\"' immediately before the require of 'reactive-ruby'."
+      "   add 'react' to your webpack manifest."
     ].join("\n")
   end
   require 'react/top_level'
@@ -49,4 +44,5 @@
 
   Opal.append_path File.expand_path('../', __FILE__).untaint
   Opal.append_path File.expand_path('../sources/', __FILE__).untaint
+  require "react/react-source"
 end

lib/reactrb.rb

@@ -2,18 +2,16 @@
 
 if RUBY_ENGINE == 'opal'
   if `window.React === undefined || window.React.version === undefined`
-    raise "No React.js Available\n\n"\
-          "React.js must be defined before requiring 'reactrb'\n"\
-          "'reactrb' has been tested with react v13, v14, and v15.\n\n"\
-          "IF USING 'react-rails':\n"\
-          "   add 'require \"react\"' immediately before the 'require \"reactive-ruby\" "\
-              "directive in 'views/components.rb'.\n"\
-          "IF USING WEBPACK:\n"\
-          "   add 'react' to your webpack manifest.\n"\
-          "OTHERWISE TO GET THE LATEST TESTED VERSION\n"\
-          "   add 'require \"react-latest\"' immediately before the require of 'reactrb',\n"\
-          "OR TO USE A SPECIFIC VERSION\n"\
-          "   add 'require \"react-v1x\"' immediately before the require of 'reactrb'."
+    raise [
+      "No React.js Available",
+      "",
+      "A global `React` must be defined before requiring 'reactrb'",
+      "",
+      "To USE THE BUILT-IN SOURCE: ",
+      "   add 'require \"react/react-source\"' immediately before the 'require \"reactrb\" directive.",
+      "IF USING WEBPACK:",
+      "   add 'react' to your webpack manifest."
+    ].join("\n")
   end
   require 'react/hash'
   require 'react/top_level'
@@ -50,4 +48,5 @@
 
   Opal.append_path File.expand_path('../', __FILE__).untaint
   Opal.append_path File.expand_path('../sources/', __FILE__).untaint
+  require "react/react-source"
 end

lib/sources/react-latest.js

@@ -1,3 +1,5 @@
+console.error("Warning: loading `react-latest` directly is deprecated. Replace the requires with `react/react-source`.");
+
 /**
  * React (with addons) v15.0.1
  */

lib/sources/react-v13.js

@@ -1,3 +1,6 @@
+console.error("Warning: loading `react-v13` directly is deprecated. ")
+console.error("Replace the requires with `react/react-source` and add `gem 'react-rails', '~> 1.3.3'` to your Gemfile.");
+
 /**
  * React (with addons) v0.13.3
  */
@@ -21639,4 +21642,4 @@ if ("production" !== "development") {
 module.exports = warning;
 
 },{"129":129}]},{},[1])(1)
-});
+});