darthjee-core_ext 1.7.4 → 3.0.0

data/Rakefile

@@ -4,6 +4,7 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'yardstick/rake/measurement'
 require './config/yardstick'
+require './config/rubycritc'
 
 RSpec::Core::RakeTask.new
 

data/SYMBOL_README.md

@@ -5,31 +5,20 @@ Camelize the symbol 'just like String#camelize'
 
 ```ruby
 :underscore_sym.camelize(:upper)
-```
-
-Returns
 
-```ruby
-:UnderscoreSym
+# returns :UnderscoreSym
 ```
 
 ```ruby
 :underscore_sym.camelize(:lower)
-```
-Returns
 
-```ruby
-:underscoreSym
+# returns :underscoreSym
 ```
 
 ```ruby
 :underscore_sym.camelize
-```
 
-Return
-
-```ruby
-:UnderscoreSym
+# returns :UnderscoreSym
 ```
 
 ### #underscore
@@ -37,10 +26,16 @@ underscore the symbol 'just like String#underscore'
 
 ```ruby
 :symBol.underscore
+
+# returns :sym_bol
 ```
 
-Returns
+## Added by Object
+- [#is_any?](OBJECT_README.md#is_any?)
+- [#trueful?](OBJECT_README.md#trueful?)
 
-```ruby
-:sym_bol
-```
+## Added by Class
+- [.default_value](CLASS_README.md#default_value)
+- [.default_values](CLASS_README.md#default_values)
+- [.default_reader](CLASS_README.md#default_reader)
+- [.default_readers](CLASS_README.md#default_readers)

data/config/check_specs.yml

@@ -0,0 +1,20 @@
+ignore:
+  - lib/darthjee/core_ext/array/hash_builder.rb
+  - lib/darthjee/core_ext/array.rb
+  - lib/darthjee/core_ext/class.rb
+  - lib/darthjee/core_ext/date.rb
+  - lib/darthjee/core_ext/enumerable.rb
+  - lib/darthjee/core_ext/hash/cameliazable.rb
+  - lib/darthjee/core_ext/hash/changeable.rb
+  - lib/darthjee/core_ext/hash/key_changeable.rb
+  - lib/darthjee/core_ext/hash/transformable.rb
+  - lib/darthjee/core_ext/hash/transposeable.rb
+  - lib/darthjee/core_ext/hash.rb
+  - lib/darthjee/core_ext/math.rb
+  - lib/darthjee/core_ext/numeric.rb
+  - lib/darthjee/core_ext/object.rb
+  - lib/darthjee/core_ext/symbol.rb
+  - lib/darthjee/core_ext/time.rb
+  - lib/darthjee/core_ext/version.rb
+  - lib/darthjee/core_ext.rb
+  - lib/darthjee.rb

data/config/rubycritc.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'rubycritic/rake_task'
+
+RubyCritic::RakeTask.new do |task|
+  options = %w[
+    --path rubycritic/
+    --no-browser
+  ]
+  task.options = options.join(' ')
+  task.paths   = %w[lib]
+end

data/config/yardstick.yml

@@ -1,4 +1,4 @@
-threshold: 65.4
+threshold: 100
 require_exact_threshold: false
 rules:
   ApiTag::Presence:
@@ -19,11 +19,53 @@ rules:
   ReturnTag:
     enabled: true
     exclude:
-      - Darthjee::CoreExt::Hash::ChainFetcher
+      - Darthjee::CoreExt::Array::HashBuilder#values
+      - Darthjee::CoreExt::Array::HashBuilder#keys
+      - Darthjee::CoreExt::Array::HashBuilder#values=
+      - Darthjee::CoreExt::Array::HashBuilder#keys=
+      - Darthjee::CoreExt::Hash::ChainFetcher#hash
+      - Darthjee::CoreExt::Hash::ChainFetcher#keys
+      - Darthjee::CoreExt::Hash::ChainFetcher#block
+      - Darthjee::CoreExt::Hash::DeepHashConstructor#separator
+      - Darthjee::CoreExt::Hash::DeepHashConstructor::Setter#hash
+      - Darthjee::CoreExt::Hash::DeepHashConstructor::Setter#base_key
+      - Darthjee::CoreExt::Hash::DeepHashConstructor::Setter#key
+      - Darthjee::CoreExt::Hash::KeyChanger#hash
+      - Darthjee::CoreExt::Hash::KeysSorter#hash
+      - Darthjee::CoreExt::Hash::KeysSorter#recursive
+      - Darthjee::CoreExt::Hash::Squasher#joiner
+      - Darthjee::CoreExt::Hash::ValueChanger#recursive
+      - Darthjee::CoreExt::Hash::ValueChanger#skip_inner
+      - Darthjee::CoreExt::Hash::ValueChanger#block
   Summary::Presence:
     enabled: true
     exclude:
-      - Darthjee::CoreExt::Hash::ChainFetcher
+      - Darthjee::CoreExt::Hash::KeyChanger#initialize
+      - Darthjee::CoreExt::Array::HashBuilder#initialize
+      - Darthjee::CoreExt::Hash::ChainFetcher#initialize
+      - Darthjee::CoreExt::Hash::ValueChanger#initialize
+      - Darthjee::CoreExt::Hash::DeepHashConstructor#initialize
+      - Darthjee::CoreExt::Hash::DeepHashConstructor::Setter#initialize
+      - Darthjee::CoreExt::Hash::KeysSorter#initialize
+      - Darthjee::CoreExt::Hash::Squasher#initialize
+      - Darthjee::CoreExt::Array::HashBuilder#values
+      - Darthjee::CoreExt::Array::HashBuilder#keys
+      - Darthjee::CoreExt::Array::HashBuilder#values=
+      - Darthjee::CoreExt::Array::HashBuilder#keys=
+      - Darthjee::CoreExt::Hash::ChainFetcher#hash
+      - Darthjee::CoreExt::Hash::ChainFetcher#keys
+      - Darthjee::CoreExt::Hash::ChainFetcher#block
+      - Darthjee::CoreExt::Hash::DeepHashConstructor#separator
+      - Darthjee::CoreExt::Hash::DeepHashConstructor::Setter#hash
+      - Darthjee::CoreExt::Hash::DeepHashConstructor::Setter#base_key
+      - Darthjee::CoreExt::Hash::DeepHashConstructor::Setter#key
+      - Darthjee::CoreExt::Hash::KeyChanger#hash
+      - Darthjee::CoreExt::Hash::KeysSorter#hash
+      - Darthjee::CoreExt::Hash::KeysSorter#recursive
+      - Darthjee::CoreExt::Hash::Squasher#joiner
+      - Darthjee::CoreExt::Hash::ValueChanger#recursive
+      - Darthjee::CoreExt::Hash::ValueChanger#skip_inner
+      - Darthjee::CoreExt::Hash::ValueChanger#block
   Summary::Length:
     enabled: true
     exclude: []

data/core_ext.gemspec

@@ -5,28 +5,20 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'darthjee/core_ext/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = 'darthjee-core_ext'
-  gem.version       = Darthjee::CoreExt::VERSION
-  gem.authors       = ['Darthjee']
-  gem.email         = ['darthjee@gmail.com']
-  gem.summary       = 'Core Extensions'
-  gem.homepage      = 'https://github.com/darthjee/core_ext'
-  gem.description   = 'Extension of basic classes with usefull methods'
+  gem.name                  = 'darthjee-core_ext'
+  gem.version               = Darthjee::CoreExt::VERSION
+  gem.authors               = ['Darthjee']
+  gem.email                 = ['darthjee@gmail.com']
+  gem.summary               = 'Core Extensions'
+  gem.homepage              = 'https://github.com/darthjee/core_ext'
+  gem.description           = 'Extension of basic classes with usefull methods'
+  gem.required_ruby_version = '>= 3.3.1'
 
   gem.files         = `git ls-files -z`.split("\x0")
   gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.add_runtime_dependency 'activesupport', '>= 5.2.x'
+  gem.add_dependency 'activesupport', '~> 7.x'
 
-  gem.add_development_dependency 'bundler',       '~> 1.17.x'
-  gem.add_development_dependency 'pry-nav',       '~> 0.2.4'
-  gem.add_development_dependency 'rake',          '>= 12.3.1'
-  gem.add_development_dependency 'rspec',         '>= 3.8'
-  gem.add_development_dependency 'rubocop',       '0.58.1'
-  gem.add_development_dependency 'rubocop-rspec', '1.30.0'
-  gem.add_development_dependency 'simplecov',     '~> 0.16.x'
-  gem.add_development_dependency 'yard',          '>= 0.9.18'
-  gem.add_development_dependency 'yardstick',     '>= 0.9.9'
+  gem.metadata['rubygems_mfa_required'] = 'true'
 end

data/docker-compose.yml

@@ -1,15 +1,32 @@
-version: '2'
+version: '3'
 services:
   base: &base
-    build:
-      context: ./
-    working_dir: /home/app/core_ext
+    image: core_ext
+    working_dir: /home/app/app
     volumes:
-      - .:/home/app/core_ext
+      - .:/home/app/app
 
-  #################### CONTAINERS ####################
+  base_build:
+    <<: *base
+    build: .
+    command: echo done
 
   core_ext:
     <<: *base
     container_name: core_ext
-    command: bash -c 'bundle exec rspec'
+    depends_on: [base_build]
+    command: /bin/bash -c 'rspec'
+
+  test_all:
+    <<: *base
+    depends_on: [base_build]
+    command: /bin/bash -c 'rspec && yard && rake yardstick_measure && rake verify_measurements'
+
+  core_ext_circleci:
+    image: darthjee/circleci_ruby_331:1.0.2
+    container_name: core_ext_circleci
+    command: /bin/bash
+    volumes:
+      - .:/home/circleci/project
+    environment:
+      PROJECT: core_ext

data/lib/darthjee/core_ext/array/hash_builder.rb

@@ -3,6 +3,9 @@
 module Darthjee
   module CoreExt
     module Array
+      # @api private
+      # @author Darthjee
+      #
       # Class responsible for building a Hash from 2 arrays
       #
       # @attribute [::Array] values
@@ -26,8 +29,6 @@ module Darthjee
       #
       #   builder.build == hash   # returns true
       class HashBuilder
-        attr_accessor :values, :keys
-
         # @param [::Array] values List of values of the hash
         # @param [::Array] keys List of keys of the hash
         def initialize(values, keys)
@@ -36,21 +37,37 @@ module Darthjee
         end
 
         # Builds the hash
-        # @return [::Hash] Hash whose keys and values are paired
-        #   from builder's keys and values
+        #
+        # The building happens through the pairing of
+        # keys and values
+        #
+        # @return [::Hash]
         def build
           fixes_sizes
 
-          ::Hash[[keys, values].transpose]
+          [keys, values].transpose.to_h
         end
 
         private
 
+        attr_reader :values, :keys
+
+        # @private
+        #
+        # Fixes the size of values array to match keys array size
+        #
+        # @return [::Array]
         def fixes_sizes
           return unless needs_resizing?
+
           values.concat ::Array.new(keys.size - values.size)
         end
 
+        # @private
+        #
+        # Checks if values array needs to be resized
+        #
+        # @return [::TrueClass,::FalseClass]
         def needs_resizing?
           keys.size > values.size
         end

data/lib/darthjee/core_ext/array.rb

@@ -2,6 +2,8 @@
 
 module Darthjee
   module CoreExt
+    # @api public
+    #
     # Module containing new usefull methods to Ruby vanilla Array
     module Array
       autoload :HashBuilder, 'darthjee/core_ext/array/hash_builder'
@@ -33,11 +35,11 @@ module Darthjee
       #   [].average # returns 0
       def average
         return 0 if empty?
+
         sum * 1.0 / length
       end
 
-      # Maps the array using the given methods on each
-      # element of the array
+      # Maps the array using the given methods on each element of the array
       #
       # @param [::String,::Symbol] methods List of methods to be called
       #   sequentially on each element of the array
@@ -59,13 +61,14 @@ module Darthjee
       #   output = words.chain_map(:size) do |size|
       #     (size % 2).zero? ? 'even size' : 'odd size'
       #   end  # returns ["even size", "even size", "odd size"]
-      def chain_map(*methods, &block)
+      def chain_map(*methods, &)
         result = methods.inject(self) do |array, method|
           array.map(&method)
         end
 
         return result unless block_given?
-        result.map(&block)
+
+        result.map(&)
       end
 
       # Maps array chain fetching the keys of the hashes inside
@@ -99,11 +102,15 @@ module Darthjee
       end
 
       # Joins elements in a string using a proc
-      # to convert elements to Strig and a block for joining
+      #
+      # Uses the proc given elements to Strig and a
+      # block for determinating the joining string
       #
       # @param [Proc] mapper Proc that will be used to map values
       # to string before joining
       #
+      # @return [String]
+      #
       # @yield [previous, nexte]
       #   defines the string to be used to join the previous and
       #   next element
@@ -122,21 +129,20 @@ module Darthjee
       #   end     # returns '1.0 +2.0 -3.0 -4.0 +5.0'
       def procedural_join(mapper = proc(&:to_s))
         return '' if empty?
-        list =     dup
-        previous = first
-        list[0] = mapper.call(previous).to_s
 
-        list.inject do |string, value|
-          link =        yield(previous, value) if block_given?
-          next_string = mapper.call(value)
-          previous = value
+        map = map_to_hash(&mapper)
 
-          "#{string}#{link}#{next_string}"
-        end
+        map.inject do |(previous, string), (nexte, nexte_string)|
+          link = yield(previous, nexte) if block_given?
+
+          [nexte, "#{string}#{link}#{nexte_string}"]
+        end.last.to_s
       end
 
       # Reeturns a random element of the array without altering it
       #
+      # @return [Object] random element of the array
+      #
       # @example Picking a random element of numeric array
       #   array = [10, 20, 30]
       #   array.random # might return 10, 20 or 30
@@ -147,6 +153,8 @@ module Darthjee
 
       # Reeturns a random element of the array removing it from the array
       #
+      # @return [Object] random element of the array
+      #
       # @example Slicing a random element of a numeric array
       #   array = [10, 20, 30]
       #   array.random! # might return 10, 20 or 30 ... lets say 20

data/lib/darthjee/core_ext/class.rb

@@ -2,6 +2,7 @@
 
 module Darthjee
   module CoreExt
+    # @api public
     module Class
       private
 
@@ -22,8 +23,6 @@ module Darthjee
       #   MyClass.new.name # returns 'John'
       #
       # @example Comparing value across instances
-      #   # frozen_string_literal: false
-      #
       #   class MyClass
       #     default_value :name, 'John'
       #   end
@@ -33,6 +32,8 @@ module Darthjee
       #
       #   instance.name.equal?('John')      # returns false
       #   instance.name.equal?(other.name)  # returns true
+      #
+      # @return [::Symbol] The name of the added method
       def default_value(name, value)
         define_method(name) { |*_| value }
       end
@@ -78,17 +79,24 @@ module Darthjee
       #
       #   instance.nick_name.equal?('John')        # returns false
       #   instance.nick_name.equal?(instance.name) # returns true
+      #
+      # @return [::Array<::Symbol>] Name of defined methods
       def default_values(*names, value)
-        names.each do |name|
+        names.map do |name|
           default_value(name, value)
         end
       end
 
       # @!visibility public
       #
-      # Creates a method that will act as reader, but will
-      # return a default value when the instance variable
-      # was never set
+      # Creates a method that will act as reader with default value
+      #
+      # The method will be a reader, but when no value was
+      # defined for the instance variable, it will
+      # return a default
+      #
+      # @param [::Symbol,::String] name Name of the method to be added
+      # @param [::Object] value default value
       #
       # @example Defining a default value
       #   class Person
@@ -119,18 +127,27 @@ module Darthjee
       #   model.name = 'Bob'
       #   model.name # returns 'Bob'
       #   Person.new.name # returns 'John Doe'
+      #
+      # @return [::Symbol] Defined method name
       def default_reader(name, value)
         define_method(name) do
           return value unless instance_variable_defined?("@#{name}")
+
           instance_variable_get("@#{name}")
         end
       end
 
       # @!visibility public
       #
-      # Creates methods that will act as readers, but will
-      # return a default value when the instance variables
-      # ware never set
+      # Creates methods that will act as reader with default value
+      #
+      # The methods will be readers, but when no value was
+      # defined for the instance variable, it will
+      # return a default
+      #
+      # @param [::Array<::Symbol,::String>] names Names of the
+      #   methods to be added
+      # @param [::Object] value default value
       #
       # @example Defining default values
       #   class Person
@@ -166,8 +183,10 @@ module Darthjee
       #   model.cars                           # returns 'none'
       #   model.cars.equal?('none')            # returns false
       #   model.nick_name.equal?(model.houses) # returns true
+      #
+      # @return [::Array<::Symbol>] Name of defined methods
       def default_readers(*names, value)
-        names.each do |name|
+        names.map do |name|
           default_reader(name, value)
         end
       end

data/lib/darthjee/core_ext/date.rb

@@ -2,6 +2,7 @@
 
 module Darthjee
   module CoreExt
+    # @api public
     module Date
       # Calculates the number of days between 2 dates
       #

data/lib/darthjee/core_ext/enumerable.rb

@@ -1,10 +1,30 @@
 # frozen_string_literal: true
 
+# @api public
 module Enumerable
-  # (see #clean!)
+  # Removes any element that is nil or empty
+  #
+  # @see #clean!
   #
   # This method does not change the original
   # enumerable
+  #
+  # @example cleaning a Hash
+  #   hash = {
+  #     keep: 'value',
+  #     nil_value: nil,
+  #     empty_array: [],
+  #     empty_string: '',
+  #     empty_hash: {}
+  #   }
+  #
+  #   hash.clean  # returns { keep: 'value' } without changing the hash
+  #
+  # @example cleaning an Array
+  #   array = ['value', nil, [], '', {}]
+  #
+  #   array.clean  # returns ['value'] without changing the array
+  # @return [::Enumerable] same class of +self+
   def clean
     deep_dup.clean!
   end
@@ -21,23 +41,23 @@ module Enumerable
   #     empty_string: '',
   #     empty_hash: {}
   #   }
-  #   hash.clean! # changes the hash to
-  #               # { keep: 'value' }
+  #
+  #   hash.clean! # changes the hash to { keep: 'value' }
   #
   # @example cleaning an Array
   #   array = ['value', nil, [], '', {}]
-  #   array.clean! # changes the array to be
-  #                # ['value']
+  #
+  #   array.clean! # changes the array to be  ['value']
+  #
+  # @return [::Enumerable] same class of +self+
   def clean!
-    if is_a?(Hash)
-      delete_if { |_k, v| empty_value?(v) }
-    else
-      delete_if { |v| empty_value?(v) }
-    end
+    delete_if { |*args| empty_value?(args.last) }
   end
 
-  # Maps the elements into a new value, returning
-  # the first element that is evaluated to true
+  # Maps the elements into a new value, returning only one
+  #
+  # The result to be returned is
+  # the first mapping that is evaluated to true
   #
   # This method is equivalent to #map#find but
   # only calling the map block up to when a value
@@ -57,10 +77,14 @@ module Enumerable
   #
   #   keys = %i[a b c d e]
   #
-  #   keys.map_and_find { |key| service_values.delete(key) }
-  #               # returns 'found me'
+  #   keys.map_and_find do |key|   #
+  #     service_values.delete(key) #
+  #   end                          # returns 'found me'
+  #
   #   service_map # has lost only 3 keys returning
   #               # { d: nil, e: 'didnt find me' }
+  #
+  # @return [::Object]
   def map_and_find
     mapped = nil
     find do |*args|
@@ -69,8 +93,10 @@ module Enumerable
     mapped || nil
   end
 
-  # Maps the elements into a new value returning an
-  # array of the values mapped to non false values
+  # Maps the elements into a new value returning a subset
+  #
+  # The subset returned has the values mapped to non
+  # false values
   #
   # This method is equivalent to call #map#select
   #
@@ -88,15 +114,18 @@ module Enumerable
   #   end
   #
   #   values # returns [3, 1]
-  def map_and_select
-    mapped = map do |*args|
-      yield(*args)
-    end
-    mapped.select { |e| e }
+  #
+  # @return [::Array<::Object>]
+  def map_and_select(&)
+    map(&).select(&:trueful?)
   end
 
-  # Maps values and creates a hash whose values are
-  # the result of the #map and the keys are the original values
+  # Maps values and creates a hash
+  #
+  # The keys will be the original values used in the
+  # mapping and the values the result of the #map
+  #
+  # @return [::Hash]
   #
   # @yield (*args) the mapping block
   #
@@ -105,17 +134,26 @@ module Enumerable
   #
   #   strings.map_to_hash(&:size) # returns { 'word' => 4, 'big_word' => 8 }
   def map_to_hash
-    {}.tap do |hash|
-      each do |element|
-        hash[element] = yield(element)
-      end
+    to_h do |value|
+      [value, yield(value)]
     end
   end
 
   private
 
+  # @api private
+  #
+  # @private
+  #
+  # Checks if a value is considered empty
+  #
+  # This also clean empty values
+  #
+  # @return [::TrueClass,::FalseClass]
   def empty_value?(value)
-    value.nil? || value.try(:empty?) ||
-      ((value.is_a?(Hash) || value.is_a?(Array)) && value.clean!.empty?)
+    return true unless value.present?
+    return false unless value.is_a?(Enumerable)
+
+    value.clean!.empty?
   end
 end