js-routes 2.2.2 → 2.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 52db2ffdef9bea714377b9c00e152177b17e40de0fd8ef57ba09a84fee2f206e
-  data.tar.gz: 8f899234c70859fee6a7c0486825c12ce501a01052e2b5d9a038f08544ac6df9
+  metadata.gz: b706c51040d12aaa69182dad9d25304ba947fe1e80cc5171775864a27d6f4ed8
+  data.tar.gz: 1a105e8a4dbc9cfde5a787a0714b6e0bf0758b6291f6945f0a16ca9c1e7a47a9
 SHA512:
-  metadata.gz: e697c45b1908906c40cdc4591f5914dd415226de79a42a8e948f6095e0f09eb5edb5bfb0c5fd61953fde7121d9a025b3472b644ddb17ca2c13cb075c97311000
-  data.tar.gz: 7f48edacee6659d4e4b5be0d71b5127f26e473119a8bf13a73c55a7b3c295dbee7fc34b9d3f515725c5871baad319ceb0bb32ed176900845b48a84c786ba3f9c
+  metadata.gz: f053d1f48cb8a4f9f7ac7f1e68d37f4816d09e42e0a91660fb84c1e9f4ad36d439019f6f402f1e2fce30467e6b0d5b799fd08bbe70bfc2aa8423c63f053f0bdb
+  data.tar.gz: bdcf72700542350da423e9cf62b4abcc0ba326400c4077c70c5f6174edb75a7e61b6b6a765a0454b4cd1a2fc5ddbf91f3a16294ce995d9ab31d9984153c29b4c

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## master
 
