enroute 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a65a1195f13ae4e7252622ddbc6da85afd4076aff0e954acb1460ea5792b4018
-  data.tar.gz: 3ee3e8d588d5b525122530b89d20561eaaef96d4967e952c9b291ee9c74036ad
+  metadata.gz: e448075c7d87f3b0a6c937069a8d97aabafc703eb1a32de10ed724c7360eb09a
+  data.tar.gz: 0440e5b70267913d65ed6876884a0bde6eb3d76d9b9ab7432d248706cbc5585b
 SHA512:
-  metadata.gz: e2b6a3fab6873badc69fb61a1708dc6a090861b7f8859145e97492d97fc04a9dde3e314861b999756c3e9ba0c7db4bb5c93058f63d5b4d83f4542b989ac00e1f
-  data.tar.gz: c608f1415e466716c2f423f70e857739963963cc19d27976cded97bb2e0c4b48c9f726f2fa1307f15c96389868f2efa24d9e93e0b1ce6ff4e212016878fe3c46
+  metadata.gz: 630f02374224590f3f51283d6b2735cabafc52454139e295be371cf5381a99c5d27f15d3d6fee4b46a7e09462cb6b6d5f20919e0956c94667beca4933743a9be
+  data.tar.gz: 485794ae75c343f3d198c206a0e9e89ba8d512d8a931f6414ef77a9b96a8d552b3a9bc1b428abb5b550ba3f621c5c7ff7684d24afbb9f66279f5d34edab4dfaa

data/.github/workflows/tests.yml

@@ -19,14 +19,14 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1"]
-        node: ["16", "17"]
+        ruby: ["3.1", "3.2", "3.3"]
+        node: ["18", "20"]
         gemfile:
+          - gemfiles/rails_7_1.gemfile
           - gemfiles/rails_7_0.gemfile
-          - gemfiles/rails_6_1.gemfile
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: actions/cache@v3
         with:
@@ -36,7 +36,7 @@ jobs:
             hashFiles('package.json') }}
 
       - name: Set up Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
 

data/.rubocop.yml

@@ -8,3 +8,9 @@ AllCops:
   Exclude:
     - vendor/**/*
     - gemfiles/**/*
+
+Minitest/MultipleAssertions:
+  Enabled: false
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/.tool-versions

@@ -1 +1,2 @@
-nodejs 16.13.1
+nodejs 21.6.1
+ruby 3.3.0

data/README.md

@@ -83,10 +83,10 @@ You can then import any route that's been exported. Parameters are positional.
 ```typescript
 import { userUrl } from "./routes";
 
-userUrl(1234);
+userUrl({ id: 1234 });
 //=> "/users/1234"
 
-userUrl(1234, "json");
+userUrl({ id: 1234, format: "json" });
 //=> "/users/1234.json"
 ```
 
@@ -100,7 +100,7 @@ import { editSettingsUrl } from "./routes";
 editSettingsUrl();
 //=> "/settings/edit"
 
-editSettingsUrl("security");
+editSettingsUrl({ section: "security" });
 //=> "/settings/edit/security"
 ```
 
@@ -139,6 +139,6 @@ found at https://github.com/fnando/enroute/blob/main/LICENSE.md.
 
 ## Code of Conduct
 
-Everyone interacting in the enroute project's codebases, issue
-trackers, chat rooms and mailing lists is expected to follow the
+Everyone interacting in the enroute project's codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the
 [code of conduct](https://github.com/fnando/enroute/blob/main/CODE_OF_CONDUCT.md).

data/gemfiles/rails_7_1.gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+gemspec path: ".."
+
+gem "rails", "~> 7.1.0"

data/jest.config.js

@@ -1,3 +1,4 @@
 module.exports = {
-  transform: {"\\.ts$": ["ts-jest"]}
+  transform: { "\\.ts$": ["ts-jest"] },
+  testEnvironment: "jest-environment-jsdom",
 };

data/lib/enroute/export.rb

@@ -54,14 +54,21 @@ module Enroute
     end
 
     def build_ts_args_definition(route)
-      route[:segments].map do |segment|
+      args = route[:segments].each_with_object([]) do |segment, buffer|
         type = route.dig(:typings, segment)&.chomp ||
                config.dig(:typings, :_default, segment)&.chomp ||
                "any"
 
         optional = route[:requiredSegments].include?(segment) ? "" : "?"
-        "#{segment.camelize(:lower)}#{optional}: #{type}"
-      end.join(", ")
+
+        buffer << "#{segment.camelize(:lower)}#{optional}: #{type}"
+      end
+
+      args << "params?: Record<string, unknown>"
+
+      "args?: {#{args.join('; ')}}"
+
+      # (args + ["params: Record<string, unknown> = {}"]).join(", ")
     end
 
     def build_ts_handler_function(route)
@@ -71,12 +78,21 @@ module Enroute
 
     def build_ts_route_function(route)
       args = build_ts_args_definition(route)
-      segments = route[:segments].map {|segment| segment.camelize(:lower) }
 
-      [
-        %[export const #{route[:name]}Url = (#{args}): string =>],
-        %[  #{route[:name]}Handler(#{segments.join(', ')});]
-      ].join("\n")
+      segments = route[:segments].map {|segment| segment.camelize(:lower) }
+      destruct = [segments.join(", "), "params"].reject(&:blank?).join(", ")
+
+      <<~TYPESCRIPT
+        export function #{route[:name]}Url(#{args}): string {
+          const {#{destruct}} = args ?? {};
+          return buildUrl(#{route[:name]}Handler(#{segments.join(', ')}), params ?? {}).url;
+        }
+
+        export function #{route[:name]}Path(#{args}): string {
+          const {#{destruct}} = args ?? {};
+          return buildUrl(#{route[:name]}Handler(#{segments.join(', ')}), params ?? {}).path;
+        }
+      TYPESCRIPT
     end
   end
 end

data/lib/enroute/template.ts.erb

@@ -2,7 +2,13 @@
 // This file has been automatically generated.
 // Don't edit it manually. Use `enroute export` instead.
 
-import { zipObject } from "lodash";
+function zipObject(keys: string[], values: unknown[]): Record<string, unknown> {
+  return keys.reduce((buffer, key, index) =>
+    Object.assign(
+      buffer,
+      {[key]: values[index]}
+    ), {} as Record<string, unknown>)
+}
 
 function camelize(text: string): string {
   return text.replace(
@@ -110,6 +116,24 @@ export type RouteHandler = RouteHelper & {
   underscore: RouteHelper;
 };
 
+const baseUrl = location.protocol + "//" + location.host;
+
+const buildUrl = (
+  path: string,
+  params: Record<string, unknown>
+): {path: string; url: string} => {
+  const url = new URL(baseUrl + path);
+
+  Object.keys(params).forEach((key) => {
+    url.searchParams.set(key, String(params[key]));
+  });
+
+  return {
+    path: url.pathname + url.search,
+    url: url.toString(),
+  };
+}
+
 <%= handler_functions %>
 
 <%= route_functions %>

data/lib/enroute/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Enroute
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/package.json

@@ -14,5 +14,8 @@
     "prettier": "*",
     "ts-jest": "*",
     "typescript": "*"
+  },
+  "dependencies": {
+    "jest-environment-jsdom": "^29.7.0"
   }
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enroute
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-12 00:00:00.000000000 Z
+date: 2024-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -166,6 +166,7 @@ files:
 - exe/enroute
 - gemfiles/rails_6_1.gemfile
 - gemfiles/rails_7_0.gemfile
+- gemfiles/rails_7_1.gemfile
 - jest.config.js
 - lib/enroute.rb
 - lib/enroute/cli.rb
@@ -198,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.17
+rubygems_version: 3.5.5
 signing_key:
 specification_version: 4
 summary: Export Rails routes to TypeScript definitions