superglue 0.40.0 → 0.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a72d44f915a1102e37b882a5492a0bae8427c68715acf5a59a809fc70cd47aba
-  data.tar.gz: 00cb36e39bbc5d47001c3c6ad9a588204e5ccf27deabbce41ddae66a1ba83ac5
+  metadata.gz: 20e7f46b274beaffe44eb96b704678e4eb2ebb43c85607a6b4170974525db452
+  data.tar.gz: 4e4280233e4e9ed82664aafb9fde2f176471c605142bba3af3326282431e0278
 SHA512:
-  metadata.gz: dfa4b3fc28f855eca34ff1533050afd0abf800d7106ffdac25ee44e051e530546990138cae9b33b78526264a9235692a0f878011ea46da84baef8a4278f49280
-  data.tar.gz: a2198132a6bf2d004745ddb1be7b49de05a21571dd55b507c0d8f09928b06771ebcefb25271b9d84ff9f88303e3f359fea9f6c197ff40db907eb3bf65e75620f
+  metadata.gz: ba6cd0dabf868452a22e88533df3b2d76f324078e7d7559917a1b5d5aa181cf3e060ceee6f1ea9271f8a8478fde127636639493914eb38ba6eba583026edeabd
+  data.tar.gz: 7ebb6ade8ba3a240013f9c55f2b6527423773d8655be5292aedab05e01af089884f8e6f7e93bbb0e45f27c785aebd20c4153e20e93796da3c88e3f0804bb775a

data/lib/generators/rails/superglue_generator.rb

@@ -1,9 +1,10 @@
 require 'rails/generators/named_base'
 require 'rails/generators/resource_helpers'
+require 'rails/version'
 
 module Rails
   module Generators
-    class SuperglueGenerator < NamedBase # :nodoc:
+    class SuperglueGenerator < NamedBase
       include Rails::Generators::ResourceHelpers
 
       source_root File.expand_path('../templates', __FILE__)
@@ -42,13 +43,29 @@ module Rails
 
 
       protected
+        def view_path
+          if Rails.version >= "7"
+            "../views"
+          else
+            "../../views"
+          end
+        end
+
+        def app_js_path
+          if Rails.version >= "7"
+            "app/javascript/"
+          else
+            "app/javascript/packs"
+          end
+        end
+
         def append_mapping(action)
-          app_js = 'app/javascript/packs/application.js'
+          app_js = "#{app_js_path}/application.js"
 
           component_name = [plural_table_name, action].map(&:camelcase).join
 
           inject_into_file app_js, after: "from '@thoughtbot/superglue'" do
-            "\nimport #{component_name} from 'views/#{controller_file_path}/#{action}'"
+            "\nimport #{component_name} from '#{view_path}/#{controller_file_path}/#{action}'"
           end
 
           inject_into_file app_js, after: 'identifierToComponentMapping = {' do

data/lib/install/templates/web/actions.js

@@ -1,4 +1,3 @@
 // Example:
 //
 // export const CLEAR_FORM_ERRORS = 'CLEAR_FORM_ERRORS'
-export const REHYDRATE = 'persist/REHYDRATE'

data/lib/install/templates/web/application.js

@@ -5,8 +5,6 @@ import thunk from 'redux-thunk';
 import { Provider } from 'react-redux';
 import { render } from 'react-dom';
 import { ApplicationBase, fragmentMiddleware } from '@thoughtbot/superglue';
-import { persistStore, persistReducer } from 'redux-persist';
-import storage from 'redux-persist/lib/storage';
 import { applicationRootReducer, applicationPagesReducer } from './reducer';
 import { buildVisitAndRemote } from './application_visit';
 
