js-routes 2.2.1 → 2.2.4

data/lib/js_routes.rb

@@ -1,116 +1,12 @@
-require 'uri'
-require "pathname"
-
-if defined?(::Rails) && defined?(::Sprockets::Railtie)
+if defined?(::Rails)
   require 'js_routes/engine'
 end
 require 'js_routes/version'
-require "js_routes/route"
+require "js_routes/configuration"
+require "js_routes/instance"
 require 'active_support/core_ext/string/indent'
 
-class JsRoutes
-
-  class Configuration
-    DEFAULTS = {
-      namespace: nil,
-      exclude: [],
-      include: //,
-      file: nil,
-      prefix: -> { Rails.application.config.relative_url_root || "" },
-      url_links: false,
-      camel_case: false,
-      default_url_options: {},
-      compact: false,
-      serializer: nil,
-      special_options_key: "_options",
-      application: -> { Rails.application },
-      module_type: 'ESM',
-      documentation: true,
-    } #:nodoc:
-
-    attr_accessor(*DEFAULTS.keys)
-
-    def initialize(attributes = nil)
-      assign(DEFAULTS)
-      return unless attributes
-      assign(attributes)
-    end
-
-    def assign(attributes)
-      attributes.each do |attribute, value|
-        value = value.call if value.is_a?(Proc)
-        send(:"#{attribute}=", value)
-      end
-      normalize_and_verify
-      self
-    end
-
-    def [](attribute)
-      send(attribute)
-    end
-
-    def merge(attributes)
-      clone.assign(attributes)
-    end
-
-    def to_hash
-      Hash[*members.zip(values).flatten(1)].symbolize_keys
-    end
-
-    def esm?
-      module_type === 'ESM'
-    end
-
-    def dts?
-      self.module_type === 'DTS'
-    end
-
-    def modern?
-      esm? || dts?
-    end
-
-    def require_esm
-      raise "ESM module type is required" unless modern?
-    end
-
-    def source_file
-      File.dirname(__FILE__) + "/" + default_file_name
-    end
-
-    def output_file
-      webpacker_dir = pathname('app', 'javascript')
-      sprockets_dir = pathname('app','assets','javascripts')
-      file_name = file || default_file_name
-      sprockets_file = sprockets_dir.join(file_name)
-      webpacker_file = webpacker_dir.join(file_name)
-      !Dir.exist?(webpacker_dir) && defined?(::Sprockets) ? sprockets_file : webpacker_file
-    end
-
-    def normalize_and_verify
-      normalize
-      verify
-    end
-
-    protected
-
-    def pathname(*parts)
-      Pathname.new(File.join(*parts))
-    end
-
-    def default_file_name
-      dts? ? "routes.d.ts" : "routes.js"
-    end
-
-    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
+module JsRoutes
 
   #
   # API
@@ -118,8 +14,7 @@ class JsRoutes
 
   class << self
     def setup(&block)
-      configuration.tap(&block) if block
-      configuration.normalize_and_verify
+      configuration.assign(&block)
     end
 
     def configuration
@@ -127,11 +22,11 @@ class JsRoutes
     end
 
     def generate(**opts)
-      new(opts).generate
+      Instance.new(opts).generate
     end
 
-    def generate!(file_name=nil, **opts)
-      new(file: file_name, **opts).generate!
+    def generate!(file_name = configuration.file, **opts)
+      Instance.new(file: file_name, **opts).generate!
     end
 
     def definitions(**opts)
@@ -147,154 +42,6 @@ class JsRoutes
       ActiveSupport::JSON.encode(string)
     end
   end
