js-routes 1.2.3 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 55daff16f999cf2dfd6cfdbbe241e6c2cbbb7fbf
-  data.tar.gz: c6e9c73edbaf8f95667565114d844b7fc92788c4
+SHA256:
+  metadata.gz: 66ff94f5c78d966f76e2a9f47d1c838c757c3e243c37f03599b24c286b15b9b7
+  data.tar.gz: c5803e4a35b99923769970149f07a6893a84c6343f10f76c8a89645974dce959
 SHA512:
-  metadata.gz: 50876af1368b52bdabdd1cb4b2f6f85a2c1121c98f24aa0d6f415152edeadf127981f804d6cf2d3b72eff7d8f9cbff3056caa6529b5f3dfd435638fc1ac564c1
-  data.tar.gz: 6dfded8fd06823e2140020c541ce138525bde7c2e7fe6bdfd6b00d2f891069ecc94421fc2a283a8e21cd56e834febbdbb639a7a8afaaebc936274887da39a57c
+  metadata.gz: a34c75f950a02a6634687889e4072f7d88f37520a6dc2ba5bfd2ccbbb71962159a70170bf7ac55b22db45de2727f7c573dfce8c80debc33f34abbd9cb1132c1f
+  data.tar.gz: 779b340c9dac721c8b427a16011ed961a05dde4d15594838649fb0860bac42e60344a682718a0b94f35f785350126ca59c7f739dac43cb47e0a7b84e45fa468a

data/.eslintrc.js

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

data/.gitignore

@@ -14,6 +14,9 @@ log
 
 # jeweler generated
 pkg
+tmp
+
+node_modules
 
 # Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore:
 #
@@ -58,3 +61,5 @@ gemfiles/*.lock
 /spec/dummy/app/assets/javascripts/routes.js
 /spec/dummy/logs
 /spec/dummy/tmp
+node_modules
+

data/.nvmrc

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

data/.travis.yml

@@ -1,25 +1,31 @@
 language: ruby
 cache: bundler
 
+before_install:
+  - gem install bundler # need for jruby and ruby-head
+
 rvm:
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.2
-  - jruby-19mode
+  - 2.4.1
+  - 2.5.3
+  - 2.6.0
   - ruby-head
-  - jruby-head
+  - jruby
 
 gemfile:
-  - gemfiles/rails32.gemfile
-  - gemfiles/rails40.gemfile
-  - gemfiles/rails40_sprockets3.gemfile
-  - gemfiles/rails41.gemfile
-  - gemfiles/rails41_sprockets3.gemfile
-  - gemfiles/rails42.gemfile
-  - gemfiles/rails42_sprockets3.gemfile
+  - gemfiles/rails40_sprockets_2.gemfile
+  - gemfiles/rails40_sprockets_3.gemfile
+  - gemfiles/rails41_sprockets_2.gemfile
+  - gemfiles/rails41_sprockets_3.gemfile
+  - gemfiles/rails42_sprockets_2.gemfile
+  - gemfiles/rails42_sprockets_3.gemfile
+  - gemfiles/rails50_sprockets_3.gemfile
+  - gemfiles/rails51_sprockets_3.gemfile
+  - gemfiles/rails52_sprockets_3.gemfile
+env:
+  TRAVIS_CI: true
 
 sudo: false
+dist: xenial
 
 notifications:
   email:
@@ -30,7 +36,32 @@ branches:
     - master
 
 matrix:
+  fast_finish: true
   allow_failures:
-    - rvm: jruby-19mode
     - rvm: ruby-head
-    - rvm: jruby-head
+    - rvm: jruby
+  exclude:
+    - rvm: 2.6.0
+      gemfile: gemfiles/rails40_sprockets_2.gemfile # Segmentation fault
+    - rvm: 2.6.0
+      gemfile: gemfiles/rails40_sprockets_3.gemfile # Segmentation fault
+    - rvm: 2.6.0
+      gemfile: gemfiles/rails41_sprockets_2.gemfile # Segmentation fault
+    - rvm: 2.6.0
+      gemfile: gemfiles/rails41_sprockets_3.gemfile # Segmentation fault
+    - rvm: 2.5.3
+      gemfile: gemfiles/rails40_sprockets_2.gemfile # Segmentation fault
+    - rvm: 2.5.3
+      gemfile: gemfiles/rails40_sprockets_3.gemfile # Segmentation fault
+    - rvm: 2.5.3
+      gemfile: gemfiles/rails41_sprockets_2.gemfile # Segmentation fault
+    - rvm: 2.5.3
+      gemfile: gemfiles/rails41_sprockets_3.gemfile # Segmentation fault
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails40_sprockets_2.gemfile # Segmentation fault
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails40_sprockets_3.gemfile # Segmentation fault
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails41_sprockets_2.gemfile # Segmentation fault
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails41_sprockets_3.gemfile # Segmentation fault

data/Appraisals

@@ -1,16 +1,19 @@
-appraise "rails32" do
-  gem "railties", "~> 3.2.18"
-  gem 'tzinfo'
-end
-
-{rails40: '4.0.5', rails41: '4.1.1', rails42: '4.2.1'}.each do |rails, version|
-  appraise "#{rails}" do
-    gem "railties", "~> #{version}"
-    gem "sprockets", "< 3"
+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
 
-  appraise "#{rails}-sprockets3" do
-    gem "railties", "~> #{version}"
-    gem "sprockets", "~> 3.0"
-  end
-end
+[
+  [:rails40, '4.0.13', [2, 3]],
+  [:rails41, '4.1.16', [2, 3]],
+  [:rails42, '4.2.9',  [2, 3]],
+  [:rails50, '5.0.5',  [3]],
+  [:rails51, '5.1.3',  [3]],
+  [:rails52, '5.2.3',  [3]]
+].each do |name, version, sprockets|
+  define_appraisal(name, version, sprockets)
+end

data/CHANGELOG.md

@@ -1,5 +1,217 @@
 ## master
 
+## v2.2.5
+
+* Fix middleware generator [#300](https://github.com/railsware/js-routes/issues/300)
+* Support `params` special parameter
+
+## v2.2.4
+
+* Fix rails engine loading if sprockets is not in Gemfile. Fixes [#294](https://github.com/railsware/js-routes/issues/294)
+
+## v2.2.3
+
+* Fixed NIL module type namespace defintion [#297](https://github.com/railsware/js-routes/issues/297).
+  * The patch may cause a problem with nested `namespace` option 
+  * Ex. Value like `MyProject.Routes` requires to define `window.MyProject` before importing the routes file
+
+## v2.2.2.
+
+* Fix custom file path [#295](https://github.com/railsware/js-routes/issues/295)
+
+## v2.2.1
+
+* Improve generator to update route files on `assets:precompile` and add them to `.gitignore by default` [#288](https://github.com/railsware/js-routes/issues/288#issuecomment-1012182815)
+
+## v2.2.0
+
+* Use Rack Middleware to automatically update routes file in development [#288](https://github.com/railsware/js-routes/issues/288)
+  * This setup is now a default recommended due to lack of any downside comparing to [ERB Loader](./Readme.md#webpacker) and [Manual Setup](./Readme.md#advanced-setup)
+
+## v2.1.3
+
+* Fix `default_url_options` bug. [#290](https://github.com/railsware/js-routes/issues/290)
+
+## v2.1.2
+
+* Improve browser window object detection. [#287](https://github.com/railsware/js-routes/issues/287)
+
+## v2.1.1
+
+* Added webpacker generator `./bin/rails generate js_routes:webpacker`
+* Reorganized Readme to describe different setups with their pros and cons more clearly
+
+## v2.1.0
+
+* Support typescript defintions file aka `routes.d.ts`. See [Readme.md](./Readme.md#definitions) for more information.
+
+## v2.0.8
+
+* Forbid usage of `namespace` option if `module_type` is not `nil`. [#281](https://github.com/railsware/js-routes/issues/281).
+
+## v2.0.7
+
+* Remove source map annotation from JS file. Fixes [#277](https://github.com/railsware/js-routes/issues/277)
+  * Generated file is not minified, so it is better to use app side bundler/compressor for source maps
+
+
+## v2.0.6
+
+* Disable `namespace` option default for all envs [#278](https://github.com/railsware/js-routes/issues/278)
+
+## v2.0.5
+
+* Fixed backward compatibility issue [#276](https://github.com/railsware/js-routes/issues/276)
+
+## v2.0.4
+
+* Fixed backward compatibility issue [#275](https://github.com/railsware/js-routes/issues/275)
+
+## v2.0.3
+
+* Fixed backward compatibility issue [#275](https://github.com/railsware/js-routes/issues/275)
+
+## v2.0.2
+
+* Fixed backward compatibility issue [#274](https://github.com/railsware/js-routes/issues/274)
+
+## v2.0.1
+
+* Fixed backward compatibility issue [#272](https://github.com/railsware/js-routes/issues/272)
+
+## v2.0.0
+
+Version 2.0 has some breaking changes.
+See [UPGRADE TO 2.0](./VERSION_2_UPGRADE.md) for guidance.
+
+* `module_type` option support
+* `documentation` option spport
+* Migrated implementation to typescript
+* ESM tree shaking support
+* Support camel case `toParam` version of `to_param` property
+
+## v1.4.14
+
+* Fix compatibility with UMD modules #237 [Comment](https://github.com/railsware/js-routes/issues/237#issuecomment-752754679)
+
+## v1.4.13
+
+* Improve compatibility with node environment #269.
+* Change default file location configuration to Webpacker if both Webpacker and Sprockets are loaded
+
+## v1.4.11
+
+* Use app/javascript/routes.js as a default file location if app/javascript directory exists
+* Add `default` export for better experience when used as es6 module
+
+## v1.4.10
+
+* Require engine only when sprockets is loaded #257.
+
+## v1.4.9
+
+* Allow to specify null namespace and receive routes as an object without assigning it anywhere #247
+
+## v1.4.7
+
+* Fix a LocalJumpError on secondary initialization of the app #248
+
+## v1.4.6
+
+* Fix regression of #244 in #243
+
+## v1.4.5
+
+* Fix escaping inside route parameters and globbing #244
+
+## v1.4.4
+
+* More informative stack trace for ParameterMissing error #235
+
+## v1.4.3
+
+* Proper implementation of the :subdomain option in routes generation
+
+## v1.4.2
+
+* Added JsRoutes namespace to Engine #230
+
+## v1.4.1
+
+* Fixed bug when js-routes is used in envs without window.location #224
+
+
+## v1.4.0
+
+* __breaking change!__ Implemented Routes.config() and Routes.configure instead of Routes.defaults
+
+New methods support 4 options at the moment:
+
+``` js
+Routes.configuration(); // =>
+/*
+{
+  prefix: "",
+  default_url_options: {},
+  special_options_key: '_options',
+  serializer: function(...) { ... }
+}
+*/
+
+Routes.configure({
+ prefix: '/app',
+ default_url_options: {format: 'json'},
+ special_options_key: '_my_options_key',
+ serializer: function(...) { ... }
+});
+```
+
+## v1.3.3
+
+* Improved optional parameters support #216
+
+## v1.3.2
+
+* Added `application` option #214
+
+## v1.3.1
+
+* Raise error object with id null passed as route paramter #209
+* Sprockets bugfixes #212
+
+## v1.3.0
+
+* Introduce the special _options key. Fixes #86
+
+## v1.2.9
+
+* Fixed deprecation varning on Sprockets 3.7
+
+## v1.2.8
+
+* Bugfix warning on Sprockets 4.0 #202
+
+## v1.2.7
+
+* Drop support 1.9.3
+* Add helper for indexOf, if no native implementation in JS engine
+* Add sprockets3 compatibility
+* Bugfix domain defaults to path #197
+
+## v1.2.6
+
+* Use default prefix from `Rails.application.config.relative_url_root` #186
+* Bugfix route globbing with optional fragments bug #191
+
+## v1.2.5
+
+* Bugfix subdomain default parameter in routes #184
+* Bugfix infinite recursion in some specific route sets #183
+
+## v1.2.4
+
+* Additional bugfixes to support all versions of Sprockets: 2.x and 3.x
+
 ## v1.2.3
 
 * Sprockets ~= 3.0 support

data/Rakefile

@@ -12,9 +12,26 @@ 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
+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