rubyhelper 1.1 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8c4d2809b4dda8c8b540cf6b28af9da23d2c57ee
-  data.tar.gz: 96df84faa2992e584bf94b9319c1407d5f3f7a30
+  metadata.gz: d6851b40a4cf69a6d0a3754db488f38a3e5f7938
+  data.tar.gz: 53db33d7c1fa2860abdf3f63c3561f92d93872f4
 SHA512:
-  metadata.gz: a06c5760573007230d36e172ae138704c353b6752df955134a7fe7f8cdb133846c28ec50a875624b247e9c1e28a560477f046014baaa4492406237569f9f3a88
-  data.tar.gz: 215fa6f0575db0c7083b3165b8b143ceb243eac4354eec4a73db42d975670c4b2903bc3f9116f8a1741f9d5a9bcbc9032bf261aa0c2be603ac9e52c6a79aa37a
+  metadata.gz: c6cc4317fb023e6e2c0026c3fb50e7b37d56d13242fb27337fc9f4bba49dbf63ae2614d3d21a1b40c9a83ef415b3dff853633191798d902b925b1aa2d405c354
+  data.tar.gz: e7ff30b52e7a1f85692993e871359c533b5dc9d87a1ecfd10345d6242cfb0bd96675fd05d2a2e8a1f12441c33eae7eb3fe285cf166f6d898b296e9234eecf553

checksums.yaml.gz.sig

