ruby-rails-extensions 2.1.0.pre.rc.13 → 2.1.0.pre.rc.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd0dcbe64c80a08c831af260bb6def15e0a56cb1643b02e9fde7f5904b3b4c37
-  data.tar.gz: 37ea13e2a243425c5e5a224005d0c41434532c45ab68b65e6ce4d8f6e7dcea2a
+  metadata.gz: 6bb1c22291a4310b41703612c9eb72818974257e3ac06c6d76f6d8caca3d53ac
+  data.tar.gz: b28bc6aaf8bd702ded6500f8f828838d7a16eed7969c1c9f723a2ba69532ddd9
 SHA512:
-  metadata.gz: b2c96c470d791ac8f4ea2dc3b6154a40e24c5bbd56a88375b2f905a5b5803d7bc96601c50e59ad94062c3b54d79d185c45e135b5e3e490230ef342eaa02eda40
-  data.tar.gz: '09edbe71001ebad9138c4588333bad479084a96e8094170324330d4ce02fce34fa8d781da8c53877906b3701c95f5afa02d59e5e95f45e9c3aace6e95544f138'
+  metadata.gz: 770c01049b51f5bdc524692728d8b73fded477dbf647b7cd0a456e20545ab343d45a688e5b94d45625c5cfb17666f77dd292b5cc1685014cd117e9ddcdfd5b69
+  data.tar.gz: 19598110c5b11b9a85de6251fd0f5e269dd2e886695942627276de6139f363bcc498b93cc35f29691672a4fb8c00336fc2aec12ba3024e9df8f8f648499f4011

data/CHANGELOG.md

@@ -11,6 +11,17 @@ Unreleased Changes
   * `FalseClass#to_d` and `TrueClass#to_d`
   * `Range#>`, `Range#<`, `Range#<=`, `Range#>=`
   * `Range#round`
+  * `Array#flatten_compact!` (`flat_pact!`)
+  * `Numeric#to_percentage`
+  * `Numeric#to_money` and `String#to_money`
+  * `String#to_delimited` and `Numeric#to_delimited` (alias `with_delimiter`)
+  * `String#utf8_encode!`, `String#utf8_encode`, and `String#safe_utf8_encode`
+  * `Time#quarter_str` and `DateTime#quarter_str`
+  * `String#to_new_date`, `String#to_new_date_safe`, and `String#to_new_date_mm_yy`
+  * `String#cutoff`
+* Other changes:
+  * Initial test framework added
+  * Initial benchmark framework added
 
 2.0.1 (2024-07-29)
 ------------------

data/lib/ruby-rails-extensions/extensions/clean_string.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 String.class_eval do
+  # @deprecated Use {String#utf8_encode!} instead
   # Remove all non-UTF-8 chars from a string.
   #
   # @param replace_with [String, nil] What to replace invalid chars with.
@@ -8,14 +9,20 @@ String.class_eval do
   # @return [String]
   #
   def clean!(replace_with = '')
+    utf8_encode_dep_warn('clean!')
+
     replace(encode('UTF-8', invalid: :replace, undef: :replace, replace: replace_with))
   end
 
+  # @deprecated Use {String#utf8_encode} instead
   # @see {#clean!}
   def clean(replace_with = '')
+    utf8_encode_dep_warn('clean')
+
     dup.clean!(replace_with)
   end
 
+  # @deprecated Use {String#utf8_encode!} instead
   # Remove all non-UTF-8 chars from a string and convert to binary.
   #
   # @param replace_with [String, nil] What to replace invalid chars with.
@@ -23,11 +30,32 @@ String.class_eval do
   # @return [String]
   #
   def clean_binary!(replace_with = '')
+    utf8_encode_dep_warn('clean_binary!')
+
     replace(encode('UTF-8', 'binary', invalid: :replace, undef: :replace, replace: replace_with))
   end
 
+  # @deprecated Use {String#utf8_encode} instead
   # @see {#clean_binary!}
   def clean_binary(replace_with = '')
+    utf8_encode_dep_warn('clean_binary!')
+
     dup.clean_binary!(replace_with)
   end
+
+  private
+
+    # Triggers a deprecation warning
+    #
+    # @param method_name [String]
+    # @param projected_version [String] Projected version methods will
+    #   be removed / no longer supported.
+    #
+    # @return [void]
+    #
+    def utf8_encode_dep_warn(method_name, projected_version = '3.0')
+      dep = ActiveSupport::Deprecation.new(projected_version, 'ruby-rails-extensions')
+
+      dep.warn("#{method_name} is deprecated and will be removed from ruby-rails-extensions #{projected_version}")
+    end
 end

data/lib/ruby-rails-extensions/extensions/cutoff.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/string/filters'
+require 'active_support/core_ext/string/output_safety'
+
+String.class_eval do
+  # Cuts off a long string and will add an ellipsis or
+  # what has been entered via +:end_more+ option.
+  #
+  # @param max [Integer] Max string length in characters
+  # @param options [Hash]
+  #
+  # @option options [Boolean] :ending This will add the
+  #   ellipsis in the middle of the word instead of the
+  #   end, which will show the start and end of the string.
+  #
+  # @option options [String] :end_more Instead of showing
+  #   and ellipsis at the end of the string, it will show
+  #   this string. This will be counted against the max
+  #   and will only show up once the max is hit.
+  #   *This is ignored when +:ending+ enabled.*
+  #
+  # @return [String]
+  #
+  def cutoff(max = 60, options = {})
+    this = self
+    max_len = (max || 60).to_i
+    opts = { ending: false, end_more: nil }.merge(options || {})
+
+    # Return the string if it isn't over the max
+    return this if this.size < max_len
+
+    end_chars = opts[:end_more].present? ? opts[:end_more] : '...'
+
+    unless opts[:ending]
+      return this.truncate(max_len, { omission: end_chars }).html_safe
+    end
+
+    start_val = ((max_len - 3) / 2).round
+    end_val = max_len - start_val
+
+    "#{this[0, start_val]}...#{this[-end_val, this.size]}".html_safe
+  end
+end

data/lib/ruby-rails-extensions/extensions/quarter_str.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/time_with_zone'
+
+module QuarterStrMethods
+  # Returns the quarter and year using the following template:
+  #   <quarter_number>Q<quarter_year(yy)>
+  #
+  # @return [String]
+  #
+  def quarter_str
+    "#{(month / 3.0).ceil}Q#{strftime('%y')}"
+  end
+end
+
+DateTime.class_eval do
+  include QuarterStrMethods
+end
+
+Time.class_eval do
+  include QuarterStrMethods
+end
+
+ActiveSupport::TimeWithZone.class_eval do
+  include QuarterStrMethods
+end

data/lib/ruby-rails-extensions/extensions/to_delimited.rb

@@ -26,7 +26,7 @@ String.class_eval do
   # @deprecated This alias is only for Atlas and will be removed in future versions
   alias_method :with_sep, :to_delimited
 
-  deprecate :with_sep, deprecator: ActiveSupport::Deprecation.new('4.0', 'ruby-rails-extensions')
+  deprecate :with_sep, deprecator: ActiveSupport::Deprecation.new('3.0', 'ruby-rails-extensions')
 end
 
 Numeric.class_eval do

data/lib/ruby-rails-extensions/extensions/to_money.rb

@@ -18,3 +18,10 @@ Numeric.class_eval do
     number_to_currency(to_d, options)
   end
 end
+
+String.class_eval do
+  # @see Numeric#to_money
+  def to_money(...)
+    to_d.to_money(...)
+  end
+end

data/lib/ruby-rails-extensions/extensions/to_new_date.rb

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext/date'
+require 'active_support/core_ext/time'
+
+module StringToNewDate
+  NEW_DATE_REGEXES = {
+    # MM DD YYYY
+    mm_dd_yyyy: /\A\d{2}\D?\d{2}\D?\d{4}\z/,
+    # YYYY MM DD
+    yyyy_mm_dd: /\A\d{4}\D?\d{2}\D?\d{2}\z/,
+    # MM DD YY
+    mm_dd_yy: /\A\d{2}\D?\d{2}\D?\d{2}\z/,
+    # (M)M (D)D (YY)YY
+    m_d_yy: %r{\A(\d{1,2})[-|/](\d{1,2})[-|/](\d+)\z},
+    # M(M) YY(YY)
+    m_yy: %r{\A(\d{1,2})[-/](\d{2,4})\z}
+  }.freeze
+
+  # Converts a string to a date object when following one of the
+  # following patterns (no space delimiters):
+  #   - MM-DD-YYYY
+  #   - YYYY-MM-DD
+  #   - MM-DD-YY
+  #   - (M)M-(D)D-(YY)YY => "()" optional values
+  #
+  # @param options [Hash]
+  #
+  # @option options [Boolean] :return_orig If +true+, the non-converted
+  #   string will be returned instead of +nil+. Default is to return
+  #   +nil+ when conversion fails.
+  # @option options [String] :quarter If date extraction successful,
+  #   the date will be converted to the beginning or ending of the
+  #   quarter. Accepts: 'begin(ning)' and 'end(ing)'
+  #
+  # @return [Date, String, nil]
+  #
+  def to_new_date(options = {})
+    opts = {
+      return_orig: false,
+      quarter: nil
+    }.merge(options || {})
+
+    new_date = extract_date
+
+    if new_date.nil?
+      return opts[:return_orig] ? self : nil
+    end
+
+    if opts[:quarter].to_s.match?(/begin/i)
+      return new_date.beginning_of_quarter
+    end
+
+    if opts[:quarter].to_s.match?(/end/i)
+      return new_date.end_of_quarter
+    end
+
+    new_date
+  end
+
+  # Recovers from any error when calling {#to_new_date}
+  def to_new_date_safe(...)
+    to_new_date(...)
+  rescue
+    nil
+  end
+
+  # Converts a string to a date object. The only pattern
+  # accepted: 'MM YY'
+  #
+  # @see #to_new_date
+  #
+  # @return [Date, nil]
+  #
+  def to_new_date_mm_yy
+    return unless NEW_DATE_REGEXES[:m_yy].match?(self)
+
+    m_yy_date
+  end
+
+  private
+
+    # Checks the string for any supported format,
+    # then converts the string to a new date.
+    #
+    # @return [Date, nil]
+    #
+    def extract_date
+      key = NEW_DATE_REGEXES.find { |_key, value| match?(value) }&.first
+
+      return if key.nil?
+
+      __send__(:"#{key}_date")
+    end
+
+    # @return [Date]
+    def mm_dd_yyyy_date
+      Date.new(scan(/\d{4}/).first.to_i, scan(/\d{2}/).first.to_i, scan(/\d{2}/)[1].to_i)
+    end
+
+    # @return [Date]
+    def yyyy_mm_dd_date
+      Date.new(scan(/\d{4}/).first.to_i, scan(/\d{2}/)[2].to_i, scan(/\d{2}/)[3].to_i)
+    end
+
+    # @return [Date]
+    def mm_dd_yy_date
+      Date.new("20#{scan(/\d{2}/)[2]}".to_i, scan(/\d{2}/).first.to_i, scan(/\d{2}/)[1].to_i)
+    end
+
+    # @return [Date]
+    def m_d_yy_date
+      numbers = NEW_DATE_REGEXES[:m_d_yy].match(self)
+
+      year =
+        case numbers[3].size
+        when 2
+          "20#{numbers[3]}".to_i
+        when 4
+          numbers[3].to_i
+        end
+
+      return if year.nil?
+
+      Date.new(year, numbers[1].to_i, numbers[2].to_i)
+    end
+
+    # @return [Date]
+    def m_yy_date
+      numbers = NEW_DATE_REGEXES[:m_yy].match(self)
+
+      year =
+        case numbers[2].size
+        when 2
+          "20#{numbers[2]}".to_i
+        when 4
+          numbers[2].to_i
+        end
+
+      return if year.nil?
+
+      Date.new(year, numbers[1].to_i, 1)
+    end
+end
+
+String.class_eval do
+  include StringToNewDate
+end

data/lib/ruby-rails-extensions/extensions/utf8_encode.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/deprecation'
+
+String.class_eval do
+  # Remove all non-UTF-8 chars from a string.
+  #
+  # @raise [Encoding::UndefinedConversionError] Failed to encode string
+  #
+  # @example
+  #
+  #    "^\u{0000}-\u{007F}".utf8_encode
+  #    # => "^\u0000-\u007F"
+  #
+  # @param binary [Boolean]
+  #
+  # @return [void]
+  #
+  def utf8_encode!(binary: true, **kwargs)
+    if binary
+      return replace(utf8_encode_str(self, 'binary', kwargs))
+    end
+
+    replace(utf8_encode_str(self, kwargs))
+  end
+
+  # @see #utf8_encode!
+  #
+  # @return [String]
+  #
+  def utf8_encode(**kwargs)
+    dup.utf8_encode!(**kwargs)
+  end
+
+  # Safely calls {#utf8_encode} with a rescue that will catch
+  # all errors.
+  #
+  # @return [String, nil]
+  #
+  def safe_utf8_encode(**kwargs)
+    utf8_encode(**kwargs)
+  rescue
+    nil
+  end
+
+  private
+
+    # Wrapper for {#Encoding.default_internal} using {#String.encode}.
+    #
+    # @see https://ruby-doc.org/core-3.0.1/String.html#method-i-encode
+    # @see https://ruby-doc.org/core-3.0.1/Encoding.html#method-c-default_internal
+    #
+    # @overload utf8_encode(str, src_encoding, options = {})
+    #   @param str [String] The string to be encoded.
+    #   @param src_encoding [String] The SRC encoding value.
+    #   @param options [Hash]
+    #
+    # @overload utf8_encode(str, options = {})
+    #   @param src_encoding [String] The SRC encoding value.
+    #   @param options [Hash]
+    #
+    # @return [String]
+    #
+    def utf8_encode_str(str, src_or_options = nil, options = nil)
+      default_options = {
+        invalid: :replace,
+        undef: :replace,
+        replace: ''
+      }
+
+      src_encode, opts =
+        if src_or_options.is_a?(Hash)
+          [src_or_options.reverse_merge(default_options), nil]
+        else
+          [src_or_options, (options.presence || {}).reverse_merge(default_options)]
+        end
+
+      if opts.nil?
+        return str.to_s.encode(Encoding::UTF_8, **src_encode)
+      end
+
+      str.to_s.encode(Encoding::UTF_8, src_encode, **opts)
+    end
+end

data/lib/ruby-rails-extensions/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyRailsExtensions
-  VERSION = '2.1.0-rc.13'
+  VERSION = '2.1.0-rc.14'
 end

data/lib/ruby-rails-extensions.rb

@@ -19,6 +19,7 @@ module RubyRailsExtensions
       current_day
       current_month
       current_week
+      cutoff
       day_of_week
       display_military
       display_user
@@ -43,6 +44,7 @@ module RubyRailsExtensions
       pipe
       presence_bang
       quarter_dates
+      quarter_str
       range_add
       range_comparisons
       range_multiply
@@ -60,6 +62,7 @@ module RubyRailsExtensions
       to_local
       to_money
       to_negative_i
+      to_new_date
       to_nonzero_i
       to_or_sentence
       to_percentage
@@ -70,6 +73,7 @@ module RubyRailsExtensions
       uniq_map
       usd_to_f
       usd_to_i
+      utf8_encode
       weighted_sum
       yesno
       zero_range

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-rails-extensions
 version: !ruby/object:Gem::Version
-  version: 2.1.0.pre.rc.13
+  version: 2.1.0.pre.rc.14
 platform: ruby
 authors:
 - Brands Insurance
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-08 00:00:00.000000000 Z
+date: 2024-10-11 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -33,6 +33,7 @@ files:
 - lib/ruby-rails-extensions/extensions/current_day.rb
 - lib/ruby-rails-extensions/extensions/current_month.rb
 - lib/ruby-rails-extensions/extensions/current_week.rb
+- lib/ruby-rails-extensions/extensions/cutoff.rb
 - lib/ruby-rails-extensions/extensions/day_of_week.rb
 - lib/ruby-rails-extensions/extensions/display_military.rb
 - lib/ruby-rails-extensions/extensions/display_user.rb
@@ -57,6 +58,7 @@ files:
 - lib/ruby-rails-extensions/extensions/pipe.rb
 - lib/ruby-rails-extensions/extensions/presence_bang.rb
 - lib/ruby-rails-extensions/extensions/quarter_dates.rb
+- lib/ruby-rails-extensions/extensions/quarter_str.rb
 - lib/ruby-rails-extensions/extensions/range_add.rb
 - lib/ruby-rails-extensions/extensions/range_comparisons.rb
 - lib/ruby-rails-extensions/extensions/range_multiply.rb
@@ -74,6 +76,7 @@ files:
 - lib/ruby-rails-extensions/extensions/to_local.rb
 - lib/ruby-rails-extensions/extensions/to_money.rb
 - lib/ruby-rails-extensions/extensions/to_negative_i.rb
+- lib/ruby-rails-extensions/extensions/to_new_date.rb
 - lib/ruby-rails-extensions/extensions/to_nonzero_i.rb
 - lib/ruby-rails-extensions/extensions/to_or_sentence.rb
 - lib/ruby-rails-extensions/extensions/to_percentage.rb
@@ -84,6 +87,7 @@ files:
 - lib/ruby-rails-extensions/extensions/uniq_map.rb
 - lib/ruby-rails-extensions/extensions/usd_to_f.rb
 - lib/ruby-rails-extensions/extensions/usd_to_i.rb
+- lib/ruby-rails-extensions/extensions/utf8_encode.rb
 - lib/ruby-rails-extensions/extensions/weighted_sum.rb
 - lib/ruby-rails-extensions/extensions/yesno.rb
 - lib/ruby-rails-extensions/extensions/zero_range.rb