Skip to content

Commit

Permalink
Rename project(name 'tyson' already exists in npm...)
Browse files Browse the repository at this point in the history
  • Loading branch information
kination committed Nov 5, 2018
1 parent f3d991a commit f9330d4
Show file tree
Hide file tree
Showing 7 changed files with 29 additions and 31 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,32 @@
# TYSON - Tune Your jSON
# TUCSON - TUne/Convert Your jSON
Package to convert JSON key/values to make it fit on your project.

# Usage

### Example
```javascript
let { Tyson, Config } = require('../lib/index')
let { Tucson, Config } = require('tucson')

const dummyUnderscoreJson = {
"id": 139,
"group_id": 139,
"user": "[email protected]",
"phone_number": "000-111-2222",
"salary": "Unknown",
"date": "2014-06-01 12:00"
}

let tunedResult = {}
let cctyson = new Tyson(new Config('camelCase'))
cctyson.tuned(dummyUnderscoreJson, {makeDate: ['date']}, tunedResult)
console.log(tunedResult)
let formedResult = {}
let cctucson = new Tucson(new Config('camelCase'))
cctucson.formed(dummyUnderscoreJson, {makeDate: ['date']}, formedResult)
console.log(formedResult)
```
...result is...
```json
{
"id":139,
"groupId":139,
"user":"[email protected]",
"phoneNumber":"000-111-2222",
"salary":"Unknown",
"date":"2014-06-01T03:00:00.000Z"
}
```


18 changes: 9 additions & 9 deletions example/example.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
let { Tyson, Config } = require('../lib/index')
let { Tucson, Config } = require('../lib/index')

const dummyUnderscoreJson = {
"id": 139,
Expand All @@ -10,12 +10,12 @@ const dummyUnderscoreJson = {
"date": "2014-06-01 12:00"
}

let tunedResult = {}
let cctyson = new Tyson(new Config('camelCase'))
cctyson.tuned(dummyUnderscoreJson, {makeDate: ['date']}, tunedResult)
console.log(`camelcase json: ${JSON.stringify(tunedResult)}`)
let formedResult = {}
let ccTucson = new Tucson(new Config('camelCase'))
ccTucson.formed(dummyUnderscoreJson, {makeDate: ['date']}, formedResult)
console.log(`camelcase json: ${JSON.stringify(formedResult)}`)

let tunedResult_sc = {}
let sctyson = new Tyson(new Config('snake_case'))
sctyson.tuned(tunedResult, {}, tunedResult_sc)
console.log(`snake_case json: ${JSON.stringify(tunedResult_sc)}`)
let formedResult_sc = {}
let scTucson = new Tucson(new Config('snake_case'))
scTucson.formed(formedResult, {}, formedResult_sc)
console.log(`snake_case json: ${JSON.stringify(formedResult_sc)}`)
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "tyson",
"name": "tucson",
"version": "0.0.1",
"description": "",
"main": "index.js",
Expand Down
2 changes: 1 addition & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
export * from './config'
export * from './tyson'
export * from './tucson'
4 changes: 2 additions & 2 deletions src/tyson.ts → src/tucson.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ const converter = (convertType: KeyConvertType, key: string): string => {
return key
}

export class Tyson {
export class Tucson {
config: Config

constructor (config: Config) {
this.config = config
}

tuned<T1, T2> (obj: T1, option: JsonOption<T1>, instance: T2): T2 {
formed<T1, T2> (obj: T1, option: JsonOption<T1>, instance: T2): T2 {
if (!obj) {
return instance
}
Expand Down
14 changes: 7 additions & 7 deletions test/testCamelcase.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
let assert = require('assert');
let moment = require('moment')
let { Tyson, Config } = require('../lib/index')
let { Tucson, Config } = require('../lib/index')

describe('to camelcase', () => {

Expand All @@ -11,23 +11,23 @@ describe('to camelcase', () => {
'company': 'LeapMind',
'date': '2014-06-01 12:00'
}
let tunedResult = {}
let cctyson = new Tyson(new Config('camelCase'))
let formedResult = {}
let cctucson = new Tucson(new Config('camelCase'))

before(() => {
cctyson.tuned(dummyUnderscoreJson, {makeDate: ['date']}, tunedResult)
cctucson.formed(dummyUnderscoreJson, {makeDate: ['date']}, formedResult)
})

describe('check key', () => {
it('key should be changed as camelcase', function() {
assert.equal(tunedResult.hasOwnProperty('groupCode'), true)
assert.equal(tunedResult.hasOwnProperty('phoneNumber'), true)
assert.equal(formedResult.hasOwnProperty('groupCode'), true)
assert.equal(formedResult.hasOwnProperty('phoneNumber'), true)
});
});

describe('check makeDate', () => {
it('value with `makeDate` should be converted as Moment', function() {
assert.equal(tunedResult['date'].valueOf(), moment('2014-06-01 12:00').toDate().valueOf())
assert.equal(formedResult['date'].valueOf(), moment('2014-06-01 12:00').toDate().valueOf())
});
});
});

0 comments on commit f9330d4

Please sign in to comment.