react_on_rails 11.0.5 → 13.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1e2e9cfdc5d161ab3706f779c18c8ce1a166b066
-  data.tar.gz: 6211ecc33d60cccc7d385ddcc7550a31f1502d43
+SHA256:
+  metadata.gz: 545e97728f6633e1adc5091f8e1a72c377ce8d8c809ca8b6378c0b1bffe62c7d
+  data.tar.gz: 06a83f533ee9518518afeb63a31191861298f92a2ec36b876914347de0a0f960
 SHA512:
-  metadata.gz: 3cac9f496b6163da14528c717ef9c6a87ad15d11f87cab027d3af08ebe48121345f62264cd42dcd2cb64e847a38bc07a2ccb6b5951a98b9ca4737414e1a5afe2
-  data.tar.gz: e692554e9375d8c789894624c86639fcc442314ccc024050fca0ee4e371a7f05e047188bed0cf24f6d32497b7ee454ad9cba07fc1d062821c720a0274d4ddd50
+  metadata.gz: 9bc25f3009cc3775d59d456e2009fe3c7f692a13268bf559a1059547c8c56998d8c0c2856a9b8e43079afa6ffa3705a6c1f613ecf9864ae6b3cc0697c5f46ac7
+  data.tar.gz: 860f4fc51d1bef3f7cc4599335062881681b3acd70e6f1104ecbc24e128e175ddb0b3aa44ee6c2b0d36c2596c6d118eb1ded0ec92fcab8781efa2233c2cd3875

data/.circleci/config.yml

@@ -0,0 +1,338 @@
+# CircleCI is not longer in use by this repository & this file is now for reference only.
+version: 2
+
+aliases:
+  - &docker-image
+    - image: circleci/ruby:2.7-node-browsers
+
+  # Print critical data and executables versions.
+  - &print-system-info
+    name: Print system information
+    command: |
+      echo "Linux release: "; cat /etc/issue
+      echo "Current user: "; whoami
+      echo "Current directory: "; pwd
+      echo "Ruby version: "; ruby -v
+      echo "Node version: "; node -v
+      echo "Yarn version: "; yarn --version
+      echo "Bundler version: "; bundle --version
+  - &lint-js
+    name: Linting of JS
+    command: yarn start lint
+
+  - &lint-ruby
+    name: Linting of Ruby
+    command: bundle exec rubocop
+
+  - &format
+    name: Check formatting
+    command: yarn start format.listDifferent
+
+  # Install/update Node modules for renderer package unless existing set of modules is satisfying Yarn.
+  - &install-package-node-modules
+    name: Install Node modules with Yarn for renderer package
+    command: |
+      sudo yarn global add yalc
+      yarn install --no-progress --no-emoji
+      yarn run eslint -v
+
+  # Install/update Node modules for dummy app unless existing set of modules is satisfying Yarn.
+  - &install-dummy-app-node-modules
+    name: Install Node modules with Yarn for dummy app
+    command: cd spec/dummy && yarn install --no-progress --no-emoji
+
+  # Setup yarn links for react-on-rails
+  - &install-yalc-publish
+    name: yalc publish for react-on-rails
+    command: yalc publish
+
+  - &install-yalc-add-react-on-rails
+    name: yalc add react-on-rails
+    command: cd spec/dummy && yalc add react-on-rails
+
+  # Install ruby gems unless existing set of gems is satisfying bundler.
+  - &install-dummy-app-ruby-gems
+    name: Install Ruby Gems for dummy app
+    command: |
+      gem install bundler:2.4.17
+      echo "Bundler version: "; bundle --version
+      cd spec/dummy && bundle lock --add-platform 'x86_64-linux' && bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
+
+  # Install ruby gems unless existing set of gems is satisfying bundler.
+  - &install-package-ruby-gems
+    name: Install Ruby Gems for package
+    command: |
+      gem install bundler:2.4.17
+      echo "Bundler version: "; bundle --version
+      bundle lock --add-platform 'x86_64-linux'
+      bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3
+
+  # Restore node_modules dir from cache using yarn.lock checksum as a key.
+  - &restore-package-node-modules-cache
+    name: Restore cached node_modules directory
+    keys:
+      - v5-package-node-modules-cache-{{ checksum "yarn.lock" }}
+
+  # Restore spec/dummy/node_modules dir from cache using yarn.lock checksum as a key.
+  - &restore-dummy-app-node-modules-cache
+    name: Restore cached spec/dummy/node_modules directory
+    keys:
+      - v5-dummy-app-node-modules-cache-{{ checksum "spec/dummy/yarn.lock" }}
+
+  # Restore vendor/bundle dir from cache using Gemfile.lock checksum as a key.
+  - &restore-dummy-app-gem-cache
+    name: Restore cached Ruby Gems for dummy app
+    keys:
+      - v5-dummy-app-gem-cache-{{ checksum "spec/dummy/Gemfile.lock" }}
+
+  # Restore vendor/bundle dir from cache using react_on_rails.gemspec checksum as a key.
+  - &restore-package-gem-cache
+    name: Restore cached Ruby Gems for package
+    keys:
+      - v5-package-app-gem-cache-{{ checksum "react_on_rails.gemspec" }}
+
+    # NOTE: Sometimes CI generated docker images are not updated in time to keep up with the minimum required
+    # by chromedriver versions of Chrome. Just bump here Chrome version if chromedriver raises errors
+  - &install-latest-chrome
+    name: Ensure minimum required Chrome version
+    command: |
+      echo -e "Installed $(google-chrome --version)\n"
+      MINIMUM_REQUIRED_CHROME_VERSION=75
+      INSTALLED_CHROME_MAJOR_VERSION="$(google-chrome --version | tr ' .' '\t' | cut -f3)"
+      if [[ $INSTALLED_CHROME_MAJOR_VERSION < $MINIMUM_REQUIRED_CHROME_VERSION ]]; then
+        wget -q -O - https://dl.google.com/linux/linux_signing_key.pub | sudo apt-key add -
+        sudo sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list'
+        sudo apt-get update
+        sudo apt-get install google-chrome-stable
+        echo -e "\nInstalled $(google-chrome --version)"
+      fi
+
+jobs:
+  # Lint all
+  lint-js-and-ruby:
+    docker: *docker-image
+    steps:
+      - checkout
+      - run: *print-system-info
+      - restore_cache: *restore-package-node-modules-cache
+      - restore_cache: *restore-package-gem-cache
+      - run: *install-package-ruby-gems
+      - run: *lint-ruby
+      - run: *lint-js
+      - run: *format
+
+  prettier:
+    docker: *docker-image
+    parallelism: 1
+    steps:
+      - checkout
+      - restore_cache: *restore-package-node-modules-cache
+      - run:
+          name: prettier
+          command: yarn start format.listDifferent
+
+  # Install Node modules for Renderer package with Yarn and save them to chache.
+  install-package-node-packages:
+    docker: *docker-image
+    steps:
+      - checkout
+      - run: *print-system-info
+      - restore_cache: *restore-package-node-modules-cache
+      - run: *install-package-node-modules
+      - save_cache:
+          name: Save root node_modules to cache
+          key: v5-package-node-modules-cache-{{ checksum "yarn.lock" }}
+          paths:
+            - node_modules
+
+
+  # Install Node modules for dummy app with Yarn and save them to cache.
+  install-dummy-app-node-packages:
+    docker: *docker-image
+    steps:
+      - checkout
+      - run: *print-system-info
+      - restore_cache: *restore-dummy-app-node-modules-cache
+      - run: *install-package-node-modules
+      - run: *install-yalc-publish
+      - run: *install-yalc-add-react-on-rails
+      - run: *install-dummy-app-node-modules
+      - save_cache:
+          name: Save spec/dummy/node_modules to cache
+          key: v5-dummy-app-node-modules-cache-{{ checksum "spec/dummy/yarn.lock" }}
+          paths:
+            - spec/dummy/node_modules
+            - spec/dummy/node_modules
+
+  # Install Ruby gems for package with Bundler and save them to cache.
+  install-package-ruby-gems:
+    docker: *docker-image
+    steps:
+      - checkout
+      - run: *print-system-info
+      - restore_cache: *restore-package-gem-cache
+      - run: *install-package-ruby-gems
+      - save_cache:
+          name: Save dummy app ruby gems to cache
+          key: v5-package-app-gem-cache-{{ checksum "react_on_rails.gemspec" }}
+          paths:
+            - vendor/bundle
+
+  # Install Ruby gems for dummy app with Bundler and save them to cache.
+  install-dummy-app-ruby-gems:
+    docker: *docker-image
+    steps:
+      - checkout
+      - run: *print-system-info
+      - restore_cache: *restore-dummy-app-gem-cache
+      - run: *install-dummy-app-ruby-gems
+      - save_cache:
+          name: Save dummy app ruby gems to cache
+          key: v5-dummy-app-gem-cache-{{ checksum "spec/dummy/Gemfile.lock" }}
+          paths:
+            - spec/dummy/vendor/bundle
+
+  # Build client and server bundles for dummy app with Webpack and save them to cache.
+  # NOTE: keeping around this cache in case we have multiple rspec suites in the future to tests
+  # different node renderers.
+  build-dummy-app-webpack-test-bundles:
+    docker: *docker-image
+    steps:
+      - checkout
+      - run: *print-system-info
+      - run: *install-package-node-modules
+      - run: *install-yalc-publish
+      - restore_cache: *restore-dummy-app-node-modules-cache
+      - run: *install-yalc-add-react-on-rails
+      - run: *install-dummy-app-node-modules
+      - run: *install-dummy-app-ruby-gems
+      - run:
+          name: generate file system-based packs
+          command: cd spec/dummy && bundle exec rake react_on_rails:generate_packs
+      - run:
+          name: Build test bundles for dummy app
+          command: cd spec/dummy && yarn run build:test
+      - save_cache:
+          name: Save test webpack bundles to cache (for build number checksum used by rspec job)
+          key: v5-dummy-app-webpack-bundle-{{ .Revision }}
+          paths:
+            - spec/dummy/public/webpack
+  # Run JS unit tests for Renderer package.
+  package-js-tests:
+    docker: *docker-image
+    steps:
+      - checkout
+      - run: *print-system-info
+      - restore_cache: *restore-package-node-modules-cache
+      - run: *install-package-node-modules
+      - run:
+          name: Run JS unit tests for Renderer package
+          command: yarn test
+
+  rspec-package-specs:
+    docker: *docker-image
+    steps:
+      - checkout
+      - run: *print-system-info
+      - restore_cache: *restore-package-gem-cache
+      - run: *install-package-ruby-gems
+      - run:
+          name: Run rspec tests
+          command: |
+            bundle exec rspec spec/react_on_rails
+      - store_test_results:
+          path: ~/rspec
+      - store_artifacts:
+          path: log/test.log
+
+  main:
+    docker: *docker-image
+    steps:
+      - checkout
+      - run: *print-system-info
+      - restore_cache: *restore-package-gem-cache
+      - restore_cache: *restore-dummy-app-gem-cache
+      - restore_cache:
+          name: Restore cached webpack bundles for dummy app
+          key: v5-dummy-app-webpack-bundle-{{ .Revision }}
+      - restore_cache: *restore-dummy-app-node-modules-cache
+      - restore_cache: *restore-package-node-modules-cache
+      - run: *install-package-node-modules
+      - run: *install-yalc-publish
+      - run: *install-yalc-add-react-on-rails
+      - run: *install-package-ruby-gems
+      - run: *install-dummy-app-ruby-gems
+      - run: *install-latest-chrome
+      - run:
+          name: Touch webpack bundles
+          command: touch spec/dummy/public/webpack/test/*
+      - run:
+          name: Install yalc globally
+          command: sudo yarn global add yalc
+      - run:
+          name: Prep for CI
+          # TODO -- need to leverage Circle CI containers
+          command: |
+            bundle exec rake prepare_for_ci
+      - run:
+          name: Main CI
+          # TODO -- need to leverage Circle CI containers
+          command: |
+            bundle exec rake run_rspec:all_dummy
+      # The following step will run only if the main job is finished successfully.
+      # Build hook is triggered by curl command described here https://docs.netlify.com/configure-builds/build-hooks/
+      # NETLIFY_HOOK is an environment variable on CircleCI to keep sensitive data outside the repo
+      - run:
+          name: Deploy SC website
+          command: |
+            if [ $CIRCLE_BRANCH = "master" ]; then
+              curl -X POST -d '{}' ${NETLIFY_HOOK}
+            fi
+          when: on_success
+      - store_test_results:
+          path: ~/rspec
+      - store_artifacts:
+          path: spec/dummy/tmp/capybara
+      - store_artifacts:
+          path: spec/dummy/tmp/screenshots
+      - store_artifacts:
+          path: spec/dummy/log/test.log
+      - store_artifacts:
+          path: spec/dummy/yarn-error.log
+
+workflows:
+  version: 2
+  build-and-test:
+    jobs:
+      - install-package-node-packages
+      - install-package-ruby-gems
+      - install-dummy-app-node-packages
+      - install-dummy-app-ruby-gems
+      - lint-js-and-ruby:
+          requires:
+            - install-package-node-packages
+            - install-package-ruby-gems
+      - prettier:
+          filters:
+            branches:
+              ignore: master
+          requires:
+            - install-package-node-packages
+      - build-dummy-app-webpack-test-bundles:
+          requires:
+            - install-dummy-app-node-packages
+            - install-dummy-app-ruby-gems
+      - package-js-tests:
+          requires:
+            - install-package-node-packages
+      - rspec-package-specs:
+          requires:
+            - install-package-ruby-gems
+            - build-dummy-app-webpack-test-bundles
+            - install-dummy-app-ruby-gems
+      - main:
+          requires:
+            - install-package-ruby-gems
+            - install-dummy-app-ruby-gems
+            - install-package-node-packages
+            - build-dummy-app-webpack-test-bundles

data/.eslintignore

@@ -2,7 +2,6 @@ node_modules
 coverage
 spec/react_on_rails/dummy-for-generators
 spec/dummy
-spec/dummy_no_webpacker
 node_package/lib/
 node_package/tests/node_modules
 node_package/webpack.config.js
@@ -14,3 +13,5 @@ node_package/webpack.config.js
 **/coverage/**
 **/cable.js
 **/public/packs*/*
+gen-examples
+bundle/

data/.eslintrc

@@ -1,8 +1,10 @@
----
-extends: eslint-config-shakacode
+extends:
+  - eslint-config-shakacode
+  - prettier
+  - prettier/react
 
 plugins:
-  - react
+  - prettier
 
 globals:
   __DEBUG_SERVER_ERRORS__: true
@@ -12,9 +14,33 @@ env:
   browser: true
   node: true
   mocha: true
+  jest: true
+
+overrides:
+  - files: ["**/*.ts", "**/*.tsx"]
+    parser: "@typescript-eslint/parser"
+    parserOptions:
+      ecmaVersion: 2018
+      sourceType: module
+      project: "./tsconfig.json"
+    extends:
+      - eslint:recommended
+      - plugin:@typescript-eslint/eslint-recommended
+      - plugin:@typescript-eslint/recommended
+    plugins:
+      - "@typescript-eslint"
+    rules:
+      "@typescript-eslint/no-namespace": 0
+      "@typescript-eslint/no-shadow": ["error"]
 
 rules:
+  no-shadow: 0
   no-console: 0
+  function-paren-newline: 0
+  object-curly-newline: 0
+  no-restricted-syntax: ["error", "SequenceExpression"]
+  # https://stackoverflow.com/a/59268871/5241481
+  import/extensions: ['error', 'ignorePackages', {"js": 'never',"ts": "never"}]
 
   # https://github.com/benmosher/eslint-plugin-import/issues/340
   import/no-extraneous-dependencies: 0
@@ -22,3 +48,6 @@ rules:
 settings:
   import/core-modules:
     - react-redux
+  import/resolver:
+    node:
+      extensions: [".js", ".ts", ".d.ts"]

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: [shakacode]

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,23 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+A bug is a crash or incorrect behavior. If you have a debugging or troubleshooting question, please open [a discussion](https://github.com/shakacode/react_on_rails/discussions).
+
+## Environment
+
+1. Ruby version:
+2. Rails version:
+3. Shakapacker/Webpacker version:
+4. React on Rails version:
+
+## Expected behavior
+
+## Actual behavior
+
+## Small, reproducible repo

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+### Summary
+
+_Remove this paragraph and provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together._
+
+### Pull Request checklist
+_Remove this line after checking all the items here. If the item is not applicable to the PR, both check it out and wrap it by `~`._
+
+- [ ] Add/update test to cover these changes
+- [ ] Update documentation
+- [ ] Update CHANGELOG file  
+  _Add the CHANGELOG entry at the top of the file._
+
+### Other Information
+
+_Remove this paragraph and mention any other important and relevant information such as benchmarks._
+

data/.github/workflows/lint-js-and-ruby.yml

@@ -0,0 +1,54 @@
+name: Lint JS and Ruby
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    strategy:
+      matrix:
+        ruby: [2.7]
+        node: [14]
+    runs-on: ubuntu-22.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler: 2.4.17
+    - name: Setup Node
+      uses: actions/setup-node@v2-beta
+      with:
+        node-version: ${{ matrix.node }}
+    - name: Print system information
+      run: |
+        echo "Linux release: "; cat /etc/issue
+        echo "Current user: "; whoami
+        echo "Current directory: "; pwd
+        echo "Ruby version: "; ruby -v
+        echo "Node version: "; node -v
+        echo "Yarn version: "; yarn --version
+        echo "Bundler version: "; bundle --version
+    - name: Save root node_modules to cache
+      uses: actions/cache@v2
+      with:
+        path: node_modules
+        key: v5-package-node-modules-cache-${{ hashFiles('yarn.lock') }}
+    - name: Save root ruby gems to cache
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: v5-package-app-gem-cache-${{ hashFiles('react_on_rails.gemspec') }}
+    - name: Install Node modules with Yarn for renderer package
+      run: |
+        yarn install --no-progress --no-emoji
+        yarn run eslint -v
+        sudo yarn global add yalc
+    - name: Install Ruby Gems for package
+      run: bundle check --path=vendor/bundle || bundle _2.4.17_ install --path=vendor/bundle --jobs=4 --retry=3
+    - name: Linting of Ruby
+      run: bundle exec rubocop
+    - name: Linting of JS
+      run: yarn start lint
+    - name: Check formatting
+      run: yarn start format.listDifferent