js-routes 1.4.9 → 2.2.0

data/VERSION_2_UPGRADE.md

@@ -0,0 +1,66 @@
+## 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/js-routes.gemspec

@@ -7,13 +7,16 @@ Gem::Specification.new do |s|
   s.name = %q{js-routes}
   s.version = JsRoutes::VERSION
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_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"]
@@ -21,16 +24,16 @@ Gem::Specification.new do |s|
   s.summary = %q{Brings Rails named routes to javascript}
 
   s.add_runtime_dependency(%q<railties>, [">= 4"])
-  s.add_runtime_dependency(%q<sprockets-rails>)
-  s.add_development_dependency(%q<rspec>, [">= 3.0.0"])
+  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<coffee-script>, [">= 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.2.4"])
+    s.add_development_dependency(%q<mini_racer>, [">= 0.4.0"])
   end
 end

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/generators/middleware.rb

@@ -0,0 +1,33 @@
+require "rails/generators"
+
+class JsRoutes::Generators::Middleware < Rails::Generators::Base
+
+  source_root File.expand_path(__FILE__ + "/../../../templates")
+
+  def create_middleware
+    copy_file "initializer.rb", "config/initializers/js_routes.rb"
+    # copy_file "erb.js", "config/webpack/loaders/erb.js"
+    # copy_file "routes.js.erb", "app/javascript/routes.js.erb"
+    # inject_into_file "config/webpack/environment.js", loader_content
+    inject_into_file "app/javascript/packs/application.js", pack_content
+    inject_into_file "config/environments/development.rb", middleware_content, before: /^end\n\z/
+  end
+
+  protected
+
+  def pack_content
+    <<-JS
+import * as Routes from '../routes';
+window.Routes = Routes;
+    JS
+  end
+
+  def middleware_content
+    <<-RB
+
+  # Automatically update routes.js file
+  # when routes.rb is changed
+  config.middleware.use(JsRoutes::Middleware)
+    RB
+  end
+end

data/lib/js_routes/generators/webpacker.rb

@@ -0,0 +1,32 @@
+require "rails/generators"
+
+class JsRoutes::Generators::Webpacker < Rails::Generators::Base
+
+  source_root File.expand_path(__FILE__ + "/../../../templates")
+
+  def create_webpack
+    copy_file "initializer.rb", "config/initializers/js_routes.rb"
+    copy_file "erb.js", "config/webpack/loaders/erb.js"
+    copy_file "routes.js.erb", "app/javascript/routes.js.erb"
+    inject_into_file "config/webpack/environment.js", loader_content
+    inject_into_file "app/javascript/packs/application.js", pack_content
+    command = Rails.root.join("./bin/yarn add rails-erb-loader")
+    run command
+  end
+
+  protected
+
+  def pack_content
+    <<-JS
+import * as Routes from 'routes.js.erb';
+window.Routes = Routes;
+    JS
+  end
+
+  def loader_content
+    <<-JS
+const erb = require('./loaders/erb')
+environment.loaders.append('erb', erb)
+    JS
+  end
+end

data/lib/js_routes/middleware.rb

@@ -0,0 +1,36 @@
+class JsRoutes
+  # A Rack middleware that automatically updates routes file
+  # whenever routes.rb is modified
+  #
+  # Inspired by
+  # https://github.com/fnando/i18n-js/blob/main/lib/i18n/js/middleware.rb
+  class Middleware
+    def initialize(app)
+      @app = app
+      @routes_file = Rails.root.join("config/routes.rb")
+      @mtime = nil
+    end
+
+    def call(env)
+      update_js_routes
+      @app.call(env)
+    end
+
+    protected
+
+    def update_js_routes
+      new_mtime = routes_mtime
+      unless new_mtime == @mtime
+        JsRoutes.generate!
+        JsRoutes.definitions!
+        @mtime = new_mtime
+      end
+    end
+
+    def routes_mtime
+      File.mtime(@routes_file)
+    rescue Errno::ENOENT
+      nil
+    end
+  end
+end

data/lib/js_routes/version.rb

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