fix: add coverage, add license, gofmt -s all files, update readme

Author: x22n

LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2019 Xavier Tremblay St-Germain <https://xaviertremblay.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,18 +1,34 @@
 # Kendo data query for Go
 
-[![Build Status](https://travis-ci.org/XavierTS/kendo-data-query.svg)](https://travis-ci.org/XavierTS/kendo-data-query)
-[![codecov](https://codecov.io/gh/XavierTS/kendo-data-query/branch/master/graph/badge.svg)](https://codecov.io/gh/XavierTS/kendo-data-query)
-[![GoDoc](https://godoc.org/github.com/XavierTS/kendo-data-query?status.svg)](https://godoc.org/github.com/XavierTS/kendo-data-query)
+[![Build Status](https://travis-ci.org/x22n/kendo-data-query.svg)](https://travis-ci.org/x22n/kendo-data-query)
+[![codecov](https://codecov.io/gh/x22n/kendo-data-query/branch/master/graph/badge.svg)](https://codecov.io/gh/x22n/kendo-data-query)
+[![GoDoc](https://godoc.org/github.com/x22n/kendo-data-query?status.svg)](https://godoc.org/github.com/x22n/kendo-data-query)
+[![Go Report Card](https://goreportcard.com/badge/github.com/x22n/kendo-data-query)](https://goreportcard.com/report/github.com/x22n/kendo-data-query)
 
-## Limitations
+Go (Golang) library to parse and apply Kendo data query on a MongoDB database using mgo.
+
+---
+
+- [Kendo data query for Go](#kendo-data-query-for-go)
+  - [Install](#install)
+  - [Examples](#examples)
+    - [Handler example](#handler-example)
+      - [DataResult example](#dataresult-example)
+  - [Limitations](#limitations)
+  - [Roadmap](#roadmap)
+
+---
+
+## Install
 
-* Does not support multiple sorts on base columns BUT supports multiple sorted groups
-* Only supports `and` logic between filters
-* Only supports `avg` and `sum` aggregates
+```sh
+go get -u github.com/x22n/kendo-data-query
+```
+
+## Examples
 
-## Usage
+### Handler example
 
-#### Handler example
 ```go
 func MyHandler(w http.ResponseWriter, r *http.Request) {
     ds, err := kendo.NewDataStateFromRequest(ctx.Request)
@@ -33,11 +49,15 @@ func MyHandler(w http.ResponseWriter, r *http.Request) {
 {"data":[{"title":"cat","due":1.98},{"title":"dog","due":8.21},...],"total":325}
 ```
 
+## Limitations
+
+- Does not support multiple sorts on base columns BUT supports multiple sorted groups
+- Only supports `and` logic between filters
+- Only supports `avg` and `sum` aggregates
+
 ## Roadmap
 
-* Better godoc
-* Better path coverage
-* Support for `or` logic between filters
-* Support for complex/nested filters
-* Better error handling on `Apply(collection)`
-* Support for more aggregates
+- Better godoc
+- Support for `or` logic between filters
+- Support for complex/nested filters
+- Support for more aggregates

apply.go

@@ -8,8 +8,9 @@ import (
 	"github.com/globalsign/mgo/bson"
 )
 
-func (d *DataState) Apply(collection mgo.Collection) (dataResult DataResult) {
-	if err := d.parse(); err != nil {
+// Apply will parse the request values and retrieves the DataResult from a collection
+func (d *DataState) Apply(collection mgo.Collection) (dataResult DataResult, err error) {
+	if err = d.parse(); err != nil {
 		return
 	}
 
@@ -22,12 +23,11 @@ func (d *DataState) Apply(collection mgo.Collection) (dataResult DataResult) {
 
 	data := []interface{}{}
 	err = aggregate.All(&data)
-	fmt.Println(err)
 
 	return DataResult{
 		Data:  data,
 		Total: total,
-	}
+	}, nil
 }
 
 func (d *DataState) getBasePipeline() (pipeline []bson.M) {
@@ -297,7 +297,7 @@ func (d *DataState) getFilter() (filter bson.M) {
 	filter = bson.M{}
 
 	for _, f := range d.Filter.Filters {
-		f.Filter(filter)
+		f.filter(filter)
 	}
 
 	return
@@ -325,7 +325,7 @@ func (d *DataState) getPaging() (paging []bson.M) {
 	page := d.Page - 1
 
 	return []bson.M{
-		bson.M{"$skip": page * d.PageSize},
-		bson.M{"$limit": d.PageSize},
+		{"$skip": page * d.PageSize},
+		{"$limit": d.PageSize},
 	}
 }