rubyhelper 1.1.3 → 1.2.alpha4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3192a8632a7143e103b0d450d621b7a0ccc98714
-  data.tar.gz: 3b1ca16f63de0e40476cdcb8e9375932d9fc1ef0
+  metadata.gz: 05ffe2c5c0a58b713e88bed0da93ef7fa9c70089
+  data.tar.gz: 77d379e1f9aa30492c732b7071c1a7e3f9345ff8
 SHA512:
-  metadata.gz: 22972314718f28dd69b5ea61e8e1f30c669a7dc8075ba5a265a7b4ea925cca2c37a9b0778df69126e17b23bc3693e51f25d9b4078ada4d6c61cae0b17f141b4f
-  data.tar.gz: 6f59cf81f21ddab38030023762852e8076c3cf4f3d97b9f992b050359850ba3d1d4b75d2a1066f61c7f17357c39e0d89ac44d2568912e2d28048ad51e7dea227
+  metadata.gz: 90ad32b9aeb04d6bc9c24968d0f6d0e35718d05fe3e3f565284a42a57cb9d6d2dd51d064d9230a3e1e41342322d52d08e9d0b5dc9e36f70799df9ddad254c3d8
+  data.tar.gz: b4b17b5381d554c56c4c2d5760ddb0e31554902eacbb93372cfd0cf3d7751579e87da693bc5e32b91d474ef50366b75edcc5d9954b320099fe5b7562996708dd

data/README.md

@@ -1,22 +1,27 @@
 # rubyhelper
 
