js-routes 2.2.3 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b706c51040d12aaa69182dad9d25304ba947fe1e80cc5171775864a27d6f4ed8
-  data.tar.gz: 1a105e8a4dbc9cfde5a787a0714b6e0bf0758b6291f6945f0a16ca9c1e7a47a9
+  metadata.gz: 66ff94f5c78d966f76e2a9f47d1c838c757c3e243c37f03599b24c286b15b9b7
+  data.tar.gz: c5803e4a35b99923769970149f07a6893a84c6343f10f76c8a89645974dce959
 SHA512:
-  metadata.gz: f053d1f48cb8a4f9f7ac7f1e68d37f4816d09e42e0a91660fb84c1e9f4ad36d439019f6f402f1e2fce30467e6b0d5b799fd08bbe70bfc2aa8423c63f053f0bdb
-  data.tar.gz: bdcf72700542350da423e9cf62b4abcc0ba326400c4077c70c5f6174edb75a7e61b6b6a765a0454b4cd1a2fc5ddbf91f3a16294ce995d9ab31d9984153c29b4c
+  metadata.gz: a34c75f950a02a6634687889e4072f7d88f37520a6dc2ba5bfd2ccbbb71962159a70170bf7ac55b22db45de2727f7c573dfce8c80debc33f34abbd9cb1132c1f
+  data.tar.gz: 779b340c9dac721c8b427a16011ed961a05dde4d15594838649fb0860bac42e60344a682718a0b94f35f785350126ca59c7f739dac43cb47e0a7b84e45fa468a

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## master
 
