hono 0.0.10 → 0.0.14

package/CODE_OF_CONDUCT.md

@@ -1,128 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-yusuke@kamawada.com.
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series
-of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.0, available at
-https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at
-https://www.contributor-covenant.org/translations.

package/src/compose.js

@@ -1,21 +0,0 @@
-// Based on the code in the MIT licensed `koa-compose` package.
-const compose = (middleware) => {
-  return function (context, next) {
-    let index = -1
-    return dispatch(0)
-    function dispatch(i) {
-      if (i <= index) return Promise.reject(new Error('next() called multiple times'))
-      index = i
-      let fn = middleware[i]
-      if (i === middleware.length) fn = next
-      if (!fn) return Promise.resolve()
-      try {
-        return Promise.resolve(fn(context, dispatch.bind(null, i + 1)))
-      } catch (err) {
-        return Promise.reject(err)
-      }
-    }
-  }
-}
-
-module.exports = compose

package/src/compose.test.js

@@ -1,42 +0,0 @@
-const compose = require('./compose')
-
-describe('compose middleware', () => {
-  const middleware = []
-
-  const a = async (c, next) => {
-    c.req['log'] = 'log'
-    await next()
-  }
-  middleware.push(a)
-
-  const b = async (c, next) => {
-    await next()
-    c.res['header'] = `${c.res.header}-custom-header`
-  }
-  middleware.push(b)
-
-  const handler = async (c, next) => {
-    c.req['log'] = `${c.req.log} message`
-    await next()
-    c.res = { message: 'new response' }
-  }
-  middleware.push(handler)
-
-  const request = {}
-  const response = {}
-
-  it('Request', async () => {
-    const c = { req: request, res: response }
-    const composed = compose(middleware)
-    await composed(c)
-    expect(c.req['log']).not.toBeNull()
-    expect(c.req['log']).toBe('log message')
-  })
-  it('Response', async () => {
-    const c = { req: request, res: response }
-    const composed = compose(middleware)
-    await composed(c)
-    expect(c.res['header']).not.toBeNull()
-    expect(c.res['message']).toBe('new response')
-  })
-})

package/src/hono.d.ts

@@ -1,67 +0,0 @@
-type Result = {
-  handler: any
-  params: {}
-}
-
-declare class Node {
-  method: string
-  handler: any
-  children: Node[]
-  middlewares: any[]
-
-  insert(method: string, path: string, handler: any): Node
-  search(method: string, path: string): Result
-}
-
-declare class Context {
-  req: Request
-  res: Response
-  newResponse(params: {}): Response
-}
-
-type Handler = (c: Context, next: () => void) => Response | void
-
-declare class Router {
-  tempPath: string
-  node: Node
-
-  add(method: string, path: string, handler: Handler): Node
-  match(method: string, path: string): Node
-}
-
-export class Hono {
-  router: Router
-  middlewareRouters: Router[]
-
-  use(path: string, middleware: Handler): void
-
-  route(path: string): Hono
-  fire(): void
-
-  all(path: string, handler: Handler): Hono
-  get(path: string, handler: Handler): Hono
-  post(path: string, handler: Handler): Hono
-  put(path: string, handler: Handler): Hono
-  head(path: string, handler: Handler): Hono
-  delete(path: string, handler: Handler): Hono
-
-  notFound(): Response
-
-  getRouter(): Router
-  addRoute(method: string, args: any[]): Hono
-  matchRoute(method: string, path: string): Promise<Node>
-  createContext(req: Request, res: Response): Promise<Context>
-  dispatch(req: Request, res: Response): Promise<Response>
-  handleEvent(event: FetchEvent): Promise<Response>
-}
-
-export class Middleware {
-  static defaultFilter: Handler
-  // Add builtin middlewares
-  static poweredBy: Handler
-}
-
-interface FetchEvent extends Event {
-  request: Request
-  respondWith(response: Promise<Response> | Response): Promise<Response>
-}

package/src/hono.js

@@ -1,141 +0,0 @@
-'use strict'
-
-const Node = require('./node')
-const Middleware = require('./middleware')
-const compose = require('./compose')
-const methods = require('./methods')
-const { getPathFromURL } = require('./util')
-
-const METHOD_NAME_OF_ALL = 'ALL'
-
-class Router {
-  constructor() {
-    this.node = new Node()
-    this.tempPath = '/'
-  }
-
-  add(method, path, ...handlers) {
-    this.node.insert(method, path, handlers)
-  }
-
-  match(method, path) {
-    return this.node.search(method, path)
-  }
-}
-
-class Hono {
-  constructor() {
-    this.router = new Router()
-    this.middlewareRouters = []
-
-    for (const method of methods) {
-      this[method] = (...args) => {
-        return this.addRoute(method, ...args)
-      }
-    }
-  }
-
-  all(...args) {
-    this.addRoute('ALL', ...args)
-  }
-
-  getRouter() {
-    return this.router
-  }
-
-  addRoute(method, ...args) {
-    method = method.toUpperCase()
-    if (args.length === 1) {
-      this.router.add(method, this.router.tempPath, ...args)
-    } else {
-      this.router.add(method, ...args)
-    }
-    return this
-  }
-
-  route(path) {
-    this.router.tempPath = path
-    return this
-  }
-
-  use(path, middleware) {
-    if (middleware.constructor.name !== 'AsyncFunction') {
-      throw new TypeError('middleware must be a async function!')
-    }
-
-    const router = new Router()
-    router.add(METHOD_NAME_OF_ALL, path, middleware)
-    this.middlewareRouters.push(router)
-  }
-
-  async matchRoute(method, path) {
-    return this.router.match(method, path)
-  }
-
-  // XXX
-  async createContext(req, res) {
-    return {
-      req: req,
-      res: res,
-      newResponse: (params) => {
-        return new Response(params)
-      },
-    }
-  }
-
-  async dispatch(request, response) {
-    const [method, path] = [request.method, getPathFromURL(request.url)]
-
-    const result = await this.matchRoute(method, path)
-
-    request.params = (key) => result.params[key]
-
-    let handler = result ? result.handler[0] : this.notFound // XXX
-
-    const middleware = []
-
-    for (const mr of this.middlewareRouters) {
-      const mwResult = mr.match(METHOD_NAME_OF_ALL, path)
-      if (mwResult) {
-        middleware.push(...mwResult.handler)
-      }
-    }
-
-    let wrappedHandler = async (context, next) => {
-      context.res = await handler(context)
-      await next()
-    }
-
-    middleware.push(Middleware.defaultFilter)
-    middleware.push(wrappedHandler)
-
-    const composed = compose(middleware)
-    const c = await this.createContext(request, response)
-
-    await composed(c)
-
-    return c.res
-  }
-
-  async handleEvent(event) {
-    return this.dispatch(event.request, {}) // XXX
-  }
-
-  fire() {
-    addEventListener('fetch', (event) => {
-      event.respondWith(this.handleEvent(event))
-    })
-  }
-
-  notFound() {
-    return new Response('Not Found', { status: 404 })
-  }
-}
-
-// Default Export
-module.exports = Hono
-exports = module.exports
-
-// Named Export
-exports.Hono = Hono
-exports.Middleware = Middleware

package/src/hono.test.js

@@ -1,158 +0,0 @@
-const fetch = require('node-fetch')
-const { Hono } = require('./hono')
-
-describe('GET Request', () => {
-  const app = new Hono()
-
-  app.get('/hello', () => {
-    return new fetch.Response('hello', {
-      status: 200,
-    })
-  })
-  app.notFound = () => {
-    return new fetch.Response('not found', {
-      status: 404,
-    })
-  }
-  it('GET /hello is ok', async () => {
-    let req = new fetch.Request('https://example.com/hello')
-    let res = await app.dispatch(req, new fetch.Response())
-    expect(res).not.toBeNull()
-    expect(res.status).toBe(200)
-    expect(await res.text()).toBe('hello')
-  })
-  it('GET / is not found', async () => {
-    let req = new fetch.Request('https://example.com/')
-    let res = await app.dispatch(req, new fetch.Response())
-    expect(res).not.toBeNull()
-    expect(res.status).toBe(404)
-  })
-})
-
-describe('params and query', () => {
-  const app = new Hono()
-
-  app.get('/entry/:id', async (c) => {
-    const id = await c.req.params('id')
-    return new fetch.Response(`id is ${id}`, {
-      status: 200,
-    })
-  })
-
-  app.get('/search', async (c) => {
-    const name = await c.req.query('name')
-    return new fetch.Response(`name is ${name}`, {
-      status: 200,
-    })
-  })
-
-  it('params of /entry/:id is found', async () => {
-    let req = new fetch.Request('https://example.com/entry/123')
-    let res = await app.dispatch(req)
-    expect(res.status).toBe(200)
-    expect(await res.text()).toBe('id is 123')
-  })
-  it('query of /search?name=sam is found', async () => {
-    let req = new fetch.Request('https://example.com/search?name=sam')
-    let res = await app.dispatch(req)
-    expect(res.status).toBe(200)
-    expect(await res.text()).toBe('name is sam')
-  })
-})
-
-describe('Middleware', () => {
-  const app = new Hono()
-
-  const logger = async (c, next) => {
-    console.log(`${c.req.method} : ${c.req.url}`)
-    await next()
-  }
-
-  const rootHeader = async (c, next) => {
-    await next()
-    await c.res.headers.append('x-custom', 'root')
-  }
-
-  const customHeader = async (c, next) => {
-    await next()
-    await c.res.headers.append('x-message', 'custom-header')
-  }
-  const customHeader2 = async (c, next) => {
-    await next()
-    c.res.headers.append('x-message-2', 'custom-header-2')
-  }
-
-  app.use('*', logger)
-  app.use('*', rootHeader)
-  app.use('/hello', customHeader)
-  app.use('/hello/*', customHeader2)
-
-  app.get('/hello', () => {
-    return new fetch.Response('hello')
-  })
-  app.get('/hello/:message', (c) => {
-    const message = c.req.params('message')
-    return new fetch.Response(`${message}`)
-  })
-
-  it('logging and custom header', async () => {
-    let req = new fetch.Request('https://example.com/hello')
-    let res = await app.dispatch(req)
-    expect(res.status).toBe(200)
-    expect(await res.text()).toBe('hello')
-    expect(await res.headers.get('x-custom')).toBe('root')
-    expect(await res.headers.get('x-message')).toBe('custom-header')
-    expect(await res.headers.get('x-message-2')).toBe('custom-header-2')
-  })
-
-  it('logging and custom header with named params', async () => {
-    let req = new fetch.Request('https://example.com/hello/message')
-    let res = await app.dispatch(req)
-    expect(res.status).toBe(200)
-    expect(await res.text()).toBe('message')
-    expect(await res.headers.get('x-custom')).toBe('root')
-    expect(await res.headers.get('x-message-2')).toBe('custom-header-2')
-  })
-})
-
-describe('Custom 404', () => {
-  const app = new Hono()
-
-  const customNotFound = async (c, next) => {
-    await next()
-    if (c.res.status === 404) {
-      c.res = new fetch.Response('Custom 404 Not Found', { status: 404 })
-    }
-  }
-
-  app.notFound = () => {
-    return new fetch.Response('Default 404 Nout Found', { status: 404 })
-  }
-
-  app.use('*', customNotFound)
-  app.get('/hello', () => {
-    return new fetch.Response('hello')
-  })
-  it('Custom 404 Not Found', async () => {
-    let req = new fetch.Request('https://example.com/hello')
-    let res = await app.dispatch(req)
-    expect(res.status).toBe(200)
-    req = new fetch.Request('https://example.com/foo')
-    res = await app.dispatch(req)
-    expect(res.status).toBe(404)
-    expect(await res.text()).toBe('Custom 404 Not Found')
-  })
-})
-
-describe('Error Handling', () => {
-  const app = new Hono()
-
-  it('Middleware must be async function', () => {
-    expect(() => {
-      app.use('*', {})
-    }).toThrow(TypeError)
-    expect(() => {
-      app.use('*', () => '')
-    }).toThrow(TypeError)
-  })
-})

package/src/methods.js

@@ -1,30 +0,0 @@
-const methods = [
-  'get',
-  'post',
-  'put',
-  'head',
-  'delete',
-  'options',
-  'trace',
-  'copy',
-  'lock',
-  'mkcol',
-  'move',
-  'patch',
-  'purge',
-  'propfind',
-  'proppatch',
-  'unlock',
-  'report',
-  'mkactivity',
-  'checkout',
-  'merge',
-  'm-search',
-  'notify',
-  'subscribe',
-  'unsubscribe',
-  'search',
-  'connect',
-]
-
-module.exports = methods

package/src/middleware/defaultFilter.js

@@ -1,19 +0,0 @@
-const defaultFilter = async (c, next) => {
-  c.req.query = (key) => {
-    const url = new URL(c.req.url)
-    return url.searchParams.get(key)
-  }
-
-  await next()
-
-  if (typeof c.res === 'string') {
-    c.res = new Response(c.res, {
-      status: 200,
-      headers: {
-        'Conten-Type': 'text/plain',
-      },
-    })
-  }
-}
-
-module.exports = defaultFilter

package/src/middleware/poweredBy.js

@@ -1,6 +0,0 @@
-const poweredBy = async (c, next) => {
-  await next()
-  await c.res.headers.append('X-Powered-By', 'Hono')
-}
-
-module.exports = poweredBy

package/src/middleware/poweredBy.test.js

@@ -1,17 +0,0 @@
-const fetch = require('node-fetch')
-const { Hono, Middleware } = require('../hono')
-
-describe('Powered by Middleware', () => {
-  const app = new Hono()
-
-  app.use('*', Middleware.poweredBy)
-  app.get('/', () => new fetch.Response('root'))
-
-  it('Response headers include X-Powered-By', async () => {
-    let req = new fetch.Request('https://example.com/')
-    let res = await app.dispatch(req, new fetch.Response())
-    expect(res).not.toBeNull()
-    expect(res.status).toBe(200)
-    expect(res.headers.get('X-Powered-By')).toBe('Hono')
-  })
-})

package/src/middleware.js

@@ -1,9 +0,0 @@
-const defaultFilter = require('./middleware/defaultFilter')
-const poweredBy = require('./middleware/poweredBy')
-
-function Middleware() {}
-
-Middleware.defaultFilter = defaultFilter
-Middleware.poweredBy = poweredBy
-
-module.exports = Middleware

package/src/middleware.test.js

@@ -1,17 +0,0 @@
-const fetch = require('node-fetch')
-const { Hono, Middleware } = require('./hono')
-
-describe('Builtin Middleware', () => {
-  const app = new Hono()
-
-  app.use('*', Middleware.poweredBy)
-  app.get('/', () => new fetch.Response('root'))
-
-  it('Builtin Powered By Middleware', async () => {
-    let req = new fetch.Request('https://example.com/')
-    let res = await app.dispatch(req, new fetch.Response())
-    expect(res).not.toBeNull()
-    expect(res.status).toBe(200)
-    expect(res.headers.get('X-Powered-By')).toBe('Hono')
-  })
-})