rubyhelper 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6851b40a4cf69a6d0a3754db488f38a3e5f7938
-  data.tar.gz: 53db33d7c1fa2860abdf3f63c3561f92d93872f4
+  metadata.gz: 6242a9c09772908bd881caa26336e4120863798b
+  data.tar.gz: 86964bfc7655e99f129dd20d7cf468235ff1ba6e
 SHA512:
-  metadata.gz: c6cc4317fb023e6e2c0026c3fb50e7b37d56d13242fb27337fc9f4bba49dbf63ae2614d3d21a1b40c9a83ef415b3dff853633191798d902b925b1aa2d405c354
-  data.tar.gz: e7ff30b52e7a1f85692993e871359c533b5dc9d87a1ecfd10345d6242cfb0bd96675fd05d2a2e8a1f12441c33eae7eb3fe285cf166f6d898b296e9234eecf553
+  metadata.gz: cfb803191d145419ff2ce8c14a68eb8eeb5f9ad044b72b41d8fa2326603b5000671b90c7a09f3b336a6907fe5dcb6dfc812c97579fbe79a3f77c97ac5bb467ae
+  data.tar.gz: 5664d87ecbc59fd7312574231cfe623d11907b62200427db000d834fb750389bebfde43139e2f0bbe4d0077692f00f963194ab8b908962be9a6ef1b3b7c151bb

data/README.md

@@ -39,15 +39,16 @@ in this gem ;)
 The following sources code is not only my stuff, but also an implementation of
 idea found on stackoverflow, ...  
 
-The developpement running like that :
-1. Found idea
-2. Put it in the gem
-3. Developpe few tests
-4. Push it in a unstable gem (like v1.0.alpha1)
-5. **repeat 1-4 actions few times**
-6. Improve tests
-7. Validate the version
-8. Push new "stable" version (like v1.1)
+The developpement running like that :  
+1. Found idea  
+2. Put it in the gem  
+3. Developpe few tests  
+4. Push it in a unstable gem (like v1.0.alpha1)  
+5. **repeat 1-4 actions few times**  
+6. Improve tests  
+7. Validate the version  
+8. Push the version into master branch and tag it  
+9. Push new "stable" version (like v1.1)  
 
 Note about the first time developpement :  
 I didn't predict to keep this gem in dev so the first part of the dev

data/lib/rubyhelper/array.rb

@@ -5,12 +5,10 @@ module ArrayHelper
   # This function return a pretty good string. Like join but with an array
   # You can use an array as separator : [",", " "] will successively ',' and ' '
   # Exemple : ["a", "b", "c"].joini(["x", "y"]) => "axbyc"
-  # == Errors:
-  #     - ArgumentError : if sep in not an array
-  # == Params:
-  #     - sep: (Array) array of separator
-  # == Returns:
-  #     - str: (String) string joined
+  #
+  # @raise [ArgumentError] if sep in not an array
+  # @param sep [Array] array of separator
+  # @return [String] string joined
   def joini sep
     raise ArgumentError, 'Argument is not an array' unless sep.is_a? Array
     str = String.new
@@ -25,47 +23,38 @@ 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)
+  #
+  # @return [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)
+  #
+  # @return [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.
-  # == Params:
-  #     none
-  # == Returns:
-  #     average: (Integer) self.sum / self.size. 0 if no elements
+  #
+  # @return [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
+  #
+  # @return [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
 
   # 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
+  #
+  # @raise [ArgumentError] if n in not an integer
+  # @raise [ArgumentError] if n is lesser than 1
+  # @param n [Integer] number of elements
   def maxs(n=1)
     raise ArgumentError, 'Argument is not an integer' unless n.is_a? Integer
     raise ArgumentError, 'Argument is lesser than 1' unless n >= 1
@@ -74,11 +63,10 @@ module ArrayHelper
   end
 
   # 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
+  #
+  # @raise [ArgumentError] if n in not an integer
+  # @raise [ArgumentError] if n is lesser than 1
+  # @param 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
@@ -89,15 +77,15 @@ module ArrayHelper
 
   # The Same as compact but remove empty string too
   # see #compact
