js-routes 2.2.9 → 2.3.0

data/lib/routes.ts

@@ -4,6 +4,8 @@
  */
 
 type Optional<T> = { [P in keyof T]?: T[P] | null };
+type Collection<T> = Record<string, T>;
+
 type BaseRouteParameter = string | boolean | Date | number;
 type MethodRouteParameter = BaseRouteParameter | (() => BaseRouteParameter);
 type ModelRouteParameter =
@@ -16,9 +18,9 @@ type QueryRouteParameter =
   | OptionalRouteParameter
   | QueryRouteParameter[]
   | { [k: string]: QueryRouteParameter };
-type RouteParameters = Record<string, QueryRouteParameter>;
+type RouteParameters = Collection<QueryRouteParameter>;
 
-type Serializable = Record<string, unknown>;
+type Serializable = Collection<unknown>;
 type Serializer = (value: Serializable) => string;
 type RouteHelperExtras = {
   requiredParams(): string[];
@@ -40,14 +42,14 @@ type RequiredParameters<T extends number> = T extends 1
     ]
   : RequiredRouteParameter[];
 
-type RouteHelperOptions = RouteOptions & Record<string, OptionalRouteParameter>;
+type RouteHelperOptions = RouteOptions & Collection<OptionalRouteParameter>;
 
 type RouteHelper<T extends number = number> = ((
   ...args: [...RequiredParameters<T>, RouteHelperOptions]
 ) => string) &
   RouteHelperExtras;
 
-type RouteHelpers = Record<string, RouteHelper>;
+type RouteHelpers = Collection<RouteHelper>;
 
 type Configuration = {
   prefix: string;
@@ -74,7 +76,7 @@ type KeywordUrlOptions = Optional<{
 
 type RouteOptions = KeywordUrlOptions & RouteParameters;
 
-type PartsTable = Record<string, { r?: boolean; d?: OptionalRouteParameter }>;
+type PartsTable = Collection<{ r?: boolean; d?: OptionalRouteParameter }>;
 
 type ModuleType = "CJS" | "AMD" | "UMD" | "ESM" | "DTS" | "NIL";
 
@@ -94,7 +96,7 @@ declare const define:
   | undefined
   | (((arg: unknown[], callback: () => unknown) => void) & { amd?: unknown });
 
-declare const module: { exports: any } | undefined;
+declare const module: { exports: unknown } | undefined;
 
 // eslint-disable-next-line
 RubyVariables.WRAPPER(
@@ -148,8 +150,9 @@ RubyVariables.WRAPPER(
     const ModuleReferences: Record<ModuleType, ModuleDefinition> = {
       CJS: {
         define(routes) {
-          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          module!.exports = routes;
+          if (module) {
+            module.exports = routes;
+          }
         },
         isSupported() {
           return typeof module === "object";
@@ -157,10 +160,11 @@ RubyVariables.WRAPPER(
       },
       AMD: {
         define(routes) {
-          // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-          define!([], function () {
-            return routes;
-          });
+          if (define) {
+            define([], function () {
+              return routes;
+            });
+          }
         },
         isSupported() {
           return typeof define === "function" && !!define.amd;
@@ -419,6 +423,7 @@ RubyVariables.WRAPPER(
         }
         return { keyword_parameters, query_parameters };
       }
+
       build_route(
         parts: string[],
         required_params: string[],
@@ -450,9 +455,9 @@ RubyVariables.WRAPPER(
         if (url_params.length) {
           result += "?" + url_params;
         }
-        result += keyword_parameters.anchor
-          ? "#" + keyword_parameters.anchor
-          : "";
+        if (keyword_parameters.anchor) {
+          result += "#" + keyword_parameters.anchor;
+        }
         if (absolute) {
           result = this.route_url(keyword_parameters) + result;
         }
@@ -679,7 +684,7 @@ RubyVariables.WRAPPER(
         return (isBrowser && window?.location?.port) || "";
       }
 
-      is_object(value: unknown): value is Record<string, unknown> {
+      is_object(value: unknown): value is Collection<unknown> {
         return (
           typeof value === "object" &&
           Object.prototype.toString.call(value) === "[object Object]"
@@ -717,13 +722,17 @@ RubyVariables.WRAPPER(
         }
       }
 
-      define_module(name: ModuleType, module: RouterExposedMethods): void {
+      define_module(
+        name: ModuleType,
+        module: RouterExposedMethods
+      ): RouterExposedMethods {
         this.ensure_module_supported(name);
         ModuleReferences[name].define(module);
+        return module;
       }
     }
 
-    const Utils = new UtilsClass();
+    const utils = new UtilsClass();
 
     // We want this helper name to be short
     const __jsr = {
@@ -732,25 +741,22 @@ RubyVariables.WRAPPER(
         route_spec: RouteTree,
         absolute?: boolean
       ): RouteHelper {
-        return Utils.route(parts_table, route_spec, absolute);
+        return utils.route(parts_table, route_spec, absolute);
       },
     };
 
-    const result = {
+    return utils.define_module(RubyVariables.MODULE_TYPE, {
       ...__jsr,
       configure: (config: Partial<Configuration>) => {
-        return Utils.configure(config);
+        return utils.configure(config);
       },
       config: (): Configuration => {
-        return Utils.config();
+        return utils.config();
       },
       serialize: (object: Serializable): string => {
-        return Utils.serialize(object);
+        return utils.serialize(object);
       },
       ...RubyVariables.ROUTES_OBJECT,
-    };
-
-    Utils.define_module(RubyVariables.MODULE_TYPE, result);
-    return result;
+    });
   }
 )();

data/lib/tasks/js_routes.rake

@@ -2,13 +2,15 @@ namespace :js do
   desc "Make a js file with all rails route URL helpers"
   task routes: :environment do
     require "js-routes"
-    JsRoutes.generate!
+    JsRoutes.generate!(typed: true)
   end
 
   namespace :routes do
     desc "Make a js file with all rails route URL helpers and typescript definitions for them"
     task typescript: "js:routes" do
-      JsRoutes.definitions!
+      ActiveSupport::Deprecation.warn(
+        "`js:routes:typescript` task is deprecated. Please use `js:routes` instead."
+      )
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.2.9
+  version: 2.3.0
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2024-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -94,48 +94,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.5.2
-- !ruby/object:Gem::Dependency
-  name: bump
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.10.0
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: mini_racer
   requirement: !ruby/object:Gem::Requirement
@@ -150,34 +108,17 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
-description: Generates javascript file that defines all Rails named routes as javascript
-  helpers
+description: Exposes all Rails Routes URL helpers as javascript module
 email: agresso@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
 files:
-- ".document"
-- ".eslintrc.js"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".nvmrc"
-- ".rspec"
-- Appraisals
 - CHANGELOG.md
-- Gemfile
 - LICENSE.txt
-- Rakefile
 - Readme.md
-- VERSION_2_UPGRADE.md
 - app/assets/javascripts/js-routes.js.erb
-- bin/tapioca
-- gemfiles/rails50_sprockets_3.gemfile
-- gemfiles/rails51_sprockets_3.gemfile
-- gemfiles/rails52_sprockets_3.gemfile
-- gemfiles/rails70_sprockets_4.gemfile
-- js-routes.gemspec
 - lib/js-routes.rb
 - lib/js_routes.rb
 - lib/js_routes/configuration.rb
@@ -189,6 +130,7 @@ files:
 - lib/js_routes/middleware.rb
 - lib/js_routes/route.rb
 - lib/js_routes/types.rb
+- lib/js_routes/utils.rb
 - lib/js_routes/version.rb
 - lib/routes.d.ts
 - lib/routes.js
@@ -197,90 +139,15 @@ files:
 - lib/templates/erb.js
 - lib/templates/initializer.rb
 - lib/templates/routes.js.erb
-- package.json
-- sorbet/config
-- sorbet/rbi/annotations/.gitattributes
-- sorbet/rbi/annotations/actionpack.rbi
-- sorbet/rbi/annotations/actionview.rbi
-- sorbet/rbi/annotations/activesupport.rbi
-- sorbet/rbi/annotations/railties.rbi
-- sorbet/rbi/gems/.gitattributes
-- sorbet/rbi/gems/actionpack@7.0.4.1.rbi
-- sorbet/rbi/gems/actionview@7.0.4.1.rbi
-- sorbet/rbi/gems/activesupport@7.0.4.1.rbi
-- sorbet/rbi/gems/appraisal@2.4.1.rbi
-- sorbet/rbi/gems/builder@3.2.4.rbi
-- sorbet/rbi/gems/bump@0.10.0.rbi
-- sorbet/rbi/gems/byebug@11.1.3.rbi
-- sorbet/rbi/gems/coderay@1.1.3.rbi
-- sorbet/rbi/gems/concurrent-ruby@1.2.0.rbi
-- sorbet/rbi/gems/crass@1.0.6.rbi
-- sorbet/rbi/gems/diff-lcs@1.5.0.rbi
-- sorbet/rbi/gems/erubi@1.12.0.rbi
-- sorbet/rbi/gems/i18n@1.12.0.rbi
-- sorbet/rbi/gems/libv8-node@16.10.0.0.rbi
-- sorbet/rbi/gems/loofah@2.19.1.rbi
-- sorbet/rbi/gems/method_source@1.0.0.rbi
-- sorbet/rbi/gems/mini_racer@0.6.3.rbi
-- sorbet/rbi/gems/minitest@5.17.0.rbi
-- sorbet/rbi/gems/netrc@0.11.0.rbi
-- sorbet/rbi/gems/nokogiri@1.14.0.rbi
-- sorbet/rbi/gems/parallel@1.24.0.rbi
-- sorbet/rbi/gems/prettier_print@1.2.1.rbi
-- sorbet/rbi/gems/prism@0.24.0.rbi
-- sorbet/rbi/gems/pry-byebug@3.10.1.rbi
-- sorbet/rbi/gems/pry@0.14.2.rbi
-- sorbet/rbi/gems/racc@1.6.2.rbi
-- sorbet/rbi/gems/rack-test@2.0.2.rbi
-- sorbet/rbi/gems/rack@2.2.6.2.rbi
-- sorbet/rbi/gems/rails-dom-testing@2.0.3.rbi
-- sorbet/rbi/gems/rails-html-sanitizer@1.5.0.rbi
-- sorbet/rbi/gems/railties@7.0.4.1.rbi
-- sorbet/rbi/gems/rake@13.0.6.rbi
-- sorbet/rbi/gems/rbi@0.1.9.rbi
-- sorbet/rbi/gems/rspec-core@3.12.0.rbi
-- sorbet/rbi/gems/rspec-expectations@3.12.2.rbi
-- sorbet/rbi/gems/rspec-mocks@3.12.3.rbi
-- sorbet/rbi/gems/rspec-support@3.12.0.rbi
-- sorbet/rbi/gems/rspec@3.12.0.rbi
-- sorbet/rbi/gems/spoom@1.2.4.rbi
-- sorbet/rbi/gems/sprockets-rails@3.4.2.rbi
-- sorbet/rbi/gems/sprockets@4.2.0.rbi
-- sorbet/rbi/gems/syntax_tree@6.2.0.rbi
-- sorbet/rbi/gems/tapioca@0.12.0.rbi
-- sorbet/rbi/gems/thor@1.2.1.rbi
-- sorbet/rbi/gems/tzinfo@2.0.5.rbi
-- sorbet/rbi/gems/yard-sorbet@0.8.1.rbi
-- sorbet/rbi/gems/yard@0.9.34.rbi
-- sorbet/rbi/gems/zeitwerk@2.6.8.rbi
-- sorbet/rbi/todo.rbi
-- sorbet/tapioca/config.yml
-- sorbet/tapioca/require.rb
-- spec/dummy/app/assets/config/manifest.js
-- spec/dummy/app/assets/javascripts/.gitkeep
-- spec/dummy/config/routes.rb
-- spec/js_routes/default_serializer_spec.rb
-- spec/js_routes/module_types/amd_spec.rb
-- spec/js_routes/module_types/cjs_spec.rb
-- spec/js_routes/module_types/dts/routes.spec.d.ts
-- spec/js_routes/module_types/dts/test.spec.ts
-- spec/js_routes/module_types/dts_spec.rb
-- spec/js_routes/module_types/esm_spec.rb
-- spec/js_routes/module_types/nil_spec.rb
-- spec/js_routes/module_types/umd_spec.rb
-- spec/js_routes/options_spec.rb
-- spec/js_routes/rails_routes_compatibility_spec.rb
-- spec/js_routes/route_specification_spec.rb
-- spec/js_routes/zzz_sprockets_spec.rb
-- spec/spec_helper.rb
-- spec/support/routes.rb
-- spec/tsconfig.json
-- tsconfig.json
-- yarn.lock
 homepage: http://github.com/railsware/js-routes
 licenses:
 - MIT
 metadata:
+  bug_tracker_uri: https://github.com/railsware/js-routes/issues
+  changelog_uri: https://github.com/railsware/js-routes/blob/v2.3.0/CHANGELOG.md
+  documentation_uri: https://github.com/railsware/js-routes
+  source_code_uri: https://github.com/railsware/js-routes/tree/v2.3.0/activerecord
+  rubygems_mfa_required: 'true'
   github_repo: ssh://github.com/railsware/js-routes
 post_install_message:
 rdoc_options: []
@@ -297,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
 summary: Brings Rails named routes to javascript

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/.eslintrc.js

@@ -1,15 +0,0 @@
- module.exports = {
-  root: true,
-  extends: [
-    'eslint:recommended',
-    'plugin:@typescript-eslint/eslint-recommended',
-    'plugin:@typescript-eslint/recommended',
-    'prettier',
-  ],
-  parser: '@typescript-eslint/parser',
-  plugins: ['@typescript-eslint'],
-  rules: {
-    '@typescript-eslint/ban-types': 'off',
-    '@typescript-eslint/no-explicit-any': 'off'
-  },
-};

data/.github/workflows/ci.yml

@@ -1,36 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - master
-  pull_request:
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        ruby: ["2.7"]
-        gemfile:
-          - gemfiles/rails50_sprockets_3.gemfile
-          - gemfiles/rails51_sprockets_3.gemfile
-          - gemfiles/rails52_sprockets_3.gemfile
-          - gemfiles/rails70_sprockets_4.gemfile
-
-    env:
-      BUNDLE_GEMFILE: ${{ matrix.gemfile }}
-    steps:
-      - uses: actions/checkout@v2
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-      - uses: actions/setup-node@v3
-        with:
-          node-version: "16"
-      - name: install dependencies
-        run: |
-          bundle install --jobs 3 --retry 3
-          yarn install
-      - name: test
-        run: bundle exec rake spec

data/.gitignore

@@ -1,65 +0,0 @@
-# rcov generated
-coverage
-
-# rdoc generated
-rdoc
-
-# yard generated
-doc
-.yardoc
-log
-
-# bundler
-.bundle
-
-# jeweler generated
-pkg
-tmp
-
-node_modules
-
-# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
-#
-# * Create a file at ~/.gitignore
-# * Include files you want ignored
-# * Run: git config --global core.excludesfile ~/.gitignore
-#
-# After doing this, these files will be ignored in all your git projects,
-# saving you from having to 'pollute' every project you touch with them
-#
-# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
-#
-# For MacOS:
-#
-#.DS_Store
-
-# For TextMate
-#*.tmproj
-#tmtags
-
-# For emacs:
-#*~
-#\#*
-#.\#*
-
-# For vim:
-#*.swp
-
-# For redcar:
-#.redcar
-
-# For rubinius:
-#*.rbc
-.rvmrc
-.ruby-version
-
-Gemfile.lock
-gemfiles/*.lock
-
-.DS_Store
-
-/spec/dummy/app/assets/javascripts/routes.js
-/spec/dummy/logs
-/spec/dummy/tmp
-node_modules
-

data/.nvmrc

@@ -1 +0,0 @@
-14

data/.rspec

@@ -1 +0,0 @@
---color

data/Appraisals

@@ -1,17 +0,0 @@
-def define_appraisal(rails, version, sprockets)
-  sprockets.each do |sprocket|
-    appraise "#{rails}-sprockets-#{sprocket}" do
-      gem "railties", "~> #{version}"
-      gem "sprockets", "~> #{sprocket}.0"
-    end
-  end
-end
-
-[
-  [:rails50, '5.0.5',  [3]],
-  [:rails51, '5.1.3',  [3]],
-  [:rails52, '5.2.3',  [3]],
-  [:rails70, '7.0.3.1', [4]]
-].each do |name, version, sprockets|
-  define_appraisal(name, version, sprockets)
-end

data/Gemfile

@@ -1,9 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in js-routes.gemspec
-gemspec
-
-group :development do
-  gem 'sorbet', '>= 0.5.11518'
-  gem 'tapioca'
-end

data/Rakefile

@@ -1,37 +0,0 @@
-# encoding: utf-8
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'bundler/gem_tasks'
-require 'rspec/core'
-require 'rspec/core/rake_task'
-require 'appraisal'
-require 'rails/version'
-if Rails.version < "6.1"
-  load "rails/tasks/routes.rake"
-end
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :test_all => :appraisal # test all rails
-
-task :default => :spec
-
-
-namespace :spec do
-  desc "Print all routes defined in test env"
-  task :routes do
-    require './spec/spec_helper'
-    require 'action_dispatch/routing/inspector'
-    draw_routes
-    all_routes = Rails.application.routes.routes
-    inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
-    puts inspector.format(ActionDispatch::Routing::ConsoleFormatter::Sheet.new)
-  end
-end

data/VERSION_2_UPGRADE.md

@@ -1,66 +0,0 @@
-## Version 2.0 upgrade notes
-
-### Using ESM module by default
-
-New version of JsRoutes doesn't try to guess your javascript environment module system because JS has generated a ton of legacy module systems in the past. 
-[ESM+Webpacker](/Readme.md#webpacker) upgrade is recommended. 
-
-However, if you don't want to follow that pass, specify `module_type` configuration option instead based on module system available in your JS environment.
-Here are supported values:
-
-* CJS
-* UMD
-* AMD
-* ESM
-* nil
-
-[Explaination Article](https://dev.to/iggredible/what-the-heck-are-cjs-amd-umd-and-esm-ikm)
-
-If you don't want to use any JS module system and make routes available via a **global variable**, specify `nil` as a `module_type` and use `namespace` option:
-
-``` ruby
-JsRoutes.setup do |config|
-  config.module_type = nil
-  config.namespace = "Routes"
-end
-```
-
-### JSDoc comment
-
-New version of js-routes generates function comment in the [JSDoc](https://jsdoc.app) format.
-If you have any problems with that, you can disable it like this:
-
-
-``` ruby
-JsRoutes.setup do |config|
-  config.documentation = false
-end
-```
-
-### `required_params` renamed
-
-In case you are using `required_params` property, it is now renamed and converted to a method:
-
-``` javascript
-// Old style
-Routes.post_path.required_params  // => ['id']
-// New style
-Routes.post_path.requiredParams() // => ['id']
-```
-
-### ParameterMissing error rework
-
-`ParameterMissing` is renamed to `ParametersMissing` error and now list all missing parameters instead of just first encountered in its message. Missing parameters are now available via `ParametersMissing#keys` property.
-
-``` javascript
-try {
-  return Routes.inbox_path();
-} catch(error) {
-  if (error.name === 'ParametersMissing') {
-    console.warn(`Missing route keys ${error.keys.join(', ')}. Ignoring.`);
-    return "#";
-  } else {
-    throw error;
-  }
-}
-```