Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Yonaba/Allen
An utility library to manipulate strings in Lua
https://github.com/Yonaba/Allen
Last synced: about 1 month ago
JSON representation
An utility library to manipulate strings in Lua
- Host: GitHub
- URL: https://github.com/Yonaba/Allen
- Owner: Yonaba
- License: mit
- Created: 2012-07-24T09:12:35.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2013-09-20T15:51:03.000Z (almost 11 years ago)
- Last Synced: 2024-06-25T22:40:03.371Z (3 months ago)
- Language: Lua
- Homepage: http://yonaba.github.com/Allen
- Size: 647 KB
- Stars: 47
- Watchers: 6
- Forks: 12
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE.txt
Awesome Lists containing this project
README
__Allen__ is a Lua library which provides a set of utilities and helpers for strings operations.
In a nutshell, __Allen__ is to strings what [Moses][] is to tables.
__Allen__ can be considered as an extension of the built-in Lua string library.
__Allen__'s API was heavily inspired by the Javascript library [Underscore.string][].
##Installation##
Put the file [Allen.lua][] inside your project folder and call it using *require* command.
It will return a table containing a set of functions.
##Usage example##
```lua
local lyrics = 'hey I just met you\nand this is crazy\nbut here is my number\nso call me maybe'
lyrics = _.lines(lyrics)
for i,line in ipairs(lyrics) do
line = _.capitalizeFirst(line)
end
-- => { 'Hey I just met you',
-- 'And this is crazy',
-- 'But here is my number',
-- 'So call me maybe'}
```
##Allen and the built-in string library##
__Allen__ provides a very handy function named *_.import*, which links Lua's native string library with __Allen__'s functions.
```lua
_.import()
print(string.capitalize('hello'))
print(('Hello'):splice(2,2,'r'))
```
##About Lua Operators##
Once __Allen__ is called inside your projet,it enables the use of arithmetic operators on strings by default.
Compatible operators are : __+,*,/,%,^,-.__
* Addition operator (+) : concatenates two strings
* Unary operator (-) : reverses a string
* Multiplication operator (*) : repeats a string
* Power operator (^) : also repeats a string
* Division operator (/) : used for chopping strings (dividing it in subsets strings)
* Modulo operator (%) : returns the remainder subset string after a chopping process.
##Strings Indexing##
Using __Allen__, strings can be indexed, like regular Lua tables.
```lua
for i = 1,5 do
print(('Accessing %s[%d] :'):format('Hello',i),('Hello')[i])
end
-- => Accessing Hello[1] : H
-- => Accessing Hello[2] : e
-- => Accessing Hello[3] : l
-- => Accessing Hello[4] : l
-- => Accessing Hello[5] : o
```
##Strings as functions##
Once __Allen__ is loaded inside a project, strings can be called as functions.
```lua
local s = 'Hello'
print(s()) --> 'Hello'
```
Passing a positive number i as the first argument will return the character at the corresponding index
```lua
local s = 'Hello'
print(s(2)) --> 'e'
```
Passing a number j as a second argument will return the substring between i and j
```lua
local s = 'Hello'
print(s(2,4)) --> 'ell'
```
Passing a character as a second argument will replace the character at index i
```lua
local s = 'Helo'
print(s(3,'r')) --> 'Hero'
```
See [Allen_StringOp_Snippets.lua][] for more details.
##API Overview##
__Allen__ offers a lot of functions, iterators to operate on strings.
A fully complete documentation, with usage examples can be found here : [Documentation][]
Some usage examples can be found here : [Allen_Lib_Snippets.lua][] and [Allen_StringOp_Snippets.lua][]
##Credits and Thanks##
[Esa-Matti Suuronen][] and [Edward Tsech][], for the amazing [Underscore.string][]
##License##
This work is under [MIT-LICENSE][]
Copyright (c) 2012 Roland Yonaba
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.
[Underscore.string]: https://github.com/epeli/underscore.string
[Moses]: https://github.com/Yonaba/Moses
[Allen.lua]: https://github.com/Yonaba/Allen/blob/master/Lib/Allen.lua
[Documentation]: https://github.com/Yonaba/Allen/blob/master/Documentation
[Allen_Lib_Snippets.lua]: https://github.com/Yonaba/Allen/blob/master/Allen_Lib_Snippets.lua
[Allen_StringOp_Snippets.lua]: https://github.com/Yonaba/Allen/blob/master/Allen_StringOp_Snippets.lua
[Esa-Matti Suuronen]: https://github.com/epeli
[Edward Tsech]: https://github.com/edtsech
[MIT-LICENSE]: http://www.opensource.org/licenses/mit-license.php
[](https://bitdeli.com/free "Bitdeli Badge")