js-routes 2.2.8 → 2.2.10

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

@@ -1,115 +0,0 @@
-/**
- * File generated by js-routes RubyVariables.GEM_VERSION
- * Based on Rails RubyVariables.RAILS_VERSION routes of RubyVariables.APP_CLASS
- */
-declare type Optional<T> = {
-    [P in keyof T]?: T[P] | null;
-};
-declare type BaseRouteParameter = string | boolean | Date | number;
-declare type MethodRouteParameter = BaseRouteParameter | (() => BaseRouteParameter);
-declare type ModelRouteParameter = {
-    id: MethodRouteParameter;
-} | {
-    to_param: MethodRouteParameter;
-} | {
-    toParam: MethodRouteParameter;
-};
-declare type RequiredRouteParameter = BaseRouteParameter | ModelRouteParameter;
-declare type OptionalRouteParameter = undefined | null | RequiredRouteParameter;
-declare type QueryRouteParameter = OptionalRouteParameter | QueryRouteParameter[] | {
-    [k: string]: QueryRouteParameter;
-};
-declare type RouteParameters = Record<string, QueryRouteParameter>;
-declare type Serializable = Record<string, unknown>;
-declare type Serializer = (value: Serializable) => string;
-declare type RouteHelperExtras = {
-    requiredParams(): string[];
-    toString(): string;
-};
-declare type RequiredParameters<T extends number> = T extends 1 ? [RequiredRouteParameter] : T extends 2 ? [RequiredRouteParameter, RequiredRouteParameter] : T extends 3 ? [RequiredRouteParameter, RequiredRouteParameter, RequiredRouteParameter] : T extends 4 ? [
-    RequiredRouteParameter,
-    RequiredRouteParameter,
-    RequiredRouteParameter,
-    RequiredRouteParameter
-] : RequiredRouteParameter[];
-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;
-    default_url_options: RouteParameters;
-    special_options_key: string;
-    serializer: Serializer;
-};
-interface RouterExposedMethods {
-    config(): Configuration;
-    configure(arg: Partial<Configuration>): Configuration;
-    serialize: Serializer;
-}
-declare type KeywordUrlOptions = Optional<{
-    host: string;
-    protocol: string;
-    subdomain: string;
-    port: string | number;
-    anchor: string;
-    trailing_slash: boolean;
-    params: RouteParameters;
-}>;
-declare type RouteOptions = KeywordUrlOptions & RouteParameters;
-declare type PartsTable = Record<string, {
-    r?: boolean;
-    d?: OptionalRouteParameter;
-}>;
-declare type ModuleType = "CJS" | "AMD" | "UMD" | "ESM" | "DTS" | "NIL";
-declare const RubyVariables: {
-    PREFIX: string;
-    DEPRECATED_GLOBBING_BEHAVIOR: boolean;
-    DEPRECATED_FALSE_PARAMETER_BEHAVIOR: boolean;
-    SPECIAL_OPTIONS_KEY: string;
-    DEFAULT_URL_OPTIONS: RouteParameters;
-    SERIALIZER: Serializer;
-    ROUTES_OBJECT: RouteHelpers;
-    MODULE_TYPE: ModuleType;
-    WRAPPER: <T>(callback: T) => T;
-};
-declare const define: undefined | (((arg: unknown[], callback: () => unknown) => void) & {
-    amd?: unknown;
-});
-declare const module: {
-    exports: any;
-} | undefined;
-export const configure: RouterExposedMethods['configure'];
-
-export const config: RouterExposedMethods['config'];
-
-export const serialize: RouterExposedMethods['serialize'];
-
-/**
- * Generates rails route to
- * /inboxes/:inbox_id/messages/:message_id/attachments/:id(.:format)
- * @param {any} inbox_id
- * @param {any} message_id
- * @param {any} id
- * @param {object | undefined} options
- * @returns {string} route path
- */
-export const inbox_message_attachment_path: ((
-  inbox_id: RequiredRouteParameter,
-  message_id: RequiredRouteParameter,
-  id: RequiredRouteParameter,
-  options?: {format?: OptionalRouteParameter} & RouteOptions
-) => string) & RouteHelperExtras;
-
-/**
- * Generates rails route to
- * /inboxes(.:format)
- * @param {object | undefined} options
- * @returns {string} route path
- */
-export const inboxes_path: ((
-  options?: {format?: OptionalRouteParameter} & RouteOptions
-) => string) & RouteHelperExtras;
-
-// By some reason this line prevents all types in a file
-// from being automatically exported
-export {};

data/spec/js_routes/module_types/dts/test.spec.ts

@@ -1,56 +0,0 @@
-import {
-  inbox_message_attachment_path,
-  inboxes_path,
-  serialize,
-  configure,
-  config,
-} from "./routes.spec";
-
-// Route Helpers
-inboxes_path();
-inboxes_path({
-  locale: "en",
-  search: {
-    q: "ukraine",
-    page: 3,
-    keywords: ["large", "small", { advanced: true }],
-  },
-});
-
-inbox_message_attachment_path(1, "2", true);
-inbox_message_attachment_path(
-  { id: 1 },
-  { to_param: () => "2" },
-  { toParam: () => true }
-);
-inbox_message_attachment_path(1, "2", true, { format: "json" });
-inboxes_path.toString();
-inboxes_path.requiredParams();
-
-// serialize test
-const SerializerArgument = {
-  locale: "en",
-  search: {
-    q: "ukraine",
-    page: 3,
-    keywords: ["large", "small", { advanced: true }],
-  },
-};
-serialize(SerializerArgument);
-config().serializer(SerializerArgument);
-
-// configure test
-configure({
-  default_url_options: { port: 1, host: null },
-  prefix: "",
-  special_options_key: "_options",
-  serializer: (value) => JSON.stringify(value),
-});
-
-// config tests
-const Config = config();
-console.log(
-  Config.prefix,
-  Config.default_url_options,
-  Config.special_options_key
-);

data/spec/js_routes/module_types/dts_spec.rb

@@ -1,111 +0,0 @@
-
-require "active_support/core_ext/string/strip"
-require "fileutils"
-require "open3"
-require "spec_helper"
-
-describe JsRoutes, "compatibility with DTS"  do
-
-  OPTIONS = {module_type: 'DTS', include: [/^inboxes$/, /^inbox_message_attachment$/]}
-  let(:extra_options) do
-    {}
-  end
-
-  let(:generated_js) do
-    JsRoutes.generate(**OPTIONS, **extra_options)
-  end
-
-  context "when file is generated" do
-    let(:dir_name) do
-       File.expand_path(__dir__ + "/dts")
-    end
-
-    let(:file_name) do
-      dir_name + "/routes.spec.d.ts"
-    end
-
-    before do
-      FileUtils.mkdir_p(dir_name)
-      File.write(file_name, generated_js)
-    end
-
-    it "has no compile errors", :slow do
-      command = "yarn tsc --strict --noEmit -p spec/tsconfig.json"
-      stdout, stderr, status = Open3.capture3(command)
-      expect(stderr).to eq("")
-      expect(stdout).to include("Done in ")
-      expect(status).to eq(0)
-    end
-  end
-
-  context "when camel case is enabled" do
-    let(:extra_options) { {camel_case: true} }
-
-    it "camelizes route name and arguments" do
-
-      expect(generated_js).to include(<<-DOC.rstrip)
-/**
- * Generates rails route to
- * /inboxes/:inbox_id/messages/:message_id/attachments/:id(.:format)
- * @param {any} inboxId
- * @param {any} messageId
- * @param {any} id
- * @param {object | undefined} options
- * @returns {string} route path
- */
-export const inboxMessageAttachmentPath: ((
-  inboxId: RequiredRouteParameter,
-  messageId: RequiredRouteParameter,
-  id: RequiredRouteParameter,
-  options?: {format?: OptionalRouteParameter} & RouteOptions
-) => string) & RouteHelperExtras;
-DOC
-    end
-  end
-
-  it "exports route helpers" do
-    expect(generated_js).to include(<<-DOC.rstrip)
-/**
- * Generates rails route to
- * /inboxes(.:format)
- * @param {object | undefined} options
- * @returns {string} route path
- */
-export const inboxes_path: ((
-  options?: {format?: OptionalRouteParameter} & RouteOptions
-) => string) & RouteHelperExtras;
-DOC
-    expect(generated_js).to include(<<-DOC.rstrip)
-/**
- * Generates rails route to
- * /inboxes/:inbox_id/messages/:message_id/attachments/:id(.:format)
- * @param {any} inbox_id
- * @param {any} message_id
- * @param {any} id
- * @param {object | undefined} options
- * @returns {string} route path
- */
-export const inbox_message_attachment_path: ((
-  inbox_id: RequiredRouteParameter,
-  message_id: RequiredRouteParameter,
-  id: RequiredRouteParameter,
-  options?: {format?: OptionalRouteParameter} & RouteOptions
-) => string) & RouteHelperExtras
-DOC
-  end
-
-  it "exports utility methods" do
-    expect(generated_js).to include("export const serialize: RouterExposedMethods['serialize'];")
-  end
-
-  it "prevents all types from automatic export" do
-    expect(generated_js).to include("export {};")
-  end
-
-  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 = /*#__PURE__*/ __jsr.r(")
-    end
-  end
-end

data/spec/js_routes/module_types/esm_spec.rb

@@ -1,45 +0,0 @@
-require "active_support/core_ext/string/strip"
-require "spec_helper"
-
-describe JsRoutes, "compatibility with ESM"  do
-
-  let(:generated_js) {
-    JsRoutes.generate(module_type: 'ESM')
-  }
-
-  before(:each) do
-    # export keyword is not supported by a simulated js environment
-    evaljs(generated_js.gsub("export const ", "const "))
-  end
-
-  it "defines route helpers" do
-    expectjs("inboxes_path()").to eq(test_routes.inboxes_path())
-  end
-
-  it "exports route helpers" do
-    expect(generated_js).to include(<<-DOC.rstrip)
-/**
- * Generates rails route to
- * /inboxes(.:format)
- * @param {object | undefined} options
- * @returns {string} route path
- */
-export const inboxes_path = /*#__PURE__*/ __jsr.r(
-DOC
-  end
-
-  it "exports utility methods" do
-    expect(generated_js).to include("export const serialize = ")
-  end
-
-  it "defines utility methods" do
-    expectjs("serialize({a: 1, b: 2})").to eq({a: 1, b: 2}.to_param)
-  end
-
-  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 = /*#__PURE__*/ __jsr.r(")
-    end
-  end
-end

data/spec/js_routes/module_types/nil_spec.rb

@@ -1,87 +0,0 @@
-require 'spec_helper'
-
-describe JsRoutes, "compatibility with NIL (legacy browser)" do
-  let(:generated_js) do
-    JsRoutes.generate(
-      module_type: nil,
-      include: /book|inboxes|inbox_message/,
-      **_options
-    )
-  end
-
-  let(:_options) { {} }
-  describe "generated js" do
-    subject do
-      generated_js
-    end
-
-    it "should call route function for each route" do
-      is_expected.to include("inboxes_path: __jsr.r(")
-    end
-    it "should have correct function without arguments signature" do
-      is_expected.to include('inboxes_path: __jsr.r({"format":{}}')
-    end
-    it "should have correct function with arguments signature" do
-      is_expected.to include('inbox_message_path: __jsr.r({"inbox_id":{"r":true},"id":{"r":true},"format":{}}')
-    end
-    it "should have correct function signature with unordered hash" do
-      is_expected.to include('inbox_message_attachment_path: __jsr.r({"inbox_id":{"r":true},"message_id":{"r":true},"id":{"r":true},"format":{}}')
-    end
-  end
-
-  describe "inline generation" do
-    let(:_options) { {namespace: nil} }
-    before do
-      evaljs("const r = #{generated_js}")
-    end
-
-    it "should be possible" do
-      expectjs("r.inboxes_path()").to eq(test_routes.inboxes_path())
-    end
-  end
-
-  describe "namespace option" do
-    let(:_options) { {namespace: "PHM"} }
-    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
-      expectjs("window.Routes").to be_nil
-      expectjs("window.PHM.inboxes_path").not_to be_nil
-    end
-
-    describe "is nested" do
-      context "and defined on client" do
-        let(:_presetup) { "window.PHM = {}" }
-        let(:_options) { {namespace: "PHM.Routes"} }
-
-        it "should use this namespace for routing" do
-          expectjs("PHM.Routes.inboxes_path").not_to be_nil
-        end
-      end
-
-      context "but undefined on client" do
-        let(:_options) { {namespace: "PHM.Routes"} }
-
-        it "should initialize namespace" do
-          expectjs("window.PHM.Routes.inboxes_path").not_to be_nil
-        end
-      end
-
-      context "and some parts are defined" do
-        let(:_presetup) { "window.PHM = { Utils: {} };" }
-        let(:_options) { {namespace: "PHM.Routes"} }
-
-        it "should not overwrite existing parts" do
-          expectjs("window.PHM.Utils").not_to be_nil
-          expectjs("window.PHM.Routes.inboxes_path").not_to be_nil
-        end
-      end
-    end
-  end
-end
-

data/spec/js_routes/module_types/umd_spec.rb

@@ -1,85 +0,0 @@
-require "active_support/core_ext/string/strip"
-require "fileutils"
-require 'spec_helper'
-
-describe JsRoutes, "compatibility with UMD" do
-  describe "generated js" do
-    subject do
-      JsRoutes.generate(
-        module_type: 'UMD',
-        include: /book|inboxes|inbox_message/,
-      )
-    end
-
-    it "should include a comment in the header" do
-      app_class = "App"
-
-      is_expected.to include("File generated by js-routes #{JsRoutes::VERSION}")
-      is_expected.to include("Based on Rails #{ActionPack.version} routes of #{app_class}")
-    end
-
-    it "should call route function for each route" do
-      is_expected.to include("inboxes_path: __jsr.r(")
-    end
-    it "should have correct function without arguments signature" do
-      is_expected.to include('inboxes_path: __jsr.r({"format":{}}')
-    end
-    it "should have correct function with arguments signature" do
-      is_expected.to include('inbox_message_path: __jsr.r({"inbox_id":{"r":true},"id":{"r":true},"format":{}}')
-    end
-    it "should have correct function signature with unordered hash" do
-      is_expected.to include('inbox_message_attachment_path: __jsr.r({"inbox_id":{"r":true},"message_id":{"r":true},"id":{"r":true},"format":{}}')
-    end
-
-    it "should have correct function comment with options argument" do
-      is_expected.to include(<<-DOC.rstrip)
-  /**
-   * Generates rails route to
-   * /inboxes(.:format)
-   * @param {object | undefined} options
-   * @returns {string} route path
-   */
-  inboxes_path: __jsr.r
-DOC
-    end
-    it "should have correct function comment with arguments" do
-      is_expected.to include(<<-DOC.rstrip)
-  /**
-   * Generates rails route to
-   * /inboxes/:inbox_id/messages/:message_id/attachments/new(.:format)
-   * @param {any} inbox_id
-   * @param {any} message_id
-   * @param {object | undefined} options
-   * @returns {string} route path
-   */
-  new_inbox_message_attachment_path: __jsr.r
-  DOC
-    end
-
-    it "routes should be sorted in alphabetical order" do
-      expect(subject.index("book_path")).to be <= subject.index("inboxes_path")
-    end
-  end
-
-  describe ".generate!" do
-
-    let(:name) { Rails.root.join('app', 'assets', 'javascripts', 'routes.js') }
-
-    before(:each) do
-      FileUtils.rm_f(name)
-      JsRoutes.generate!(file: name)
-    end
-
-    after(:each) do
-      FileUtils.rm_f(name)
-    end
-
-    after(:all) do
-      FileUtils.rm_f("#{File.dirname(__FILE__)}/../routes.js") # let(:name) is not available here
-    end
-
-    it "should not generate file before initialization" do
-      expect(File.exist?(name)).to be_falsey
-    end
-  end
-end