react_on_rails_pro 16.2.0.beta.8

data/CONTRIBUTING.md

@@ -0,0 +1,376 @@
+# Tips for Contributors
+
+## Installation
+
+Install [yalc](https://github.com/wclr/yalc).
+
+
+```sh
+cd react_on_rails_pro
+bundle && yarn && cd spec/dummy && bundle && yarn
+```
+To use the `React 18 Apollo with GraphQL` example you need to seed the testing database inside `spec/dummy` directory.
+```sh
+rake db:seed
+```
+
+
+See the example apps under `/spec`
+
+## Summary
+
+For non-doc fixes:
+
+* Provide changelog entry in the [unreleased section of the CHANGELOG.md](https://github.com/shakacode/react_on_rails_pro/blob/master/CHANGELOG.md#unreleased).
+* Ensure CI passes and that you added a test that passes with the fix and fails without the fix.
+* Squash all commits down to one with a nice commit message *ONLY* once final review is given. Make sure this single commit is rebased on top of master.
+* Please address all code review comments.
+* Ensure that docs are updated accordingly if a feature is added.
+
+## Commit Messages
+
+From [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/)
+
+#### The seven rules of a great git commit message
+> Keep in mind: This has all been said before.
+
+1. Separate subject from body with a blank line
+1. Limit the subject line to 50 characters
+1. Capitalize the subject line
+1. Do not end the subject line with a period
+1. Use the imperative mood in the subject line
+1. Wrap the body at 72 characters
+1. Use the body to explain what and why vs. how
+
+
+## Doc Changes
+
+When making doc changes, we want the change to work on both https://www.shakacode.com/react-on-rails-pro/docs/ and when browsing the GitHub repo. 
+The issue is that the Shakacode site is generated only from files in [`docs`](./docs), so any references from them to non-doc files must use the full GitHub URL.
+
+### Links to other docs:
+* When making references to doc files, use a relative URL path like:
+`[Installation Overview](docs/basics/installation-overview.md)`
+
+* When making references to source code files, use a full url path like:
+`[spec/dummy/config/initializers/react_on_rails.rb](https://github.com/shakacode/react_on_rails_pro/tree/master/spec/dummy/config/initializers/react_on_rails.rb)`
+
+
+## To run tests:
+See [Run NPM JS tests](#run-npm-js-tests) for the JS tests and [RSpec Testing](#rspec-testing) for the Ruby tests.
+
+See [Dev Initial Setup](#dev-initial-setup) below for, well... initial setup.
+
+## CI Testing and Optimization
+
+React on Rails Pro shares the optimized CI pipeline with the main gem. The CI system intelligently runs only relevant tests based on file changes.
+
+### CI Behavior
+
+- **On PRs/Branches**: Runs reduced test matrix (latest Ruby/Node versions only) for faster feedback
+- **On Master**: Runs full test matrix (all Ruby/Node/dependency combinations) for complete coverage
+- **Docs-only changes**: CI skips entirely when only `.md` files or `docs/` directory change
+
+### Local CI Tools
+
+The repository root provides local CI tools that work with both the main gem and Pro:
+
+#### `bin/ci-local` - Smart Local CI Runner
+
+Run from the **repository root** to test Pro changes:
+
+```bash
+# Navigate to repository root first
+cd ..
+
+# Auto-detect what to test (includes Pro tests if Pro files changed)
+bin/ci-local
+
+# Run all CI checks (same as master branch)
+bin/ci-local --all
+
+# Quick check - only fast tests
+bin/ci-local --fast
+```
+
+The detector automatically identifies Pro-related changes and runs appropriate Pro tests.
+
+#### `script/ci-changes-detector` - Change Analysis
+
+Analyzes changes to both main gem and Pro:
+
+```bash
+# From repository root
+script/ci-changes-detector origin/master
+```
+
+### CI Best Practices for Pro
+
+✅ **DO:**
+- Run `bin/ci-local` from repository root before pushing
+- Test Pro changes alongside main gem changes if modifying both
+- Use `bin/ci-local --fast` during rapid iteration
+
+❌ **DON'T:**
+- Push Pro changes without testing locally first
+- Modify both Pro and main gem without running full tests
+
+For comprehensive CI documentation, see [`../docs/CI_OPTIMIZATION.md`](../docs/CI_OPTIMIZATION.md) in the repository root.
+
+# IDE/Editor Setup
+It's critical to configure your IDE/editor to ignore certain directories. Otherwise your IDE might slow to a crawl!
+
+* /coverage
+* /tmp
+* /node_modules
+* /spec/dummy/app/assets/webpack
+* /spec/dummy/log
+* /spec/dummy/node_modules
+* /spec/dummy/client/node_modules
+* /spec/dummy/tmp
+
+
+# Configuring your test app to use your local fork
+You can test the `react_on_rails_pro` gem using your own external test_app or the gem's internal `spec/dummy` app. The `spec/dummy` app is an example of the various setup techniques you can use with the gem.
+As of 2018-04-28, this directory mirrors the test app spec/dummy on https://github.com/shakacode/react_on_rails plus a few additional tests.
+
+```
+├── test_app
+|    └── client
+└── react_on_rails_pro
+    └── spec
+        └── dummy
+```
+
+## Testing the Ruby Gem
+If you want to test the ruby parts of the gem with an application before you release a new version of the gem, you can specify the path to your local version via your test app's Gemfile:
+
+```ruby
+gem "react_on_rails_pro", path: "../path-to-react_on_rails_pro"
+gem "react_on_rails"
+```
+================================================================================
+
+Set `config.server_renderer = "NodeRenderer"` in your  `ReactOnRailsPro.configure` block in the initializer.
+
+After making this change, run `bundle install`.
+
+> [!NOTE]
+> You will need to restart your Rails application if you make any changes to the gem.
+
+## Testing the Node package for react_on_rails_pro
+In addition to testing the Ruby parts out, you can also test the node package parts of the gem with an external application.
+
+To do this, follow the instructions in the
+[Local Node Package](#local-node-package).
+
+### Example: Testing NPM changes with the dummy app
+
+1. Add `console.log('Hello!')` [here](https://github.com/shakacode/react_on_rails_pro/blob/more_test_and_docs/packages/node-renderer/src/ReactOnRailsProNodeRenderer.js#L6) in `packages/node-renderer/src/ReactOnRailsProNodeRenderer.js` to confirm we're getting an update to the node package.
+2. The `preinstall` script of `spec/dummy` builds the NPM package and sets up `yalc` to use it for the renderer. 
+   It's run automatically when you run `yarn install`. 
+3. Refresh the browser if the server is already running or start the server using `foreman start -f Procfile.dev` from `spec/dummy` and navigate to `http://localhost:3000/`. You will now see the `Hello!` message printed in the browser's console.
+
+> [!NOTE]
+> `yalc` makes the NPM package available globally on the machine.
+> So, if you have the repo checked out more than once to compare behavior between branches,
+> make sure to run `yarn install` every time you switch to a new copy.
+
+# Development Setup for Gem and Node Package Contributors
+
+## Checklist before Committing
+1. Run all JS tests, dummy app tests and linters.
+2. Did you need any more tests for your change?
+3. Did you document your change? Update the README.md?
+
+## Dev Initial Setup
+
+### Prereqs
+After checking out the repo, making sure you have rvm and nvm setup (setup ruby and node), cd to `spec/dummy` and run `bin/setup` to install ruby dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+
+### Building the Node Package for Development
+
+At the root:
+```
+nps build
+```
+
+### Modifying the startup for testing
+
+This is a possible update to package.json to debug the lockfile. Notice the `NODE_DEBUG=LOCKFILE,ROR`
+
+```json
+    "developing": "rm -rf /tmp/react-on-rails-pro-node-renderer-bundles && RENDERER_LOG_LEVEL=info NODE_DEBUG=LOCKFILE,ROR node --enable-source-maps --experimental-modules packages/node-renderer/lib/default-node-renderer.js",
+```
+
+See https://nodejs.org/api/util.html#util_util_debuglog_section for details on `debuglog`.
+
+### Local Node Package
+Because the example and dummy apps rely on the `react_on_rails_pro` node package, they should link directly to your local version to pick up any changes you may have made to that package.
+To achieve this, you can use `yalc`.
+The easy way to do this is to run the command below in the dummy app root directory.
+For more information check the script section of the
+[spec/dummy/package.json](spec/dummy/package.json) file.
+
+```sh
+cd spec/dummy
+yarn install
+```
+
+> [!NOTE]
+> This runs npm under the hood as explained in the **Test NPM for react_on_rails_pro** section above.
+
+From now on, the example and dummy apps will use your local packages/node-renderer folder as the `react_on_rails_pro` node package.
+
+### Install NPM dependencies and build the NPM package for react_on_rails_pro
+
+```sh
+cd react_on_rails_pro
+yarn install
+```
+
+Or run this, which builds the yarn package, then the webpack files for spec/dummy, and finally runs tests in
+spec/dummy.
+
+
+```sh
+# Optionally change default selenium_firefox driver
+# export DRIVER=poltergeist
+cd react_on_rails_pro
+yarn run dummy:spec
+```
+
+### Run NPM JS tests
+
+```sh
+cd react_on_rails_pro
+yarn test
+```
+
+### Debugging NPM JS tests
+
+Example of using ndb to debug a test
+```bash
+ndb $(yarn bin)/jest --runInBand  packages/node-renderer/tests/**/*.test.[jt]s -t 'FriendsAndGuests bundle for commit 1a7fe417'
+```
+Hit F8 and then a debugger statement within the test will get hit.
+
+### Creating new VM tests
+1. copy a server bundle to `packages/node-renderer/tests/fixtures/projects/<project-name>/<commit>`
+2. create a directory with a hash representing the commit of the project
+
+### Async issues with Jest
+Beware that Jest runs multiple test files synchronously, so you can't use the same temporary directory
+between tests. See the file [`packages/node-renderer/tests/helper.ts`](packages/node-renderer/tests/helper.ts) for how we handle this.
+
+### Run most tests and linting
+
+```sh
+cd react_on_rails_pro
+yarn run check
+```
+
+### Starting the Dummy App
+Before running the dummy app,
+you need to generate JavaScript packs in the dummy app project.
+To do this,
+go to `spec/dummy` directory and run the following rake task:
+
+```sh
+bundle exec rake react_on_rails:generate_packs
+```
+
+Since the dummy app requires several processes to run in the background, don't run `rails s` directly.
+Instead, run `foreman start -f Procfile.dev`.
+This requires [the `foreman` gem](https://github.com/ddollar/foreman) to be installed (`gem install foreman`).
+Alternatively, you can use [`overmind`](https://github.com/DarthSim/overmind).
+
+Doing this ensures the asset generation by webpack
+and node renderer run in the background,
+which is essential for the dummy app to work.
+
+If you change the webpack configs, then you need to restart `foreman`.
+
+### RSpec Testing
+
+Before running Ruby tests ensure you have done the following steps in `spec/dummy` directory:
+
+```sh
+# in the root directory
+bundle install
+yarn install
+
+cd spec/dummy
+
+bundle install
+bundle exec rake react_on_rails:generate_packs
+
+yarn install
+
+RAILS_ENV=test bin/shakapacker # to generate assets for test environment
+```
+
+Then in a separate terminal, run the following to run the Node renderer and the test Rails server (only needed for the streaming tests) in the background:
+
+```sh
+# in spec/dummy directory
+yarn run node-renderer
+RAILS_ENV=test bin/dev&
+```
+
+Get back to your main terminal and run:
+
+```sh
+bundle exec rspec
+```
+
+If you run `rspec` at the top level, you'll see this message: `require': cannot load such file -- rails_helper (LoadError)`
+
+After running a test, you can view the coverage results in SimpleCov reports by opening `coverage/index.html`.
+
+### Debugging
+Start the sample app like this for some debug printing:
+
+```sh
+TRACE_REACT_ON_RAILS=true && foreman start -f Procfile.dev
+```
+
+# Releasing
+
+⚠️ **The release process has moved to the repository root.**
+
+React on Rails Pro is now released together with React on Rails using unified versioning.
+All packages (core + pro) are released together with the same version number.
+
+Contact Justin Gordon, [justin@shakacode.com](mailto:justin@shakacode.com) for release permissions.
+
+## Prerequisites
+
+You need authentication for public package registries:
+
+**Public packages (npmjs.org + rubygems.org):**
+- NPM: Run `npm login`
+- RubyGems: Standard credentials via `gem push`
+
+All React on Rails and React on Rails Pro packages are now published publicly to npmjs.org and RubyGems.org.
+
+## Release Command
+
+From the **repository root**, run:
+
+```bash
+# Full release
+cd /path/to/react_on_rails
+rake release[17.0.0]
+
+# Dry run first
+rake release[17.0.0,true]
+
+# Test with Verdaccio
+rake release[17.0.0,false,verdaccio]
+```
+
+For complete documentation, see:
+- [Root Release Documentation](../docs/contributor-info/releasing.md)
+- Run `rake -D release` for inline help

data/Dockerfile

@@ -0,0 +1,63 @@
+# Using Ubuntu Xenial Xerus 16.04 LTS (this is a minimal image with curl and vcs tool pre-installed):
+FROM buildpack-deps:xenial
+
+# Install dependencies.
+RUN \
+  apt-get update \
+  && apt-get install tzdata build-essential \
+     chrpath libssl-dev libxft-dev libfreetype6 \
+     libfreetype6-dev libfontconfig1 libfontconfig1-dev -y
+
+# Install Phantomjs 2.1.1:
+ENV PHANTOM_JS=phantomjs-2.1.1-linux-x86_64
+RUN \
+ wget https://github.com/Medium/phantomjs/releases/download/v2.1.1/$PHANTOM_JS.tar.bz2 \
+ && tar xvjf $PHANTOM_JS.tar.bz2 \
+ && mv $PHANTOM_JS /usr/local/share \
+ && ln -sf /usr/local/share/$PHANTOM_JS/bin/phantomjs /usr/local/bin
+
+# Add new user "renderer":
+RUN adduser renderer
+
+# Switch to created user and run further commands form its home directory.
+# $HOME does not work under ENV directive (https://github.com/moby/moby/issues/2637), so we use custom ENV variable:
+USER renderer
+ENV USER_HOME=/home/renderer
+WORKDIR $USER_HOME
+
+# Install Ruby 2.4.3 from source, set GEM_HOME and expose executable paths:
+ENV RUBY_MAJOR_MINOR=2.4
+ENV RUBY_VERSION=$RUBY_MAJOR_MINOR.3
+RUN \
+  wget http://ftp.ruby-lang.org/pub/ruby/$RUBY_MAJOR_MINOR/ruby-$RUBY_VERSION.tar.gz \
+  && tar -xvzf ruby-$RUBY_VERSION.tar.gz \
+  && rm ruby-$RUBY_VERSION.tar.gz \
+  && cd ruby-$RUBY_VERSION/ \
+  && ./configure --prefix=$USER_HOME \
+  && make \
+  && make install
+ENV RUBY_HOME=$USER_HOME/ruby-$RUBY_VERSION
+ENV GEM_HOME=$RUBY_HOME/gems
+ENV PATH=$PATH:$RUBY_HOME:$RUBY_HOME/bin:$RUBY_HOME/gems/bin:
+
+RUN gem install bundler
+
+ENV NODE_VERSION=8.9.4
+RUN \
+  wget https://nodejs.org/dist/v$NODE_VERSION/node-v$NODE_VERSION-linux-x64.tar.gz \
+  && tar -xvzf node-v$NODE_VERSION-linux-x64.tar.gz \
+  && mv node-v$NODE_VERSION-linux-x64 nodejs \
+  && rm node-v$NODE_VERSION-linux-x64.tar.gz
+ENV PATH=$PATH:$USER_HOME/nodejs/bin:
+
+ENV YARN_VERSION=1.6.0
+RUN \
+  wget https://github.com/yarnpkg/yarn/releases/download/v$YARN_VERSION/yarn-v$YARN_VERSION.tar.gz \
+  && mkdir yarn \
+  && tar -xvzf yarn-v$YARN_VERSION.tar.gz -C yarn \
+  && rm yarn-v$YARN_VERSION.tar.gz
+ENV PATH=$PATH:$USER_HOME/yarn/yarn-v$YARN_VERSION/bin:
+
+# Create a directory for the application and run further commands form there.
+RUN mkdir -p project
+WORKDIR $USER_HOME/project

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem"s dependencies in react_on_rails.gemspec
+gemspec
+
+eval_gemfile File.expand_path("./Gemfile.loader", __dir__)

data/Gemfile.development_dependencies

@@ -0,0 +1,74 @@
+# Keep in sync with https://github.com/shakacode/react_on_rails/blob/master/Gemfile.development_dependencies
+# frozen_string_literal: true
+
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+ruby '3.3.7'
+
+gem "react_on_rails", path: "../"
+
+gem "shakapacker", "9.3.0"
+gem "bootsnap", require: false
+gem "rails", "~> 7.1"
+gem "puma", "~> 6"
+
+# Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
+gem "jbuilder"
+
+gem "pg"
+
+# Turbolinks makes following links in your web application faster. Read more: https://github.com/rails/turbolinks
+gem "turbolinks"
+gem "sqlite3", "~> 1.4"
+gem "uglifier"
+gem "jquery-rails"
+gem "sprockets"
+gem "sass-rails"
+
+gem "net-http"
+gem "net-smtp"
+gem "net-imap"
+
+gem "amazing_print"
+
+group :development do
+  # Access an interactive console on exception pages or by calling 'console' anywhere in the code.
+  gem 'web-console'
+  gem 'listen'
+  # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
+  gem 'spring'
+  gem 'spring-watcher-listen'
+end
+
+group :development, :test do
+  gem 'faker'
+  gem 'graphiql-rails'
+  gem 'pry', '>= 0.14.1' # Console with powerful introspection capabilities
+  # Need to use master of pry-byebug to use latest pry version
+  gem 'pry-byebug', github: 'shakacode/pry-byebug' # Integrates pry with byebug
+  gem 'pry-doc' # Provide MRI Core documentation
+  gem 'pry-rails' # Causes rails console to open pry. `DISABLE_PRY_RAILS=1 rails c` can still open with IRB
+  gem 'pry-theme' # An easy way to customize Pry colors via theme files
+
+  gem "rbs", require: false
+  gem "rubocop", "1.36.0", require: false
+  gem 'rubocop-performance', "1.15.0", require: false
+  gem 'rubocop-rspec', "2.13.2", require: false
+  gem "scss_lint", require: false
+  gem 'fakefs', require: 'fakefs/safe'
+end
+
+group :test do
+  gem "capybara", ">= 3.38.0"
+  gem "capybara-screenshot"
+  gem "coveralls", require: false
+  gem "equivalent-xml"
+  gem "generator_spec"
+  gem "launchy"
+  gem "rspec_junit_formatter"
+  gem "rspec-rails"
+  gem "rspec-retry"
+  gem "selenium-webdriver", "4.9.0"
+  gem "webmock"
+  gem "webdrivers", "5.3.0"
+end

data/Gemfile.loader

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# Load base dependencies
+base_deps = File.read(File.expand_path("./Gemfile.development_dependencies", __dir__))
+
+# Determine which override file to use
+override_deps = if ENV["CI"] == "true" && File.exist?(File.expand_path("./Gemfile.ci", __dir__))
+  # In CI environment, use CI dependencies
+  File.read(File.expand_path("./Gemfile.ci", __dir__))
+elsif File.exist?(File.expand_path("./Gemfile.local", __dir__))
+  # In non-CI environment, use local dependencies if they exist
+  File.read(File.expand_path("./Gemfile.local", __dir__))
+else
+  ""
+end
+
+# Parse override gems
+override_gem_names = override_deps.scan(/^\s*gem\s+["']([^"']+)["']/).flatten
+
+# Remove overridden gems from base dependencies
+override_gem_names.each do |gem_name|
+  base_deps.gsub!(/^\s*gem\s+["']#{gem_name}["'].*$/, '')
+end
+
+# Clean up any blank lines created by removals
+base_deps.gsub!(/^\s*$\n/, '')
+
+# Evaluate the modified base dependencies
+eval(base_deps)
+
+# Evaluate override dependencies if they exist
+eval(override_deps) unless override_deps.empty?