react_on_rails 11.0.0 → 12.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: react_on_rails
 version: !ruby/object:Gem::Version
-  version: 11.0.0
+  version: 12.0.0
 platform: ruby
 authors:
 - Justin Gordon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-22 00:00:00.000000000 Z
+date: 2020-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -72,14 +72,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webpacker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -220,20 +234,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-stack_explorer
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-state
   requirement: !ruby/object:Gem::Requirement
@@ -248,20 +248,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-toys
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -310,14 +296,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: 0.85.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.55.0
+        version: 0.85.0
 description: See README.md
 email:
 - justin@shakacode.com
@@ -326,12 +312,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".bookignore"
+- ".circleci/config.yml"
 - ".coveralls.yml"
 - ".dockerignore"
 - ".eslintignore"
 - ".eslintrc"
+- ".github/FUNDING.yml"
 - ".gitignore"
 - ".npmignore"
+- ".prettierignore"
+- ".prettierrc"
+- ".release-it.json"
 - ".rspec"
 - ".rubocop.yml"
 - ".scss-lint.yml"
@@ -340,64 +331,79 @@ files:
 - CONTRIBUTING.md
 - Dockerfile_tests
 - Gemfile
-- Gemfile.rails32
 - KUDOS.md
+- LICENSE.md
 - NEWS.md
 - PROJECTS.md
+- REACT-ON-RAILS-PRO-LICENSE
 - README.md
 - Rakefile
 - SUMMARY.md
 - app/helpers/react_on_rails_helper.rb
 - book.json
 - docker-compose.yml
-- docs/LICENSE.md
 - docs/additional-reading/angular-js-integration-migration.md
 - docs/additional-reading/asset-pipeline.md
-- docs/additional-reading/babel.md
-- docs/additional-reading/caching-and-performance.md
 - docs/additional-reading/capistrano-deployment.md
-- docs/additional-reading/code-splitting.md
+- docs/additional-reading/convert-rails-5-api-only-app.md
+- docs/additional-reading/credits.md
 - docs/additional-reading/elastic-beanstalk.md
 - docs/additional-reading/foreman-issues.md
-- docs/additional-reading/heroku-deployment.md
-- docs/additional-reading/hot-reloading-rails-development.md
 - docs/additional-reading/images.md
 - docs/additional-reading/node-dependencies-and-npm.md
-- docs/additional-reading/node-server-rendering.md
-- docs/additional-reading/rails-assets-relative-paths.md
-- docs/additional-reading/rails-assets.md
 - docs/additional-reading/rails-engine-integration.md
 - docs/additional-reading/rails_view_rendering_from_inline_javascript.md
 - docs/additional-reading/react-and-redux.md
 - docs/additional-reading/react-helmet.md
 - docs/additional-reading/react-router.md
-- docs/additional-reading/recommended-project-structure.md
-- docs/additional-reading/rspec-configuration.md
 - docs/additional-reading/server-rendering-tips.md
 - docs/additional-reading/tips.md
 - docs/additional-reading/troubleshooting-when-using-webpacker.md
 - docs/additional-reading/turbolinks.md
 - docs/additional-reading/updating-dependencies.md
+- docs/additional-reading/upgrade-webpacker-v3-to-v4.md
 - docs/additional-reading/webpack-dev-server.md
 - docs/additional-reading/webpack-v1-notes.md
 - docs/additional-reading/webpack.md
 - docs/api/javascript-api.md
-- docs/api/ruby-api-hot-reload-view-helpers.md
-- docs/api/ruby-api.md
+- docs/api/redux-store-api.md
+- docs/api/view-helpers-api.md
+- docs/articles.md
+- docs/basics/client-vs-server-rendering.md
 - docs/basics/configuration.md
-- docs/basics/generator.md
+- docs/basics/deployment.md
+- docs/basics/generator-details.md
+- docs/basics/heroku-deployment.md
+- docs/basics/hmr-and-hot-reloading-with-the-webpack-dev-server.md
 - docs/basics/i18n.md
-- docs/basics/installation-overview.md
+- docs/basics/installation-into-an-existing-rails-app.md
 - docs/basics/migrating-from-react-rails.md
+- docs/basics/minitest-configuration.md
+- docs/basics/react-server-rendering.md
+- docs/basics/recommended-project-structure.md
+- docs/basics/render-functions-and-railscontext.md
+- docs/basics/rspec-configuration.md
 - docs/basics/upgrading-react-on-rails.md
