Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/westonganger/rearmed-rb
A collection of helpful methods and monkey patches for Arrays, Hash, Enumerables, Strings, Objects & Dates in Ruby
https://github.com/westonganger/rearmed-rb
monkey-patching rails ruby utility
Last synced: 3 months ago
JSON representation
A collection of helpful methods and monkey patches for Arrays, Hash, Enumerables, Strings, Objects & Dates in Ruby
- Host: GitHub
- URL: https://github.com/westonganger/rearmed-rb
- Owner: westonganger
- License: mit
- Archived: true
- Created: 2016-05-03T13:27:37.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-02-14T05:39:24.000Z (over 1 year ago)
- Last Synced: 2024-06-22T14:02:34.120Z (5 months ago)
- Topics: monkey-patching, rails, ruby, utility
- Language: Ruby
- Homepage:
- Size: 111 KB
- Stars: 42
- Watchers: 6
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Rearmed Ruby
A collection of helpful methods and monkey patches for Arrays, Hash, Enumerables, Strings, Objects & Dates in Ruby. [Rearmed is a collection of plugins](https://github.com/westonganger?utf8=%E2%9C%93&tab=repositories&q=rearmed) which are driven by making life easier & coding more natural.
The difference between this library and others is that all monkey patching is performed in an opt-in way because you shouldnt be using methods you dont know about anyways.
When possible I have placed the method implementations inside the Rearmed module so if you don't like monkey patching or are working on the project with a team then you can use these methods instead. You can then skip the config and see how to use each implementation below the relevant methods documentation.
# Install
Add the following line to your gemfile:
```ruby
gem 'rearmed'
```
# Usage
## Setup Monkey Patches (all are opt-in)
```ruby
# config/initializers/rearmed.rb
Rearmed.enabled_patches = {
array: {
delete_first: false,
dig: false,
not_empty: false
},
date: {
now: false
},
enumerable: {
natural_sort: false,
natural_sort_by: false,
select_map: false
},
hash: {
compact: false,
deep_set: false,
dig: false,
join: false,
only: false,
to_struct: false
},
integer: {
length: false
},
object: {
bool?: false,
false?: false,
in: false,
not_nil: false,
true?: false
},
string: {
begins_with: false,
casecmp?: false,
ends_with: false,
match?: false,
starts_with: false,
to_bool: false,
valid_float: false,
valid_integer: false
}
}
Rearmed.apply_patches!
```
Some other argument formats the `enabled_patches` option accepts are:
```ruby
### Enable everything
Rearmed.enabled_patches = :all
### Disable everything
Rearmed.enabled_patches = nil
### Hash values can be boolean/nil values also
Rearmed.enabled_patches = {
array: true,
date: {
now: true
},
enumerable: true,
hash: false,
integer: false,
object: nil,
string: nil
}
```
By design, once `Rearmed.apply_patches!` is called then `Rearmed.enabled_patches` is no longer editable and `Rearmed.apply_patches!` cannot be called again. If you try to do so, it will raise a `PatchesAlreadyAppliedError`. There is no-built in way of changing the patches, if you need to do so (which you shouldn't) that is up to you to figure out.
## Array Methods
```ruby
array = [1,2,1,4,1]
array.delete_first(1) # => 1
puts array #=> [2,1,4,1]
array.delete_first{|x| 1 == x} # => 1
puts array # => [2,4,1]
array.delete_first # => 2
puts array # => [4,1]
array.not_empty? # => true
# Only monkey patched if using Ruby 2.2.x or below as this method was added to Ruby core in 2.3.0
items = [{foo: ['foo','bar']}, {test: 'thing'}]
items.dig(0, :foo, 1) # => 'bar'
# or without monkey patch: Rearmed.dig(items, 0, :foo, 1)
```
## Enumerable Methods (Array, Hash, etc.)
```ruby
items = ['1.1', '1.11', '1.2']
items.natural_sort
items.natural_sort(reverse: true) # because natural_sort does not accept a block, accepting PR's on this
# or without monkey patch: Rearmed.natural_sort(items) or Rearmed.natural_sort(items, reverse: true)
items = [{version: "1.1"}, {version: "1.11"}, {version: "1.2"}]
items.natural_sort_by{|x| x[:version]}
# or without monkey patch: Rearmed.natural_sort_by(items){|x| x[:version]}
items = [{version: "1.1"}, {version: nil}, {version: false}]
items.select_map{|x| x[:version]} #=> [{version: "1.1"}]
# or without monkey patch: Rearmed.select_map(items){|x| x[:version]}
```
## Date
```ruby
Date.now
```
## Hash Methods
```ruby
hash.join{|k,v| "#{k}: #{v}\n"}
hash = {foo: 'foo', bar: 'bar', other: 'other'}
hash.only(:foo, :bar) # => {foo: 'foo'}
# or without monkey patch: Rearmed.hash_only(hash, :foo, :bar)
hash.only!(:foo, :bar)
hash.to_struct
# or without monkey patch: Rearmed.hash_to_struct(hash)
# Only monkey patched if using Ruby 2.2.x or below as this method was added to Ruby core in 2.3.0
items = [{foo: ['foo','bar']}, {test: 'thing'}]
items.dig(0, :foo, 1) # => 'bar'
# or without monkey patch: Rearmed.dig(items, 0, :foo, 1)
# Only monkey patched if using Ruby 2.3.x or below as this method was added to Ruby core in 2.4.0
hash.compact
# or without monkey patch: Rearmed.hash_compact(hash)
hash.compact!
hash.deep_set([:foo, :bar, :name], "John") # => {foo: {bar: {name: "John"}}}
# or without monkey patch: Rearmed.hash_deep_set(hash, keys_array, value)
```
## Object
```ruby
my_var.not_nil?
# Only monkey patched if not using ActiveSupport / Rails as this method is already defined there
my_var.in?([1,2,3])
my_var.in?(1,2,3) # or with splat arguments
my_var.bool? # if is true or false boolean value
my_var.true? # if is true boolean value
my_var.false? # if is false boolean value
```
## String
```ruby
'123'.valid_integer?
# or without monkey patch: Rearmed.valid_integer?('123')
'123.123'.valid_float?
# or without monkey patch: Rearmed.valid_float?('123.123')
'123.123'.valid_number?
# or without monkey patch: Rearmed.valid_number?('123.123')
'true'.to_bool
# or without monkey patch: Rearmed.to_bool('true')
'foo'.match?(/fo/) #=> true, this method returns a convenient boolean value instead of matchdata
# alias of start_with? and end_with? to have more sensible method names
'foo'.starts_with?('fo') # => true
'foo'.begins_with?('fo') # => true
'bar'.ends_with?('ar') # => true
# Only monkey patched if using Ruby 2.3.x or below as this method was added to Ruby core in 2.4.0
'foo'.casecmp?('FOO') #=> true
'foo'.casecmp?('FOOBAR') #=> false
# or without monkey patch: Rearmed.casecmp?('foo', 'FOO')
```
# Contributing / Todo
If your looking to contribute here is a list of outstanding items:
- Get the `natural_sort` method to accept a block
To request or add a method, please raise an issue and we can discuss the implementation.
# Credits
Created by Weston Ganger - [@westonganger](https://github.com/westonganger)
## Other Libraries in the Rearmed family of Plugins
- [Rearmed Rails](https://github.com/westonganger/rearmed_rails)
- [Rearmed-JS](https://github.com/westonganger/rearmed-js)
- [Rearmed-CSS](https://github.com/westonganger/rearmed-css)