js_from_routes 3.0.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5be06720d112b28716ce584184abba22d15b44917d3032bc6bb926781a028a9
-  data.tar.gz: 6bc27e4de388e7e1420b598ca53f51bcf5d04feea736ad491c8de3c0195516da
+  metadata.gz: d025db2a61cac22a1639c8164379135ecc21495cf9088e100c3301af27836bc3
+  data.tar.gz: f2480ec441295677d3289269225052b99c91a8a7ba5ef554f6bc63a6eedf0fa2
 SHA512:
-  metadata.gz: 23722e80af9943f268a65ae51c93856a70b16fc192146b3f83bb6d2fb81ab1c3c62671912380348f0398e26548b3798654797d78c575aa7839f90c29c1433b83
-  data.tar.gz: dd3702554cb2f815d2efa3f4733b83698e46efd0c05ef12999a39e7e026f1c1cb6b871dac3e1e6e4b46df94833cc64157c6ea49cc5e589fa5d4d75e7d60bc393
+  metadata.gz: 2cd07f08b897c978aaa8d38ddee26298ab9f0202f57cbad37cecaf4cd86694a7700f2b0980ca8e8f8821d9379bdf70db88f301ff3e67c5086e3c6e388909060d
+  data.tar.gz: a121e858da619a7b1843d708cb1b564aff0f2aca3762384361e4d02179e2bb58f4b65029bd09bf7ec4d4064a6d6da25b2a3099fe1e001a58891f5d245c4a29d3

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+# [4.0.0](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@3.0.2...js_from_routes@4.0.0) (2024-10-11)
+
+
+### Features
+
+* allow customizing the namespace for path helpers ([#50](https://github.com/ElMassimo/js_from_routes/issues/50)) ([9d38c83](https://github.com/ElMassimo/js_from_routes/commit/9d38c8312ef1275b3b8c18c1129bc936da08bcd0))
+
+
+
+## [3.0.2](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@3.0.1...js_from_routes@3.0.2) (2024-09-25)
+
+
+### Bug Fixes
+
+* remove references to OpenStruct ([#49](https://github.com/ElMassimo/js_from_routes/issues/49)) ([6c0d8de](https://github.com/ElMassimo/js_from_routes/commit/6c0d8ded2bf82ccc2f8f35508dc256c3b301069a)), closes [#47](https://github.com/ElMassimo/js_from_routes/issues/47)
+
+
+
 ## [3.0.1](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@3.0.0...js_from_routes@3.0.1) (2023-10-09)
 
 

data/lib/js_from_routes/generator.rb

@@ -15,8 +15,13 @@ module JsFromRoutes
     def initialize(controller, routes, config)
       @controller, @config = controller, config
       @routes = routes
-        .uniq { |route| route.requirements.fetch(:action) }
-        .map { |route| Route.new(route, config.helper_mappings) }
+        .reject { |route| route.requirements[:action] == "update" && route.verb == "PUT" }
+        .group_by { |route| route.requirements.fetch(:action) }
+        .flat_map { |action, routes|
+          routes.each_with_index.map { |route, index|
+            Route.new(route, mappings: config.helper_mappings, index:, controller:)
+          }
+        }
     end
 
     # Public: Used to check whether the file should be generated again, changes
@@ -53,8 +58,8 @@ module JsFromRoutes
 
   # Internal: A presenter for an individual Rails action.
   class Route
-    def initialize(route, mappings = {})
-      @route, @mappings = route, mappings
+    def initialize(route, mappings:, controller:, index: 0)
+      @route, @mappings, @controller, @index = route, mappings, controller, index
     end
 
     # Public: The `export` setting specified for the action.
@@ -64,7 +69,7 @@ module JsFromRoutes
 
     # Public: The HTTP verb for the action. Example: 'patch'
     def verb
-      @route.verb.downcase
+      @route.verb.split("|").last.downcase
     end
 
     # Public: The path for the action. Example: '/users/:id/edit'
@@ -74,8 +79,12 @@ module JsFromRoutes
 
     # Public: The name of the JS helper for the action. Example: 'destroyAll'
     def helper
-      action = @route.requirements.fetch(:action).camelize(:lower)
-      @mappings.fetch(action, action)
+      action = @route.requirements.fetch(:action)
+      if @index > 0
+        action = @route.name&.sub(@controller.tr(":/", "_"), "") || "#{action}#{verb.titleize}"
+      end
+      helper = action.camelize(:lower)
+      @mappings.fetch(helper, helper)
     end
 
     # Internal: Useful as a cache key for the route, and for debugging purposes.
@@ -126,10 +135,39 @@ module JsFromRoutes
     end
   end
 
+  class Configuration
+    attr_accessor :all_helpers_file, :client_library, :export_if, :file_suffix,
+      :helper_mappings, :output_folder, :template_path,
+      :template_all_path, :template_index_path
+
+    def initialize(root)
+      dir = %w[frontend packs javascript assets].find { |dir| root.join("app", dir).exist? }
+      @all_helpers_file = true
+      @client_library = "@js-from-routes/client"
+      @export_if = ->(route) { route.defaults.fetch(:export, nil) }
+      @file_suffix = "Api.js"
+      @helper_mappings = {}
+      @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
+  end
+
+  class TemplateConfig
+    attr_reader :cache_key, :filename, :helpers
+
+    def initialize(cache_key:, filename:, helpers: nil)
+      @cache_key = cache_key
+      @filename = filename
+      @helpers = helpers
+    end
+  end
+
   class << self
     # Public: Configuration of the code generator.
     def config
-      @config ||= OpenStruct.new(default_config(::Rails.root || Pathname.new(Dir.pwd)))
+      @config ||= Configuration.new(::Rails.root || Pathname.new(Dir.pwd))
       yield(@config) if block_given?
       @config
     end
@@ -145,7 +183,8 @@ module JsFromRoutes
 
     def generate_files(exported_routes)
       template = Template.new(config.template_path)
-      generate_file_for_all exported_routes.map { |controller, routes|
+      generate_file_for_all exported_routes.filter_map { |controller, routes|
+        next unless controller
         ControllerRoutes.new(controller, routes, config).tap do |routes|
           template.write_if_changed routes
         end
@@ -156,41 +195,30 @@ module JsFromRoutes
       return unless config.all_helpers_file && !routes.empty?
 
       preferred_extension = File.extname(config.file_suffix)
-      index_file = config.all_helpers_file == true ? "index#{preferred_extension}" : config.all_helpers_file
+      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(
+      Template.new(config.template_all_path).write_if_changed TemplateConfig.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(
+      Template.new(config.template_index_path).write_if_changed TemplateConfig.new(
         cache_key: File.read(config.template_index_path),
         filename: config.output_folder.join(index_file),
       )
     end
 
-    def default_config(root)
-      dir = %w[frontend packs javascript assets].find { |dir| root.join("app", dir).exist? }
-      {
-        all_helpers_file: true,
-        client_library: "@js-from-routes/client",
-        export_if: ->(route) { route.defaults.fetch(:export, nil) },
-        file_suffix: "Api.js",
-        helper_mappings: {},
-        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__),
-      }
+    def namespace_for_route(route)
+      if (export = route.defaults[:export]).is_a?(Hash)
+        export[:namespace]
+      end || route.requirements[:controller]
     end
 
     # Internal: Returns exported routes grouped by controller name.
     def exported_routes_by_controller(routes)
-      routes.select { |route|
-        config.export_if.call(route) && route.requirements[:controller]
-      }.group_by { |route|
-        route.requirements.fetch(:controller)
-      }
+      routes
+        .select { |route| config.export_if.call(route) }
+        .group_by { |route| namespace_for_route(route)&.to_s }
     end
   end
 end

data/lib/js_from_routes/railtie.rb

@@ -30,7 +30,7 @@ class JsFromRoutes::Railtie < Rails::Railtie
   initializer "js_from_routes.required_defaults" do |app|
     ActionDispatch::Journey::Route.prepend Module.new {
       def required_default?(key)
-        key == :export ? false : super
+        (key == :export) ? false : super
       end
     }
   end

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 = "3.0.1"
+  VERSION = "4.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_from_routes
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-09 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: Generate JS automatically from Rails routes.