+## v2.2.5
+
+* Fix middleware generator [#300](https://github.com/railsware/js-routes/issues/300)
+* Support `params` special parameter
+
 ## v2.2.4
 
 * Fix rails engine loading if sprockets is not in Gemfile. Fixes [#294](https://github.com/railsware/js-routes/issues/294)

data/Readme.md

@@ -62,7 +62,7 @@ import * as Routes from '../routes';
 alert(Routes.post_path(1))
 ```
 
-Upgrade `rake assets:precompile` to update js-routes files: 
+Upgrade `rake assets:precompile` to update js-routes files in `Rakefile`: 
 
 ``` ruby
 namespace :assets do

data/lib/js_routes/generators/middleware.rb

@@ -52,7 +52,7 @@ end
       {},
       {module_type: 'DTS'}
     ].map do |config|
-      File.join('/', JsRoutes.new(config).configuration.output_file) + "\n"
+      File.join('/', JsRoutes::Configuration.new(config).output_file) + "\n"
     end.join
   end
 end

data/lib/js_routes/instance.rb

@@ -2,7 +2,7 @@ require "js_routes/configuration"
 require "js_routes/route"
 
 module JsRoutes
-  class Instance
+  class Instance # :nodoc:
 
     attr_reader :configuration
     #

data/lib/js_routes/middleware.rb

@@ -21,12 +21,16 @@ module JsRoutes
     def update_js_routes
       new_mtime = routes_mtime
       unless new_mtime == @mtime
-        JsRoutes.generate!
-        JsRoutes.definitions!
+        regenerate
         @mtime = new_mtime
       end
     end
 
+    def regenerate
+      JsRoutes.generate!
+      JsRoutes.definitions!
+    end
+
     def routes_mtime
       File.mtime(@routes_file)
     rescue Errno::ENOENT

data/lib/js_routes/version.rb

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

data/lib/routes.d.ts

@@ -53,6 +53,7 @@ declare type KeywordUrlOptions = Optional<{
     port: string | number;
     anchor: string;
     trailing_slash: boolean;
+    params: RouteParameters;
 }>;
 declare type RouteOptions = KeywordUrlOptions & RouteParameters;
 declare type PartsTable = Record<string, {

data/lib/routes.js

@@ -222,12 +222,23 @@ RubyVariables.WRAPPER(() => {
                 ...options,
             };
             const keyword_parameters = {};
-            const query_parameters = {};
+            let query_parameters = {};
             for (const key in options) {
                 if (!hasProp(options, key))
                     continue;
                 const value = options[key];
-                if (this.is_reserved_option(key)) {
+                if (key === "params") {
+                    if (this.is_object(value)) {
+                        query_parameters = {
+                            ...query_parameters,
+                            ...value,
+                        };
+                    }
+                    else {
+                        throw new Error("params value should always be an object");
+                    }
+                }
+                else if (this.is_reserved_option(key)) {
                     keyword_parameters[key] = value;
                 }
                 else {

data/lib/routes.ts

@@ -70,6 +70,7 @@ type KeywordUrlOptions = Optional<{
   port: string | number;
   anchor: string;
   trailing_slash: boolean;
+  params: RouteParameters;
 }>;
 
 type RouteOptions = KeywordUrlOptions & RouteParameters;
@@ -365,11 +366,20 @@ RubyVariables.WRAPPER(
         };
 
         const keyword_parameters: KeywordUrlOptions = {};
-        const query_parameters: RouteParameters = {};
+        let query_parameters: RouteParameters = {};
         for (const key in options) {
           if (!hasProp(options, key)) continue;
           const value = options[key];
-          if (this.is_reserved_option(key)) {
+          if (key === "params") {
+            if (this.is_object(value)) {
+              query_parameters = {
+                ...query_parameters,
+                ...(value as RouteParameters),
+              };
+            } else {
+              throw new Error("params value should always be an object");
+            }
+          } else if (this.is_reserved_option(key)) {
             keyword_parameters[key] = value as any;
           } else {
             if (

data/spec/js_routes/default_serializer_spec.rb

@@ -7,25 +7,25 @@ describe JsRoutes, "#serialize" do
   end
 
   it "should provide this method" do
-    expect(evaljs("Routes.serialize({a: 1, b: [2,3], c: {d: 4, e: 5}, f: ''})")).to eq(
+    expectjs("Routes.serialize({a: 1, b: [2,3], c: {d: 4, e: 5}, f: ''})").to eq(
       "a=1&b%5B%5D=2&b%5B%5D=3&c%5Bd%5D=4&c%5Be%5D=5&f="
     )
   end
 
   it "should provide this method" do
-    expect(evaljs("Routes.serialize({a: 1, b: [2,3], c: {d: 4, e: 5}, f: ''})")).to eq(
+    expectjs("Routes.serialize({a: 1, b: [2,3], c: {d: 4, e: 5}, f: ''})").to eq(
       "a=1&b%5B%5D=2&b%5B%5D=3&c%5Bd%5D=4&c%5Be%5D=5&f="
     )
   end
 
   it "works with JS suckiness" do
-    expect(evaljs(
+    expectjs(
       [
         "const query = Object.create(null);",
         "query.a = 1;",
         "query.b = 2;",
         "Routes.serialize(query);",
       ].join("\n")
-    )).to eq("a=1&b=2")
+    ).to eq("a=1&b=2")
   end
 end

data/spec/js_routes/module_types/amd_spec.rb

@@ -29,7 +29,7 @@ EOF
   end
 
   it "should working from require" do
-    expect(evaljs("require(['js-routes'], function(r){ return r.inboxes_path(); })")).to eq(test_routes.inboxes_path())
+    expectjs("require(['js-routes'], function(r){ return r.inboxes_path(); })").to eq(test_routes.inboxes_path())
   end
 
 end

data/spec/js_routes/module_types/cjs_spec.rb

@@ -10,6 +10,6 @@ describe JsRoutes, "compatibility with CJS"  do
   end
 
   it "should define module exports" do
-    expect(evaljs("module.exports.inboxes_path()")).to eq(test_routes.inboxes_path())
+    expectjs("module.exports.inboxes_path()").to eq(test_routes.inboxes_path())
   end
 end

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

@@ -53,6 +53,7 @@ declare type KeywordUrlOptions = Optional<{
     port: string | number;
     anchor: string;
     trailing_slash: boolean;
+    params: RouteParameters;
 }>;
 declare type RouteOptions = KeywordUrlOptions & RouteParameters;
 declare type PartsTable = Record<string, {

data/spec/js_routes/module_types/esm_spec.rb

@@ -13,7 +13,7 @@ describe JsRoutes, "compatibility with ESM"  do
   end
 
   it "defines route helpers" do
-    expect(evaljs("inboxes_path()")).to eq(test_routes.inboxes_path())
+    expectjs("inboxes_path()").to eq(test_routes.inboxes_path())
   end
 
   it "exports route helpers" do
@@ -33,7 +33,7 @@ DOC
   end
 
   it "defines utility methods" do
-    expect(evaljs("serialize({a: 1, b: 2})")).to eq({a: 1, b: 2}.to_param)
+    expectjs("serialize({a: 1, b: 2})").to eq({a: 1, b: 2}.to_param)
   end
 
   describe "compiled javascript asset" do

data/spec/js_routes/module_types/nil_spec.rb

@@ -36,7 +36,7 @@ describe JsRoutes, "compatibility with NIL (legacy browser)" do
     end
 
     it "should be possible" do
-      expect(evaljs("r.inboxes_path()")).to eq(test_routes.inboxes_path())
+      expectjs("r.inboxes_path()").to eq(test_routes.inboxes_path())
     end
   end
 
@@ -50,8 +50,8 @@ describe JsRoutes, "compatibility with NIL (legacy browser)" do
       evaljs(generated_js)
     end
     it "should use this namespace for routing" do
-      expect(evaljs("window.Routes")).to be_nil
-      expect(evaljs("window.PHM.inboxes_path")).not_to be_nil
+      expectjs("window.Routes").to be_nil
+      expectjs("window.PHM.inboxes_path").not_to be_nil
     end
 
     describe "is nested" do
@@ -60,7 +60,7 @@ describe JsRoutes, "compatibility with NIL (legacy browser)" do
         let(:_options) { {namespace: "PHM.Routes"} }
 
         it "should use this namespace for routing" do
-          expect(evaljs("PHM.Routes.inboxes_path")).not_to be_nil
+          expectjs("PHM.Routes.inboxes_path").not_to be_nil
         end
       end
 
@@ -68,7 +68,7 @@ describe JsRoutes, "compatibility with NIL (legacy browser)" do
         let(:_options) { {namespace: "PHM.Routes"} }
 
         it "should initialize namespace" do
-          expect(evaljs("window.PHM.Routes.inboxes_path")).not_to be_nil
+          expectjs("window.PHM.Routes.inboxes_path").not_to be_nil
         end
       end
 
@@ -77,8 +77,8 @@ describe JsRoutes, "compatibility with NIL (legacy browser)" do
         let(:_options) { {namespace: "PHM.Routes"} }
 
         it "should not overwrite existing parts" do
-          expect(evaljs("window.PHM.Utils")).not_to be_nil
-          expect(evaljs("window.PHM.Routes.inboxes_path")).not_to be_nil
+          expectjs("window.PHM.Utils").not_to be_nil
+          expectjs("window.PHM.Routes.inboxes_path").not_to be_nil
         end
       end
     end