README.md in refinements-4.1.0 vs README.md in refinements-4.2.0
- old
+ new
@@ -2,41 +2,41 @@
[](http://badge.fury.io/rb/refinements)
[](https://codeclimate.com/github/bkuhlmann/refinements)
[](https://codeclimate.com/github/bkuhlmann/refinements)
[](https://gemnasium.com/bkuhlmann/refinements)
-[](https://travis-ci.org/bkuhlmann/refinements)
+[](https://circleci.com/gh/bkuhlmann/refinements)
[](https://www.patreon.com/bkuhlmann)
Provides a collection of refinements to core Ruby objects.
<!-- Tocer[start]: Auto-generated, don't remove. -->
-# Table of Contents
+## Table of Contents
-- [Features](#features)
-- [Requirements](#requirements)
-- [Setup](#setup)
-- [Usage](#usage)
- - [Requires](#requires)
- - [Using](#using)
- - [Examples](#examples)
- - [String](#string)
- - [Big Decimal](#big-decimal)
- - [Array](#array)
- - [Hash](#hash)
-- [Tests](#tests)
-- [Versioning](#versioning)
-- [Code of Conduct](#code-of-conduct)
-- [Contributions](#contributions)
-- [License](#license)
-- [History](#history)
-- [Credits](#credits)
+ - [Features](#features)
+ - [Requirements](#requirements)
+ - [Setup](#setup)
+ - [Usage](#usage)
+ - [Requires](#requires)
+ - [Using](#using)
+ - [Examples](#examples)
+ - [String](#string)
+ - [Big Decimal](#big-decimal)
+ - [Array](#array)
+ - [Hash](#hash)
+ - [Tests](#tests)
+ - [Versioning](#versioning)
+ - [Code of Conduct](#code-of-conduct)
+ - [Contributions](#contributions)
+ - [License](#license)
+ - [History](#history)
+ - [Credits](#credits)
<!-- Tocer[finish]: Auto-generated, don't remove. -->
-# Features
+## Features
- Provides Array refinements:
- `Array#compress` - Removes `nil` and empty values without modifying itself.
- `Array#compress!` - Removes `nil` and empty values while modifying itself.
- Provides BigDecimal refinements:
@@ -63,16 +63,16 @@
- `#snakecase` - Answers a snakecased string. Example: "this_is_snakecase".
- `#titleize` - Answers titleized string. Example: "This Is Titleized".
- `#use` - Provides hash value computation, via a block, by using
only the keys as arguments to the block.
-# Requirements
+## Requirements
0. [Ruby 2.4.x](https://www.ruby-lang.org).
0. A solid understanding of [Ruby refinements and lexical scope](https://www.youtube.com/watch?v=qXC9Gk4dCEw).
-# Setup
+## Setup
For a secure install, type the following from the command line (recommended):
gem cert --add <(curl --location --silent https://www.alchemists.io/gem-public.pem)
gem install refinements --trust-policy MediumSecurity
@@ -87,13 +87,13 @@
Add the following to your Gemfile file:
gem "refinements"
-# Usage
+## Usage
-## Requires
+### Requires
If all refinements are not desired, add the following to your `Gemfile` instead:
gem "refinements", require: false
@@ -102,26 +102,26 @@
require "refinements/arrays"
require "refinements/big_decimals"
require "refinements/hashes"
require "refinements/strings"
-## Using
+### Using
Much like including/extending a module, you'll need modify your object(s) to use the refinement(s):
class Example
using Refinements::Arrays
using Refinements::BigDecimals
using Refinements::Hashes
using Refinements::Strings
end
-## Examples
+### Examples
The following sections demonstrate how each refinement enriches your objects with new capabilities.
-### String
+#### String
"example".first # => "e"
"example".first 4 # => "exam"
"instant".last # => "t"
@@ -132,26 +132,26 @@
"EXAMPLE".down # => "eXAMPLE"
"this_is_an_example".camelcase # => "ThisIsAnExample"
"ThisIsAnExample".snakecase # => "this_is_an_example"
"ThisIsAnExample".titleize # => "This Is An Example"
-### Big Decimal
+#### Big Decimal
big = BigDecimal.new "5.0E-10"
big.inspect # => "#<BigDecimal:3fd3d458fe84 0.0000000005>"
-### Array
+#### Array
example = ["An", nil, "", "Example"]
example.compress # => ["An", "Example"]
example # => ["An", nil, "", "Example"]
example = ["An", nil, "", "Example"]
example.compress! # => ["An", "Example"]
example # => ["An", "Example"]
-### Hash
+#### Hash
example = {a: 1, b: 2, c: 3}
example.except :a, :b # => {c: 3}
example # => {a: 1, b: 2, c: 3}
@@ -192,42 +192,42 @@
example # => {a: 1, b: 2, c: 3}
example = {unit: "221B", street: "Baker Street", city: "London", country: "UK"}
example.use { |unit, street| "#{unit} #{street}" } # => "221B Baker Street"
-# Tests
+## Tests
To test, run:
bundle exec rake
-# Versioning
+## Versioning
Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
- Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
- Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
-# Code of Conduct
+## Code of Conduct
Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By
participating in this project you agree to abide by its terms.
-# Contributions
+## Contributions
Read [CONTRIBUTING](CONTRIBUTING.md) for details.
-# License
+## License
Copyright (c) 2015 [Alchemists](https://www.alchemists.io).
Read [LICENSE](LICENSE.md) for details.
-# History
+## History
Read [CHANGES](CHANGES.md) for details.
Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
-# Credits
+## Credits
Developed by [Brooke Kuhlmann](https://www.alchemists.io) at
[Alchemists](https://www.alchemists.io).