lite-ruby 1.3.2 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e3035bce45906f90af5be5db4a0caca9581e73225b46c1639ef98df7ac431ef
-  data.tar.gz: 566859827bee72df021c49499b5c4f8c48c880633057a64de94ae491bfdec94f
+  metadata.gz: 22d988f2dbe25b5c04f273b924da8cc9f959e6bbf0c54405abfc7153e6639d13
+  data.tar.gz: 2e01d2a910067c3495299e2fa1a93e640f9a9051316389507ba2369d8704ba04
 SHA512:
-  metadata.gz: 6039e7334d7eace9f2cc0537c8d3b2fe6da1f8e2ec296d445acf0bb2fcae62a9c69b16ea002cffdd75a09178e6b0671f3075045b952493135fae184a27d91054
-  data.tar.gz: a9aa682a454cbd7084e74533f7aebdfed02c27fc321e6c6650d872f695d74222d7d7246cd647d1f8b57abe18b14eea6da365e5225fd5396798774e195a5898cc
+  metadata.gz: 0657f33f0ec47ccc0bcff90ad6992d12b66e43b31738ee8dbb4220059ea25784b25cb7e4a442ac39fd01e8b1f75c7adb2178ccd0759c852e4f2534f4711de168
+  data.tar.gz: 2cfaa631e59ba2643125937b026a872d2bd81f969ec853f2b4ef5fcc7f80512a8a26b53a8586527732ec2f7883a6e1bfc4bf31ae541e7bbff4a641a90719238b

data/CHANGELOG.md

@@ -6,6 +6,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.0.2] - 2021-07-22
+### Changed
+- Changed `all.rb` => `monkey_patches.rb`
+
+## [2.0.1] - 2021-07-22
+### Added
+- Added `all.rb` for monkey patching everything with one command.
+
+## [2.0.0] - 2021-07-22
+### Added
+- Added Hash => `deep_key?`
+### Changed
+- Update install generator to reflect configuration changes
+### Removed
+- Removed configuration to use explicit inclusions
+
+## [1.3.3] - 2021-07-21
+### Changed
+- Improved generator support
+
 ## [1.3.2] - 2021-07-20
 ### Changed
 - Argument passing for try and send methods

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lite-ruby (1.3.2)
+    lite-ruby (2.0.2)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -33,16 +33,36 @@ Or install it yourself as:
 
 ## Configurations
 
+Any and all monkey patches must be explicitly included anywhere you want to use it.
+
+To globally use the money patches, just create an initializer requiring them.
+
 `rails g lite:ruby:install` will generate the following file:
 `../config/initalizers/lite_ruby.rb`
 
+They can be disabled by commenting any of them out.
+
 ```ruby
-Lite::Ruby.configure do |config|
-  config.monkey_patches = %w[
-    array boolean date enumerable hash integer kernel numeric object open_struct range string
-    struct time
-  ]
-end
+# frozen_string_literal: true
+
+require 'lite/ruby/monkey_patches'
+
+# - or -
+
+# require 'lite/ruby/array'
+# require 'lite/ruby/boolean'
+# require 'lite/ruby/date'
+# require 'lite/ruby/enumerable'
+# require 'lite/ruby/hash'
+# require 'lite/ruby/integer'
+# require 'lite/ruby/kernel'
+# require 'lite/ruby/numeric'
+# require 'lite/ruby/object'
+# require 'lite/ruby/open_struct'
+# require 'lite/ruby/range'
+# require 'lite/ruby/string'
+# require 'lite/ruby/struct'
+# require 'lite/ruby/time'
 ```
 
 ## Extensions

data/docs/HASH.md

@@ -160,6 +160,19 @@ h2 = { a: false, b: { x: [3, 4, 5] } }
 h1.deep_merge(h2) #=> { a: false, b: { c: [1, 2, 3], x: [3, 4, 5] } }
 ```
 
+`deep_key`
+------
+Returns if a set of nested keys exists.
+
+```ruby
+h1 = { a: { c: { d: 2 } }, b: 1 }
+
+h1.deep_key?(:a)         #=> true
+h1.deep_key?(:a, :c, :d) #=> true
+h1.deep_key?(:x)         #=> false
+h1.deep_key?(:a, :c, :x) #=> false
+```
+
 `delete_unless`
 ------
 Inverse of `delete_if`.

data/lib/generators/lite/ruby/install_generator.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'rails/generators'
-
 module Lite
   module Ruby
     class InstallGenerator < Rails::Generators::Base

data/lib/generators/lite/ruby/templates/install.rb

@@ -1,8 +1,20 @@
 # frozen_string_literal: true
 
-Lite::Ruby.configure do |config|
-  config.monkey_patches = %w[
-    array boolean date enumerable hash integer kernel numeric object open_struct range string
-    struct time
-  ]
-end
+require 'lite/ruby/monkey_patches'
+
+# - or -
+
+# require 'lite/ruby/array'
+# require 'lite/ruby/boolean'
+# require 'lite/ruby/date'
+# require 'lite/ruby/enumerable'
+# require 'lite/ruby/hash'
+# require 'lite/ruby/integer'
+# require 'lite/ruby/kernel'
+# require 'lite/ruby/numeric'
+# require 'lite/ruby/object'
+# require 'lite/ruby/open_struct'
+# require 'lite/ruby/range'
+# require 'lite/ruby/string'
+# require 'lite/ruby/struct'
+# require 'lite/ruby/time'

data/lib/lite/ruby.rb

@@ -1,18 +1,5 @@
 # frozen_string_literal: true
 
-%w[version configuration].each do |filename|
-  require "lite/ruby/#{filename}"
-end
+require 'generators/lite/ruby/install_generator' if defined?(Rails::Generators)
 
-%w[date time].each do |filename|
-  require "lite/ruby/helpers/#{filename}_helper"
-end
-
-%w[
-  array boolean date enumerable hash integer kernel numeric object open_struct range string
-  struct time
-].each do |filename|
-  require "lite/ruby/#{filename}"
-end
-
-require 'generators/lite/ruby/install_generator'
+require 'lite/ruby/version'

data/lib/lite/ruby/array.rb

@@ -1,301 +1,299 @@
 # frozen_string_literal: true
 
-if Lite::Ruby.configuration.monkey_patches.include?('array')
-  class Array
+class Array
 
-    def assert_min_values!(*valid_values)
-      return self if empty?
+  def assert_min_values!(*valid_values)
+    return self if empty?
 
-      valid_values.each do |value|
-        next if include?(value)
+    valid_values.each do |value|
+      next if include?(value)
 
-        raise ArgumentError,
-              "Missing value: #{value.inspect}. " \
-              "Minimum values are: #{valid_values.map(&:inspect).join(', ')}"
-      end
-
-      self
+      raise ArgumentError,
+            "Missing value: #{value.inspect}. " \
+            "Minimum values are: #{valid_values.map(&:inspect).join(', ')}"
     end
 
-    def assert_all_min_values!(*valid_values)
-      return assert_min_values!(*valid_values) unless empty?
+    self
+  end
 
-      raise ArgumentError, 'An empty array is not allowed'
-    end
+  def assert_all_min_values!(*valid_values)
+    return assert_min_values!(*valid_values) unless empty?
 
-    def assert_valid_values!(*valid_values)
-      each do |value|
-        next if valid_values.include?(value)
+    raise ArgumentError, 'An empty array is not allowed'
+  end
 
-        raise ArgumentError,
-              "Invalid value: #{value.inspect}. " \
-              "Allowed values are: #{valid_values.map(&:inspect).join(', ')}"
-      end
+  def assert_valid_values!(*valid_values)
+    each do |value|
+      next if valid_values.include?(value)
+
+      raise ArgumentError,
+            "Invalid value: #{value.inspect}. " \
+            "Allowed values are: #{valid_values.map(&:inspect).join(', ')}"
     end
+  end
 
-    def assert_all_valid_values!(*valid_values)
-      return assert_valid_values!(*valid_values) unless empty?
+  def assert_all_valid_values!(*valid_values)
+    return assert_valid_values!(*valid_values) unless empty?
 
-      raise ArgumentError, 'An empty array is not allowed'
-    end
+    raise ArgumentError, 'An empty array is not allowed'
+  end
 
-    def assert_value_presence!
-      each do |value|
-        next if value.respond_to?(:present?) ? value.present? : value
+  def assert_value_presence!
+    each do |value|
+      next if value.respond_to?(:present?) ? value.present? : value
 
-        raise ArgumentError, "A #{value.inspect} value is not allowed"
-      end
+      raise ArgumentError, "A #{value.inspect} value is not allowed"
     end
+  end
 
-    def assert_all_value_presence!
-      return assert_value_presence! unless empty?
+  def assert_all_value_presence!
+    return assert_value_presence! unless empty?
 
-      raise ArgumentError, 'An empty array is not allowed'
-    end
+    raise ArgumentError, 'An empty array is not allowed'
+  end
 
-    def after(value)
-      return unless include?(value)
+  def after(value)
+    return unless include?(value)
 
-      self[(index(value) + 1) % size]
-    end
+    self[(index(value) + 1) % size]
+  end
 
-    def all_after(value)
-      return unless include?(value)
+  def all_after(value)
+    return unless include?(value)
 
-      i = index(value)
-      return if i == (size - 1)
+    i = index(value)
+    return if i == (size - 1)
 
-      self[(i + 1)..-1]
-    end
+    self[(i + 1)..-1]
+  end
 
-    def all_before(value)
-      return unless include?(value)
+  def all_before(value)
+    return unless include?(value)
 
-      i = index(value)
-      return if i.zero?
+    i = index(value)
+    return if i.zero?
 
-      self[0..(i - 1)]
-    end
+    self[0..(i - 1)]
+  end
 
-    def before(value)
-      return unless include?(value)
+  def before(value)
+    return unless include?(value)
 
-      self[(index(value) - 1) % size]
-    end
+    self[(index(value) - 1) % size]
+  end
 
-    # rubocop:disable Metrics/AbcSize, Metrics/BlockNesting, Metrics/MethodLength
-    # rubocop:disable Metrics/PerceivedComplexity, Style/GuardClause, Style/IfInsideElse
-    def bury(*args)
-      if args.count < 2
-        raise ArgumentError, '2 or more arguments required'
-      elsif args.count == 2
-        if args[0].is_a?(Integer)
-          self[args[0]] = args[1]
-        else
-          self << { args[0] => args[1] }
-        end
+  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
+  # rubocop:disable Style/GuardClause, Style/IfInsideElse
+  def bury(*args)
+    if args.count < 2
+      raise ArgumentError, '2 or more arguments required'
+    elsif args.count == 2
+      if args[0].is_a?(Integer)
+        self[args[0]] = args[1]
       else
-        if args[0].is_a?(Integer)
-          arg = args.shift
-          self[arg] = [] unless self[arg]
-          self[arg].bury(*args)
-        else
-          self << {}.bury(*args)
-        end
+        self << { args[0] => args[1] }
+      end
+    else
+      if args[0].is_a?(Integer)
+        arg = args.shift
+        self[arg] = [] unless self[arg]
+        self[arg].bury(*args)
+      else
+        self << {}.bury(*args)
       end
-
-      self
-    end
-    # rubocop:enable Metrics/PerceivedComplexity, Style/GuardClause, Style/IfInsideElse
-    # rubocop:enable Metrics/AbcSize, Metrics/BlockNesting, Metrics/MethodLength
-
-    def contains_all?(other)
-      (other & self) == self
     end
 
-    def contains_any?(other)
-      !contains_none?(other)
-    end
+    self
+  end
+  # rubocop:enable Style/GuardClause, Style/IfInsideElse
+  # rubocop:enable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity
 
-    def contains_none?(other)
-      (other & self).empty?
-    end
+  def contains_all?(other)
+    (other & self) == self
+  end
 
-    def delete_first
-      self[1..-1]
-    end
+  def contains_any?(other)
+    !contains_none?(other)
+  end
 
-    def delete_first!
-      replace(delete_first)
-    end
+  def contains_none?(other)
+    (other & self).empty?
+  end
 
-    def delete_last
-      self[0...-1]
-    end
+  def delete_first
+    self[1..-1]
+  end
 
-    def delete_last!
-      replace(delete_last)
-    end
+  def delete_first!
+    replace(delete_first)
+  end
 
-    def delete_values(*args)
-      args.each_with_object([]) { |val, array| array << delete(val) }
-    end
+  def delete_last
+    self[0...-1]
+  end
 
-    def demote(value)
-      sort_by { |val| val == value ? 0 : -1 }
-    end
+  def delete_last!
+    replace(delete_last)
+  end
 
-    def demote!(value)
-      replace(demote(value))
-    end
+  def delete_values(*args)
+    args.each_with_object([]) { |val, array| array << delete(val) }
+  end
 
-    def denillify(identity = 0)
-      map { |val| val || identity }
-    end
+  def demote(value)
+    sort_by { |val| val == value ? 0 : -1 }
+  end
 
-    def denillify!(identity = 0)
-      replace(denillify(identity))
-    end
+  def demote!(value)
+    replace(demote(value))
+  end
 
-    def divergence(other)
-      (self - other) | (other - self)
-    end
+  def denillify(identity = 0)
+    map { |val| val || identity }
+  end
 
-    def duplicates(minimum = 2)
-      hash = Hash.new(0)
-      each { |val| hash[val] += 1 }
-      hash.delete_if { |_, val| val < minimum }.keys
-    end
+  def denillify!(identity = 0)
+    replace(denillify(identity))
+  end
 
-    def except(*values)
-      reject { |val| values.include?(val) }
-    end
+  def divergence(other)
+    (self - other) | (other - self)
+  end
 
-    def except!(*values)
-      reject! { |val| values.include?(val) }
-      self
-    end
+  def duplicates(minimum = 2)
+    hash = Hash.new(0)
+    each { |val| hash[val] += 1 }
+    hash.delete_if { |_, val| val < minimum }.keys
+  end
 
-    def fulfill(value, amount)
-      return self if amount <= size
+  def except(*values)
+    reject { |val| values.include?(val) }
+  end
 
-      fill(value, size..(amount - 1))
-    end
+  def except!(*values)
+    reject! { |val| values.include?(val) }
+    self
+  end
 
-    def groups(number)
-      return [] if number <= 0
+  def fulfill(value, amount)
+    return self if amount <= size
 
-      num, rem = size.divmod(number)
-      collection = (0..(num - 1)).collect { |val| self[(val * number), number] }
-      return collection unless rem.positive?
+    fill(value, size..(amount - 1))
+  end
 
-      collection << self[-rem, rem]
-    end
+  def groups(number)
+    return [] if number <= 0
 
-    def indexes(value)
-      array = []
-      each_with_index { |val, i| array << i if value == val }
-      array
-    end
+    num, rem = size.divmod(number)
+    collection = (0..(num - 1)).collect { |val| self[(val * number), number] }
+    return collection unless rem.positive?
 
-    def match(value)
-      find { |val| value == val }
-    end
+    collection << self[-rem, rem]
+  end
 
-    def merge(*values)
-      dup.merge!(*values)
-    end
+  def indexes(value)
+    array = []
+    each_with_index { |val, i| array << i if value == val }
+    array
+  end
 
-    def merge!(*values)
-      values.each_with_object(self) { |val, arr| arr.concat(val) }
-    end
+  def match(value)
+    find { |val| value == val }
+  end
 
-    def nillify
-      map { |val| !val.nil? && (val.try(:blank?) || val.try(:to_s).blank?) ? nil : val }
-    end
+  def merge(*values)
+    dup.merge!(*values)
+  end
 
-    def nillify!
-      replace(nillify)
-    end
+  def merge!(*values)
+    values.each_with_object(self) { |val, arr| arr.concat(val) }
+  end
 
-    def only(*values)
-      select { |val| values.include?(val) }
-    end
+  def nillify
+    map { |val| !val.nil? && (val.try(:blank?) || val.try(:to_s).blank?) ? nil : val }
+  end
 
-    def only!(*values)
-      select! { |val| values.include?(val) }
-      self
-    end
+  def nillify!
+    replace(nillify)
+  end
 
-    def position(value)
-      idx = index(value)
-      return idx if idx.nil?
+  def only(*values)
+    select { |val| values.include?(val) }
+  end
 
-      idx + 1
-    end
+  def only!(*values)
+    select! { |val| values.include?(val) }
+    self
+  end
 
-    def positions(value)
-      indexes(value).map { |val| val + 1 }
-    end
+  def position(value)
+    idx = index(value)
+    return idx if idx.nil?
 
-    def probability
-      hash = Hash.new(0.0)
-      differ = 0.0
+    idx + 1
+  end
 
-      each do |val|
-        hash[val] += 1.0
-        differ += 1.0
-      end
+  def positions(value)
+    indexes(value).map { |val| val + 1 }
+  end
 
-      hash.each_key { |val| hash[val] /= differ }
-      hash
-    end
+  def probability
+    hash = Hash.new(0.0)
+    differ = 0.0
 
-    def promote(value)
-      sort_by { |val| val == value ? -1 : 0 }
+    each do |val|
+      hash[val] += 1.0
+      differ += 1.0
     end
 
-    def promote!(value)
-      sort_by! { |val| val == value ? -1 : 0 }
-    end
+    hash.each_key { |val| hash[val] /= differ }
+    hash
+  end
 
-    def rand_sample(max = nil)
-      amount = rand(1..(max || size))
-      sample(amount)
-    end
+  def promote(value)
+    sort_by { |val| val == value ? -1 : 0 }
+  end
 
-    def rposition(value)
-      idx = rindex(value)
-      return idx if idx.nil?
+  def promote!(value)
+    sort_by! { |val| val == value ? -1 : 0 }
+  end
 
-      idx + 1
-    end
+  def rand_sample(max = nil)
+    amount = rand(1..(max || size))
+    sample(amount)
+  end
 
-    def sample!
-      delete_at(Random.rand(size - 1))
-    end
+  def rposition(value)
+    idx = rindex(value)
+    return idx if idx.nil?
 
-    def strip
-      reject(&:blank?)
-    end
+    idx + 1
+  end
 
-    def strip!
-      reject!(&:blank?)
-      self
-    end
+  def sample!
+    delete_at(Random.rand(size - 1))
+  end
 
-    def swap(from, to)
-      self[from], self[to] = self[to], self[from]
-      self
-    end
+  def strip
+    reject(&:blank?)
+  end
 
-    alias indices indexes
-    alias reject_values except
-    alias reject_values! except!
-    alias select_values only
-    alias select_values! only!
+  def strip!
+    reject!(&:blank?)
+    self
+  end
 
+  def swap(from, to)
+    self[from], self[to] = self[to], self[from]
+    self
   end
 
-  require 'lite/ruby/safe/array' unless defined?(ActiveSupport)
+  alias indices indexes
+  alias reject_values except
+  alias reject_values! except!
+  alias select_values only
+  alias select_values! only!
+
 end
+
+require 'lite/ruby/safe/array' unless defined?(ActiveSupport)