js_from_routes 2.0.1 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5663dc5fb9fd9062e81af864e59d7fb8ec61625d5db06c0f55c04307afde8314
-  data.tar.gz: 5dc7aa69994d396c22472c249e216045a4b6466b4041d7df6974f9bf6f6e5f75
+  metadata.gz: '00930d579b2a7eaada963f2b8139bf03f850224ca6a93cc4715b938a84e26b58'
+  data.tar.gz: 10556d08300abe1e64c0fdfaa35db23099d7915306928a210f48717258fc9762
 SHA512:
-  metadata.gz: 782f8ee6ca92ab3bcb84220e4012bb235b8aeafeeff88e54499f93d35fa75fbfcde6799460a53f4dd6dd2990ac9a3934dd07632a7e1e4b7ecea527f66a324e1c
-  data.tar.gz: ebdc1552cfae84ce61f36ad7f70fc302c6b1994b29ad06956391ab9701cd8a639dbb4d8317d2122907b474b114f01dd36e61de22d7b3aa118f694349d64a2a12
+  metadata.gz: 0c099a34cc949e8d600c1199f8bcb66228bf0f57c5d17de329c87fefcacdcbe2f465996a1d0111a1b964117977bc311477640508f49d4a33d5107ba03d1e2551
+  data.tar.gz: a720dfc8dd9d2c26291c8feb6f8e009e3612612be2db83278c27d632a2c1bbcfe4a7e2bf9f7d63aa68c4418f119693c83cf58229bf21691e9a4492b0f7f48ccd

data/CHANGELOG.md

@@ -1,6 +1,48 @@
+## [2.0.5](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@2.0.5...js_from_routes@2.0.5) (2021-09-02)
+
+
+
+## [2.0.5](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@2.0.4...js_from_routes@2.0.5) (2021-09-02)
+
+
+### Bug Fixes
+
+* ensure :export is not added as a required default in routes ([40126ac](https://github.com/ElMassimo/js_from_routes/commit/40126ac27caeee33abef1c7067ba1db88ea03660))
+
+
+
+## [2.0.4](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@2.0.3...js_from_routes@2.0.4) (2021-03-16)
+
+### Features
+
+* Allow importing individual helpers from "~/api" by adding exports ([2dfb8a2](https://github.com/ElMassimo/js_from_routes/commit/2dfb8a27d182376d75f0b037258bc772553e43f3)). Thanks @matias-capeletto!
+
+
+## [2.0.3](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@2.0.2...js_from_routes@2.0.3) (2021-03-16)
+
+
+### Bug Fixes
+
+* Ensure changing the client library triggers code generation ([6cf2bdf](https://github.com/ElMassimo/js_from_routes/commit/6cf2bdf4896dafe0d1e80668551665c46bfcadc6))
+
+
+### Features
+
+* Allow passing JS_FROM_ROUTES_FORCE=true to ignore cache keys ([8a6d2a8](https://github.com/ElMassimo/js_from_routes/commit/8a6d2a807e0a9926c6b24e1fc9127f917ec0ed5d))
+
+
+
+## [2.0.2](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@2.0.1...js_from_routes@2.0.2) (2021-03-14)
+
+### Improvements
+
+- Remove underscores from namespaced controllers in global file ([90fdcc2](https://github.com/ElMassimo/js_from_routes/commit/90fdcc2))
+
 ## [2.0.1](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@2.0.0...js_from_routes@2.0.1) (2021-03-14)
 
+### Features ⚡️
 
+- Enable generation of index combining and exporting all helpers (#9)
 
 # [2.0.0](https://github.com/ElMassimo/js_from_routes/compare/v1.0.3...js_from_routes@2.0.0) (2021-03-13)
 

data/lib/js_from_routes/generator.rb

@@ -8,28 +8,6 @@ require "pathname"
 # Public: Automatically generates JS for Rails routes with { export: true }.
 # Generates one file per controller, and one function per route.
 module JsFromRoutes
-  # Internal: Helper class used as a presenter for the all helpers template.
-  class AllRoutes
-    attr_reader :helpers
-
-    def initialize(helpers, config)
-      @helpers, @config = helpers, config
-    end
-
-    # Public: Used to check whether the file should be generated again, changes
-    # based on the configuration, and route definition.
-    def cache_key
-      helpers.map(&:import_filename).join + File.read(@config.template_all_path)
-    end
-
-    # Internal: Name of the JS file where all helpers will be exported.
-    def filename
-      path = @config.all_helpers_file
-      path = "index#{File.extname(@config.file_suffix)}" if path == true
-      @config.output_folder.join(path)
-    end
-  end
-
   # Internal: Helper class used as a presenter for the routes template.
   class ControllerRoutes
     attr_reader :routes
@@ -44,7 +22,7 @@ module JsFromRoutes
     # Public: Used to check whether the file should be generated again, changes
     # based on the configuration, and route definition.
     def cache_key
-      routes.map(&:inspect).join + [File.read(@config.template_path), @config.helper_mappings.inspect].join
+      routes.map(&:inspect).join + [File.read(@config.template_path), @config.helper_mappings.inspect, @config.client_library].join
     end
 
     # Public: Exposes the preferred import library to the generator.
@@ -64,7 +42,7 @@ module JsFromRoutes
 
     # Public: Name of the file as a valid JS variable.
     def js_name
-      @controller.camelize(:lower).tr(":", "_")
+      @controller.camelize(:lower).tr(":", "")
     end
 
     # Internal: The base name of the JS file to be written.
@@ -126,6 +104,11 @@ module JsFromRoutes
       object.instance_eval(@compiled_template)
     end
 
+    # Internal: Returns true if the cache key has changed since the last codegen.
+    def stale?(file, cache_key_comment)
+      ENV["JS_FROM_ROUTES_FORCE"] || file.gets != cache_key_comment
+    end
+
     # Internal: Writes if the file does not exist or the cache key has changed.
     # The cache strategy consists of a comment on the first line of the file.
     #
@@ -134,7 +117,7 @@ module JsFromRoutes
       FileUtils.mkdir_p(name.dirname)
       cache_key_comment = "// JsFromRoutes CacheKey #{Digest::MD5.hexdigest(cache_key)}\n"
       File.open(name, "a+") { |file|
-        if file.gets != cache_key_comment
+        if stale?(file, cache_key_comment)
           file.truncate(0)
           file.write(cache_key_comment)
           file.write(yield)
@@ -172,7 +155,18 @@ module JsFromRoutes
     def generate_file_for_all(routes)
       return unless config.all_helpers_file && !routes.empty?
 
-      Template.new(config.template_all_path).write_if_changed AllRoutes.new(routes, config)
+      preferred_extension = File.extname(config.file_suffix)
+      index_file = config.all_helpers_file == true ? "index#{preferred_extension}" : config.all_helpers_file
+
+      Template.new(config.template_all_path).write_if_changed OpenStruct.new(
+        cache_key: routes.map(&:import_filename).join + File.read(config.template_all_path),
+        filename: config.output_folder.join("all#{preferred_extension}"),
+        helpers: routes,
+      )
+      Template.new(config.template_index_path).write_if_changed OpenStruct.new(
+        cache_key: File.read(config.template_index_path),
+        filename: config.output_folder.join(index_file),
+      )
     end
 
     def default_config(root)
@@ -185,6 +179,7 @@ module JsFromRoutes
         output_folder: root.join("app", dir, "api"),
         template_path: File.expand_path("template.js.erb", __dir__),
         template_all_path: File.expand_path("template_all.js.erb", __dir__),
+        template_index_path: File.expand_path("template_index.js.erb", __dir__),
       }
     end
 

data/lib/js_from_routes/railtie.rb

@@ -24,4 +24,14 @@ class JsFromRoutes::Railtie < Rails::Railtie
       end
     end
   end
+
+  # Prevents Rails from interpreting the :export option as a required default,
+  # which would cause controller tests to fail.
+  initializer "js_from_routes.required_defaults" do |app|
+    ActionDispatch::Journey::Route.prepend Module.new {
+      def required_default?(key)
+        key == :export ? false : super
+      end
+    }
+  end
 end

data/lib/js_from_routes/template_all.js.erb

@@ -1,11 +1,5 @@
 //
 // DO NOT MODIFY: This file was automatically generated by JsFromRoutes.
 <% helpers.each do |helper| %>
-import <%= helper.js_name %> from '~/<%= helper.import_filename %>'
+export { default as <%= helper.js_name %> } from '~/<%= helper.import_filename %>'
 <% end %>
-
-export default {
-<% helpers.each do |helper| %>
-  <%= helper.js_name %>,
-<% end %>
-}

data/lib/js_from_routes/template_index.js.erb

@@ -0,0 +1,5 @@
+//
+// DO NOT MODIFY: This file was automatically generated by JsFromRoutes.
+import * as helpers from '~/api/all'
+export * from '~/api/all'
+export default helpers

data/lib/js_from_routes/version.rb

@@ -4,5 +4,5 @@
 # Generates one file per controller, and one function per route.
 module JsFromRoutes
   # Public: This library adheres to semantic versioning.
-  VERSION = "2.0.1"
+  VERSION = "2.0.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_from_routes
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.5
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-14 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -146,6 +146,7 @@ files:
 - lib/js_from_routes/railtie.rb
 - lib/js_from_routes/template.js.erb
 - lib/js_from_routes/template_all.js.erb
+- lib/js_from_routes/template_index.js.erb
 - lib/js_from_routes/version.rb
 homepage: https://github.com/ElMassimo/js_from_routes
 licenses: