GitXplorerGitXplorer
a

ugo

public
27 stars
4 forks
0 issues

Commits

List of commits on branch master.
Unverified
33de225aac2b2040c531d7cba8f588ac31ddd82e

Removed broken badge

aalxrm committed 9 years ago
Unverified
99b4bb5752e74aa432d657c37e568dfbbc2428e8

Typo fix

aalxrm committed 9 years ago
Unverified
c76a0b641a5bbbc2a11b0ed1a1c4312aed3ca525

Added comments for chaining wrapper methods

aalxrm committed 9 years ago
Unverified
8247d6720795008ca2fba1e4ba1682f4d6804388

Update README.md

aalxrm committed 9 years ago
Unverified
12ec561620df67fe18895a7c6def9ece9a798b8f

Update README.md

aalxrm committed 9 years ago
Unverified
abc0ed12f53e25a46aa35444ee94c1387bd1804a

Update README.md

aalxrm committed 9 years ago

README

The README file for this repository.

GoDoc Go Report Card Travis CI

ugo

Simple and expressive toolbox written with love and care in Go.

Deeply inspired by underscore.js and has the same syntax and behaviour

Fully covered with tests, no surprises

Quick start

Installation

go get -u  github.com/alxrm/ugo

Import

import (
	u "github.com/alxrm/ugo"
)

Usage

It works with some special type, named Seq, which is an alias for []interface{}

So let's make some

	
// creates the new string Seq
strSeq := u.Seq{ "nineteen", "eigth", "four" } // ["nineteen" "eigth" "four"]
	
// creates the new Seq with given length
emptySeq := u.NewSeq(0); // []
	
// copies reflectively all of the values from int slice to Seq
intSlc := []int{ 4, 6, 2, 7, 8, 10, 9, 9, 120, 10, 2, 17 }
intSeq := u.From(intSlc, len(intSlc)) // [4 6 2 7 8 10 9 9 120 10 2 17]

Actually reflection approach in u.From can have an impact on performance 🐌 so use it with care.

Okay, now we have some Seq's,

What if I want to leave only unique elements in my int slice?

Go and get it ⚡

initialSeq := u.Seq{ 4, 6, 2, 7, 8, 10, 9, 9, 120, 10, 2, 17 }
uniquedSeq := u.Uniq(initial, func(l, r u.Object) int { return l.(int) - r.(int) })

fmt.Println(uniquedSeq) // [4 6 2 7 8 10 9 120 17]

And I want to leave only odd ones

Nice choice! 🔥

oddsSeq := u.Filter(uniquedSeq, func(cur, _, _ u.Object) bool { return cur.(int) % 2 != 0 })

fmt.Println(oddsSeq) // [7 9 17]

Well, sometimes you may want to use many method one by one, and it can be a bit ugly

Here we are, fluent syntax, just like in underscore.js 🚀

initialSeq := u.Seq{ 4, 6, 2, 7, 8, 10, 9, 9, 120, 10, 2, 17 }

res := u.Chain(initialSeq).Uniq(func(l, r u.Object) int {
	return l.(int) - r.(int)
}).Filter(func(cur, _, _ u.Object) bool {
	return cur.(int) % 2 != 0
}).Value()

fmt.Println(res) // [7 9 17]

Try it by yourself!

Explore all of the features and get your slice routine done faster

Contribute

We highly appreciate any of your pull requests and issues!

Be welcome ☕

Some of the TODOs:

  • [x] Aliases from underscore
  • [x] Chaining like map(...).uniq(...).result()
  • [ ] Better documentation

License

The MIT License (MIT)

Copyright (c) 2016 Alexey Derbyshev

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.