-  # == Params:
-  #     none
-  # == Returns:
-  #     compacti: (Array) compacted array
+  #
+  # @return [Array] compacted array
   def compacti
     return self.map{|e| e == "" ? nil : e}.compact
   end
 
-  # see #compacti
+  # see {#compacti}
+  #
+  # @return [Array]
   def compacti!
     return self.replace(self.compacti)
   end

data/lib/rubyhelper/gem-version.rb

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

data/lib/rubyhelper/hash.rb

@@ -1,11 +1,15 @@
 module HashHelper
 
   # Return a hash that includes everything but the given keys.
+  #
+  # @return [Hash]
   def except(*keys)
     return self.dup.except!(*keys)
   end
 
   # Replaces the hash without the given keys.
+  #
+  # @return [Hash]
   def except!(*keys)
     keys.each { |key| self.delete(key) }
     return self

data/lib/rubyhelper/numeric.rb

@@ -4,36 +4,42 @@
 module NumericHelper
 
   # get - or + function of the sign of the integer
-  # == Params:
-  #     none
-  # == Returns:
-  #     none
-  def sign
-    return (self < 0) ? ("-") : ("+")
+  #
+  # @param plus [Object] a value if self >= 0
+  # @param less [Object] a value if self < 0
+  # @return [Object] the param plus or less if self >= 0 or < 0
+  def sign(plus="+", less="-")
+    return (self < 0) ? (less) : (plus)
   end
 
   # Get the self value or minimum_value if greater than self
-  # == Errors:
-  #	- ArgumentError : if the passed value is not an integer
-  # == Returns:
-  #	- value: (Numeric) self if self >= min else min
+  #
+  # @raise [ArgumentError] if the passed value is not an integer
+  # @return [Numeric] self if self >= min else min
   def min(minimum_value)
     raise ArgumentError unless minimum_value.is_a? Numeric
     return self >= minimum_value ? self : minimum_value
   end
+
+  # see {#min}
+  #
+  # @return [Numeric]
   def min!(minimum_value)
     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:
-  #	- value: (Numeric) self if self <= max else max
+  #
+  # @raise [ArgumentError] if the passed value is not an integer
+  # @return [Numeric] self if self <= max else max
   def max(maximum_value)
     raise ArgumentError unless maximum_value.is_a? Numeric
     return self <= maximum_value ? self : maximum_value
   end
+
+  # see {#max}
+  #
+  # @return [Numeric]
   def max!(maximum_value)
     return self.replace(self.min(maximum_value))
   end

data/lib/rubyhelper/string.rb

@@ -6,15 +6,16 @@ require 'digest'
 module StringHelper
 
   # Force utf-8 encoding (shortcut ;) ! )
-  # == Params:
-  #     - replace: (String) replace invalids chars by other chas
-  # == Returns:
-  #     - self: (String) utf-8 string
+  #
+  # @param replace [String] replace invalids chars by other chas
+  # @return [String] utf-8 string
   def utf8 replace=''
     return self.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: replace)
   end
 
-  # see #utf8
+  # see {#utf8}
+  #
+  # @return [String]
   def utf8!
     return self.replace(self.utf8)
   end
@@ -22,25 +23,25 @@ module StringHelper
   # 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)
+  #
+  # @param case_mod [Symbol] :upcase, :capitalize or :downcase or nil for no case change
+  # @param replace [String] if a char is not utf8 valid, character will replace it
+  # @return [String] self changed
   def to_plain(case_mod = nil, replace='')
     return self.p(replace).utf8(replace).to_case(case_mod)
   end
 
-  # see #to_plain
+  # see {#to_plain}
+  #
+  # @return [String]
   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)
+  #
+  # @param replace [String] replace by character default case
+  # @return [String] self cahnged
   def p(replace='')
     begin
       return self.tr("ÀÁÂÃÄÅàáâãäåĀāĂ㥹ÇçĆćĈĉĊċČčÐðĎďĐđÈÉÊËèéêëĒēĔĕĖėĘęĚěĜĝĞğĠġĢģĤĥĦħÌÍÎÏìíîïĨĩĪīĬĭĮįİıĴĵĶķĸĹĺĻļĽľĿŀŁłÑñŃńŅņŇňʼnŊŋÒÓÔÕÖØòóôõöøŌōŎŏŐőŔŕŖŗŘřŚśŜŝŞşŠšſŢţŤťŦŧÙÚÛÜùúûüŨũŪūŬŭŮůŰűŲųŴŵÝýÿŶŷŸŹźŻżŽž",
@@ -50,14 +51,17 @@ module StringHelper
     end
   end
 
-  # see #p
+  # see {#p}
+  #
+  # @return [String]
   def p!(replace='')
     return self.replace(self.p(replace))
   end
 
   # permit to do upcase/downcase/capitalize easier with a simple param
-  # == Params:
-  #     - case_mod: nil (not changement), :upcase, :capitalize or :downcase
+  #
+  # @param case_mod [Symbol] :upcase, :capitalize or :downcase or nil if no case change
+  # @return [String] self changed
   def to_case(case_mod = :downcase)
     case case_mod
     when :upcase
@@ -71,18 +75,19 @@ module StringHelper
     end
   end
 
-  # see #to_case
+  # see {#to_case}
+  #
+  # @return [String]
   def to_case!(case_mod = :downcase)
     return self.replace(self.to_case(case_mod))
   end
 
   # Return a simple ascii string. Invalid characters will be replaced by "replace" (argument)
   # Accents are removed first and replaced by the equivalent ASCII letter
-  # == Params:
-  #     - replace: a caracter to replace non-ascii chars
-  #     - case_mod: nil (not changement), :upcase, :capitalize or :downcase
-  # == Returns:
-  #     - self: (String)
+  #
+  # @param replace [String] a caracter to replace non-ascii chars
+  # @param case_mod [Symbol] :upcase, :capitalize or :downcase or nil if no case change
+  # @return [String] self changed
   def to_ascii(replace="", case_mod = nil)
     s = String.new
     self.p.each_char do |c|
@@ -92,28 +97,26 @@ module StringHelper
   end
 
   # improvement of to_f to count "," caracter as "."
-  # == Params:
-  #       none
-  # == Returns:
-  #     - float: (Float)
+  #
+  # @return [Float] like {Integer#to_f}
   def to_fi
     return self.gsub(',', '.').to_f
   end
 
   # 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
+  #
+  # @param char [String] char to delete (default : ' ')
+  # @return [Integer] like {Integer#to_i]
+  # @raise [ArgumentError] If (param char) is not a String
   def to_ii(char=' ')
     raise ArgumentError, "Argument is not a String" unless char.is_a? String
     self.delete(char).to_i
   end
 
   # CRYXOR (one time pad dirt application)
+  #
+  # @return [String]
   def ^(k)
     str = ""
     self.size.times do |i|
@@ -123,12 +126,16 @@ module StringHelper
   end
 
   # SHA2 shortcuts
-  # see #Digest::SHA2.hexdigest
+  # see {Digest::SHA2#hexdigest}
+  #
+  # @return [String]
   def sha2
     Digest::SHA2.hexdigest(self)
   end
 
-  # see #sha2
+  # see {#sha2}
+  #
+  # @return [String]
   def sha2!
     return self.replace(self.sha2)
   end
@@ -136,12 +143,12 @@ module StringHelper
   # Get a str with a static length.
   # If the str size > n, reduce the str (keep str from the (param place) )
   # You should check the test files for examples
-  # == Params:
-  #     - n: number of char
-  #     - char: char to replace if the initial str is too short
-  #     - place: :begin/:front :end/:back :center/:middle
-  # == Errors:
-  #     - ArgumentError : if n in not an integer/char a String
+  #
+  # @param n [Integer] number of char
+  # @param char [String] char to replace if the initial str is too short
+  # @param place [Symbol] :begin/:front :end/:back :center/:middle
+  # @raise [ArgumentError] if n in not an integer/char a String
+  # @return [String]
   def static(n, char=' ', place= :back)
     raise ArgumentError, 'char is not an Char (String)' unless char.is_a? String
     raise ArgumentError, 'n is not an Integer' unless n.is_a? Integer
@@ -170,11 +177,10 @@ module StringHelper
     return self.replace(self.static(n, char))
   end
 
-  #Returns true or false if the string if "true" or "false". else nil
-  # == Params:
-  #       none
-  # == Returns:
-  #     - true/false
+  # Returns true or false if the string if "true" or "false". else nil
+  #
+  # @return [TrueClass]
+  # @return [FalseClass]
   def to_t
     case self
     when "true"
@@ -186,46 +192,48 @@ module StringHelper
     end
   end
 
-  #get only the digits and symbols in the string
-  # == Params:
-  #     - sign: (true/false) if true, keep the - and + signs
-  # == Return:
-  #     epured_string: (String)
+  # get only the digits and symbols in the string
+  #
+  # @param sign (true/false) if true, keep the - and + signs
+  # @return [String] epured string
   def get_int(sign = true)
     return self.gsub(/[^\-\+\d]/, "") if sign == true
     return self.gsub(/[^\d]/, "")
   end
 
   # see #get_int
+  #
+  # @return [String]
   def get_int!(sign = true)
     return self.replace(self.get_int(sign))
   end
 
-  #as get_int but with . and ,
-  # == Params:
-  #     - sign: (true/false) if true, keep the - and + signs
-  # == Returns:
-  #     epured_string: (String)
+  # as get_int but with . and ,
+  #
+  # @param sign (true/false) if true, keep the - and + signs
+  # @return [String] epured_string
   def get_float(sign = true)
     return self.gsub(/[^\-\+\d\.\,]/, "") if sign == true
     return self.gsub(/[^\d\.\,]/, "") if sign == true
   end
 
-  # see #get_float
+  # see {#get_float}
+  #
+  # @return [String]
   def get_float!(sign = true)
     return self.replace(self.get_float(sign))
   end
 
   # Capitalize a sequence (each word)
-  # == Params:
-  #       none
-  # == Returns:
-  #     capitalized_string: (String)
+  #
+  # @return [String] capitalized_string
   def scapitalize
     return self.split.map(&:capitalize).join(' ')
   end
 
-  # see #scapitalize
+  # see {#scapitalize}
+  #
+  # @return [String]
   def scapitalize!
     return self.replace(self.scapitalize)
   end

data/lib/rubyhelper/versionhelper.rb

@@ -8,13 +8,12 @@ module VersionHelper
 
     attr_accessor :v
 
-    # == Params:
-    #	- arg : list of arguments
-    #		Integer : 1234 => 1.2.3.4
-    #		String : "1.2-3" => 1.2.3
-    #		Array : like multiple arguments
-    #		multiple : each argument is converted to a number
-    #			1,2,3 => 1.2.3
+    # [Integer] : 1234 => 1.2.3.4
+    # [String] : "1.2-3" => 1.2.3
+    # [Array] : like multiple arguments
+    # [multiple] : each argument is converted to a number 1,2,3 => 1.2.3
+    #
+    # @param arg : list of arguments
     def initialize(*arg)
       @v = []
       if arg.size == 1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyhelper
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - poulet_a
@@ -31,7 +31,7 @@ cert_chain:
   +lG6tRo8QaFrH3afOmy4VUaG84Jm1XjNYnyaOfLb9ItpcQgVySn2c3aJ2PLcPljM
   EhZUryAiV8KNMQ==
   -----END CERTIFICATE-----
-date: 2014-09-06 00:00:00.000000000 Z
+date: 2014-09-07 00:00:00.000000000 Z
 dependencies: []
 description: A list of utils for the basic Class of ruby.
 email: