immosquare-extensions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1d5cf291f00c33bf864785c2bf1b72db5ce0c682292da329aa3bef2cd909df2
+  data.tar.gz: 0d443a7bdb4304e42c7d065085a2a57c84ca57f6ef16078d6ae318953cd80a42
+SHA512:
+  metadata.gz: 8866d06150921a47bd3b23d3b02f65acb3bc51793f55ff1f0097fe29c969a064ed0f61908b792cd1069366a02c6d3312ca5aecee18ace47321a2f357b964ba92
+  data.tar.gz: 5ee4d9ef0ecbb4374cd2dab28baa8e22bb9909e45c19499194d34698056f3133de6382c2e095273bc6b6c6c63b7960b185a260ec14de913b0ac6dc94cc4fa2cb

data/lib/immosquare-extensions/array.rb

@@ -0,0 +1,21 @@
+##============================================================##
+## This extension adds utility methods to the Array class.
+##============================================================##
+class Array
+
+  ##============================================================##
+  ## Calculate the average (mean) of an array of numbers.
+  ## The mean is the sum of the numbers divided by the count.
+  ##
+  ## Reference:
+  ## https://www.chrisjmendez.com/2018/10/14/mean-median-mode-standard-deviation/
+  ##
+  ## Examples:
+  ## [1, 2, 3, 4, 5].mean => 3.0
+  ## [2, 4, 6].mean       => 4.0
+  ##============================================================##
+  def mean
+    sum(0.0) / size
+  end
+
+end

data/lib/immosquare-extensions/hash.rb

@@ -0,0 +1,87 @@
+##============================================================##
+## This extension adds utility methods to the Hash class.
+## It includes methods for handling and manipulating the keys
+## and values of a hash in various ways.
+##============================================================##
+class Hash
+
+  ##============================================================##
+  ## Remove multiple keys from a hash in a single command.
+  ##
+  ## Reference:
+  ## https://apidock.com/ruby/Hash/delete
+  ##
+  ## Examples:
+  ## {a: 1, b: 2, c: 3}.without(:a, :b) => {:c=>3}
+  ##============================================================##
+  def without(*keys)
+    cpy = dup
+    keys.each {|key| cpy.delete(key) }
+    cpy
+  end
+
+  ##============================================================##
+  ## Convert all keys of the hash to lowercase. 
+  ## If a value is an array, it recursively processes the 
+  ## nested hash elements.
+  ##
+  ## Example:
+  ## { "A" => { "B" => "value" } }.downcase_key => {"a"=>{"b"=>"value"}}
+  ##============================================================##
+  def downcase_key
+    keys.each do |k|
+      store(k.downcase, (v = delete(k)).is_a?(Array) ? v.map(&:downcase_key) : v)
+    end
+    self
+  end
+
+  ##============================================================##
+  ## Calculate the depth (or level) of nesting within a hash.
+  ##
+  ## Example:
+  ## {a: {b: {c: 1}}}.depth => 3
+  ##============================================================##
+  def depth
+    1 + values.map {|v| v.is_a?(Hash) ? v.depth : 1 }.max
+  end
+
+  ##============================================================##
+  ## Sort a hash by its keys. If the recursive flag is true, 
+  ## it will sort nested hashes as well.
+  ##
+  ## Reference:
+  ## http://dan.doezema.com/2012/04/recursively-sort-ruby-hash-by-key/
+  ##
+  ## Example:
+  ## {b: 1, a: {d: 4, c: 3}}.sort_by_key(true) => {:a=>{:c=>3, :d=>4}, :b=>1}
+  ##============================================================##
+  def sort_by_key(recursive = false, &block)
+    keys.sort(&block).each_with_object({}) do |key, seed|
+      seed[key] = self[key]
+      seed[key] = seed[key].sort_by_key(true, &block) if recursive && seed[key].is_a?(Hash)
+    end
+  end
+
+  ##============================================================##
+  ## Flatten a nested hash into a single-level hash. Nested keys 
+  ## are represented with dot notation.
+  ##
+  ## Reference:
+  ## https://stackoverflow.com/questions/23521230/flattening-nested-hash-to-a-single-hash-with-ruby-rails
+  ##
+  ## Example:
+  ## {a: {b: {c: 1}}}.flatten_hash => {:a.b.c=>1}
+  ##============================================================##
+  def flatten_hash
+    each_with_object({}) do |(k, v), h|
+      if v.is_a?(Hash)
+        v.flatten_hash.map do |h_k, h_v|
+          h["#{k}.#{h_k}".to_sym] = h_v
+        end
+      else 
+        h[k] = v
+      end
+    end    
+  end
+
+end

data/lib/immosquare-extensions/string.rb

@@ -0,0 +1,53 @@
+require "unicode_utils/upcase"
+
+##============================================================##
+## This extension adds utility methods to the String class.
+##============================================================##
+class String
+
+  ##============================================================##
+  ## Convert the string 'true' to true and 'false' to false.
+  ## Any other value will return nil.
+  ##
+  ## Examples:
+  ## "true".to_boolean  => true
+  ## "false".to_boolean => false
+  ## "random".to_boolean => nil
+  ##============================================================##
+  def to_boolean
+    case downcase
+    when "true"
+      true
+    when "false"
+      false
+    end
+  end
+
+  ##============================================================##
+  ## Provide a custom titleize method to handle strings 
+  ## especially ones with hyphens more appropriately.
+  ## Standard titleize does not preserve hyphens in the desired manner.
+  ##
+  ## Reference:
+  ## https://stackoverflow.com/questions/29784873/titleize-a-hyphenated-name
+  ##
+  ## Examples:
+  ## "SANT-ANDREA-D'ORCINO".titleize_custom => Sant-Andrea-D'orcino
+  ## "SANT-ANDREA-D'ORCINO".titleize        => Sant Andrea D'orcino
+  ##============================================================##
+  def titleize_custom
+    humanize.gsub(/\b('?[a-z])/) { ::Regexp.last_match(1).capitalize }
+  end
+
+  ##============================================================##
+  ## Overriding the standard upcase method to provide a more 
+  ## comprehensive version that correctly handles Unicode characters.
+  ## 
+  ## Example:
+  ## "José".upcase => "JOSÉ"
+  ##============================================================##
+  def upcase
+    UnicodeUtils.upcase(self)
+  end
+
+end

data/lib/immosquare-extensions/version.rb

@@ -0,0 +1,3 @@
+module ImmosquareExtensions
+  VERSION = "0.1.0".freeze
+end

data/lib/immosquare-extensions.rb

@@ -0,0 +1,7 @@
+require "immosquare-extensions/array"
+require "immosquare-extensions/hash"
+require "immosquare-extensions/string"
+
+module ImmosquareExentions
+  
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: immosquare-extensions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- IMMO SQUARE
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unicode_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+description: The immosquare-extensions gem provides a set of utility extensions for
+  various Ruby core classes such as String, Hash, and Array. These extensions aim
+  to enhance the standard functionality, offering more convenience and efficiency
+  for Ruby developers.
+email:
+- jules@immosquare.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/immosquare-extensions.rb
+- lib/immosquare-extensions/array.rb
+- lib/immosquare-extensions/hash.rb
+- lib/immosquare-extensions/string.rb
+- lib/immosquare-extensions/version.rb
+homepage: https://github.com/IMMOSQUARE/immosquare-extensions
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: Utility extensions for Ruby core classes
+test_files: []