js_from_routes 1.0.3 → 2.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11da4a678c4081b4ce6d99bac78e007f819cf5fecd2321af94c2e7962e557a71
-  data.tar.gz: 3c81aa21374aae94ec47493f70ed978938061a9d1a03ca9bba481939e853c7ab
+  metadata.gz: 13b4bc245728511e15d787762ffddbe1bfb3799a7b61f69620a7f617435aed12
+  data.tar.gz: 1f2f759b537ce46f2628df9c17ea3f8325db4c7fb36e048270babc1a9116e637
 SHA512:
-  metadata.gz: 8d71a098de83a7feab5bae4ce682c981a32d9d296db8392dc441371ce4f53b3237beefc155f670e69960af30d6780144bd426f6727fcf98d3a7260ac63c7fc12
-  data.tar.gz: 70347defa686e95bae4264eda364e514eef9fa623078957a17825dc1c8894f77c0079b19c70f001586344980c5fe29c57812aaef0f74ba2ac8b92f910c39dc5e
+  metadata.gz: d5c443ada290e81b71dc6776e02007966471f6c2c188be2fc03f849b1c5f6bf0954fa1e37508f79a2f4ec015bd2e4b582f5ae29ed655843d07a0dd43f9f6d793
+  data.tar.gz: ee9cfcdf677e351aa7631c34835c9fbac8fd29fbb6d380c9bedb6965435f681c52f6a50c14ec63a8f971bef211b9ebf5e1ef2a243ac72e841f567250056a1b48

data/CHANGELOG.md

@@ -1,18 +1,64 @@
-## JsFromRoutes 1.0.3 (2021-03-10) ##
+## [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)
+
+
+
+## [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 ⚡️
+
+- Path helpers now support both making a request or obtaining the path
+- Auto-detect the folder where javascript files live (`frontend`, `packs`, `javascript`, or `assets`)
+- The new default template is more flexible and can be easily customized using the `client_library` setting
+
+### Breaking Changes 💥
+
+- Created client libraries that provide the necessary functionality out of the box (optional)
+- Changed the default template, now using `definePathHelper`
+- Defaults for code generation have changed (`Requests` → `Api`)
+- `path_only?` and `request_method?` have been removed from `Route` during code generation
+  - You may still check for it in your custom templates, using `route.export == :path_only`
+
+## 1.0.3 (2021-03-10) ##
 
 *   Use `~/` instead of `@/` in the default template imports.
 
 
-## JsFromRoutes 1.0.2 (2021-03-10) ##
+## 1.0.2 (2021-03-10) ##
 
 *   Ensure a default `template.js.erb` ships with the gem.
 
 
-## JsFromRoutes 1.0.1 (2020-06-21) ##
+## 1.0.1 (2020-06-21) ##
 
 *   Expose `export_setting` in the `Route` API, to support custom workflows.
 
 
-## JsFromRoutes 1.0.0 (2020-06-21) ##
+## 1.0.0 (2020-06-21) ##
 
 *   Initial Release.

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/README.md

@@ -6,33 +6,16 @@ JS From Rails Routes
 <a href="https://codeclimate.com/github/ElMassimo/js_from_routes"><img alt="Maintainability" src="https://codeclimate.com/github/ElMassimo/js_from_routes/badges/gpa.svg"/></a>
 <a href="https://codeclimate.com/github/ElMassimo/js_from_routes"><img alt="Test Coverage" src="https://codeclimate.com/github/ElMassimo/js_from_routes/badges/coverage.svg"/></a>
 <a href="https://rubygems.org/gems/js_from_routes"><img alt="Gem Version" src="https://img.shields.io/gem/v/js_from_routes.svg?colorB=e9573f"/></a>
-<a href="https://github.com/ElMassimo/js_from_routes/blob/master/LICENSE.txt"><img alt="License" src="https://img.shields.io/badge/license-MIT-428F7E.svg"/></a>
+<a href="https://github.com/ElMassimo/js_from_routes/blob/main/LICENSE.txt"><img alt="License" src="https://img.shields.io/badge/license-MIT-428F7E.svg"/></a>
 </p>
 </h1>
 
 [Vite Rails]: https://vite-ruby.netlify.app/
 [aliases]: https://vite-ruby.netlify.app/guide/development.html#import-aliases-%F0%9F%91%89
+[config options]: https://github.com/ElMassimo/js_from_routes/blob/main/lib/js_from_routes/generator.rb#L82-L85
+[readme]: https://github.com/ElMassimo/js_from_routes
 
-_JS from Routes_ helps you by automatically generating path and API helpers from
-Rails route definitions, allowing you to save development effort and focus on
-the things that matter.
-
-Check out [this pull request](https://github.com/ElMassimo/pingcrm-vite/pull/2) to get a sense of how flexible it can be.
-
-### Why? 🤔
-
-Path helpers in Rails are useful, and make it easier to build urls, avoiding
-typos and mistakes.
-
-With this library, it's possible the enjoy the same benefits in JS:
-
-- No need to manually specify the URL, preventing mistakes and saving development time.
-- If an action is renamed or removed, the helper ceases to exist, which causes
-  an error that is easier to detect than a 404.
-- We can embed the the HTTP verb in the helper. Changing the verb in the route causes the JS
-  code to be regenerated, no need to update the consumer!
-  
-Read more about it in the [blog announcement](https://maximomussini.com/posts/js-from-routes/).
+For more information, check the main [README].
 
 ### Installation 💿
 
@@ -49,138 +32,3 @@ And then execute:
 Or install it yourself as:
 
     $ gem install js_from_routes
-
-### Usage 🚀
-
-#### 1. Specify the Rails routes you want to export
-
-Use the `export` attribute to determine which [routes](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/config/routes.rb#L6) should be taken into account when generating JS.
-
-```ruby
-Rails.application.routes.draw do
-  resources :video_clips, export: true do
-    get :download, on: :member, export: :path_only
-    get :trending, on: :collection, export: false
-  end
-end
-```
-
-#### 2. Generate JS code from your routes
-
-This is usually done automatically the next time you make a request to your
-Rails server (such as when you refresh the page), which causes Rails reloader to
-kick in, and the routes to be generated.
-
-If you are not running a local development server, or prefer to do it manually,
-you can use a rake task instead:
-
-```
-bin/rake js_from_routes:generate
-```
-
-which can generate code such as:
-
-```js
-import { formatUrl } from '~/helpers/UrlHelper'
-import { request } from '~/services/ApiService'
-
-export default {
-  downloadPath: options =>
-    formatUrl('/video_clips/:id/download', options),
-
-  get: options =>
-    request('get', '/video_clips/:id', options),
-    
-  update: options =>
-    request('patch', '/video_clips/:id', options),
-}
-```
-
-#### 3. Use the generated code in your JS application
-
-This can happen in many [different ways](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/Videos.vue#L10), but to illustrate using the example above, in combination with [`axios`](https://github.com/axios/axios) or `fetch`:
-
-```js
-import VideoClipsRequests from '@requests/VideoClipsRequests'
-
-VideoClipsRequests.get({ id: 'oHg5SJYRHA0' }).then(data => { this.video = data })
-
-const newVideo = { ...this.video, format: '.mp4' }
-VideoClipsRequests.update(newVideo)
-
-const path = VideoClipsRequests.downloadPath(newVideo)
-```
-
-Check the [examples](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/Videos.vue) for ideas on how to [use it](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/Videos.vue), and how you can configure it to your convenience.
-
-Read on to find out how to customize the generated code to suit your needs.
-
-### Advanced Configuration 📖
-
-Since all projects are different, it's very unlikely that the default settings
-fulfill all your requirements.
-
-The following [settings](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L77-L80) are available:
-
-##### [`file_suffix`](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L77), default: `Requests.js`
-
-This suffix is added by default to all generated files. You can modify it to
-if you prefer a different convention, or if you use it to generate TypeScript.
-
-##### [`helper_mappings`](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L80)
-
-By default it maps `index` to `list` and `show` to `get`, which helps to make
-the JS code read more naturally.
-
-##### [`output_folder`](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L78), default: `app/javascript/requests`
-
-The directory where the generated files are created.
-
-Tip: It's highly recommended to [add a webpack alias](https://github.com/ElMassimo/js_from_routes/blob/webpack/spec/support/sample_app/config/webpack/aliases.js#L11), to simplify [imports](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/Videos.vue#2).
-
-If you use [Vite Rails], the [aliases] are already configured for you.
-
-##### [`template_path`](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L79)
-
-A [default template](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/template.js.erb) is provided, but it makes assumptions about the [available](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/services/ApiService.js#L17) [code](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/helpers/UrlHelper.js#L28).
-
-You will probably want to use a custom template, such as:
-
-```ruby
-# config/initializers/js_from_routes.rb
-if Rails.env.development?
-  JsFromRoutes.config do |config|
-    config.template_path = Rails.root.join('app', 'views', 'custom_js_from_routes.js.erb')
-  end
-end
-```
-
-A `routes` variable will be available in the template, which will contain the
-endpoints exported for a controller.
-
-Each `route` exposes properties such as `verb` and `path`, please [check the
-source code](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L34-L71) for details on the [API](https://github.com/ElMassimo/js_from_routes/blob/master/lib/js_from_routes/generator.rb#L34-L71).
-
-### How does it work? ⚙️
-
-By adding a hook to Rails' reload process in development, it's possible to
-automatically generate files from routes when a route is added, modified, or removed.
-
-In order to optimize file generation, the generated JS files are split by
-controller, and add a cache key based on the routes to avoid rewriting the file
-if the route definition hasn't changed.
-
-When the Vite.js or Webpack development server is running, it detects when a new
-file is generated, automatically triggering a new build, which can now use the
-generated request methods or path helpers 😃
-
-### Take this idea 💡
-
-While the original use cases intended to generate code that targes a custom `ApiService`, 
-it can be tweaked to generate TypeScript, [target jQuery](https://gist.github.com/ElMassimo/cab56e64e20ff797f3054b661a883646),
-or use it only to generate [path helpers](https://github.com/ElMassimo/js_from_routes/blob/master/spec/support/sample_app/app/javascript/requests/UserPreferencesRequests.js#L11-L15).
-
-There are plenty of other opportunities for automatic code generation, such as keeping
-enums in sync between Ruby and JS.
-
-Let me know if you come up with new or creative ways to use this technique 😃

data/lib/js_from_routes/generator.rb

@@ -3,16 +3,17 @@
 require "digest"
 require "erubi"
 require "fileutils"
+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 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) }
@@ -21,13 +22,32 @@ 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
 
-    # 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)
+    # Public: Exposes the preferred import library to the generator.
+    def client_library
+      @config.client_library
+    end
+
+    # 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
 
@@ -37,21 +57,11 @@ module JsFromRoutes
       @route, @mappings = route, mappings
     end
 
-    # Public: Whether it should export only the path.
-    def path_only?
-      export_setting == :path_only
-    end
-
     # Public: The `export` setting specified for the action.
-    def export_setting
+    def export
       @route.defaults[:export]
     end
 
-    # Public: Whether it should export only the path.
-    def request_method?
-      !path_only?
-    end
-
     # Public: The HTTP verb for the action. Example: 'patch'
     def verb
       @route.verb.downcase
@@ -65,8 +75,7 @@ module JsFromRoutes
     # Public: The name of the JS helper for the action. Example: 'destroyAll'
     def helper
       action = @route.requirements.fetch(:action).camelize(:lower)
-      name = @mappings.fetch(action, action)
-      path_only? ? "#{name}Path" : name
+      @mappings.fetch(action, action)
     end
 
     # Internal: Useful as a cache key for the route, and for debugging purposes.
@@ -75,15 +84,52 @@ 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
-      @config ||= OpenStruct.new(
-        file_suffix: "Requests.js",
-        output_folder: ::Rails.root&.join("app", "javascript", "requests"),
-        template_path: File.expand_path("template.js.erb", __dir__),
-        helper_mappings: {"index" => "list", "show" => "get"}
-      )
+      @config ||= OpenStruct.new(default_config(::Rails.root || Pathname.new(Dir.pwd)))
       yield(@config) if block_given?
       @config
     end
@@ -92,55 +138,57 @@ 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
 
-    # Internal: Returns exported routes grouped by controller name.
-    def exported_routes_by_controller(routes)
-      routes.select { |route|
-        route.defaults.fetch(:export, false)
-      }.group_by { |route|
-        route.requirements.fetch(:controller)
+    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
 
-    # 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
+    def generate_file_for_all(routes)
+      return unless config.all_helpers_file && !routes.empty?
 
-    # Internal: Returns a String with the JS generated for a controller's routes.
-    def render_template(routes)
-      routes.evaluate(compiled_template)
+      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
 
-    # 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
+    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: 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
+    # Internal: Returns exported routes grouped by controller name.
+    def exported_routes_by_controller(routes)
+      routes.select { |route|
+        route.defaults.fetch(:export, false)
+      }.group_by { |route|
+        route.requirements.fetch(:controller)
       }
     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

data/lib/js_from_routes/template.js.erb

@@ -1,22 +1,9 @@
 //
 // DO NOT MODIFY: This file was automatically generated by JsFromRoutes.
-<%
-if routes.any?(&:path_only?)
-  %>import { formatUrl } from '~/helpers/UrlHelper'<%
-end
-%><% if routes.any?(&:path_only?) && routes.any?(&:request_method?) %><%= "\n" %><% end %><%
-if routes.any?(&:request_method?)
-  %>import { request } from '~/services/ApiService'<%
-end
-%>
+import { definePathHelper } from '<%= client_library %>'
 
 export default {
-<% routes.each_with_index do |route, index| %>
-<% if index > 0 %><%= "\n" %><% end
-%>  <%= route.helper %>: options =>
-    <% if route.path_only?
-       %>formatUrl(<% else
-       %>request('<%= route.verb %>', <% end
-                                    %>'<%= route.path %>', options),
+<% 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 = "1.0.3"
+  VERSION = "2.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_from_routes
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.4
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-10 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -139,35 +139,15 @@ 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
-- spec/js_from_routes/js_from_routes_spec.rb
-- spec/spec_helper.rb
-- spec/support/sample_app/app/controllers/application_controller.rb
-- spec/support/sample_app/app/controllers/comments_controller.rb
-- spec/support/sample_app/app/controllers/user_preferences_controller.rb
-- spec/support/sample_app/app/controllers/video_clips_controller.rb
-- spec/support/sample_app/app/controllers/welcome_controller.rb
-- spec/support/sample_app/app/mailers/application_mailer.rb
-- spec/support/sample_app/config/application.rb
-- spec/support/sample_app/config/boot.rb
-- spec/support/sample_app/config/environment.rb
-- spec/support/sample_app/config/environments/development.rb
-- spec/support/sample_app/config/environments/test.rb
-- spec/support/sample_app/config/initializers/application_controller_renderer.rb
-- spec/support/sample_app/config/initializers/backtrace_silencers.rb
-- spec/support/sample_app/config/initializers/content_security_policy.rb
-- spec/support/sample_app/config/initializers/cookies_serializer.rb
-- spec/support/sample_app/config/initializers/filter_parameter_logging.rb
-- spec/support/sample_app/config/initializers/inflections.rb
-- spec/support/sample_app/config/initializers/mime_types.rb
-- spec/support/sample_app/config/initializers/wrap_parameters.rb
-- spec/support/sample_app/config/puma.rb
-- spec/support/sample_app/config/routes.rb
 homepage: https://github.com/ElMassimo/js_from_routes
 licenses:
 - MIT
@@ -191,27 +171,4 @@ rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Generate JS automatically from Rails routes.
-test_files:
-- spec/spec_helper.rb
-- spec/js_from_routes/js_from_routes_spec.rb
-- spec/support/sample_app/app/mailers/application_mailer.rb
-- spec/support/sample_app/app/controllers/video_clips_controller.rb
-- spec/support/sample_app/app/controllers/application_controller.rb
-- spec/support/sample_app/app/controllers/comments_controller.rb
-- spec/support/sample_app/app/controllers/welcome_controller.rb
-- spec/support/sample_app/app/controllers/user_preferences_controller.rb
-- spec/support/sample_app/config/routes.rb
-- spec/support/sample_app/config/environments/development.rb
-- spec/support/sample_app/config/environments/test.rb
-- spec/support/sample_app/config/environment.rb
-- spec/support/sample_app/config/application.rb
-- spec/support/sample_app/config/puma.rb
-- spec/support/sample_app/config/boot.rb
-- spec/support/sample_app/config/initializers/application_controller_renderer.rb
-- spec/support/sample_app/config/initializers/backtrace_silencers.rb
-- spec/support/sample_app/config/initializers/mime_types.rb
-- spec/support/sample_app/config/initializers/filter_parameter_logging.rb
-- spec/support/sample_app/config/initializers/wrap_parameters.rb
-- spec/support/sample_app/config/initializers/cookies_serializer.rb
-- spec/support/sample_app/config/initializers/content_security_policy.rb
-- spec/support/sample_app/config/initializers/inflections.rb
+test_files: []

data/spec/js_from_routes/js_from_routes_spec.rb

@@ -1,78 +0,0 @@
-require "support/sample_app/config/application"
-require "support/sample_app/config/routes"
-
-describe JsFromRoutes do
-  original_template_path = JsFromRoutes.config.template_path
-
-  let(:output_dir) { Pathname.new File.expand_path("../support/generated", __dir__) }
-  let(:sample_dir) { Rails.root.join("app", "javascript", "requests") }
-  let(:different_template_path) { File.expand_path("../support/jquery_template.js.erb", __dir__) }
-  let(:controllers_with_exported_routes) { %w[Comments UserPreferences VideoClips] }
-
-  def file_for(dir, name)
-    dir.join("#{name}Requests.js")
-  end
-
-  def sample_file_for(name)
-    file_for(sample_dir, name)
-  end
-
-  def output_file_for(name)
-    file_for(output_dir, name)
-  end
-
-  before do
-    # Sanity checks
-    expect(sample_dir.exist?).to eq true
-    expect(Rails.application.routes.routes).to be_present
-
-    # Remove directory from a previous test run.
-    begin
-      FileUtils.remove_dir(output_dir)
-    rescue
-      nil
-    end
-
-    # Change the configuration to use a different directory.
-    JsFromRoutes.config do |config|
-      config.output_folder = output_dir
-      config.template_path = original_template_path
-    end
-  end
-
-  # NOTE: We do a manual snapshot test for now, more tests coming in the future.
-  it "should generate the files as expected" do
-    expect(JsFromRoutes).to receive(:render_template).exactly(3).times.and_call_original
-    JsFromRoutes.generate!
-
-    # It does not generate routes that don't have `export: true`.
-    expect(output_file_for("Welcome").exist?).to eq false
-
-    # It generates one file per controller with exported routes.
-    controllers_with_exported_routes.each do |file_name|
-      expect(output_file_for(file_name).read).to eq sample_file_for(file_name).read
-    end
-
-    # It detects changes to the template, and regenerates the files.
-    JsFromRoutes.config do |config|
-      config.template_path = different_template_path
-    end
-    expect(JsFromRoutes).to receive(:render_template).exactly(3).times.and_call_original
-    JsFromRoutes.generate!
-
-    # These files should no longer match the sample ones.
-    controllers_with_exported_routes.each do |file_name|
-      expect(output_file_for(file_name).read).not_to eq sample_file_for(file_name).read
-    end
-
-    # It should not rewrite the files if the cache key has not changed.
-    expect(JsFromRoutes).not_to receive(:render_template)
-    JsFromRoutes.generate!
-  end
-
-  it "should have a rake task available" do
-    Rails.application.load_tasks
-    expect(JsFromRoutes).to receive(:render_template).exactly(3).times
-    expect { Rake::Task["js_from_routes:generate"].invoke }.not_to raise_error
-  end
-end

data/spec/spec_helper.rb

@@ -1,7 +0,0 @@
-require "simplecov"
-SimpleCov.start { add_filter "/spec/" }
-
-require "rails"
-require "js_from_routes"
-require "rspec/given"
-require "pry-byebug"

data/spec/support/sample_app/app/controllers/application_controller.rb

@@ -1,2 +0,0 @@
-class ApplicationController < ActionController::Base
-end

data/spec/support/sample_app/app/controllers/comments_controller.rb

@@ -1,2 +0,0 @@
-class CommentsController < ApplicationController
-end

data/spec/support/sample_app/app/controllers/user_preferences_controller.rb

@@ -1,2 +0,0 @@
-class UserPreferencesController < ApplicationController
-end

data/spec/support/sample_app/app/controllers/video_clips_controller.rb

@@ -1,17 +0,0 @@
-class VideoClipsController < ApplicationController
-  def trending
-    render json: [
-      {title: "Smoke Signals"},
-      {title: "Camino Libre"},
-      {title: "Sin Querer"},
-      {title: "Tabula Rasa"},
-      {title: "Raindance"},
-      {title: "Ragamuffin"},
-      {title: "Vals Venezolano Nº 2"},
-      {title: "Xaranga do Vovô"},
-      {title: "Café 1930"},
-      {title: "Milonga (Uruguay)"},
-      {title: "Divagando"}
-    ]
-  end
-end

data/spec/support/sample_app/app/controllers/welcome_controller.rb

@@ -1,2 +0,0 @@
-class WelcomeController < ApplicationController
-end

data/spec/support/sample_app/app/mailers/application_mailer.rb

@@ -1,4 +0,0 @@
-class ApplicationMailer < ActionMailer::Base
-  default from: "from@example.com"
-  layout "mailer"
-end

data/spec/support/sample_app/config/application.rb

@@ -1,15 +0,0 @@
-require_relative "boot"
-
-require "action_controller/railtie"
-
-# Require the gems listed in Gemfile, including any gems
-# you've limited to :test, :development, or :production.
-Bundler.require(*Rails.groups)
-
-module SampleApp
-  class Application < Rails::Application
-    # Application configuration can go into files in config/initializers
-    # -- all .rb files in that directory are automatically loaded after loading
-    # the framework and any gems in your application.
-  end
-end

data/spec/support/sample_app/config/boot.rb

@@ -1,3 +0,0 @@
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
-
-require "bundler/setup" # Set up gems listed in the Gemfile.

data/spec/support/sample_app/config/environment.rb

@@ -1,5 +0,0 @@
-# Load the Rails application.
-require_relative "application"
-
-# Initialize the Rails application.
-Rails.application.initialize!

data/spec/support/sample_app/config/environments/development.rb

@@ -1,25 +0,0 @@
-Rails.application.configure do
-  # Settings specified here will take precedence over those in config/application.rb.
-
-  # In the development environment your application's code is reloaded on
-  # every request. This slows down response time but is perfect for development
-  # since you don't have to restart the web server when you make code changes.
-  config.cache_classes = false
-
-  # Do not eager load code on boot.
-  config.eager_load = false
-
-  # Show full error reports.
-  config.consider_all_requests_local = true
-
-  # Store uploaded files on the local file system (see config/storage.yml for options).
-  # Print deprecation notices to the Rails logger.
-  config.active_support.deprecation = :log
-
-  # Raises error for missing translations.
-  # config.action_view.raise_on_missing_translations = true
-
-  # Use an evented file watcher to asynchronously detect changes in source code,
-  # routes, locales, etc. This feature depends on the listen gem.
-  config.file_watcher = ActiveSupport::EventedFileUpdateChecker
-end

data/spec/support/sample_app/config/environments/test.rb

@@ -1,5 +0,0 @@
-Rails.application.configure do
-  # Settings specified here will take precedence over those in config/application.rb.
-  config.cache_classes = true
-  config.eager_load = true
-end

data/spec/support/sample_app/config/initializers/application_controller_renderer.rb

@@ -1,8 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# ActiveSupport::Reloader.to_prepare do
-#   ApplicationController.renderer.defaults.merge!(
-#     http_host: 'example.org',
-#     https: false
-#   )
-# end

data/spec/support/sample_app/config/initializers/backtrace_silencers.rb

@@ -1,7 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
-# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
-
-# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
-# Rails.backtrace_cleaner.remove_silencers!

data/spec/support/sample_app/config/initializers/content_security_policy.rb

@@ -1,37 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Define an application-wide content security policy
-# For further information see the following documentation
-# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy
-
-# Rails.application.config.content_security_policy do |policy|
-#   policy.default_src :self, :https
-#   policy.font_src    :self, :https, :data
-#   policy.img_src     :self, :https, :data
-#   policy.object_src  :none
-#   policy.script_src  :self, :https
-# Allow @vite/client to hot reload changes in development
-#    policy.script_src *policy.script_src, :unsafe_eval, "http://localhost:3036" if Rails.env.development?
-
-# You may need to enable this in production as well depending on your setup.
-#    policy.script_src *policy.script_src, :blob if Rails.env.test?
-#   policy.style_src   :self, :https
-#   # If you are using webpack-dev-server then specify webpack-dev-server host
-#   policy.connect_src :self, :https, "http://localhost:3035", "ws://localhost:3035" if Rails.env.development?
-# Allow @vite/client to hot reload changes in development
-#    policy.connect_src *policy.connect_src, "ws://#{ ViteRuby.config.host_with_port }" if Rails.env.development?
-
-#   # Specify URI for violation reports
-#   # policy.report_uri "/csp-violation-report-endpoint"
-# end
-
-# If you are using UJS then enable automatic nonce generation
-# Rails.application.config.content_security_policy_nonce_generator = -> request { SecureRandom.base64(16) }
-
-# Set the nonce only to specific directives
-# Rails.application.config.content_security_policy_nonce_directives = %w(script-src)
-
-# Report CSP violations to a specified URI
-# For further information see the following documentation:
-# https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy-Report-Only
-# Rails.application.config.content_security_policy_report_only = true

data/spec/support/sample_app/config/initializers/cookies_serializer.rb

@@ -1,5 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Specify a serializer for the signed and encrypted cookie jars.
-# Valid options are :json, :marshal, and :hybrid.
-Rails.application.config.action_dispatch.cookies_serializer = :json

data/spec/support/sample_app/config/initializers/filter_parameter_logging.rb

@@ -1,4 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Configure sensitive parameters which will be filtered from the log file.
-Rails.application.config.filter_parameters += [:password]

data/spec/support/sample_app/config/initializers/inflections.rb

@@ -1,16 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Add new inflection rules using the following format. Inflections
-# are locale specific, and you may define rules for as many different
-# locales as you wish. All of these examples are active by default:
-# ActiveSupport::Inflector.inflections(:en) do |inflect|
-#   inflect.plural /^(ox)$/i, '\1en'
-#   inflect.singular /^(ox)en/i, '\1'
-#   inflect.irregular 'person', 'people'
-#   inflect.uncountable %w( fish sheep )
-# end
-
-# These inflection rules are supported but not enabled by default:
-# ActiveSupport::Inflector.inflections(:en) do |inflect|
-#   inflect.acronym 'RESTful'
-# end

data/spec/support/sample_app/config/initializers/mime_types.rb

@@ -1,4 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# Add new mime types for use in respond_to blocks:
-# Mime::Type.register "text/richtext", :rtf

data/spec/support/sample_app/config/initializers/wrap_parameters.rb

@@ -1,14 +0,0 @@
-# Be sure to restart your server when you modify this file.
-
-# This file contains settings for ActionController::ParamsWrapper which
-# is enabled by default.
-
-# Enable parameter wrapping for JSON. You can disable this by setting :format to an empty array.
-ActiveSupport.on_load(:action_controller) do
-  wrap_parameters format: [:json]
-end
-
-# To enable root element in JSON for ActiveRecord objects.
-# ActiveSupport.on_load(:active_record) do
-#   self.include_root_in_json = true
-# end

data/spec/support/sample_app/config/puma.rb

@@ -1,38 +0,0 @@
-# Puma can serve each request in a thread from an internal thread pool.
-# The `threads` method setting takes two numbers: a minimum and maximum.
-# Any libraries that use thread pools should be configured to match
-# the maximum value specified for Puma. Default is set to 5 threads for minimum
-# and maximum; this matches the default thread size of Active Record.
-#
-max_threads_count = ENV.fetch("RAILS_MAX_THREADS", 5)
-min_threads_count = ENV.fetch("RAILS_MIN_THREADS", max_threads_count)
-threads min_threads_count, max_threads_count
-
-# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
-#
-port ENV.fetch("PORT", 3000)
-
-# Specifies the `environment` that Puma will run in.
-#
-environment ENV.fetch("RAILS_ENV") { "development" }
-
-# Specifies the `pidfile` that Puma will use.
-pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
-
-# Specifies the number of `workers` to boot in clustered mode.
-# Workers are forked web server processes. If using threads and workers together
-# the concurrency of the application would be max `threads` * `workers`.
-# Workers do not work on JRuby or Windows (both of which do not support
-# processes).
-#
-# workers ENV.fetch("WEB_CONCURRENCY") { 2 }
-
-# Use the `preload_app!` method when specifying a `workers` number.
-# This directive tells Puma to first boot the application and load code
-# before forking the application. This takes advantage of Copy On Write
-# process behavior so workers use less memory.
-#
-# preload_app!
-
-# Allow puma to be restarted by `rails restart` command.
-plugin :tmp_restart

data/spec/support/sample_app/config/routes.rb

@@ -1,22 +0,0 @@
-Rails.application.routes.draw do
-  root to: "welcome#home"
-
-  resources :welcome
-
-  resources :video_clips, only: [:new, :edit, :create, :update, :destroy], export: true do
-    get :download, on: :member, export: :path_only
-    patch :add_to_playlist, on: :member
-    patch :remove_from_playlist, on: :member
-    get :trending, on: :collection
-    get "/thumbnail/:thumbnail_id", as: :thumbnail, action: :thumbnail, on: :member
-
-    resources :comments, only: [:show, :index], shallow: true, export: true
-  end
-
-  resources :user_preferences, only: [], export: true do
-    patch :switch_to_classic_navbar, on: :collection
-    get :switch_to_beta_navbar, on: :collection, export: false
-    get "/switch_to_classic/:page", action: :switch_to_classic, on: :collection, export: :path_only
-    get "/switch_to_beta/:page", action: :switch_to_beta, on: :collection, as: :switch_to_beta_page, export: :path_only
-  end
-end