js-routes 2.3.3 → 2.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1acb75b6e26ae17c5b028fb97d400d0fb061ec582298598e91b05f27a5a9a32c
-  data.tar.gz: 2bc54da6a67463569ad6b239f90392394d666f0b89cde662a09cf35f19b07f85
+  metadata.gz: b8057000afc83b5ce111428c7aec30249f52ef15872db97527757c94fc7faf6d
+  data.tar.gz: f7d4b47f6248278cb53b5cac80807d37aec7a51a1c47f1c4711e1e6bd0d2d3ea
 SHA512:
-  metadata.gz: d4a84398697f1bfb41f9c0dace8d50a805b5aae36de24382bd5b43214e237a776471267046ec01487cb52ab542f0b61cc46f62a32037476af8aa2510d5b87c77
-  data.tar.gz: db690e312707ad1951b9b9905c62400eb1f70eafbeab95aab94920eab5df57c18d6d18cec1e3bc3bbe133d0a2a98308469fe934b955a43f401357284cf29f9c3
+  metadata.gz: 40c3c12d7d4a37089268aebda4b82d2f5d8944d5c16048394c1e38eda270f82f867faed7b129e4c27295bcf8158e998e42b92b552c015303d965c0e2227b0780
+  data.tar.gz: 0f075f81e3d5c0b3d6ed9315e3a34d34857c9c9bf34f136c6884e95b4ab6c6f37c0ebb4ee767eceba98bad7377bd1f4e0bc5e68019c9179fef32b4a7f57b96ea

data/CHANGELOG.md

@@ -1,6 +1,24 @@
 # Changelog
 
