jhonnymoreira/obbie

Ruby Hash methods in JavaScript as a collection of functions.

obbie's Issues

Improve API template

Description

The current API template for the functions dirties the URL with the type signature of each function.

The URL to compact is /docs/api.md#compactobject-object--object. These object-object--object just makes the URL less friendly.

The current syntax looks like:

## `functionName(argumentName: argumentType) => returnType`

Function description (the same as JSDoc)

```javascript
import { functionName } from 'obbie'

example
```

Proposal

It would be nice to move those type signatures from the function name to a line before the description, just as the example:

## functionName

`functionName :: (argumentName: argumentType) -> returnType`

Function description (the same as JSDoc)

```javascript
import { functionName } from 'obbie'

example
```

This change affects directly how the URL looks like, using compact as example, it becomes /docs/api.md#compact. No type signature dirtying the URL!

It would render:

---

functionName

functionName :: (argumentName: argumentType) -> returnType

Function description (the same as JSDoc)

import { functionName } from 'obbie'

example

Hash#values

The old description doesn't match the behavior of JavaScript. The type coercion helps not to break stuff easily, let it be like this. I'm removing the good first issue and help wanted.

Object.values() has a lot of gotchas. Try to keep things as normalized as possible. The Object.values() coercion of non-object values into object are harmful and could cause inconsistency.

We may need to rethink on how to approach this issue and maybe do some benchmarks.

If there is any question, feel free to ping me.

References

• https://ruby-doc.org/core-2.4.2/Hash.html#method-i-values
• https://developer.mozilla.org/pt-BR/docs/Web/JavaScript/Reference/Global_Objects/Object/values

Move readme API to an exclusive file

Missing readme.md

A readme.md file that explain what this repository is about is a good entry point to new devs. Is nearly impossible to review or give some ideas without know what repository author is purposing.

A good example of readme contains, but is not limited to:

• What is this repository;
• Wich kind of problem it solves;
• How can to use;
• How to contribute.

Hash#dig implementation

The behavior will change from Ruby to JavaScript, because JavaScript is stricter when handling keys that doesn't exist and has a sequence, so instead of returning null, it throws a TypeError. Below, the example of it:

Ruby

{ a: { b: { c: 1 } } }.dig(:a, :d, :c)
#=> nil

JavaScript

dig({ a: { b: { c: 1 } } }, 'a', 'd', 'c')
//=> Uncaught TypeError: Cannot read property 'c' of undefined

References

• https://ruby-doc.org/core-2.4.2/Hash.html#method-i-dig

Setup CI

See: https://travis-ci.org/

Hash::[] implementation

The arrow syntax (key => value) to set key-value pairs on Ruby Hashes can be totally ignored.

Maybe, but just maybe, passing a valid JSON string can be a form of initializing the Obbie object.

References

• https://ruby-doc.org/core-2.4.2/Hash.html#method-c-5B-5D

An in-range update of eslint-plugin-jest is breaking the build 🚨

The devDependency eslint-plugin-jest was updated from 22.5.1 to 22.6.0.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

eslint-plugin-jest is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push: The Travis CI build could not complete due to an error (Details).

---

Release Notes for v22.6.0

22.6.0 (2019-05-22)

Features

• rules: add no-commented-out rule (#262) (14d83ef)

Commits

The new version differs by 9 commits.

• 14d83ef feat(rules): add no-commented-out rule (#262)
• 83ff198 chore: migrate no-jest-import to typescript (#259)
• 718c08c chore: upgrade @typescript-eslint
• ca2aa27 chore: port lowercase-name to TypeScript (#258)
• 3df0058 chore(ci): run danger with lts version of node
• 48e3a59 chore: precompile with babel (#257)
• 8670804 chore: bump deps
• 05eb11a chore: fix lint error
• dff6446 docs: link to eslint-plugin-jest-formatting

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