js-routes 1.4.9 → 1.4.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcc3b758ce05ed0444162cda94d5442b811a582330ea4418cf816763e4e482b0
-  data.tar.gz: 3bfd8cc484ba00a6cd7ff0e5ffb90c3f3ec11c1d7aa9171572e93bc66b1cab42
+  metadata.gz: 9c3f51f23d5304f6e3df508ebada74e685ec6305b478f556cb76c8d6ad99a7ff
+  data.tar.gz: '081dda3bca55d88f5ad34089e9754a219c3603af20987aef0781beb1e57ed79e'
 SHA512:
-  metadata.gz: a51ee9fc01642e16287b648085debd75749b983b2602a2407068cc7159cd302f8b04bd065b1ea28f7314cd19ae60e535cede86af4e7d7073648ffe2b3222d006
-  data.tar.gz: a979758f820232a129f9befd597a248511c76b05eab8aae5b62b56bf31a2f94580b889371aa52e584aac0fdfd5802a03f1632eaee65713b2438d98e29265846b
+  metadata.gz: 98370a987b6d01b7d3eeab333767b50f668ed67cadeb51a5b7ce9298c85e51ef9edae8081a4396af46096a1dfa0b9854e32b548baef18e1774031c0ed31b0b38
+  data.tar.gz: e55fa57008421373e99cb9674701d64dc59dc79db419ab216a004bb76405950be5d8c906e4fbdc066d16c74fef0292b7de750da8a314703514736e936dcdaff0

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 ## master
 
+* 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

data/Readme.md

