rbs_ts_generator 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e0bdcb75fbd43e55803cc7c21203215a2cba5a42d840dc925b595767a947138
-  data.tar.gz: 9da00247066e1b51919e4619b3fdc290a5f25a8772ff1c358836a3f0fa71c445
+  metadata.gz: 80e481b7939151a064e8dd75a83ffa7f2bb886259f783d19143d92fab10abd98
+  data.tar.gz: 1718516288d3fe9201da07b2883dd83a957de2db6b494401615365aa2c7c78df
 SHA512:
-  metadata.gz: 0bd4417dadbb8f9b18c6f3dc4d3e85f80cd0f7dad4954db298f49c58048ddd7d5341e37361aead84038132b9068127e74a5241e8dfea9515d1508b0188db00e2
-  data.tar.gz: d6f7285ff572d6ce0e1854a34c01ac62dd9ec763fdc13b7f06579efd050cff0c1a788bda584682910697a146f79249bfd241779d963e336f5fb3449e64b1ef7a
+  metadata.gz: 54c0d8b7c1a489c78a498a4e4350c0b58b11fc47733f5455894ef96846eb4491e270b487c940139f8efb75b8d1667030f1f92299d55fb987920d5fa5079160bd
+  data.tar.gz: 7bed37d5dfe2bfae016bd92fc9747bcee462f93b93ad2629b1bf463be9bb2f2af53398850045165c7fd88c8ab224ae7c540c71a3b7ea007215fc057c0d861f14

data/README.md

@@ -10,14 +10,14 @@ Write type signature of your controller actions in [ruby/rbs](https://github.com
 
 ```rbs
 # sig/app/controllers/boards_controller.rbs
-class BoardsController < ApplicationController
+class BoardsController < ::ApplicationController
   @board: Board
   @boards: Board::ActiveRecord_Relation
 
   def index: () -> Array[{ id: Integer, title: String }]
-  def create: (String title) -> ({ url: String, message: String } | Array[String])
-  def update: (Integer id, String title) -> ({ url: String, message: String } | Array[String])
-  def destroy: (Integer id) -> { url: String, message: String }
+  def create: (String title) -> { id: Integer, message: String } | Array[String]
+  def update: (Integer id, String title) -> { id: Integer, message: String } | Array[String]
+  def destroy: (Integer id) -> { message: String }
 end
 ```
 
@@ -26,14 +26,14 @@ But action does not explicitly return json record.
 To pass the ruby type checking, add `| void` to each signatures.
 
 ```rbs
-class BoardsController < ApplicationController
+class BoardsController < ::ApplicationController
   @board: Board
   @boards: Board::ActiveRecord_Relation
 
   def index: () -> (Array[{ id: Integer, title: String }] | void)
-  def create: (String title) -> ({ url: String, message: String } | Array[String] | void)
-  def update: (Integer id, String title) -> ({ url: String, message: String } | Array[String] | void)
-  def destroy: (Integer id) -> ({ url: String, message: String } | void)
+  def create: (String title) -> ({ id: Integer, message: String } | Array[String] | void)
+  def update: (Integer id, String title) -> ({ id: Integer, message: String } | Array[String] | void)
+  def destroy: (Integer id) -> ({ message: String } | void)
 end
 ```
 
@@ -52,7 +52,7 @@ end
 
 ```console
 $ bundle exec steep check
-[Steep 0.17.1] [target=app] [target#type_check(target_sources: [app/channels/application_cable/channel.rb, app/channels/application_cable/connection.rb, app/controllers/application_controller.rb, app/controllers/boards_controller.rb, app/helpers/application_helper.rb, app/helpers/boards_helper.rb, app/jobs/application_job.rb, app/mailers/application_mailer.rb, app/models/application_record.rb, app/models/board.rb, app/mailboxes/application_mailbox.rb], validate_signatures: true)] [synthesize:(1:1)] [synthesize:(2:3)] [synthesize:(2:3)] [(*::Symbol, ?model_name: ::string, **untyped) -> void] Method call with rest keywords type is detected. Rough approximation to be improved.
+[Steep 0.20.0] [target=app] [target#type_check(target_sources: [app/channels/application_cable/channel.rb, app/channels/application_cable/connection.rb, app/controllers/application_controller.rb, app/controllers/boards_controller.rb, app/helpers/application_helper.rb, app/helpers/boards_helper.rb, app/jobs/application_job.rb, app/mailboxes/application_mailbox.rb, app/mailers/application_mailer.rb, app/models/application_record.rb, app/models/board.rb], validate_signatures: true)] [synthesize:(1:1)] [synthesize:(2:3)] [synthesize:(2:3)] [(*::Symbol, ?model_name: ::string, **untyped) -> void] Method call with rest keywords type is detected. Rough approximation to be improved.
 ```
 
 When you passed the ruby type check, next generate TypeScript from those signatures.
@@ -112,43 +112,6 @@ export const board = {
 
 And generate default runtime in `app/javascript/packs/rbs_ts_runtime.ts`
 
-```typescript
-type HttpMethods = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE'
-type BaseResource = {
-  path: (args: any) => string
-  names: string[]
-  Methods?: any
-  Params?: { [method in HttpMethods]?: any }
-  Return?: { [method in HttpMethods]?: any }
-}
-export async function railsApi<
-  Method extends Exclude<Resource['Methods'], undefined>,
-  Resource extends BaseResource,
-  Params extends Exclude<Resource['Params'], undefined>[Method],
-  Return extends Exclude<Resource['Return'], undefined>[Method]
->(method: Method, { path, names }: Resource, params: Params): Promise<{ status: number, json: Return }> {
-  const tag = document.querySelector<HTMLMetaElement>('meta[name=csrf-token]')
-  const paramsNotInNames = Object.keys(params).reduce<object>((ps, key) => names.indexOf(key) === - 1 ? { ...ps, [key]: params[key] } : ps, {})
-  const searchParams = new URLSearchParams()
-  for (const name of Object.keys(paramsNotInNames)) {
-    searchParams.append(name, paramsNotInNames[name])
-  }
-  const query = method === 'GET' && Object.keys(paramsNotInNames).length ? `?${searchParams.toString()}` : ''
-  const body = method === 'GET' ? undefined : JSON.stringify(paramsNotInNames)
-  const response = await fetch(path(params) + query, {
-    method,
-    body,
-    headers: {
-      'Accept': 'application/json',
-      'Content-Type': 'application/json',
-      'X-CSRF-Token': tag.content
-    }
-  })
-  const json = await response.json() as Return
-  return new Promise((resolve) => resolve({ status: response.status, json: json }))
-}
-```
-
 In your TypeScript code, you can use those routes definition and the default runtime like following
 
 ```typescript
@@ -156,7 +119,7 @@ import { boards } from './rbs_ts_routes'
 import { railsApi } from './rbs_ts_runtime'
 
 const params = { title: 'test' }
-railsApi('POST' as const, boards, params).then(({ json }) => {
+railsApi('POST', boards, params).then(({ json }) => {
   if (json instanceof Array) {
     return Promise.reject(json)
   } else {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rbs_ts_generator
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Seiei Miyagi