-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)  
+Last Stable Gem [![Gem Version](https://badge.fury.io/rb/rubyhelper.svg)](http://badge.fury.io/rb/rubyhelper)  
+
+- Last release	v1.1	=> see the branch #master  
+- Last dev	v1.2	=> see the branch #dev  
+
+You can see the documentation here : http://rubydoc.info/gems/rubyhelper  
+The source code is available here  : https://gitlab.com/poulet_a/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.  
 Too use the gem, install it :
-```
+```bash
 $ gem install rubyhelper # install the last stable version
 ```
 
 To use it in your ruby project, use
-```
+```ruby
 require 'rubyhelper'
 ```
 
+
 ## Wtf ?
 This gem is my own creation. It is a compilation of shortcuts, improvement,
 helpers about the basic classes, String, Array, ... to make your work easier.  
@@ -56,17 +61,17 @@ is a little messy. Don't look back 1.1 ;)
 
 
 # TODO
-## Benchmark
+### Benchmark
 - Hash.except with  
-	```
+	```ruby
 		h.delete_if{|k| [:a].include? k}
 	```  
 
-## Improve VersionHelper
+### Improve VersionHelper
 - Add test
 - Add more documentation
 
-## Improve main tests
+### Improve main tests
 - Add few tests for untested features
 - Improve existing tests (mainly on StringHelper)
 

data/lib/rubyhelper/array.rb

@@ -23,27 +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
+  # If the argument toadd is no nill, then the self.size firsts elements
+  # will be added to self and returned
+  # examples: [1,2,3].sum([1,1]) => [2,3,3]
+  # examples: [1,2].sum([1,1,1]) => [2,3]
   #
+  # @param toadd [Array] if not nil, the array will be added
   # @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)
+  # @return [Array] an array wich contain the sum of a1[i] + a2[i]
+  def sum(toadd=nil)
+    return (self.size > 0) ? (self.map{|e| e.to_s.to_i}.reduce(:+)) : (0) if toadd.nil?
+    raise ArgumentError, 'Argument is not an Array' unless toadd.is_a? Array
+    return self.zip(toadd).map{|pair| pair.map{|e| e.to_s.to_i}.reduce(&:+) }
   end
 
-  # lke sum by with a to_f instead of to_i
+  # like {#sum} by with a to_f instead of to_i
   #
   # @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)
+  # @return [Array] an array wich contain the sum of a1[i] + a2[i]
+  def sumf(toadd=nil)
+    return (self.size > 0) ? (self.map{|e| e.to_s.to_f}.reduce(:+)) : (0.0) if toadd.nil?
+    raise ArgumentError, 'Argument is not an Array' unless toadd.is_a? Array
+    return self.zip(toadd).map{|pair| pair.map{|e| e.to_s.to_f}.reduce(&:+) }
   end
 
-  # Use the sum and divide by the size of the array.
+  # Use the {#sum} and divide by the size of the array.
   #
   # @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
+  # Same than {#average} but use to_f instead of to_i
   #
   # @return [Float] self.sumf / self.size. 0.0 if no elements
   def averagef
@@ -75,7 +86,7 @@ module ArrayHelper
     return Array(self.sort[0..(n-1)])
   end
 
-  # The Same as compact but remove empty string too
+  # Same as {#compact} but remove empty string too
   # see #compact
   #
   # @return [Array] compacted array
@@ -90,6 +101,13 @@ module ArrayHelper
     return self.replace(self.compacti)
   end
 
+  # [:a, :b, :c, 1, 2, 3] => [[:a, 1], [:b, 2], [:c, 3]]
+  # [:a, :b, :c, :d, 1, 2, 3] => [[:a, 1], [:b, 2], [:c, 3], [:d, nil]]
+  # [:a, :b, :c, 1, 2, 3, 4] => [[:a, 2], [:b, 3], [:c, 4], [1, nil]]
+  def mirror
+    return self[0..(size/2+size%2-1)].zip(self[(size/2+size%2)..-1])
+  end
+
 end
 
 class Array

data/lib/rubyhelper/gem-version.rb

@@ -1,3 +1,3 @@
 module RubyHelper
-  VERSION = '1.1.3'
+  VERSION = '1.2.alpha4'
 end

data/lib/rubyhelper/string.rb

@@ -5,17 +5,21 @@ require 'digest'
 
 module StringHelper
 
+  # TODO : raise error on invalid utf-8 param replace
   # Force utf-8 encoding (shortcut ;) ! )
   #
+  # @raise [ArgumentError] if replace is not a String
   # @param replace [String] replace invalids chars by other chas
   # @return [String] utf-8 string
   def utf8 replace=''
+    raise ArgumentError, 'replace is not a valid char (String)' unless replace.is_a? String
     return self.encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: replace)
   end
 
   # see {#utf8}
   #
-  # @return [String]
+  # @raise [ArgumentError] if replace is not a String (via {#utf8})
+  # @return [String] utf-8 valid string
   def utf8!
     return self.replace(self.utf8)
   end
@@ -24,15 +28,17 @@ module StringHelper
   # Remove accents from the string (convert to ASCII chars !)
   # And then, change the case as first argument if not nil
   #
+  # @raise [ArgumentError] if replace is not a String (via {#p} and {#utf8})
   # @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
+  # @return [String] self changed without accents and non-utf-8 chars
   def to_plain(case_mod = nil, replace='')
     return self.p(replace).utf8(replace).to_case(case_mod)
   end
 
   # see {#to_plain}
   #
+  # @raise [ArgumentError] if replace is not a String (via {#to_plain})
   # @return [String]
   def to_plain!(case_mod = nil, replace='')
     return self.replace(self.to_plain(case_mod, replace))
@@ -41,6 +47,7 @@ module StringHelper
   # Remove accents from the string, and replace it by the same letter in ASCII
   # Note : it doesn't remove non ASCII characters
   #
+  # @raise [ArgumentError] if replace is not a String (via {#utf8})
   # @param replace [String] replace by character default case
   # @return [String] self cahnged
   def p(replace='')
@@ -54,6 +61,7 @@ module StringHelper
 
   # see {#p}
   #
+  # @raise [ArgumentError] if replace is not a String (via {#p})
   # @return [String]
   def p!(replace='')
     return self.replace(self.p(replace))
@@ -61,8 +69,8 @@ module StringHelper
 
   # permit to do upcase/downcase/capitalize easier with a simple param
   #
-  # @param case_mod [Symbol] :upcase, :capitalize or :downcase or nil if no case change
-  # @return [String] self changed
+  # @param case_mod [Symbol] :upcase, :capitalize, :classic or :downcase or nil if no case change. The capitalize correspond to {#scapitalize} and classic to {#capitalize}
+  # @return [String] self changed to downcase, upcase, capitalize or classic_capitalize
   def to_case(case_mod = :downcase)
     case case_mod
     when :upcase
@@ -70,6 +78,8 @@ module StringHelper
     when :downcase
       return self.downcase
     when :capitalize
+      return self.scapitalize
+    when :classic
       return self.capitalize
     else
       return self
@@ -85,14 +95,17 @@ module StringHelper
 
   # Return a simple ascii string. Invalid characters will be replaced by "replace" (argument)
   # Accents are removed first and replaced by the equivalent ASCII letter (example : 'é' => 'e')
+  # no raise error on {#p} because of default doesn't let it happen ;)
   #
+  # @raise [ArgumentError] if replace is not a String char
   # @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)
+  def to_ascii(replace='', case_mod = nil)
+    raise ArgumentError, "Argument replace is not a String char" unless replace.is_a? String
     s = String.new
     self.p.each_char do |c|
-      s += ((c.ord > 255) ? (replace.to_s) : (c))
+      s += ((c.ord > 255) ? (replace) : (c))
     end
     return s.to_case(case_mod)
   end
@@ -117,8 +130,10 @@ module StringHelper
 
   # CRYXOR (one time pad dirt application)
   #
-  # @return [String]
+  # @raise [ArgumentError] if key is not a valid String
+  # @return [String] encrypted mail
   def ^(k)
+    raise ArgumentError, "The key MUST BE a String" unless key.is_a? String
     str = ""
     self.size.times do |i|
       str << (self[i].ord ^ k[i % k.size].ord).chr
@@ -129,7 +144,7 @@ module StringHelper
   # SHA2 shortcuts
   # see {Digest::SHA2#hexdigest}
   #
-  # @return [String]
+  # @return [String] the sha2 hash value of self
   def sha2
     Digest::SHA2.hexdigest(self)
   end
@@ -144,11 +159,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
+  # Note : {#center} {#left} and {#right} do a similar work.
   #
+  # @raise [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
@@ -174,14 +190,18 @@ module StringHelper
       end
     end
   end
+
+  # @raise [ArgumentError] via {#static}
+  # see {#static}
   def static!(n, char=' ')
     return self.replace(self.static(n, char))
   end
 
   # Returns true or false if the string if "true" or "false". else nil
   #
-  # @return [TrueClass]
-  # @return [FalseClass]
+  # @return [TrueClass] on self == "true"
+  # @return [FalseClass] on self == "false"
+  # @return [NilClass] else
   def to_t
     case self
     when "true"
@@ -193,6 +213,18 @@ module StringHelper
     end
   end
 
+  # @return [TrueClass] if self == "true"
+  # @return [FalseClass] else
+  def true?
+    return (self == "true")
+  end
+
+  # @return [TrueClass] on self == "false"
+  # @return [FalseClass] else
+  def false?
+    return (self == "false")
+  end
+
   # get only the digits and symbols in the string
   #
   # @param sign (true/false) if true, keep the - and + signs

data/rubyhelper.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.name        = 'rubyhelper'
   s.version     = RubyHelper::VERSION
   s.date        = Time.now.getgm.to_s.split.first
-  s.summary     = "hotfix (remove pry requirement)"
+  s.summary     = "First real release :) 1.1 with fix doc, fix tests, certification, ..."
   s.description = "A list of utils for the basic Class of ruby."
   s.authors     = [
             	  "poulet_a"
@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
 		  "test/test_string.rb",
 		  "test/test_versionhelper.rb",
 		  ]
-  s.homepage    = "https://gitlab.com/Sopheny/rubyhelper"
+  s.homepage    = "https://gitlab.com/poulet_a/rubyhelper"
   s.license     = "GNU/GPLv3"
   s.cert_chain  = ['certs/poulet_a.pem']
   s.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $0 =~ /gem\z/

data/test/test_array.rb

@@ -14,10 +14,20 @@ class ArrayHelperTest < Minitest::Test
     assert_equal(0, [].sum)
   end
 
+  def test_sum_with_array
+    assert_equal([2,3,4], [1,2,3].sum([1,1,1]))
+    assert_equal([2,3,3], [1,2,3].sum([1,1]))
+    assert_equal([2,3], [1,2].sum([1,1,1]))
+    assert_equal([], [].sum([1,1,1]))
+    assert_equal([1,1,1,3,1,5], [1,1,2,2,3,3].sum([0, 0,-1,+1,-2,+2]))
+  end
+
   def test_sumf
     assert_equal(12.0, [1,2, 9].sumf)
     assert_equal(0.1, [0.01, 0.09, -0, -1, 1.1, -0.1].sumf.round(2))
     assert_equal(0.0, [].sumf)
+    assert_equal([2.0,3.0], [1,2].sumf([1,1,1]))
+    assert_equal([], [].sumf([1,1,1]))
   end
 
   def test_average
@@ -38,4 +48,11 @@ class ArrayHelperTest < Minitest::Test
     assert_equal([" "], ["", " ", nil].compacti)
   end
 
+  # + maths : ok
+  def test_mirror
+   assert_equal([[:a, 1], [:b, 2], [:c, 3]], [:a, :b, :c, 1, 2, 3].mirror)
+   assert_equal([[:a, 1], [:b, 2], [:c, 3], [:d, nil]], [:a, :b, :c, :d, 1, 2, 3].mirror)
+   assert_equal([[:a, 2], [:b, 3], [:c, 4], [1, nil]], [:a, :b, :c, 1, 2, 3, 4].mirror)
+  end
+
 end

data/test/test_string.rb

@@ -5,54 +5,60 @@ require_relative '../lib/rubyhelper'
 class StringHelperTest < Minitest::Test
 
   def test_to_plain
-    assert_equal("bonjour".to_plain, "bonjour")
-    assert_equal("bonjouré".to_plain, "bonjoure")
-    assert_equal("bonjo\\AAAur".to_plain, "bonjo\\AAAur")
-    assert_equal("bonjo€".to_plain, "bonjo")
+    assert_equal("bonjour", "bonjour".to_plain)
+    assert_equal("bonjoure", "bonjouré".to_plain, "bonjoure")
+    assert_equal("bonjo\\AAAur", "bonjo\\AAAur".to_plain)
+    assert_equal("bonjo", "bonjo€".to_plain)
   end
 
   def test_p
-    assert_equal("bonjour".p, "bonjour")
-    assert_equal("bonjouré".p, "bonjoure")
-    assert_equal("bonjo\\AAAur".p, "bonjo\\AAAur")
-    assert_equal("bonjo€".p, "bonjo€")
+    assert_equal("bonjour", "bonjour".p)
+    assert_equal("bonjoure", "bonjouré".p)
+    assert_equal("bonjo\\AAAur", "bonjo\\AAAur".p)
+    assert_equal("bonjo€", "bonjo€".p)
   end
 
-  def test_to_case
-    assert_equal("bonjour".to_case(:downcase), "bonjour")
-    assert_equal("bonJour".to_case(:upcase), "BONJOUR")
-    assert_equal("bonJour".to_case(:capitalize), "Bonjour")
+  def test_to_case_downcase
+    assert_equal("bonjour", "bonJoUr".to_case(:downcase))
+    assert_equal("bonjour toi", "bonJoUr tOI".to_case(:downcase))
+  end
+
+  def test_to_case_upcase
+    assert_equal("BONJOUR", "bonJoUr".to_case(:upcase))
+    assert_equal("BONJOUR TOI", "bonJoUr tOI".to_case(:upcase))
+  end
+
+  def test_to_case_capitalize
+    assert_equal("Bonjour", "bonJoUr".to_case(:capitalize))
+    assert_equal("Bonjour Toi", "bonJoUr tOI".to_case(:capitalize))
+  end
+
+  def test_to_case_classic
+    assert_equal("Bonjour", "bonJoUr".to_case(:classic))
+    assert_equal("Bonjour toi", "bonJoUr tOI".to_case(:classic))
   end
 
   def test_to_ascii
-    assert_equal("bonjoure".to_ascii(""), "bonjoure")
-    assert_equal("bonjouré".to_ascii(""), "bonjoure")
-    assert_equal("bonjouré".to_ascii("."), "bonjoure")
-    assert_equal("bonjour€".to_ascii(""), "bonjour")
-    assert_equal("bonjour€".to_ascii("."), "bonjour.")
+    assert_equal("bonjoure", "bonjoure".to_ascii(""))
+    assert_equal("bonjoure", "bonjouré".to_ascii(""))
+    assert_equal("bonjoure", "bonjouré".to_ascii("."))
+    assert_equal("bonjour", "bonjour€".to_ascii(""))
+    assert_equal("bonjour.", "bonjour€".to_ascii("."))
   end
 
   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)
+    assert_equal(0.0, "bonjour".to_fi)
+    assert_equal(0.0, "bonj1our".to_fi)
+    assert_equal(1.1, "1.1.1".to_fi)
+    assert_equal(1.1, "1.1".to_fi)
+    assert_equal(1.1, "1,1".to_fi)
+    assert_equal(0.1, ",1,1".to_fi)
   end
 
   def test_to_ii
-    assert_equal("1 1".to_ii(), 11)
-    assert_equal("06.08.68".to_ii("."), 60868)
-    assert_equal("06.08.68".to_ii("\. \t\-"), 60868)
-  end
-
-  def test_to_t
-    assert_equal("true".to_t, true)
-    assert_equal("false".to_t, false)
-    assert_equal("truex".to_t, nil)
-    assert_equal("xfalsex".to_t, nil)
-    assert_equal("".to_t, nil)
+    assert_equal(11, "1 1".to_ii())
+    assert_equal(60868, "06.08.68".to_ii("."))
+    assert_equal(60868, "06.08.68".to_ii("\. \t\-"))
   end
 
   def test_static
@@ -72,6 +78,26 @@ class StringHelperTest < Minitest::Test
     assert_equal("  bonjour  ", "bonjour".static(11, " ", :center))
   end
 
+  def test_to_t
+    assert_equal(true, "true".to_t)
+    assert_equal(false, "false".to_t)
+    assert_equal(nil, "truex".to_t)
+    assert_equal(nil, "xfalsex".to_t)
+    assert_equal(nil, "".to_t)
+  end
+
+  def test_true?
+    assert_equal(true, "true".true?)
+    assert_equal(false, "false".true?)
+    assert_equal(false, "other".true?)
+  end
+
+  def test_false?
+    assert_equal(false, "true".false?)
+    assert_equal(true, "false".false?)
+    assert_equal(false, "other".false?)
+  end
+
   def test_get_int
     assert_equal("1312".get_int(), "1312")
     assert_equal("ea -ze 13e12 à nnazdaz d".get_int(), "-1312")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubyhelper
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.alpha4
 platform: ruby
 authors:
 - poulet_a
@@ -72,7 +72,7 @@ files:
 - test/test_numeric.rb
 - test/test_string.rb
 - test/test_versionhelper.rb
-homepage: https://gitlab.com/Sopheny/rubyhelper
+homepage: https://gitlab.com/poulet_a/rubyhelper
 licenses:
 - GNU/GPLv3
 metadata: {}
@@ -87,14 +87,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
-summary: hotfix (remove pry requirement)
+summary: First real release :) 1.1 with fix doc, fix tests, certification, ...
 test_files: []
 has_rdoc: