js-routes 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 315ddd617bc6630cf5858afc5ba38d2c204f6167a7984ccdaf7171a50404e418
-  data.tar.gz: 676d2d36107ee524c07517143499173c0658731cc06d1c52753e3ab2f4e6cb81
+  metadata.gz: 54158654106dece477c1fdf36afa52b504a43b8210c4c8d30f98d41ccd0ef600
+  data.tar.gz: a67b36754269392839bb6d2e86a20899ec2575437ac9667f10cdd9feb7306185
 SHA512:
-  metadata.gz: 6c7f715e9afd02d1daebb882381e328595beca59a6a6d8c10a3a1518801522090e986c6b362174aaa9c51faf91508ee8e1cc6fff8ba118a08c32eb26c7205ba1
-  data.tar.gz: 7f70bfa95a1fb42092f20118bb3f22f07e459ccc6f95b8d3b0651faf0457266152465873da6a4dfddc4d52df006d6f5b991e3608a083c1eb524fef5ed77ff0c8
+  metadata.gz: 582b6a39a062f6fcfd7b2cb4a57b4fd4573e343f93d5751ef764b7e3617cb7243801caf61ee971224a2c1a41e43a2f51221e5d3a40c12d5db21af98f47467044
+  data.tar.gz: f54b26ed68ed8ef2a6b4ad5ebf2e0322bfbec7385756a8578b5c11c01eca646d42baa5634d16cef6d16520e3eed4d1b1a37260e4ade943ee568b6b4755153cea

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## master
 
+## 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)

data/Readme.md

@@ -16,12 +16,12 @@ gem "js-routes"
 
 ## Setup
 
-There are 3 possible ways to setup JsRoutes:
+There are several possible ways to setup JsRoutes:
 
 * [Quick and easy](#quick-start)
   * Uses Rack Middleware to automatically update routes locally
   * Works great for a simple Rails application
-* [Webpacker](#webpacker) automatic updates
+* [Webpacker ERB Loader](#webpacker)
   * Requires ESM module system (the default)
   * Doesn't support typescript definitions
 * [Advanced Setup](#advanced-setup)
@@ -33,18 +33,52 @@ There are 3 possible ways to setup JsRoutes:
 
 ### Quick Start 
 
-Setup [Rack Middleware](https://guides.rubyonrails.org/rails_on_rack.html#action-dispatcher-middleware-stack) to automatically generate and maintain `routes.js` file and corresponding [Typescript definitions](https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-d-ts.html) `routes.d.ts`:
+Setup [Rack Middleware](https://guides.rubyonrails.org/rails_on_rack.html#action-dispatcher-middleware-stack) 
+to automatically generate and maintain `routes.js` file and corresponding 
+[Typescript definitions](https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-d-ts.html) `routes.d.ts`:
 
-Run:
+#### Use a Generator
+
+Run a command:
 
 ``` sh
 rails generate js_routes:middleware
 ```
 
+#### Setup Manually
+
+Add the following to `config/environments/development.rb`:
+
+``` ruby
+  config.middleware.use(JsRoutes::Middleware)
+```
+
+Use it in `app/javascript/packs/application.js`:
+
+``` javascript
+import * as Routes from '../routes';
+// window.Routes = Routes;
+alert(Routes.post_path(1))
+```
+
+Upgrade `rake assets:precompile` to update js-routes files: 
+
+``` ruby
+namespace :assets do
+  task :precompile => "js:routes:typescript"
+end
+```
+
+Add js-routes files to `.gitignore`:
+
+```
+/app/javascript/routes.js
+/app/javascript/routes.d.ts
+```
 
 <div id='webpacker'></div>
 
-### Webpacker + automatic updates - Typescript
+### Webpacker ERB loader
 
 **IMPORTANT**: this setup doesn't support IDE autocompletion with [Typescript](https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-d-ts.html)
 
@@ -111,7 +145,7 @@ window.Routes = Routes;
 
 **IMPORTANT**: that this setup requires the JS routes file to be updates manually
 
-You can run every time you want to generate a routes file:
+Routes file can be generated with a `rake` task:
 
 ``` sh
 rake js:routes 
@@ -122,6 +156,8 @@ rake js:routes:typescript
 In case you need multiple route files for different parts of your application, you have to create the files manually.
 If your application has an `admin` and an `application` namespace for example:
 
+**IMPORTANT**: Requires [Webpacker ERB Loader](#webpacker) setup.
+
 ``` erb
 // app/javascript/admin/routes.js.erb
 <%= JsRoutes.generate(include: /admin/) %>

data/lib/js_routes/generators/middleware.rb

@@ -6,11 +6,12 @@ class JsRoutes::Generators::Middleware < Rails::Generators::Base
 
   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/
+    inject_into_file "Rakefile", rakefile_content
+    inject_into_file ".gitignore", gitignore_content
+    JsRoutes.generate!
+    JsRoutes.definitions!
   end
 
   protected
@@ -25,9 +26,33 @@ window.Routes = Routes;
   def middleware_content
     <<-RB
 
-  # Automatically update routes.js file
+  # Automatically update js-routes file
   # when routes.rb is changed
   config.middleware.use(JsRoutes::Middleware)
     RB
   end
+
+  def rakefile_content
+    <<-RB
+
+# Update js-routes file before assets precompile
+namespace :assets do
+  task :precompile => "js:routes:typescript"
+end
+    RB
+  end
+
+  def gitignore_content
+    banner = <<-TXT
+
+# Ignore automatically generated js-routes files.
+    TXT
+
+    banner + [
+      {},
+      {module_type: 'DTS'}
+    ].map do |config|
+      File.join('/', JsRoutes.new(config).configuration.output_file) + "\n"
+    end.join
+  end
 end

data/lib/js_routes/route.rb

@@ -0,0 +1,172 @@
+class JsRoutes
+  class Route #:nodoc:
+    FILTERED_DEFAULT_PARTS = [:controller, :action]
+    URL_OPTIONS = [:protocol, :domain, :host, :port, :subdomain]
+    NODE_TYPES = {
+      GROUP: 1,
+      CAT: 2,
+      SYMBOL: 3,
+      OR: 4,
+      STAR: 5,
+      LITERAL: 6,
+      SLASH: 7,
+      DOT: 8
+    }
+
+    attr_reader :configuration, :route, :parent_route
+
+    def initialize(configuration, route, parent_route = nil)
+      @configuration = configuration
+      @route = route
+      @parent_route = parent_route
+    end
+
+    def helpers
+      helper_types.map do |absolute|
+        [ documentation, helper_name(absolute), body(absolute) ]
+      end
+    end
+
+    def helper_types
+      return [] unless match_configuration?
+      @configuration[:url_links] ? [true, false] : [false]
+    end
+
+    def body(absolute)
+      @configuration.dts? ?
+        definition_body : "__jsr.r(#{arguments(absolute).map{|a| json(a)}.join(', ')})"
+    end
+
+    def definition_body
+      args = required_parts.map{|p| "#{apply_case(p)}: RequiredRouteParameter"}
+      args << "options?: #{optional_parts_type} & RouteOptions"
+      "((\n#{args.join(",\n").indent(2)}\n) => string) & RouteHelperExtras"
+    end
+
+    def optional_parts_type
+      @optional_parts_type ||=
+        "{" + optional_parts.map {|p| "#{p}?: OptionalRouteParameter"}.join(', ') + "}"
+    end
+
+    protected
+
+    def arguments(absolute)
+      absolute ? [*base_arguments, true] : base_arguments
+    end
+
+    def match_configuration?
+      !match?(@configuration[:exclude]) && match?(@configuration[:include])
+    end
+
+    def base_name
+      @base_name ||= parent_route ?
+        [parent_route.name, route.name].join('_') : route.name
+    end
+
+    def parent_spec
+      parent_route&.path&.spec
+    end
+
+    def spec
+      route.path.spec
+    end
+
+    def json(value)
+      JsRoutes.json(value)
+    end
+
+    def helper_name(absolute)
+      suffix = absolute ? :url : @configuration[:compact] ? nil : :path
+      apply_case(base_name, suffix)
+    end
+
+    def documentation
+      return nil unless @configuration[:documentation]
+      <<-JS
+/**
+ * Generates rails route to
+ * #{parent_spec}#{spec}#{documentation_params}
+ * @param {object | undefined} options
+ * @returns {string} route path
+ */
+JS
+    end
+
+    def required_parts
+      route.required_parts
+    end
+
+    def optional_parts
+      route.path.optional_names
+    end
+
+    def base_arguments
+      @base_arguments ||= [parts_table, serialize(spec, parent_spec)]
+    end
+
+    def parts_table
+      parts_table = {}
+      route.parts.each do |part, hash|
+        parts_table[part] ||= {}
+        if required_parts.include?(part)
+          # Using shortened keys to reduce js file size
+          parts_table[part][:r] = true
+        end
+      end
+      route.defaults.each do |part, value|
+        if FILTERED_DEFAULT_PARTS.exclude?(part) &&
+          URL_OPTIONS.include?(part) || parts_table[part]
+          parts_table[part] ||= {}
+          # Using shortened keys to reduce js file size
+          parts_table[part][:d] = value
+        end
+      end
+      parts_table
+    end
+
+    def documentation_params
+      required_parts.map do |param|
+        "\n * @param {any} #{apply_case(param)}"
+      end.join
+    end
+
+    def match?(matchers)
+      Array(matchers).any? { |regex| base_name =~ regex }
+    end
+
+    def apply_case(*values)
+      value = values.compact.map(&:to_s).join('_')
+      @configuration[:camel_case] ? value.camelize(:lower) : value
+    end
+
+    # This function serializes Journey route into JSON structure
+    # We do not use Hash for human readable serialization
+    # And preffer Array serialization because it is shorter.
+    # Routes.js file will be smaller.
+    def serialize(spec, parent_spec=nil)
+      return nil unless spec
+      # Rails 4 globbing requires * removal
+      return spec.tr(':*', '') if spec.is_a?(String)
+
+      result = serialize_spec(spec, parent_spec)
+      if parent_spec && result[1].is_a?(String) && parent_spec.type != :SLASH
+        result = [
+          # We encode node symbols as integer
+          # to reduce the routes.js file size
+          NODE_TYPES[:CAT],
+          serialize_spec(parent_spec),
+          result
+        ]
+      end
+      result
+    end
+
+    def serialize_spec(spec, parent_spec = nil)
+      [
+        NODE_TYPES[spec.type],
+        serialize(spec.left, parent_spec),
+        spec.respond_to?(:right) ? serialize(spec.right) : nil
+      ].compact
+    end
+  end
+end

data/lib/js_routes/version.rb

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

data/lib/js_routes.rb

@@ -1,8 +1,11 @@
 require 'uri'
+require "pathname"
+
 if defined?(::Rails) && defined?(::Sprockets::Railtie)
   require 'js_routes/engine'
 end
 require 'js_routes/version'
+require "js_routes/route"
 require 'active_support/core_ext/string/indent'
 
 class JsRoutes
@@ -75,8 +78,8 @@ class JsRoutes
     end
 
     def output_file
-      webpacker_dir = Rails.root.join('app', 'javascript')
-      sprockets_dir = Rails.root.join('app','assets','javascripts')
+      webpacker_dir = pathname('app', 'javascript')
+      sprockets_dir = pathname('app','assets','javascripts')
       file_name = file || default_file_name
       sprockets_file = sprockets_dir.join(file_name)
       webpacker_file = webpacker_dir.join(file_name)
@@ -90,6 +93,10 @@ class JsRoutes
 
     protected
 
+    def pathname(*parts)
+      Pathname.new(File.join(*parts))
+    end
+
     def default_file_name
       dts? ? "routes.d.ts" : "routes.js"
     end
@@ -141,6 +148,7 @@ class JsRoutes
     end
   end
 
+  attr_reader :configuration
   #
   # Implementation
   #
@@ -284,179 +292,9 @@ export {};
   end
 
   def route_helpers_if_match(route, parent_route = nil)
-    JsRoute.new(@configuration, route, parent_route).helpers
+    Route.new(@configuration, route, parent_route).helpers
   end
 
-  class JsRoute #:nodoc:
-    FILTERED_DEFAULT_PARTS = [:controller, :action]
-    URL_OPTIONS = [:protocol, :domain, :host, :port, :subdomain]
-    NODE_TYPES = {
-      GROUP: 1,
-      CAT: 2,
-      SYMBOL: 3,
-      OR: 4,
-      STAR: 5,
-      LITERAL: 6,
-      SLASH: 7,
-      DOT: 8
-    }
-
-    attr_reader :configuration, :route, :parent_route
-
-    def initialize(configuration, route, parent_route = nil)
-      @configuration = configuration
-      @route = route
-      @parent_route = parent_route
-    end
-
-    def helpers
-      helper_types.map do |absolute|
-        [ documentation, helper_name(absolute), body(absolute) ]
-      end
-    end
-
-    def helper_types
-      return [] unless match_configuration?
-      @configuration[:url_links] ? [true, false] : [false]
-    end
-
-    def body(absolute)
-      @configuration.dts? ?
-        definition_body : "__jsr.r(#{arguments(absolute).map{|a| json(a)}.join(', ')})"
-    end
-
-    def definition_body
-      args = required_parts.map{|p| "#{apply_case(p)}: RequiredRouteParameter"}
-      args << "options?: #{optional_parts_type} & RouteOptions"
-      "((\n#{args.join(",\n").indent(2)}\n) => string) & RouteHelperExtras"
-    end
-
-    def optional_parts_type
-      @optional_parts_type ||=
-        "{" + optional_parts.map {|p| "#{p}?: OptionalRouteParameter"}.join(', ') + "}"
-    end
-
-    protected
-
-    def arguments(absolute)
-      absolute ? [*base_arguments, true] : base_arguments
-    end
-
-    def match_configuration?
-      !match?(@configuration[:exclude]) && match?(@configuration[:include])
-    end
-
-    def base_name
-      @base_name ||= parent_route ?
-        [parent_route.name, route.name].join('_') : route.name
-    end
-
-    def parent_spec
-      parent_route&.path&.spec
-    end
-
-    def spec
-      route.path.spec
-    end
-
-    def json(value)
-      JsRoutes.json(value)
-    end
-
-    def helper_name(absolute)
-      suffix = absolute ? :url : @configuration[:compact] ? nil : :path
-      apply_case(base_name, suffix)
-    end
-
-    def documentation
-      return nil unless @configuration[:documentation]
-      <<-JS
-/**
- * Generates rails route to
- * #{parent_spec}#{spec}#{documentation_params}
- * @param {object | undefined} options
- * @returns {string} route path
- */
-JS
-    end
-
-    def required_parts
-      route.required_parts
-    end
-
-    def optional_parts
-      route.path.optional_names
-    end
-
-    def base_arguments
-      @base_arguments ||= [parts_table, serialize(spec, parent_spec)]
-    end
-
-    def parts_table
-      parts_table = {}
-      route.parts.each do |part, hash|
-        parts_table[part] ||= {}
-        if required_parts.include?(part)
-          # Using shortened keys to reduce js file size
-          parts_table[part][:r] = true
-        end
-      end
-      route.defaults.each do |part, value|
-        if FILTERED_DEFAULT_PARTS.exclude?(part) &&
-          URL_OPTIONS.include?(part) || parts_table[part]
-          parts_table[part] ||= {}
-          # Using shortened keys to reduce js file size
-          parts_table[part][:d] = value
-        end
-      end
-      parts_table
-    end
-
-    def documentation_params
-      required_parts.map do |param|
-        "\n * @param {any} #{apply_case(param)}"
-      end.join
-    end
-
-    def match?(matchers)
-      Array(matchers).any? { |regex| base_name =~ regex }
-    end
-
-    def apply_case(*values)
-      value = values.compact.map(&:to_s).join('_')
-      @configuration[:camel_case] ? value.camelize(:lower) : value
-    end
-
-    # This function serializes Journey route into JSON structure
-    # We do not use Hash for human readable serialization
-    # And preffer Array serialization because it is shorter.
-    # Routes.js file will be smaller.
-    def serialize(spec, parent_spec=nil)
-      return nil unless spec
-      # Rails 4 globbing requires * removal
-      return spec.tr(':*', '') if spec.is_a?(String)
-
-      result = serialize_spec(spec, parent_spec)
-      if parent_spec && result[1].is_a?(String) && parent_spec.type != :SLASH
-        result = [
-          # We encode node symbols as integer
-          # to reduce the routes.js file size
-          NODE_TYPES[:CAT],
-          serialize_spec(parent_spec),
-          result
-        ]
-      end
-      result
-    end
-
-    def serialize_spec(spec, parent_spec = nil)
-      [
-        NODE_TYPES[spec.type],
-        serialize(spec.left, parent_spec),
-        spec.respond_to?(:right) ? serialize(spec.right) : nil
-      ].compact
-    end
-  end
   module Generators
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -174,6 +174,7 @@ files:
 - lib/js_routes/generators/middleware.rb
 - lib/js_routes/generators/webpacker.rb
 - lib/js_routes/middleware.rb
+- lib/js_routes/route.rb
 - lib/js_routes/version.rb
 - lib/routes.d.ts
 - lib/routes.js