@@ -1,2 +1,3 @@
-s`቏�Z��L��e4]U	~Q�1)���E=��HQх�'��/�=�7D��K���),A��8)�2XDJK���J�J�Z|�Ģ]�P��G-�J��j�˳jú�b�9��
e�gq�cj�=��G�-!�`�n�r��ٲ��=
-��hg���G�AfR�e�jL��:��%�P4��KdU�W<���
+��y��
+��u�ϊ�[%�
+�]�i����PE��B�(����1�}d�t�X˨�Q���Eg�pg��3/PNzn�J��.�.e���(��Q���m���w'�"���믷��ZJ�<�b�(jZ

data/README.md

@@ -3,7 +3,7 @@
 Gem [![Gem Version](https://badge.fury.io/rb/rubyhelper.svg)](http://badge.fury.io/rb/rubyhelper)  
 Dev [![GitHub version](https://badge.fury.io/gh/pouleta%2Frubyhelper.svg)](http://badge.fury.io/gh/pouleta%2Frubyhelper)  
 
-You can see the documentation here : https://www.omniref.com/ruby/gems/rubyhelper
+You can see the documentation here : http://rubydoc.info/gems/rubyhelper/
 
 ## How is it works ?
 See the [wtf] section too know what is exactly this stuff.  
@@ -55,15 +55,21 @@ is a little messy. Don't look back 1.1 ;)
 
 
 # TODO
-- Benchmark Hash.except with  
+## Benchmark
+- Hash.except with  
 	```
 		h.delete_if{|k| [:a].include? k}
 	```  
-- Improve documentation
-- Prepare the v1.0
-- Improve VersionHelper tests
+
+## Improve VersionHelper
+- Add test
+- Add more documentation
+
+## Improve main tests
+- Add few tests for untested features
+- Improve existing tests (mainly on StringHelper)
 
 # Contributors
 - poulet_a : Creator and main developper. Feel free to ask me a question by email.  
-	email   : arthur.poulet AT cryptolab.net  
-	OpenPGP : 0x6D9EA34A  
+	email   : arthur.poulet AT cryptolab.net [OpenPGP : 0x6D9EA34A]  
+

data/lib/rubyhelper/array.rb

@@ -25,21 +25,37 @@ module ArrayHelper
   # Do the sum of an array of integer.
   # if there is not integer, it will do a to_s.to_i of the element to try
   # find an integer in the element. else, replace by a simple 0
+  # == Params:
+  #     none
+  # == Returns:
+  #     sum: (Integer) the sum of each element (converted via .to_s.to_i)
   def sum
     return (self.size > 0) ? (self.map{|e| e.to_s.to_i}.reduce(:+)) : (0)
   end
 
   # lke sum by with a to_f instead of to_i
+  # == Params:
+  #     none
+  # == Returns:
+  #     sum: (Float) the sum of each element (converted via .to_s.to_f)
   def sumf
     return (self.size > 0) ? (self.map{|e| e.to_s.to_f}.reduce(:+)) : (0.0)
   end
 
-  # Use the sum and divide by the size of the array. 0 if no element.
+  # Use the sum and divide by the size of the array.
+  # == Params:
+  #     none
+  # == Returns:
+  #     average: (Integer) self.sum / self.size. 0 if no elements
   def average
     return (self.size > 0) ? (self.sum / self.size) : (0)
   end
 
   # Same than average but use to_f instead of to_i
+  # == Params:
+  #     none
+  # == Returns:
+  #     average: (Float) self.sumf / self.size. 0.0 if no elements
   def averagef
     return (self.size > 0) ? (self.sumf / self.size.to_f) : (0.0)
   end
@@ -47,11 +63,12 @@ module ArrayHelper
   # get the n higher values of the array
   # == Errors:
   #     - ArgumentError : if n in not an integer
+  #     - ArgumentError : if n is lesser than 1
   # == Params:
   #     - n: (Integer) number of elements
   def maxs(n=1)
     raise ArgumentError, 'Argument is not an integer' unless n.is_a? Integer
-    n = 1 if n < 1
+    raise ArgumentError, 'Argument is lesser than 1' unless n >= 1
     n = self.size if n > self.size
     return Array(self.sort[(-n)..(-1)])
   end
@@ -59,19 +76,28 @@ module ArrayHelper
   # get the n lower values of the array
   # == Errors:
   #     - ArgumentError : if n in not an integer
+  #     - ArgumentError : if n is lesser than 1
   # == Params:
   #     - n: (Integer) number of elements
   def mins(n=1)
     raise ArgumentError, 'Argument is not an integer' unless n.is_a? Integer
+    raise ArgumentError, 'Argument is lesser than 1' unless n >= 1
     n = 1 if n < 1
     n = self.size if n > self.size
     return Array(self.sort[0..(n-1)])
   end
 
   # The Same as compact but remove empty string too
+  # see #compact
+  # == Params:
+  #     none
+  # == Returns:
+  #     compacti: (Array) compacted array
   def compacti
-    return self.map{|e| e = nil if e == "" ; e}.compact
+    return self.map{|e| e == "" ? nil : e}.compact
   end
+
+  # see #compacti
   def compacti!
     return self.replace(self.compacti)
   end

data/lib/rubyhelper/gem-version.rb

@@ -1,3 +1,3 @@
 module RubyHelper
-  VERSION = '1.1'
+  VERSION = '1.1.1'
 end

data/lib/rubyhelper/numeric.rb

@@ -4,10 +4,15 @@
 module NumericHelper
 
   # get - or + function of the sign of the integer
+  # == Params:
+  #     none
+  # == Returns:
+  #     none
   def sign
     return (self < 0) ? ("-") : ("+")
   end
 
+  # Get the self value or minimum_value if greater than self
   # == Errors:
   #	- ArgumentError : if the passed value is not an integer
   # == Returns:
@@ -20,6 +25,7 @@ module NumericHelper
     return self.replace(self.min(minimum_value))
   end
 
+  # Get the self value or maximum_value if lesser than self
   # == Errors:
   #	- ArgumentError : if the passed value is not an integer
   # == Returns:

data/lib/rubyhelper/string.rb

@@ -5,26 +5,42 @@ require 'digest'
 
 module StringHelper
 
+  # Force utf-8 encoding (shortcut ;) ! )
   # == Params:
   #     - replace: (String) replace invalids chars by other chas
+  # == Returns:
+  #     - self: (String) utf-8 string
   def utf8 replace=''
     return self.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: replace)
   end
+
+  # see #utf8
   def utf8!
     return self.replace(self.utf8)
   end
 
-  # UTF-8 encoding and replace invalid chars, Remove accents from the string. Change the case as first argument if not nil
+  # UTF-8 encoding and replace invalid chars.
+  # Remove accents from the string (convert to ASCII chars !)
+  # And then, change the case as first argument if not nil
   # == Params:
   #     - case_mod: nil (not changement), :upcase, :capitalize or :downcase
   #     - replace: (String) if a char is not utf8 valid, character will replace it
+  # == Returns:
+  #     - self: (String)
   def to_plain(case_mod = nil, replace='')
     return self.p(replace).utf8(replace).to_case(case_mod)
   end
 
+  # see #to_plain
+  def to_plain!(case_mod = nil, replace='')
+    return self.replace(self.to_plain(case_mod, replace))
+  end
+
   # Remove accents from the string, and replace it by the same letter in ASCII
   # == Params:
   #     - replace: (String) replace by character default case
+  # == Returns:
+  #     - self: (String)
   def p(replace='')
     begin
       return self.tr("ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž",
@@ -33,8 +49,10 @@ module StringHelper
       return self.utf8(replace)
     end
   end
-  def p!
-    return self.replace(self.p)
+
+  # see #p
+  def p!(replace='')
+    return self.replace(self.p(replace))
   end
 
   # permit to do upcase/downcase/capitalize easier with a simple param
@@ -52,6 +70,8 @@ module StringHelper
       return self
     end
   end
+
+  # see #to_case
   def to_case!(case_mod = :downcase)
     return self.replace(self.to_case(case_mod))
   end
@@ -61,6 +81,8 @@ module StringHelper
   # == Params:
   #     - replace: a caracter to replace non-ascii chars
   #     - case_mod: nil (not changement), :upcase, :capitalize or :downcase
+  # == Returns:
+  #     - self: (String)
   def to_ascii(replace="", case_mod = nil)
     s = String.new
     self.p.each_char do |c|
@@ -70,21 +92,28 @@ module StringHelper
   end
 
   # improvement of to_f to count "," caracter as "."
-  def to_f
-    s = self.dup
-    self.gsub!(',', '.')
-    f = super
-    self.replace(s)
-    return f
+  # == Params:
+  #       none
+  # == Returns:
+  #     - float: (Float)
+  def to_fi
+    return self.gsub(',', '.').to_f
   end
 
-  # to_i with delimiter
+  # to_i with delimiter to remove
   # Example : "12.000.000".to_ii => 12000000
+  # == Params:
+  #     - char: char to delete (default : ' ')
+  # == Returns:
+  #     - integer: (Integer)
+  # == Errors:
+  #     ArgumentError: If (param char) is not a String
   def to_ii(char=' ')
-    self.delete(char.to_s).to_i
+    raise ArgumentError, "Argument is not a String" unless char.is_a? String
+    self.delete(char).to_i
   end
 
-  #CRYXOR (one time pad dirt application)
+  # CRYXOR (one time pad dirt application)
   def ^(k)
     str = ""
     self.size.times do |i|
@@ -93,10 +122,13 @@ module StringHelper
     return str
   end
 
-  #SHA2 shortcuts
+  # SHA2 shortcuts
+  # see #Digest::SHA2.hexdigest
   def sha2
     Digest::SHA2.hexdigest(self)
   end
+
+  # see #sha2
   def sha2!
     return self.replace(self.sha2)
   end
@@ -139,6 +171,10 @@ module StringHelper
   end
 
   #Returns true or false if the string if "true" or "false". else nil
+  # == Params:
+  #       none
+  # == Returns:
+  #     - true/false
   def to_t
     case self
     when "true"
@@ -153,10 +189,14 @@ module StringHelper
   #get only the digits and symbols in the string
   # == Params:
   #     - sign: (true/false) if true, keep the - and + signs
+  # == Return:
+  #     epured_string: (String)
   def get_int(sign = true)
     return self.gsub(/[^\-\+\d]/, "") if sign == true
     return self.gsub(/[^\d]/, "")
   end
+
+  # see #get_int
   def get_int!(sign = true)
     return self.replace(self.get_int(sign))
   end
@@ -164,18 +204,28 @@ module StringHelper
   #as get_int but with . and ,
   # == Params:
   #     - sign: (true/false) if true, keep the - and + signs
+  # == Returns:
+  #     epured_string: (String)
   def get_float(sign = true)
     return self.gsub(/[^\-\+\d\.\,]/, "") if sign == true
     return self.gsub(/[^\d\.\,]/, "") if sign == true
   end
+
+  # see #get_float
   def get_float!(sign = true)
     return self.replace(self.get_float(sign))
   end
 
-  # Capitalize a sequence
+  # Capitalize a sequence (each word)
+  # == Params:
+  #       none
+  # == Returns:
+  #     capitalized_string: (String)
   def scapitalize
     return self.split.map(&:capitalize).join(' ')
   end
+
+  # see #scapitalize
   def scapitalize!
     return self.replace(self.scapitalize)
   end

data/test/test_array.rb

@@ -29,7 +29,6 @@ class ArrayHelperTest < Minitest::Test
   end
 
   def test_maxs
-    assert_equal([44], [2,3,1,14,44,-1,1,2].maxs(0))
     assert_equal([44], [2,3,1,14,44,-1,1,2].maxs(1))
     assert_equal([14,44], [2,3,1,14,44,-1,1,2].maxs(2))
     assert_equal([-1,1,1,2,2,3,14,44], [2,3,1,14,44,-1,1,2].maxs(100))

data/test/test_string.rb

@@ -32,13 +32,13 @@ class StringHelperTest < Minitest::Test
     assert_equal("bonjour€".to_ascii("."), "bonjour.")
   end
 
-  def test_to_f
-    assert_equal("bonjour".to_f, 0.0)
-    assert_equal("bonj1our".to_f, 0.0)
-    assert_equal("1.1.1".to_f, 1.1)
-    assert_equal("1.1".to_f, 1.1)
-    assert_equal("1,1".to_f, 1.1)
-    assert_equal(",1,1".to_f, 0.1)
+  def test_to_fi
+    assert_equal("bonjour".to_fi, 0.0)
+    assert_equal("bonj1our".to_fi, 0.0)
+    assert_equal("1.1.1".to_fi, 1.1)
+    assert_equal("1.1".to_fi, 1.1)
+    assert_equal("1,1".to_fi, 1.1)
+    assert_equal(",1,1".to_fi, 0.1)
   end
 
   def test_to_ii

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyhelper
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: 1.1.1
 platform: ruby
 authors:
 - poulet_a