react_for_rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9854257125995e1a483db136b560e75176004af5e83043001be76ea654542f6d
+  data.tar.gz: e200204f2b5466fe98bfa6e5538bf98e80d9b8991977886026cd9735a2aee469
+SHA512:
+  metadata.gz: 6e58856cb17aacedecd3b85cfc7dae710c4fd165d6a31c65c06966beaf54780efa4a29ee68465e22e964a06c03a5db7482a64f09581eb571c29a34c9b6f9c20f
+  data.tar.gz: e118639eafbf219f7d64571bb574ec05708b221653dfa370d817000170247c37718fd28df0b8f979acdb24afdd145f45179e7d4dacb090f1516a312d3b669ccc

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,82 @@
+require: rubocop-rails
+
+AllCops:
+  Exclude:
+    - "lib/tasks/auto_annotate_models.rake"
+    - "db/schema.rb"
+    - "db/data_schema.rb"
+    - "bin/{bundle,rails,rake,setup,spring,webpack,webpack-dev-server,yarn}"
+    - "tmp/**/*"
+    - "config.ru"
+    - "config/boot.rb"
+  NewCops: enable
+  TargetRubyVersion: 3.2.2
+
+Layout/ArrayAlignment:
+  EnforcedStyle: with_first_element
+
+Layout/FirstHashElementIndentation:
+  EnforcedStyle: consistent
+
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - "db/seeds/*.rb"
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Lint/AmbiguousBlockAssociation:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
+Metrics/AbcSize:
+  CountRepeatedAttributes: false
+  Exclude:
+    - "db/migrate/*.rb"
+    - "lib/generators/**/*_generator.rb"
+  AllowedMethods:
+    - required_fields
+  Max: 20
+
+Metrics/BlockLength:
+  Max: 15
+  Exclude:
+    - "config/routes.rb"
+    - "app/**/*.html.arb"
+    - "spec/**/*_spec.rb"
+    - "spec/factories/**/*.rb"
+    - "spec/support/shared_examples/**/*.rb"
+    - "config/environments/*.rb"
+    - "lib/tasks/*.rake"
+  AllowedMethods:
+    - class_methods
+
+Metrics/ClassLength:
+  Max: 200
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    - "lib/generators/**/*_generator.rb"
+  AllowedMethods:
+    - required_fields
+
+Metrics/MethodLength:
+  CountAsOne: ["array", "method_call"]
+  Exclude:
+    - "db/migrate/**/*"
+    - "lib/generators/**/*_generator.rb"
+    - "spec/integration/api/models/**/*"
+  AllowedMethods:
+    - required_fields
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    - "lib/generators/**/*_generator.rb"
+  AllowedMethods:
+    - required_fields
+
+Style/StringLiterals:
+  EnforcedStyle: single_quotes
+  Exclude:
+    - "Gemfile"

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.0.1] - 2024-09-04
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Mateusz Wszeborowski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,30 @@
+# ReactForRails
+
+Lightweight Ruby gem + npm package to add React components to Rails app. Inspired by ReactOnRails.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add react_for_rails
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install react_for_rails
+
+Add npm package to your package.json
+
+    $ yarn add react-for-rails
+
+## Usage
+
+    $ ReactForRails.register({Component1, Component2}) // In your javascript
+    $ react_component('Component1', props: {something: 'Test'}) // In your Rails view
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/wszeborowskimateusz/react_for_rails.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/app/helpers/react_for_rails_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ReactForRailsHelper
+  include ReactForRails::Helper
+end

data/lib/react_for_rails/engine.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module ReactForRails
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/react_for_rails/helper.rb

@@ -0,0 +1,23 @@
+module ReactForRails
+  module Helper
+    def react_component(name, options = {})
+      props = options[:props] || {}
+      props_json = ERB::Util.json_escape(props.is_a?(String) ? props : props.to_json)
+  
+      id = "react-component-#{SecureRandom.hex(8)}"
+  
+      html_options = options[:html_options] || {}
+      html_options[:id] = id
+  
+      content_tag(:div, "", html_options) +
+        content_tag(
+          :script,
+          props_json.html_safe,
+          type: "application/json",
+          "data-dom-id" => id,
+          "data-component-name" => name,
+          class: "custom-react-component-render"
+        )
+    end
+  end
+end

data/lib/react_for_rails/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ReactForRails
+  VERSION = "0.0.1"
+end

data/lib/react_for_rails.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "react_for_rails/version"
+require "react_for_rails/helper"

data/node_modules/.yarn-integrity

