js-routes 2.2.9 → 2.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d890e17e32f816311de89a16506fca4b8ff905ea773c7a8d198343e0270eb50a
-  data.tar.gz: 934c79a8b93e7129778e07789f93ac90d4183bd39ea578551f4ea9ca6cab22d2
+  metadata.gz: f69479723e452f1b4ed09bf940b3150ad45430b5c601f966f05a082bce0a9494
+  data.tar.gz: bd47ceb7b1cba241262b8308e913f7d87aef6304d93d9185026e70dd4980487f
 SHA512:
-  metadata.gz: 6adcfbfefbbf13c8f46198f9bf2ca47efdac35aa8d28a8b17be7b8af65d321a3ba0da30dd26e40c4a329c359f1a02b865adb74a1d5e3d024b61bae7fd6f8d9e0
-  data.tar.gz: 9cc86f32f79975aace5a264ef94d7bbe1afb41a7a141c738969c762479789fa74b1fb752139320f8ddd7c25b2eb164fe14cbcc3c6eb1a40046549538c3a6eb33
+  metadata.gz: 4f67b2ccc88195647ea7c694f935848aad52ddd9e46ac1a766df0c29b7e123a147169deb5b8207c8d3a598fcf0c0ba01f98b0d24ee30b326737200f02f2f8235
+  data.tar.gz: 9aad6d181099b3fdd7ada0facf1269e08669cd1181f94d3039f0e13f8bf2bc5a44172e13843fec5a8317b4c99e1eee6a2de2343e34fe6c3cddebb7a63f9608fb

data/CHANGELOG.md

@@ -4,10 +4,15 @@
 
 ## v2.2.10
 
