Skip to content

Commit

Permalink
implement 🐈
Browse files Browse the repository at this point in the history
  • Loading branch information
tunnckoCore committed Oct 9, 2015
1 parent 647c998 commit 944be08
Show file tree
Hide file tree
Showing 28 changed files with 1,476 additions and 5 deletions.
26 changes: 26 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# .editorconfig <https://github.com/tunnckoCore/dotfiles>
#
# Copyright (c) 2015 Charlike Mike Reagent, contributors.
# Released under the MIT license.
#

root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space

[*.js]
insert_final_newline = true
trim_trailing_whitespace = true

[*.php]
indent_size = 4
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
insert_final_newline = false
trim_trailing_whitespace = false
57 changes: 57 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# .gitignore <https://github.com/tunnckoCore/dotfiles>
#
# Copyright (c) 2015 Charlike Mike Reagent, contributors.
# Released under the MIT license.
#

# Always-ignore dirs #
# ####################
_gh_pages
node_modules
bower_components
components
vendor
build
dest
dist
src
lib-cov
coverage
nbproject
cache
temp
tmp
letta

# Packages #
# ##########
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.zip

# OS, Logs and databases #
# #########################
*.pid
*.dat
*.log
*.sql
*.sqlite
*~
~*

# Another files #
# ###############
Icon?
.DS_Store*
Thumbs.db
ehthumbs.db
Desktop.ini
npm-debug.log
.directory
._*
lcov.info
29 changes: 29 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
language: "node_js"
sudo: false

node_js:
- "0.10"
- "0.12"
- "4"

notifications:
email:
on_success: never
on_failure: never

before_script:
- npm install standard
- standard

script:
- npm install istanbul-harmony
- node --harmony node_modules/.bin/istanbul cover test.js

after_success:
- npm install coveralls
- cat coverage/lcov.info | coveralls
- mv coverage/lcov.info .

matrix:
allow_failures:
- node_js: "0.10"
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@


## 0.0.0 - 2015-10-09
- Initial commit
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing Guidelines

Contributions are always welcome!

**Before spending lots of time on something, ask for feedback on your idea first!**

Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations.


## Installing

Fork and clone the repo, then `npm install` to install all dependencies and `npm test` to ensure all is okey before you start anything.


## Testing

Tests are run with `npm test`. Please ensure all tests are passing before submitting a pull request (unless you're creating a failing test to increase test coverage or show a problem).

## Code Style

[![standard][standard-image]][standard-url]

This repository uses [`standard`][standard-url] to maintain code style and consistency, and to avoid style arguments. You are encouraged to install it globally. `npm test` runs `standard` so you don't have to!

```
npm i standard -g
```

It is intentional to don't have `standard`, `istanbul` and `coveralls` in the devDependencies. Travis will handle all that stuffs. That approach will save bandwidth also installing and development time.

[standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg
[standard-url]: https://github.com/feross/standard
5 changes: 2 additions & 3 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2015
Copyright (c) 2015 Charlike Mike Reagent

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -18,5 +18,4 @@ 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.

SOFTWARE.
76 changes: 74 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,74 @@
# letta
Let's move to promises! Drop-in replacement for `co@4`, but on steroids. Accepts sync, async and generator functions.
# [letta][author-www-url] [![npmjs.com][npmjs-img]][npmjs-url] [![The MIT License][license-img]][license-url]

> Let's move to promises! Drop-in replacement for `co@4`, but on steroids. Accepts sync, async and generator functions.
[![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url]


## Install
```
npm i letta --save
```


## Usage
> For more use-cases see the [tests](./test.js)
```js
var letta = require('letta')
```


## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/hybridables/letta/issues/new).
But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines.


## [Charlike Make Reagent](http://j.mp/1stW47C) [![new message to charlike][new-message-img]][new-message-url] [![freenode #charlike][freenode-img]][freenode-url]

[![tunnckocore.tk][author-www-img]][author-www-url] [![keybase tunnckocore][keybase-img]][keybase-url] [![tunnckoCore npm][author-npm-img]][author-npm-url] [![tunnckoCore twitter][author-twitter-img]][author-twitter-url] [![tunnckoCore github][author-github-img]][author-github-url]


[npmjs-url]: https://www.npmjs.com/package/letta
[npmjs-img]: https://img.shields.io/npm/v/letta.svg?label=letta

[license-url]: https://github.com/hybridables/letta/blob/master/LICENSE.md
[license-img]: https://img.shields.io/badge/license-MIT-blue.svg


[codeclimate-url]: https://codeclimate.com/github/hybridables/letta
[codeclimate-img]: https://img.shields.io/codeclimate/github/hybridables/letta.svg

[travis-url]: https://travis-ci.org/hybridables/letta
[travis-img]: https://img.shields.io/travis/hybridables/letta.svg

[coveralls-url]: https://coveralls.io/r/hybridables/letta
[coveralls-img]: https://img.shields.io/coveralls/hybridables/letta.svg

[david-url]: https://david-dm.org/hybridables/letta
[david-img]: https://img.shields.io/david/hybridables/letta.svg

[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg


[author-www-url]: http://www.tunnckocore.tk
[author-www-img]: https://img.shields.io/badge/www-tunnckocore.tk-fe7d37.svg

[keybase-url]: https://keybase.io/tunnckocore
[keybase-img]: https://img.shields.io/badge/keybase-tunnckocore-8a7967.svg

[author-npm-url]: https://www.npmjs.com/~tunnckocore
[author-npm-img]: https://img.shields.io/badge/npm-~tunnckocore-cb3837.svg

[author-twitter-url]: https://twitter.com/tunnckoCore
[author-twitter-img]: https://img.shields.io/badge/twitter-@tunnckoCore-55acee.svg

[author-github-url]: https://github.com/tunnckoCore
[author-github-img]: https://img.shields.io/badge/github-@tunnckoCore-4183c4.svg

[freenode-url]: http://webchat.freenode.net/?channels=charlike
[freenode-img]: https://img.shields.io/badge/freenode-%23charlike-5654a4.svg

[new-message-url]: https://github.com/tunnckoCore/ama
[new-message-img]: https://img.shields.io/badge/ask%20me-anything-green.svg
37 changes: 37 additions & 0 deletions examples/fs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
/*!
* letta <https://github.com/hybridables/letta>
*
* Copyright (c) 2015 Charlike Mike Reagent <@tunnckoCore> (http://www.tunnckocore.tk)
* Released under the MIT license.
*/

'use strict'

var fs = require('fs')
var path = require('path')
var letta = require('../index')
var filepath = path.join(path.dirname(__dirname), 'package.json')

/**
* fs.readFileSync
*/

letta(fs.readFileSync, filepath, 'utf-8').then(function (data) {
console.log(JSON.parse(data).name) // => 'letta'
}, console.error)

/**
* fs.readFile
*/

letta(fs.readFile, filepath, 'utf-8').then(function (data) {
console.log(data.indexOf('"license": "MIT"') !== -1) // => true
}, console.error)

/**
* fs.stat
*/

letta(fs.stat, filepath).then(function (stats) {
console.log(stats.isFile()) // => true
}, console.error)
50 changes: 50 additions & 0 deletions examples/generators.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/*!
* letta <https://github.com/hybridables/letta>
*
* Copyright (c) 2015 Charlike Mike Reagent <@tunnckoCore> (http://www.tunnckocore.tk)
* Released under the MIT license.
*/

/* jshint asi:true */

'use strict'

var fs = require('fs')
var letta = require('../index')
var simpleGet = require('simple-get')

/**
* readFile
*/

function read (fp) {
return function (done) {
fs.readFile(fp, 'utf8', done)
}
}

letta(function * () {
var data = yield read('package.json')
return JSON.parse(data)
}).then(function (json) {
console.log(json.name) // => 'letta'
}, console.error)

/**
* http request
*/

function get (url) {
return function (done) {
simpleGet.concat(url, done)
}
}

letta(function * () {
var res = yield get('http://www.tunnckocore.tk')
var buf = res[0]
// var httpResponse = res[1]
return buf.toString()
}).then(function (res) {
console.log(res.indexOf('<title>') !== -1) // => true
}, console.error)
38 changes: 38 additions & 0 deletions examples/json.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/*!
* letta <https://github.com/hybridables/letta>
*
* Copyright (c) 2015 Charlike Mike Reagent <@tunnckoCore> (http://www.tunnckocore.tk)
* Released under the MIT license.
*/

'use strict'

var letta = require('../index')

/**
* JSON.stringify without identation
*/

letta(JSON.stringify, {foo: 'bar'}).then(function (data) {
console.log(data) // => {"foo":"bar"}
}, console.error)

/**
* JSON.stringify with identation
*/

letta(JSON.stringify, {foo: 'bar'}, null, 2).then(function (data) {
console.log(data)
// =>
// {
// "foo": "bar"
// }
}, console.error)

/**
* JSON.parse
*/

letta(JSON.parse, '{"foo":"bar"}').then(function (data) {
console.log(data.foo) // => 'bar'
}, console.error)
Loading

0 comments on commit 944be08

Please sign in to comment.