@@ -40,7 +40,7 @@ JsRoutes.setup do |config|
 end
 ```
 
-Or dynamically in JavaScript, although not all configuration options are supported:
+Or dynamically in JavaScript, although only [Formatter Options](#formatter-options) are supported (see below)
 
 ``` js
 Routes.configure({
@@ -49,47 +49,57 @@ Routes.configure({
 Routes.config(); // current config
 ```
 
-Available options:
+#### Available Options
+
+##### Generator Options
+
+Options to configure JavaScript file generator:
 
-* `default_url_options` - default parameters used when generating URLs
-  * Option is configurable at JS level with `Routes.configure()`
-  * Example: {:format => "json", :trailing\_slash => true, :protocol => "https", :subdomain => "api", :host => "example.com", :port => 3000}
-  * Default: {}
 * `exclude` - Array of regexps to exclude from routes.
-  * Default: []
+  * Default: `[]`
   * The regexp applies only to the name before the `_path` suffix, eg: you want to match exactly `settings_path`, the regexp should be `/^settings$/`
 * `include` - Array of regexps to include in routes.
-  * Default: []
+  * Default: `[]`
   * The regexp applies only to the name before the `_path` suffix, eg: you want to match exactly `settings_path`, the regexp should be `/^settings$/`
 * `namespace` - global object used to access routes.
   * Supports nested namespace like `MyProject.routes`
   * Default: `Routes`
+* `camel_case` - Generate camel case route names.
+  * Default: `false`
+* `url_links` - Generate `*_url` helpers (in addition to the default `*_path` helpers).
+  * Example: `true`
+  * Default: `false`
+  * Note: generated URLs will first use the protocol, host, and port options specified in the route definition. Otherwise, the URL will be based on the option specified in the `default_url_options` config. If no default option has been set, then the URL will fallback to the current URL based on `window.location`.
+* `compact` - Remove `_path` suffix in path routes(`*_url` routes stay untouched if they were enabled)
+  * Default: `false`
+  * Sample route call when option is set to true: Routes.users() => `/users`
+* `application` - a key to specify which rails engine you want to generate routes too.
+  * This option allows to only generate routes for a specific rails engine, that is mounted into routes instead of all Rails app routes
+  * Default: `Rails.application`
+* `file` - a file location where generated routes are stored
+  * Default: `app/assets/javascripts/routes.js` if `app/assets/javascripts` directory exists, otherwise `app/javascript/routes.js`.
+
+##### Formatter Options
+
+Options to configure routes formatting:
+
+* `default_url_options` - default parameters used when generating URLs
+  * Option is configurable at JS level with `Routes.configure()`
+  * Example: `{format: "json", trailing_slash: true, protocol: "https", subdomain: "api", host: "example.com", port: 3000}`
+  * Default: `{}`
 * `prefix` - String representing a url path to prepend to all paths.
   * Option is configurable at JS level with `Routes.configure()`
   * Example: `http://yourdomain.com`. This will cause route helpers to generate full path only.
   * Default: `Rails.application.config.relative_url_root`
-* `camel_case` (version >= 0.8.8) - Generate camel case route names.
-  * Default: false
-* `url_links` (version >= 0.8.9) - Generate `*_url` helpers (in addition to the default `*_path` helpers).
-  * Example: true
-  * Default: false
-  * Note: generated URLs will first use the protocol, host, and port options specified in the route definition. Otherwise, the URL will be based on the option specified in the `default_url_options` config. If no default option has been set, then the URL will fallback to the current URL based on `window.location`.
-* `compact` (version > 0.9.9) - Remove `_path` suffix in path routes(`*_url` routes stay untouched if they were enabled)
-  * Default: false
-  * Sample route call when option is set to true: Routes.users() => `/users`
-* `serializer` (version >= 1.1.0) - Puts a JS function here that serializes a Javascript Hash object into URL paramters: `{a: 1, b: 2} => "a=1&b=2"`.
-  * Default: `nil`. Uses built-in serializer
+* `serializer` - a JS function that serializes a Javascript Hash object into URL paramters like `{a: 1, b: 2} => "a=1&b=2"`.
+  * Default: `nil`. Uses built-in serializer compatible with Rails
   * Option is configurable at JS level with `Routes.configure()`
   * Example: `jQuery.param` - use jQuery's serializer algorithm. You can attach serialize function from your favorite AJAX framework.
-  * Example: `MyApp.custom_serialize` - use completely custom serializer of your application.
-
+  * Example: `function (object) { ... }` - use completely custom serializer of your application.
 * `special_options_key` - a special key that helps JsRoutes to destinguish serialized model from options hash
-  * This option is required because JS doesn't provide a difference between an object and a hash
+  * This option exists because JS doesn't provide a difference between an object and a hash
   * Option is configurable at JS level with `Routes.configure()`
   * Default: `_options`
-* `application` - a key to specify which rails engine you want to generate routes too.
-  * This option allows to only generate routes for a specific rails engine, that is mounted into routes instead of all Rails app routes
-  * Default: `Rails.application`
 
 ### Very Advanced Setup
 
@@ -122,9 +132,9 @@ If you want to generate the routes files outside of the asset pipeline, you can
 
 ``` ruby
 path = "app/assets/javascripts"
-JsRoutes.generate!("#{path}/app_routes.js", :namespace => "AppRoutes", :exclude => [/^admin_/, /^api_/])
-JsRoutes.generate!("#{path}/adm_routes.js", :namespace => "AdmRoutes", :include => /^admin_/)
-JsRoutes.generate!("#{path}/api_routes.js", :namespace => "ApiRoutes", :include => /^api_/, :default_url_options => {:format => "json"})
+JsRoutes.generate!("#{path}/app_routes.js", namespace: "AppRoutes", exclude: [/^admin_/, /^api_/])
+JsRoutes.generate!("#{path}/adm_routes.js", namespace: "AdmRoutes", include: /^admin_/)
+JsRoutes.generate!("#{path}/api_routes.js", namespace: "ApiRoutes", include: /^api_/, default_url_options: {format: "json"})
 ```
 
 ### Rails relative URL root
@@ -206,7 +216,7 @@ Routes.company_project_path({company_id: 1, id: 2, _options: true}) // => "/comp
 
 ## What about security?
 
-JsRoutes itself do not have security holes. It makes URLs
+JsRoutes itself does not have security holes. It makes URLs
 without access protection more reachable by potential attacker.
 In order to prevent this use `:exclude` option for sensitive urls like `/admin_/`
 

data/lib/js_routes.rb

@@ -1,5 +1,7 @@
 require 'uri'
-require 'js_routes/engine' if defined?(Rails)
+if defined?(::Rails) && defined?(::Sprockets::Railtie)
+  require 'js_routes/engine'
+end
 require 'js_routes/version'
 
 class JsRoutes
@@ -8,13 +10,16 @@ class JsRoutes
   # OPTIONS
   #
 
-  DEFAULT_PATH = File.join('app','assets','javascripts','routes.js')
-
   DEFAULTS = {
-    namespace: "Routes",
+    namespace: -> { defined?(Webpacker) ? nil : "Routes" },
     exclude: [],
     include: //,
-    file: DEFAULT_PATH,
+    file: -> do
+      sprockets_dir = Rails.root.join('app','assets','javascripts')
+      sprockets_file = sprockets_dir.join('routes.js')
+      webpacker_file = Rails.root.join('app', 'javascript', 'routes.js')
+      Dir.exists?(sprockets_dir) ? sprockets_file : webpacker_file
+    end,
     prefix: -> { Rails.application.config.relative_url_root || "" },
     url_links: false,
     camel_case: false,
@@ -23,7 +28,7 @@ class JsRoutes
     serializer: nil,
     special_options_key: "_options",
     application: -> { Rails.application }
-  }
+  } #:nodoc:
 
   NODE_TYPES = {
     GROUP: 1,
@@ -34,11 +39,11 @@ class JsRoutes
     LITERAL: 6,
     SLASH: 7,
     DOT: 8
-  }
+  } #:nodoc:
 
-  LAST_OPTIONS_KEY = "options".freeze
-  FILTERED_DEFAULT_PARTS = [:controller, :action]
-  URL_OPTIONS = [:protocol, :domain, :host, :port, :subdomain]
+  LAST_OPTIONS_KEY = "options".freeze #:nodoc:
+  FILTERED_DEFAULT_PARTS = [:controller, :action] #:nodoc:
+  URL_OPTIONS = [:protocol, :domain, :host, :port, :subdomain] #:nodoc:
 
   class Configuration < Struct.new(*DEFAULTS.keys)
     def initialize(attributes = nil)
@@ -215,7 +220,7 @@ class JsRoutes
     parent_spec = parent_route.try(:path).try(:spec)
     route_arguments = route_js_arguments(route, parent_spec)
     url_link = generate_url_link(name, route_arguments)
-    _ = <<-JS.strip!
+    <<-JS.strip!
   // #{name.join('.')} => #{parent_spec}#{route.path.spec}
   // function(#{build_params(route.required_parts)})
   #{route_name}: Utils.route(#{route_arguments})#{",\n" + url_link if url_link.length > 0}

data/lib/js_routes/engine.rb

@@ -47,7 +47,6 @@ class Engine < ::Rails::Engine
       when  -> (v) { v2.match?('', v) },
             -> (v) { vgte3.match?('', v) }
 
-      # Other rails version, assumed newer
       Rails.application.config.assets.configure do |config|
         config.register_preprocessor(
           "application/javascript",

data/lib/js_routes/version.rb

@@ -1,3 +1,3 @@
 class JsRoutes
-  VERSION = "1.4.9"
+  VERSION = "1.4.11"
 end

data/lib/routes.js

@@ -497,16 +497,13 @@ Based on Rails RAILS_VERSION routes of APP_CLASS
       routes.config = function() {
         return Utils.config();
       };
-      Object.defineProperty(routes, 'defaults', {
-        get: function() {
-          throw new Error(NAMESPACE + ".defaults is removed. Use " + NAMESPACE + ".configure() instead.");
-        },
-        set: function(value) {}
-      });
       routes.default_serializer = function(object, prefix) {
         return Utils.default_serializer(object, prefix);
       };
-      return Utils.namespace(root, NAMESPACE, routes);
+      Utils.namespace(root, NAMESPACE, routes);
+      return Object.assign({
+        "default": routes
+      }, routes);
     }
   };
 

data/lib/routes.js.coffee

@@ -393,15 +393,11 @@ Utils =
     routes = ROUTES
     routes.configure = (config) -> Utils.configure(config)
     routes.config = -> Utils.config()
-    Object.defineProperty routes, 'defaults',
-      get: ->
-        throw new Error("#{NAMESPACE}.defaults is removed. Use #{NAMESPACE}.configure() instead.")
-      set: (value) ->
-
     routes.default_serializer = (object, prefix) ->
       Utils.default_serializer(object, prefix)
     # Browser globals
     Utils.namespace(root, NAMESPACE, routes)
+    Object.assign({default: routes}, routes)
 
 result = Utils.make()
 # Set up Routes appropriately for the environment.

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

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

data/spec/js_routes/amd_compatibility_spec.rb

@@ -39,4 +39,7 @@ EOF
     expect(evaljs("require(['js-routes'], function(r){ return r.inboxes_path(); })")).to eq(test_routes.inboxes_path())
   end
 
+  it "should define default export for es6 modules" do
+    expect(evaljs("require(['js-routes'], function(r){ return r.default.inboxes_path(); })")).to eq(test_routes.inboxes_path())
+  end
 end

data/spec/js_routes/generated_javascript_spec.rb

@@ -60,11 +60,6 @@ describe JsRoutes do
     end
 
     it "should not generate file before initialization" do
-      # This method is alread fixed in Rails master
-      # But in 3.2 stable we need to hack it like this
-      if Rails.application.instance_variable_get("@initialized")
-        pending
-      end
       expect(File.exists?(name)).to be_falsey
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 1.4.9
+  version: 1.4.11
 platform: ruby
 authors:
 - Bogdan Gusiev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-07-19 00:00:00.000000000 Z
+date: 2020-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -172,6 +172,7 @@ files:
 - lib/routes.js
 - lib/routes.js.coffee
 - lib/tasks/js_routes.rake
+- spec/dummy/app/assets/config/manifest.js
 - spec/dummy/app/assets/javascripts/.gitkeep
 - spec/dummy/config/routes.rb
 - spec/js_routes/amd_compatibility_spec.rb
@@ -186,7 +187,7 @@ homepage: http://github.com/railsware/js-routes
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -201,9 +202,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Brings Rails named routes to javascript
 test_files: []