-* Fix middleware error for non-modern setup.
+* Remove sorbet files from repo
+* Clearly define files included in gem
+* Fix Middleware and Middleware generator bugs [#316](https://github.com/railsware/js-routes/issue/316)
+* Remove empty object linter warning on DTS module
+* Generators: Add `.ts` extension when searching for main JS file of the project
 
 ## v2.2.9
 
+* Fix middleware error for non-modern setup.
 * Added [Sorbet](https://sorbet.org/) method signatures.
 * Always use DTS module type when calling JsRoutes.definitions or .definitions!. [#313](https://github.com/railsware/js-routes/issues/313)
 

data/lib/js_routes/generators/base.rb

@@ -3,13 +3,18 @@ require "rails/generators"
 
 class JsRoutes::Generators::Base < Rails::Generators::Base
 
-  source_root File.expand_path(__FILE__ + "/../../../templates")
+  def self.inherited(subclass)
+    super
+    subclass.source_root(File.expand_path(__FILE__ + "/../../../templates"))
+  end
 
   protected
 
   def application_js_path
     [
+      "app/javascript/packs/application.ts",
       "app/javascript/packs/application.js",
+      "app/javascript/controllers/application.ts",
       "app/javascript/controllers/application.js",
     ].find do |path|
       File.exist?(Rails.root.join(path))

data/lib/js_routes/generators/middleware.rb

@@ -11,7 +11,7 @@ class JsRoutes::Generators::Middleware < JsRoutes::Generators::Base
       inject_into_file path, pack_content
     end
     JsRoutes.generate!
-    JsRoutes.definitions!
+    JsRoutes.definitions! if JsRoutes.configuration.modern?
   end
 
   protected
@@ -34,9 +34,10 @@ alert(`JsRoutes installed.\\nYour root path is ${root_path()}`)
 
   def rakefile_content
     enhanced_task = depends_on_js_bundling? ? "javascript:build" : "assets:precompile"
+    dependency_task = JsRoutes.configuration.modern? ? "js:routes:typescript" : 'js:routes'
     <<-RB
 # Update js-routes file before javascript build
-task "#{enhanced_task}" => "js:routes:typescript"
+task "#{enhanced_task}" => "#{dependency_task}"
     RB
   end
 

data/lib/js_routes/instance.rb

@@ -2,6 +2,7 @@
 require "js_routes/configuration"
 require "js_routes/route"
 require "js_routes/types"
+require 'fileutils'
 
 module JsRoutes
   class Instance # :nodoc:
@@ -57,6 +58,13 @@ module JsRoutes
       end
     end
 
+    sig { void }
+    def remove!
+      path = Rails.root.join(@configuration.output_file)
+      FileUtils.rm_rf(path)
+      FileUtils.rm_rf(path.sub(%r{\.js\z}, '.d.ts'))
+    end
+
     protected
 
     sig { returns(T::Hash[String, String]) }

data/lib/js_routes/middleware.rb

@@ -9,16 +9,18 @@ module JsRoutes
   # https://github.com/fnando/i18n-js/blob/main/lib/i18n/js/middleware.rb
   class Middleware
     include JsRoutes::Types
+    include RackApp
+
     extend T::Sig
 
-    sig { params(app: T.proc.params(a0: StringHash).returns(UntypedArray)).void }
+    sig { params(app: T.untyped).void }
     def initialize(app)
       @app = app
       @routes_file = T.let(Rails.root.join("config/routes.rb"), Pathname)
       @mtime = T.let(nil, T.nilable(Time))
     end
 
-    sig { params(env: StringHash).returns(UntypedArray) }
+    sig { override.params(env: StringHash).returns(UntypedArray) }
     def call(env)
       update_js_routes
       @app.call(env)

data/lib/js_routes/route.rb

@@ -65,13 +65,15 @@ module JsRoutes
 
     sig { returns(String) }
     def definition_body
+      options_type = optional_parts_type ? "#{optional_parts_type} & RouteOptions" : "RouteOptions"
       args = required_parts.map{|p| "#{apply_case(p)}: RequiredRouteParameter"}
-      args << "options?: #{optional_parts_type} & RouteOptions"
+      args << "options?: #{options_type}"
       "((\n#{args.join(",\n").indent(2)}\n) => string) & RouteHelperExtras"
     end
 
-    sig { returns(String) }
+    sig { returns(T.nilable(String)) }
     def optional_parts_type
+      return nil if optional_parts.empty?
       @optional_parts_type ||= T.let(
         "{" + optional_parts.map {|p| "#{p}?: OptionalRouteParameter"}.join(', ') + "}",
         T.nilable(String)

data/lib/js_routes/types.rb

@@ -24,5 +24,15 @@ module JsRoutes
     Prefix = T.type_alias do
       T.any(T.proc.returns(String), String, NilClass)
     end
+
+    module RackApp
+      extend T::Sig
+      extend T::Helpers
+
+      interface!
+
+      sig { abstract.params(input: StringHash).returns(UntypedArray) }
+      def call(input); end
+    end
   end
 end

data/lib/js_routes/version.rb

@@ -1,4 +1,4 @@
 # typed: strict
 module JsRoutes
-  VERSION = "2.2.9"
+  VERSION = "2.2.10"
 end

data/lib/js_routes.rb

@@ -39,6 +39,11 @@ module JsRoutes
       Instance.new(file: file_name, **opts).generate!
     end
 
+    sig { params(file_name: FileName, opts: T.untyped).void }
+    def remove!(file_name = configuration.file, **opts)
+      Instance.new(file: file_name, **opts).remove!
+    end
+
     sig { params(opts: T.untyped).returns(String) }
     def definitions(**opts)
       generate(**opts, module_type: 'DTS',)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.2.9
+  version: 2.2.10
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-02 00:00:00.000000000 Z
+date: 2024-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -150,34 +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
-- 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
@@ -197,90 +180,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.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: []

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

data/bin/tapioca

@@ -1,27 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'tapioca' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
-
-bundle_binstub = File.expand_path("bundle", __dir__)
-
-if File.file?(bundle_binstub)
-  if File.read(bundle_binstub, 300).include?("This file was generated by Bundler")
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("tapioca", "tapioca")

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: "../"