js_from_routes 2.0.0 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 120fa96855c034323a664b851019f5d1df7bd418de5578af5fa074b80451ca3e
-  data.tar.gz: 7a39747149294d21f74568296c4cab44f2e93ea172c85bad0d721e686c16ce74
+  metadata.gz: 9053499de4df17e1ef042b1b54e4c172ab8ab94b2c0c353e6b8035efa8d3c0e5
+  data.tar.gz: 6fc5926dfcf3b0f94bde9c7176af31522c36bf206d6636563415143655414c3e
 SHA512:
-  metadata.gz: 77d1b1b6bef1a59d68bc1452dcb8ade3de38123ae907687bab9017347897a440b6f8b57ce6874f46d8873c6fcddf0e0480e38aa46a02fd91c39600c5c9980eca
-  data.tar.gz: 993bf91cfd887d1c645313b305f2f5d1c095ed31f3232d34b7dcbf575eefafdbadaeb3fb6948e00f1b1614e8f38e86217dd6c5bb2c55c508df771584441bde53
+  metadata.gz: 30c30f206f148dcb9ca5dac38f4f5eb07d0b6d49f5ca4c87dd4e358a3b7af12ce1fe0750cb0554c91c0655c2cadcaf6ad47438a35b9ee9678eaf3cf4945ba2d5
+  data.tar.gz: 2515d4737e9202d93e99b3f573f43667d2beea1dc61a2fafdabf2a3752478e36289fd742649fe55396185604b3ff8b04d0742048e6d8ec7ef7530627107e0931

data/CHANGELOG.md

@@ -1,3 +1,54 @@
+## [2.0.6](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@2.0.5...js_from_routes@2.0.6) (2022-05-25)
+
+
+### Bug Fixes
+
+* should not attempt to export routes without controllers ([47f8f70](https://github.com/ElMassimo/js_from_routes/commit/47f8f70b0db98baa240470f8b2b891a730499518))
+
+
+
+## [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)
 
 ### Features ⚡️

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2021 Máximo Mussini
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/js_from_routes/generator.rb

@@ -9,11 +9,11 @@ require "pathname"
 # Generates one file per controller, and one function per route.
 module JsFromRoutes
   # Internal: Helper class used as a presenter for the routes template.
-  class Routes
+  class ControllerRoutes
     attr_reader :routes
 
-    def initialize(routes, config)
-      @config = config
+    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) }
@@ -22,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
-      Digest::MD5.hexdigest(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.
@@ -30,10 +30,24 @@ module JsFromRoutes
       @config.client_library
     end
 
-    # Internal: By performing the evaluation here, we ensure only "routes" is
-    # exposed to the ERB template as a local variable.
-    def evaluate(compiled_template)
-      instance_eval(compiled_template)
+    # Internal: Name of the JS file with helpers for the the given controller.
+    def filename
+      @config.output_folder.join(basename)
+    end
+
+    # Public: Name of the JS file with helpers for the the given controller.
+    def import_filename
+      @config.output_folder.basename.join((basename.split(".")[0]).to_s)
+    end
+
+    # Public: Name of the file as a valid JS variable.
+    def js_name
+      @controller.camelize(:lower).tr(":", "")
+    end
+
+    # Internal: The base name of the JS file to be written.
+    def basename
+      "#{@controller.camelize}#{@config.file_suffix}".tr_s(":", "/")
     end
   end
 
@@ -70,6 +84,48 @@ module JsFromRoutes
     end
   end
 
+  # Internal: Represents a compiled template that can write itself to a file.
+  class Template
+    def initialize(template_path)
+      # NOTE: The compiled ERB template, used to generate JS code.
+      @compiled_template = Erubi::Engine.new(File.read(template_path), filename: template_path).src
+    end
+
+    # Public: Checks if the cache is fresh, or renders the template with the
+    # specified variables, and writes the updated result to a file.
+    def write_if_changed(object)
+      write_file_if_changed(object.filename, object.cache_key) { render_template(object) }
+    end
+
+    private
+
+    # Internal: Returns a String with the generated JS code.
+    def render_template(object)
+      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.
+    #
+    # Yields to receive the rendered file content when it needs to.
+    def write_file_if_changed(name, cache_key)
+      FileUtils.mkdir_p(name.dirname)
+      cache_key_comment = "// JsFromRoutes CacheKey #{Digest::MD5.hexdigest(cache_key)}\n"
+      File.open(name, "a+") { |file|
+        if stale?(file, cache_key_comment)
+          file.truncate(0)
+          file.write(cache_key_comment)
+          file.write(yield)
+        end
+      }
+    end
+  end
+
   class << self
     # Public: Configuration of the code generator.
     def config
@@ -82,67 +138,58 @@ module JsFromRoutes
     def generate!(app_or_routes = Rails.application)
       raise ArgumentError, "A Rails app must be defined, or you must specify a custom `output_folder`" if config.output_folder.blank?
       rails_routes = app_or_routes.is_a?(::Rails::Engine) ? app_or_routes.routes.routes : app_or_routes
-      @compiled_template = nil # Clear on every code reload in case the template changed.
-      exported_routes_by_controller(rails_routes).each do |controller, controller_routes|
-        routes = Routes.new(controller_routes, config)
-        write_if_changed(filename_for(controller), routes.cache_key) { render_template(routes) }
-      end
+      generate_files exported_routes_by_controller(rails_routes)
     end
 
     private
 
+    def generate_files(exported_routes)
+      template = Template.new(config.template_path)
+      generate_file_for_all exported_routes.map { |controller, routes|
+        ControllerRoutes.new(controller, routes, config).tap do |routes|
+          template.write_if_changed routes
+        end
+      }
+    end
+
+    def generate_file_for_all(routes)
+      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
+
+      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)
       dir = %w[frontend packs javascript assets].find { |dir| root.join("app", dir).exist? }
       {
+        all_helpers_file: true,
         client_library: "@js-from-routes/client",
         file_suffix: "Api.js",
         helper_mappings: {"index" => "list", "show" => "get"},
         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
 
     # Internal: Returns exported routes grouped by controller name.
     def exported_routes_by_controller(routes)
       routes.select { |route|
-        route.defaults.fetch(:export, false)
+        route.defaults.fetch(:export, false) && route.requirements[:controller]
       }.group_by { |route|
         route.requirements.fetch(:controller)
       }
     end
-
-    # Internal: Name of the JS file with helpers for the the given controller.
-    def filename_for(controller)
-      config.output_folder.join("#{controller.camelize}#{config.file_suffix}".tr_s(":", "/"))
-    end
-
-    # Internal: Returns a String with the JS generated for a controller's routes.
-    def render_template(routes)
-      routes.evaluate(compiled_template)
-    end
-
-    # Internal: Returns the compiled ERB to generate JS from a set of routes.
-    def compiled_template
-      @compiled_template ||= begin
-        template = File.read(config.template_path)
-        Erubi::Engine.new(template, filename: config.template_path).src
-      end
-    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.
-    #
-    # Yields to receive the rendered file content when it needs to.
-    def write_if_changed(name, cache_key)
-      FileUtils.mkdir_p(name.dirname)
-      cache_key_comment = "// JsFromRoutes CacheKey #{cache_key}\n"
-      File.open(name, "a+") { |file|
-        if file.gets != cache_key_comment
-          file.truncate(0)
-          file.write(cache_key_comment)
-          file.write(yield)
-        end
-      }
-    end
   end
 end

data/lib/js_from_routes/railtie.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rails/railtie"
+
 # NOTE: Not strictly required, but it helps to simplify the setup.
 class JsFromRoutes::Railtie < Rails::Railtie
   railtie_name :js_from_routes
@@ -22,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.js.erb

@@ -3,7 +3,7 @@
 import { definePathHelper } from '<%= client_library %>'
 
 export default {
-<% routes.each_with_index do |route, index| %>
+<% routes.each do |route| %>
   <%= route.helper %>: definePathHelper('<%= route.verb %>', '<%= route.path %>'),
 <% end %>
 }

data/lib/js_from_routes/template_all.js.erb

@@ -0,0 +1,5 @@
+//
+// DO NOT MODIFY: This file was automatically generated by JsFromRoutes.
+<% helpers.each do |helper| %>
+export { default as <%= helper.js_name %> } from '~/<%= helper.import_filename %>'
+<% 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.0"
+  VERSION = "2.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_from_routes
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.6
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-13 00:00:00.000000000 Z
+date: 2022-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -139,11 +139,14 @@ extra_rdoc_files:
 - README.md
 files:
 - CHANGELOG.md
+- LICENSE.txt
 - README.md
 - lib/js_from_routes.rb
 - lib/js_from_routes/generator.rb
 - 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:
@@ -164,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Generate JS automatically from Rails routes.