js-routes 2.2.7 → 2.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc558c858345b705d2ca048eaab529acf4d4ffe20299e152f1c23fcbeb31388e
-  data.tar.gz: 70dc5ab9c6f629d3236d45a5cf202c6bb8f00893041857f137b9569a3467d48c
+  metadata.gz: 6dfe30c594c24cf044d0f19342e17cd6b23857da7ec68a0bf68d8f8be9f33def
+  data.tar.gz: 3aefa8fc04221f07996ada7c57f35b22d2ae519575a6df0e20c6d860fe6203ed
 SHA512:
-  metadata.gz: 0536cff5b25734ae0c0399cba8d65fb48503e7038c6e5f7396acb69497505ab8849b109e3348bc2c7a010b073cb3cd4aebed1798c538e8bd0e0270f8949dd53c
-  data.tar.gz: 99e9d0487c9062cf3789a8018beba7bcc0b9f985251921cb6f042c20c571d74fab8a4c79f82ad0a6530dde42ee8a678fb5dbfae184dd64e8756ef47d06805b0b
+  metadata.gz: 652fa60215a5c812e3a0cb0284870bfa63c6eeb1d249940388ade48a3f90a7209559d7cf66750e697ffc317bfcd1bec87e57fed44cad375795ead64fb1bcd254
+  data.tar.gz: a68bdb295fb704a5ed753d0576e700668aecfe30d5ec6d425ed458d029eb084de66ff26e0789c808e655574146973db02226a1a48f2cd81fa6ebda3379b7bc8c

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## 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)

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 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

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/version.rb

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

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

@@ -100,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,
@@ -135,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) {
@@ -215,8 +225,6 @@ RubyVariables.WRAPPER(
       }
     }
 
-    const UriEncoderSegmentRegex = /[^a-zA-Z0-9\-._~!$&'()*+,;=:@]/g;
-
     const ReservedOptions = [
       "anchor",
       "trailing_slash",
@@ -525,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 {

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/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.7
+  version: 2.2.8
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-26 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