+- docs/basics/webpack-configuration.md
 - docs/coding-style/style.md
+- docs/contributor-info/errors-with-hooks.md
 - docs/contributor-info/generator-testing.md
 - docs/contributor-info/linters.md
+- docs/contributor-info/pull-requests.md
 - docs/contributor-info/releasing.md
 - docs/misc/code_of_conduct.md
 - docs/misc/doctrine.md
-- docs/misc/rails3.md
+- docs/outdated/code-splitting.md
+- docs/outdated/how-react-on-rails-works.md
+- docs/outdated/manual-installation-overview.md
+- docs/outdated/rails-assets-relative-paths.md
+- docs/outdated/rails-assets.md
+- docs/outdated/rails3.md
+- docs/testimonials/hvmn.md
+- docs/testimonials/resortpass.md
+- docs/testimonials/testimonials.md
 - docs/tutorial.md
+- jest.config.js
 - lib/generators/USAGE
 - lib/generators/react_on_rails/base_generator.rb
 - lib/generators/react_on_rails/dev_tests_generator.rb
@@ -408,7 +414,7 @@ files:
 - lib/generators/react_on_rails/react_with_redux_generator.rb
 - lib/generators/react_on_rails/templates/.eslintrc
 - lib/generators/react_on_rails/templates/base/base/Procfile.dev
-- lib/generators/react_on_rails/templates/base/base/Procfile.dev-server
+- lib/generators/react_on_rails/templates/base/base/Procfile.dev-hmr
 - lib/generators/react_on_rails/templates/base/base/app/controllers/hello_world_controller.rb
 - lib/generators/react_on_rails/templates/base/base/app/javascript/bundles/HelloWorld/components/HelloWorld.jsx
 - lib/generators/react_on_rails/templates/base/base/app/javascript/packs/registration.js.tt
@@ -429,17 +435,20 @@ files:
 - lib/generators/react_on_rails/templates/redux/base/app/javascript/bundles/HelloWorld/startup/HelloWorldApp.jsx
 - lib/generators/react_on_rails/templates/redux/base/app/javascript/bundles/HelloWorld/store/helloWorldStore.js
 - lib/react_on_rails.rb
-- lib/react_on_rails/assets_precompile.rb
 - lib/react_on_rails/configuration.rb
 - lib/react_on_rails/controller.rb
 - lib/react_on_rails/engine.rb
 - lib/react_on_rails/error.rb
 - lib/react_on_rails/git_utils.rb
+- lib/react_on_rails/helper.rb
 - lib/react_on_rails/json_output.rb
-- lib/react_on_rails/locales_to_js.rb
+- lib/react_on_rails/json_parse_error.rb
+- lib/react_on_rails/locales/base.rb
+- lib/react_on_rails/locales/to_js.rb
+- lib/react_on_rails/locales/to_json.rb
 - lib/react_on_rails/prerender_error.rb
-- lib/react_on_rails/react_component/options.rb
-- lib/react_on_rails/react_on_rails_helper.rb
+- lib/react_on_rails/react_component/render_options.rb
+- lib/react_on_rails/server_rendering_js_code.rb
 - lib/react_on_rails/server_rendering_pool.rb
 - lib/react_on_rails/server_rendering_pool/ruby_embedded_java_script.rb
 - lib/react_on_rails/test_helper.rb
@@ -453,6 +462,7 @@ files:
 - lib/react_on_rails/webpacker_utils.rb
 - lib/tasks/assets.rake
 - lib/tasks/locale.rake
+- package-scripts.yml
 - package.json
 - rakelib/docker.rake
 - rakelib/dummy_apps.rake
@@ -470,6 +480,7 @@ files:
 - script/release
 - script/setup
 - script/test
+- tsconfig.json
 - webpackConfigLoader.js
 - yarn.lock
 homepage: https://github.com/shakacode/react_on_rails
@@ -489,15 +500,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Rails with react server rendering with webpack.

data/Gemfile.rails32

@@ -1,74 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-eval_gemfile File.expand_path("../react_on_rails.gemspec", __FILE__)
-
-# Bundle edge Rails instead: gem 'rails', github: 'rails/rails'
-gem "rails", "~> 3.2"
-# Use sqlite3 as the database for Active Record
-gem "sqlite3"
-# Use SCSS for stylesheets
-gem "sass-rails"
-# Use Uglifier as compressor for JavaScript assets
-gem "uglifier"
-# Use CoffeeScript for .coffee assets and views
-gem "coffee-rails"
-
-# Use jquery as the JavaScript library
-gem "jquery-rails"
-
-gem "puma"
-
-# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
-gem "jbuilder"
-# bundle exec rake doc:rails generates the API under doc/api.
-gem "sdoc", group: :doc
-
-# Use ActiveModel has_secure_password
-# gem 'bcrypt', '~> 3.1.7'
-
-# Use Unicorn as the app server
-# gem 'unicorn'
-
-# Use Capistrano for deployment
-# gem 'capistrano-rails', group: :development
-
-gem "mini_racer"
-gem "connection_pool"
-gem "rainbow"
-gem "addressable"
-gem "execjs"
-
-group :development, :test do
-  # Call 'byebug' anywhere in the code to stop execution and get a debugger console
-  gem "awesome_print"
-  gem "listen"
-  gem "pry"
-  gem "pry-byebug"
-  gem "pry-doc"
-  gem "pry-rails"
-  gem "pry-rescue"
-  gem "pry-stack_explorer"
-  gem "rubocop", require: false
-  gem "ruby-lint", require: false
-  gem "scss_lint", require: false
-
-end
-
-group :test do
-  gem "capybara"
-  gem "capybara-screenshot"
-  gem "coveralls", require: false
-  # install trouble with updated
-  # gem "capybara-webkit"
-  gem "chromedriver-helper"
-  gem "generator_spec"
-  gem "launchy"
-  gem "poltergeist"
-  gem "rspec-rails"
-  gem "rspec-retry"
-  gem "selenium-webdriver"
-  gem 'test-unit', '~> 3.0'
-  gem "equivalent-xml", github: "mbklein/equivalent-xml"
-end

data/docs/additional-reading/babel.md

@@ -1,5 +0,0 @@
-# Babel
-
-As of React on Rails 2.0, we recommend Babel 6 and at least node version 5.5. If you want to stick with Babel 5 for a bit, see [Issue #238](https://github.com/shakacode/react_on_rails/issues/238).
-
-We recommend that you take a look at https://github.com/shakacode/react-webpack-rails-tutorial and follow the recipe there. We will try to keep that simple example updated.

data/docs/additional-reading/caching-and-performance.md

@@ -1,4 +0,0 @@
-# Caching and Performance
-
-Caching and performance optimizations are now part of React on Rails Pro. For more information,
-[contact Justin](mailto:justin@shakacode.com).

data/docs/additional-reading/heroku-deployment.md

@@ -1,92 +0,0 @@
-# Heroku Deployment
-The generator has created the necessary files and gems for deployment to Heroku. If you have installed manually, you will need to provide these files yourself:
-
-+ `Procfile`: used by Heroku and Foreman to start the Puma server
-+ `12factor` gem: required by Heroku if using a version before Rails 5 (see their [README](https://github.com/heroku/rails_12factor#rails-5) for more information if upgrading from a lower version)
-+ `'puma'` gem: recommended Heroku webserver
-+ `config/puma.rb`: Puma webserver config file
-+ `/package.json`: Top level package.json which must contain `"scripts": { "postinstall": "cd client && npm install" }`
-
-If you want to see an updated example deployed to Heroku, please visit the [github.com/shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial).
-
-## More details on precompilation using webpack to create JavaScript assets
-This is how the `assets:precompile` rake task gets modified by `react_on_rails`. You should be able to call `clear_prerequisites` and setup your own custom precompile if needed.
-```ruby
-# These tasks run as pre-requisites of assets:precompile.
-# Note, it's not possible to refer to ReactOnRails configuration values at this point.
-Rake::Task["assets:precompile"]
-    .clear_prerequisites
-    .enhance([:environment, "react_on_rails:assets:compile_environment"])
-    .enhance do
-      Rake::Task["react_on_rails:assets:symlink_non_digested_assets"].invoke
-      Rake::Task["react_on_rails:assets:delete_broken_symlinks"].invoke
-    end
-```    
-
-For an example of how to do this, see the [dummy app](https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/lib/tasks/assets.rake).
-
-## Caching Node Modules
-By default Heroku will cache the root `node_modules` directory between deploys but since we're installing in `client/node_modules` you'll need to add the following line to the `package.json` in your root directory (otherwise you'll have to sit through a full `yarn` on each deploy):
-
-```js
-"cacheDirectories": [
-  "node_modules",
-  "client/node_modules"
-],
-```
-
-## How to Deploy
-
-React on Rails requires both a ruby environment (for Rails) and a Node environment (for Webpack), so you will need to have Heroku use multiple buildpacks.
-
-Assuming you have downloaded and installed the Heroku command-line utility and have initialized the app, you will need to tell Heroku to use both buildpacks via the command-line:
-
-```
-heroku buildpacks:set heroku/ruby
-heroku buildpacks:add --index 1 heroku/nodejs
-```
-
-For more information, see [Using Multiple Buildpacks for an App](https://devcenter.heroku.com/articles/using-multiple-buildpacks-for-an-app)
-
-## Fresh Rails Install
-
-### Swap out sqlite for postgres by doing the following:
-
-#### 1. Delete the line with `sqlite` and replace it with:
-
-```ruby
-   gem 'pg'
-```
-
-#### 2. Replace your `database.yml` file with this (assuming your app name is "ror")
-
-```yml
-default: &default
-  adapter: postgresql
-  username:
-  password:
-  host: localhost
-
-development:
-  <<: *default
-  database: ror_development
-
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
-test:
-  <<: *default
-  database: ror_test
-
-production:
-  <<: *default
-  database: ror_production
-```
-
-Run:
-
-```
-bundle
-bin/rake db:setup
-bin/rake db:migrate
-```

data/docs/additional-reading/hot-reloading-rails-development.md

@@ -1,57 +0,0 @@
-# Live Reloading vs. Hot Reloading (aka HMR)
-
-The use of the [webpack-dev-server](https://webpack.js.org/configuration/dev-server/) provides "Live Reloading" by default. The difference between live and hot reloading is that live reloading will act similarly to hitting refresh in the browser. Hot reloading will attempt to preserve the state of any props.
-
-See the Webpack document [Hot Module Replacement](https://webpack.js.org/concepts/hot-module-replacement/) for more details on the concepts of live vs. hot reloading.
-
-The remainder of this document discusses HMR.
-
-# Using the Webpacker Webpack setup
-
-If you are using the default Webpacker setup of running the dev server with `bin/webpack-dev-server`, see the [Webpacker Webpack Dev Server discussion of HMR](https://github.com/rails/webpacker/blob/master/docs/webpack-dev-server.md#hot-module-replacement).
-
-
-# Hot Reloading of Assets For Rails Development
-
-_Note, this document is not yet updated for React on Rails v8+. See [PR #865](https://github.com/shakacode/react_on_rails/pull/865) for a detailed example of doing hot reloading using V8+ with Webpack v2. Any volunteers to update this page? See [#772](https://github.com/shakacode/react_on_rails/issues/772) and [#361](https://github.com/shakacode/react-webpack-rails-tutorial/issues/361)._
-
-------
-
-This document outlines the steps to setup your React On Rails Environment so that you can experience the pleasure of hot reloading of JavaScript and Sass during your Rails development work. See [Issue 332](https://github.com/shakacode/react_on_rails/issues/332) for troubleshooting. There are 3 examples of this setup:
-
-1. [minimal demo here](https://github.com/retroalgic/react-on-rails-hot-minimal): The most simple and updated hot reloading setup.
-1. [spec/dummy](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy): Simpler setup used for integration testing this gem.
-1. [shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/). Full featured setup using Twitter bootstrap.
-
-## Help Wanted
-
-This doc might be outdated. PRs welcome!
-
-## High Level Strategy
-
-We'll use a Webpack Dev server on port 3500 to provide the assets to Rails, rather than the asset pipeline, and only during development mode. This is configured via the `Procfile.hot`. 
-
-`Procfile.static` provides an alternative that uses "static" assets, similar to a production deployment.
-
-## Places to Configure (Files to Examine)
-
-1. See the Webpack config files. Note, these examples are now setup for using [CSS Modules](https://github.com/css-modules/css-modules).
-   1. [client/webpack.client.base.config.js](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/webpack.client.base.config.js): Common configuration for hot or static assets.
-   1. [client/webpack.client.rails.hot.config.js](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/webpack.client.rails.hot.config.js): Setup for hot loading, using react-transform-hmr.
-   1. [client/webpack.client.rails.build.config.js](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/webpack.client.rails.build.config.js): Setup for static loading, as is done in a production deployment.
-1. [app/views/layouts/application.html.erb](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/app/views/layouts/application.html.erb): Uses the view helpers `env_stylesheet_link_tag` and `env_javascript_include_tag` which will either do the hot reloading or the static loading.
-1. See the Procfiles: [Procfile.hot](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/Procfile.hot) and [Procfile.static](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/Procfile.static). These:
-   1. Start the webpack processes, depending on the mode or HOT or not.
-   2. Start the rails server, setting an ENV value of REACT_ON_RAILS_ENV to HOT if we're hot loading or else setting this to blank.
-1. Configure the file Rails asset pipeline files:
-   1. [app/assets/javascripts/application_static.js](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/app/assets/javascripts/application_static.js) 
-   1. [app/assets/stylesheets/application_non_webpack.scss](https://github.com/shakacode/react_on_rails/blob/master/spec/dummy/app/assets/stylesheets/application_non_webpack.scss)
-1. Copy the [client/server-rails-hot.js](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/server-rails-hot.js) to the your client directory.
-1. Copy the scripts in the top level and client level `package.json` files:
-   1. Top Level: [package.json](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/package.json)
-   1. Client Level: [package.json](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy/client/package.json)
-
-
-## Code Snippets
-Please refer to the examples linked above in `spec/dummy` as these code samples might be out of date.
-

data/docs/additional-reading/node-server-rendering.md

@@ -1,5 +0,0 @@
-# Node.js for Server Rendering
-
-Node.js can be used as the backend for server-side rendering instead of [execJS](https://github.com/rails/execjs). Before you try this, consider the tradeoff of extra complexity with your deployments versus *potential* performance gains. While often ExecJS with [mini_racer](https://github.com/discourse/mini_racer) is "fast enough", we've heard of other large websites using Node.js for better server rendering performance.
-
-If you want to use a node server for server rendering, [get in touch](mailto:justin@shakacode.com). ShakaCode has built a premium Node rendering server for React on Rails.

data/docs/additional-reading/rspec-configuration.md

@@ -1,56 +0,0 @@
-# RSpec Configuration
-Because you will probably want to run RSpec tests that rely on compiled webpack assets (typically, your integration/feature specs where `js: true`), you will want to ensure you don't accidentally run tests on missing or stale webpack assets. If you did use stale Webpack assets, you will get invalid test results as your tests do not use the very latest JavaScript code.
-
-ReactOnRails provides a helper method called `ReactOnRails::TestHelper.configure_rspec_to_compile_assets`. Call this method from inside of the `RSpec.configure` block in your `spec/rails_helper.rb` file, passing the config as an argument. See file [lib/react_on_rails/test_helper.rb](../../lib/react_on_rails/test_helper.rb) for more details. You can customize this to your particular needs by replacing any of the default components used by `ReactOnRails::TestHelper.configure_rspec_to_compile_assets`.
-
-```ruby
-RSpec.configure do |config|
-  ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
-```
-
-You can pass one or more RSpec metatags as an optional second parameter to this helper method if you want this helper to run on examples other than where `:js` or `:server_rendering` (those are the defaults). The helper will compile webpack files at most once per test run. The helper will not compile the webpack files unless they are out of date (stale). The helper is configurable in terms of what command is used to prepare the files.
-
-If you are using Webpack to build CSS assets, you should do something like this to ensure that you assets are built for any specs under `specs/requests` or `specs/features`:
-
-```ruby
-  ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config, :requires_webpack_assets)
-
-  # Because we're using some CSS Webpack files, we need to ensure the webpack files are generated
-  # for all feature specs. https://github.com/shakacode/react_on_rails/issues/792
-  config.define_derived_metadata(file_path: %r{spec/(features|requests)}) do |metadata|
-    metadata[:requires_webpack_assets] = true
-  end
-```
-
-Please take note of the following:
-- This utility uses your `build_test_command` to build the static generated files. This command **must not** include the `--watch` option. If you have different server and client bundle files, this command **must** create all the bundles. If you are using webpacker, the default value will come from the `config/webpacker.yml` value for the `public_output_path` and the `source_path`
-- If you add an older file to your source files, that is already older than the produced output files, no new recompilation is done. The solution to this issue is to clear out your directory of webpack generated files when adding new source files that may have older dates. This is actually a common occurrence when you've built your test generated files and then you sync up your repository files.
-
-- By default, the webpack processes look for the `app/assets/webpack` folders (configured as setting `webpack_generated_files` in the `config/react_on_rails.rb`. If this folder is missing, is empty, or contains files in the `config.webpack_generated_files` list with `mtime`s older than any of the files in your `client` folder, the helper will recompile your assets. You can override the location of these files inside of `config/initializers/react_on_rails.rb` by passing a filepath (relative to the root of the app) to the `generated_assets_dir` configuration option.
-
-The following `config/react_on_rails.rb` settings **must** match your setup:
-```ruby
-  # Directory where your generated assets go. All generated assets must go to the same directory.
-  # Configure this in your webpack config files. This relative to your Rails root directory.
-  # We recommend having different generated assets dirs per Rails env.
-  config.generated_assets_dir = File.join(%w[public webpack], Rails.env)
-
-  # Define the files we need to check for webpack compilation when running tests.
-  # Generally, the manifest.json is good enough for this check if using webpacker
-  config.webpack_generated_files = %w( hello-world-bundle.js )
-  
-  # If you are using the ReactOnRails::TestHelper.configure_rspec_to_compile_assets(config)
-  # with rspec then this controls what yarn command is run
-  # to automatically refresh your webpack assets on every test run.
-  config.build_test_command = "yarn run build:test"
-```
-
-If you want to speed up the re-compiling process so you don't wait to run your tests to build the files, you can run your test compilation with the "watch" flags.
-
-[spec/dummy](https://github.com/shakacode/react_on_rails/tree/master/spec/dummy) contains examples of how to set the proc files for this purpose.
-
-If you want to use a testing framework other than RSpec, please submit let us know on the changes you need to do and we'll update the docs.
-
-![2016-01-27_02-36-43](https://cloud.githubusercontent.com/assets/1118459/12611951/7c56d070-c4a4-11e5-8a80-9615f99960d9.png)
-
-![2016-01-27_03-18-05](https://cloud.githubusercontent.com/assets/1118459/12611975/a8011654-c4a4-11e5-84f9-1baca4835b4b.png)

data/docs/api/ruby-api-hot-reload-view-helpers.md

@@ -1,44 +0,0 @@
-## NOTE: These helpers are NOT needed if using webpacker
-
-## Hot Reloading View Helpers
-The `env_javascript_include_tag` and `env_stylesheet_link_tag` support the usage of a webpack dev server for providing the JS and CSS assets during development mode. See the [shakacode/react-webpack-rails-tutorial](https://github.com/shakacode/react-webpack-rails-tutorial/) for a working example.
-
-The key options are `static` and `hot` which specify what you want for static vs. hot. Both of these params are optional, and support either a single value, or an array.
-
-static vs. hot is picked based on whether `ENV["REACT_ON_RAILS_ENV"] == "HOT"`
-
-```erb
- <%= env_stylesheet_link_tag(static: 'application_static',
-                             hot: 'application_non_webpack',
-                             media: 'all',
-                             'data-turbolinks-track' => true)  %>
-
- <!-- These do not use turbolinks, so no data-turbolinks-track -->
- <!-- This is to load the hot assets. -->
- 
- <!-- Note, you can have multiple files here. It's an array. -->
- <%= env_javascript_include_tag(hot: ['http://localhost:3500/hello-world-bundle.js]') %>
-
- <!-- These do use turbolinks -->
- <%= env_javascript_include_tag(static: 'application_static',
-                                hot: 'application_non_webpack',
-                                'data-turbolinks-track' => true) %>
-```
-
-See application.html.erb for usage example and [application.html.erb](https://github.com/shakacode/react-webpack-rails-tutorial/blob/master/app%2Fviews%2Flayouts%2Fapplication.html.erb)
-
-Helper to set CSS and JS assets depending on if we want static or "hot", which means from the Webpack dev server.
-
-In this example, `application_non_webpack` is simply a CSS asset pipeline file which includes styles not placed in the webpack build. The same can be said for `application_non_webpack` for JS files. Note, the suffix is not used in the helper calls.
-
-We don't need styles from the webpack build, as those will come via the JavaScript include tags.
-
-The key options are `static` and `hot` which specify what you want for static vs. hot. Both of
-these params are optional, and support either a single value, or an array.
-
-```erb
- <%= env_stylesheet_link_tag(static: 'application_static',
-                             hot: 'application_non_webpack',
-                             media: 'all',
-                             'data-turbolinks-track' => true)  %>
-```

data/docs/api/ruby-api.md

@@ -1,8 +0,0 @@
-# View Helpers
-See the [app/helpers/react_on_rails_helper.rb](../../app/helpers/react_on_rails_helper.rb) source.
-
-# Controller Helpers
-See the [lib/react_on_rails/controller.rb](../../lib/react_on_rails/controller.rb) source.
-
-# Utility Methods
-See the [lib/react_on_rails/utils.rb](../../lib/react_on_rails/utils.rb) source.