js-routes 2.2.9 → 2.3.0

data/sorbet/rbi/gems/zeitwerk@2.6.8.rbi

@@ -1,8 +0,0 @@
-# typed: true
-
-# DO NOT EDIT MANUALLY
-# This is an autogenerated file for types exported from the `zeitwerk` gem.
-# Please instead update this file by running `bin/tapioca gem zeitwerk`.
-
-# THIS IS AN EMPTY RBI FILE.
-# see https://github.com/Shopify/tapioca#manually-requiring-parts-of-a-gem

data/sorbet/rbi/todo.rbi

@@ -1,31 +0,0 @@
-# DO NOT EDIT MANUALLY
-# This is an autogenerated file for unresolved constants.
-# Please instead update this file by running `bin/tapioca todo`.
-
-# typed: false
-
-module ::Rhino; end
-module ActionController::MimeResponds::Collector; end
-module ActionDispatch::Flash::FlashHash; end
-module ActionDispatch::Http::Headers; end
-module ActionDispatch::Request::Session; end
-module ActionDispatch::Response; end
-module ActionDispatch::Response::Header; end
-module ActionDispatch::TestRequest; end
-module ActionDispatch::TestResponse; end
-module ActionView::Base; end
-module ActionView::Helpers::SanitizeHelper::ClassMethods; end
-module ActionView::Helpers::TagHelper; end
-module ActionView::Helpers::UrlHelper::ClassMethods; end
-module ActionView::Layouts::ClassMethods; end
-module ActionView::Rendering::ClassMethods; end
-module ActionView::Template::Error; end
-module ActiveSupport::HashWithIndifferentAccess; end
-module MiniRacer::JSError; end
-module Rack::Test::CookieJar; end
-module Sprockets::Context; end
-module Sprockets::VERSION; end
-module Webpacker; end
-class ActionView::ActionViewError; end
-class AbstractController::Base; end
-class ActionController::Base; end

data/sorbet/tapioca/config.yml

@@ -1,13 +0,0 @@
-gem:
-  # Add your `gem` command parameters here:
-  #
-  # exclude:
-  # - gem_name
-  # doc: true
-  # workers: 5
-dsl:
-  # Add your `dsl` command parameters here:
-  #
-  # exclude:
-  # - SomeGeneratorName
-  # workers: 5

data/sorbet/tapioca/require.rb

@@ -1,4 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-# Add your extra requires here (`bin/tapioca require` can be used to bootstrap this list)

data/spec/dummy/app/assets/config/manifest.js

@@ -1,2 +0,0 @@
-//= link_tree ../images
-//= link_directory ../stylesheets .css

data/spec/dummy/config/routes.rb

@@ -1,55 +0,0 @@
-App.routes.draw do
-  resource "3df1b2d050ae5a96eac8565c9daef37a"
-  resource "341f9e69e3db1c344de2fc6551885711"
-  resource "0e1bcb2dc1ce4d80ec15cae9140fb99a"
-  resource "15b91c612530bfc69c70d121c8713da4"
-  resource "49e12936168a64dce4d4ec148104fb5a"
-  resource "d878104611f88952aba49965c1d2d573"
-  resource "0e94bfc3c8aaee5ea09579fe73cbdaff"
-  resource "e1c2dd2ea9c63b380eb0947a0e1f49aa"
-  resource "587c6e26ad7f9a6aa09f81add77b16f5"
-  resource "8e00bfffebe0c874d6dad1c7b8c7cd6b"
-  resource "394482d3515e7e49989a8496afa7d367"
-  resource "4ab9c701622cba87eae50795564abe1c"
-  resource "af4b4a2ea501fefbdb8367eb108b2e14"
-  resource "116d17a93932a9a3e5bd2750665582f9"
-  resource "315f0a62063288cd56373c8a00870596"
-  resource "d5357ec6df4589f81ca8689cf0231667"
-  resource "560a3b8cf807e873843cd889400cd52b"
-  resource "361de6041f545e67db1aeaa6206c8ac7"
-  resource "28b0a54de4a0884386f1e324edc13194"
-  resource "ab77f21a956d956295187806cdf38cd1"
-  resource "0b8a362fd486247fb7c41898709b9815"
-  resource "5efa0a96733bc027b3309ffb54d1d1d0"
-  resource "70a3ee535c59fcf59c58b6d39178833c"
-  resource "5095fc05868c673ce450524f78cd28d3"
-  resource "79b994cfbc79432d644a3b83804f4924"
-  resource "e25125c477cd451fd74a76eaaebc9165"
-  resource "672fbfb432687e2fee7d0e799cc10ea4"
-  resource "2eb8350243305659082eb92b2e5b702c"
-  resource "08c9973b624e10b10dc7235659c81346"
-  resource "fee0d4b123529a2c652bef0ec0116ef2"
-  resource "8422445d2aa176b7733473164c461a2e"
-  resource "c24b8252b235431ca3df21a6ac119062"
-  resource "c08c66c7fc40e9937ff84a86f6c6d18a"
-  resource "964851acca72064d861188150e848d55"
-  resource "d02927a4fd37b37c03dbad5d3c7a4753"
-  resource "2a69df680ff9bd8d3855d9ce5a4e51f7"
-  resource "d8daed677f9a9a6926005afbdeebcf73"
-  resource "83d4db872f5f148e9ead108d483fec78"
-  resource "09f9fb4250595d26f4149b76fcfa957d"
-  resource "956cdb4d3cbf36bb9ccb7c7fcc36a602"
-  resource "02816449a6c929f55f8bad958f25d25a"
-  resource "2dd7ae38bd72f7e8b26aafb5f002d634"
-  resource "c7c9aaa3f7131f1e7dbc9325b3426d3e"
-  resource "7556e7d17c2a26acbad7d5fa86e6e640"
-  resource "d03081ef427a227a808c708282fdc86b"
-  resource "8f610d21e6e499c1eea98ca08191c05f"
-  resource "b6b412ae8a369f6bfc7f312245eacc8c"
-  resource "e9bcda8b00879c49bd7f05afee59a28e"
-  resource "6e89f4baddd4044b42be7c2d3b382567"
-  resource "5959c376d15a609f2e74f4f351d0a565"
-  resource "3b7e418511c305c78f2d2c292a3a1289"
-  resource "87acf6bf6e8191ff8900f420b33d5268"
-  resource "648a9b17078423f29f42aa2ecac1cc7d"
-end

data/spec/js_routes/default_serializer_spec.rb

@@ -1,31 +0,0 @@
-require "spec_helper"
-
-describe JsRoutes, "#serialize" do
-
-  before(:each) do
-    evallib(module_type: nil, namespace: 'Routes')
-  end
-
-  it "should provide this method" do
-    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
-    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
-    expectjs(
-      [
-        "const query = Object.create(null);",
-        "query.a = 1;",
-        "query.b = 2;",
-        "Routes.serialize(query);",
-      ].join("\n")
-    ).to eq("a=1&b=2")
-  end
-end

data/spec/js_routes/module_types/amd_spec.rb

@@ -1,35 +0,0 @@
-require "spec_helper"
-
-describe JsRoutes, "compatibility with AMD/require.js"  do
-
-  before(:each) do
-    evaljs("var global = this;", force: true)
-    evaljs("global.GlobalCheck = {};")
-    evaljs("global.define = function (requirs, callback) { global.GlobalCheck['js-routes'] = callback.call(this); return global.GlobalCheck['js-routes']; };")
-    evaljs("global.define.amd = { jQuery: true };")
-    strRequire =<<EOF
-    global.require = function (r, callback) {
-      var allArgs, i;
-
-      allArgs = (function() {
-        var _i, _len, _results;
-        _results = [];
-        for (_i = 0, _len = r.length; _i < _len; _i++) {
-          i = r[_i];
-          _results.push(global.GlobalCheck[i]);
-        }
-        return _results;
-      })();
-
-      return callback.apply(null, allArgs);
-    };
-EOF
-    evaljs(strRequire)
-    evaljs(JsRoutes.generate(module_type: 'AMD'))
-  end
-
-  it "should working from require" do
-    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

@@ -1,15 +0,0 @@
-require "spec_helper"
-
-describe JsRoutes, "compatibility with CJS"  do
-  before(:each) do
-    evaljs("module = { exports: null }")
-    evaljs(JsRoutes.generate(
-      module_type: 'CJS',
-      include: /^inboxes/
-    ))
-  end
-
-  it "should define module exports" do
-    expectjs("module.exports.inboxes_path()").to eq(test_routes.inboxes_path())
-  end
-end

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,126 +0,0 @@
-
-require "active_support/core_ext/string/strip"
-require "fileutils"
-require "open3"
-require "spec_helper"
-
-describe JsRoutes, "compatibility with DTS"  do
-
-  INCLUDE_OPTION = [/^inboxes$/, /^inbox_message_attachment$/]
-  OPTIONS = {module_type: 'DTS', include: INCLUDE_OPTION}
-
-  let(:extra_options) do
-    {}
-  end
-
-  let(:options) do
-    { module_type: 'DTS', include: INCLUDE_OPTION, **extra_options }
-  end
-
-  let(:generated_js) do
-    JsRoutes.generate(**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
-
-  describe ".definitions" do
-    let(:extra_options) { { module_type: 'ESM' } }
-
-    it "uses DTS module automatically" do
-      generated_js = JsRoutes.definitions(**options)
-      expect(generated_js).to include('export {};')
-    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
-