rails_react_scaffold 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 18b1352090b47f7482237fffaef270b990c9d7d754c0da2e205430c54edd5541
+  data.tar.gz: 44131cc992121147161ec94c2e9a958ad6bd25a896eb1482c93baa8fc61659d9
+SHA512:
+  metadata.gz: bdd59ca44d2e9d4f63eddde9194608961d4fd194c15e7bd0a87d4705ae7442a11fd05abdab4af62c68c328985a4da75ca5cc199de046f54e1676d9a16b88f712
+  data.tar.gz: 27351ace6f4d03668a1821844441a4aac877f8dd3412d218339a2b11a13ffc0087e2d91f67065e998896ee6523795b3c1de7550ee397654e3929f87c0926415d

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-02-17
+
+- Initial release
+  - Support for jQuery and Fetch AJAX engines
+  - Support for RABL JSON engine

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at casey.li@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in rails_react_scaffold.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Casey Li
+
+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,75 @@
+# Rails React Scaffold
+
+This gem will allow you create scaffold for Ruby on Rails applications that use React as their front end. It basically overrides the default Views in the rails scaffold generator to generate a mount point HTML file and an associated React component for all the default Rails views (index, show, new, edit).
+
+**Note: This gem is in its early days of development and right now only supports generating the views. Thus you have to have an existing model to use this. In the future, we will program an entire scaffold generator.**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_react_scaffold'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails_react_scaffold
+
+## Usage
+
+At this point, this generator only generates VIEWS and assumes a model is in place. So at this point, use the standard model generator that comes pre-built with Rails or code your own model, then use this generator.
+
+### Basic Usage
+
+#### Step 1
+
+Generate your Rails model however you want.
+
+#### Step 2
+
+```
+rails g rails_react_scaffold:controller MODEL_NAME
+```
+
+### Options
+
+|Option|Type|Description|Default|
+|------|----|-----------|-------|
+|`component_dir`|string|The directory where the generated components will be placed|`app/javascript/components`|
+|`component_ext`|string|The file extension to use for generated react components. (js, jsx)|`js`|
+|`ajax_engine`|string|What you want to use to make your Ajax calls (fetch, jQuery, axios) **axios coming soon**|`fetch`|
+|`json_engine`|string|What to use to generate your JSON responses (jbuiler, rabl) **jbuilder coming soon**|`jbuilder`|
+|`use_cancan`|boolean|If you want to load and authorize resources through CanCan(Can).|`false`|
+|`use_remount`|boolean|**Coming soon** If you want to use Remount to mount your components.|`false`|
+|`use_webpacker`|boolean|If you want to use javascript_pack_tag to include your JS in your ERB files.|`false`|
+|`use_webpacker_chunks`|boolean|If you want use javascript_packs_with_chunks_tag to include your JS in your ERB files.|`false`|
+
+
+### Example Usage
+
+```
+rails g rails_react_scaffold:controller Book --component_dir app/javascript/src --use_cancan --ajax_engine jquery --use_webpacker_chunks
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails_react_scaffold. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rails_react_scaffold/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RailsReactScaffold project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rails_react_scaffold/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/generators/rails_react_scaffold/controller_generator.rb

@@ -0,0 +1,53 @@
+require 'generators/rails_react_scaffold/generator_helpers'
+
+module RailsReactScaffold
+  module Generators
+    # Custom scaffolding generator
+    class ControllerGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::ResourceHelpers
+      include RailsReactScaffold::Generators::GeneratorHelpers
+
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc "Generates views for the model with the given NAME."
+
+      class_option :component_dir, type: :string, default: "app/javascript/components", desc: "Specify components directory"
+      class_option :component_ext, type: :string, default: "js", desc: "Extension to use for generated React components. (e.g. js vs jsx)"
+      class_option :ajax_engine, type: :string, default: "fetch", desc: "What you wan to use for your Ajax calls (fetch, jquery, axios)"
+      class_option :json_engine, type: :string, default: "jbuilder", desc: "What you would like to use to render your JSON (jbuilder, rabl)"
+      class_option :use_remount, type: :boolean, default: false, desc: "Use Remount for mounting components"
+      class_option :use_webpacker, type: :boolean, default: false, desc: "Use Webpacker for JS Bundling"
+      class_option :use_webpacker_chunks, type: :boolean, default: false, desc: "Use chunks with Webpacker for JS Bundling"
+      class_option :use_cancan, type: :boolean, default: false, desc: "Use CanCan(Can) to load and authorize resources"
+
+      def add_routes
+        routes_string = "resources :#{plural_name}"
+        route routes_string
+      end
+
+      def copy_controller_and_spec_files
+        template "controller.rb", File.join("app/controllers", "#{controller_file_name}_controller.rb")
+      end
+
+      def copy_view_files
+        views_directory_path = File.join("app/views", controller_file_path)
+        react_components_directory_path = File.join(options['component_dir'], controller_file_path)
+        empty_directory views_directory_path
+
+        view_files.each do |file_name|
+          template "views/#{file_name}.html.erb", File.join(views_directory_path, "#{file_name}.html.erb")
+        end
+
+        json_files.each do |file_name|
+          template "views/#{file_name}.json.#{options[:json_engine]}", File.join(views_directory_path, "#{file_name}.json.#{options[:json_engine]}")
+        end
+        
+        component_files.each do |suffix|
+          extension = options[:component_ext]
+          template "react_components/#{suffix}.js.erb", File.join(react_components_directory_path, "#{plural_name}_#{suffix}.#{extension}")
+        end
+      end
+      
+    end
+  end
+end

data/lib/generators/rails_react_scaffold/generator_helpers.rb

@@ -0,0 +1,95 @@
+module RailsReactScaffold
+  module Generators
+    # Some helpers for generating scaffolding
+    module GeneratorHelpers
+      attr_accessor :options, :viewable_attributes, :editable_attributes
+
+      private
+
+      # def show_action?
+      #   !options['skip_show']
+      # end
+
+      def model_exists?
+        File.exist?("#{Rails.root}/app/models/#{singular_name}.rb")
+      end
+
+      def model_columns_for_viewable_attributes
+        class_name.constantize.columns
+      end
+
+      def viewable_attributes
+        viewable_attributes ||= if model_exists?
+          model_columns_for_viewable_attributes.map do |column|
+              Rails::Generators::GeneratedAttribute.new(column.name.to_s, column.type.to_s)
+            end
+          else
+            []
+          end
+      end
+
+      def model_columns_for_editable_attributes
+        class_name.constantize.columns.reject do |column|
+          column.name.to_s =~ /^(id|created_at|updated_at)$/
+        end
+      end
+      
+
+      def editable_attributes
+        editable_attributes ||= if model_exists?
+                        model_columns_for_editable_attributes.map do |column|
+                            Rails::Generators::GeneratedAttribute.new(column.name.to_s, column.type.to_s)
+                          end
+                        else
+                          []
+                        end
+      end
+
+      # def field_to_check_update
+      #   @field_update_in_spec ||= if text_field = editable_attributes.find { |attr| attr.type == 'string' }
+      #                               { name: text_field.name, old_value: "'Just Text'", new_value: "'New Text'" }
+      #                             elsif numeric_field = editable_attributes.find { |attr| attr.type == 'integer' }
+      #                               { name: numeric_field.name, old_value: 1, new_value: 2 }
+      #                             else
+      #                               false
+      #                             end
+      # end
+
+      # def all_actions
+      #   actions = %w(index new create edit update destroy)
+      #   actions << 'show' if show_action?
+      #   actions
+      # end
+
+      def view_files
+        actions = %w(index show new edit)
+        actions
+      end
+
+      def json_files
+        actions = %w(index show)
+        actions
+      end
+
+      def component_files
+        suffixes = %w(index_page show_page new_page edit_page form)
+        suffixes
+      end
+      
+
+      # def controller_methods(dir_name)
+      #   all_actions.map do |action|
+      #     read_template("#{dir_name}/#{action}.rb")
+      #   end.join("\n").strip
+      # end
+
+      # def source_path(relative_path)
+      #   File.expand_path(File.join("../templates/", relative_path), __FILE__)
+      # end
+
+      # def read_template(relative_path)
+      #   ERB.new(File.read(source_path(relative_path)), nil, '-').result(binding)
+      # end
+    end
+  end
+end

data/lib/generators/rails_react_scaffold/templates/controller.rb

@@ -0,0 +1,76 @@
+class <%= controller_class_name %>Controller < ApplicationController
+  <%- if options[:use_cancan] -%>
+  load_and_authorize_resource
+  <%- else -%>
+  before_action :set_<%= singular_name %>, only: [:show, :edit, :destroy]
+  <%- end -%>
+
+  def index
+    <%- if !options[:use_cancan] -%>
+    @<%= plural_name %> = <%= class_name %>.all
+
+    <%- end -%>
+    respond_to do |format|
+      format.html
+      format.json
+    end
+  end
+
+  def show
+    respond_to do |format|
+      format.html
+      format.json
+    end
+  end
+
+  def new
+  end
+
+  def create
+    <%- if !options[:use_cancan] -%>
+    @<%= singular_name %> = <%= class_name %>.new(<%= singular_name %>_params)
+    
+    <%- end -%>
+    respond_to do |format|
+      if @<%= singular_name %>.save
+        format.json { render :show, status: :created, location: @<%= singular_name %> }
+      else
+        format.json { render json: @<%= singular_name %>.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  def edit
+    
+  end
+
+  def update
+    respond_to do |format|
+      if @<%= singular_name %>.update(<%= singular_name %>_params)
+        format.json { render :show, status: :ok, location: @<%= singular_name %> }
+      else
+        format.json { render json: @<%= singular_name %>.errors, status: :unprocessable_entity }
+      end
+    end
+  end
+
+  def destroy
+    @<%= singular_name %>.destroy
+
+    respond_to do |format|
+      format.json { head :no_content }
+    end
+  end
+
+  private
+
+    <%- if !options[:use_cancan] -%>
+    def set_<%= singular_name %>
+      @<%= singular_name %> = <%= class_name %>.find params[:id]
+    end
+    <%- end -%>
+
+    def <%= singular_name %>_params
+      params.require(:<%= singular_name %>).permit(<%= editable_attributes.map{|attribute| ":#{attribute.name}"}.join(", ") %>)
+    end
+end

data/lib/generators/rails_react_scaffold/templates/react_components/edit_page.js.erb

@@ -0,0 +1,23 @@
+import React from 'react';
+import ReactDOM from 'react-dom';
+import <%= plural_name.camelize %>Form from './<%= plural_name %>_form';
+
+const <%= plural_name.camelize %>EditPage = ({ <%= singular_name.camelize(:lower)%>Id }) => (
+  <div>
+    <h1>Editing <%= singular_name %> {<%= singular_name.camelize(:lower)%>Id}</h1>
+    <<%= plural_name.camelize %>Form <%= singular_name.camelize(:lower) %>Id={<%= singular_name.camelize(:lower)%>Id} />
+  </div>
+);
+
+<% if options['use_remount'] %>
+/* REMOUNT COMING SOON */
+<% else %>
+document.addEventListener('DOMContentLoaded', () => {
+  const mountPoint = document.getElementById('<%= "#{plural_name}-edit-page-mount-point" %>');
+  
+  if(mountPoint) {
+    const <%= singular_name %>Id = parseInt(mountPoint.dataset.<%= singular_name.camelize(:lower) %>Id);
+    ReactDOM.render(<<%= "#{plural_name.camelize}EditPage" %> <%= singular_name %>Id={<%= singular_name %>Id} />, mountPoint);
+  }
+});
+<% end %>

data/lib/generators/rails_react_scaffold/templates/react_components/form.js.erb

@@ -0,0 +1,130 @@
+import React from 'react';
+import { useState, useEffect } from 'react';
+
+const <%= plural_name.camelize %>Form = ({ <%= singular_name.camelize(:lower)%>Id }) => {
+
+  const [loading, setLoading] = useState(true);
+  const [submitting, setSubmitting] = useState(false);
+  <%- editable_attributes.each do |attribute| -%>
+  const [<%= attribute.name.camelize(:lower) %>, <%= "set#{attribute.name.camelize}" %>] = useState();
+  <%- end -%>
+
+  const load<%= singular_name.camelize %> = () => {
+    if (<%= singular_name.camelize(:lower)%>Id) {
+      const url = `/<%= plural_name %>/${<%= singular_name.camelize(:lower)%>Id}`;
+
+      <%- if options[:ajax_engine] == 'fetch' -%>
+      fetch(url, { headers: { Accept: 'application/json' } })
+      .then((response) => {
+        if (response.status === 200) {
+          return response.json();
+        }
+        return undefined;
+      })
+      .then((responseJson) => {
+        if (responseJson) {
+          <%- editable_attributes.each do |attribute| -%>
+          <%= "set#{attribute.name.camelize}" %>(responseJson.<%= attribute.name %>);
+          <%- end -%>
+        }
+        setLoading(false);
+      });
+      <%- end -%>
+      <%- if options[:ajax_engine] == 'jquery' -%>
+      $.getJSON(url, (result) => {
+        <%- editable_attributes.each do |attribute| -%>
+        <%= "set#{attribute.name.camelize}" %>(result.<%= attribute.name %>);
+        <%- end -%>
+        setLoading(false);
+      });
+      <%- end -%>
+      <%- if options[:ajax_engine] == 'axios' -%>
+      /* Axios coming soon */
+      <%- end -%>
+    } else {
+      setLoading(false);
+    }
+  }
+
+  const handleSubmit = () => {
+    setSubmitting(true);
+
+    let method = 'POST';
+    let url = '/<%= plural_name %>';
+    let redirectUrl = '/<%= plural_name%>';
+    const data = {
+      <%= singular_name %>: {
+        <%- editable_attributes.each do |attribute| -%>
+        <%= attribute.name %>: <%= attribute.name.camelize(:lower) %>,
+        <%- end -%>
+      }
+    };
+
+    if (<%= singular_name.camelize(:lower)%>Id) {
+      method = 'PUT';
+      url = `/<%= plural_name %>/${<%= singular_name.camelize(:lower)%>Id}`;
+      redirectUrl = `/<%= plural_name %>/${<%= singular_name.camelize(:lower)%>Id}`;
+    }
+
+    <%- if options[:ajax_engine] == 'fetch' -%>
+    const csrfToken = document.querySelector("[name='csrf-token']").content;
+
+    fetch(url, {
+      method,
+      headers: {
+        'Content-Type': 'application/json',
+        Accept: 'application/json',
+        'X-CSRF-Token': csrfToken,
+      },
+      body: JSON.stringify(data),
+    }).then((response) => {
+      if (response.status === 200 || response.status === 201) {
+        window.location.href = redirectUrl;
+      }
+    });
+    <%- end -%>
+    <%- if options[:ajax_engine] == 'jquery' -%>
+
+    $.ajax({
+      url,
+      method,
+      data,
+      dataType: 'JSON',
+      success: () => {
+        window.location.href = redirectUrl;
+      },
+      error: () => {}
+    });
+    <%- end -%>
+    <%- if options[:ajax_engine] == 'axios' -%>
+    /* Axios coming soon */
+    <%- end -%>
+  };
+
+  useEffect(() => {
+    load<%= singular_name.camelize %>();
+  }, []);
+
+  return (
+    <div>
+      {
+        loading ?
+          "Loading.."
+        :
+        <>
+          <%- editable_attributes.each do |attribute| -%>
+          <div className="field">
+            <label><%= attribute.name.titleize %></label>
+            <input type="text" value={<%= attribute.name.camelize(:lower) %>} onChange={(e) => set<%= attribute.name.camelize %>(e.target.value)} />
+          </div>
+          <%- end -%>
+          <div className="actions">
+            <input type="submit" value={submitting ? 'Submitting...' : 'Submit'} onClick={handleSubmit} />
+          </div>
+        </>
+      }
+    </div>
+  );
+};
+
+export default <%= plural_name.camelize %>Form;

data/lib/generators/rails_react_scaffold/templates/react_components/index_page.js.erb

@@ -0,0 +1,121 @@
+import React from 'react';
+import { useState, useEffect } from 'react';
+import ReactDOM from 'react-dom';
+
+const <%= plural_name.camelize %>IndexPage = () => {
+
+  const [loading, setLoading] = useState(false);
+  const [<%= plural_name.camelize(:lower) %>, set<%= plural_name.camelize %>] = useState([]);
+
+  const load<%= plural_name.camelize%> = () => {
+    setLoading(true);
+    const url = '/<%= plural_name %>';
+    <%- if options[:ajax_engine] == 'fetch' -%>
+    fetch(url, { headers: { Accept: 'application/json' } })
+      .then((response) => {
+        if (response.status === 200) {
+          return response.json();
+        }
+        return undefined;
+      })
+      .then((responseJson) => {
+        if (responseJson) {
+          set<%= plural_name.camelize %>(responseJson);
+        }
+        setLoading(false);
+      });
+    <%- end -%>
+    <%- if options[:ajax_engine] == 'jquery' %>
+    $.getJSON(url, (results) => {
+      set<%= plural_name.camelize %>(results);
+      setLoading(false);
+    });
+    <%- end -%>
+    <%- if options[:ajax_engine] == 'axios' -%>
+    /* Axios coming soon */
+    <%- end -%>
+  };
+
+  const destroy = (<%= singular_name.camelize(:lower) %>Id) => {
+    if (window.confirm('Are you sure?')) {
+      <%- if options[:ajax_engine] == 'fetch' -%>
+      const csrfToken = document.querySelector("[name='csrf-token']").content;
+
+      fetch(`/<%= plural_name %>/${<%= singular_name.camelize(:lower) %>Id}`, { method: 'DELETE', headers: { Accept: 'application/json', 'X-CSRF-Token': csrfToken } }).then((response) => {
+        if (response.status === 204) {
+          load<%= plural_name.camelize%>();
+        }
+      });
+      <%- end -%>
+      <%- if options[:ajax_engine] == 'jquery' -%>
+      $.ajax({
+        url: `/<%= plural_name %>/${<%= singular_name.camelize(:lower) %>Id}`,
+        method: 'DELETE',
+        success: () => {
+          load<%= plural_name.camelize%>();
+        },
+        error: () => {},
+      });
+      <%- end -%>
+      <%- if options[:ajax_engine] == 'axios' -%>
+      /* Axios coming soon */
+      <%- end -%>
+    }
+  }
+
+  useEffect(() => {
+    load<%= plural_name.camelize%>();
+  }, []);
+
+  return (
+    <div>
+      <h1><%= plural_name.titleize %></h1>
+
+      <div>
+        <a href='/<%= plural_name %>/new'>New <%= singular_name %></a>
+      </div>
+      {
+        loading ?
+          "Loading..."
+        :
+          <table>
+            <thead>
+              <tr><% viewable_attributes.each do |viewable_attribute| %>
+                <th><%= viewable_attribute.name.titleize%></th><% end %>
+                <th></th>
+                <th></th>
+                <th></th>
+              </tr>
+            </thead>
+            <tbody>
+              {
+                <%= plural_name.camelize(:lower) %>.map((<%= singular_name.camelize(:lower) %>) => 
+                  (
+                    <tr key={<%= singular_name.camelize(:lower) %>.id}><% viewable_attributes.each do |viewable_attribute| %>
+                      <td>{<%= "#{singular_name.camelize(:lower)}.#{viewable_attribute.name}" %>}</td><% end %>
+                      <td><a href={`/<%= plural_name %>/${<%= singular_name.camelize(:lower) %>.id}`}>Show</a></td>
+                      <td><a href={`/<%= plural_name %>/${<%= singular_name.camelize(:lower) %>.id}/edit`}>Edit</a></td>
+                      <td><a href='#' onClick={(e) => { e.preventDefault(); destroy(<%= singular_name.camelize(:lower) %>.id); }}>Destroy</a></td>
+                    </tr>
+                  )
+                )
+              }
+            </tbody>
+          </table>
+      }
+
+    </div>
+  );
+};
+
+<%- if options['use_remount'] -%>
+/* REMOUNT COMING SOON */
+<%- else -%>
+document.addEventListener('DOMContentLoaded', () => {
+  const mountPoint = document.getElementById('<%= "#{plural_name}-index-page-mount-point" %>');
+  
+  if(mountPoint) {
+    ReactDOM.render(<<%= "#{plural_name.camelize}IndexPage" %> />, mountPoint);
+  }
+});
+<%- end -%>

data/lib/generators/rails_react_scaffold/templates/react_components/new_page.js.erb

@@ -0,0 +1,22 @@
+import React from 'react';
+import ReactDOM from 'react-dom';
+import <%= plural_name.camelize %>Form from './<%= plural_name %>_form';
+
+const <%= plural_name.camelize %>NewPage = () => (
+  <div>
+    <h1>New <%= singular_name %></h1>
+    <<%= plural_name.camelize %>Form />
+  </div>
+);
+
+<%- if options['use_remount'] -%>
+/* REMOUNT COMING SOON */
+<%- else -%>
+document.addEventListener('DOMContentLoaded', () => {
+  const mountPoint = document.getElementById('<%= "#{plural_name}-new-page-mount-point" %>');
+  
+  if(mountPoint) {
+    ReactDOM.render(<<%= "#{plural_name.camelize}NewPage" %> />, mountPoint);
+  }
+});
+<%- end -%>

data/lib/generators/rails_react_scaffold/templates/react_components/show_page.js.erb

@@ -0,0 +1,74 @@
+import React, { useState, useEffect } from 'react';
+import ReactDOM from 'react-dom';
+const <%= plural_name.camelize %>ShowPage = ({ <%= singular_name.camelize(:lower)%>Id }) => {
+
+  const [loading, setLoading] = useState(true);
+  const [<%= singular_name.camelize(:lower) %>, set<%= singular_name.camelize %>] = useState();
+
+  const load<%= singular_name.camelize %> = () => {
+    setLoading(true);
+    const url = `/<%= plural_name %>/${<%= singular_name.camelize(:lower)%>Id}`;
+    <%- if options[:ajax_engine] == 'fetch' -%>
+    fetch(url, { headers: { Accept: 'application/json' } })
+      .then((response) => {
+        if (response.status === 200) {
+          return response.json();
+        }
+        return undefined;
+      })
+      .then((responseJson) => {
+        if (responseJson) {
+          set<%= singular_name.camelize %>(responseJson);
+        }
+        setLoading(false);
+      });
+    <%- end -%>
+    <%- if options[:ajax_engine] == 'jquery' -%>
+    $.getJSON(url, (result) => {
+      set<%= singular_name.camelize %>(result);
+      setLoading(false);
+    });
+    <%- end -%>
+    <%- if options[:ajax_engine] == 'axios' -%>
+    /* Axios coming soon */
+    <%- end -%>
+  };
+
+  useEffect(() => {
+    load<%= singular_name.camelize %>();
+  }, []);
+
+  return (
+    <div>
+      <h1><%= singular_name.titleize %> {<%= singular_name.camelize(:lower)%>Id}</h1>
+      {
+        loading ?
+          "Loading..."
+        :
+          <>
+            <%- viewable_attributes.each do |viewable_attribute| -%>
+            <p>
+              <b><%= viewable_attribute.name.titleize %></b>: {<%= "#{singular_name.camelize(:lower)}.#{viewable_attribute.name}" %>}
+            </p>
+            <%- end -%>
+          </>
+      }
+      <div>
+        <a href="/<%= plural_name %>">Back to <%= plural_name %></a>
+      </div>
+    </div>
+  );
+};
+
+<%- if options['use_remount'] -%>
+/* REMOUNT COMING SOON */
+<%- else -%>
+document.addEventListener('DOMContentLoaded', () => {
+  const mountPoint = document.getElementById('<%= "#{plural_name}-show-page-mount-point" %>');
+  
+  if(mountPoint) {
+    const <%= singular_name %>Id = parseInt(mountPoint.dataset.<%= singular_name.camelize(:lower) %>Id);
+    ReactDOM.render(<<%= "#{plural_name.camelize}ShowPage" %> <%= singular_name %>Id={<%= singular_name %>Id} />, mountPoint);
+  }
+});
+<%- end -%>

data/lib/generators/rails_react_scaffold/templates/views/edit.html.erb

@@ -0,0 +1,7 @@
+<%- if options[:use_webpacker_chunks] -%>
+<%= "<%= javascript_packs_with_chunks_tag '#{plural_name}/#{plural_name}_edit_page' %%>" %>
+<%- end -%>
+<%- if options[:use_webpacker] -%>
+<%= "<%= javascript_pack_tag '#{plural_name}/#{plural_name}_edit_page' %%>" %>
+<%- end -%>
+<div id="<%= "#{plural_name}-edit-page-mount-point" %>" data-<%= singular_name.dasherize %>-id=<%= "<%= @#{singular_name}.id  %%>" %>></div>

data/lib/generators/rails_react_scaffold/templates/views/index.html.erb

@@ -0,0 +1,7 @@
+<%- if options[:use_webpacker_chunks] -%>
+<%= "<%= javascript_packs_with_chunks_tag '#{plural_name}/#{plural_name}_index_page' %%>" %>
+<%- end -%>
+<%- if options[:use_webpacker] -%>
+<%= "<%= javascript_pack_tag '#{plural_name}/#{plural_name}_index_page' %%>" %>
+<%- end -%>
+<div id="<%= "#{plural_name}-index-page-mount-point" %>"></div>

data/lib/generators/rails_react_scaffold/templates/views/index.json.jbuilder

@@ -0,0 +1 @@
+# JBuilder Coming Soon

data/lib/generators/rails_react_scaffold/templates/views/index.json.rabl

@@ -0,0 +1,11 @@
+collection @<%= plural_name %>
+
+<%- viewable_attributes.each_with_index do |attribute, index| -%>
+  <%- if index == 0 -%>
+attributes :<%= attribute.name -%>,
+  <%- elsif index == (viewable_attributes.size - 1) -%>
+           :<%= attribute.name %>
+  <%- else -%>
+           :<%= attribute.name %>,
+  <%- end -%>
+<%- end -%>

data/lib/generators/rails_react_scaffold/templates/views/new.html.erb

@@ -0,0 +1,7 @@
+<%- if options[:use_webpacker_chunks] -%>
+<%= "<%= javascript_packs_with_chunks_tag '#{plural_name}/#{plural_name}_new_page' %%>" %>
+<%- end -%>
+<%- if options[:use_webpacker] -%>
+<%= "<%= javascript_pack_tag '#{plural_name}/#{plural_name}_new_page' %%>" %>
+<%- end -%>
+<div id="<%= "#{plural_name}-new-page-mount-point" %>"></div>

data/lib/generators/rails_react_scaffold/templates/views/show.html.erb

@@ -0,0 +1,7 @@
+<%- if options[:use_webpacker_chunks] -%>
+<%= "<%= javascript_packs_with_chunks_tag '#{plural_name}/#{plural_name}_show_page' %%>" %>
+<%- end -%>
+<%- if options[:use_webpacker] -%>
+<%= "<%= javascript_pack_tag '#{plural_name}/#{plural_name}_show_page' %%>" %>
+<%- end -%>
+<div id="<%= "#{plural_name}-show-page-mount-point" %>" data-<%= singular_name.dasherize %>-id=<%= "<%= @#{singular_name}.id  %%>" %>></div>

data/lib/generators/rails_react_scaffold/templates/views/show.json.jbuilder

@@ -0,0 +1 @@
+# JBuilder Coming Soon

data/lib/generators/rails_react_scaffold/templates/views/show.json.rabl

@@ -0,0 +1,11 @@
+object @<%= singular_name %>
+
+<%- viewable_attributes.each_with_index do |attribute, index| -%>
+  <%- if index == 0 -%>
+attributes :<%= attribute.name %>,
+  <%- elsif index == (viewable_attributes.size - 1) -%>
+           :<%= attribute.name %>
+  <%- else -%>
+           :<%= attribute.name %>,
+  <%- end -%>
+<%- end %>

data/lib/rails_react_scaffold/version.rb

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

data/lib/rails_react_scaffold.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require_relative "rails_react_scaffold/version"
+
+module RailsReactScaffold
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/rails_react_scaffold.rbs

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

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: rails_react_scaffold
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Casey Li
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-02-19 00:00:00.000000000 Z
+dependencies: []
+description: This gem overrides the default scaffold generators to build scaffolds
+  that use React views.
+email:
+- casey.li@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/rails_react_scaffold/controller_generator.rb
+- lib/generators/rails_react_scaffold/generator_helpers.rb
+- lib/generators/rails_react_scaffold/templates/controller.rb
+- lib/generators/rails_react_scaffold/templates/react_components/edit_page.js.erb
+- lib/generators/rails_react_scaffold/templates/react_components/form.js.erb
+- lib/generators/rails_react_scaffold/templates/react_components/index_page.js.erb
+- lib/generators/rails_react_scaffold/templates/react_components/new_page.js.erb
+- lib/generators/rails_react_scaffold/templates/react_components/show_page.js.erb
+- lib/generators/rails_react_scaffold/templates/views/edit.html.erb
+- lib/generators/rails_react_scaffold/templates/views/index.html.erb
+- lib/generators/rails_react_scaffold/templates/views/index.json.jbuilder
+- lib/generators/rails_react_scaffold/templates/views/index.json.rabl
+- lib/generators/rails_react_scaffold/templates/views/new.html.erb
+- lib/generators/rails_react_scaffold/templates/views/show.html.erb
+- lib/generators/rails_react_scaffold/templates/views/show.json.jbuilder
+- lib/generators/rails_react_scaffold/templates/views/show.json.rabl
+- lib/rails_react_scaffold.rb
+- lib/rails_react_scaffold/version.rb
+- sig/rails_react_scaffold.rbs
+homepage: https://github.com/bitesite/rails_react_scaffold
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bitesite/rails_react_scaffold
+  source_code_uri: https://github.com/bitesite/rails_react_scaffold
+  changelog_uri: https://github.com/bitesite/rails_react_scaffold/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Gem to build Rails scaffolds for Rails projects that use React front ends.
+test_files: []