pixar-ruby-extensions 1.11.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a04889a5f74e6ac42d916b2eaa70fdb2c4fc32440e9e4197216b75f7fe14782
+  data.tar.gz: dd3b29c31ef90da3a272bf24f35647bdec3411495f61b5a0ec634dbc9a3aa17d
+SHA512:
+  metadata.gz: 1211b16e2eff5e1b8868e0ddf3c7ba6e26f4d91b15f9e44cd752c5157e1b92776562c36e5ccd4caba2b9129f268af0839ed62326636f3a7003f7d1e2f84b20d0
+  data.tar.gz: 4d9ec47bf87cb4eb2d9d7389ac1a71c64a3d93cc789e6dbc00d3ab91a09fe688ec825abba7220415ebd04e037770c8e1a680ca5ff0bd5417e0162c01e1f21ad5

data/LICENSE.txt

@@ -0,0 +1,177 @@
+
+TOMORROW OPEN SOURCE TECHNOLOGY LICENSE 1.0
+
+The Tomorrow Open Source Technology License 1.0 differs from the original Apache License 2.0 in the following manner.  The scope of the trademark grant in section 6 is different.
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor
+      and its affiliates, except as required to comply with Section 4(c) of
+      the License and to reproduce the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS

data/README.md

@@ -0,0 +1,29 @@
+# Pixar's Ruby Extensions
+
+This gem defines extensions to modules and classes in Ruby's Core and Standard Library. We've put them here because we've found ourselves performing these tasks repeatedly in our code over the years and we like to stay DRY.
+
+They are also used in our open-source projects, and those will be migrating to use this gem - also in pursuit of DRYness.
+
+To ease troubleshooting and prevent name collisions:
+
+- Methods are not directly monkey-patched into the Core or StdLib classes/modules.
+  - Instead they are defined in modules under `PixarRubyExtensions` with obvious namespaces, and mixed-in to the Core or StdLib classes/modules.
+
+    This provides _much_ easier debugging when there are exceptions, since the error and backtrace will indicate exactly where these methods are defined.
+
+- With only a couple of exceptions, all new method names are prefixed with `pix_`
+  - See `PixarRubyExtensions::IPAddr::Predicates` for examples and explanation about the exceptions.
+
+### Usage
+
+To load all the extensions: `require 'pixar_ruby_extensions'`
+
+To load only one: `require 'pixar_ruby_extensions/integer'`
+
+### Credits
+
+- The modularization idea came from [this page about responsible monkey-patching](https://www.justinweiss.com/articles/3-ways-to-monkey-patch-without-making-a-mess/), many thanks to the author and the discussion thread.
+
+### ToDo
+
+- Investigate re-doing all this using refinements rather than monkey-patching

data/lib/pixar-ruby-extensions.rb

@@ -0,0 +1,10 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+#
+#
+
+# frozen_string_literal: true
+
+require 'pixar_ruby_extensions'

data/lib/pixar_ruby_extensions/array/predicates.rb

@@ -0,0 +1,30 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+
+# frozen_string_literal: true
+
+module PixarRubyExtensions
+
+  module ArrayExtensions
+
+    module Predicates
+
+      # A case-insensitive version of #include? for Arrays.
+      # It only considers elements that are Strings
+      # (well, that respond to .casecmp?)
+      #
+      # @param somestring [String] the String to search for
+      #
+      # @return [Boolean] Does the Array contain the String, ignoring case?
+      #
+      def pix_ci_include?(somestring)
+        any? { |s| s.respond_to?(:casecmp?) && s.casecmp?(somestring) }
+      end
+
+    end # module
+
+  end # module
+
+end # module

data/lib/pixar_ruby_extensions/array/utils.rb

@@ -0,0 +1,88 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+
+# frozen_string_literal: true
+
+module PixarRubyExtensions
+
+  module ArrayExtensions
+
+    # Useful monkey patches for Array
+    module Utils
+
+      # Fetch a string from an Array case-insensitively,
+      # e.g. if my_array contains 'thrasher',
+      #    my_array.pix_ci_fetch('ThRashEr')
+      # will return 'thrasher'
+      #
+      # It only considers elements that are Strings
+      # (well, that respond to .casecmp?)
+      #
+      # returns nil if no match
+      #
+      # @param somestring [String] the String to search for
+      #
+      # @return [String, nil] The matching string as it exists in the Array,
+      #   nil if it doesn't exist
+      #
+      def pix_ci_fetch(somestring)
+        each { |s| return s if s.respond_to?(:casecmp?) && s.casecmp?(somestring) }
+        nil
+      end
+
+      # Array.pix_string_split
+      # Splits string elements of an Array on a given delimiter.
+      # Preserves order relative to the position in the original Array.
+      #
+      # @param [String] Split delimeter
+      # @return [Array]
+      #
+      def pix_string_split!(delim)
+        map! { |s| s.is_a?(String) ? s.split(delim) : s }
+        flatten!
+      end # end pix_string_split
+
+      # These handy padding methods from
+      # https://stackoverflow.com/questions/5608918/pad-an-array-to-be-a-certain-size
+      #
+      # The [l|r]just method names mirror those in String
+      # The aliases are a little more Englishy
+      def pix_rjust!(to_len, val)
+        insert(0, *Array.new([0, to_len - length].max, val))
+      end
+      alias pix_padleft! pix_rjust!
+
+      def pix_ljust!(to_len, val)
+        fill(val, length...to_len)
+      end
+      alias pix_padright! pix_ljust!
+
+      def pix_rjust(to_len, val)
+        Array.new([0, to_len - length].max, val) + self
+      end
+      alias pix_padleft pix_rjust
+
+      def pix_ljust(to_len, val)
+        dup.fill(val, length...to_len)
+      end
+      alias pix_padright pix_ljust
+
+      # Array#pix_to_jsonl
+      #
+      # Convert an Array of objects to a jsonlines string
+      #
+      # @param opts [Hash] Options to pass to JSON.dump
+      #
+      # @return [String] The jsonlines string
+      #
+      def pix_to_jsonl(**opts)
+        map { |obj| JSON.generate(obj, **opts) }.join("\n")
+      end
+
+    end # module
+
+  end # module
+
+end # module

data/lib/pixar_ruby_extensions/array.rb

@@ -0,0 +1,17 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+
+# frozen_string_literal: true
+
+require 'pixar_ruby_extensions/array/predicates'
+require 'pixar_ruby_extensions/array/utils'
+
+# an array
+class Array
+
+  include PixarRubyExtensions::ArrayExtensions::Predicates
+  include PixarRubyExtensions::ArrayExtensions::Utils
+
+end # class

data/lib/pixar_ruby_extensions/filetest/predicates.rb

@@ -0,0 +1,38 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+
+# frozen_string_literal: true
+
+module PixarRubyExtensions
+
+  module FileTestExtensions
+
+    module Predicates
+
+      # FileTest.file? returns true if
+      # the item is a symlink pointing to a regular file.
+      #
+      # This test, real_file?, returns true if the item is
+      # a regular file but NOT a symlink.
+      #
+      def pix_real_file?(path)
+        FileTest.file?(path) && !FileTest.symlink?(path)
+      end # real_file?
+
+      # FileTest.directory? returns true if
+      # the item is a symlink pointing to a directory.
+      #
+      # This test, real_directory?, returns true if the item is
+      # a directory but NOT a symlink.
+      #
+      def pix_real_directory?(path)
+        FileTest.directory?(path) && !FileTest.symlink?(path)
+      end # real_file?
+
+    end # module
+
+  end # module
+
+end # module

data/lib/pixar_ruby_extensions/filetest.rb

@@ -0,0 +1,14 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+
+# frozen_string_literal: true
+
+require 'pixar_ruby_extensions/filetest/predicates'
+
+module FileTest
+
+  extend PixarRubyExtensions::FileTestExtensions::Predicates
+
+end # module FileTest

data/lib/pixar_ruby_extensions/float/utils.rb

@@ -0,0 +1,36 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+
+# frozen_string_literal: true
+
+require 'pixar_ruby_extensions/integer'
+
+module PixarRubyExtensions
+
+  module FloatExtensions
+
+    module Utils
+
+      # See IntegerExtensions::Utils.pix_humanize_secs for more info
+      # Runs that method on the integer part of the float, then append the fraction
+      # as a decimal part of a second.
+      #
+      # @return [String] The integer number of seconds, expressed in descending English time units
+      #
+      def pix_humanize_secs(omit_zeros: false, down_to: :seconds, up_to: :years)
+        int, fraction = to_s.split('.')
+        int.to_i.pix_humanize_secs(
+          omit_zeros: omit_zeros,
+          down_to: down_to,
+          up_to: up_to,
+          fraction: fraction
+        )
+      end
+
+    end # module
+
+  end # module
+
+end # module

data/lib/pixar_ruby_extensions/float.rb

@@ -0,0 +1,14 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+
+# frozen_string_literal: true
+
+require 'pixar_ruby_extensions/float/utils'
+
+class Float
+
+  include PixarRubyExtensions::FloatExtensions::Utils
+
+end

data/lib/pixar_ruby_extensions/hash/utils.rb

@@ -0,0 +1,94 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+
+# frozen_string_literal: true
+
+module PixarRubyExtensions
+
+  module HashExtensions
+
+    module Utils
+
+      # Convert certain Hash values to nil, optionally recursively
+      #
+      # This is useful when a dataset lacks consistency as to
+      # whether unset values come as nils or empty strings.
+      #
+      # By default this method converts all empty strings to nils,
+      # but other target strings can be provided.
+      #
+      # With no block, values equalling the given String (default is the empty string),
+      # or any member of a given Array of Strings will be converted to nil.
+      # Equality is evaluated with Array#include?
+      #
+      # With a block, the to_nils param is ignored, and if the result of the block
+      # evaluates to true, the value is converted to nil.
+      #
+      # Subhashes are ignored unless recurse is true.
+      #
+      # @param to_nils[String,Array] Hash values equal to (==) these become nil. Defaults to empty string
+      #
+      # @param recurse[Boolean] should sub-Hashes be nillified?
+      #
+      # @yield [value] Hash values for which the block returns true will become nil.
+      #
+      # @return [Hash] the hash with the desired values converted to nil
+      #
+      # @example
+      #   hash = {:foo => '', :bar => {:baz => '' }}
+      #   hash.jss_nillify!  # {:foo => nil, :bar => {:baz => '' }}
+      #
+      #   hash = {:foo => '', :bar => {:baz => '' }}
+      #   hash.jss_nillify! '', :recurse  # {:foo => nil, :bar => {:baz => nil }}
+      #
+      #   hash = {:foo => 123, :bar => {:baz => '', :bim => "123" }}
+      #   hash.jss_nillify! ['', 123], :recurse # {:foo => nil, :bar => {:baz => nil, :bim => "123" }}
+      #
+      #   hash = {:foo => 123, :bar => {:baz => '', :bim => "123" }}
+      #   hash.jss_nillify!(:anything, :recurse){|v| v.to_i == 123 }  # {:foo => nil, :bar => {:baz => '', :bim => nil }}
+      #
+      def pix_nillify(to_nils = '', recurse: false, &block)
+        p_nillifier(to_nils, recurse: recurse, destructive: false, &block)
+      end # def nillify
+
+      # Modify self in-place.
+      #
+      # @see p_nillify
+      #
+      def pix_nillify!(to_nils = '', recurse: false, &block)
+        p_nillifier(to_nils, recurse: recurse, destructive: true, &block)
+      end
+
+      private
+
+      def pix_nillifier(to_nils, recurse:, destructive:, &block)
+        nillify_these = [to_nils].flatten
+
+        if destructive
+          transformer = :transform_values!
+          nillifier = :p_nillify!
+        else
+          nillifier = :p_nillify
+          transformer = :transform_values
+        end
+
+        send transformer do |v|
+          if v.is_a?(Hash) && recurse
+            # puts :recursing
+            v = v.send(nillifier, to_nils, recurse: recurse, &block)
+            # puts "new v is: #{v}"
+            v
+          else
+            do_it = block_given? ? yield(v) : nillify_these.include?(v)
+            do_it ? nil : v
+          end # if
+        end # transform values
+      end
+
+    end # module
+
+  end # module
+
+end # module

data/lib/pixar_ruby_extensions/hash.rb

@@ -0,0 +1,15 @@
+# Copyright 2025 Pixar
+#
+#    Licensed under the terms set forth in the LICENSE.txt file available at
+#    at the root of this project.
+
+# frozen_string_literal: true
+
+require 'pixar_ruby_extensions/hash/utils'
+
+# include the modules loaded above
+class Hash
+
+  include PixarRubyExtensions::HashExtensions::Utils
+
+end