rb_core_extensions 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6e1b20ef1ca0581de4193e3035e1d4e060f3714e8b81912cbc6d3d2a240a35b
-  data.tar.gz: a590f507ea31525383242987cca723c208617baea3f66c76967680044d154e3b
+  metadata.gz: 8debb12bba2cbb5357f52feaaf7c9bb9eb3a2c54bdca4e7f9438857e985dc4fb
+  data.tar.gz: 95bfeab24e32c5bbd5e60e3fb278282754efb7f7a080c4be765cd647d8ca778f
 SHA512:
-  metadata.gz: 4d229736ef48c958c4d844b11d1d186f8832248e759875bc3322b268ca05f98905df2455049c7416a8752364f93fd79991e9c50bf5f785d93f79ec380b011872
-  data.tar.gz: 3bcd013b138d899c6566552d564acc61331ac4db63a255d6f1bbe3917e46a4276cb4802664434489b3ccd5cd064556f1d296ca4413835144687cf341b7830d02
+  metadata.gz: 5ba7dfc16cfa492cacbfc41df35c59f6f00610ff5f28ff6247540eefab0bf8362bc86ff4bff340e39db67d75990ea0e31823a5d9efd56aa147c6b6ce866b22e2
+  data.tar.gz: 4e42b2b57b2600654c8accd9f9349fe5ce575f9e2a82b5013012b820500df59253901b2b8dfa0219a11c499d09b3035dc50e99e77c074be4e6e3938d32319b66

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.1.1](https://github.com/shivam091/core_extensions/compare/main...0.1.1) - 2023-07-05
+
+### What's new
+
+- Added core extension methods `take!`, `round`, `duplicates`, `include_all?`, `include_any?`, `include_none?`, `includes_index?`, `mean`, `stddev`, and `variance` in `Array`
+
 ## [0.1.0] - 2023-07-05
 
 - Initial release

data/Gemfile

@@ -1,4 +1,6 @@
-# frozen_string_literal: true
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
 
 source "https://rubygems.org"
 

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    rb_core_extensions (0.1.0)
-      activesupport
+    rb_core_extensions (0.1.1)
+      activesupport (~> 7.0)
 
 GEM
   remote: https://rubygems.org/
@@ -48,7 +48,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rb_core_extensions!
   rspec (~> 3.0)
-  simplecov (>= 0.21.2)
+  simplecov (~> 0.21, >= 0.21.2)
 
 BUNDLED WITH
    2.4.10

data/README.md

@@ -2,6 +2,13 @@
 
 `rb_core_extensions` is a set of core extensions beyond those provided by `Ruby` and `ActiveSupport`.
 
+[![Ruby](https://github.com/shivam091/core_extensions/actions/workflows/main.yml/badge.svg)](https://github.com/shivam091/rb_core_extensions/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/rb_core_extensions.svg)](https://badge.fury.io/rb/rb_core_extensions)
+[![Gem Downloads](https://img.shields.io/gem/dt/rb_core_extensions.svg)](http://rubygems.org/gems/rb_core_extensions)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/592b82a5336ee551a8f1/test_coverage)](https://codeclimate.com/github/shivam091/core_extensions/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/592b82a5336ee551a8f1/maintainability)](https://codeclimate.com/github/shivam091/core_extensions/maintainability)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/shivam091/core_extensions/blob/main/LICENSE.txt)
+
 ## Minimum Requirements
 
 * Ruby 3.2.2+ (https://www.ruby-lang.org/en/downloads/branches/)
@@ -22,6 +29,46 @@ Or otherwise simply install it yourself as:
 
 `$ gem install rb_core_extensions`
 
+### Usage
+
+Loading all core extensions at once:
+
+```ruby
+require "core_extensions/all"
+```
+
+Cherry-picking only what you want:
+
+```ruby
+require "core_extensions/array"
+require "core_extensions/array/math"
+require "core_extensions/date"
+```
+
+## Extensions Provided
+
+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
+
+* ***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/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`.
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,4 +1,6 @@
-# frozen_string_literal: true
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"

data/lib/core_extensions/all.rb

@@ -0,0 +1,5 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+require "core_extensions/array"

data/lib/core_extensions/array/delete.rb

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+class Array
+  # Alters the array by removing first +n+ elements.
+  #
+  # If a negative number is given, raises an +ArgumentError+.
+  #
+  # ==== Attributes
+  #
+  # * +n+ - Number of elements to take from the 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]
+  def take!(n)
+    replace(take(n))
+  end
+end

data/lib/core_extensions/array/duplicates.rb

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- 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]
+  def duplicates
+    self.select { |element| self.count(element) > 1 }.uniq
+  end
+end

data/lib/core_extensions/array/inclusion.rb

@@ -0,0 +1,70 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+class Array
+  # Returns whether the array contains any of the +elements+.
+  #
+  # ==== Arguments
+  #
+  # * +elements+ - +elements+ that needs to be checked in the 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
+  def include_any?(*elements)
+    elements = elements.first if elements.length == 1 && elements.first.kind_of?(Array)
+    !(self & elements).empty?
+  end
+
+  # Returns whether the array contains none of the +elements+.
+  #
+  # ==== Arguments
+  #
+  # * +elements+ - +elements+ that needs to be checked in the 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
+  def include_none?(*elements)
+    elements = elements.first if elements.length == 1 && elements.first.kind_of?(Array)
+    (self & elements).empty?
+  end
+
+  # Returns whether the array contains all of the +elements+.
+  #
+  # ==== Arguments
+  #
+  # * +elements+ - +elements+ that needs to be checked in the 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
+  def include_all?(*elements)
+    elements = elements.first if elements.length == 1 && elements.first.kind_of?(Array)
+    (elements - self).empty?
+  end
+
+  # Returns whether the array has a value at the specified +index+.
+  #
+  # ==== Arguments
+  #
+  # * +index+ - +index+ that needs to be checked in the array.
+  #
+  # ==== Examples
+  #
+  #   [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
+  def includes_index?(index)
+    (-self.length...self.length).cover?(index)
+  end
+end

data/lib/core_extensions/array/math.rb

@@ -0,0 +1,54 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+class Array
+  # Rounds each element of the array up to specified +precision+.
+  #
+  # If +precision+ is +zero+, array elements will be rounded to integers.
+  #
+  # ==== Attributes
+  #
+  # * +precision+ - Returns float rounded to the nearest value with a precision of +precision+.
+  #
+  # ==== 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]
+  def round(precision = 2)
+    map { |element| element.round(precision) }
+  end
+
+  # Returns the mean of the array of +Numeric+.
+  #
+  # ==== Examples
+  #
+  #   [1, 2, 3, 4, 5].mean  #=> 3.0
+  #   [1.0, 2.0, 3.0].mean  #=> 2.0
+  def mean
+    sum.to_f / length
+  end
+
+  # 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
+  def variance
+    return 0 if empty?
+
+    map { |element| (element - mean) ** 2 }.sum / length
+  end
+
+  # Returns the standard deviation of the array of +Numeric+.
+  #
+  # ==== Examples
+  #
+  #   [1, 2, 3, 4, 5].stddev  #=> 1.4142135623730951
+  #   [1.0, 2.0, 3.0].stddev  #=> 0.816496580927726
+  def stddev
+    Math.sqrt(variance)
+  end
+end

data/lib/core_extensions/array.rb

@@ -0,0 +1,8 @@
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
+
+require "core_extensions/array/delete"
+require "core_extensions/array/duplicates"
+require "core_extensions/array/inclusion"
+require "core_extensions/array/math"

data/lib/core_extensions/version.rb

@@ -2,6 +2,6 @@
 # -*- frozen_string_literal: true -*-
 # -*- warn_indent: true -*-
 
-module CoreExtensions
-  VERSION = "0.1.0"
+module CoreExtensions #:nodoc:
+  VERSION = "0.1.1"
 end

data/rb_core_extensions.gemspec

@@ -1,4 +1,6 @@
-# frozen_string_literal: true
+# -*- encoding: utf-8 -*-
+# -*- frozen_string_literal: true -*-
+# -*- warn_indent: true -*-
 
 require_relative "lib/core_extensions/version"
 
@@ -31,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "activesupport", "~> 7.0"
 
-  spec.add_development_dependency "simplecov", ">= 0.21.2"
+  spec.add_development_dependency "simplecov", "~> 0.21", ">= 0.21.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rb_core_extensions
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Harshal LADHE
@@ -14,20 +14,23 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.21.2
@@ -35,6 +38,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.21.2
@@ -58,6 +64,12 @@ files:
 - bin/console
 - bin/setup
 - lib/core_extensions.rb
+- lib/core_extensions/all.rb
+- lib/core_extensions/array.rb
+- lib/core_extensions/array/delete.rb
+- lib/core_extensions/array/duplicates.rb
+- lib/core_extensions/array/inclusion.rb
+- lib/core_extensions/array/math.rb
 - lib/core_extensions/version.rb
 - rb_core_extensions.gemspec
 homepage: https://github.com/shivam091/core_extensions