Dev v0.1

.coveralls.yml

@@ -0,0 +1,2 @@
+repo_token: 4FZysTXA8OlRMafXynFGoFOjM5F9qQHDx
+

.gitattributes

@@ -1,5 +1,5 @@
-stylesheets/* linguist-vendored linguist-documentation=false
-*.json linguist-vendored linguist-documentation=false
-*.html linguist-vendored linguist-documentation=false
-*.css linguist-vendored linguist-documentation=false
-*.go linguist-language=Go
+stylesheets/* linguist-vendored linguist-documentation=false
+*.json linguist-vendored linguist-documentation=false
+*.html linguist-vendored linguist-documentation=false
+*.css linguist-vendored linguist-documentation=false
+*.go linguist-language=Go

.gitignore

@@ -0,0 +1,152 @@
+###################################################################################################
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio
+
+*.iml
+
+## Directory-based project format:
+.idea/
+# if you remove the above rule, at least ignore the following:
+
+# User-specific stuff:
+# .idea/workspace.xml
+# .idea/tasks.xml
+# .idea/dictionaries
+
+# Sensitive or high-churn files:
+# .idea/dataSources.ids
+# .idea/dataSources.xml
+# .idea/sqlDataSources.xml
+# .idea/dynamic.xml
+# .idea/uiDesigner.xml
+
+# Gradle:
+# .idea/gradle.xml
+# .idea/libraries
+
+# Mongo Explorer plugin:
+# .idea/mongoSettings.xml
+
+## File-based project format:
+*.ipr
+*.iws
+
+## Plugin-specific files:
+
+# IntelliJ
+/out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+
+
+###################################################################################################
+# MacOS
+
+**/.DS_Store
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+###################################################################################################
+# Linux
+
+*~
+
+# KDE directory preferences
+.directory
+
+# Linux trash folder which might appear on any partition or disk
+.Trash-*
+
+
+###################################################################################################
+# Vi
+
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+*.un~
+Session.vim
+.netrwhist
+*~
+
+
+###################################################################################################
+# Go
+
+# Compiled Object files, Static and Dynamic libs (Shared Objects)
+*.o
+*.a
+*.so
+*.dll
+*.dylib
+
+# Folders
+_obj
+_test
+bin/
+pkg/
+
+# Architecture specific extensions/prefixes
+*.[568vq]
+[568vq].out
+
+*.cgo1.go
+*.cgo2.c
+_cgo_defun.c
+_cgo_gotypes.go
+_cgo_export.*
+
+_testmain.go
+
+*.out
+*.exe
+*.test
+*.prof
+
+
+###################################################################################################
+# Javascript
+
+static/bower_components/
+static/*.log
+
+
+###################################################################################################
+# ~~ Others ~~
+
+\.tmp/
+data/*.db
+config/drivers.yaml
+HOWTO.txt
+dist/

.travis.yml

@@ -0,0 +1,14 @@
+language: go
+sudo: false
+os:
+  - linux
+  - osx
+go:
+  - "go1.7"
+  - "go1.8"
+  - "go1.9"
+  - "go1.10"
+before_install:
+  - go get github.com/mattn/goveralls
+script:
+  - "$GOPATH/bin/goveralls -service=travis-ci"

README.md

@@ -1,2 +1,211 @@
-# goerrors
-_This project is still under development_ 
+# GoErrors - Easy error informations and stack traces for Go with rich informations and a Try/Catch/Finally mechanism.
+[![Build Status](https://img.shields.io/travis/corebreaker/goerrors/master.svg?style=plastic)](https://travis-ci.org/corebreaker/goerrors)
+[![Coverage Status](https://img.shields.io/coveralls/github/corebreaker/goerrors/master.svg?style=plastic)](https://coveralls.io/github/corebreaker/goerrors)
+[![GoDoc](https://img.shields.io/badge/godoc-reference-5272B4.svg?style=plastic)](https://godoc.org/github.com/corebreaker/goerrors)
+[![Release](https://img.shields.io/github/release/corebreaker/goerrors.svg?style=plastic)](https://github.com/corebreaker/goerrors/releases)
+
+It's a package that's allow you to make Go errors more comprehensive, more featured and easier to use.
+
+
+## Features
+- Verbose with stack trace
+- Ready for Try/Catch/Finally paradigm
+- Extensible with your own error
+- Error hierarchy
+- Entirely customizable
+
+
+## Installation
+go get github.com/corebreaker/goerrors
+
+
+## How is it work ?
+A normal error is just an interface. But here we added an extended interface IError which can transport other infomations.
+Therefore to add informations, the standard error (`error` interface) is «decorated» with informations and so
+we obtain a new error value. These informations are:
+- stack trace informations (files + lines)
+- additionnal customized string
+- optionnal error code
+
+When the `Error` method is called, all these informations will be formated in a string.
+
+This type of error gives you rich informations on an error without using `panic` function (even if with a panic, you
+could show your additionnal infomations).
+
+
+## How to use it ?
+### Decorate error to add a stack trace
+```go
+// for example, let's open a file
+func OpenMyFile() (*os.File, error) {
+    file, err := os.Open("MyFile.txt")
+    if err != nil {
+        // Here, we decorate the error
+        return nil, goerrors.DecorateError(err)
+    }
+
+    return file, nil
+}
+```
+
+Then, we can `panic` this decorated error or simply print it, like this:
+```go
+func main() {
+    // First we must enable the debug mode to activate the stacktrace
+    goerrors.SetDebug(true)
+
+    // Use a function that use the `goerrors` package
+    file, err := OpenMyFile()
+
+    // Check the error
+    if err != nil {
+        // Show the error
+        fmt.Println(err)
+
+        // Terminate
+        return
+    }
+
+    // …
+}
+```
+
+You will see some thing like this:
+```
+github.com/corebreaker/goerrors.tStandardError: open MyFile.txt: no such file or directory
+    github.com/corebreaker/goerrors.(*GoError).Init (/home/frederic/go/src/github.com/corebreaker/goerrors/errors.go:219)
+    github.com/corebreaker/goerrors.DecorateError (/home/frederic/go/src/github.com/corebreaker/goerrors/standard.go:51)
+    main.OpenMyFile (/home/frederic/.local/share/data/liteide/liteide/goplay.go:13)
+    main.main (/home/frederic/.local/share/data/liteide/liteide/goplay.go:24)
+------------------------------------------------------------------------------
+```
+
+### A Try/Catch/Finally mechanism
+Plus, this library uses the `panic()` function, the `recover()` function and the `defer` instruction,
+as a Throw and a Try/Catch/Finally mechanisms and can be used like this:
+```go
+goerrors.Try(func(err goerrors.IError) error {
+    // Try block
+}, func(err goerrors.IError) error {
+    // Catch block
+}, func(err goerrors.IError) error {
+    // Finally block
+})
+```
+
+
+## A simple example
+```go
+package main
+
+import (
+    "fmt"
+    gerr "github.com/corebreaker/goerrors"
+)
+
+// A function which return checked quotient
+func my_func(i, j int) (int, error) {
+    if j == 0 {
+        return 0, gerr.MakeError("Division by zero")
+    }
+
+    return i / j, nil
+}
+
+// Main function
+func main() {
+    // Activate stack trace
+    gerr.SetDebug(true)
+
+    i, j := 1, 0
+
+    // Call checked function
+    q, err := my_func(i, j)
+    if err != nil {
+        fmt.Println(err)
+
+        return
+    }
+
+    // Here, in this example, this code won't never be executed
+    fmt.Print(i, "/", j, "=", q)
+}
+```
+
+This will show:
+```
+Division by zero
+    main.my_func (/projects/go/prototype/main.go:11)
+    main.main (/projects/go/prototype/main.go:23)
+------------------------------------------------------------------------------
+```
+
+
+## Another example with existing error
+```go
+package main
+
+import (
+    "fmt"
+    "os"
+    gerr "github.com/corebreaker/goerrors"
+)
+
+// A function which open a file
+func open_file(name string) (*os.File, error) {
+    f, err := os.Open(name)
+
+    // Decorate the opening error
+    if err != nil {
+        return nil, gerr.DecorateError(err)
+    }
+
+    return f, nil
+}
+
+// A function which read one byte in the opened file
+func read_file(f *os.File) (byte, error) {
+    var b [1]byte
+
+    n, err := f.Read(b[:])
+
+    // Decorate the read error
+    if err != nil {
+        return 0, gerr.DecorateError(err)
+    }
+
+    // Return custom error
+    if n == 0 {
+        return 0, gerr.MakeError("No data to read")
+    }
+
+    return b[0], nil
+}
+
+// Main function
+func main() {
+    // Activate stack trace
+    gerr.SetDebug(true)
+
+    // Call the checked open function
+    f, err := open_file("a_file.txt")
+    if err != nil {
+        fmt.Println(err)
+
+        return
+    }
+
+    // Here, in this example, this code won't never be executed if the file can't be opened
+    defer f.Close()
+
+    _, err = read_file(f)
+}
+```
+
+This will show:
+```
+open a_file.txt: no such file or directory
+    main.open_file (/projects/go/src/github.com/corebreaker/goerrors.go:15)
+    main.main (/projects/go/src/github.com/corebreaker/goerrors.go:46)
+------------------------------------------------------------------------------
+```