js-routes 2.2.8 → 2.2.10

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.2.8
+  version: 2.2.10
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-16 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4'
+- !ruby/object:Gem::Dependency
+  name: sorbet-runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sprockets-rails
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +72,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.2.25
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 2.2.25
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -136,33 +150,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
-- 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
@@ -173,6 +171,7 @@ files:
 - lib/js_routes/instance.rb
 - lib/js_routes/middleware.rb
 - lib/js_routes/route.rb
+- lib/js_routes/types.rb
 - lib/js_routes/version.rb
 - lib/routes.d.ts
 - lib/routes.js
@@ -181,32 +180,16 @@ files:
 - lib/templates/erb.js
 - lib/templates/initializer.rb
 - lib/templates/routes.js.erb
-- package.json
-- 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: {}
+metadata:
+  bug_tracker_uri: https://github.com/railsware/js-routes/issues
+  changelog_uri: https://github.com/railsware/js-routes/blob/v2.2.10/CHANGELOG.md
+  documentation_uri: https://github.com/railsware/js-routes
+  source_code_uri: https://github.com/railsware/js-routes/tree/v2.2.10/activerecord
+  rubygems_mfa_required: 'true'
+  github_repo: ssh://github.com/railsware/js-routes
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -222,7 +205,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.15
+rubygems_version: 3.2.22
 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,4 +0,0 @@
-source "http://rubygems.org"
-
-# Specify your gem's dependencies in js-routes.gemspec
-gemspec

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;
-  }
-}
-```

data/gemfiles/rails50_sprockets_3.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "railties", "~> 5.0.5"
-gem "sprockets", "~> 3.0"
-
-gemspec path: "../"

data/gemfiles/rails51_sprockets_3.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "railties", "~> 5.1.3"
-gem "sprockets", "~> 3.0"
-
-gemspec path: "../"

data/gemfiles/rails52_sprockets_3.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "railties", "~> 5.2.3"
-gem "sprockets", "~> 3.0"
-
-gemspec path: "../"

data/gemfiles/rails70_sprockets_4.gemfile

@@ -1,8 +0,0 @@
-# This file was generated by Appraisal
-
-source "http://rubygems.org"
-
-gem "railties", "~> 7.0.3.1"
-gem "sprockets", "~> 4.0"
-
-gemspec path: "../"

data/js-routes.gemspec

@@ -1,39 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'js_routes/version'
-
-Gem::Specification.new do |s|
-  s.name = %q{js-routes}
-  s.version = JsRoutes::VERSION
-
-  if s.respond_to? :required_rubygems_version=
-    s.required_rubygems_version = Gem::Requirement.new(">= 0")
-  end
-  s.authors = ["Bogdan Gusiev"]
-  s.description = %q{Generates javascript file that defines all Rails named routes as javascript helpers}
-  s.email = %q{agresso@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE.txt"
-  ]
-  s.required_ruby_version = '>= 2.4.0'
-  s.files = `git ls-files`.split("\n")
-  s.homepage = %q{http://github.com/railsware/js-routes}
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.summary = %q{Brings Rails named routes to javascript}
-
-  s.add_runtime_dependency(%q<railties>, [">= 4"])
-  s.add_development_dependency(%q<sprockets-rails>)
-  s.add_development_dependency(%q<rspec>, [">= 3.10.0"])
-  s.add_development_dependency(%q<bundler>, [">= 1.1.0"])
-  s.add_development_dependency(%q<appraisal>, [">= 0.5.2"])
-  s.add_development_dependency(%q<bump>, [">= 0.10.0"])
-  if defined?(JRUBY_VERSION)
-    s.add_development_dependency(%q<therubyrhino>, [">= 2.0.4"])
-  else
-    s.add_development_dependency(%q<byebug>)
-    s.add_development_dependency(%q<pry-byebug>)
-    s.add_development_dependency(%q<mini_racer>, [">= 0.4.0"])
-  end
-end

data/package.json

@@ -1,38 +0,0 @@
-{
-  "name": "js-routes",
-  "version": "1.0.0",
-  "main": "index.js",
-  "repository": "git@github.com:railsware/js-routes.git",
-  "author": "Bogdan Gusiev <agresso@gmail.com>, Alexey Vasiliev <https://leopard.in.ua> ",
-  "license": "MIT",
-  "private": false,
-  "devDependencies": {
-    "typescript": "^4.1.2"
-  },
-  "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^4.9.0",
-    "@typescript-eslint/parser": "^4.9.0",
-    "eslint": "^8.35.0",
-    "eslint-config-prettier": "^8.7.0",
-    "eslint-plugin-import": "^2.27.5",
-    "husky": "^4.3.0",
-    "lint-staged": "^10.5.2",
-    "pinst": "^2.1.1",
-    "prettier": "^2.8.4"
-  },
-  "scripts": {
-    "build": "tsc && yarn lint:fix",
-    "lint:fix": "yarn eslint --fix && yarn prettier --write lib/routes.ts",
-    "postinstall": "yarn husky-upgrade"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "yarn lint:fix"
-    }
-  },
-  "lint-staged": {
-    "./lib/routes.ts": [
-      "yarn lint:fix"
-    ]
-  }
-}

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