+## v2.2.4
+
+* Fix rails engine loading if sprockets is not in Gemfile. Fixes [#294](https://github.com/railsware/js-routes/issues/294)
+
+## v2.2.3
+
+* Fixed NIL module type namespace defintion [#297](https://github.com/railsware/js-routes/issues/297).
+  * The patch may cause a problem with nested `namespace` option 
+  * Ex. Value like `MyProject.Routes` requires to define `window.MyProject` before importing the routes file
+
 ## v2.2.2.
 
 * Fix custom file path [#295](https://github.com/railsware/js-routes/issues/295)

data/Readme.md

@@ -20,6 +20,7 @@ There are several possible ways to setup JsRoutes:
 
 * [Quick and easy](#quick-start)
   * Uses Rack Middleware to automatically update routes locally
+  * Automatically generates routes files on `assets:precompile` in production
   * Works great for a simple Rails application
 * [Webpacker ERB Loader](#webpacker)
   * Requires ESM module system (the default)

data/lib/js_routes/engine.rb

@@ -29,32 +29,34 @@ end
 
 
 class Engine < ::Rails::Engine
-  require 'sprockets/version'
-  v2                = Gem::Dependency.new('', ' ~> 2')
-  vgte3             = Gem::Dependency.new('', ' >= 3')
-  sprockets_version = Gem::Version.new(::Sprockets::VERSION).release
-  initializer_args  = case sprockets_version
-                        when -> (v) { v2.match?('', v) }
-                          { after: "sprockets.environment" }
-                        when -> (v) { vgte3.match?('', v) }
-                          { after: :engines_blank_point, before: :finisher_hook }
-                        else
-                          raise StandardError, "Sprockets version #{sprockets_version} is not supported"
-                      end
-
-  initializer 'js-routes.dependent_on_routes', initializer_args do
-    case sprockets_version
-      when  -> (v) { v2.match?('', v) },
-            -> (v) { vgte3.match?('', v) }
-
-      Rails.application.config.assets.configure do |config|
-        config.register_preprocessor(
-          "application/javascript",
-          SprocketsExtension,
-        )
+  if defined?(::Sprockets::Railtie)
+    require 'sprockets/version'
+    v2                = Gem::Dependency.new('', ' ~> 2')
+    vgte3             = Gem::Dependency.new('', ' >= 3')
+    sprockets_version = Gem::Version.new(::Sprockets::VERSION).release
+    initializer_args  = case sprockets_version
+                          when -> (v) { v2.match?('', v) }
+                            { after: "sprockets.environment" }
+                          when -> (v) { vgte3.match?('', v) }
+                            { after: :engines_blank_point, before: :finisher_hook }
+                          else
+                            raise StandardError, "Sprockets version #{sprockets_version} is not supported"
+                        end
+
+    initializer 'js-routes.dependent_on_routes', initializer_args do
+      case sprockets_version
+        when  -> (v) { v2.match?('', v) },
+              -> (v) { vgte3.match?('', v) }
+
+        Rails.application.config.assets.configure do |config|
+          config.register_preprocessor(
+            "application/javascript",
+            SprocketsExtension,
+          )
+        end
+      else
+        raise StandardError, "Sprockets version #{sprockets_version} is not supported"
       end
-    else
-      raise StandardError, "Sprockets version #{sprockets_version} is not supported"
     end
   end
 end

data/lib/js_routes/instance.rb

@@ -57,16 +57,35 @@ module JsRoutes
         'DEPRECATED_GLOBBING_BEHAVIOR' => ActionPack::VERSION::MAJOR == 4 && ActionPack::VERSION::MINOR == 0,
 
         'APP_CLASS'           => application.class.to_s,
-        'NAMESPACE'           => json(@configuration.namespace),
         'DEFAULT_URL_OPTIONS' => json(@configuration.default_url_options),
         'PREFIX'              => json(@configuration.prefix),
         'SPECIAL_OPTIONS_KEY' => json(@configuration.special_options_key),
         'SERIALIZER'          => @configuration.serializer || json(nil),
         'MODULE_TYPE'         => json(@configuration.module_type),
-        'WRAPPER'             => @configuration.esm? ? 'const __jsr = ' : '',
+        'WRAPPER'             => wrapper_variable,
       }
     end
 
+    def wrapper_variable
+      case @configuration.module_type
+      when 'ESM'
+        'const __jsr = '
+      when 'NIL'
+        namespace = @configuration.namespace
+        if namespace
+          if namespace.include?('.')
+            "#{namespace} = "
+          else
+            "(typeof window !== 'undefined' ? window : this).#{namespace} = "
+          end
+        else
+          ''
+        end
+      else
+        ''
+      end
+    end
+
     def application
       @configuration.application
     end

data/lib/js_routes/version.rb

@@ -1,3 +1,3 @@
 module JsRoutes
-  VERSION = "2.2.2"
+  VERSION = "2.2.3"
 end

data/lib/js_routes.rb

@@ -1,4 +1,4 @@
-if defined?(::Rails) && defined?(::Sprockets::Railtie)
+if defined?(::Rails)
   require 'js_routes/engine'
 end
 require 'js_routes/version'

data/lib/routes.d.ts

@@ -66,7 +66,6 @@ declare const RubyVariables: {
     SPECIAL_OPTIONS_KEY: string;
     DEFAULT_URL_OPTIONS: RouteParameters;
     SERIALIZER: Serializer;
-    NAMESPACE: string;
     ROUTES_OBJECT: RouteHelpers;
     MODULE_TYPE: ModuleType;
     WRAPPER: <T>(callback: T) => T;

data/lib/routes.js

@@ -2,7 +2,7 @@
  * File generated by js-routes RubyVariables.GEM_VERSION
  * Based on Rails RubyVariables.RAILS_VERSION routes of RubyVariables.APP_CLASS
  */
-RubyVariables.WRAPPER((that) => {
+RubyVariables.WRAPPER(() => {
     const hasProp = (value, key) => Object.prototype.hasOwnProperty.call(value, key);
     let NodeTypes;
     (function (NodeTypes) {
@@ -15,8 +15,7 @@ RubyVariables.WRAPPER((that) => {
         NodeTypes[NodeTypes["SLASH"] = 7] = "SLASH";
         NodeTypes[NodeTypes["DOT"] = 8] = "DOT";
     })(NodeTypes || (NodeTypes = {}));
-    const Root = that;
-    const isBroswer = typeof window !== "undefined";
+    const isBrowser = typeof window !== "undefined";
     const ModuleReferences = {
         CJS: {
             define(routes) {
@@ -70,11 +69,11 @@ RubyVariables.WRAPPER((that) => {
             },
         },
         NIL: {
-            define(routes) {
-                Utils.namespace(Root, RubyVariables.NAMESPACE, routes);
+            define() {
+                // Defined using RubyVariables.WRAPPER
             },
             isSupported() {
-                return !RubyVariables.NAMESPACE || !!Root;
+                return true;
             },
         },
         DTS: {
@@ -422,15 +421,15 @@ RubyVariables.WRAPPER((that) => {
         }
         current_host() {
             var _a;
-            return (isBroswer && ((_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.hostname)) || "";
+            return (isBrowser && ((_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.hostname)) || "";
         }
         current_protocol() {
             var _a, _b;
-            return ((isBroswer && ((_b = (_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.protocol) === null || _b === void 0 ? void 0 : _b.replace(/:$/, ""))) || "http");
+            return ((isBrowser && ((_b = (_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.protocol) === null || _b === void 0 ? void 0 : _b.replace(/:$/, ""))) || "http");
         }
         current_port() {
             var _a;
-            return (isBroswer && ((_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.port)) || "";
+            return (isBrowser && ((_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.port)) || "";
         }
         is_object(value) {
             return (typeof value === "object" &&
@@ -445,21 +444,6 @@ RubyVariables.WRAPPER((that) => {
         is_reserved_option(key) {
             return ReservedOptions.includes(key);
         }
-        namespace(object, namespace, routes) {
-            const parts = (namespace === null || namespace === void 0 ? void 0 : namespace.split(".")) || [];
-            if (parts.length === 0) {
-                return;
-            }
-            for (let index = 0; index < parts.length; index++) {
-                const part = parts[index];
-                if (index < parts.length - 1) {
-                    object = object[part] || (object[part] = {});
-                }
-                else {
-                    object[part] = routes;
-                }
-            }
-        }
         configure(new_config) {
             this.configuration = { ...this.configuration, ...new_config };
             return this.configuration;
@@ -502,4 +486,4 @@ RubyVariables.WRAPPER((that) => {
     };
     Utils.define_module(RubyVariables.MODULE_TYPE, result);
     return result;
-})(this);
+})();

data/lib/routes.ts

@@ -84,7 +84,6 @@ declare const RubyVariables: {
   SPECIAL_OPTIONS_KEY: string;
   DEFAULT_URL_OPTIONS: RouteParameters;
   SERIALIZER: Serializer;
-  NAMESPACE: string;
   ROUTES_OBJECT: RouteHelpers;
   MODULE_TYPE: ModuleType;
   WRAPPER: <T>(callback: T) => T;
@@ -97,7 +96,7 @@ declare const define:
 declare const module: { exports: any } | undefined;
 
 RubyVariables.WRAPPER(
-  (that: unknown): RouterExposedMethods => {
+  (): RouterExposedMethods => {
     const hasProp = (value: unknown, key: string) =>
       Object.prototype.hasOwnProperty.call(value, key);
     enum NodeTypes {
@@ -128,8 +127,7 @@ RubyVariables.WRAPPER(
       [T in keyof RouteNodes]: RouteNode<T>;
     }[keyof RouteNodes];
 
-    const Root = that;
-    const isBroswer = typeof window !== "undefined";
+    const isBrowser = typeof window !== "undefined";
     type ModuleDefinition = {
       define: (routes: RouterExposedMethods) => void;
       isSupported: () => boolean;
@@ -186,11 +184,11 @@ RubyVariables.WRAPPER(
         },
       },
       NIL: {
-        define(routes) {
-          Utils.namespace(Root, RubyVariables.NAMESPACE, routes);
+        define() {
+          // Defined using RubyVariables.WRAPPER
         },
         isSupported() {
-          return !RubyVariables.NAMESPACE || !!Root;
+          return true;
         },
       },
       DTS: {
@@ -628,17 +626,17 @@ RubyVariables.WRAPPER(
       }
 
       current_host(): string {
-        return (isBroswer && window?.location?.hostname) || "";
+        return (isBrowser && window?.location?.hostname) || "";
       }
 
       current_protocol(): string {
         return (
-          (isBroswer && window?.location?.protocol?.replace(/:$/, "")) || "http"
+          (isBrowser && window?.location?.protocol?.replace(/:$/, "")) || "http"
         );
       }
 
       current_port(): string {
-        return (isBroswer && window?.location?.port) || "";
+        return (isBrowser && window?.location?.port) || "";
       }
 
       is_object(value: unknown): value is Record<string, unknown> {
@@ -660,25 +658,6 @@ RubyVariables.WRAPPER(
         return ReservedOptions.includes(key as any);
       }
 
-      namespace(
-        object: any,
-        namespace: string | null | undefined,
-        routes: unknown
-      ): void {
-        const parts = namespace?.split(".") || [];
-        if (parts.length === 0) {
-          return;
-        }
-        for (let index = 0; index < parts.length; index++) {
-          const part = parts[index];
-          if (index < parts.length - 1) {
-            object = object[part] || (object[part] = {});
-          } else {
-            object[part] = routes;
-          }
-        }
-      }
-
       configure(new_config: Partial<Configuration>): Configuration {
         this.configuration = { ...this.configuration, ...new_config };
         return this.configuration;
@@ -734,4 +713,4 @@ RubyVariables.WRAPPER(
     Utils.define_module(RubyVariables.MODULE_TYPE, result);
     return result;
   }
-)(this);
+)();

data/spec/js_routes/module_types/dts/routes.spec.d.ts

@@ -66,7 +66,6 @@ declare const RubyVariables: {
     SPECIAL_OPTIONS_KEY: string;
     DEFAULT_URL_OPTIONS: RouteParameters;
     SERIALIZER: Serializer;
-    NAMESPACE: string;
     ROUTES_OBJECT: RouteHelpers;
     MODULE_TYPE: ModuleType;
     WRAPPER: <T>(callback: T) => T;

data/spec/js_routes/module_types/nil_spec.rb

@@ -45,6 +45,7 @@ describe JsRoutes, "compatibility with NIL (legacy browser)" do
     let(:_presetup) { "" }
     before do
       evaljs("var window = this;")
+      evaljs("window.PHM = {}")
       evaljs(_presetup)
       evaljs(generated_js)
     end

data/spec/js_routes/options_spec.rb

@@ -399,13 +399,16 @@ describe JsRoutes, "options" do
       end
 
       let(:_presetup) do
-        window = {location: {
+        location =  {
           protocol: current_protocol,
           hostname: current_hostname,
           port: current_port,
           host: current_host,
-        }}
-        "const window = #{ActiveSupport::JSON.encode(window)}"
+        }
+        [
+          "const window = this;",
+          "window.location = #{ActiveSupport::JSON.encode(location)};",
+        ].join("\n")
       end
 
       context "without specifying a default host" do

data/spec/js_routes/rails_routes_compatibility_spec.rb

@@ -2,8 +2,11 @@ require "spec_helper"
 
 describe JsRoutes, "compatibility with Rails"  do
 
+  let(:generated_js) do
+    JsRoutes.generate({module_type: nil, namespace: 'Routes'})
+  end
   before(:each) do
-    evaljs(JsRoutes.generate({module_type: nil, namespace: 'Routes'}))
+    evaljs(generated_js)
   end
 
   it "should generate collection routing" do

data/spec/spec_helper.rb

@@ -42,10 +42,14 @@ end
 def evaljs(string, force: false, filename: 'context.js')
   jscontext(force).eval(string, filename: filename)
 rescue MiniRacer::ParseError => e
-  message = e.message
-  _, _, line, _ = message.split(':')
-  code = line && string.split("\n")[line.to_i-1]
-  raise "#{message}. Code: #{code.strip}";
+  trace = e.message
+  _, _, line, _ = trace.split(':')
+  if line
+    code = string.split("\n")[line.to_i-1]
+    raise "#{trace}. Code: #{code.strip}";
+  else
+    raise e
+  end
 rescue MiniRacer::RuntimeError => e
   raise e
 end
@@ -62,6 +66,10 @@ def planner_routes
   Planner::Engine.routes.url_helpers
 end
 
+def log(string)
+  evaljs("console.log(#{string})")
+end
+
 ActiveSupport::Inflector.inflections do |inflect|
   inflect.irregular "budgie", "budgies"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.3
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties