ruby_extended 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6713d9529df421372812b0a1d21c647eb6e4cbc2928d9d544ccfa1b4bef5ad0b
+  data.tar.gz: 4400debd57858bbbbf006c2004ad6812c91baec26c1180a202f56bc5f5c9a8a5
+SHA512:
+  metadata.gz: 4766701ba03173a2ae2e07e88f0ff7ebe7e14bedf14ec78a5d622258f4c2b2521b8cdc790380e6b376050696ad60d1a2a27c700f1ee5a76c0fe4cc6396d669b5
+  data.tar.gz: c8c9a8193876f82888c3163a4cc24469b396fc98e5c0002a09e2767d8f23b4ef036ec7cad87a284c68859a0d757bac5a85f31c63af3d11adfc4beea26c3433cc

data/.gitignore

@@ -0,0 +1,10 @@
+# IDE
+.idea/
+.atom/
+.vscode/
+
+# Rspec
+coverage/
+
+# Gem builds
+ruby_extended-*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gem 'unicode_utils'
+
+group :test do
+  gem 'pry',            require: false
+  gem 'rspec',          require: false
+  gem 'codecov',        require: false
+  gem 'simplecov-html', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,45 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    codecov (0.2.12)
+      json
+      simplecov
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    docile (1.3.2)
+    json (2.3.1)
+    method_source (1.0.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    simplecov (0.19.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+    simplecov-html (0.12.3)
+    unicode_utils (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  codecov
+  pry
+  rspec
+  simplecov-html
+  unicode_utils
+
+BUNDLED WITH
+   2.1.2

data/badges/coverage.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="104" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="104" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h61v20H0z"/><path fill="#4c1" d="M61 0h43v20H61z"/><path fill="url(#b)" d="M0 0h104v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"> <text x="315" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="510">coverage</text><text x="315" y="140" transform="scale(.1)" textLength="510">coverage</text><text x="815" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="330">100%</text><text x="815" y="140" transform="scale(.1)" textLength="330">100%</text></g> </svg>

data/badges/license.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="112" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="112" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h47v20H0z"/><path fill="#4c1" d="M47 0h65v20H47z"/><path fill="url(#b)" d="M0 0h112v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"> <text x="245" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370">license</text><text x="245" y="140" transform="scale(.1)" textLength="370">license</text><text x="785" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="550">CC BY 4.0</text><text x="785" y="140" transform="scale(.1)" textLength="550">CC BY 4.0</text></g> </svg>

data/badges/ruby.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="84" height="20"><linearGradient id="b" x2="0" y2="100%"><stop offset="0" stop-color="#bbb" stop-opacity=".1"/><stop offset="1" stop-opacity=".1"/></linearGradient><clipPath id="a"><rect width="84" height="20" rx="3" fill="#fff"/></clipPath><g clip-path="url(#a)"><path fill="#555" d="M0 0h37v20H0z"/><path fill="#007ec6" d="M37 0h47v20H37z"/><path fill="url(#b)" d="M0 0h84v20H0z"/></g><g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110"> <text x="195" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="270">Ruby</text><text x="195" y="140" transform="scale(.1)" textLength="270">Ruby</text><text x="595" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="370">1.9.3+</text><text x="595" y="140" transform="scale(.1)" textLength="370">1.9.3+</text></g> </svg>

data/documentation/array.md

@@ -0,0 +1,226 @@
+# Ruby Extend - Array
+
+
+
+### `.sort_lv`
+Sorts Array respecting latvian characters, like `Ā`, `Č`, etc..
+```ruby
+%w[a b c ā z č].sort_lv # => ['a', 'ā', 'b', 'c', 'č', 'z']
+```
+Method accepts block, so it can be used on hash arrays.
+```ruby
+[
+  { n: 'a' },
+  { n: 'c' },
+  { n: 'ā' },
+  { n: 'č' },
+  { n: 'z' }
+].sort_lv { |x| x[:n] } # => [ { n: 'a' }, { n: 'ā' }, { n: 'c' }, { n: 'č' }, { n: 'z' } ]
+```
+
+
+### `.tabulate`
+Split and transpose array horizontally or vertically.
+```ruby
+%w[a b c d e f g].tabulate(2, split_by: :columns, direction: :horizontal)
+# => [ [a,b], [c,d], [e,f], [g,nil] ]
+#
+# visualized example:
+# [ a ] [ b ]
+# [ c ] [ d ]
+# [ e ] [ f ]
+# [ g ] [nil] 
+```
+```ruby
+%w[a b c d e f g].tabulate(2, split_by: :rows, direction: :horizontal)
+# => [ [a,b,c,d], [e,f,g,nil] ]
+#
+# visualized example:
+# [ a ] [ b ] [ c ] [ d ]
+# [ e ] [ f ] [ g ] [nil] 
+```
+```ruby
+%w[a b c d e f g].tabulate(2, split_by: :columns, direction: :vertical)
+# => [ [a,b,c,d], [e,f,g,nil] ]
+#
+# visualized example:
+# [ a ] [ e ]
+# [ b ] [ f ]
+# [ c ] [ g ]
+# [ d ] [nil] 
+```
+```ruby
+%w[a b c d e f g].tabulate(2, split_by: :rows, direction: :vertical)
+# => [ [a,c,e,g], [b,d,f,nil] ]
+#
+# visualized example:
+# [ a ] [ c ] [ e ] [ g ]
+# [ b ] [ d ] [ f ] [nil]
+```
+
+
+### `.sample_index`
+Returns uniq array of hashes, based on one key.
+```ruby
+[
+  {a: 1, b: '123'},
+  {a: 1, b: 'abc'},
+  {a: 2, b: 'cde'}
+].uniq_by_key(:a)   # => [ {a: 1, b: '123'}, {a: 2, b: 'cde'} ]
+```
+Returns original array if key not found
+```ruby
+[
+  {a: 1, b: '123'},
+  {a: 1, b: 'abc'},
+  {a: 2, b: 'cde'}
+].uniq_by_key(:x)   # => [ {a: 1, b: '123'}, {a: 1, b: 'abc'}, {a: 2, b: 'cde'} ]
+```
+
+
+### `.duplicates`
+Returns duplicates from array
+```ruby
+['a', 'a', 2, 2, 2, 2, 3, 'b', nil, nil].duplicates # => ['a', 2, nil]
+```
+Returns duplicates from array with count
+```ruby
+['a', 'a', 2, 2, 2, 2, 3, 'b', nil, nil].duplicates(full: true)
+# => [
+#       {item: 'a', count: 2},
+#       {item: 2,   count: 4},
+#       {item: nil, count: 2}
+#    ]
+```
+
+
+### `.sum` (overwrites & extends existing method)
+```ruby
+[1, 2, 3].sum               # => 6
+[0.1, 0.2, 1].sum           # => 1.3
+%w[a b].sum                 # => 'ab'
+['a', 'b', 2, 1.5, nil].sum # => ab21.5
+```
+If only numbers in array need to be summed:
+```ruby
+['a', 1, 1.5, nil].sum(only_numbers: true) # => 2.5
+```
+Possible to sum by hash key:
+```ruby
+[ {a: 1}, {a: 'a'}, {a: 3} ].sum(key: :a, only_numbers: true) # => 4
+[ {a: 1}, {a: 'a'}, {b: 3} ].sum(key: :a, only_numbers: true) # => 1
+```
+If the key is not found in any of the array hash items, will return `nil`
+```ruby
+[ {a: 1}, {a: 'a'}, {a: 3} ].sum(key: :b) # => nil
+```
+
+
+### `.to_tree`
+Converts hash array with parent_id to embed array with children.
+```ruby
+[
+  {id: 1, parent_id: nil, any_other_key: 'a'},
+  {id: 2, parent_id: 1,   any_other_key: 'b'},
+  {id: 3, parent_id: 2,   any_other_key: 'c'},
+].to_tree
+```
+to
+```json
+[                                
+  {                              
+    "id": 1,                     
+    "parent_id": null,           
+    "any_other_key": "a",        
+    "children": [                
+      {                          
+        "id": 2,                 
+        "parent_id": 1,          
+        "any_other_key": "b",    
+        "children": [            
+          {                      
+            "id": 3,             
+            "parent_id": 2,      
+            "any_other_key": "c" 
+          }                      
+        ]                        
+      }                          
+    ]                            
+  }                              
+]                                
+```
+It's also possible to convert it to hash
+```ruby
+[
+  {id: 1, parent_id: nil, any_other_key: 'a'},
+  {id: 2, parent_id: 1,   any_other_key: 'b'},
+  {id: 3, parent_id: 2,   any_other_key: 'c'},
+].to_tree(to_hash: true)
+```
+```json
+{
+  "1": {
+    "id": 1,
+    "any_other_key": "a",
+    "children": {
+      "2": {
+        "id": 2,
+        "any_other_key": "b",
+        "children": {
+          "3": {
+            "id": 3,
+            "any_other_key": "c"
+          }
+        }
+      }
+    }
+  }
+}
+```
+All available options
+<table border="1">
+  <thead>
+    <tr>
+      <td>Option</td>
+      <td>Description</td>
+      <td>Default</td>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>id_key</td>
+      <td>Specify the id key</td>
+      <td>id</td>
+    </tr>
+    <tr>
+      <td>parent_id_key</td>
+      <td>Specify parent_id key</td>
+      <td>parent_id</td>
+    </tr>
+    <tr>
+      <td>children_key</td>
+      <td>Specify children key</td>
+      <td>children</td>
+    </tr>
+    <tr>
+      <td>include_parent_id</td>
+      <td>Include parent_id</td>
+      <td>false</td>
+    </tr>
+    <tr>
+      <td>include_empty_children</td>
+      <td>includes empty children key if no children present</td>
+      <td>false</td>
+    </tr>
+    <tr>
+      <td>to_hash</td>
+      <td>Convert to hash instead of array</td>
+      <td>false</td>
+    </tr>
+    <tr>
+      <td>include_id</td>
+      <td>Include id key when converting to hash</td>
+      <td>true</td>
+    </tr>
+  </tbody>
+</table>

data/documentation/hash.md

@@ -0,0 +1,22 @@
+# Ruby Extend - Hash
+
+
+
+### `.deep_find`
+Returns key value in any hash level and return full path to it
+```ruby
+{
+  a: {
+    d: 'foo value 1',
+    b: [
+      {c: 1},
+      {d: 'foo value 2'}
+    ]
+  }
+}.deep_find(:d)
+# => 
+# [
+#   {value: 'foo value 1', path: [:a, :d]},
+#   {value: 'foo value 2', path: [:a, b, 1, :d]}
+# ]
+```

data/documentation/number.md

@@ -0,0 +1,39 @@
+# Ruby Extend - Number (Integer, Float, BigDecimal, Complex, Rational)
+
+
+
+### `.no_zeros`
+Converts any number to string, that has no zeroes
+```ruby
+(1.0).no_zero  # => '1'
+(1.10).no_zero # => '1.1'
+```
+
+
+### `.to_money`
+Converts any number to string formatted in money format
+```ruby
+(1.0).to_money  # => '1.00'
+```
+
+
+### `.percent_of`
+Get percent value from number
+```ruby
+(10).percent_of(100) # => 10
+```
+Possible to get decimal value as well
+```ruby
+(10).percent_of(111, decimal: true) # => 11.100000000000001
+```
+
+
+### `.get_percent_from`
+Get percent from two numbers
+```ruby
+(2).get_percent_from(6) # => 33
+```
+Possible to get decimal value as well
+```ruby
+(2).get_percent_from(6, decimal: true) # => 33.33333333333333
+```

data/documentation/object.md

@@ -0,0 +1,17 @@
+# Ruby Extend - Object (Array & Hash)
+
+
+
+### `.dig`
+Navigate hash or array without getting error, in case item is not found.
+```ruby
+{a: {b: 'value'}}.dig(:a, :b) # => 'value'
+[{a: [{b: 'value'}]}].dig(0, :a, 0, :b) # => 'value'
+```
+Note: the difference from the dig method, included from Ruby 2.3, is that
+in this version it's possible to use array as value, which is not possible
+to do in original dig method.
+```ruby
+{a: {b: 'value'}}.dig([:a, :b]) # => 'value'
+[{a: [{b: 'value'}]}].dig([0, :a, 0, :b]) # => 'value'
+```

data/documentation/readme.md

@@ -0,0 +1,7 @@
+# Ruby Extend Documentation
+
+* [Array](/documentation/array.md)
+* [Hash](/documentation/hash.md)
+* [Object](/documentation/object.md) (Array & Hash)
+* [Number](/documentation/object.md) (Integer, Float, BigDecimal, Complex, Rational)
+* [String](/documentation/string.md)

data/documentation/string.md

@@ -0,0 +1,156 @@
+# Ruby Extend - String
+
+
+
+### `.similarity_percent`
+Returns percentage on how similar are two strings
+```ruby
+'ab'.similarity_percent('a')                  # => 50.0
+'ab'.similarity_percent('ax')                 # => 50.0
+'abdefghijk'.similarity_percent('abdefghij0') # => 90.0
+
+a = 'The quick brown fox jumps over the lazy dog'
+b = 'The quick brown fox jumps over the lazy cat'
+a.similarity_percent(b) # => 93.02325581395348
+```
+
+
+### `.index_of`
+Return array of indexes found in string
+```ruby
+'abc123abc'.index_of('abc') # => [0, 6]
+```
+
+
+### `.strip_newline`
+Remove new line characters
+```ruby
+"\n\r".strip_newline # => ''
+```
+
+
+### `.strip_whitespace`
+Remove multiple different whitespace characters
+```ruby
+' '.strip_whitespace # => ''
+```
+Whitespace characters that are removed:
+<table border="1">
+  <thead>
+    <tr>
+      <td>Name</td>
+      <td>Code</td>
+    </td>
+  </thead>
+  <tbody>
+    <tr>
+      <td>SPACE</td>
+      <td>(U+0020)</td>
+    <tr>
+    <tr>
+      <td>NO-BREAK SPACE</td>
+      <td>(U+00A0)</td>
+    <tr>
+    <tr>
+      <td>OGHAM SPACE MARK</td>
+      <td>(U+1680)</td>
+    <tr>
+    <tr>
+      <td>MONGOLIAN VOWEL SEPARATOR</td>
+      <td>(U+180E)</td>
+    <tr>
+    <tr>
+      <td>EN QUAD</td>
+      <td>(U+2000)</td>
+    <tr>
+    <tr>
+      <td>EN SPACE (nut)</td>
+      <td>(U+2002)</td>
+    <tr>
+    <tr>
+      <td>EM SPACE (mutton)</td>
+      <td>(U+2003)</td>
+    <tr>
+    <tr>
+      <td>THREE-PER-EM SPACE (thick space)</td>
+      <td>(U+2004)</td>
+    <tr>
+    <tr>
+      <td>FOUR-PER-EM SPACE (mid space)</td>
+      <td>(U+2005)</td>
+    <tr>
+    <tr>
+      <td>SIX-PER-EM SPACE</td>
+      <td>(U+2006)</td>
+    <tr>
+    <tr>
+      <td>FIGURE SPACE</td>
+      <td>(U+2007)</td>
+    <tr>
+    <tr>
+      <td>PUNCTUATION SPACE</td>
+      <td>(U+2008)</td>
+    <tr>
+    <tr>
+      <td>THIN SPACE</td>
+      <td>(U+2009)</td>
+    <tr>
+    <tr>
+      <td>HAIR SPACE</td>
+      <td>(U+200A)</td>
+    <tr>
+    <tr>
+      <td>ZERO WIDTH SPACE</td>
+      <td>(U+200B)</td>
+    <tr>
+    <tr>
+      <td>NARROW NO-BREAK SPACE</td>
+      <td>(U+200F)</td>
+    <tr>
+    <tr>
+      <td>MEDIUM MATHEMATICAL SPACE</td>
+      <td>(U+205F)</td>
+    <tr>
+    <tr>
+      <td>IDEOGRAPHIC SPACE</td>
+      <td>(U+3000)</td>
+    <tr>
+    <tr>
+      <td>ZERO WIDTH NO-BREAK SPACE</td>
+      <td>(U+FEFF)</td>
+    <tr>
+  </tbody>
+</table>
+
+Possible to also remove visual space characters, by
+passing `visible` option.
+```ruby
+'␣'.strip_whitespace(visible: true) # => ''
+```
+Visual characters removed
+<table>
+  <thead>
+    <tr>
+      <td>Name</td>
+      <td>Code</td>
+      <td>Character</td>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>OPEN BOX</td>
+      <td>U+2423</td>
+      <td>␣</td>
+    </tr>
+    <tr>
+      <td>BLANK SYMBOL</td>
+      <td>U+2422</td>
+      <td>␢</td>
+    </tr>
+    <tr>
+      <td>SYMBOL FOR SPACE</td>
+      <td>U+2420</td>
+      <td>␠</td>
+    </tr>
+  </tbody>
+</table>