-
-  attr_reader :configuration
-  #
-  # Implementation
-  #
-
-  def initialize(options = {})
-    @configuration = self.class.configuration.merge(options)
-  end
-
-  def generate
-    # Ensure routes are loaded. If they're not, load them.
-    if named_routes.empty? && application.respond_to?(:reload_routes!)
-      application.reload_routes!
-    end
-    content = File.read(@configuration.source_file)
-
-    if !@configuration.dts?
-      content = js_variables.inject(content) do |js, (key, value)|
-        js.gsub!("RubyVariables.#{key}", value.to_s) ||
-        raise("Missing key #{key} in JS template")
-      end
-    end
-    content + routes_export + prevent_types_export
-  end
-
-  def generate!
-    # Some libraries like Devise did not load their routes yet
-    # so we will wait until initialization process finishes
-    # https://github.com/railsware/js-routes/issues/7
-    Rails.configuration.after_initialize do
-      file_path = Rails.root.join(@configuration.output_file)
-      source_code = generate
-
-      # We don't need to rewrite file if it already exist and have same content.
-      # It helps asset pipeline or webpack understand that file wasn't changed.
-      next if File.exist?(file_path) && File.read(file_path) == source_code
-
-      File.open(file_path, 'w') do |f|
-        f.write source_code
-      end
-    end
-  end
-
-  protected
-
-  def js_variables
-    {
-      'GEM_VERSION'         => JsRoutes::VERSION,
-      'ROUTES_OBJECT'       => routes_object,
-      'RAILS_VERSION'       => ActionPack.version,
-      'DEPRECATED_GLOBBING_BEHAVIOR' => ActionPack::VERSION::MAJOR == 4 && ActionPack::VERSION::MINOR == 0,
-
-      'APP_CLASS'           => application.class.to_s,
-      'NAMESPACE'           => json(@configuration.namespace),
-      'DEFAULT_URL_OPTIONS' => json(@configuration.default_url_options),
-      'PREFIX'              => json(@configuration.prefix),
-      'SPECIAL_OPTIONS_KEY' => json(@configuration.special_options_key),
-      'SERIALIZER'          => @configuration.serializer || json(nil),
-      'MODULE_TYPE'         => json(@configuration.module_type),
-      'WRAPPER'             => @configuration.esm? ? 'const __jsr = ' : '',
-    }
-  end
-
-  def application
-    @configuration.application
-  end
-
-  def json(string)
-    self.class.json(string)
-  end
-
-  def named_routes
-    application.routes.named_routes.to_a
-  end
-
-  def routes_object
-    return json({}) if @configuration.modern?
-    properties = routes_list.map do |comment, name, body|
-      "#{comment}#{name}: #{body}".indent(2)
-    end
-    "{\n" + properties.join(",\n\n") + "}\n"
-  end
-
-  def static_exports
-    [:configure, :config, :serialize].map do |name|
-      [
-        "", name,
-        @configuration.dts? ?
-          "RouterExposedMethods['#{name}']" :
-          "__jsr.#{name}"
-      ]
-    end
-  end
-
-  def routes_export
-    return "" unless @configuration.modern?
-    [*static_exports, *routes_list].map do |comment, name, body|
-      "#{comment}export const #{name}#{export_separator}#{body};\n\n"
-    end.join
-  end
-
-  def prevent_types_export
-    return "" unless @configuration.dts?
-    <<-JS
-// By some reason this line prevents all types in a file
-// from being automatically exported
-export {};
-    JS
-  end
-
-  def export_separator
-    @configuration.dts? ? ': ' : ' = '
-  end
-
-  def routes_list
-    named_routes.sort_by(&:first).flat_map do |_, route|
-      route_helpers_if_match(route) + mounted_app_routes(route)
-    end
-  end
-
-  def mounted_app_routes(route)
-    rails_engine_app = app_from_route(route)
-    if rails_engine_app.respond_to?(:superclass) &&
-       rails_engine_app.superclass == Rails::Engine && !route.path.anchored
-      rails_engine_app.routes.named_routes.flat_map do |_, engine_route|
-        route_helpers_if_match(engine_route, route)
-      end
-    else
-      []
-    end
-  end
-
-  def app_from_route(route)
-    app = route.app
-    # rails engine in Rails 4.2 use additional
-    # ActionDispatch::Routing::Mapper::Constraints, which contain app
-    if app.respond_to?(:app) && app.respond_to?(:constraints)
-      app.app
-    else
-      app
-    end
-  end
-
-  def route_helpers_if_match(route, parent_route = nil)
-    Route.new(@configuration, route, parent_route).helpers
-  end
-
   module Generators
   end
 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, {
@@ -66,7 +67,6 @@ declare const RubyVariables: {
     SPECIAL_OPTIONS_KEY: string;
     DEFAULT_URL_OPTIONS: RouteParameters;
     SERIALIZER: Serializer;
-    NAMESPACE: string;
     ROUTES_OBJECT: RouteHelpers;
     MODULE_TYPE: ModuleType;
     WRAPPER: <T>(callback: T) => T;

data/lib/routes.js

@@ -2,7 +2,7 @@
  * File generated by js-routes RubyVariables.GEM_VERSION
  * Based on Rails RubyVariables.RAILS_VERSION routes of RubyVariables.APP_CLASS
  */
-RubyVariables.WRAPPER((that) => {
+RubyVariables.WRAPPER(() => {
     const hasProp = (value, key) => Object.prototype.hasOwnProperty.call(value, key);
     let NodeTypes;
     (function (NodeTypes) {
@@ -15,8 +15,7 @@ RubyVariables.WRAPPER((that) => {
         NodeTypes[NodeTypes["SLASH"] = 7] = "SLASH";
         NodeTypes[NodeTypes["DOT"] = 8] = "DOT";
     })(NodeTypes || (NodeTypes = {}));
-    const Root = that;
-    const isBroswer = typeof window !== "undefined";
+    const isBrowser = typeof window !== "undefined";
     const ModuleReferences = {
         CJS: {
             define(routes) {
@@ -70,11 +69,11 @@ RubyVariables.WRAPPER((that) => {
             },
         },
         NIL: {
-            define(routes) {
-                Utils.namespace(Root, RubyVariables.NAMESPACE, routes);
+            define() {
+                // Defined using RubyVariables.WRAPPER
             },
             isSupported() {
-                return !RubyVariables.NAMESPACE || !!Root;
+                return true;
             },
         },
         DTS: {
@@ -223,12 +222,23 @@ RubyVariables.WRAPPER((that) => {
                 ...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 {
@@ -422,15 +432,15 @@ RubyVariables.WRAPPER((that) => {
         }
         current_host() {
             var _a;
-            return (isBroswer && ((_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.hostname)) || "";
+            return (isBrowser && ((_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.hostname)) || "";
         }
         current_protocol() {
             var _a, _b;
-            return ((isBroswer && ((_b = (_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.protocol) === null || _b === void 0 ? void 0 : _b.replace(/:$/, ""))) || "http");
+            return ((isBrowser && ((_b = (_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.protocol) === null || _b === void 0 ? void 0 : _b.replace(/:$/, ""))) || "http");
         }
         current_port() {
             var _a;
-            return (isBroswer && ((_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.port)) || "";
+            return (isBrowser && ((_a = window === null || window === void 0 ? void 0 : window.location) === null || _a === void 0 ? void 0 : _a.port)) || "";
         }
         is_object(value) {
             return (typeof value === "object" &&
@@ -445,21 +455,6 @@ RubyVariables.WRAPPER((that) => {
         is_reserved_option(key) {
             return ReservedOptions.includes(key);
         }
-        namespace(object, namespace, routes) {
-            const parts = (namespace === null || namespace === void 0 ? void 0 : namespace.split(".")) || [];
-            if (parts.length === 0) {
-                return;
-            }
-            for (let index = 0; index < parts.length; index++) {
-                const part = parts[index];
-                if (index < parts.length - 1) {
-                    object = object[part] || (object[part] = {});
-                }
-                else {
-                    object[part] = routes;
-                }
-            }
-        }
         configure(new_config) {
             this.configuration = { ...this.configuration, ...new_config };
             return this.configuration;
@@ -502,4 +497,4 @@ RubyVariables.WRAPPER((that) => {
     };
     Utils.define_module(RubyVariables.MODULE_TYPE, result);
     return result;
-})(this);
+})();

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;
@@ -84,7 +85,6 @@ declare const RubyVariables: {
   SPECIAL_OPTIONS_KEY: string;
   DEFAULT_URL_OPTIONS: RouteParameters;
   SERIALIZER: Serializer;
-  NAMESPACE: string;
   ROUTES_OBJECT: RouteHelpers;
   MODULE_TYPE: ModuleType;
   WRAPPER: <T>(callback: T) => T;
@@ -97,7 +97,7 @@ declare const define:
 declare const module: { exports: any } | undefined;
 
 RubyVariables.WRAPPER(
-  (that: unknown): RouterExposedMethods => {
+  (): RouterExposedMethods => {
     const hasProp = (value: unknown, key: string) =>
       Object.prototype.hasOwnProperty.call(value, key);
     enum NodeTypes {
@@ -128,8 +128,7 @@ RubyVariables.WRAPPER(
       [T in keyof RouteNodes]: RouteNode<T>;
     }[keyof RouteNodes];
 
-    const Root = that;
-    const isBroswer = typeof window !== "undefined";
+    const isBrowser = typeof window !== "undefined";
     type ModuleDefinition = {
       define: (routes: RouterExposedMethods) => void;
       isSupported: () => boolean;
@@ -186,11 +185,11 @@ RubyVariables.WRAPPER(
         },
       },
       NIL: {
-        define(routes) {
-          Utils.namespace(Root, RubyVariables.NAMESPACE, routes);
+        define() {
+          // Defined using RubyVariables.WRAPPER
         },
         isSupported() {
-          return !RubyVariables.NAMESPACE || !!Root;
+          return true;
         },
       },
       DTS: {
@@ -367,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 (
@@ -628,17 +636,17 @@ RubyVariables.WRAPPER(
       }
 
       current_host(): string {
-        return (isBroswer && window?.location?.hostname) || "";
+        return (isBrowser && window?.location?.hostname) || "";
       }
 
       current_protocol(): string {
         return (
-          (isBroswer && window?.location?.protocol?.replace(/:$/, "")) || "http"
+          (isBrowser && window?.location?.protocol?.replace(/:$/, "")) || "http"
         );
       }
 
       current_port(): string {
-        return (isBroswer && window?.location?.port) || "";
+        return (isBrowser && window?.location?.port) || "";
       }
 
       is_object(value: unknown): value is Record<string, unknown> {
@@ -660,25 +668,6 @@ RubyVariables.WRAPPER(
         return ReservedOptions.includes(key as any);
       }
 
-      namespace(
-        object: any,
-        namespace: string | null | undefined,
-        routes: unknown
-      ): void {
-        const parts = namespace?.split(".") || [];
-        if (parts.length === 0) {
-          return;
-        }
-        for (let index = 0; index < parts.length; index++) {
-          const part = parts[index];
-          if (index < parts.length - 1) {
-            object = object[part] || (object[part] = {});
-          } else {
-            object[part] = routes;
-          }
-        }
-      }
-
       configure(new_config: Partial<Configuration>): Configuration {
         this.configuration = { ...this.configuration, ...new_config };
         return this.configuration;
@@ -734,4 +723,4 @@ RubyVariables.WRAPPER(
     Utils.define_module(RubyVariables.MODULE_TYPE, result);
     return result;
   }
-)(this);
+)();

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, {
@@ -66,7 +67,6 @@ declare const RubyVariables: {
     SPECIAL_OPTIONS_KEY: string;
     DEFAULT_URL_OPTIONS: RouteParameters;
     SERIALIZER: Serializer;
-    NAMESPACE: string;
     ROUTES_OBJECT: RouteHelpers;
     MODULE_TYPE: ModuleType;
     WRAPPER: <T>(callback: T) => T;

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
 
@@ -45,12 +45,13 @@ describe JsRoutes, "compatibility with NIL (legacy browser)" do
     let(:_presetup) { "" }
     before do
       evaljs("var window = this;")
+      evaljs("window.PHM = {}")
       evaljs(_presetup)
       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
@@ -59,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
 
@@ -67,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
 
@@ -76,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