Merge pull request #4 from bmf-san/1.0.0

1.0.0

.circleci/config.yml

@@ -0,0 +1,43 @@
+references: &golang-image
+    docker:
+      - image: circleci/golang:1.13
+    working_directory: /go/src/github.com/goblin
+version: 2
+jobs:
+  download_go_modules:
+    <<: *golang-image
+    steps:
+      - checkout
+      - restore_cache:
+          name: Restore go modules cache
+          keys:
+            - go-modules-{{ checksum "go.sum" }}
+      - run: go mod download
+      - save_cache:
+          name: Save go modules cache
+          key: go-modules-{{ checksum "go.sum" }}
+          paths:
+            - "/go/pkg/mod"
+  tests:
+    <<: *golang-image
+    steps:
+        - checkout
+        - run:
+            name: Run golint
+            command: >
+                go get -u golang.org/x/lint/golint && golint ./...
+        - run:
+            name: Run vet
+            command: go vet ./...
+        - run:
+            name: Run tests
+            command: go test -v ./...
+
+workflows:
+    version: 2
+    build_and_tests:
+      jobs:
+        - download_go_modules
+        - tests:
+            requires:
+              - download_go_modules

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = false
+
+[*.go]
+indent_style = tab

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at bmf.infomation@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing
+
+1. Fork ([https://github.com/bmf-san/goblin/fork](https://github.com/bmf-san/goblin/fork))
+2. Create a feature branch
+3. Commit your changes
+4. Rebase your local changes against the master branch
+5. Run test suite with the `go test ./...` command and confirm that it passes
+6. Run `gofmt -s`
+7. Create new Pull Request

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,35 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,11 @@
+# Overview
+
+# Changes
+
+# Impact range
+
+# Operational Requirements
+
+# Related Issue
+
+# Supplement

.gitignore

@@ -1,12 +1,5 @@
-# Binaries for programs and plugins
-*.exe
-*.exe~
-*.dll
-*.so
-*.dylib
-
-# Test binary, build with `go test -c`
-*.test
-
-# Output of the go coverage tool, specifically when used with LiteIDE
-*.out
+launch.json
+.DS_STORE
+.vscode/
+goblin
+debug.test

README.md

@@ -1,2 +1,158 @@
-# go-router
-A golang http router based on radix tree.
+# goblin
+[![CircleCI](https://circleci.com/gh/bmf-san/goblin/tree/master.svg?style=svg)](https://circleci.com/gh/bmf-san/goblin/tree/master)
+[![GitHub license](https://img.shields.io/github/license/bmf-san/goblin)](https://github.com/bmf-san/goblin/blob/master/LICENSE)
+
+A golang http router based on trie tree.
+
+# Features
+- Go 1.13
+- Easy to use
+- Lightweight
+- Fully compatible with net/http
+- No external dependencies
+- Support named parameters with an optional regular expression.
+
+# Install
+```sh
+go get -u github.com/bmf-san/goblin
+```
+
+# Usage
+## Basic
+goblin supports these http methods.
+
+`GET/POST/PUT/PATCH/DELETE`
+
+You can define routing like this.
+
+```go
+    r := goblin.NewRouter()
+
+	r.GET(`/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprintf(w, "/")
+    }))
+
+	r.POST(`/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprintf(w, "/")
+    }))
+```
+
+## Named parameters
+You can use named parameters like this.
+
+```go
+    r := goblin.NewRouter()
+
+	r.GET(`/foo/:id/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		id := goblin.GetParam(r.Context(), "id")
+		fmt.Fprintf(w, "/foo/%v/", id)
+    }))
+
+	r.POST(`/foo/:name/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		name := goblin.GetParam(r.Context(), "name")
+		fmt.Fprintf(w, "/foo/%v/", name)
+    }))
+```
+
+## Named parameters with regular expression
+You can also use named parameter with regular expression like this.
+
+`[name:pattern]`
+
+```go
+	r.GET(`/foo/:id[^\d+$]/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		id := goblin.GetParam(r.Context(), "id")
+		fmt.Fprintf(w, "/foo/%v/", id)
+	}))
+```
+
+A default pattern is wildcard.
+
+`(.+)`
+
+## Note
+A routing pattern matching priority depends on an order of routing definition.
+
+```go
+    r := goblin.NewRouter()
+
+	r.GET(`/foo/:id/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprintf(w, `/foo/:id/`)
+    }))
+	r.GET(`/foo/:id[^\d+$]/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprintf(w, `/foo/:id[^\d+$]/`)
+    }))
+	r.GET(`/foo/:id[^\w+$]`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprintf(w, `/foo/:id[^\w+$]/`)
+    }))
+```
+
+# Examples
+```go
+package main
+
+import (
+	"fmt"
+	"net/http"
+
+	goblin "github.com/bmf-san/goblin"
+)
+
+func main() {
+	r := goblin.NewRouter()
+
+	r.GET(`/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprintf(w, "/")
+	}))
+	r.GET(`/foo/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprintf(w, "/foo/")
+	}))
+	r.GET(`/foo/bar/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		fmt.Fprintf(w, "/foo/bar/")
+	}))
+	r.GET(`/foo/bar/:id/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		id := goblin.GetParam(r.Context(), "id")
+		fmt.Fprintf(w, "/foo/bar/%v/", id)
+	}))
+	r.GET(`/foo/bar/:id/:name/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		id := goblin.GetParam(r.Context(), "id")
+		name := goblin.GetParam(r.Context(), "name")
+		fmt.Fprintf(w, "/foo/bar/%v/%v/", id, name)
+	}))
+	r.GET(`/foo/:id[^\d+$]/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		id := goblin.GetParam(r.Context(), "id")
+		fmt.Fprintf(w, "/foo/%v/", id)
+	}))
+	r.GET(`/foo/:id[^\d+$]/:name/`, http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		id := goblin.GetParam(r.Context(), "id")
+		name := goblin.GetParam(r.Context(), "name")
+		fmt.Fprintf(w, "/foo/%v/%v/", id, name)
+	}))
+
+	http.ListenAndServe(":8000", r)
+}
+```
+
+If you want to try it, you can use an [_examples](https://github.com/bmf-san/goblin/blob/master/_examples).
+
+# Router design
+A role of an url router.
+
+![A role of an url router](https://user-images.githubusercontent.com/13291041/70861219-30929d80-1f6e-11ea-8e86-114e8ba0942b.png "A role of an url router")
+
+goblin based on trie tree structure.
+
+![Based on trie tree](https://user-images.githubusercontent.com/13291041/70862745-7148e180-1f83-11ea-85d3-2cd8fb4db0d3.png "Based on trie tree")
+
+# Contribution
+Please take a look at our [CONTRIBUTING.md](https://github.com/bmf-san/goblin/blob/master/CONTRIBUTING.md) file.
+
+# License
+This project is licensed under the terms of the MIT license.
+
+## Author
+
+bmf - A Web Developer in Japan.
+
+-   [@bmf-san](https://twitter.com/bmf_san)
+-   [bmf-tech](http://bmf-tech.com/)