ruuuby-extensions 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 354997ed4a057826b15bc626d33b66114776f7be
-  data.tar.gz: 81569622b15dbbbb62f3021d1551dc9b89ca7d82
+  metadata.gz: ebb8cfb655ee14c5bc77da717475557ffb107948
+  data.tar.gz: a66269f18ae8a11459a03bb774837a6391e57efe
 SHA512:
-  metadata.gz: d216915d34808cb1f9c8e73fe0474afe8247fe539e557e054ec8f35a979c957e0c7606e0352a8eada96c45728605d16fc807591191dbcb3ba8e4400c8b29f6b9
-  data.tar.gz: 4c95498758e15119c9ffab770058d04ac61e8da44f5d450a8c53a34c4a32e140aa9e3e311a1824eaf24f730c9f7597acd1a57ea7aee86ea9bb4b27bda7b4261f
+  metadata.gz: a83abc7ef9025837d1e73970a91fced98be816612988a64b5cdaab8762bbc6fc6ad101be036e6e39756beca19755121c826d181a5a62f496abefccbed9bae7c3
+  data.tar.gz: 461540a3cdc6e31dce7b334f02a26043aece0345a96990e8b0c12983d23821cf8a174367bfde680db475eeca391dd51705530839b761ac44d1caf0a7c64eeff1

data/CHANGELOG.md

@@ -1,6 +1,8 @@
+#0.1.1
+- Further extend classes(Array, String)
+- Add additional RSpecs
+- Start abstraction work for type checking and exception throwing
+- Start tracking code coverage
 #0.1.0
 - GEM created, first configurations set
 - Add function extensions to class(Array)
-
-
-

data/Gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in ruuuby-extensions.gemspec
 gemspec
 
-gem "rdoc"
+gem "rdoc", require: false
 gem 'simplecov', require: false, group: :test
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"

data/lib/ruuuby/extensions.rb

@@ -1,47 +1,111 @@
 require "ruuuby/extensions/version"
 
+# This module + gem simply aims to provide coding quality of life extensions to core classes, somewhat similar to Python's approach.
 module Ruuuby
+
+  # Empty module. To be used for documenting Ruuuby.
   module Extensions
+    # Placeholder error class for errors specifically caused by Ruuuby.
     class Error < StandardError; end
+  end
+
+  # Utility functionalities for checking data types and throw exceptions.
+  module Params
+    # @param [String|*] str
+    #
+    # @return [Boolean] true, if provided param is not nil and inherits from String class.
+    def self.not_string?(str)
+      str == nil || !str.is_a?(String)
+    end
+
+    # @param [Array|*] str
+    #
+    # @return [Boolean] true, if provided param is not nil and inherits from Array class.
+    def self.not_array?(ary)
+      ary == nil || !ary.is_a?(Array)
+    end
+
+    # @param [String|nil|*] param
+    #
+    # @raise [ArgumentError]
+    #
+    # @return [Boolean] true only, exception raised otherwise
+    def self.check_string(param)
+      raise ArgumentError.new(self::bad_type(caller_locations.first.label.to_s, String, param)) if Ruuuby::Params::not_string?(param)
+      true
+    end
+
+    # @param [Array|nil|*] param
+    #
+    # @raise [ArgumentError]
+    #
+    # @return [Boolean] true only, exception raised otherwise
+    def self.check_array(param)
+      raise ArgumentError.new(self::bad_type(caller_locations.first.label.to_s, Array, param)) if Ruuuby::Params::not_array?(param)
+      true
+    end
 
-    module Arrays
-      def self.already_loaded?
-        Array.respond_to?(:equal_contents?)
+    # @param [Array|nil|*] param
+    #
+    # @raise [ArgumentError]
+    #
+    # @return [Boolean] true only, exception raised otherwise
+    def self.check_char(param)
+      if param == nil || !param.is_a?(String)
+        error_message = "a param of type{#{String.to_s}}, instead got{#{param.class.to_s}}!"
+      elsif param.chars.length != 1
+        error_message = "a String of length 1, instead got{#{param.length.to_s}}"
+      else
+        return true
       end
+      raise ArgumentError.new("#{caller_locations.first.label.to_s} requires #{error_message}")
     end
 
+    private
+
+    # @param [String] func | the name of the original function that triggered this exception
+    # @param [*] required_type | the required data type for the param
+    # @param [*] param | the variable with mis-mitached type
+    #
+    # @return [String]
+    def self.bad_type(func_name, required_type, param)
+      "#{func_name} requires param of type{#{required_type.to_s}}, instead got{#{param.class.to_s}}!"
+    end
   end
 end
 
-unless Ruuuby::Extensions::Arrays::already_loaded?
+unless Array.respond_to?(:equal_contents?)
+
+  # Add extensions to the default class(*String*).
   class Array
+
     # @param [Array] them | another array to be compared against
     #
+    # @raise [ArgumentError]
+    #
     # @return [Array] a new array instance containing values only appearing in base array (and not in provided array)
     def uniq_to_me(them)