@@ -58,57 +56,20 @@ export default class Application extends ApplicationBase {
     const composeEnhancers =
       (this.hasWindow && window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__) ||
       compose;
-    const reducer = this.wrapWithPersistReducer(
-      reduceReducers(
+    const reducer = reduceReducers(
         combineReducers({
           superglue: superglueReducer,
           pages: reduceReducers(pagesReducer, applicationPagesReducer),
         }),
         applicationRootReducer
-      )
     );
+
     const store = createStore(
       reducer,
       initialState,
       composeEnhancers(applyMiddleware(thunk, fragmentMiddleware))
     );
 
-    if (this.hasWindow) {
-      // Persist the store using Redux-Persist
-      persistStore(store);
-    }
-
     return store;
   }
-
-  wrapWithPersistReducer(reducers) {
-    // Redux Persist settings
-    // The key is set to the stringified JS asset path to remove the need for
-    // migrations when hydrating.
-    if (!this.hasWindow) {
-      return reducers;
-    }
-    const prefix = "superglue";
-    const persistKey =
-      prefix +
-      this.props.initialPage.assets
-        .filter((asset) => asset.endsWith(".js"))
-        .join(",");
-    const persistConfig = {
-      key: persistKey,
-      storage,
-    };
-
-    // Remove older storage items that were used by previous JS assets
-    if (this.hasWindow) {
-      const storedKeys = Object.keys(localStorage);
-      storedKeys.forEach((key) => {
-        if (key.startsWith(`persist:${prefix}`) && key !== persistKey) {
-          localStorage.removeItem(key);
-        }
-      });
-    }
-
-    return persistReducer(persistConfig, reducers);
-  }
 }

data/lib/install/templates/web/application.json.props

@@ -8,7 +8,8 @@ json.component_identifier local_assigns[:virtual_path_of_template]
 json.defers json.deferred!
 json.fragments json.fragments!
 json.assets [
-  asset_pack_path('application.js'),
+  # Uncomment for webpacker support
+  # asset_pack_path('application.js'),
   asset_path('application.css')
 ]
 

data/lib/install/templates/web/reducer.js

@@ -20,9 +20,6 @@
 //   }
 // }
 
-import {
-  REHYDRATE,
-} from './actions'
 
 // The applicationPageReducer is for cross page reducers
 // Its common to add to this. You'll typically have to pass a pageKey to the 
@@ -38,34 +35,9 @@ export const applicationPagesReducer = (state = {}, action) => {
 }
 
 // The applicationRootReducer is for app wide reducers
-// Its rare to be adding to this. Included out of the box ix a reducer for
-// Redux Persist.
-//
-// The REHYDRATE reducer is generated by Superglue and is needed to persist state
-// on any changes made to the initial state that gets injected into
-// window.SUPERGLUE_INITIAL_PAGE_STATE.
+// Its rare to be adding to this.
 export const applicationRootReducer = (state = {}, action) => {
   switch(action.type) {
-  case REHYDRATE: {
-    if (action.payload) {
-      const {
-        pages: hydratedPages
-      } = action.payload
-      const { pages } = state
-      const nextPages = { ...pages, ...hydratedPages }
-
-      for (const key in pages) {
-        if (pages[key] && hydratedPages[key] &&
-          pages[key].renderedAt > hydratedPages[key].renderedAt) {
-          nextPages[key] = { ...pages[key] }
-        }
-      }
-
-      return { ...state, pages: nextPages }
-    } else {
-      return state
-    }
-  }
   default:
     return state
   }

data/lib/install/web.rb

@@ -1,6 +1,4 @@
-require "webpacker/configuration"
-
-babel_config = Rails.root.join("babel.config.js")
+require "rails/version"
 
 def add_member_methods
   inject_into_file "app/models/application_record.rb", after: "class ApplicationRecord < ActiveRecord::Base\n" do
@@ -16,35 +14,28 @@ def add_member_methods
   end
 end
 
-say "Copying module-resolver preset to your babel.config.js"
-resolver_snippet = <<~JAVASCRIPT
-  [
-    require('babel-plugin-module-resolver').default, {
-      "root": ["./app"],
-      "alias": {
-        "views": "./app/views",
-        "components": "./app/components",
-        "javascript": "./app/javascript"
-      }
-    }
-  ],
-JAVASCRIPT
-insert_into_file "babel.config.js", resolver_snippet, after: /plugins: \[\n/
+def app_js_path
+  if Rails.version >= "7"
+    "app/javascript/"
+  else
+    "app/javascript/packs"
+  end
+end
 
-say "Copying application.js file to #{Webpacker.config.source_entry_path}"
-copy_file "#{__dir__}/templates/web/application.js", "#{Webpacker.config.source_entry_path}/application.js"
+say "Copying application.js file to #{app_js_path}"
+copy_file "#{__dir__}/templates/web/application.js", "#{app_js_path}/application.js"
 
-say "Copying reducer.js file to #{Webpacker.config.source_entry_path}"
-copy_file "#{__dir__}/templates/web/reducer.js", "#{Webpacker.config.source_entry_path}/reducer.js"
+say "Copying reducer.js file to #{app_js_path}"
+copy_file "#{__dir__}/templates/web/reducer.js", "#{app_js_path}/reducer.js"
 
-say "Copying action_creators.js file to #{Webpacker.config.source_entry_path}"
-copy_file "#{__dir__}/templates/web/action_creators.js", "#{Webpacker.config.source_entry_path}/action_creators.js"
+say "Copying action_creators.js file to #{app_js_path}"
+copy_file "#{__dir__}/templates/web/action_creators.js", "#{app_js_path}/action_creators.js"
 
-say "Copying actions.js file to #{Webpacker.config.source_entry_path}"
-copy_file "#{__dir__}/templates/web/actions.js", "#{Webpacker.config.source_entry_path}/actions.js"
+say "Copying actions.js file to #{app_js_path}"
+copy_file "#{__dir__}/templates/web/actions.js", "#{app_js_path}/actions.js"
 
-say "Copying application_visit.js file to #{Webpacker.config.source_entry_path}"
-copy_file "#{__dir__}/templates/web/application_visit.js", "#{Webpacker.config.source_entry_path}/application_visit.js"
+say "Copying application_visit.js file to #{app_js_path}"
+copy_file "#{__dir__}/templates/web/application_visit.js", "#{app_js_path}/application_visit.js"
 
 say "Copying Superglue initializer"
 copy_file "#{__dir__}/templates/web/initializer.rb", "config/initializers/superglue.rb"
@@ -56,11 +47,13 @@ say "Adding required member methods to ApplicationRecord"
 add_member_methods
 
 say "Installing React, Redux, and Superglue"
-run "yarn add babel-plugin-module-resolver history html-react-parser react-redux redux-thunk redux redux-persist reduce-reducers immer @thoughtbot/superglue --save"
+run "yarn add history html-react-parser react-redux redux-thunk redux reduce-reducers immer @thoughtbot/superglue --save"
 
-# For newer webpacker
-insert_into_file Webpacker.config.config_path, "'app/views', 'app/components'", after: /additional_paths: \[/
-# For older webpacker
-insert_into_file Webpacker.config.config_path, "'app/views', 'app/components'", after: /resolved_paths: \[/
+if Rails.version < "7"
+  # For newer webpacker
+  insert_into_file Webpacker.config.config_path, "'app/views', 'app/components'", after: /additional_paths: \[/
+  # For older webpacker
+  insert_into_file Webpacker.config.config_path, "'app/views', 'app/components'", after: /resolved_paths: \[/
+end
 
-say "Webpacker now supports superglue.js 🎉", :green
+say "Superglue is Installed! 🎉", :green

data/lib/tasks/install.rake

@@ -1,15 +1,4 @@
 namespace :superglue do
-  desc "Verifies if any version of Yarn is installed"
-  task :verify_yarn do
-    begin
-      yarn_version = `yarn --version`
-      raise Errno::ENOENT if yarn_version.blank?
-    rescue Errno::ENOENT
-      $stderr.puts "Yarn not installed. Please download and install Yarn from https://yarnpkg.com/lang/en/docs/install/"
-      $stderr.puts "Exiting!" && exit!
-    end
-  end
-
   desc "Verifies if any version of react is in package.json"
   task :verify_react do
     package_json = JSON.parse(File.read(Rails.root.join("package.json")))
@@ -20,20 +9,9 @@ namespace :superglue do
     end
   end
 
-  desc "Verifies webpacker has been installed"
-  task "verify_webpacker" do
-    begin
-      require "webpacker/configuration"
-    rescue LoadError
-      $stderr.puts "Superglue's web install requires webpacker!"
-      $stderr.puts "https://github.com/rails/webpacker#installation"
-      $stderr.puts "Exiting!" && exit!
-    end
-  end
-
   namespace :install do
     desc "Install everything needed for superglue web"
-    task 'web' => ["superglue:verify_webpacker", "webpacker:verify_install", "superglue:verify_react"] do
+    task 'web' => ["superglue:verify_react"] do
       template = File.expand_path("../install/web.rb", __dir__)
       exec "#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{template}"
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: superglue
 version: !ruby/object:Gem::Version
-  version: 0.40.0
+  version: 0.41.0
 platform: ruby
 authors:
 - Johny Ho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-04-03 00:00:00.000000000 Z
+date: 2023-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack