rb_core_extensions 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8debb12bba2cbb5357f52feaaf7c9bb9eb3a2c54bdca4e7f9438857e985dc4fb
-  data.tar.gz: 95bfeab24e32c5bbd5e60e3fb278282754efb7f7a080c4be765cd647d8ca778f
+  metadata.gz: ff651ca46ca4e51a477160b362fdd434c6fa95d248d27a5022b0ee8f0c9b5b41
+  data.tar.gz: 819bafb17f44354587c741c2ede51e3bf7f002f7020bdb32a718d82016401519
 SHA512:
-  metadata.gz: 5ba7dfc16cfa492cacbfc41df35c59f6f00610ff5f28ff6247540eefab0bf8362bc86ff4bff340e39db67d75990ea0e31823a5d9efd56aa147c6b6ce866b22e2
-  data.tar.gz: 4e42b2b57b2600654c8accd9f9349fe5ce575f9e2a82b5013012b820500df59253901b2b8dfa0219a11c499d09b3035dc50e99e77c074be4e6e3938d32319b66
+  metadata.gz: e05845abd3afc84fcee0fd1ee16d05f2b9904b5e9abe082cf261bddc2681e3637122786a3ddb792a6ba08273313ea766b8b4defcdbcf627de1ba747b333d10d2
+  data.tar.gz: 572c3a81cc8c4fe82b821220d3528c4497d4246b02061422ce7f1155af4427c70666db8b28f2a64a63e2f96a1523a3e57db8a46867e686ec0372a04444d57987

data/.github/workflows/main.yml

@@ -27,4 +27,4 @@ jobs:
     - name: Run test cases
       run: bundle exec rake
     - name: Publish code coverage
-      uses: paambaati/codeclimate-action@v4.0.0
+      uses: paambaati/codeclimate-action@v5.0.0

data/CHANGELOG.md

@@ -1,4 +1,17 @@
-## [0.1.1](https://github.com/shivam091/core_extensions/compare/main...0.1.1) - 2023-07-05
+## [0.1.2](https://github.com/shivam091/core_extensions/compare/v0.1.1...v0.1.2) - 2023-07-06
+
+### What's new
+
+- Added core extension methods `keys?`, `slice!`, and `keys_at` in `Hash`
+- Added core extension method `namespaces` in `Module`
+- Added core extension method `blank?` in `NilClass`
+- Added core extension methods `is_one_of?`, `deep_send`, and `in_namespace?` in `Object`
+
+### What's changed
+
+- Bumped version of `paambaati/codeclimate-action` workflow action to `5.0.0`
+
+## [0.1.1](https://github.com/shivam091/core_extensions/compare/v0.1.0...v0.1.1) - 2023-07-05
 
 ### What's new
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rb_core_extensions (0.1.1)
+    rb_core_extensions (0.1.2)
       activesupport (~> 7.0)
 
 GEM

data/README.md