-      unless them.is_a?(Array)
-        raise ArgumentError.new("Array.uniq_to_me requires array param, not the provided{#{them.class.to_s}}!")
-      end
+      Ruuuby::Params::check_array(them)
       self.uniq - them.uniq
     end
 
     # @param [Array] them | an array to be compared against
     #
+    # @raise [ArgumentError]
+    #
     # @return [Array] a new array instance containing values only appearing in provided array (and not in base array)
     def uniq_to_them(them)
-      unless them.is_a?(Array)
-        raise ArgumentError.new("Array.uniq_to_them requires array param, not the provided{#{them.class.to_s}}!")
-      end
+      Ruuuby::Params::check_array(them)
       them.uniq - self.uniq
     end
 
     # @param [Array] them | an array to be compared against
     #
+    # @raise [ArgumentError]
+    #
     # @return [Array] a new array instance containing values only appearing in provided array (and not in base array)
     def shared_between(them)
-      unless them.is_a?(Array)
-        raise ArgumentError.new("Array.shared_between requires array param, not the provided{#{them.class.to_s}}!")
-      end
+      Ruuuby::Params::check_array(them)
       self.uniq & them.uniq
     end
 
@@ -53,15 +117,97 @@ unless Ruuuby::Extensions::Arrays::already_loaded?
 
     # @param [Array] them
     #
-    # @return [Boolean] true, if this array and provided array both have same content (order-matters: false, duplicates-matter: false)
+    # @raise [ArgumentError]
+    #
+    # @return [Boolean] true, if this array and provided array both have same content (*order-matters*: false, *duplicates-matter*: false)
     def equal_contents?(them)
-      return false if (them == nil || !them.is_a?(Array))
-      len_this = self.length
-      len_them = them.length
-      return true  if (len_this == 0 && len_them == 0)
-      return false if (len_this != len_them)
+      Ruuuby::Params::check_array(them)
+      return true  if (self.length == 0 && them.length == 0)
+      return false if (self.length != them.length)
       uniq_to_me(them).empty? && uniq_to_them(them).empty?
     end
+
+    # @param [Array] ending
+    #
+    # @raise [ArgumentError]
+    #
+    # @return [Boolean] true, if this array ends with the elements in the provided parameter array (*order-matters*: true, *duplicates-matter*: true)
+    def end_with?(ending)
+      Ruuuby::Params::check_array(ending)
+      if ending.length == 0
+        self.length == 0
+      else
+        self[(self.length-ending.length)..(self.length-1)] == ending[(0)..(ending.length-1)]
+      end
+    end
+
+    # @param [Array] ending
+    #
+    # @raise [ArgumentError]
+    #
+    # @return [Array]
+    def ensure_ending!(ending)
+      Ruuuby::Params::check_array(ending)
+      len_ending = ending.length
+      return self if len_ending == 0 || self.end_with?(ending)
+      len_this = self.length
+      return self << ending[0] if len_ending == 1
+      if len_this == 0
+        ending.each { |element| self << element }
+        return self
+      end
+      delta        = 0
+      last_matched = nil
+      while delta <= len_this && delta <= len_ending
+        ending_of_this  = self[(len_this-1-delta)..(len_this-1)]
+        starting_of_end = ending[0..delta]
+        last_matched    = starting_of_end if ending_of_this == starting_of_end
+        delta          += 1
+      end
+      if last_matched == nil
+        ending.each { |element| self << element }
+      else
+        ending[(last_matched.length)..(len_ending-1)].each { |element| self << element }
+      end
+      self
+    end
   end
-end
 
+  # Add extensions to the default class(*String*).
+  class String
+
+    # @param [String] ending
+    #
+    # @raise [ArgumentError]
+    #
+    # @return [String]
+    def ensure_ending!(ending)
+      Ruuuby::Params::check_string(ending)
+      return self if ending == '' || self.end_with?(ending)
+      len_this = self.length
+      return self << ending if len_this == 0
+      last_matched = ''
+      len_ending   = ending.length
+      delta        = 0
+      while delta <= len_this && delta <= len_ending
+        ending_of_this  = self[(len_this-1-delta)..(len_this-1)]
+        starting_of_end = ending[0..delta]
+        last_matched    = starting_of_end if ending_of_this == starting_of_end
+        delta          += 1
+      end
+      self << (last_matched == '' ? ending : ending[last_matched.length..len_ending-1])
+    end
+
+    # @param [String] ending
+    #
+    # @raise [ArgumentError]
+    #
+    # @return [String]
+    def ensure_ending_char!(ending)
+      Ruuuby::Params::check_char(ending)
+      self << ending if self.length == 0 || self[-1] != ending
+      self
+    end
+  end
+
+end

data/lib/ruuuby/extensions/version.rb

@@ -1,5 +1,8 @@
+# This module + gem simply aims to provide coding quality of life extensions to core classes, somewhat similar to Python's approach.
 module Ruuuby
+  # Empty module. To be used for documenting Ruuuby.
   module Extensions
-    VERSION = "0.1.0"
+    # Current version of *Ruuuby*.
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruuuby-extensions
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Uladzislau Tarsunou