darthjee-core_ext 1.7.3 → 1.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 75f22a94cfe27dfcc43f9209d7684ee7cef8546c
-  data.tar.gz: 7077d45122b6498b960f459c5fda5c9965138902
+  metadata.gz: 103b4b6d1acc61970210009223f1dafb42ffe566
+  data.tar.gz: 6887e4ef498e5e8edaa14c604ac8b79b91f9e709
 SHA512:
-  metadata.gz: df8e4a2c6c6a6b27611d9ba1d52785323239ec7df2a9239862a1116db897b4112a875d6d279f1a507c7906615247d88375198a9e921e33d9272c6e76d8e46d4c
-  data.tar.gz: a71629faafba5302d768e80c556d5deec6249e9a09b14f1a3fd7457e97edf4d14bcd075ca89b89d0c9a2110e2dfcf6e6b86ea3540c43ad334c5e50de1da70b8b
+  metadata.gz: 21eed9f42d42a66a273413cdd784b32e3f1b07b9be39e6c34e8dba7162c442ad2cb4b96be93177a4d6b33e87e20365524b4e5d72bccbe27cbc22d1f0943c28db
+  data.tar.gz: 6de12c71400aa5f5cbd50b7614df418c50815ddf4f222cfe56b3cc852acbd2a745108e3f56394f065de4fb9c518fe02b0a77ddc02669f626b17f0c77b7b17054

data/.circleci/config.yml

@@ -2,13 +2,24 @@ version: 2
 jobs:
   build:
     docker:
-      - image: circleci/ruby:2.4.1
+      - image: darthjee/circleci_ruby_240:0.1.0
     steps:
       - checkout
-      - run: curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-      - run: chmod +x ./cc-test-reporter
-      - run: ./cc-test-reporter before-build
-      - run: bundle install
-      - run: bundle exec rspec
-      - run: rubocop
-      - run: ./cc-test-reporter after-build --exit-code $?
+      - run:
+          name: Prepare Coverage Test Report
+          command: cc-test-reporter before-build
+      - run:
+          name: Bundle Install
+          command: bundle install
+      - run:
+          name: RSpec
+          command: bundle exec rspec
+      - run:
+          name: Rubocop
+          command: rubocop
+      - run:
+          name: Coverage Test Report
+          command: cc-test-reporter after-build --exit-code $?
+      - run:
+          name: Yardstick coverage check
+          command: bundle exec rake verify_measurements

data/.gitignore

@@ -3,3 +3,4 @@ pkg
 Gemfile.lock
 doc
 .yardoc
+measurement

data/.rubocop.yml

@@ -1,3 +1,4 @@
+require: rubocop-rspec
 inherit_from: .rubocop_todo.yml
 
 AllCops:
@@ -11,3 +12,9 @@ Metrics/BlockLength:
   Exclude:
     - 'spec/**/*_spec.rb'
     - 'spec/support/shared_*/**/*.rb'
+
+RSpec/AlignLeftLetBrace:
+  Enabled: true
+
+RSpec/NestedGroups:
+  Max: 5

data/.rubocop_todo.yml

@@ -1,12 +1,16 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-07-26 20:39:06 +0000 using RuboCop version 0.58.1.
+# on 2019-02-18 18:10:37 +0000 using RuboCop version 0.58.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 16
+# Offense count: 3
+# Configuration parameters: AggregateFailuresByDefault.
+RSpec/MultipleExpectations:
+  Max: 2
+
+# Offense count: 24
 Style/Documentation:
   Enabled: false
-

data/Dockerfile

@@ -0,0 +1,9 @@
+FROM darthjee/ruby_240:0.2.2
+
+USER app
+COPY ./ /home/app/app/
+
+RUN gem uninstall bundler
+RUN gem install bundler -v '1.17.3'
+RUN bundle install
+

data/README.md

@@ -3,9 +3,8 @@ 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)
+[![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)
 
 Yard Documentation
 -------------------
@@ -16,17 +15,17 @@ This project adds some new methods to the core ruby classes
 
 To use core-ext either intall directly
 
-```console
+```shell
 gem install darthjee-core_ext
 ```
 
 or add it to Gemfile
 
-```
+```shell
 gem 'darthjee-core_ext'
 ```
 
-```console
+```shell
 bundle install darthjee-core_ext
 ```
 

data/Rakefile

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

data/config/yardstick.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'yardstick/rake/measurement'
+require 'yardstick/rake/verify'
+require 'yaml'
+
+options = YAML.load_file('config/yardstick.yml')
+
+Yardstick::Rake::Measurement.new(:yardstick_measure, options) do |measurement|
+  measurement.output = 'measurement/report.txt'
+end
+
+Yardstick::Rake::Verify.new(:verify_measurements, options)

data/config/yardstick.yml

@@ -0,0 +1,35 @@
+threshold: 65.4
+require_exact_threshold: false
+rules:
+  ApiTag::Presence:
+    enabled: true
+    exclude: []
+  ApiTag::Inclusion:
+    enabled: true
+    exclude: []
+  ApiTag::ProtectedMethod:
+    enabled: true
+    exclude: []
+  ApiTag::PrivateMethod:
+    enabled: true
+    exclude: []
+  ExampleTag:
+    enabled: true
+    exclude: []
+  ReturnTag:
+    enabled: true
+    exclude:
+      - Darthjee::CoreExt::Hash::ChainFetcher
+  Summary::Presence:
+    enabled: true
+    exclude:
+      - Darthjee::CoreExt::Hash::ChainFetcher
+  Summary::Length:
+    enabled: true
+    exclude: []
+  Summary::Delimiter:
+    enabled: true
+    exclude: []
+  Summary::SingleLine:
+    enabled: true
+    exclude: []

data/core_ext.gemspec

@@ -20,11 +20,13 @@ Gem::Specification.new do |gem|
 
   gem.add_runtime_dependency 'activesupport', '>= 5.2.x'
 
-  gem.add_development_dependency 'bundler'
-  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 'simplecov', '~> 0.16.x'
-  gem.add_development_dependency 'yard',      '>= 0.9'
+  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'
 end

data/docker-compose.yml

@@ -1,18 +1,15 @@
 version: '2'
 services:
   base: &base
-    image: ruby:2.4.0
+    build:
+      context: ./
     working_dir: /home/app/core_ext
     volumes:
       - .:/home/app/core_ext
-      - core_ext_gems_2_4_0:/usr/local/bundle
 
   #################### CONTAINERS ####################
 
   core_ext:
     <<: *base
     container_name: core_ext
-    command: bash -c 'gem install bundler; bundle install;  bundle exec rspec'
-
-volumes:
-  core_ext_gems_2_4_0:
+    command: bash -c 'bundle exec rspec'

data/lib/darthjee/core_ext/array.rb

@@ -142,7 +142,7 @@ module Darthjee
       #   array.random # might return 10, 20 or 30
       #   array        # returns unchanged [10, 20, 30]
       def random
-        self[rand(size)]
+        self[Random.rand(size)]
       end
 
       # Reeturns a random element of the array removing it from the array
@@ -152,7 +152,7 @@ module Darthjee
       #   array.random! # might return 10, 20 or 30 ... lets say 20
       #   array         # returns changed [20, 30]
       def random!
-        slice!(rand(size))
+        slice!(Random.rand(size))
       end
     end
   end

data/lib/darthjee/core_ext/class.rb

@@ -48,6 +48,8 @@ module Darthjee
       #   methods to be added
       # @param [::Object] value default value
       #
+      # @see default_value
+      #
       # @example Defining a default values
       #   class MyClass
       #     default_values :name, :nick_name, 'John'
@@ -57,8 +59,6 @@ module Darthjee
       #   MyClass.new.nick_name # returns 'John'
       #
       # @example Comparing value across instances
-      #   # frozen_string_literal: false
-      #
       #   class MyClass
       #     default_values :name, :nick_name, 'John'
       #   end
@@ -70,8 +70,6 @@ module Darthjee
       #   instance.name.equal?(other.name) # returns true
       #
       # @example Comparing value across methods
-      #   # frozen_string_literal: false
-      #
       #   class MyClass
       #     default_values :name, :nick_name, 'John'
       #   end
@@ -85,6 +83,94 @@ module Darthjee
           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
+      #
+      # @example Defining a default value
+      #   class Person
+      #     attr_writer :name
+      #     default_reader :name, 'John Doe'
+      #   end
+      #
+      #   model = Person.new
+      #
+      #   model.name # returns 'John Doe'
+      #
+      # @example Changing the instance value
+      #
+      #   model = Person.new
+      #   model.name # returns 'John Doe'
+      #
+      #   model.name = 'Joe'
+      #   model.name # returns 'Joe'
+      #
+      #   model.name = nil
+      #   model.name # returns nil
+      #
+      # @example Changing values accros instances
+      #
+      #   model = Person.new
+      #   model.name # returns 'John Doe'
+      #
+      #   model.name = 'Bob'
+      #   model.name # returns 'Bob'
+      #   Person.new.name # returns 'John Doe'
+      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
+      #
+      # @example Defining default values
+      #   class Person
+      #     attr_writer :cars, :houses
+      #     default_reader :cars, :houses, 'none'
+      #   end
+      #
+      #   model = Person.new
+      #
+      #   model.cars # returns 'none'
+      #
+      # @example Changing the instance value
+      #
+      #   model = Person.new
+      #   model.cars # returns 'none'
+      #
+      #   model.cars = ['volvo']
+      #   model.cars # returns ['volvo']
+      #
+      #   model.cars = nil
+      #   model.cars # returns nil
+      #
+      # @example Changing values accros instances
+      #
+      #   model = Person.new
+      #   model.cars # returns 'none'
+      #
+      #   model.cars = ['volvo']
+      #   model.cars # returns ['volvo']
+      #   Person.new.cars # returns 'none'
+      #
+      # @example Comparing value across methods
+      #   model.cars                           # returns 'none'
+      #   model.cars.equal?('none')            # returns false
+      #   model.nick_name.equal?(model.houses) # returns true
+      def default_readers(*names, value)
+        names.each do |name|
+          default_reader(name, value)
+        end
+      end
     end
   end
 end

data/lib/darthjee/core_ext/enumerable.rb

@@ -1,13 +1,17 @@
 # frozen_string_literal: true
 
 module Enumerable
+  # (see #clean!)
+  #
+  # This method does not change the original
+  # enumerable
   def clean
     deep_dup.clean!
   end
 
   # Removes any element that is nil or empty
   #
-  # @returns [::Enumerable] the enumerable itself
+  # @return [::Enumerable] the enumerable itself
   #
   # @example cleaning a Hash
   #   hash = {

data/lib/darthjee/core_ext/hash.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'darthjee/core_ext/hash/cameliazable'
 require 'darthjee/core_ext/hash/key_changeable'
 require 'darthjee/core_ext/hash/transposeable'
 require 'darthjee/core_ext/hash/transformable'
@@ -15,6 +16,7 @@ module Darthjee
       autoload :ValueChanger,        "#{PATH}/hash/value_changer"
       autoload :ToHashMapper,        "#{PATH}/hash/to_hash_mapper"
 
+      include Hash::Cameliazable
       include Hash::KeyChangeable
       include Hash::Transposeable
       include Hash::Transformable
@@ -23,6 +25,34 @@ module Darthjee
       # Fetching methods
       #########################################
 
+      # Crawls through the hash fetching a key value from inside it
+      #
+      # this is the equivalent of chaining several calls to fetch method
+      #
+      # ```
+      #   hash.chain_fetch(:key1, :key2)
+      #   hash.fetch(:key1).fetch(:key2)
+      # ```
+      #
+      # @param [::Array<::Object>] keys List of keys to be fetched
+      # @param [::Proc] block block to be called in case of key not found
+      # @yield (key_not_found, keys_missing) The result of the yield
+      #   will be the returned value instead of raising KeyError
+      #
+      # @return Object value fetched
+      #
+      # @example
+      #   hash = {
+      #     a: {
+      #       b: { c: 1, d: 2 }
+      #     }
+      #   }
+      #
+      #   hash.chain_fetch(:a, :b, :c) # returns 1
+      #   hash.chain_fetch(:a, :c, :d) # raises KeyError
+      #   hash.chain_fetch(:a, :c, :d) { 10 } # returns 10
+      #   hash.chain_fetch(:a, :c, :d) { |key, _| key } # returns :c
+      #   hash.chain_fetch(:a, :c, :d) { |_, missing| missing } # returns [:d]
       def chain_fetch(*keys, &block)
         ::Hash::ChainFetcher.new(self, *keys, &block).fetch
       end

data/lib/darthjee/core_ext/hash/cameliazable.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Darthjee
+  module CoreExt
+    module Hash
+      # Module holding methods responsible for camelizing
+      # keys of a hash
+      #
+      # @api public
+      module Cameliazable
+        # Change keys to CamelCase without changing the
+        # original hash
+        #
+        # @return [::Hash] new hash with changed keys
+        # @param [::Hash] options options of camelization
+        # @option options [::Boolean] uppercase_first_letter: flag
+        #   defining the type of CamelCase
+        #
+        # @see Hash::KeyChanger#camelize_keys
+        #
+        # @example
+        #   hash = { first_key: 1, 'second_key' => 2 }
+        #   hash.camelize_keys # returns {
+        #                      #   FirstKey: 1,
+        #                      #   'SecondKey' => 2
+        #                      # }
+        #
+        # @example
+        #   hash = { first_key: 1, 'second_key' => 2 }
+        #   options = { uppercase_first_letter: false }
+        #   hash.camelize_keys(options) # returns {
+        #                               #   firstKey: 1,
+        #                               #   'secondKey' => 2
+        #                               # }
+        #
+        def camelize_keys(options = {})
+          dup.camelize_keys!(options)
+        end
+
+        # Change keys to CamelCase changing the
+        # original hash
+        #
+        # @return [::Hash] new hash with changed keys
+        # @param [::Hash] options options of camelization
+        # @option options [::Boolean] uppercase_first_letter: flag
+        #   defining the type of CamelCase
+        #
+        # @example (see #camelize_keys)
+        #
+        # @see #camelize_keys
+        def camelize_keys!(options = {})
+          Hash::KeyChanger.new(self).camelize_keys(options)
+        end
+
+        # Camelize all keys in the hash as `key.camelize(:lower)
+        #
+        # @return [::Hash] the resulting hash
+        #
+        # @example
+        #   hash = { first_key: 1, 'second_key' => 2 }
+        #   hash.lower_camelize_keys # {
+        #                            #   firstKey: 1,
+        #                            #   'secondKey' => 2
+        #                            # }
+        #
+        def lower_camelize_keys(options = {})
+          dup.lower_camelize_keys!(options)
+        end
+
+        # Camelize all keys in the hash
+        #
+        # @return [::Hash] self after changing the keys
+        #
+        # @example (see #lower_camelize_keys)
+        def lower_camelize_keys!(options = {})
+          options = options.merge(uppercase_first_letter: false)
+
+          camelize_keys!(options)
+        end
+
+        def underscore_keys(options = {})
+          dup.underscore_keys!(options)
+        end
+
+        def underscore_keys!(options = {})
+          Hash::KeyChanger.new(self).underscore_keys(options)
+        end
+      end
+    end
+  end
+end