js_rails_routes 0.8.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: abaf98e11062f86106203b6b2d68bbf65c83c00e0781122019cc1d0ca20a5fe3
-  data.tar.gz: 38cb07f953ea05bdb1a754a76bfc8e8fd2637c778b69eb35a6d39eb6484b5296
+  metadata.gz: ff931b1b9f29b4a86444a8613d653a32961bc378e86d44fdc25cf319bcd9cc86
+  data.tar.gz: ce054504cf1e89cde6d76bca05f5fb03834740e8ff0a2e9acdea76326ef3e8ce
 SHA512:
-  metadata.gz: 8c2c5bff02e8b53f16ec78fa3e818b693786f454c5cf226a13e3c9d67371e69d1e3d5eae538e5c9c52116abf5394902311afe8f5604ffa56e34fe77ba925d930
-  data.tar.gz: 10ebd6b90a0bf90b566ed76fa1aeef2ee87612c59c44728917fcc63107075d38c640e21cf450bd4b60d0479973aae407a14cd0112099cf33a134fd2677d2c814
+  metadata.gz: 932d0666655cf343988cdd19730ed038b662d6efa86c36a1e97c63a9f98a7c1cbe51a4abdc5a14903814f6a578e597a123e782ebb85a5c3dfa9e0807f7fbca25
+  data.tar.gz: b6c2ad6c62c1c95b6db17386468801a1fc543c60fed064b253a36458c3b14cb3614b9928c495a1f26d53e02946735a452106388ad5f46ebd8af96b494b5578a6

data/CHANGELOG.md

@@ -6,6 +6,10 @@ This change log adheres to [keepachangelog.com](http://keepachangelog.com).
 
 ## [Unreleased]
 
+## [0.9.0] - 2018-08-24
+### Added
+- Improved TypeScript params typing support
+
 ## [0.8.1] - 2018-08-21
 ### Fixed
 - Camelize `params` keys as `camelize` option
@@ -66,7 +70,8 @@ This change log adheres to [keepachangelog.com](http://keepachangelog.com).
 ### Added
 - Implement "js:rails:routes" task
 
-[Unreleased]: https://github.com/yuku-t/js_rails_routes/compare/v0.8.1...HEAD
+[Unreleased]: https://github.com/yuku-t/js_rails_routes/compare/v0.9.0...HEAD
+[0.9.0]: https://github.com/yuku-t/js_rails_routes/compare/v0.8.1...v0.9.0
 [0.8.1]: https://github.com/yuku-t/js_rails_routes/compare/v0.8.0...v0.8.1
 [0.8.0]: https://github.com/yuku-t/js_rails_routes/compare/v0.7.1...v0.8.0
 [0.7.1]: https://github.com/yuku-t/js_rails_routes/compare/v0.7.0...v0.7.1

data/lib/js_rails_routes/language/typescript.rb

@@ -7,8 +7,10 @@ module JSRailsRoutes
   module Language
     class TypeScript < JavaScript
       PROCESS_FUNC = <<~TYPESCRIPT
-        type Params = Record<string, string | number>
-        function process(route: string, params: Params, keys: string[]): string {
+        type Value = string | number
+        type Params<Keys extends string> = { [key in Keys]: Value } & Record<string, Value>
+        function process(route: string, params: Record<string, Value> | undefined, keys: string[]): string {
+          if (!params) return route
           var query = [];
           for (var param in params) if (params.hasOwnProperty(param)) {
             if (keys.indexOf(param) === -1) {
@@ -24,7 +26,8 @@ module JSRailsRoutes
       def handle_route(route)
         path, keys = parse(route.path)
         name = function_name(route.name)
-        "export function #{name}(params: Params) { return process('#{path}', params, [#{keys.join(',')}]); }"
+        params = keys.empty? ? 'params?: Record<string, Value>' : "params: Params<#{keys.join(' | ')}>"
+        "export function #{name}(#{params}) { return process('#{path}', params, [#{keys.join(',')}]); }"
       end
 
       # @note Implementation for {JSRailsRoutes::Language::Base#ext}

data/lib/js_rails_routes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JSRailsRoutes
-  VERSION = '0.8.1'
+  VERSION = '0.9.0'
 end

data/spec/js_rails_routes/language/typescript_spec.rb

@@ -10,8 +10,10 @@ RSpec.describe JSRailsRoutes::Language::TypeScript do
 
     it 'returns a typescript function' do
       is_expected.to eq <<~TYPESCRIPT
-        type Params = Record<string, string | number>
-        function process(route: string, params: Params, keys: string[]): string {
+        type Value = string | number
+        type Params<Keys extends string> = { [key in Keys]: Value } & Record<string, Value>
+        function process(route: string, params: Record<string, Value> | undefined, keys: string[]): string {
+          if (!params) return route
           var query = [];
           for (var param in params) if (params.hasOwnProperty(param)) {
             if (keys.indexOf(param) === -1) {
@@ -40,10 +42,10 @@ RSpec.describe JSRailsRoutes::Language::TypeScript do
       it 'returns a typescript with snake_case functions' do
         is_expected.to eq <<~TYPESCRIPT
           #{described_class::PROCESS_FUNC}
-          export function articles_path(params: Params) { return process('/articles', params, []); }
-          export function new_article_path(params: Params) { return process('/articles/new', params, []); }
-          export function edit_article_path(params: Params) { return process('/articles/' + params.id + '/edit', params, ['id']); }
-          export function article_path(params: Params) { return process('/articles/' + params.id + '', params, ['id']); }
+          export function articles_path(params?: Record<string, Value>) { return process('/articles', params, []); }
+          export function new_article_path(params?: Record<string, Value>) { return process('/articles/new', params, []); }
+          export function edit_article_path(params: Params<'id'>) { return process('/articles/' + params.id + '/edit', params, ['id']); }
+          export function article_path(params: Params<'id'>) { return process('/articles/' + params.id + '', params, ['id']); }
         TYPESCRIPT
       end
     end
@@ -58,10 +60,10 @@ RSpec.describe JSRailsRoutes::Language::TypeScript do
       it 'returns a javascript with lowerCamelCase functions' do
         is_expected.to eq <<~TYPESCRIPT
           #{described_class::PROCESS_FUNC}
-          export function articlesPath(params: Params) { return process('/articles', params, []); }
-          export function newArticlePath(params: Params) { return process('/articles/new', params, []); }
-          export function editArticlePath(params: Params) { return process('/articles/' + params.id + '/edit', params, ['id']); }
-          export function articlePath(params: Params) { return process('/articles/' + params.id + '', params, ['id']); }
+          export function articlesPath(params?: Record<string, Value>) { return process('/articles', params, []); }
+          export function newArticlePath(params?: Record<string, Value>) { return process('/articles/new', params, []); }
+          export function editArticlePath(params: Params<'id'>) { return process('/articles/' + params.id + '/edit', params, ['id']); }
+          export function articlePath(params: Params<'id'>) { return process('/articles/' + params.id + '', params, ['id']); }
         TYPESCRIPT
       end
     end
@@ -76,10 +78,10 @@ RSpec.describe JSRailsRoutes::Language::TypeScript do
       it 'returns a javascript with UpperCamelCase functions' do
         is_expected.to eq <<~TYPESCRIPT
           #{described_class::PROCESS_FUNC}
-          export function ArticlesPath(params: Params) { return process('/articles', params, []); }
-          export function NewArticlePath(params: Params) { return process('/articles/new', params, []); }
-          export function EditArticlePath(params: Params) { return process('/articles/' + params.Id + '/edit', params, ['Id']); }
-          export function ArticlePath(params: Params) { return process('/articles/' + params.Id + '', params, ['Id']); }
+          export function ArticlesPath(params?: Record<string, Value>) { return process('/articles', params, []); }
+          export function NewArticlePath(params?: Record<string, Value>) { return process('/articles/new', params, []); }
+          export function EditArticlePath(params: Params<'Id'>) { return process('/articles/' + params.Id + '/edit', params, ['Id']); }
+          export function ArticlePath(params: Params<'Id'>) { return process('/articles/' + params.Id + '', params, ['Id']); }
         TYPESCRIPT
       end
     end
@@ -94,7 +96,7 @@ RSpec.describe JSRailsRoutes::Language::TypeScript do
       it 'returns a javascript matching to the regexp' do
         is_expected.to eq <<~TYPESCRIPT
           #{described_class::PROCESS_FUNC}
-          export function new_article_path(params: Params) { return process('/articles/new', params, []); }
+          export function new_article_path(params?: Record<string, Value>) { return process('/articles/new', params, []); }
         TYPESCRIPT
       end
     end
@@ -109,9 +111,9 @@ RSpec.describe JSRailsRoutes::Language::TypeScript do
       it 'returns a javascript not matching to the regexp' do
         is_expected.to eq <<~TYPESCRIPT
           #{described_class::PROCESS_FUNC}
-          export function articles_path(params: Params) { return process('/articles', params, []); }
-          export function edit_article_path(params: Params) { return process('/articles/' + params.id + '/edit', params, ['id']); }
-          export function article_path(params: Params) { return process('/articles/' + params.id + '', params, ['id']); }
+          export function articles_path(params?: Record<string, Value>) { return process('/articles', params, []); }
+          export function edit_article_path(params: Params<'id'>) { return process('/articles/' + params.id + '/edit', params, ['id']); }
+          export function article_path(params: Params<'id'>) { return process('/articles/' + params.id + '', params, ['id']); }
         TYPESCRIPT
       end
     end
@@ -126,7 +128,7 @@ RSpec.describe JSRailsRoutes::Language::TypeScript do
       it 'returns a javascript matching to the regexp' do
         is_expected.to eq <<~TYPESCRIPT
           #{described_class::PROCESS_FUNC}
-          export function new_article_path(params: Params) { return process('/articles/new', params, []); }
+          export function new_article_path(params?: Record<string, Value>) { return process('/articles/new', params, []); }
         TYPESCRIPT
       end
     end
@@ -141,9 +143,9 @@ RSpec.describe JSRailsRoutes::Language::TypeScript do
       it 'returns a javascript not matching to the regexp' do
         is_expected.to eq <<~TYPESCRIPT
           #{described_class::PROCESS_FUNC}
-          export function articles_path(params: Params) { return process('/articles', params, []); }
-          export function edit_article_path(params: Params) { return process('/articles/' + params.id + '/edit', params, ['id']); }
-          export function article_path(params: Params) { return process('/articles/' + params.id + '', params, ['id']); }
+          export function articles_path(params?: Record<string, Value>) { return process('/articles', params, []); }
+          export function edit_article_path(params: Params<'id'>) { return process('/articles/' + params.id + '/edit', params, ['id']); }
+          export function article_path(params: Params<'id'>) { return process('/articles/' + params.id + '', params, ['id']); }
         TYPESCRIPT
       end
     end

data/spec/js_rails_routes_spec.rb

@@ -93,31 +93,31 @@ RSpec.describe JSRailsRoutes do
       it 'generates typescript files' do
         subject
 
-        expect(File.read(app_root.join('app/assets/javascripts/rails-routes.ts'))).to eq <<~JAVASCRIPT
+        expect(File.read(app_root.join('app/assets/javascripts/rails-routes.ts'))).to eq <<~TYPESCRIPT
           // Don't edit manually. `rake #{task}` generates this file.
           #{JSRailsRoutes::Language::TypeScript::PROCESS_FUNC}
-          export function blogs_path(params: Params) { return process('/blogs', params, []); }
-          export function new_blog_path(params: Params) { return process('/blogs/new', params, []); }
-          export function edit_blog_path(params: Params) { return process('/blogs/' + params.id + '/edit', params, ['id']); }
-          export function blog_path(params: Params) { return process('/blogs/' + params.id + '', params, ['id']); }
-          export function users_path(params: Params) { return process('/users', params, []); }
-          export function new_user_path(params: Params) { return process('/users/new', params, []); }
-          export function edit_user_path(params: Params) { return process('/users/' + params.id + '/edit', params, ['id']); }
-          export function user_path(params: Params) { return process('/users/' + params.id + '', params, ['id']); }
-        JAVASCRIPT
-
-        expect(File.read(app_root.join('app/assets/javascripts/admin-routes.ts'))).to eq <<~JAVASCRIPT
+          export function blogs_path(params?: Record<string, Value>) { return process('/blogs', params, []); }
+          export function new_blog_path(params?: Record<string, Value>) { return process('/blogs/new', params, []); }
+          export function edit_blog_path(params: Params<'id'>) { return process('/blogs/' + params.id + '/edit', params, ['id']); }
+          export function blog_path(params: Params<'id'>) { return process('/blogs/' + params.id + '', params, ['id']); }
+          export function users_path(params?: Record<string, Value>) { return process('/users', params, []); }
+          export function new_user_path(params?: Record<string, Value>) { return process('/users/new', params, []); }
+          export function edit_user_path(params: Params<'id'>) { return process('/users/' + params.id + '/edit', params, ['id']); }
+          export function user_path(params: Params<'id'>) { return process('/users/' + params.id + '', params, ['id']); }
+        TYPESCRIPT
+
+        expect(File.read(app_root.join('app/assets/javascripts/admin-routes.ts'))).to eq <<~TYPESCRIPT
           // Don't edit manually. `rake #{task}` generates this file.
           #{JSRailsRoutes::Language::TypeScript::PROCESS_FUNC}
-          export function notes_path(params: Params) { return process('/notes', params, []); }
-          export function new_note_path(params: Params) { return process('/notes/new', params, []); }
-          export function edit_note_path(params: Params) { return process('/notes/' + params.id + '/edit', params, ['id']); }
-          export function note_path(params: Params) { return process('/notes/' + params.id + '', params, ['id']); }
-          export function photos_path(params: Params) { return process('/photos', params, []); }
-          export function new_photo_path(params: Params) { return process('/photos/new', params, []); }
-          export function edit_photo_path(params: Params) { return process('/photos/' + params.id + '/edit', params, ['id']); }
-          export function photo_path(params: Params) { return process('/photos/' + params.id + '', params, ['id']); }
-        JAVASCRIPT
+          export function notes_path(params?: Record<string, Value>) { return process('/notes', params, []); }
+          export function new_note_path(params?: Record<string, Value>) { return process('/notes/new', params, []); }
+          export function edit_note_path(params: Params<'id'>) { return process('/notes/' + params.id + '/edit', params, ['id']); }
+          export function note_path(params: Params<'id'>) { return process('/notes/' + params.id + '', params, ['id']); }
+          export function photos_path(params?: Record<string, Value>) { return process('/photos', params, []); }
+          export function new_photo_path(params?: Record<string, Value>) { return process('/photos/new', params, []); }
+          export function edit_photo_path(params: Params<'id'>) { return process('/photos/' + params.id + '/edit', params, ['id']); }
+          export function photo_path(params: Params<'id'>) { return process('/photos/' + params.id + '', params, ['id']); }
+        TYPESCRIPT
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_rails_routes
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Yuku Takahashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails