js-routes 2.3.2 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 771e5ddecccbde6b5b78778d456fe9602a4ae4b2aaa89e821cd6bda24be95565
-  data.tar.gz: b0ac96fe4273cc21fa616614429e270a393c7bcd11f15b5b79e1b14e56ec579f
+  metadata.gz: 1acb75b6e26ae17c5b028fb97d400d0fb061ec582298598e91b05f27a5a9a32c
+  data.tar.gz: 2bc54da6a67463569ad6b239f90392394d666f0b89cde662a09cf35f19b07f85
 SHA512:
-  metadata.gz: 150bccfe350126ca0db67d03a8a7bbc22884edd63ef2e86c1cecd4ac2d0d72b941d7f1133cadbe64d19f99332be22db9891ca42f2f4ccfbec7e77447b741fb71
-  data.tar.gz: 2a51b7337560e055a21ff96be1b6f89d40d88bc6b541c56129a5f99823436a7c31027cc6e029f6b33b00a42805cd7986d805a30fc8a8ce5cc4e9bd5be20e2757
+  metadata.gz: d4a84398697f1bfb41f9c0dace8d50a805b5aae36de24382bd5b43214e237a776471267046ec01487cb52ab542f0b61cc46f62a32037476af8aa2510d5b87c77
+  data.tar.gz: db690e312707ad1951b9b9905c62400eb1f70eafbeab95aab94920eab5df57c18d6d18cec1e3bc3bbe133d0a2a98308469fe934b955a43f401357284cf29f9c3

data/CHANGELOG.md

@@ -1,21 +1,36 @@
 # Changelog
 
+## v2.3.3
+
+* Rework default banner to use `routes.rb` digest instead of timestamp to ensure
+  consistent routes.js version accross environments. 
+* Use [JSDoc Tags](https://jsdoc.app/) in banner by default.
+
+
+The new default banner:
+
+``` js
+/**
+ * @file Generated by js-routes 2.3.3. Based on Rails 7.2.0 routes of App.
+ * @see https://github.com/railsware/js-routes
+ * @version e289929fc3fbe69b77aa24c5c3a58fcb1246ad1ea3f4e883f7eafa915ca929f3
+ */
+```
+
 ## v2.3.2
 
 * Add `banner` option that allow to control JSDoc on top of generated file. [#324](https://github.com/bogdan/repo/issues/324).
 
 ``` ruby
-JsRoutes.configure do |c|
-c.banner = -> {
-  commit_hash = `git rev-parse --short HEAD`.strip
-
-  <<~DOC
-  @file Javascript Route helpers of my magic pony app.
-  @author Bogdan Gusiev
-  @license MIT
-  @version #{commit_hash}
-  DOC
-}
+JsRoutes.setup do |c|
+    c.banner = -> {
+      <<~DOC
+      @file Javascript Route helpers of my magic pony app.
+      @author Bogdan Gusiev
+      @license MIT
+      @version #{JsRoutes.digest}
+      DOC
+    }
 end
 ```
 

data/Readme.md

@@ -483,7 +483,7 @@ While all of these methods are supported by JsRoutes, it is impossible to suppor
 If you are using routes like this, use the following configuration that will prevent required parameters presence to be validated by definition:
 
 ``` ruby
-JsRoutes.configure do |c|
+JsRoutes.setup do |c|
   c.optional_definition_params = true
 end
 ```

data/lib/js_routes/configuration.rb

@@ -168,8 +168,9 @@ module JsRoutes
       -> () {
         app = application.is_a?(Proc) ? T.unsafe(application).call : application
         <<~TXT
-          File generated by js-routes #{JsRoutes::VERSION} on #{Time.now}
-          Based on Rails #{Rails.version} routes of #{app.class}
+          @file Generated by js-routes #{JsRoutes::VERSION}. Based on Rails #{Rails.version} routes of #{app.class}.
+          @version #{JsRoutes.digest}
+          @see https://github.com/railsware/js-routes
         TXT
 
       }

data/lib/js_routes/middleware.rb

@@ -16,8 +16,7 @@ module JsRoutes
     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))
+      @digest = T.let(nil, T.nilable(String))
     end
 
     sig { override.params(env: StringHash).returns(UntypedArray) }
@@ -30,10 +29,10 @@ module JsRoutes
 
     sig { void }
     def update_js_routes
-      new_mtime = routes_mtime
-      unless new_mtime == @mtime
+      new_digest = fetch_digest
+      unless new_digest == @digest
         regenerate
-        @mtime = new_mtime
+        @digest = new_digest
       end
     end
 
@@ -42,9 +41,9 @@ module JsRoutes
       JsRoutes.generate!(typed: true)
     end
 
-    sig { returns(T.nilable(Time)) }
-    def routes_mtime
-      File.mtime(@routes_file)
+    sig { returns(T.nilable(String)) }
+    def fetch_digest
+      JsRoutes.digest
     rescue Errno::ENOENT
       nil
     end

data/lib/js_routes/version.rb

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

data/lib/js_routes.rb

@@ -7,6 +7,7 @@ require "js_routes/configuration"
 require "js_routes/instance"
 require "js_routes/types"
 require 'active_support/core_ext/string/indent'
+require "digest/sha2"
 
 module JsRoutes
   extend T::Sig
@@ -62,6 +63,13 @@ module JsRoutes
     def json(value)
       ActiveSupport::JSON.encode(value)
     end
+
+    sig { returns(String) }
+    def digest
+      Digest::SHA256.file(
+        Rails.root.join("config/routes.rb")
+      ).hexdigest
+    end
   end
   module Generators
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.3
 platform: ruby
 authors:
 - Bogdan Gusiev
@@ -144,9 +144,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/railsware/js-routes/issues
-  changelog_uri: https://github.com/railsware/js-routes/blob/v2.3.2/CHANGELOG.md
+  changelog_uri: https://github.com/railsware/js-routes/blob/v2.3.3/CHANGELOG.md
   documentation_uri: https://github.com/railsware/js-routes
-  source_code_uri: https://github.com/railsware/js-routes/tree/v2.3.2/activerecord
+  source_code_uri: https://github.com/railsware/js-routes/tree/v2.3.3/activerecord
   rubygems_mfa_required: 'true'
   github_repo: ssh://github.com/railsware/js-routes
 post_install_message: