README
¶
Description
Fluent Regular Expressions in golang is a port of https://github.com/selvinortiz/flux by Selvin Ortiz
Requirements
- golang
- Created and Tested with Version 1.4.2
Install
Flux is available via go get github.com/alexanderbartels/flux
Example
This simple example illustrates the way you would use flux and it's fluent interface to build complex patterns.
package main
import (
"flux"
)
func main() {
// create the regex
regex := flux.NewFlux().StartOfLine().Find("http").Maybe("s").Then("://").Maybe("www.").AnythingBut(".").Either(".co", ".com", ".de").IgnoreCase().EndOfLine()
// print the created regex
fmt.Println("Regex: ", regex.String())
// or
fmt.Println("Regex: ", regex)
// The subject string (URL)
subject := 'http://www.selvinortiz.com';
// Match
match, _ := regex.Match("http://selvinortiz.com")
if match {
fmt.Println("Matched")
}
// Replace
repl := regex.Replace("http://selvinortiz.com", "$5$6")
if repl == "selvinortiz.com" {
fmt.Println("Replacement ok")
}
}
For other examples, please see the flux_test.go file.
License
Flux is released under the MIT license
TODO
- Add CI Builds
- API Documentation
- SourceCode Documentation
- Branching, Changelog, Versioning / using semver
Documentation
¶
Index ¶
- type Flux
- func (f *Flux) Any(value string) *Flux
- func (f *Flux) Anything() *Flux
- func (f *Flux) AnythingBut(value string) *Flux
- func (f *Flux) Clear() *Flux
- func (f *Flux) Compile() (*regexp.Regexp, error)
- func (f *Flux) Digits() *Flux
- func (f *Flux) Either(values ...string) *Flux
- func (f *Flux) EndOfLine() *Flux
- func (f *Flux) Find(value string) *Flux
- func (f *Flux) IgnoreCase() *Flux
- func (f *Flux) Length(min, max int) *Flux
- func (f *Flux) Letters() *Flux
- func (f *Flux) LineBreak() *Flux
- func (f *Flux) Match(value string) (bool, error)
- func (f *Flux) MatchNewLine() *Flux
- func (f *Flux) Maybe(value string) *Flux
- func (f *Flux) Min(min int) *Flux
- func (f *Flux) Multiline() *Flux
- func (f *Flux) MustCompile() *regexp.Regexp
- func (f *Flux) NamedGroup(name, value string) *Flux
- func (f *Flux) NamedMatches(s string) (map[string]string, error)
- func (f *Flux) Once() *Flux
- func (f *Flux) OneLine() *Flux
- func (f *Flux) OrTry() *Flux
- func (f *Flux) Range(values ...string) *Flux
- func (f *Flux) RawGroup(value string) *Flux
- func (f *Flux) Replace(src, repl string) string
- func (f *Flux) StartOfLine() *Flux
- func (f *Flux) String() string
- func (f *Flux) Tab() *Flux
- func (f *Flux) Then(value string) *Flux
- func (f *Flux) Word() *Flux
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Flux ¶
type Flux struct {
// contains filtered or unexported fields
}
func (*Flux) AnythingBut ¶
Matches anything but the given arguments
func (*Flux) Either ¶
Takes multiple arguments are creates an OR list. Output would be one|two|three etc
func (*Flux) Find ¶
-------------------------------------------------------------------------------- @=LANGUAGE -------------------------------------------------------------------------------- Alias to Flux#then
func (*Flux) MatchNewLine ¶
func (*Flux) MustCompile ¶
To reuse the compiled regexp regexp.MustCompile
func (*Flux) NamedMatches ¶
returns a map with all named matches experimental.... (Currently Only for groups added with #NamedGroup(name, rawGroup))
func (*Flux) Range ¶
Creates a range character class You can create a-z0-9 by calling Flux.range("a", "z", "0", "9")
func (*Flux) StartOfLine ¶
-------------------------------------------------------------------------------- MODIFIERS -------------------------------------------------------------------------------- Helper for the ^ prefix
Source Files