@@ -0,0 +1,10 @@
+{
+  "systemParams": "darwin-arm64-93",
+  "modulesFolders": [],
+  "flags": [],
+  "linkedModules": [],
+  "topLevelPatterns": [],
+  "lockfileEntries": {},
+  "files": [],
+  "artifacts": {}
+}

data/node_package/src/ReactForRails.js

@@ -0,0 +1,89 @@
+import React from "react";
+import { createRoot } from "react-dom/client";
+
+const componentsRegistry = {};
+
+export function register(components) {
+  Object.keys(components).forEach((name) => {
+    if (name in componentsRegistry) {
+      console.warn(
+        "Called register for component that is already registered",
+        name
+      );
+    }
+
+    const component = components[name];
+    if (!component) {
+      throw new Error(`Called register with null component named ${name}`);
+    }
+
+    componentsRegistry[name] = component;
+  });
+}
+
+function reactHtmlElements() {
+  return document.getElementsByClassName("custom-react-component-render");
+}
+
+function render(el) {
+  const name = el.getAttribute("data-component-name") || "";
+  const domNodeId = el.getAttribute("data-dom-id") || "";
+  const props = el.textContent !== null ? JSON.parse(el.textContent) : {};
+
+  try {
+    const domNode = document.getElementById(domNodeId);
+    if (domNode) {
+      const Component = componentsRegistry[name];
+
+      if (Component != null) {
+        const ReactElement = React.createElement(Component, props);
+
+        const root = createRoot(domNode);
+        root.render(ReactElement);
+
+        window.reactComponentsRoots.push(root);
+      }
+    }
+  } catch (e) {
+    console.error(e.message);
+    e.message = `Encountered an error while rendering component: ${name}. See above error message.`;
+    throw e;
+  }
+}
+
+function reactPageUnloaded() {
+  for (const root of window.reactComponentsRoots ?? []) {
+    root.unmount();
+  }
+}
+
+function reactPageLoaded() {
+  window.reactComponentsRoots = [];
+
+  const els = reactHtmlElements();
+  for (let i = 0; i < els.length; i += 1) {
+    render(els[i]);
+  }
+}
+
+function onPageReady(callback) {
+  if (document.readyState === "complete") {
+    callback();
+  } else {
+    document.addEventListener(
+      "readystatechange",
+      function onReadyStateChange() {
+        onPageReady(callback);
+        document.removeEventListener("readystatechange", onReadyStateChange);
+      }
+    );
+  }
+}
+
+function onPageLoaded() {
+  document.addEventListener("turbolinks:before-render", reactPageUnloaded);
+  document.addEventListener("turbolinks:render", reactPageLoaded);
+  reactPageLoaded();
+}
+
+onPageReady(onPageLoaded);

data/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "react-for-rails",
+  "version": "0.0.1",
+  "description": "npm package for ReactForRails ruby gem",
+  "main": "node_package/src/ReactForRails.js",
+  "files": [
+    "node_package/src"
+  ],
+  "peerDependencies": {
+    "react": ">= 18",
+    "react-dom": ">= 18"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wszeborowskimateusz/react-for-rails.git"
+  },
+  "keywords": [
+    "react",
+    "rails",
+    "ruby"
+  ],
+  "author": "wszeborowskimateusz@gmail.com",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/wszeborowskimateusz/react-for-rails/issues"
+  },
+  "homepage": "https://github.com/wszeborowskimateusz/react-for-rails#readme"
+}

data/sig/react_for_rails.rbs

@@ -0,0 +1,4 @@
+module ReactForRails
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

data/yarn.lock

@@ -0,0 +1,4 @@
+# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
+# yarn lockfile v1
+
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: react_for_rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mateusz Wszeborowski
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-05 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- wszeborowskimateusz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/helpers/react_for_rails_helper.rb
+- lib/react_for_rails.rb
+- lib/react_for_rails/engine.rb
+- lib/react_for_rails/helper.rb
+- lib/react_for_rails/version.rb
+- node_modules/.yarn-integrity
+- node_package/src/ReactForRails.js
+- package.json
+- sig/react_for_rails.rbs
+- yarn.lock
+homepage: https://github.com/wszeborowskimateusz/react-for-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wszeborowskimateusz/react-for-rails
+  source_code_uri: https://github.com/wszeborowskimateusz/react-for-rails
+  changelog_uri: https://github.com/wszeborowskimateusz/react-for-rails/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Enables using React components in Rails apps. Inspired by react_on_rails
+test_files: []