js-routes 2.2.6 → 2.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 55d34a6a511e250d1fc59aa2e868a3148734bc6fafc6f156ff86eea1f0d6f81e
-  data.tar.gz: 94143965ae4a2a14db535dd484521c3348c18eee2ca6f61ee72186e908cdc786
+  metadata.gz: 6dfe30c594c24cf044d0f19342e17cd6b23857da7ec68a0bf68d8f8be9f33def
+  data.tar.gz: 3aefa8fc04221f07996ada7c57f35b22d2ae519575a6df0e20c6d860fe6203ed
 SHA512:
-  metadata.gz: d727f254cec5e5269e92ef1180309aacb3362fc4aa8065c2fb604237d9096918c1e0ab534b7b443df656fb5218962e949522ce3338b4be9d99e17d0268f6efbb
-  data.tar.gz: 9ce12dc8aefab9a646aadc2318e541f6b422fc9340856e69488889374727c7de7f7e70fa8fbe510263b9d7f5edf2097657ae62fac0a90d0206b9b2be5481b48a
+  metadata.gz: 652fa60215a5c812e3a0cb0284870bfa63c6eeb1d249940388ade48a3f90a7209559d7cf66750e697ffc317bfcd1bec87e57fed44cad375795ead64fb1bcd254
+  data.tar.gz: a68bdb295fb704a5ed753d0576e700668aecfe30d5ec6d425ed458d029eb084de66ff26e0789c808e655574146973db02226a1a48f2cd81fa6ebda3379b7bc8c

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 ## master
 
+## v2.2.8
+
+* Leave emoji symbols intact when encoding URI fragment [#312](https://github.com/railsware/js-routes/issues/312)
+* Use webpacker config variable instead of hardcode [#309](https://github.com/railsware/js-routes/issues/309)
+* Use `File.exist?` to be compatible with all versions of ruby [#310](https://github.com/railsware/js-routes/issues/310)
+
+## v2.2.7
+
+* Fix ESM Tree Shaking [#306](https://github.com/railsware/js-routes/issues/306)
+
 ## v2.2.6
 
 * Prefer to extend `javascript:build` instead of `assets:precompile`. [#305](https://github.com/railsware/js-routes/issues/305)

data/Readme.md

@@ -16,16 +16,17 @@ gem "js-routes"
 
 There are several possible ways to setup JsRoutes:
 
-* [Quick and easy](#quick-start)
+* [Quick and easy](#quick-start) - Recommended
   * Uses Rack Middleware to automatically update routes locally
-  * Automatically generates routes files on `assets:precompile` in production
+  * Automatically generates routes files on javascript build
   * Works great for a simple Rails application
-* [Webpacker ERB Loader](#webpacker)
-  * Requires ESM module system (the default)
-  * Doesn't support typescript definitions
 * [Advanced Setup](#advanced-setup)
   * Allows very custom setups
-* [Sprockets](#sprockets) legacy
+  * Automatic updates need to be customized
+* [Webpacker ERB Loader](#webpacker) - Legacy
+  * Requires ESM module system (the default)
+  * Doesn't support typescript definitions
+* [Sprockets](#sprockets) - Legacy
   * Deprecated and not recommended for modern apps
 
 <div id='quick-start'></div>
@@ -80,7 +81,7 @@ Add js-routes files to `.gitignore`:
 
 ### Webpacker ERB loader
 
-**IMPORTANT**: this setup doesn't support IDE autocompletion with [Typescript](https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-d-ts.html)
+**IMPORTANT**: the setup doesn't support IDE autocompletion with [Typescript](https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-d-ts.html)
 
 
 #### Use a Generator
@@ -414,9 +415,14 @@ JsRoutes itself does not have security holes.
 It makes URLs without access protection more reachable by potential attacker.
 If that is an issue for you, you may use one of the following solutions:
 
-### Explicit Import + ESM Tree shaking
+### ESM Tree shaking
+
+Make sure `module_type` is set to `ESM` (the default). Modern JS bundlers like
+[Webpack](https://webpack.js.org) can statically determine which ESM exports are used, and remove
+the unused exports to reduce bundle size. This is known as [Tree
+Shaking](https://webpack.js.org/guides/tree-shaking/).
 
-Make sure `module_type` is set to `ESM` (the default) and JS files import only required routes into the file like:
+JS files can use named imports to import only required routes into the file, like:
 
 ``` javascript
 import {
@@ -428,8 +434,15 @@ import {
 } from '../routes'
 ```
 
-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.
+JS files can also use star imports (`import * as`) for tree shaking, as long as only explicit property accesses are used.
+
+``` javascript
+import * as routes from '../routes';
+
+console.log(routes.inbox_path); // OK, only `inbox_path` is included in the bundle
+
+console.log(Object.keys(routes)); // forces bundler to include all exports, breaking tree shaking
+```
 
 ### Exclude option
 

data/lib/js_routes/configuration.rb

@@ -75,7 +75,7 @@ module JsRoutes
     end
 
     def output_file
-      webpacker_dir = pathname('app', 'javascript')
+      webpacker_dir = defined?(Webpacker) ? Webpacker.config.source_path : pathname('app', 'javascript')
       sprockets_dir = pathname('app','assets','javascripts')
       file_name = file || default_file_name
       sprockets_file = sprockets_dir.join(file_name)

data/lib/js_routes/generators/base.rb

@@ -10,7 +10,7 @@ class JsRoutes::Generators::Base < Rails::Generators::Base
       "app/javascript/packs/application.js",
       "app/javascript/controllers/application.js",
     ].find do |path|
-      File.exists?(Rails.root.join(path))
+      File.exist?(Rails.root.join(path))
     end
   end
 end

data/lib/js_routes/generators/webpacker.rb

@@ -7,7 +7,7 @@ class JsRoutes::Generators::Webpacker < Rails::Generators::Base
   def create_webpack
     copy_file "initializer.rb", "config/initializers/js_routes.rb"
     copy_file "erb.js", "config/webpack/loaders/erb.js"
-    copy_file "routes.js.erb", "app/javascript/routes.js.erb"
+    copy_file "routes.js.erb", "#{Webpacker.config.source_path}/routes.js.erb"
     inject_into_file "config/webpack/environment.js", loader_content
     if path = application_js_path
       inject_into_file path, pack_content

data/lib/js_routes/route.rb

@@ -33,8 +33,15 @@ module JsRoutes
     end
 
     def body(absolute)
-      @configuration.dts? ?
-        definition_body : "__jsr.r(#{arguments(absolute).map{|a| json(a)}.join(', ')})"
+      if @configuration.dts?
+        definition_body
+      else
+        # For tree-shaking ESM, add a #__PURE__ comment informing Webpack/minifiers that the call to `__jsr.r`
+        # has no side-effects (e.g. modifying global variables) and is safe to remove when unused.
+        # https://webpack.js.org/guides/tree-shaking/#clarifying-tree-shaking-and-sideeffects
+        pure_comment = @configuration.esm? ? '/*#__PURE__*/ ' : ''
+        "#{pure_comment}__jsr.r(#{arguments(absolute).map{|a| json(a)}.join(', ')})"
+      end
     end
 
     def definition_body

data/lib/js_routes/version.rb

@@ -1,3 +1,3 @@
 module JsRoutes
-  VERSION = "2.2.6"
+  VERSION = "2.2.8"
 end

data/lib/routes.d.ts

@@ -32,8 +32,8 @@ declare type RequiredParameters<T extends number> = T extends 1 ? [RequiredRoute
     RequiredRouteParameter,
     RequiredRouteParameter
 ] : RequiredRouteParameter[];
-declare type RouteHelperOptions<T extends string> = RouteOptions & Optional<Record<T, OptionalRouteParameter>>;
-declare type RouteHelper<T extends number = number, U extends string = string> = ((...args: [...RequiredParameters<T>, RouteHelperOptions<U>]) => string) & RouteHelperExtras;
+declare type RouteHelperOptions = RouteOptions & Record<string, OptionalRouteParameter>;
+declare type RouteHelper<T extends number = number> = ((...args: [...RequiredParameters<T>, RouteHelperOptions]) => string) & RouteHelperExtras;
 declare type RouteHelpers = Record<string, RouteHelper>;
 declare type Configuration = {
     prefix: string;

data/lib/routes.js

@@ -19,6 +19,14 @@ RubyVariables.WRAPPER(
         NodeTypes[NodeTypes["DOT"] = 8] = "DOT";
     })(NodeTypes || (NodeTypes = {}));
     const isBrowser = typeof window !== "undefined";
+    const UnescapedSpecials = "-._~!$&'()*+,;=:@"
+        .split("")
+        .map((s) => s.charCodeAt(0));
+    const UnescapedRanges = [
+        ["a", "z"],
+        ["A", "Z"],
+        ["0", "9"],
+    ].map((range) => range.map((s) => s.charCodeAt(0)));
     const ModuleReferences = {
         CJS: {
             define(routes) {
@@ -97,7 +105,6 @@ RubyVariables.WRAPPER(
             this.name = ParametersMissing.name;
         }
     }
-    const UriEncoderSegmentRegex = /[^a-zA-Z0-9\-._~!$&'()*+,;=:@]/g;
     const ReservedOptions = [
         "anchor",
         "trailing_slash",
@@ -349,7 +356,22 @@ RubyVariables.WRAPPER(
             }
         }
         encode_segment(segment) {
-            return segment.replace(UriEncoderSegmentRegex, (str) => encodeURIComponent(str));
+            if (segment.match(/^[a-zA-Z0-9-]$/)) {
+                // Performance optimization for 99% of cases
+                return segment;
+            }
+            return (segment.match(/./gu) || [])
+                .map((ch) => {
+                const code = ch.charCodeAt(0);
+                if (UnescapedRanges.find((range) => code >= range[0] && code <= range[1]) ||
+                    UnescapedSpecials.includes(code)) {
+                    return ch;
+                }
+                else {
+                    return encodeURIComponent(ch);
+                }
+            })
+                .join("");
         }
         is_optional_node(node) {
             return [NodeTypes.STAR, NodeTypes.SYMBOL, NodeTypes.CAT].includes(node);
@@ -358,7 +380,7 @@ RubyVariables.WRAPPER(
             let key;
             switch (route[0]) {
                 case NodeTypes.GROUP:
-                    return "(" + this.build_path_spec(route[1]) + ")";
+                    return `(${this.build_path_spec(route[1])})`;
                 case NodeTypes.CAT:
                     return (this.build_path_spec(route[1]) + this.build_path_spec(route[2]));
                 case NodeTypes.STAR:

data/lib/routes.ts

@@ -40,11 +40,10 @@ type RequiredParameters<T extends number> = T extends 1
     ]
   : RequiredRouteParameter[];
 
-type RouteHelperOptions<T extends string> = RouteOptions &
-  Optional<Record<T, OptionalRouteParameter>>;
+type RouteHelperOptions = RouteOptions & Record<string, OptionalRouteParameter>;
 
-type RouteHelper<T extends number = number, U extends string = string> = ((
-  ...args: [...RequiredParameters<T>, RouteHelperOptions<U>]
+type RouteHelper<T extends number = number> = ((
+  ...args: [...RequiredParameters<T>, RouteHelperOptions]
 ) => string) &
   RouteHelperExtras;
 
@@ -101,7 +100,7 @@ declare const module: { exports: any } | undefined;
 RubyVariables.WRAPPER(
   // eslint-disable-next-line
   (): RouterExposedMethods => {
-    const hasProp = (value: unknown, key: string) =>
+    const hasProp = (value: unknown, key: string): boolean =>
       Object.prototype.hasOwnProperty.call(value, key);
     enum NodeTypes {
       GROUP = 1,
@@ -136,6 +135,16 @@ RubyVariables.WRAPPER(
       define: (routes: RouterExposedMethods) => void;
       isSupported: () => boolean;
     };
+
+    const UnescapedSpecials = "-._~!$&'()*+,;=:@"
+      .split("")
+      .map((s) => s.charCodeAt(0));
+    const UnescapedRanges = [
+      ["a", "z"],
+      ["A", "Z"],
+      ["0", "9"],
+    ].map((range) => range.map((s) => s.charCodeAt(0)));
+
     const ModuleReferences: Record<ModuleType, ModuleDefinition> = {
       CJS: {
         define(routes) {
@@ -216,8 +225,6 @@ RubyVariables.WRAPPER(
       }
     }
 
-    const UriEncoderSegmentRegex = /[^a-zA-Z0-9\-._~!$&'()*+,;=:@]/g;
-
     const ReservedOptions = [
       "anchor",
       "trailing_slash",
@@ -526,9 +533,25 @@ RubyVariables.WRAPPER(
       }
 
       encode_segment(segment: string): string {
-        return segment.replace(UriEncoderSegmentRegex, (str) =>
-          encodeURIComponent(str)
-        );
+        if (segment.match(/^[a-zA-Z0-9-]$/)) {
+          // Performance optimization for 99% of cases
+          return segment;
+        }
+        return (segment.match(/./gu) || [])
+          .map((ch) => {
+            const code = ch.charCodeAt(0);
+            if (
+              UnescapedRanges.find(
+                (range) => code >= range[0] && code <= range[1]
+              ) ||
+              UnescapedSpecials.includes(code)
+            ) {
+              return ch;
+            } else {
+              return encodeURIComponent(ch);
+            }
+          })
+          .join("");
       }
 
       is_optional_node(node: NodeTypes): boolean {
@@ -539,7 +562,7 @@ RubyVariables.WRAPPER(
         let key: string;
         switch (route[0]) {
           case NodeTypes.GROUP:
-            return "(" + this.build_path_spec(route[1]) + ")";
+            return `(${this.build_path_spec(route[1])})`;
           case NodeTypes.CAT:
             return (
               this.build_path_spec(route[1]) + this.build_path_spec(route[2])

data/spec/js_routes/default_serializer_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe JsRoutes, "#serialize" do
 
   before(:each) do
-    evaljs(JsRoutes.generate(module_type: nil, namespace: 'Routes'))
+    evallib(module_type: nil, namespace: 'Routes')
   end
 
   it "should provide this method" do

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

@@ -32,8 +32,8 @@ declare type RequiredParameters<T extends number> = T extends 1 ? [RequiredRoute
     RequiredRouteParameter,
     RequiredRouteParameter
 ] : RequiredRouteParameter[];
-declare type RouteHelperOptions<T extends string> = RouteOptions & Optional<Record<T, OptionalRouteParameter>>;
-declare type RouteHelper<T extends number = number, U extends string = string> = ((...args: [...RequiredParameters<T>, RouteHelperOptions<U>]) => string) & RouteHelperExtras;
+declare type RouteHelperOptions = RouteOptions & Record<string, OptionalRouteParameter>;
+declare type RouteHelper<T extends number = number> = ((...args: [...RequiredParameters<T>, RouteHelperOptions]) => string) & RouteHelperExtras;
 declare type RouteHelpers = Record<string, RouteHelper>;
 declare type Configuration = {
     prefix: string;

data/spec/js_routes/module_types/dts_spec.rb

@@ -105,7 +105,7 @@ DOC
   describe "compiled javascript asset" do
     subject { ERB.new(File.read("app/assets/javascripts/js-routes.js.erb")).result(binding) }
     it "should have js routes code" do
-      is_expected.to include("export const inbox_message_path = __jsr.r(")
+      is_expected.to include("export const inbox_message_path = /*#__PURE__*/ __jsr.r(")
     end
   end
 end

data/spec/js_routes/module_types/esm_spec.rb

@@ -24,7 +24,7 @@ describe JsRoutes, "compatibility with ESM"  do
  * @param {object | undefined} options
  * @returns {string} route path
  */
-export const inboxes_path = __jsr.r
+export const inboxes_path = /*#__PURE__*/ __jsr.r(
 DOC
   end
 
@@ -39,7 +39,7 @@ DOC
   describe "compiled javascript asset" do
     subject { ERB.new(File.read("app/assets/javascripts/js-routes.js.erb")).result(binding) }
     it "should have js routes code" do
-      is_expected.to include("export const inbox_message_path = __jsr.r(")
+      is_expected.to include("export const inbox_message_path = /*#__PURE__*/ __jsr.r(")
     end
   end
 end

data/spec/js_routes/module_types/umd_spec.rb

@@ -79,7 +79,7 @@ DOC
     end
 
     it "should not generate file before initialization" do
-      expect(File.exists?(name)).to be_falsey
+      expect(File.exist?(name)).to be_falsey
     end
   end
 end

data/spec/js_routes/rails_routes_compatibility_spec.rb

@@ -2,11 +2,8 @@ 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(generated_js)
+    evallib(module_type: nil, namespace: 'Routes')
   end
 
   it "should generate collection routing" do
@@ -87,14 +84,22 @@ describe JsRoutes, "compatibility with Rails"  do
     expectjs("Routes.budgie_descendents_path(1)").to eq(test_routes.budgie_descendents_path(1))
   end
 
-  it "should support route with parameters containing symbols that need URI-encoding", :aggregate_failures do
-    expectjs("Routes.inbox_path('#hello')").to eq(test_routes.inbox_path('#hello'))
-    expectjs("Routes.inbox_path('some param')").to eq(test_routes.inbox_path('some param'))
-    expectjs("Routes.inbox_path('some param with more & more encode symbols')").to eq(test_routes.inbox_path('some param with more & more encode symbols'))
-  end
-  it "should support route with parameters containing symbols not need URI-encoding", :aggregate_failures do
-    expectjs("Routes.inbox_path(':some_id')").to eq(test_routes.inbox_path(':some_id'))
-    expectjs("Routes.inbox_path('.+')").to eq(test_routes.inbox_path('.+'))
+  describe "url parameters encoding" do
+
+    it "should support route with parameters containing symbols that need URI-encoding", :aggregate_failures do
+      expectjs("Routes.inbox_path('#hello')").to eq(test_routes.inbox_path('#hello'))
+      expectjs("Routes.inbox_path('some param')").to eq(test_routes.inbox_path('some param'))
+      expectjs("Routes.inbox_path('some param with more & more encode symbols')").to eq(test_routes.inbox_path('some param with more & more encode symbols'))
+    end
+
+    it "should support route with parameters containing symbols not need URI-encoding", :aggregate_failures do
+      expectjs("Routes.inbox_path(':some_id')").to eq(test_routes.inbox_path(':some_id'))
+      expectjs("Routes.inbox_path('.+')").to eq(test_routes.inbox_path('.+'))
+    end
+
+    it "supports emoji characters", :aggregate_failures do
+      expectjs("Routes.inbox_path('💗')").to eq(test_routes.inbox_path('💗'))
+    end
   end
 
   describe "when route has defaults" do

data/spec/js_routes/route_specification_spec.rb

@@ -3,11 +3,8 @@ 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(generated_js)
+    evallib(module_type: nil, namespace: 'Routes')
   end
 
   context "when specs" do

data/spec/js_routes/{zzz_last_post_rails_init_spec.rb → zzz_sprockets_spec.rb}

@@ -47,7 +47,7 @@ describe "after Rails initialization", :slow do
   end
 
   it "should generate routes file" do
-    expect(File.exists?(NAME)).to be_truthy
+    expect(File.exist?(NAME)).to be_truthy
   end
 
   it "should not rewrite routes file if nothing changed" do

data/spec/spec_helper.rb

@@ -54,6 +54,10 @@ rescue MiniRacer::RuntimeError => e
   raise e
 end
 
+def evallib(**options)
+  evaljs(JsRoutes.generate(**options), filename: 'lib/routes.js')
+end
+
 def test_routes
   ::App.routes.url_helpers
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.2.6
+  version: 2.2.8
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
+date: 2023-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -197,7 +197,7 @@ files:
 - spec/js_routes/options_spec.rb
 - spec/js_routes/rails_routes_compatibility_spec.rb
 - spec/js_routes/route_specification_spec.rb
-- spec/js_routes/zzz_last_post_rails_init_spec.rb
+- spec/js_routes/zzz_sprockets_spec.rb
 - spec/spec_helper.rb
 - spec/support/routes.rb
 - spec/tsconfig.json
@@ -222,7 +222,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: Brings Rails named routes to javascript