js-routes 2.0.7 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c4859fef1627aff464cbfd2c4cede3be5890c402d6bcb20afe1617059996d85
-  data.tar.gz: 04135b7c60e37f964f7f3904f04714fe76e6297560c7526b9ff5d3dd6069aa1c
+  metadata.gz: 4f78bfaf0cba479c48245d0606cc10b262481e854f3fc82e7195a8b58548bf7a
+  data.tar.gz: 118cafad50e73568ba4b1758821af072194e9570178f1f9caf067785e9f5a0f5
 SHA512:
-  metadata.gz: 77a1e9c70ee04c5e01a64cd910ea724f68f5eaec46977bb2d2f3bb2677482688ca11a6efb32ba54e397f7f6267aa1eccc3797d86f9ce629a4c988731ba48bbaf
-  data.tar.gz: cb8166142e036e1232f517c25e6a3d515f8ecc75c87aa356562e3db1199a9962d51f64f21932a502de75c0b0fba94202efb0f40574f6c16b8fb6910a6a4c3577
+  metadata.gz: 95490b886a00861b0fe4a5e2419c67ec804bbb94a916edefe333acd2e0c94b407137952b97e4bf70d928ad1ebc5cf47333b5b5083f0dc227a43be2d3ebba7648
+  data.tar.gz: 666d2862d8a86e760176afdfdd62711a34202a4725d08609e5f5bf69732becb8829826ddeccaca0f8cacffa6a78022e69a05872ea26ce550e7352a9bfde0d0e4

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## master
 
+## v2.0.8
+
+* Forbid usage of `namespace` option if `module_type` is not `nil`. [#281](https://github.com/railsware/js-routes/issues/281).
+
 ## v2.0.7
 
 * Remove source map annotation from JS file. Fixes [#277](https://github.com/railsware/js-routes/issues/277)

data/Readme.md

@@ -159,6 +159,7 @@ Options to configure JavaScript file generator. These options are only available
   * Default: `[]`
   * The regexp applies only to the name before the `_path` suffix, eg: you want to match exactly `settings_path`, the regexp should be `/^settings$/`
 * `namespace` - global object used to access routes.
+  * Only available if `module_type` option is set to `nil`.
   * Supports nested namespace like `MyProject.routes`
   * Default: `nil`
 * `camel_case` - specifies if route helpers should be generated in camel case instead of underscore case.
@@ -314,6 +315,9 @@ import {
 } from 'routes.js.erb'
 ```
 
+Such import structure allows for moddern JS bundlers like [Webpack](https://webpack.js.org/) to only include explicitly imported routes into JS bundle file.
+See [Tree Shaking](https://webpack.js.org/guides/tree-shaking/) for more information.
+
 ### Exclude option
 
 Split your routes into multiple files related to each section of your website like:
@@ -325,18 +329,6 @@ Split your routes into multiple files related to each section of your website li
 <%= JsRoutes.generate(exclude: /^admin_/)
 ```
 
-## JsRoutes and Heroku
-
-When using this setup on Heroku, it is impossible to use the asset pipeline. You should use the "Very Advanced Setup" schema in this case.
-
-For example create routes.js.erb in assets folder with needed content:
-
-``` erb
-<%= JsRoutes.generate(options) %>
-```
-
-This should just work.
-
 ## Advantages over alternatives
 
 There are some alternatives available. Most of them has only basic feature and don't reach the level of quality I accept.

data/VERSION_2_UPGRADE.md

@@ -2,28 +2,40 @@
 
 ### Using ESM module by default
 
-The default setting are now changed:
+New version of JsRoutes doesn't try to guess your javascript environment module system because JS has generated a ton of legacy module systems in the past. 
+[ESM+Webpacker](/Readme.md#webpacker) upgrade is recommended. 
 
-Setting | Old | New 
---- | --- | ---
-module\_type | nil | ESM 
-namespace | Routes | nil
-documentation | false | true
+However, if you don't want to follow that pass, specify `module_type` configuration option instead based on module system available in your JS environment.
+Here are supported values:
 
-This is more optimized setup for WebPacker. 
-New version of js-routes generates function comment in the [JSDoc](https://jsdoc.app) format.
+* CJS
+* UMD
+* AMD
+* ESM
+* nil
+
+[Explaination Article](https://dev.to/iggredible/what-the-heck-are-cjs-amd-umd-and-esm-ikm)
 
-You can restore the old configuration like this:
+If you don't want to use any JS module system and make routes available via a **global variable**, specify `nil` as a `module_type` and use `namespace` option:
 
 ``` ruby
 JsRoutes.setup do |config|
   config.module_type = nil
-  config.namespace = 'Routes'
-  config.documentation = false
+  config.namespace = "Routes"
 end
 ```
 
-However, [ESM+Webpacker](/Readme.md#webpacker) upgrade is recommended. 
+### JSDoc comment
+
+New version of js-routes generates function comment in the [JSDoc](https://jsdoc.app) format.
+If you have any problems with that, you can disable it like this:
+
+
+``` ruby
+JsRoutes.setup do |config|
+  config.documentation = false
+end
+```
 
 ### `required_params` renamed
 

data/lib/js_routes.rb

@@ -60,6 +60,7 @@ class JsRoutes
         value = value.call if value.is_a?(Proc)
         send(:"#{attribute}=", value)
       end
+      normalize_and_verify
       self
     end
 
@@ -76,7 +77,24 @@ class JsRoutes
     end
 
     def esm?
-      self.module_type === 'ESM'
+      module_type === 'ESM'
+    end
+
+    def normalize_and_verify
+      normalize
+      verify
+    end
+
+    protected
+
+    def normalize
+      self.module_type = module_type&.upcase || 'NIL'
+    end
+
+    def verify
+      if module_type != 'NIL' && namespace
+        raise "JsRoutes namespace option can only be used if module_type is nil"
+      end
     end
   end
 
@@ -87,6 +105,7 @@ class JsRoutes
   class << self
     def setup(&block)
       configuration.tap(&block) if block
+      configuration.normalize_and_verify
     end
 
     def configuration
@@ -248,12 +267,14 @@ class JsRoutes
       end
     end
 
+    protected
+
     def body(absolute)
-      "__jsr.r(#{arguments(absolute).join(', ')})"
+      "__jsr.r(#{arguments(absolute).map{|a| json(a)}.join(', ')})"
     end
 
     def arguments(absolute)
-      absolute ? base_arguments + [json(true)] : base_arguments
+      absolute ? base_arguments + [true] : base_arguments
     end
 
     def match_configuration?
@@ -298,10 +319,11 @@ JS
       route.required_parts
     end
 
-    protected
-
     def base_arguments
-      return @base_arguments if defined?(@base_arguments)
+      @base_arguments ||= [parts_table, serialize(spec, parent_spec)]
+    end
+
+    def parts_table
       parts_table = {}
       route.parts.each do |part, hash|
         parts_table[part] ||= {}
@@ -318,11 +340,7 @@ JS
           parts_table[part][:d] = value
         end
       end
-      @base_arguments = [
-        parts_table, serialize(spec, parent_spec)
-      ].map do |argument|
-        json(argument)
-      end
+      parts_table
     end
 
     def documentation_params

data/lib/js_routes/version.rb

@@ -1,3 +1,3 @@
 class JsRoutes
-  VERSION = "2.0.7"
+  VERSION = "2.0.8"
 end

data/lib/routes.d.ts

@@ -37,7 +37,7 @@ declare type PartsTable = Record<string, {
     r?: boolean;
     d?: unknown;
 }>;
-declare type ModuleType = "CJS" | "AMD" | "UMD" | "ESM";
+declare type ModuleType = "CJS" | "AMD" | "UMD" | "ESM" | "NIL";
 declare const RubyVariables: {
     PREFIX: string;
     DEPRECATED_GLOBBING_BEHAVIOR: boolean;
@@ -46,7 +46,7 @@ declare const RubyVariables: {
     SERIALIZER: Serializer;
     NAMESPACE: string;
     ROUTES_OBJECT: RouteHelpers;
-    MODULE_TYPE: ModuleType | null;
+    MODULE_TYPE: ModuleType;
     WRAPPER: <T>(callback: T) => T;
 };
 declare const define: undefined | (((arg: unknown[], callback: () => unknown) => void) & {

data/lib/routes.js

@@ -18,25 +18,32 @@ RubyVariables.WRAPPER((that) => {
     const Root = that;
     const ModuleReferences = {
         CJS: {
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            define: (routes) => (module.exports = routes),
-            support: () => typeof module === "object",
+            define(routes) {
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                module.exports = routes;
+            },
+            isSupported() {
+                return typeof module === "object";
+            },
         },
         AMD: {
-            define: (routes) => 
-            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-            define([], function () {
-                return routes;
-            }),
-            support: () => typeof define === "function" && !!define.amd,
+            define(routes) {
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+                define([], function () {
+                    return routes;
+                });
+            },
+            isSupported() {
+                return typeof define === "function" && !!define.amd;
+            },
         },
         UMD: {
-            define: (routes) => {
-                if (ModuleReferences.AMD.support()) {
+            define(routes) {
+                if (ModuleReferences.AMD.isSupported()) {
                     ModuleReferences.AMD.define(routes);
                 }
                 else {
-                    if (ModuleReferences.CJS.support()) {
+                    if (ModuleReferences.CJS.isSupported()) {
                         try {
                             ModuleReferences.CJS.define(routes);
                         }
@@ -47,11 +54,27 @@ RubyVariables.WRAPPER((that) => {
                     }
                 }
             },
-            support: () => ModuleReferences.AMD.support() || ModuleReferences.CJS.support(),
+            isSupported() {
+                return (ModuleReferences.AMD.isSupported() ||
+                    ModuleReferences.CJS.isSupported());
+            },
         },
         ESM: {
-            define: () => null,
-            support: () => true,
+            define() {
+                // Module can only be defined using ruby code generation
+            },
+            isSupported() {
+                // Its impossible to check if "export" keyword is supported
+                return true;
+            },
+        },
+        NIL: {
+            define(routes) {
+                Utils.namespace(Root, RubyVariables.NAMESPACE, routes);
+            },
+            isSupported() {
+                return !!Root;
+            },
         },
     };
     class ParametersMissing extends Error {
@@ -62,7 +85,6 @@ RubyVariables.WRAPPER((that) => {
             this.name = ParametersMissing.name;
         }
     }
-    const DeprecatedGlobbingBehavior = RubyVariables.DEPRECATED_GLOBBING_BEHAVIOR;
     const UriEncoderSegmentRegex = /[^a-zA-Z0-9\-._~!$&'()*+,;=:@]/g;
     const ReservedOptions = [
         "anchor",
@@ -342,7 +364,9 @@ RubyVariables.WRAPPER((that) => {
                 value = value.join("/");
             }
             const result = this.path_identifier(value);
-            return DeprecatedGlobbingBehavior ? result : encodeURI(result);
+            return RubyVariables.DEPRECATED_GLOBBING_BEHAVIOR
+                ? result
+                : encodeURI(result);
         }
         get_prefix() {
             const prefix = this.configuration.prefix;
@@ -449,7 +473,7 @@ RubyVariables.WRAPPER((that) => {
             return { ...this.configuration };
         }
         is_module_supported(name) {
-            return ModuleReferences[name].support();
+            return ModuleReferences[name].isSupported();
         }
         ensure_module_supported(name) {
             if (!this.is_module_supported(name)) {
@@ -457,9 +481,6 @@ RubyVariables.WRAPPER((that) => {
             }
         }
         define_module(name, module) {
-            if (!name) {
-                return;
-            }
             this.ensure_module_supported(name);
             ModuleReferences[name].define(module);
         }
@@ -484,9 +505,6 @@ RubyVariables.WRAPPER((that) => {
         },
         ...RubyVariables.ROUTES_OBJECT,
     };
-    Utils.namespace(Root, RubyVariables.NAMESPACE, result);
-    if (RubyVariables.MODULE_TYPE) {
-        Utils.define_module(RubyVariables.MODULE_TYPE, result);
-    }
+    Utils.define_module(RubyVariables.MODULE_TYPE, result);
     return result;
 })(this);

data/lib/routes.ts

@@ -39,7 +39,7 @@ type KeywordUrlOptions = Optional<{
 
 type PartsTable = Record<string, { r?: boolean; d?: unknown }>;
 
-type ModuleType = "CJS" | "AMD" | "UMD" | "ESM";
+type ModuleType = "CJS" | "AMD" | "UMD" | "ESM" | "NIL";
 
 declare const RubyVariables: {
   PREFIX: string;
@@ -49,7 +49,7 @@ declare const RubyVariables: {
   SERIALIZER: Serializer;
   NAMESPACE: string;
   ROUTES_OBJECT: RouteHelpers;
-  MODULE_TYPE: ModuleType | null;
+  MODULE_TYPE: ModuleType;
   WRAPPER: <T>(callback: T) => T;
 };
 
@@ -94,28 +94,35 @@ RubyVariables.WRAPPER(
     const Root = that;
     type ModuleDefinition = {
       define: (routes: unknown) => void;
-      support: () => boolean;
+      isSupported: () => boolean;
     };
     const ModuleReferences: Record<ModuleType, ModuleDefinition> = {
       CJS: {
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-        define: (routes) => (module!.exports = routes),
-        support: () => typeof module === "object",
+        define(routes) {
+          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+          module!.exports = routes;
+        },
+        isSupported() {
+          return typeof module === "object";
+        },
       },
       AMD: {
-        define: (routes) =>
+        define(routes) {
           // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
           define!([], function () {
             return routes;
-          }),
-        support: () => typeof define === "function" && !!define.amd,
+          });
+        },
+        isSupported() {
+          return typeof define === "function" && !!define.amd;
+        },
       },
       UMD: {
-        define: (routes) => {
-          if (ModuleReferences.AMD.support()) {
+        define(routes) {
+          if (ModuleReferences.AMD.isSupported()) {
             ModuleReferences.AMD.define(routes);
           } else {
-            if (ModuleReferences.CJS.support()) {
+            if (ModuleReferences.CJS.isSupported()) {
               try {
                 ModuleReferences.CJS.define(routes);
               } catch (error) {
@@ -124,12 +131,29 @@ RubyVariables.WRAPPER(
             }
           }
         },
-        support: () =>
-          ModuleReferences.AMD.support() || ModuleReferences.CJS.support(),
+        isSupported() {
+          return (
+            ModuleReferences.AMD.isSupported() ||
+            ModuleReferences.CJS.isSupported()
+          );
+        },
       },
       ESM: {
-        define: () => null,
-        support: () => true,
+        define() {
+          // Module can only be defined using ruby code generation
+        },
+        isSupported() {
+          // Its impossible to check if "export" keyword is supported
+          return true;
+        },
+      },
+      NIL: {
+        define(routes) {
+          Utils.namespace(Root, RubyVariables.NAMESPACE, routes);
+        },
+        isSupported() {
+          return !!Root;
+        },
       },
     };
 
@@ -143,9 +167,6 @@ RubyVariables.WRAPPER(
       }
     }
 
-    const DeprecatedGlobbingBehavior =
-      RubyVariables.DEPRECATED_GLOBBING_BEHAVIOR;
-
     const UriEncoderSegmentRegex = /[^a-zA-Z0-9\-._~!$&'()*+,;=:@]/g;
 
     const ReservedOptions = [
@@ -498,7 +519,9 @@ RubyVariables.WRAPPER(
           value = value.join("/");
         }
         const result = this.path_identifier(value as any);
-        return DeprecatedGlobbingBehavior ? result : encodeURI(result);
+        return RubyVariables.DEPRECATED_GLOBBING_BEHAVIOR
+          ? result
+          : encodeURI(result);
       }
 
       get_prefix(): string {
@@ -635,7 +658,7 @@ RubyVariables.WRAPPER(
       }
 
       is_module_supported(name: ModuleType): boolean {
-        return ModuleReferences[name].support();
+        return ModuleReferences[name].isSupported();
       }
 
       ensure_module_supported(name: ModuleType): void {
@@ -644,13 +667,7 @@ RubyVariables.WRAPPER(
         }
       }
 
-      define_module(
-        name: ModuleType | null,
-        module: RouterExposedMethods
-      ): void {
-        if (!name) {
-          return;
-        }
+      define_module(name: ModuleType, module: RouterExposedMethods): void {
         this.ensure_module_supported(name);
         ModuleReferences[name].define(module);
       }
@@ -683,11 +700,7 @@ RubyVariables.WRAPPER(
       ...RubyVariables.ROUTES_OBJECT,
     };
 
-    Utils.namespace(Root, RubyVariables.NAMESPACE, result);
-
-    if (RubyVariables.MODULE_TYPE) {
-      Utils.define_module(RubyVariables.MODULE_TYPE, result);
-    }
+    Utils.define_module(RubyVariables.MODULE_TYPE, result);
     return result;
   }
 )(this);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.8
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties