darthjee-core_ext 1.7.4 → 2.0.0

data/MATH_README.md

@@ -4,12 +4,9 @@
 calculates the average of the given values
 
 ```ruby
-Math.average([ 0, 1, 2, 3, 4 ])
-```
+Math.average([0, 1, 2, 3, 4, 5])
 
-returns
-```
-2
+# returns 2.5
 ```
 
 It can also be used to calculate the average of weighted values
@@ -20,11 +17,18 @@ Math.average(
   1 => 2,
   2 => 3,
   3 => 4,
-  4 => 5
+  4 => 6
 )
-```
 
-returns
-```
-2.6666
+# returns 2.6666
 ```
+
+## Added by Object
+- [#is_any?](OBJECT_README.md#is_any?)
+- [#trueful?](OBJECT_README.md#trueful?)
+
+## 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/OBJECT_README.md

@@ -1,50 +1,33 @@
 ## Object
 
-### .default_value
-Adds a method with default value
+### #is_any?
+returns if the object is an instance of any of the given classes
 
 ```ruby
-class TheClass
-  default_value :the_method, 10
-end.new.the_method
-```
-
-will return
+1.is_any?(String, Symbol)
 
-```ruby
-10
+# returns false
 ```
 
-### .default_values
-Add several methods with single return value
-
 ```ruby
-class TheIntermediateChild < TheParent
-  default_values :is_child?, :is_final?, true
-end.new.is_child?
-```
-
-will return
+1.is_any?(String, Symbol, Numeric)
 
-```ruby
-true
+# returns true
 ```
 
-### #is_any?
-returns if the object is an instance of any of the given classes
+## #trueful?
 
 ```ruby
-1.is_any?(String, Symbol)
-```
-returns
-```ruby
-false
+nil.trueful?         # returns false
+[].trueful?          # returns true
+{}.trueful?          # returns true
+"".trueful?          # returns true
+0.trueful?           # returns true
+Object.new.trueful?  # returns true
 ```
 
-```ruby
-1.is_any?(String, Symbol, Numeric)
-```
-returns
-```ruby
-false
-```
+## 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/README.md

@@ -1,14 +1,16 @@
 Darthjee/CoreExt
 ========
 
-![core_ext](https://raw.githubusercontent.com/darthjee/core_ext/master/mech.jpg)
+[![Code Climate](https://codeclimate.com/github/darthjee/core_ext/badges/gpa.svg)](https://codeclimate.com/github/darthjee/core_ext)
+[![Test Coverage](https://codeclimate.com/github/darthjee/core_ext/badges/coverage.svg)](https://codeclimate.com/github/darthjee/core_ext/coverage)
+[![Issue Count](https://codeclimate.com/github/darthjee/core_ext/badges/issue_count.svg)](https://codeclimate.com/github/darthjee/core_ext)
+[![Gem Version](https://badge.fury.io/rb/darthjee-core_ext.svg)](https://badge.fury.io/rb/darthjee-core_ext)
 
-[![Maintainability](https://api.codeclimate.com/v1/badges/23f472dcc717ed285737/maintainability)](https://codeclimate.com/github/darthjee/core_ext/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/23f472dcc717ed285737/test_coverage)](https://codeclimate.com/github/darthjee/core_ext/test_coverage)
+![core_ext](https://raw.githubusercontent.com/darthjee/core_ext/master/mech.jpg)
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/darthjee-core_ext/1.7.3
+https://www.rubydoc.info/gems/darthjee-core_ext/2.0.0
 
 # Usage
 This project adds some new methods to the core ruby classes
@@ -45,3 +47,5 @@ bundle install darthjee-core_ext
 [OBJECT_README.md](OBJECT_README.md)
 ## Math
 [MATH_README.md](MATH_README.md)
+## Class
+[CLASS_README.md](CLASS_README.md)

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/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,13 +5,14 @@ $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 = '>= 2.4.0'
 
   gem.files         = `git ls-files -z`.split("\x0")
   gem.executables   = gem.files.grep(%r{^bin/}) { |f| File.basename(f) }
@@ -20,12 +21,13 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'activesupport', '>= 5.2.x'
 
-  gem.add_development_dependency 'bundler',       '~> 1.17.x'
+  gem.add_development_dependency 'bundler',       '~> 1.17.3'
   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 'rubycritic',    '>= 4.0.2'
   gem.add_development_dependency 'simplecov',     '~> 0.16.x'
   gem.add_development_dependency 'yard',          '>= 0.9.18'
   gem.add_development_dependency 'yardstick',     '>= 0.9.9'

data/docker-compose.yml

@@ -1,15 +1,23 @@
-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'

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'
@@ -36,8 +38,7 @@ module Darthjee
         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
@@ -99,11 +100,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 +127,19 @@ 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
+        map = map_to_hash(&mapper)
 
-        list.inject do |string, value|
-          link =        yield(previous, value) if block_given?
-          next_string = mapper.call(value)
-          previous = value
+        map.inject do |(previous, string), (nexte, nexte_string)|
+          link = yield(previous, nexte) if block_given?
 
-          "#{string}#{link}#{next_string}"
-        end
+          [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 +150,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/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,8 +37,11 @@ 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
 
@@ -46,11 +50,23 @@ module Darthjee
 
         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