-## v2.3.3
+## [2.3.4]
+
+* Fix deprecator usage in `rake js:routes:typescript` [#327](https://github.com/railsware/js-routes/issues/327)
+* Migrate to yarn 4
+* Deprecated `prefix` option in favor of `default_url_options.script_name`.
+* Add support for `script_name` [Rails helper option](https://api.rubyonrails.org/classes/ActionDispatch/Routing/UrlFor.html#method-i-url_for).
+
+``` javascript
+Routes.post_path(1, { script_name: "/myapp" })
+  // => /myapp/post/1
+
+Routes.configure({
+  default_url_options: { script_name: "/myapp" }
+})
+
+Routes.post_path(1) // => /myapp/post/1
+```
+
+## [2.3.3]
 
 * Rework default banner to use `routes.rb` digest instead of timestamp to ensure
   consistent routes.js version accross environments. 
@@ -17,7 +35,7 @@ The new default banner:
  */
 ```
 
-## v2.3.2
+## [2.3.2]
 
 * Add `banner` option that allow to control JSDoc on top of generated file. [#324](https://github.com/bogdan/repo/issues/324).
 
@@ -34,13 +52,13 @@ JsRoutes.setup do |c|
 end
 ```
 
-## v2.3.1
+## [2.3.1]
 
 * Add timestamp on when routes.js was generated into banner.
 * Fix application specified directly without proc. [#323](https://github.com/railsware/js-routes/issues/323)
 * Support `optional_definition_params` option. See [Related Docs](./Readme.md#optional-definition-params).
 
-## v2.3.0
+## [2.3.0]
 
 * Drop support of Rails 4.x
 * Fix support of shakapacker [#321](https://github.com/railsware/js-routes/issues/321).
@@ -48,7 +66,7 @@ end
 * Deprecated `rake js:routes:typescript`.
   `rake js:routes` now automatically detects if types support can be used on not.
 
-## v2.2.10
+## [2.2.10]
 
 * Remove sorbet files from repo
 * Clearly define files included in gem
@@ -56,109 +74,109 @@ end
 * Remove empty object linter warning on DTS module
 * Generators: Add `.ts` extension when searching for main JS file of the project
 
-## v2.2.9
+## [2.2.9]
 
 * Fix middleware error for non-modern setup.
 * Added [Sorbet](https://sorbet.org/) method signatures.
 * Always use DTS module type when calling JsRoutes.definitions or .definitions!.
   [#313](https://github.com/railsware/js-routes/issues/313)
 
-## v2.2.8
+## [2.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
+## [2.2.7]
 
 * Fix ESM Tree Shaking [#306](https://github.com/railsware/js-routes/issues/306)
 
-## v2.2.6
+## [2.2.6]
 
 * Prefer to extend `javascript:build` instead of `assets:precompile`. [#305](https://github.com/railsware/js-routes/issues/305)
 * Add stimulus framework application.js location to generators
 
-## v2.2.5
+## [2.2.5]
 
 * Upgraded eslint and prettier versions [#304](https://github.com/railsware/js-routes/issues/304)
 * Fix middleware generator [#300](https://github.com/railsware/js-routes/issues/300)
 * Support `params` special parameter
 
-## v2.2.4
+## [2.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
+## [2.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
+## [2.2.2]
 
 * Fix custom file path [#295](https://github.com/railsware/js-routes/issues/295)
 
-## v2.2.1
+## [2.2.1]
 
 * Improve generator to update route files on `assets:precompile` and add them to `.gitignore by default` [#288](https://github.com/railsware/js-routes/issues/288#issuecomment-1012182815)
 
-## v2.2.0
+## [2.2.0]
 
 * Use Rack Middleware to automatically update routes file in development [#288](https://github.com/railsware/js-routes/issues/288)
   * This setup is now a default recommended due to lack of any downside comparing to [ERB Loader](./Readme.md#webpacker) and [Manual Setup](./Readme.md#advanced-setup)
 
-## v2.1.3
+## [2.1.3]
 
 * Fix `default_url_options` bug. [#290](https://github.com/railsware/js-routes/issues/290)
 
-## v2.1.2
+## [2.1.2]
 
 * Improve browser window object detection. [#287](https://github.com/railsware/js-routes/issues/287)
 
-## v2.1.1
+## [2.1.1]
 
 * Added webpacker generator `./bin/rails generate js_routes:webpacker`
 * Reorganized Readme to describe different setups with their pros and cons more clearly
 
-## v2.1.0
+## [2.1.0]
 
 * Support typescript defintions file aka `routes.d.ts`. See [Readme.md](./Readme.md#definitions) for more information.
 
-## v2.0.8
+## [2.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
+## [2.0.7]
 
 * Remove source map annotation from JS file. Fixes [#277](https://github.com/railsware/js-routes/issues/277)
   * Generated file is not minified, so it is better to use app side bundler/compressor for source maps
 
 
-## v2.0.6
+## [2.0.6]
 
 * Disable `namespace` option default for all envs [#278](https://github.com/railsware/js-routes/issues/278)
 
-## v2.0.5
+## [2.0.5]
 
 * Fixed backward compatibility issue [#276](https://github.com/railsware/js-routes/issues/276)
 
-## v2.0.4
+## [2.0.4]
 
 * Fixed backward compatibility issue [#275](https://github.com/railsware/js-routes/issues/275)
 
-## v2.0.3
+## [2.0.3]
 
 * Fixed backward compatibility issue [#275](https://github.com/railsware/js-routes/issues/275)
 
-## v2.0.2
+## [2.0.2]
 
 * Fixed backward compatibility issue [#274](https://github.com/railsware/js-routes/issues/274)
 
-## v2.0.1
+## [2.0.1]
 
 * Fixed backward compatibility issue [#272](https://github.com/railsware/js-routes/issues/272)
 
-## v2.0.0
+## [2.0.0]
 
 Version 2.0 has some breaking changes.
 See [UPGRADE TO 2.0](./VERSION_2_UPGRADE.md) for guidance.

data/Readme.md

@@ -353,10 +353,8 @@ Options to configure routes formatting. These options are available both in Ruby
 
 * `default_url_options` - default parameters used when generating URLs
   * Example: `{format: "json", trailing_slash: true, protocol: "https", subdomain: "api", host: "example.com", port: 3000}`
+  * See [`url_for` doc](https://api.rubyonrails.org/classes/ActionDispatch/Routing/UrlFor.html#method-i-url_for) for list of supported options
   * Default: `{}`
-* `prefix` - string that will prepend any generated URL. Usually used when app URL root includes a path component.
-  * Example: `/rails-app`
-  * Default: `Rails.application.config.relative_url_root`
 * `serializer` - a JS function that serializes a Javascript Hash object into URL paramters like `{a: 1, b: 2} => "a=1&b=2"`.
   * Default: `nil`. Uses built-in serializer compatible with Rails
   * Example: `jQuery.param` - use jQuery's serializer algorithm. You can attach serialize function from your favorite AJAX framework.

data/lib/js_routes/configuration.rb

@@ -19,7 +19,7 @@ module JsRoutes
     sig { returns(FileName) }
     attr_accessor :file
     sig { returns(Prefix) }
-    attr_accessor :prefix
+    attr_reader :prefix
     sig { returns(T::Boolean) }
     attr_accessor :url_links
     sig { returns(T::Boolean) }
@@ -91,6 +91,11 @@ module JsRoutes
       public_send(attribute)
     end
 
+    def prefix=(value)
+      JsRoutes::Utils.deprecator.warn("JsRoutes configuration prefix is deprecated in favor of default_url_options.script_name.")
+      @prefix = value
+    end
+
     sig { params(attributes: Options).returns(JsRoutes::Configuration) }
     def merge(attributes)
       clone.assign(attributes)

data/lib/js_routes/instance.rb

@@ -26,7 +26,7 @@ module JsRoutes
       # Ensure routes are loaded. If they're not, load them.
 
       application = T.unsafe(self.application)
-      if named_routes.empty?
+      if routes_from(application).empty?
         if application.is_a?(Rails::Application)
           if Rails.version >= "8.0.0"
             T.unsafe(application).reload_routes_unless_loaded
@@ -135,9 +135,9 @@ module JsRoutes
       JsRoutes.json(value)
     end
 
-    sig { returns(T::Hash[Symbol, JourneyRoute]) }
-    def named_routes
-      T.unsafe(application).routes.named_routes.to_h
+    sig {params(application: Application).returns(T::Array[JourneyRoute])}
+    def routes_from(application)
+      T.unsafe(application).routes.named_routes.to_h.values.sort_by(&:name)
     end
 
     sig { returns(String) }
@@ -186,7 +186,7 @@ export {};
 
     sig { returns(T::Array[StringArray]) }
     def routes_list
-      named_routes.sort_by(&:first).flat_map do |_, route|
+      routes_from(application).flat_map do |route|
         route_helpers_if_match(route) + mounted_app_routes(route)
       end
     end
@@ -196,7 +196,7 @@ export {};
       rails_engine_app = T.unsafe(app_from_route(route))
       if rails_engine_app.is_a?(Class) &&
           rails_engine_app < Rails::Engine && !route.path.anchored
-        T.unsafe(rails_engine_app).routes.named_routes.flat_map do |_, engine_route|
+        routes_from(rails_engine_app).flat_map do |engine_route|
           route_helpers_if_match(engine_route, route)
         end
       else

data/lib/js_routes/utils.rb

@@ -13,6 +13,15 @@ module JsRoutes
         nil
       end
     end
+
+    sig { returns(T.untyped) }
+    def self.deprecator
+      if defined?(Rails) && Rails.version >= "7.1.0"
+        Rails.deprecator
+      else
+        ActiveSupport::Deprecation
+      end
+    end
   end
 
 end

data/lib/js_routes/version.rb

@@ -1,4 +1,4 @@
 # typed: strict
 module JsRoutes
-  VERSION = "2.3.3"
+  VERSION = "2.3.4"
 end

data/lib/routes.d.ts

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

data/lib/routes.js

@@ -110,6 +110,7 @@ RubyVariables.WRAPPER(
         "host",
         "port",
         "protocol",
+        "script_name",
     ];
     class UtilsClass {
         constructor() {
@@ -275,21 +276,29 @@ RubyVariables.WRAPPER(
         }
         build_route(parts, required_params, default_options, route, absolute, args) {
             const { keyword_parameters, query_parameters } = this.partition_parameters(parts, required_params, default_options, args);
+            let { trailing_slash, anchor, script_name } = keyword_parameters;
             const missing_params = required_params.filter((param) => !hasProp(query_parameters, param) ||
                 this.is_nullable(query_parameters[param]));
             if (missing_params.length) {
                 throw new ParametersMissing(...missing_params);
             }
             let result = this.get_prefix() + this.visit(route, query_parameters);
-            if (keyword_parameters.trailing_slash) {
+            if (trailing_slash) {
                 result = result.replace(/(.*?)[/]?$/, "$1/");
             }
             const url_params = this.serialize(query_parameters);
             if (url_params.length) {
                 result += "?" + url_params;
             }
-            if (keyword_parameters.anchor) {
-                result += "#" + keyword_parameters.anchor;
+            if (anchor) {
+                result += "#" + anchor;
+            }
+            if (script_name) {
+                const last_index = script_name.length - 1;
+                if (script_name[last_index] == "/" && result[0] == "/") {
+                    script_name = script_name.slice(0, last_index);
+                }
+                result = script_name + result;
             }
             if (absolute) {
                 result = this.route_url(keyword_parameters) + result;
@@ -481,6 +490,9 @@ RubyVariables.WRAPPER(
             return ReservedOptions.includes(key);
         }
         configure(new_config) {
+            if (new_config.prefix) {
+                console.warn("JsRoutes configuration prefix option is deprecated in favor of default_url_options.script_name.");
+            }
             this.configuration = { ...this.configuration, ...new_config };
             return this.configuration;
         }

data/lib/routes.ts

@@ -66,6 +66,7 @@ type KeywordUrlOptions = Optional<{
   port: string | number;
   anchor: string;
   trailing_slash: boolean;
+  script_name: string;
   params: RouteParameters;
 }>;
 
@@ -230,7 +231,9 @@ RubyVariables.WRAPPER(
       "host",
       "port",
       "protocol",
+      "script_name",
     ] as const;
+
     type ReservedOption = (typeof ReservedOptions)[any];
 
     class UtilsClass {
@@ -433,6 +436,8 @@ RubyVariables.WRAPPER(
             default_options,
             args
           );
+
+        let { trailing_slash, anchor, script_name } = keyword_parameters;
         const missing_params = required_params.filter(
           (param) =>
             !hasProp(query_parameters, param) ||
@@ -442,15 +447,22 @@ RubyVariables.WRAPPER(
           throw new ParametersMissing(...missing_params);
         }
         let result = this.get_prefix() + this.visit(route, query_parameters);
-        if (keyword_parameters.trailing_slash) {
+        if (trailing_slash) {
           result = result.replace(/(.*?)[/]?$/, "$1/");
         }
         const url_params = this.serialize(query_parameters);
         if (url_params.length) {
           result += "?" + url_params;
         }
-        if (keyword_parameters.anchor) {
-          result += "#" + keyword_parameters.anchor;
+        if (anchor) {
+          result += "#" + anchor;
+        }
+        if (script_name) {
+          const last_index = script_name.length - 1;
+          if (script_name[last_index] == "/" && result[0] == "/") {
+            script_name = script_name.slice(0, last_index);
+          }
+          result = script_name + result;
         }
         if (absolute) {
           result = this.route_url(keyword_parameters) + result;
@@ -696,6 +708,11 @@ RubyVariables.WRAPPER(
       }
 
       configure(new_config: Partial<Configuration>): Configuration {
+        if (new_config.prefix) {
+          console.warn(
+            "JsRoutes configuration prefix option is deprecated in favor of default_url_options.script_name."
+          );
+        }
         this.configuration = { ...this.configuration, ...new_config };
         return this.configuration;
       }

data/lib/tasks/js_routes.rake

@@ -8,7 +8,7 @@ namespace :js do
   namespace :routes do
     desc "Make a js file with all rails route URL helpers and typescript definitions for them"
     task typescript: "js:routes" do
-      ActiveSupport::Deprecation.warn(
+      JsRoutes::Utils.deprecator.warn(
         "`js:routes:typescript` task is deprecated. Please use `js:routes` instead."
       )
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.3.4
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-04 00:00:00.000000000 Z
+date: 2024-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -144,9 +144,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/railsware/js-routes/issues
-  changelog_uri: https://github.com/railsware/js-routes/blob/v2.3.3/CHANGELOG.md
+  changelog_uri: https://github.com/railsware/js-routes/blob/v2.3.4/CHANGELOG.md
   documentation_uri: https://github.com/railsware/js-routes
-  source_code_uri: https://github.com/railsware/js-routes/tree/v2.3.3/activerecord
+  source_code_uri: https://github.com/railsware/js-routes/tree/v2.3.4/activerecord
   rubygems_mfa_required: 'true'
   github_repo: ssh://github.com/railsware/js-routes
 post_install_message:
@@ -164,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Brings Rails named routes to javascript