Update to version 8.5.0 | NEW: MVC Output Result | Read HISTORY.md

Former-commit-id: 6a3579f2500fc715d7dc606478960946dcade61d

_examples/README.md

@@ -19,13 +19,14 @@ It doesn't always contain the "best ways" but it does cover each important featu
 
 ### Structuring
 
-Nothing stops you from using your favorite folder structure. Iris is a low level web framework, it has got MVC support but it doesn't limit your folder structure, this is your choice.
+Nothing stops you from using your favorite folder structure. Iris is a low level web framework, it has got MVC first-class support but it doesn't limit your folder structure, this is your choice.
 
-Structuring is always depends on your needs. We can't tell you how to design your own application for sure but you're free to take a closer look to the examples below; you may find something useful that you can borrow for your app
+Structuring depends on your own needs. We can't tell you how to design your own application for sure but you're free to take a closer look to the examples below; you may find something useful that you can borrow for your app
 
 - [Example 1](mvc/login)
 - [Example 2](structuring/mvc)
 - [Example 3](structuring/handler-based)
+- [Example 4](mvc/using-method-result)
 
 ### HTTP Listening
 
@@ -200,7 +201,7 @@ Follow the examples below,
 - [From func(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)](convert-handlers/negroni-like/main.go)
 - [From http.Handler or http.HandlerFunc](convert-handlers/nethttp/main.go)
 
-### View 
+### View
 
 | Engine | Declaration |
 | -----------|-------------|

_examples/mvc/using-method-result/controllers/hello_controller.go

@@ -0,0 +1,60 @@
+// file: controllers/hello_controller.go
+
+package controllers
+
+import (
+	"errors"
+
+	"github.com/kataras/iris/mvc"
+)
+
+// HelloController is our sample controller
+// it handles GET: /hello and GET: /hello/{name}
+type HelloController struct {
+	mvc.C
+}
+
+var helloView = mvc.View{
+	Name: "hello/index.html",
+	Data: map[string]interface{}{
+		"Title":     "Hello Page",
+		"MyMessage": "Welcome to my awesome website",
+	},
+}
+
+// Get will return a predefined view with bind data.
+//
+// `mvc.Result` is just an interface with a `Dispatch` function.
+// `mvc.Response` and `mvc.View` are the built'n result type dispatchers
+// you can even create custom response dispatchers by
+// implementing the `github.com/kataras/iris/mvc#Result` interface.
+func (c *HelloController) Get() mvc.Result {
+	return helloView
+}
+
+// you can define a standard error in order to be re-usable anywhere in your app.
+var errBadName = errors.New("bad name")
+
+// you can just return it as error or even better
+// wrap this error with an mvc.Response to make it an mvc.Result compatible type.
+var badName = mvc.Response{Err: errBadName, Code: 400}
+
+// GetBy returns a "Hello {name}" response.
+// Demos:
+// curl -i http://localhost:8080/hello/iris
+// curl -i http://localhost:8080/hello/anything
+func (c *HelloController) GetBy(name string) mvc.Result {
+	if name != "iris" {
+		return badName
+		// or
+		// GetBy(name string) (mvc.Result, error) {
+		//	return nil, errBadName
+		// }
+	}
+
+	// return mvc.Response{Text: "Hello " + name} OR:
+	return mvc.View{
+		Name: "hello/name.html",
+		Data: name,
+	}
+}

_examples/mvc/using-method-result/controllers/movies_controller.go

@@ -0,0 +1,75 @@
+// file: controllers/movies_controller.go
+//
+// This is just an example of usage, don't use it for production, it even doesn't check for
+// index exceed!
+
+package controllers
+
+import (
+	"github.com/kataras/iris/_examples/mvc/using-method-result/datasource"
+	"github.com/kataras/iris/_examples/mvc/using-method-result/models"
+
+	"github.com/kataras/iris"
+	"github.com/kataras/iris/mvc"
+)
+
+// MoviesController is our /movies controller.
+type MoviesController struct {
+	// mvc.C is just a lightweight lightweight alternative
+	// to the "mvc.Controller" controller type,
+	// use it when you don't need mvc.Controller's fields
+	// (you don't need those fields when you return values from the method functions).
+	mvc.C
+}
+
+// Get returns list of the movies.
+// Demo:
+// curl -i http://localhost:8080/movies
+func (c *MoviesController) Get() []models.Movie {
+	return datasource.Movies
+}
+
+// GetBy returns a movie.
+// Demo:
+// curl -i http://localhost:8080/movies/1
+func (c *MoviesController) GetBy(id int) models.Movie {
+	return datasource.Movies[id]
+}
+
+// PutBy updates a movie.
+// Demo:
+// curl -i -X PUT -F "genre=Thriller" -F "poster=@/Users/kataras/Downloads/out.gif" http://localhost:8080/movies/1
+func (c *MoviesController) PutBy(id int) (models.Movie, int) {
+	// get the movie
+	m := datasource.Movies[id]
+
+	// get the request data for poster and genre
+	file, info, err := c.Ctx.FormFile("poster")
+	if err != nil {
+		return models.Movie{}, iris.StatusInternalServerError
+	}
+	// we don't need the file so close it now
+	file.Close()
+
+	// imagine that is the url of the uploaded file...
+	poster := info.Filename
+	genre := c.Ctx.FormValue("genre")
+
+	// update the poster
+	m.Poster = poster
+	m.Genre = genre
+	datasource.Movies[id] = m
+
+	return m, iris.StatusOK
+}
+
+// DeleteBy deletes a movie.
+// Demo:
+// curl -i -X DELETE -u admin:password http://localhost:8080/movies/1
+func (c *MoviesController) DeleteBy(id int) iris.Map {
+	// delete the entry from the movies slice
+	deleted := datasource.Movies[id].Name
+	datasource.Movies = append(datasource.Movies[:id], datasource.Movies[id+1:]...)
+	// and return the deleted movie's name
+	return iris.Map{"deleted": deleted}
+}

_examples/mvc/using-method-result/datasource/movies.go

@@ -0,0 +1,39 @@
+// file: datasource/movies.go
+
+package datasource
+
+import "github.com/kataras/iris/_examples/mvc/using-method-result/models"
+
+// Movies is our imaginary data source.
+var Movies = []models.Movie{
+	{
+		Name:   "Casablanca",
+		Year:   1942,
+		Genre:  "Romance",
+		Poster: "https://iris-go.com/images/examples/mvc-movies/1.jpg",
+	},
+	{
+		Name:   "Gone with the Wind",
+		Year:   1939,
+		Genre:  "Romance",
+		Poster: "https://iris-go.com/images/examples/mvc-movies/2.jpg",
+	},
+	{
+		Name:   "Citizen Kane",
+		Year:   1941,
+		Genre:  "Mystery",
+		Poster: "https://iris-go.com/images/examples/mvc-movies/3.jpg",
+	},
+	{
+		Name:   "The Wizard of Oz",
+		Year:   1939,
+		Genre:  "Fantasy",
+		Poster: "https://iris-go.com/images/examples/mvc-movies/4.jpg",
+	},
+	{
+		Name:   "North by Northwest",
+		Year:   1959,
+		Genre:  "Thriller",
+		Poster: "https://iris-go.com/images/examples/mvc-movies/5.jpg",
+	},
+}

_examples/mvc/using-method-result/main.go

@@ -0,0 +1,33 @@
+// file: main.go
+
+package main
+
+import (
+	"github.com/kataras/iris/_examples/mvc/using-method-result/controllers"
+	"github.com/kataras/iris/_examples/mvc/using-method-result/middleware"
+
+	"github.com/kataras/iris"
+)
+
+func main() {
+	app := iris.New()
+	// Load the template files.
+	app.RegisterView(iris.HTML("./views", ".html"))
+
+	// Register our controllers.
+	app.Controller("/hello", new(controllers.HelloController))
+	// Add the basic authentication(admin:password) middleware
+	// for the /movies based requests.
+	app.Controller("/movies", new(controllers.MoviesController), middleware.BasicAuth)
+
+	// Start the web server at localhost:8080
+	// http://localhost:8080/hello
+	// http://localhost:8080/hello/iris
+	// http://localhost:8080/movies/1
+	app.Run(
+		iris.Addr("localhost:8080"),
+		iris.WithoutVersionChecker,
+		iris.WithoutServerError(iris.ErrServerClosed),
+		iris.WithOptimizations, // enables faster json serialization and more
+	)
+}

_examples/mvc/using-method-result/middleware/basicauth.go

@@ -0,0 +1,12 @@
+// file: middleware/basicauth.go
+
+package middleware
+
+import "github.com/kataras/iris/middleware/basicauth"
+
+// BasicAuth middleware sample.
+var BasicAuth = basicauth.New(basicauth.Config{
+	Users: map[string]string{
+		"admin": "password",
+	},
+})

_examples/mvc/using-method-result/models/movie.go

@@ -0,0 +1,11 @@
+// file: models/movie.go
+
+package models
+
+// Movie is our sample data structure.
+type Movie struct {
+	Name   string `json:"name"`
+	Year   int    `json:"year"`
+	Genre  string `json:"genre"`
+	Poster string `json:"poster"`
+}

_examples/mvc/using-method-result/views/hello/index.html

@@ -0,0 +1,12 @@
+<!-- file: views/hello/index.html -->
+<html>
+
+<head>
+    <title>{{.Title}} - My App</title>
+</head>
+
+<body>
+    <p>{{.MyMessage}}</p>
+</body>
+
+</html>

_examples/mvc/using-method-result/views/hello/name.html

@@ -0,0 +1,12 @@
+<!-- file: views/hello/name.html -->
+<html>
+
+<head>
+    <title>{{.}}' Portfolio - My App</title>
+</head>
+
+<body>
+    <h1>Hello {{.}}</h1>
+</body>
+
+</html>

_examples/structuring/handler-based/bootstrap/bootstrapper.go

@@ -6,6 +6,8 @@ import (
 	"github.com/gorilla/securecookie"
 
 	"github.com/kataras/iris"
+	"github.com/kataras/iris/middleware/logger"
+	"github.com/kataras/iris/middleware/recover"
 	"github.com/kataras/iris/sessions"
 	"github.com/kataras/iris/websocket"
 )
@@ -104,6 +106,10 @@ func (b *Bootstrapper) Bootstrap() *Bootstrapper {
 	b.Favicon(StaticAssets + Favicon)
 	b.StaticWeb(StaticAssets[1:len(StaticAssets)-1], StaticAssets)
 
+	// middleware, after static files
+	b.Use(recover.New())
+	b.Use(logger.New())
+
 	return b
 }