@@ -49,25 +49,51 @@ require "core_extensions/date"
 
 Below are the extension methods which are provided by `rb_core_extensions`. Please refer [documentation](https://shivam091.github.io/core_extensions) or rspec for examples of how to use these methods.
 
-### Array
+### [Array](https://shivam091.github.io/core_extensions/Array.html)
 
-* ***core_extensions/array/delete.rb***
-  1. **[`#take!`](https://shivam091.github.io/core_extensions/Array.html#method-i-take-21)** - Alters the array by removing first `n` elements.
+#### ***core_extensions/array/delete.rb***
+1. **[`#take!`](https://shivam091.github.io/core_extensions/Array.html#method-i-take-21)** - Alters the array by removing first `n` elements.
 
-* ***core_extensions/array/math.rb***
-  1. **[`round`](https://shivam091.github.io/core_extensions/Array.html#method-i-round)** - Rounds each element of the numeric array up to specified `precision`.
-  2. **[`mean`](https://shivam091.github.io/core_extensions/Array.html#method-i-mean)** - Returns the mean of the array of `Numeric`.
-  3. **[`variance`](https://shivam091.github.io/core_extensions/Array.html#method-i-variance)** - Returns the variance of the array of `Numeric`.
-  4. **[`stddev`](https://shivam091.github.io/core_extensions/Array.html#method-i-stddev)** - Returns the standard deviation of the array of `Numeric`.
+#### ***core_extensions/array/math.rb***
+1. **[`round`](https://shivam091.github.io/core_extensions/Array.html#method-i-round)** - Rounds each element of the numeric array up to specified `precision`.
+2. **[`mean`](https://shivam091.github.io/core_extensions/Array.html#method-i-mean)** - Returns the mean of the array of `Numeric`.
+3. **[`variance`](https://shivam091.github.io/core_extensions/Array.html#method-i-variance)** - Returns the variance of the array of `Numeric`.
+4. **[`stddev`](https://shivam091.github.io/core_extensions/Array.html#method-i-stddev)** - Returns the standard deviation of the array of `Numeric`.
 
-* ***core_extensions/array/duplicates.rb***
-  1. **[`duplicates`](https://shivam091.github.io/core_extensions/Array.html#method-i-duplicates)** - Returns an array of the duplicate elements.
+#### ***core_extensions/array/duplicates.rb***
+1. **[`duplicates`](https://shivam091.github.io/core_extensions/Array.html#method-i-duplicates)** - Returns an array of the duplicate elements.
 
-* ***core_extensions/array/inclusion.rb***
-  1. **[`include_any?`](https://shivam091.github.io/core_extensions/Array.html#method-i-include_any-3F)** - Returns whether the array contains any of the `elements`.
-  2. **[`include_none?`](https://shivam091.github.io/core_extensions/Array.html#method-i-include_none-3F)** - Returns whether the array contains none of the `elements`.
-  3. **[`include_all?`](https://shivam091.github.io/core_extensions/Array.html#method-i-include_all-3F)** - Returns whether the array contains all of the `elements`.
-  4. **[`includes_index?`](https://shivam091.github.io/core_extensions/Array.html#method-i-includes_index-3F)** - Returns whether the array has a value at the specified `index`.
+#### ***core_extensions/array/inclusion.rb***
+1. **[`include_any?`](https://shivam091.github.io/core_extensions/Array.html#method-i-include_any-3F)** - Returns whether the array contains any of the `elements`.
+2. **[`include_none?`](https://shivam091.github.io/core_extensions/Array.html#method-i-include_none-3F)** - Returns whether the array contains none of the `elements`.
+3. **[`include_all?`](https://shivam091.github.io/core_extensions/Array.html#method-i-include_all-3F)** - Returns whether the array contains all of the `elements`.
+4. **[`includes_index?`](https://shivam091.github.io/core_extensions/Array.html#method-i-includes_index-3F)** - Returns whether the array has a value at the specified `index`.
+
+### [Hash](https://shivam091.github.io/core_extensions/Hash.html)
+
+#### ***core_extensions/hash/inclusion.rb***
+1. **[`#keys?`](https://shivam091.github.io/core_extensions/Hash.html#method-i-keys-3F)** - Returns whether the hash contains all of the specified `keys`.
+#### ***core_extensions/hash/access.rb***
+1. **[`#keys_at`](https://shivam091.github.io/core_extensions/Hash.html#method-i-keys_at)** - Returns the array of keys of an occurrence of given `values`.
+#### ***core_extensions/hash/delete.rb***
+1. **[`#slice!`](https://shivam091.github.io/core_extensions/Hash.html#method-i-slice-21)** - Alters the hash by keeping only specified `keys` and returns it.
+
+### [NilClass](https://shivam091.github.io/core_extensions/NilClass.html)
+
+### ***core_extensions/nil_class***
+1. **[`#blank?`](https://shivam091.github.io/core_extensions/NilClass.html#method-i-blank-3F)** - Returns `true` when invoked on `nil`.
+
+### [Object](https://shivam091.github.io/core_extensions/Object.html)
+
+#### ***core_extensions/object.rb***
+1. **[`#is_one_of?`](https://shivam091.github.io/core_extensions/Object.html#method-i-is_one_of-3F)** - Returns `true` if the receiver object is an instance of at least one of the classes specified by `args`.
+2. **[`#deep_send`](https://shivam091.github.io/core_extensions/Object.html#method-i-deep_send)** - Invokes the specified methods continuously, unless encountering a `nil` value.
+3. **[`#in_namespace?`](https://shivam091.github.io/core_extensions/Object.html#method-i-in_namespace-3F)** - Returns whether or not the object is in the given namespace.
+
+### [Module](https://shivam091.github.io/core_extensions/Module.html)
+
+#### ***core_extensions/module.rb***
+1. **[`#namespaces`](https://shivam091.github.io/core_extensions/Module.html#method-i-namespaces)** - Returns an `Array` with the namespaces to the current `Module`.
 
 ## Contributing
 

data/bin/console

@@ -4,7 +4,7 @@
 # -*- warn_indent: true -*-
 
 require "bundler/setup"
-require "core_extensions"
+require "core_extensions/all"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/core_extensions/all.rb

@@ -3,3 +3,8 @@
 # -*- warn_indent: true -*-
 
 require "core_extensions/array"
+require "core_extensions/hash"
+require "core_extensions/nil_class"
+
+require "core_extensions/object"
+require "core_extensions/module"

data/lib/core_extensions/array/delete.rb

@@ -13,9 +13,9 @@ class Array
   #
   # ==== Examples
   #
-  #     [].take!(3)               # => []
-  #     [1, 2, 3, 4, 5].take!(3)  #=> [1, 2, 3]
-  #     [1, 2, 3, 4, 5].take!(6)  #=> [1, 2, 3, 4, 5]
+  #   [].take!(3)              # => []
+  #   [1, 2, 3, 4, 5].take!(3) #=> [1, 2, 3]
+  #   [1, 2, 3, 4, 5].take!(6) #=> [1, 2, 3, 4, 5]
   def take!(n)
     replace(take(n))
   end

data/lib/core_extensions/array/duplicates.rb

@@ -3,13 +3,12 @@
 # -*- warn_indent: true -*-
 
 class Array
-  #
   # Returns an array of the duplicate elements.
   #
   # ==== Examples
   #
-  #     [1, 2, 3, 2, 4, 1, 5].duplicates  #=> [1, 2]
-  #     [1, 2, 3, 4, 2, 4].duplicates     #=> [2, 4]
+  #   [1, 2, 3, 2, 4, 1, 5].duplicates #=> [1, 2]
+  #   [1, 2, 3, 4, 2, 4].duplicates    #=> [2, 4]
   def duplicates
     self.select { |element| self.count(element) > 1 }.uniq
   end

data/lib/core_extensions/array/inclusion.rb

@@ -11,11 +11,10 @@ class Array
   #
   # ==== Examples
   #
-  #   [1, 2, 3].include_any?(1, 2)  #=> true
-  #   [1, 2, 3].include_any?(1, 4)  #=> true
-  #   [1, 2, 3].include_any?(4, 5)  #=> false
+  #   [1, 2, 3].include_any?(1, 2) #=> true
+  #   [1, 2, 3].include_any?(1, 4) #=> true
+  #   [1, 2, 3].include_any?(4, 5) #=> false
   def include_any?(*elements)
-    elements = elements.first if elements.length == 1 && elements.first.kind_of?(Array)
     !(self & elements).empty?
   end
 
@@ -27,11 +26,10 @@ class Array
   #
   # ==== Examples
   #
-  #   [1, 2, 3].include_none?(1, 2)  #=> false
-  #   [1, 2, 3].include_none?(1, 4)  #=> false
-  #   [1, 2, 3].include_none?(4, 5)  #=> true
+  #   [1, 2, 3].include_none?(1, 2) #=> false
+  #   [1, 2, 3].include_none?(1, 4) #=> false
+  #   [1, 2, 3].include_none?(4, 5) #=> true
   def include_none?(*elements)
-    elements = elements.first if elements.length == 1 && elements.first.kind_of?(Array)
     (self & elements).empty?
   end
 
@@ -43,11 +41,10 @@ class Array
   #
   # ==== Examples
   #
-  #   [1, 2, 3].include_all?(1, 2)  #=> true
-  #   [1, 2, 3].include_all?(1, 4)  #=> false
-  #   [1, 2, 3].include_all?(4, 5)  #=> false
+  #   [1, 2, 3].include_all?(1, 2) #=> true
+  #   [1, 2, 3].include_all?(1, 4) #=> false
+  #   [1, 2, 3].include_all?(4, 5) #=> false
   def include_all?(*elements)
-    elements = elements.first if elements.length == 1 && elements.first.kind_of?(Array)
     (elements - self).empty?
   end
 
@@ -59,8 +56,8 @@ class Array
   #
   # ==== Examples
   #
-  #   [1, 2, 3].includes_index?(-4)  #=> false
-  #   [1, 2, 3].includes_index?(-3)  #=> true
+  #   [1, 2, 3].includes_index?(-4) #=> false
+  #   [1, 2, 3].includes_index?(-3) #=> true
   #   [1, 2, 3].includes_index?(1)  #=> true
   #   [1, 2, 3].includes_index?(2)  #=> true
   #   [1, 2, 3].includes_index?(3)  #=> false

data/lib/core_extensions/array/math.rb

@@ -13,9 +13,9 @@ class Array
   #
   # ==== Examples
   #
-  #     [1.342, 2.876, 3.546, 5.623, 5.245].round     #=> [1.34, 2.88, 3.55, 5.62, 5.25]
-  #     [1.342, 2.876, 3.546, 5.623, 5.245].round(1)  #=> [1.3, 2.9, 3.5, 5.6, 5.2]
-  #     [1.342, 2.876, 3.546, 5.623, 5.245].round(0)  #=> [1, 3, 4, 6, 5]
+  #   [1.342, 2.876, 3.546, 5.623, 5.245].round    #=> [1.34, 2.88, 3.55, 5.62, 5.25]
+  #   [1.342, 2.876, 3.546, 5.623, 5.245].round(1) #=> [1.3, 2.9, 3.5, 5.6, 5.2]
+  #   [1.342, 2.876, 3.546, 5.623, 5.245].round(0) #=> [1, 3, 4, 6, 5]
   def round(precision = 2)
     map { |element| element.round(precision) }
   end
@@ -24,18 +24,19 @@ class Array
   #
   # ==== Examples
   #
-  #   [1, 2, 3, 4, 5].mean  #=> 3.0
-  #   [1.0, 2.0, 3.0].mean  #=> 2.0
+  #   [1, 2, 3, 4, 5].mean #=> 3.0
+  #   [1.0, 2.0, 3.0].mean #=> 2.0
   def mean
-    sum.to_f / length
+    sum.to_f / size
   end
+  alias_method :average, :mean
 
   # Returns the variance of the array of +Numeric+.
   #
   # ==== Examples
   #
-  #   [1, 2, 3, 4, 5].variance  #=> 2.0
-  #   [1.0, 2.0, 3.0].variance  #=> 0.6666666666666666
+  #   [1, 2, 3, 4, 5].variance #=> 2.0
+  #   [1.0, 2.0, 3.0].variance #=> 0.6666666666666666
   def variance
     return 0 if empty?
 
@@ -46,8 +47,8 @@ class Array
   #
   # ==== Examples
   #
-  #   [1, 2, 3, 4, 5].stddev  #=> 1.4142135623730951
-  #   [1.0, 2.0, 3.0].stddev  #=> 0.816496580927726
+  #   [1, 2, 3, 4, 5].stddev #=> 1.4142135623730951
+  #   [1.0, 2.0, 3.0].stddev #=> 0.816496580927726
   def stddev
     Math.sqrt(variance)
   end

data/lib/core_extensions/hash/access.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+class Hash
+  # Returns the array of keys of an occurrence of given +values+.
+  # If the value is not found, returns empty array.
+  #
+  # ==== Arguments
+  #
+  # * +values+ - +values+ for which keys are to be retrieved.
+  #
+  # ==== Examples
+  #
+  #   {a: 1, b: 2}.keys_at(1, 2) #=> [:a, :b]
+  #   {a: 1, b: 2}.keys_at(1, 3) #=> [:a]
+  #   {a: 1, b: 2}.keys_at(3)    #=> []
+  def keys_at(*values)
+    select { |_, value| values.include?(value) }.keys
+  end
+end

data/lib/core_extensions/hash/delete.rb

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+class Hash
+  # Alters the hash by keeping only specified `keys` and returns it.
+  # If the key is not present, returns empty `Hash`.
+  #
+  # ==== Arguments
+  #
+  # * +keys+ - +keys+ to be kept in the original `Hash`.
+  #
+  # ==== Examples
+  #
+  #   {name: 'John', age: 30, occupation: 'Engineer', gender: 'Male'}.slice!(:name, :age) #=> {name: 'John', age: 30}
+  #   {name: 'John', age: 30, occupation: 'Engineer', gender: 'Male'}.slice!(:address)    #=> {}
+  def slice!(*keys)
+    keep_if { |key, _| keys.include?(key) }
+  end
+end

data/lib/core_extensions/hash/inclusion.rb

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+class Hash
+  # Returns whether the hash contains all of the specified +keys+.
+  # This method is similar to Hash#key?, but it accepts several keys.
+  #
+  # ==== Arguments
+  #
+  # * +keys+ - +keys+ that needs to be checked in the hash.
+  #
+  # ==== Examples
+  #
+  #   {a: 1, b: 2}.keys?(:a, :b) #=> true
+  #   {a: 1, b: 2}.keys?(:a, :c) #=> false
+  def keys?(*keys)
+    keys.all? { |key| self.key?(key) }
+  end
+  alias_method :has_keys?, :keys?
+end

data/lib/core_extensions/hash.rb

@@ -0,0 +1,7 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+require "core_extensions/hash/access"
+require "core_extensions/hash/delete"
+require "core_extensions/hash/inclusion"

data/lib/core_extensions/module.rb

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+class Module
+  # Returns an +Array+ with the namespaces to the current Module.
+  #
+  # ==== Examples
+  #
+  #   Aaa::Bbb::Ccc::Ddd.namespaces      #=> ["Aaa", "Bbb", "Ccc", "Ddd"]
+  def namespaces
+    name.to_s.split("::")
+  end
+end

data/lib/core_extensions/nil_class.rb

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+class NilClass
+  # Returns +true+ when invoked on `nil`.
+  #
+  # ==== Examples
+  #
+  #   nil.blank? #=> true
+  def blank?
+    true
+  end
+end

data/lib/core_extensions/object.rb

@@ -0,0 +1,64 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+class Object
+  # Returns +true+ if the receiver object is an instance of at least one of the classes specified by +args+.
+  # This method is similar to {Object#is_a?}[https://www.rubydoc.info/stdlib/core/Object#is_a%3F-instance_method], but it accepts multiple arguments.
+  #
+  # ==== Arguments
+  #
+  # * +args+ - The classes to check against. One or more classes can be passed. Each argument represents a class that the object will be checked against.
+  #
+  # ==== Examples
+  #
+  #   1.is_one_of?(Numeric, TrueClass)     #=> true
+  #   true.is_one_of?(Numeric, TrueClass)  #=> true
+  #   false.is_one_of?(Numeric, TrueClass) #=> false
+  #
+  # ==== Returns
+  # (Boolean)
+  def is_one_of?(*args)
+    args.any? { |arg| is_a?(arg) }
+  end
+
+  # Invokes the specified methods continuously, unless encountering a +nil+ value.
+  #
+  # ==== Examples
+  #
+  #   10.deep_send("to_s.length")      # => 2
+  #   10.deep_send("to_s", "length")   # => 2
+  #   10.deep_send(:to_s, :length)     # => 2
+  #   10.deep_send(["to_s", "length"]) # => 2
+  #   [].deep_send("first.length")     # => nil
+  def deep_send(*args)
+    args = args.first.dup if args.length == 1 && args.first.kind_of?(Array)
+    args = args.shift.to_s.strip.split('.') + args
+
+    arg = args.shift
+    raise ArgumentError if arg.nil?
+
+    result = send(arg)
+    return nil if result.nil?
+    return result if args.empty?
+
+    result.deep_send(args)
+  end
+
+  # Returns whether or not the object is in the given namespace.
+  #
+  # ==== Arguments
+  #
+  # * +val+ - The object to be checked in the namespace.
+  #
+  # ==== Examples
+  #
+  #   Aaa::Bbb::Ccc::Ddd.in_namespace?(Aaa::Bbb)           #=> true
+  #   Aaa::Bbb::Ccc::Ddd.new.in_namespace?(Aaa::Bbb)       #=> true
+  #   Aaa::Bbb::Ccc::Eee.in_namespace?("Aaa::Bbb")         #=> true
+  #   Aaa::Bbb::Ccc::Eee.in_namespace?(Aaa::Bbb::Ccc::Ddd) #=> false
+  def in_namespace?(val)
+    namespaces = val.to_s.split("::")
+    namespaces == (kind_of?(Module) ? namespaces : self.class.namespaces)[0, namespaces.length]
+  end
+end

data/lib/core_extensions/version.rb

@@ -3,5 +3,5 @@
 # -*- warn_indent: true -*-
 
 module CoreExtensions #:nodoc:
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rb_core_extensions
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Harshal LADHE
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
+date: 2023-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,6 +70,13 @@ files:
 - lib/core_extensions/array/duplicates.rb
 - lib/core_extensions/array/inclusion.rb
 - lib/core_extensions/array/math.rb
+- lib/core_extensions/hash.rb
+- lib/core_extensions/hash/access.rb
+- lib/core_extensions/hash/delete.rb
+- lib/core_extensions/hash/inclusion.rb
+- lib/core_extensions/module.rb
+- lib/core_extensions/nil_class.rb
+- lib/core_extensions/object.rb
 - lib/core_extensions/version.rb
 - rb_core_extensions.gemspec
 homepage: https://github.com/shivam091/core_extensions