renamed grimoire to rel

Author: Fs02

.gitignore

@@ -1,7 +1,8 @@
 vendor
-coverage.out
 .tool-versions
 *.db
 .vscode/
 debug.test
 .idea/
+*.out
+*.test

.travis.yml

@@ -1,8 +1,8 @@
 env:
   global:
     - CC_TEST_REPORTER_ID=42ba59b516289c90de75bec1e73dcf75e601d150b271e8762cee9efcb8d70282
-    - MYSQL_DATABASE=root@(127.0.0.1:3306)/grimoire_test
-    - POSTGRESQL_DATABASE=postgres://postgres@localhost/grimoire_test?sslmode=disable
+    - MYSQL_DATABASE=root@(127.0.0.1:3306)/rel_test
+    - POSTGRESQL_DATABASE=postgres://postgres@localhost/rel_test?sslmode=disable
 
 language: go
 go:
@@ -19,8 +19,8 @@ services:
   - postgresql
 
 before_install:
-  - mysql -e 'CREATE DATABASE grimoire_test;'
-  - psql -c 'create database grimoire_test;' -U postgres
+  - mysql -e 'CREATE DATABASE rel_test;'
+  - psql -c 'create database rel_test;' -U postgres
 
 install:
   - go get -u github.com/golang/dep/cmd/dep

README.md

@@ -1,26 +1,12 @@
-# grimoire
-[![GoDoc](https://godoc.org/github.com/Fs02/grimoire?status.svg)](https://godoc.org/github.com/Fs02/grimoire) [![Build Status](https://travis-ci.org/Fs02/grimoire.svg?branch=master)](https://travis-ci.org/Fs02/grimoire) [![Go Report Card](https://goreportcard.com/badge/github.com/Fs02/grimoire)](https://goreportcard.com/report/github.com/Fs02/grimoire) [![Maintainability](https://api.codeclimate.com/v1/badges/d487e2be0ed7b0b1fed1/maintainability)](https://codeclimate.com/github/Fs02/grimoire/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/d487e2be0ed7b0b1fed1/test_coverage)](https://codeclimate.com/github/Fs02/grimoire/test_coverage)
+# rel
+[![GoDoc](https://godoc.org/github.com/Fs02/rel?status.svg)](https://godoc.org/github.com/Fs02/rel) [![Build Status](https://travis-ci.org/Fs02/rel.svg?branch=master)](https://travis-ci.org/Fs02/rel) [![Go Report Card](https://goreportcard.com/badge/github.com/Fs02/rel)](https://goreportcard.com/report/github.com/Fs02/rel) [![Maintainability](https://api.codeclimate.com/v1/badges/d487e2be0ed7b0b1fed1/maintainability)](https://codeclimate.com/github/Fs02/rel/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/d487e2be0ed7b0b1fed1/test_coverage)](https://codeclimate.com/github/Fs02/rel/test_coverage)
 
-Grimoire is a database access layer inspired by Ecto. It features a flexible query API and built-in validation. It currently supports MySQL, PostgreSQL, and SQLite3 but a custom adapter can be implemented easily using the Adapter interface.
-
-Features:
-
-- Query Builder
-- Association Preloading
-- Struct style create and update
-- Changeset Style create and update
-- Builtin validation using changeset
-- Multi adapter support
-- Logger
-
-## Motivation
-
-Common go ORM accepts struct as a value for modifying records which has a problem of unable to differentiate between an empty, nil, or undefined value. It's a tricky problem especially when you want to have an endpoint that supports partial updates. Grimoire attempts to solve that problem by integrating Changeset system inspired from Elixir's Ecto. Changeset is a form like entity which allows us to not only solve that problem but also help us with casting, validations, and constraints check.
+rel is a repository layer for sql database. 
 
 ## Install
 
 ```bash
-go get github.com/Fs02/grimoire
+go get github.com/Fs02/rel
 ```
 
 ## Quick Start
@@ -31,10 +17,9 @@ package main
 import (
 	"time"
 
-	"github.com/Fs02/grimoire"
-	"github.com/Fs02/grimoire/adapter/mysql"
-	"github.com/Fs02/grimoire/changeset"
-	"github.com/Fs02/grimoire/params"
+	"github.com/Fs02/rel"
+	"github.com/Fs02/rel/adapter/mysql"
+	"github.com/Fs02/rel/where"
 )
 
 type Product struct {
@@ -45,15 +30,6 @@ type Product struct {
 	UpdatedAt time.Time
 }
 
-// ChangeProduct prepares data before database operation.
-// Such as casting value to appropriate types and perform validations.
-func ChangeProduct(product interface{}, params params.Params) *changeset.Changeset {
-	ch := changeset.Cast(product, params, []string{"name", "price"})
-	changeset.ValidateRequired(ch, []string{"name", "price"})
-	changeset.ValidateMin(ch, "price", 100)
-	return ch
-}
-
 func main() {
 	// initialize mysql adapter.
 	adapter, err := mysql.Open("root@(127.0.0.1:3306)/db?charset=utf8&parseTime=True&loc=Local")
@@ -62,60 +38,22 @@ func main() {
 	}
 	defer adapter.Close()
 
-	// initialize grimoire's repo.
-	repo := grimoire.New(adapter)
-
-	var product Product
+	// initialize rel's repo.
+	repo := rel.New(adapter)
 
 	// Inserting Products.
-	// Changeset is used when creating or updating your data.
-	ch := ChangeProduct(product, params.Map{
-		"name":  "shampoo",
-		"price": 1000,
-	})
-
-	if ch.Error() != nil {
-		// handle error
+	product := Product{
+		Name: "shampoo",
+		Price: 1000,
 	}
-
-	// Changeset can also be created directly from json string.
-	jsonch := ChangeProduct(product, params.ParseJSON(`{
-		"name":  "soap",
-		"price": 2000,
-	}`))
-
-	// Create products with changeset and return the result to &product,
-	if err = repo.From("products").Insert(&product, ch); err != nil {
-		// handle error
-	}
-
-	// or panic when insertion pailed
-	repo.From("products").MustInsert(&product, jsonch)
+	repo.Insert(&product)
 
 	// Querying Products.
 	// Find a product with id 1.
-	repo.From("products").Find(1).MustOne(&product)
-
-	// Updating Products.
-	// Update products with id=1.
-	repo.From("products").Find(1).MustUpdate(&product, ch)
-
-	// Deleting Products.
-	// Delete Product with id=1.
-	repo.From("products").Find(1).MustDelete()
+	repo.One(&product, where.Eq("id", 1))
 }
 ```
 
-## Examples
-
-- [Todo API](https://github.com/Fs02/grimoire-todo-example)
-
-## Documentation
-
-Guides: [https://fs02.github.io/grimoire](https://fs02.github.io/grimoire)
-
-API Documentation: [https://godoc.org/github.com/Fs02/grimoire](https://godoc.org/github.com/Fs02/grimoire)
-
 ## License
 
-Released under the [MIT License](https://github.com/Fs02/grimoire/blob/master/LICENSE)
+Released under the [MIT License](https://github.com/Fs02/rel/blob/master/LICENSE)

adapter.go

@@ -1,4 +1,4 @@
-package grimoire
+package rel
 
 // Adapter interface
 type Adapter interface {

adapter/mysql/mysql.go

@@ -1,32 +1,32 @@
-// Package mysql wraps mysql driver as an adapter for grimoire.
+// Package mysql wraps mysql driver as an adapter for rel.
 //
 // Usage:
 //	// open mysql connection.
-//	adapter, err := mysql.Open("root@(127.0.0.1:3306)/grimoire_test?charset=utf8&parseTime=True&loc=Local")
+//	adapter, err := mysql.Open("root@(127.0.0.1:3306)/rel_test?charset=utf8&parseTime=True&loc=Local")
 //	if err != nil {
 //		panic(err)
 //	}
 //	defer adapter.Close()
 //
-//	// initialize grimoire's repo.
-//	repo := grimoire.New(adapter)
+//	// initialize rel's repo.
+//	repo := rel.New(adapter)
 package mysql
 
 import (
 	db "database/sql"
 	"strings"
 
 	"github.com/Fs02/go-paranoid"
-	"github.com/Fs02/grimoire"
-	"github.com/Fs02/grimoire/adapter/sql"
+	"github.com/Fs02/rel"
+	"github.com/Fs02/rel/adapter/sql"
 )
 
 // Adapter definition for mysql database.
 type Adapter struct {
 	*sql.Adapter
 }
 
-var _ grimoire.Adapter = (*Adapter)(nil)
+var _ rel.Adapter = (*Adapter)(nil)
 
 // Open mysql connection using dsn.
 func Open(dsn string) (*Adapter, error) {
@@ -56,7 +56,7 @@ func incrementFunc(adapter sql.Adapter) int {
 	} else {
 		err = adapter.DB.QueryRow("SHOW VARIABLES LIKE 'auto_increment_increment';").Scan(&variable, &increment)
 	}
-	paranoid.Panic(err, "grimoire: MySQL failed to get auto_increment_increment variable")
+	paranoid.Panic(err, "rel: MySQL failed to get auto_increment_increment variable")
 
 	return increment
 }
@@ -78,15 +78,15 @@ func errorFunc(err error) error {
 
 	switch msg[:errCodeIndex] {
 	case "Error 1062":
-		return grimoire.ConstraintError{
+		return rel.ConstraintError{
 			Key:  sql.ExtractString(msg, "key '", "'"),
-			Type: grimoire.UniqueConstraint,
+			Type: rel.UniqueConstraint,
 			Err:  err,
 		}
 	case "Error 1452":
-		return grimoire.ConstraintError{
+		return rel.ConstraintError{
 			Key:  sql.ExtractString(msg, "CONSTRAINT `", "`"),
-			Type: grimoire.ForeignKeyConstraint,
+			Type: rel.ForeignKeyConstraint,
 			Err:  err,
 		}
 	default:

adapter/mysql/mysql_test.go

@@ -5,8 +5,8 @@ import (
 	"testing"
 
 	paranoid "github.com/Fs02/go-paranoid"
-	"github.com/Fs02/grimoire"
-	"github.com/Fs02/grimoire/adapter/specs"
+	"github.com/Fs02/rel"
+	"github.com/Fs02/rel/adapter/specs"
 	_ "github.com/go-sql-driver/mysql"
 	"github.com/stretchr/testify/assert"
 )
@@ -59,15 +59,15 @@ func dsn() string {
 		return os.Getenv("MYSQL_DATABASE") + "?charset=utf8&parseTime=True&loc=Local"
 	}
 
-	return "root@tcp(localhost:3306)/grimoire_test?charset=utf8&parseTime=True&loc=Local"
+	return "root@tcp(localhost:3306)/rel_test?charset=utf8&parseTime=True&loc=Local"
 }
 
 func TestAdapter_specs(t *testing.T) {
 	adapter, err := Open(dsn())
 	paranoid.Panic(err, "failed to open database connection")
 	defer adapter.Close()
 
-	repo := grimoire.New(adapter)
+	repo := rel.New(adapter)
 
 	// Query Specs
 	specs.Query(t, repo)
@@ -129,7 +129,7 @@ func TestAdapter_specs(t *testing.T) {
 // 		{"notexist": "13"},
 // 	}
 
-// 	_, err = adapter.InsertAll(grimoire.Repo{}.From("users"), fields, allchanges)
+// 	_, err = adapter.InsertAll(rel.Repo{}.From("users"), fields, allchanges)
 
 // 	assert.NotNil(t, err)
 // }

adapter/postgres/postgres.go

@@ -1,31 +1,31 @@
-// Package postgres wraps postgres (pq) driver as an adapter for grimoire.
+// Package postgres wraps postgres (pq) driver as an adapter for rel.
 //
 // Usage:
 //	// open postgres connection.
-//	adapter, err := postgres.Open("postgres://postgres@localhost/grimoire_test?sslmode=disable")
+//	adapter, err := postgres.Open("postgres://postgres@localhost/rel_test?sslmode=disable")
 //	if err != nil {
 //		panic(err)
 //	}
 //	defer adapter.Close()
 //
-//	// initialize grimoire's repo.
-//	repo := grimoire.New(adapter)
+//	// initialize rel's repo.
+//	repo := rel.New(adapter)
 package postgres
 
 import (
 	db "database/sql"
 	"time"
 
-	"github.com/Fs02/grimoire"
-	"github.com/Fs02/grimoire/adapter/sql"
+	"github.com/Fs02/rel"
+	"github.com/Fs02/rel/adapter/sql"
 )
 
 // Adapter definition for postgrees database.
 type Adapter struct {
 	*sql.Adapter
 }
 
-var _ grimoire.Adapter = (*Adapter)(nil)
+var _ rel.Adapter = (*Adapter)(nil)
 
 // Open postgrees connection using dsn.
 func Open(dsn string) (*Adapter, error) {
@@ -48,7 +48,7 @@ func Open(dsn string) (*Adapter, error) {
 }
 
 // Insert inserts a record to database and returns its id.
-func (adapter *Adapter) Insert(query grimoire.Query, changes grimoire.Changes, loggers ...grimoire.Logger) (interface{}, error) {
+func (adapter *Adapter) Insert(query rel.Query, changes rel.Changes, loggers ...rel.Logger) (interface{}, error) {
 	var (
 		id              int64
 		statement, args = sql.NewBuilder(adapter.Config).Returning("id").Insert(query.Collection, changes)
@@ -64,7 +64,7 @@ func (adapter *Adapter) Insert(query grimoire.Query, changes grimoire.Changes, l
 }
 
 // InsertAll inserts multiple records to database and returns its ids.
-func (adapter *Adapter) InsertAll(query grimoire.Query, fields []string, allchanges []grimoire.Changes, loggers ...grimoire.Logger) ([]interface{}, error) {
+func (adapter *Adapter) InsertAll(query rel.Query, fields []string, allchanges []rel.Changes, loggers ...rel.Logger) ([]interface{}, error) {
 	var (
 		ids             []interface{}
 		statement, args = sql.NewBuilder(adapter.Config).Returning("id").InsertAll(query.Collection, fields, allchanges)
@@ -83,7 +83,7 @@ func (adapter *Adapter) InsertAll(query grimoire.Query, fields []string, allchan
 	return ids, err
 }
 
-func (adapter *Adapter) query(statement string, args []interface{}, loggers []grimoire.Logger) (*db.Rows, error) {
+func (adapter *Adapter) query(statement string, args []interface{}, loggers []rel.Logger) (*db.Rows, error) {
 	var (
 		err   error
 		rows  *db.Rows
@@ -96,13 +96,13 @@ func (adapter *Adapter) query(statement string, args []interface{}, loggers []gr
 		rows, err = adapter.DB.Query(statement, args...)
 	}
 
-	go grimoire.Log(loggers, statement, time.Since(start), err)
+	go rel.Log(loggers, statement, time.Since(start), err)
 
 	return rows, errorFunc(err)
 }
 
 // Begin begins a new transaction.
-func (adapter *Adapter) Begin() (grimoire.Adapter, error) {
+func (adapter *Adapter) Begin() (rel.Adapter, error) {
 	newAdapter, err := adapter.Adapter.Begin()
 
 	return &Adapter{
@@ -122,21 +122,21 @@ func errorFunc(err error) error {
 
 	switch constraintType {
 	case "unique":
-		return grimoire.ConstraintError{
+		return rel.ConstraintError{
 			Key:  sql.ExtractString(err.Error(), "constraint \"", "\""),
-			Type: grimoire.UniqueConstraint,
+			Type: rel.UniqueConstraint,
 			Err:  err,
 		}
 	case "foreign key":
-		return grimoire.ConstraintError{
+		return rel.ConstraintError{
 			Key:  sql.ExtractString(err.Error(), "constraint \"", "\""),
-			Type: grimoire.ForeignKeyConstraint,
+			Type: rel.ForeignKeyConstraint,
 			Err:  err,
 		}
 	case "check":
-		return grimoire.ConstraintError{
+		return rel.ConstraintError{
 			Key:  sql.ExtractString(err.Error(), "constraint \"", "\""),
-			Type: grimoire.CheckConstraint,
+			Type: rel.CheckConstraint,
 			Err:  err,
 		}
 	default: