webpacker-routes 0.0.11 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5194266884b788ff6ffd76ecf6408d7196fc8e4769381c6a63ef19ad49a30571
-  data.tar.gz: 3fc7761af1ec667dd6f9cb742dd5131439bd42e36e801bc1f21f4d1bfd44e7b8
+  metadata.gz: c0593e1d38a8f7b8c3f5f8d46a27609b6c4552fdaa7030ad15e05734d9c0f4ba
+  data.tar.gz: 1399772ba3737f5fb38418eb17c7730dd606f36f16c84df146e0a7bbccf94656
 SHA512:
-  metadata.gz: df569079481a998bec69b845602ee4f9ec35d6589fab7a91248608c9bcfeaa53a37ad2f25b35061b4be65ee427a6d188f98c5691526fa26deeca9d285c31d0d5
-  data.tar.gz: acd55b6c961fa9372b311d96ff6ea9494213f8dbd83d1963f73b8b0b5b16d2f5a1134467ef4f5d3d4459de648e750219f76a7be4faa3950c41ccd916fb53c9bf
+  metadata.gz: 3c6916c6d80e316f5d73bd8217cbac538fc1a4caa23a4b950d8af566fce20776b97fc2534448ff059353ad3946ea94fc4721315e8ac643f6600876d64d0e0238
+  data.tar.gz: a129f2c9afe03ff317b1e0f9c42ec045edd53680d16b08bca3a4cc1d26e869b4666e947a9ef199ee6fae3bcca93056aa657cd5913404a07bfdbae19b73d4b052

data/README.md

@@ -18,9 +18,34 @@ $ bundle exec rails webpacker:install:routes
 Import individual routes from any Webpacker-compiled file:
 
 ```javascript
-import { root_path } from 'routes'
+import { root_path, root_url } from 'routes'
+import { engine_path } from 'routes/engine_name'
 
-console.log(root_path())
+root_path()
+// /
+
+root_path({ foo: 'bar' })
+// /?foo=bar
+
+root_url({ host: 'https://example.com' })
+// https://example.com/
+
+root_url({ host: 'https://example.com', bar: 'baz' })
+// https://example.com/?bar=baz
+
+root_url({
+  anchor: 'abc',
+  host: 'example.com',
+  params: {
+    foo: 'bar'
+  },
+  port: 3000,
+  protocol: 'https',
+  relative_url_root: '/rel',
+  trailing_slash: true,
+  bar: 'baz'
+})
+// https://example.com:3000/rel/?bar=baz&foo=bar#abc
 ```
 
 The routes file is generated when Rails starts, including during `webpacker:compile` (or `assets:precompile`).
@@ -31,11 +56,10 @@ To generate routes manually, run:
 $ bundle exec rails webpacker:routes:generate
 ```
 
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+### Options
 
-## Todo
+- `config.webpacker.routes.default_url_options` - defaults used for generating urls. These are merged with `Rails.application.default_url_options`. Default: `{}`
+- `config.webpacker.routes.camel_case` - convert route names to camel case. Default: `false`
 
-- support all valid route names
-- relative_url_root
-- camelcase
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/install/template.rb

@@ -1,5 +1,5 @@
 say "Creating JavaScript app source directory"
-file Webpacker.config.routes_path.join('.gitignore'), "/index.js\n"
+file Webpacker.config.routes_path.join('.gitignore'), "*\n!.gitignore\n"
 
 say "Installing all JavaScript dependencies"
 run "yarn add webpacker-routes@#{Webpacker::Routes::VERSION} --exact"

data/lib/tasks/webpacker/routes_tasks.rake

@@ -25,7 +25,7 @@ namespace :webpacker do
 
     desc "Generate routes package"
     task generate: [:verify_install, :environment] do
-      Webpacker::Routes.generate(Rails.application.routes)
+      Webpacker::Routes.generate(Rails.application)
     end
   end
 end

data/lib/webpacker/routes.rb

@@ -4,7 +4,7 @@ require "webpacker/routes/railtie"
 module Webpacker
   class Configuration
     def routes_path
-      source_path.join('routes')
+      fetch(:routes_path) || source_path.join('routes')
     end
   end
 
@@ -13,29 +13,80 @@ module Webpacker
     IGNORED_OPTIONS = %i[controller action]
 
     class << self
-      def generate(route_set)
-        File.atomic_write(Webpacker.config.routes_path.join('index.js')) do |file|
-          default_url_options = js(route_set.default_url_options.except(*IGNORED_OPTIONS))
-
-          file.write(<<-JAVASCRIPT.strip_heredoc)
-            import { urlFor, pathFor } from 'webpacker-routes'
-            const default_url_options = #{default_url_options}
-          JAVASCRIPT
-
-          route_set.named_routes.sort_by(&:first).each do |name, route|
-            raise `Invalid route name for javascript: ${name}` unless JAVASCRIPT_VARIABLE_NAME_REGEX =~ name
-
-            spec = js(route.path.spec.to_s)
-            segment_keys = js(route.segment_keys.uniq)
-            options = js(route.defaults.except(*IGNORED_OPTIONS))
-
-            file.write(<<-JAVASCRIPT.strip_heredoc)
-              const #{name}_spec = [#{spec}, #{segment_keys}, { ...default_url_options, ...#{options} }]
-              export const #{name}_url = (...args) => urlFor(#{name}_spec, ...args)
-              export const #{name}_path = (...args) => pathFor(#{name}_spec, ...args)
-            JAVASCRIPT
+      def generate(app)
+        config = app.config.webpacker.routes
+        var_name = -> (name) { config.camel_case ? name.camelize(:lower) : name }
+
+        default_url_options = app.default_url_options.dup
+        default_url_options[:relative_url_root] = app.config.relative_url_root if app.config.relative_url_root
+        default_url_options.merge!(config.default_url_options)
+        default_url_options.except!(*IGNORED_OPTIONS)
+
+        parent_spec_var = var_name.call('parent_spec')
+        default_url_options_var = var_name.call('default_url_options')
+
+        route_sets = [[app.routes, nil, Webpacker.config.routes_path]]
+        visited_directories = []
+
+        while (route_set, parent, directory = route_sets.shift)
+          directory.mkpath
+          visited_directories << directory
+          js_file = directory.join('index.js')
+
+          catch(:identical) do
+            File.atomic_write(js_file) do |temp_file|
+              parent_var_definition = if parent
+                "import { #{parent} as #{parent_spec_var} } from '../'"
+              else
+                "const #{parent_spec_var} = null"
+              end
+
+              temp_file.write(<<-JAVASCRIPT.strip_heredoc)
+                import { urlFor, pathFor } from 'webpacker-routes'
+                #{parent_var_definition}
+                const #{default_url_options_var} = #{js(default_url_options)}
+              JAVASCRIPT
+
+              route_set.named_routes.sort_by(&:first).each do |name, route|
+                raise `Invalid route name for javascript: ${name}` unless JAVASCRIPT_VARIABLE_NAME_REGEX =~ name
+
+                spec = route.path.spec.to_s
+                segment_keys = route.segment_keys.uniq
+                options = route.defaults.except(*IGNORED_OPTIONS)
+
+                spec_var = var_name.call("#{name}_spec")
+                url_var = var_name.call("#{name}_url")
+                path_var = var_name.call("#{name}_path")
+
+                temp_file.write(<<-JAVASCRIPT.strip_heredoc)
+                  export const #{spec_var} = [#{js(spec)}, #{js(segment_keys)}, { ...#{default_url_options_var}, ...#{js(options)} }, #{parent_spec_var}]
+                  export const #{url_var} = (...args) => urlFor(#{spec_var}, ...args)
+                  export const #{path_var} = (...args) => pathFor(#{spec_var}, ...args)
+                JAVASCRIPT
+
+                if engine?(route)
+                  engine = rack_app(route)
+                  engine_name = engine.railtie_name
+
+                  raise `Invalid engine name for javascript: ${engine_name}` unless JAVASCRIPT_VARIABLE_NAME_REGEX =~ engine_name
+
+                  engine_name_var = var_name.call(engine_name)
+
+                  route_sets << [engine.routes, spec_var, directory.join(engine_name_var)]
+                end
+              end
+
+              temp_file.close
+              if identical?(js_file.to_s, temp_file.path)
+                temp_file.unlink
+                throw :identical
+              end
+            end
           end
         end
+
+        extra_directories = Webpacker.config.routes_path.glob('**/*').select(&:directory?) - visited_directories
+        extra_directories.sort_by { |directory| directory.to_s.size }.reverse_each(&:rmtree)
       end
 
     private
@@ -43,6 +94,21 @@ module Webpacker
       def js(obj)
         ERB::Util.json_escape(obj.to_json)
       end
+
+      def identical?(path1, path2)
+        FileUtils.compare_file(path1, path2)
+      rescue Errno::ENOENT
+        false
+      end
+
+      def rack_app(route)
+        route.app.app
+      end
+
+      def engine?(route)
+        app = rack_app(route)
+        app.is_a?(Class) && app < Rails::Engine
+      end
     end
   end
 end

data/lib/webpacker/routes/railtie.rb

@@ -1,14 +1,19 @@
+require 'webpacker/railtie'
+
 module Webpacker
   module Routes
     class Engine < ::Rails::Engine
+      config.webpacker.routes = ActiveSupport::OrderedOptions.new
+      config.webpacker.routes.default_url_options = {}
+      config.webpacker.routes.camel_case = false
+
       config.after_initialize do |app|
-        generate = -> { Webpacker::Routes.generate(app.tap(&:reload_routes!).routes) }
         if Rails::VERSION::MAJOR >= 5
-          app.reloader.to_run(&generate)
+          app.reloader.to_run(:after) { Webpacker::Routes.generate(app) }
         else
-          ActionDispatch::Reloader.to_prepare(&generate)
+          ActionDispatch::Reloader.to_prepare(:after) { Webpacker::Routes.generate(app) }
         end
-        generate.call unless ENV['WEBPACKER_ROUTES_INSTALL'] == 'true'
+        Webpacker::Routes.generate(app.tap(&:reload_routes!)) unless ENV['WEBPACKER_ROUTES_INSTALL']
       end
     end
   end

data/lib/webpacker/routes/version.rb

@@ -1,5 +1,5 @@
 module Webpacker
   module Routes
-    VERSION = '0.0.11'
+    VERSION = '0.1.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webpacker-routes
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.1.4
 platform: ruby
 authors:
 - David Harsha
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-14 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -84,7 +84,8 @@ files:
 homepage: https://github.com/davishmcclurg/webpacker-routes
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/davishmcclurg/webpacker-routes
 post_install_message: 
 rdoc_options: []
 require_paths: