js-routes 2.0.5 → 2.1.0

data/lib/tasks/js_routes.rake

@@ -1,8 +1,14 @@
 namespace :js do
-  desc "Make a js file that will have functions that will return restful routes/urls."
+  desc "Make a js file with all rails route URL helpers"
   task routes: :environment do
     require "js-routes"
-
     JsRoutes.generate!
   end
+
+  namespace :routes do
+    desc "Make a js file with all rails route URL helpers and typescript definitions for them"
+    task typescript: "js:routes" do
+      JsRoutes.definitions!
+    end
+  end
 end

data/package.json

@@ -21,6 +21,7 @@
     "prettier": "^2.2.1"
   },
   "scripts": {
+    "build": "tsc && yarn lint:fix",
     "lint:fix": "yarn eslint --fix && yarn prettier --write lib/routes.ts",
     "postinstall": "yarn husky-upgrade"
   },
@@ -30,7 +31,7 @@
     }
   },
   "lint-staged": {
-    "*.ts": ["yarn lint:fix" ]
+    "./lib/routes.ts": ["yarn lint:fix" ]
   }
 
 }

data/spec/js_routes/default_serializer_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe JsRoutes, "#serialize" do
 
   before(:each) do
-    evaljs(JsRoutes.generate({module_type: nil}))
+    evaljs(JsRoutes.generate({module_type: nil, namespace: 'Routes'}))
   end
 
   it "should provide this method" do

data/spec/js_routes/module_types/dts/routes.spec.d.ts

@@ -0,0 +1,114 @@
+/**
+ * File generated by js-routes RubyVariables.GEM_VERSION
+ * Based on Rails RubyVariables.RAILS_VERSION routes of RubyVariables.APP_CLASS
+ */
+declare type Optional<T> = {
+    [P in keyof T]?: T[P] | null;
+};
+declare type BaseRouteParameter = string | boolean | Date | number;
+declare type MethodRouteParameter = BaseRouteParameter | (() => BaseRouteParameter);
+declare type ModelRouteParameter = {
+    id: MethodRouteParameter;
+} | {
+    to_param: MethodRouteParameter;
+} | {
+    toParam: MethodRouteParameter;
+};
+declare type RequiredRouteParameter = BaseRouteParameter | ModelRouteParameter;
+declare type OptionalRouteParameter = undefined | null | RequiredRouteParameter;
+declare type QueryRouteParameter = OptionalRouteParameter | QueryRouteParameter[] | {
+    [k: string]: QueryRouteParameter;
+};
+declare type RouteParameters = Record<string, QueryRouteParameter>;
+declare type Serializable = Record<string, unknown>;
+declare type Serializer = (value: Serializable) => string;
+declare type RouteHelperExtras = {
+    requiredParams(): string[];
+    toString(): string;
+};
+declare type RequiredParameters<T extends number> = T extends 1 ? [RequiredRouteParameter] : T extends 2 ? [RequiredRouteParameter, RequiredRouteParameter] : T extends 3 ? [RequiredRouteParameter, RequiredRouteParameter, RequiredRouteParameter] : T extends 4 ? [
+    RequiredRouteParameter,
+    RequiredRouteParameter,
+    RequiredRouteParameter,
+    RequiredRouteParameter
+] : RequiredRouteParameter[];
+declare type RouteHelperOptions<T extends string> = RouteOptions & Optional<Record<T, OptionalRouteParameter>>;
+declare type RouteHelper<T extends number = number, U extends string = string> = ((...args: [...RequiredParameters<T>, RouteHelperOptions<U>]) => string) & RouteHelperExtras;
+declare type RouteHelpers = Record<string, RouteHelper>;
+declare type Configuration = {
+    prefix: string;
+    default_url_options: RouteParameters;
+    special_options_key: string;
+    serializer: Serializer;
+};
+interface RouterExposedMethods {
+    config(): Configuration;
+    configure(arg: Partial<Configuration>): Configuration;
+    serialize: Serializer;
+}
+declare type KeywordUrlOptions = Optional<{
+    host: string;
+    protocol: string;
+    subdomain: string;
+    port: string | number;
+    anchor: string;
+    trailing_slash: boolean;
+}>;
+declare type RouteOptions = KeywordUrlOptions & RouteParameters;
+declare type PartsTable = Record<string, {
+    r?: boolean;
+    d?: OptionalRouteParameter;
+}>;
+declare type ModuleType = "CJS" | "AMD" | "UMD" | "ESM" | "DTS" | "NIL";
+declare const RubyVariables: {
+    PREFIX: string;
+    DEPRECATED_GLOBBING_BEHAVIOR: boolean;
+    SPECIAL_OPTIONS_KEY: string;
+    DEFAULT_URL_OPTIONS: RouteParameters;
+    SERIALIZER: Serializer;
+    NAMESPACE: string;
+    ROUTES_OBJECT: RouteHelpers;
+    MODULE_TYPE: ModuleType;
+    WRAPPER: <T>(callback: T) => T;
+};
+declare const define: undefined | (((arg: unknown[], callback: () => unknown) => void) & {
+    amd?: unknown;
+});
+declare const module: {
+    exports: any;
+} | undefined;
+export const configure: RouterExposedMethods['configure'];
+
+export const config: RouterExposedMethods['config'];
+
+export const serialize: RouterExposedMethods['serialize'];
+
+/**
+ * Generates rails route to
+ * /inboxes/:inbox_id/messages/:message_id/attachments/:id(.:format)
+ * @param {any} inbox_id
+ * @param {any} message_id
+ * @param {any} id
+ * @param {object | undefined} options
+ * @returns {string} route path
+ */
+export const inbox_message_attachment_path: ((
+  inbox_id: RequiredRouteParameter,
+  message_id: RequiredRouteParameter,
+  id: RequiredRouteParameter,
+  options?: {format?: OptionalRouteParameter} & RouteOptions
+) => string) & RouteHelperExtras;
+
+/**
+ * Generates rails route to
+ * /inboxes(.:format)
+ * @param {object | undefined} options
+ * @returns {string} route path
+ */
+export const inboxes_path: ((
+  options?: {format?: OptionalRouteParameter} & RouteOptions
+) => string) & RouteHelperExtras;
+
+// By some reason this line prevents all types in a file
+// from being automatically exported
+export {};

data/spec/js_routes/module_types/dts/test.spec.ts

@@ -0,0 +1,56 @@
+import {
+  inbox_message_attachment_path,
+  inboxes_path,
+  serialize,
+  configure,
+  config,
+} from "./routes.spec";
+
+// Route Helpers
+inboxes_path();
+inboxes_path({
+  locale: "en",
+  search: {
+    q: "ukraine",
+    page: 3,
+    keywords: ["large", "small", { advanced: true }],
+  },
+});
+
+inbox_message_attachment_path(1, "2", true);
+inbox_message_attachment_path(
+  { id: 1 },
+  { to_param: () => "2" },
+  { toParam: () => true }
+);
+inbox_message_attachment_path(1, "2", true, { format: "json" });
+inboxes_path.toString();
+inboxes_path.requiredParams();
+
+// serialize test
+const SerializerArgument = {
+  locale: "en",
+  search: {
+    q: "ukraine",
+    page: 3,
+    keywords: ["large", "small", { advanced: true }],
+  },
+};
+serialize(SerializerArgument);
+config().serializer(SerializerArgument);
+
+// configure test
+configure({
+  default_url_options: { port: 1, host: null },
+  prefix: "",
+  special_options_key: "_options",
+  serializer: (value) => JSON.stringify(value),
+});
+
+// config tests
+const Config = config();
+console.log(
+  Config.prefix,
+  Config.default_url_options,
+  Config.special_options_key
+);

data/spec/js_routes/module_types/dts_spec.rb

@@ -0,0 +1,111 @@
+
+require "active_support/core_ext/string/strip"
+require "fileutils"
+require "open3"
+require "spec_helper"
+
+describe JsRoutes, "compatibility with DTS"  do
+
+  OPTIONS = {module_type: 'DTS', include: [/^inboxes$/, /^inbox_message_attachment$/]}
+  let(:extra_options) do
+    {}
+  end
+
+  let(:generated_js) do
+    JsRoutes.generate({**OPTIONS, **extra_options})
+  end
+
+  context "when file is generated" do
+    let(:dir_name) do
+       File.expand_path(__dir__ + "/dts")
+    end
+
+    let(:file_name) do
+      dir_name + "/routes.spec.d.ts"
+    end
+
+    before do
+      FileUtils.mkdir_p(dir_name)
+      File.write(file_name, generated_js)
+    end
+
+    it "has no compile errors", :slow do
+      command = "yarn tsc --strict --noEmit -p spec/tsconfig.json"
+      stdout, stderr, status = Open3.capture3(command)
+      expect(stderr).to eq("")
+      expect(stdout).to include("Done in ")
+      expect(status).to eq(0)
+    end
+  end
+
+  context "when camel case is enabled" do
+    let(:extra_options) { {camel_case: true} }
+
+    it "camelizes route name and arguments" do
+
+      expect(generated_js).to include(<<-DOC.rstrip)
+/**
+ * Generates rails route to
+ * /inboxes/:inbox_id/messages/:message_id/attachments/:id(.:format)
+ * @param {any} inboxId
+ * @param {any} messageId
+ * @param {any} id
+ * @param {object | undefined} options
+ * @returns {string} route path
+ */
+export const inboxMessageAttachmentPath: ((
+  inboxId: RequiredRouteParameter,
+  messageId: RequiredRouteParameter,
+  id: RequiredRouteParameter,
+  options?: {format?: OptionalRouteParameter} & RouteOptions
+) => string) & RouteHelperExtras;
+DOC
+    end
+  end
+
+  it "exports route helpers" do
+    expect(generated_js).to include(<<-DOC.rstrip)
+/**
+ * Generates rails route to
+ * /inboxes(.:format)
+ * @param {object | undefined} options
+ * @returns {string} route path
+ */
+export const inboxes_path: ((
+  options?: {format?: OptionalRouteParameter} & RouteOptions
+) => string) & RouteHelperExtras;
+DOC
+    expect(generated_js).to include(<<-DOC.rstrip)
+/**
+ * Generates rails route to
+ * /inboxes/:inbox_id/messages/:message_id/attachments/:id(.:format)
+ * @param {any} inbox_id
+ * @param {any} message_id
+ * @param {any} id
+ * @param {object | undefined} options
+ * @returns {string} route path
+ */
+export const inbox_message_attachment_path: ((
+  inbox_id: RequiredRouteParameter,
+  message_id: RequiredRouteParameter,
+  id: RequiredRouteParameter,
+  options?: {format?: OptionalRouteParameter} & RouteOptions
+) => string) & RouteHelperExtras
+DOC
+  end
+
+  it "exports utility methods" do
+    expect(generated_js).to include("export const serialize: RouterExposedMethods['serialize'];")
+  end
+
+  it "prevents all types from automatic export" do
+    expect(generated_js).to include("export {};")
+  end
+
+  describe "compiled javascript asset" do
+    subject { ERB.new(File.read("app/assets/javascripts/js-routes.js.erb")).result(binding) }
+    it "should have js routes code" do
+      is_expected.to include("export const inbox_message_path = __jsr.r(")
+    end
+  end
+end

data/spec/js_routes/options_spec.rb

@@ -3,7 +3,11 @@ require 'spec_helper'
 describe JsRoutes, "options" do
 
   let(:generated_js) do
-    JsRoutes.generate({module_type: nil, **_options})
+    JsRoutes.generate({
+      module_type: nil,
+      namespace: 'Routes',
+      **_options
+    })
   end
 
   before(:each) do

data/spec/js_routes/rails_routes_compatibility_spec.rb

@@ -3,7 +3,7 @@ require "spec_helper"
 describe JsRoutes, "compatibility with Rails"  do
 
   before(:each) do
-    evaljs(JsRoutes.generate({module_type: nil}))
+    evaljs(JsRoutes.generate({module_type: nil, namespace: 'Routes'}))
   end
 
   it "should generate collection routing" do

data/spec/js_routes/zzz_last_post_rails_init_spec.rb

@@ -5,7 +5,7 @@
 require 'spec_helper'
 require "fileutils"
 
-describe "after Rails initialization" do
+describe "after Rails initialization", :slow do
   NAME = Rails.root.join('app', 'assets', 'javascripts', 'routes.js').to_s
 
   def sprockets_v3?
@@ -122,7 +122,7 @@ describe "after Rails initialization" do
   end
 end
 
-describe "JSRoutes thread safety" do
+describe "JSRoutes thread safety", :slow do
   before do
     begin
       Rails.application.initialize!

data/spec/spec_helper.rb

@@ -8,7 +8,7 @@ require 'js-routes'
 require 'active_support/core_ext/hash/slice'
 
 unless ENV['TRAVIS_CI']
-  code = system("yarn tsc")
+  code = system("yarn build")
   unless code
     exit(1)
   end

data/spec/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../tsconfig.json",
+  "include": ["./**/*.spec.ts"]
+}

data/tsconfig.json

@@ -3,14 +3,10 @@
     "target": "es2019",
     "lib": ["es2020", "dom"],
     "module": "commonjs",
-    "outDir": "lib",
-    "sourceMap": true,
+    "sourceMap": false,
     "declaration": true,
     "allowSyntheticDefaultImports": true,
-    "resolveJsonModule": true,
-    "typeRoots": ["node_modules/@types", "./@types"],
-
-    "strict": true,
+    "resolveJsonModule": false,
     "strictNullChecks": true,
     "noImplicitAny": true,
     "noImplicitThis": true,
@@ -22,11 +18,11 @@
     "forceConsistentCasingInFileNames": true,
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true
+
   },
   "ts-node": {
     "files": true,
     "transpileOnly": false
   },
-  "include": ["./**/*.ts", "lib/**/*.json", "./**/*.tsx"],
-  "exclude": ["node_modules", "**/thorn", "**/support", "**/tmp"]
+  "include": ["lib/*.ts"]
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js-routes
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.1.0
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -174,7 +174,6 @@ files:
 - lib/js_routes/version.rb
 - lib/routes.d.ts
 - lib/routes.js
-- lib/routes.js.map
 - lib/routes.ts
 - lib/tasks/js_routes.rake
 - package.json
@@ -184,6 +183,9 @@ files:
 - spec/js_routes/default_serializer_spec.rb
 - spec/js_routes/module_types/amd_spec.rb
 - spec/js_routes/module_types/cjs_spec.rb
+- spec/js_routes/module_types/dts/routes.spec.d.ts
+- spec/js_routes/module_types/dts/test.spec.ts
+- spec/js_routes/module_types/dts_spec.rb
 - spec/js_routes/module_types/esm_spec.rb
 - spec/js_routes/module_types/umd_spec.rb
 - spec/js_routes/options_spec.rb
@@ -191,6 +193,7 @@ files:
 - spec/js_routes/zzz_last_post_rails_init_spec.rb
 - spec/spec_helper.rb
 - spec/support/routes.rb
+- spec/tsconfig.json
 - tsconfig.json
 - yarn.lock
 homepage: http://github.com/railsware/js-routes