fat_core 4.17.0 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a535331fa37f8a1247eb587f0b2a4770c5e37f7f27f7c2cb850ea9f31b4bd1ca
-  data.tar.gz: b0644ff70137d300cc2f02cdefdfa1aa9857f6f333e000137dc8e8124f02d760
+  metadata.gz: 6d377f4ea28c3310ce28733b4da66dad3e39dc13be3f5406ab1cce4b4e784924
+  data.tar.gz: d1e6f6fb84c9211104a87c2e4d596a3637eaacfa5bc82349b3d5baaa2b9657df
 SHA512:
-  metadata.gz: 7ee6dee2e096d81087efb0a8a517010738b609102892e8f32617ca780edca9ba129433e79ef19e6c9979a27f4e451b141d1291fdd7457ccdbf38cec6cca53331
-  data.tar.gz: dcf803b07f015dbb3846a13a4cb27122e185dfae6b7461345a4deaf1ff2cfb838cfb75f6a0d5ce61f2bb1299bc80b8b1023bf898e800369a54564d6f5001fe2c
+  metadata.gz: 0f81e05b5728f6dc3a7fe556bcd48ff011a006375938afd269ced9d3b6266715118dd5281d7e5c2dd39665257ed8f49a86fc73ddb3d5c3a1f9b1bc728efecb15
+  data.tar.gz: 8c6fd80723f159aaaf92cf52b249cb194f4394bb8f655963a4287c37523e8212e93ed27c7a9b40be8620bb45773cd47e38a701b0ceead250e1f69fd20fab162a

data/.envrc

@@ -0,0 +1 @@
+PATH_add .bundle/bin

data/.gitignore

@@ -21,3 +21,6 @@ tmp
 /.rubocop_todo.yml
 /gtags.files
 /.ruby-version
+/.idea/
+/README.md
+/TAGS

data/.rspec

@@ -1,2 +1,3 @@
+--require 'spec_helper'
 --color
 --format documentation

data/lib/fat_core/array.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module FatCore
+  # Useful extensions to the core Array class.
   module Array
     # Return the index of the last element of this Array.  This is just a
     # convenience for an oft-needed Array attribute.
@@ -8,14 +9,14 @@ module FatCore
       size - 1
     end
 
-    # Return a new Array that is the intersection of this Array with +other+,
-    # but without removing duplicates as the Array#& method does. All items of
-    # this Array are included in the result but only if they also appear in the
-    # +other+ Array.
-    def intersect(other)
+    # Return a new Array that is the intersection of this Array with all
+    # +others+, but without removing duplicates as the Array#& method
+    # does. All items of this Array are included in the result but only if
+    # they also appear in all of the other Arrays.
+    def intersect_with_dups(*others)
       result = []
       each do |itm|
-        result << itm if other.include?(itm)
+        result << itm if others.all? { |oth| oth.include?(itm) }
       end
       result
     end
@@ -24,10 +25,53 @@ module FatCore
     # without removing duplicates as the Array#- method does. All items of this
     # Array are included in the result unless they also appear in the +other+
     # Array.
-    def difference(other)
+    def diff_with_dups(*others)
       result = []
       each do |itm|
-        result << itm unless other.include?(itm)
+        result << itm if others.none? { |oth| oth.include?(itm) }
+      end
+      result
+    end
+
+    # Convert this array into a single string by (1) applying #to_s to each
+    # element and (2) joining the elements with the string given by the sep:
+    # paramater. By default the sep parameter is ', '. You may use a different
+    # separation string in the case when there are only two items in the list
+    # by supplying a two_sep parameter.  You may also supply a difference
+    # separation string to separate the second-last and last items in the
+    # array by supplying a last_sep: parameter.  By default, the sep parameter
+    # is the string ', ', the two_sep is ' and ', and the last_sep is ', and
+    # ', all of which makes for a well-punctuated English clause.  If sep is
+    # given, the other two parameters are set to its value by default.  If
+    # last_sep is given, two_sep takes its value by default.  If the input
+    # array is empty, #comma_join returns an empty string.
+    def comma_join(sep: nil, last_sep: nil, two_sep: nil)
+      orig_sep = sep
+      orig_last_sep = last_sep
+      sep ||= ', '
+      last_sep ||= orig_sep || ', and '
+      two_sep ||=  orig_sep || orig_last_sep || ' and '
+      result = +''
+      case size
+      when 0
+        result
+      when 1
+        result = self[0].to_s
+      when 2
+        result = self[0].to_s + two_sep + self[1]
+      else
+        second_last = size - 2
+        last = size - 1
+        each_with_index do |itm, k|
+          result <<
+            if k == second_last
+              "#{itm}#{last_sep}"
+            elsif k == last
+              itm.to_s
+            else
+              "#{itm}#{sep}"
+            end
+        end
       end
       result
     end

data/lib/fat_core/date.rb

@@ -90,7 +90,7 @@ module FatCore
     # Format as an inactive Org date timestamp of the form `[YYYY-MM-DD <dow>]`
     # (see Emacs org-mode)
     # @return [String]
-    def org(active = false)
+    def org(active: false)
       if active
         strftime('<%Y-%m-%d %a>')
       else
@@ -186,7 +186,7 @@ module FatCore
     # semimonth the date falls in.
     # @return [Integer]
     def semimonth
-      (month - 1) * 2 + (day <= 15 ? 1 : 2)
+      ((month - 1) * 2) + (day <= 15 ? 1 : 2)
     end
 
     # Self's calendar biweek: 1, through 24 depending on which calendar
@@ -428,7 +428,7 @@ module FatCore
       self - 1.day
     end
 
-    # Note: the ::Date class already has a #succ method.
+    # NOTE: the ::Date class already has a #succ method.
 
     # The date that is the first day of the half-year in which self falls.
     # @return [::Date]
@@ -1842,6 +1842,7 @@ module FatCore
           raise ArgumentError, 'requires String, Date, DateTime, or Time'
         end
       end
+      alias ensure ensure_date
     end
 
     def self.included(base)

data/lib/fat_core/enumerable.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Useful extensions to the core Enumerable module.
 module Enumerable
   # Yield items in groups of n, for each group yield the group number, starting
   # with zero and an Array of n items, or all remaining items if less than n.

data/lib/fat_core/hash.rb

@@ -10,20 +10,20 @@
 # require 'fat_core/hash'
 # ```
 #
-# It provides a couple of methods for manipulating the keys of a Hash:
-# `#remap_keys` for translating the current set of keys to a new set provided by
-# a Hash of old to new keys, and `#replace_keys` for doing a similar operation
-# with an Array of new keys. Along the same line, the method `#keys_with_value`
-# will return the keys in a Hash equal to the given value of any of an Array of
-# values.
-#
-# It also provides a method for deleting all entries in a Hash whose value match
-# a single value or any one of an Array of values in `#delete_with_value`
-#
-# Finally, it provides an `#each_pair`-like method, `#each_pair_with_flags`,
-# that yields each key-value pair of the Hash along with two boolean flags that
-# indicate whether the element is the first or last in the Hash.
 module FatCore
+  # It provides a couple of methods for manipulating the keys of a Hash:
+  # `#remap_keys` for translating the current set of keys to a new set provided by
+  # a Hash of old to new keys, and `#replace_keys` for doing a similar operation
+  # with an Array of new keys. Along the same line, the method `#keys_with_value`
+  # will return the keys in a Hash equal to the given value of any of an Array of
+  # values.
+  #
+  # It also provides a method for deleting all entries in a Hash whose value match
+  # a single value or any one of an Array of values in `#delete_with_value`
+  #
+  # Finally, it provides an `#each_pair`-like method, `#each_pair_with_flags`,
+  # that yields each key-value pair of the Hash along with two boolean flags that
+  # indicate whether the element is the first or last in the Hash.
   module Hash
     # @group Enumerable Extensions
     #
@@ -130,15 +130,13 @@ module FatCore
     # @param new_keys [Array<Object>] replacement keys
     # @return [Hash]
     def replace_keys(new_keys)
-      unless keys.size == new_keys.size
-        raise ArgumentError, 'replace_keys: new keys size differs from key size'
-      end
+      raise ArgumentError, 'replace_keys: new keys size differs from key size' unless keys.size == new_keys.size
 
-      to_a.each_with_index.map { |(_k, v), i| [new_keys[i], v] }.to_h
+      to_a.each_with_index.to_h { |(_k, v), i| [new_keys[i], v] }
     end
 
     def <<(other)
-      self.merge(other)
+      merge(other)
     end
   end
 end

data/lib/fat_core/nil.rb

@@ -8,7 +8,7 @@ module FatCore
     def as_string
       ''
     end
-    alias_method :entitle, :as_string
+    alias entitle as_string
 
     # Allow nils to respond to #tex_quote for use in TeX documents
     #

data/lib/fat_core/range.rb

@@ -132,7 +132,7 @@ module FatCore
 
       ([min, other.min].max..[max, other.max].min)
     end
-    alias_method :&, :intersection
+    alias & intersection
 
     # Return a Range that represents the union between this range and the
     # `other` range.  If there is no overlap and self is not contiguous with
@@ -150,7 +150,7 @@ module FatCore
 
       ([min, other.min].min..[max, other.max].max)
     end
-    alias_method :+, :union
+    alias + union
 
     # The difference method, -, removes the overlapping part of the other
     # argument from self.  Because in the case where self is a superset of the
@@ -187,7 +187,7 @@ module FatCore
         [(min..isec.min.pred), (isec.max.succ..max)]
       end
     end
-    alias_method :-, :difference
+    alias - difference
 
     # Allow erb or erubis documents to directly interpolate a Range.
     #
@@ -297,7 +297,7 @@ module FatCore
     # @return [Boolean] is self wholly within other
     def proper_subset_of?(other)
       subset_of?(other) &&
-      (min > other.min || max < other.max)
+        (min > other.min || max < other.max)
     end
 
     # Return whether self contains `other` range, even if their
@@ -324,8 +324,8 @@ module FatCore
     # @param other [Range] range to test for overlap with self
     # @return [Boolean] is there an overlap?
     def overlaps?(other)
-      (cover?(other.min) || cover?(other.max) ||
-       other.cover?(min) || other.cover?(max))
+      cover?(other.min) || cover?(other.max) ||
+        other.cover?(min) || other.cover?(max)
     end
 
     # Return whether any of the `ranges` that overlap self have overlaps among one
@@ -357,10 +357,10 @@ module FatCore
         joined_range = joined_range.join(r)
         break if joined_range.nil?
       end
-      if !joined_range.nil?
-        joined_range.min <= min && joined_range.max >= max
-      else
+      if joined_range.nil?
         false
+      else
+        joined_range.min <= min && joined_range.max >= max
       end
     end
 

data/lib/fat_core/string.rb

@@ -58,7 +58,7 @@ module FatCore
       line_width_so_far = 0
       words = split(' ')
       words.each do |w|
-        w = ::String.new(' ') * hang + w if !first_line && first_word_on_line
+        w = (::String.new(' ') * hang) + w if !first_line && first_word_on_line
         w = ::String.new(' ') + w unless first_word_on_line
         result << w
         first_word_on_line = false
@@ -85,13 +85,13 @@ module FatCore
       r = dup
       r = r.gsub(/[{]/, 'XzXzXobXzXzX')
       r = r.gsub(/[}]/, 'XzXzXcbXzXzX')
-      r = r.gsub(/\\/, '\textbackslash{}')
-      r = r.gsub(/\^/, '\textasciicircum{}')
-      r = r.gsub(/~/, '\textasciitilde{}')
-      r = r.gsub(/\|/, '\textbar{}')
-      r = r.gsub(/\</, '\textless{}')
-      r = r.gsub(/\>/, '\textgreater{}')
-      r = r.gsub(/([_$&%#])/) { |m| '\\' + m }
+      r = r.gsub("\\", '\textbackslash{}')
+      r = r.gsub("^", '\textasciicircum{}')
+      r = r.gsub("~", '\textasciitilde{}')
+      r = r.gsub("|", '\textbar{}')
+      r = r.gsub("<", '\textless{}')
+      r = r.gsub(">", '\textgreater{}')
+      r = r.gsub(/([_$&%#])/) { |m| "\\#{m}" }
       r = r.gsub('XzXzXobXzXzX', '\\{')
       r.gsub('XzXzXcbXzXzX', '\\}')
     end

data/lib/fat_core/symbol.rb

@@ -14,9 +14,9 @@ module FatCore
     #
     # @return [String]
     def as_string
-      to_s.tr('_', ' ').split(' ').join(' ').entitle
+      to_s.tr('_', ' ').split.join(' ').entitle
     end
-    alias_method :entitle, :as_string
+    alias entitle as_string
 
     # Return self. This (together with String#as_sym) allows `#as_sym` to be
     # applied to a string or Symbol and get back a Symbol with out testing for

data/lib/fat_core/version.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module FatCore
-  MAJOR = 4
-  MINOR = 17
+  MAJOR = 5
+  MINOR = 1
   PATCH = 0
 
   # FatCore version number

data/spec/lib/array_spec.rb

@@ -8,19 +8,61 @@ describe Array do
     expect(letters.last_i).to eq(25)
   end
 
-  it 'intersection' do
-    expect(%w(A A B A C A B).intersect(%w(A B A))).to eq(%w(A A B A A B))
-    expect(%w(A A B A C A B).intersect(%w(A B))).to eq(%w(A A B A A B))
-    expect(%w(A A B A C A B).intersect(%w(A))).to eq(%w(A A A A))
-    expect(%w(A A B A C A B).intersect(%w(B))).to eq(%w(B B))
-    expect(%w(A A B A C A B).intersect(%w(C))).to eq(%w(C))
-  end
-
-  it 'difference' do
-    expect(%w(A A B A C A B).difference(%w(A B A))).to eq(%w(C))
-    expect(%w(A A B A C A B).difference(%w(A B))).to eq(%w(C))
-    expect(%w(A A B A C A B).difference(%w(A))).to eq(%w(B C B))
-    expect(%w(A A B A C A B).difference(%w(B))).to eq(%w(A A A C A))
-    expect(%w(A A B A C A B).difference(%w(C))).to eq(%w(A A B A A B))
+  it 'intersect_with_dups' do
+    expect(%w[A A B A C A B].intersect_with_dups(%w[A B A])).to eq(%w[A A B A A B])
+    expect(%w[A A B A C A B].intersect_with_dups(%w[A B])).to eq(%w[A A B A A B])
+    expect(%w[A A B A C A B].intersect_with_dups(%w[A])).to eq(%w[A A A A])
+    expect(%w[A A B A C A B].intersect_with_dups(%w[B])).to eq(%w[B B])
+    expect(%w[A A B A C A B].intersect_with_dups(%w[C])).to eq(%w[C])
+  end
+
+  it 'intersect_with_dups multiple' do
+    # Include only elements that occur in /all/ other arrays.
+    expect(%w[A A B A C A B].intersect_with_dups(%w[A B A], %w[A D F])).to eq(%w[A A A A])
+    expect(%w[A A B A C A B].intersect_with_dups(%w[A B A], %w[B D F])).to eq(%w[B B])
+    expect(%w[A A B A C A B].intersect_with_dups(%w[A D E F], %w[B D F])).to eq(%w[])
+    # expect(%w[A A B A C A B].intersect_with_dups(%w[A B])).to eq(%w[A A B A A B])
+    # expect(%w[A A B A C A B].intersect_with_dups(%w[A])).to eq(%w[A A A A])
+    # expect(%w[A A B A C A B].intersect_with_dups(%w[B])).to eq(%w[B B])
+    # expect(%w[A A B A C A B].intersect_with_dups(%w[C])).to eq(%w[C])
+  end
+
+  it 'diff_with_dups' do
+    expect(%w[A A B A C A B].diff_with_dups(%w[A B A])).to eq(%w[C])
+    expect(%w[A A B A C A B].diff_with_dups(%w[A B])).to eq(%w[C])
+    expect(%w[A A B A C A B].diff_with_dups(%w[A])).to eq(%w[B C B])
+    expect(%w[A A B A C A B].diff_with_dups(%w[B])).to eq(%w[A A A C A])
+    expect(%w[A A B A C A B].diff_with_dups(%w[C])).to eq(%w[A A B A A B])
+  end
+
+  it 'diff_with_dups multiple' do
+    # Include only elements that occur in /none/ of the other arrays.
+    expect(%w[A A B A C A B].diff_with_dups(%w[A C], %w[D F])).to eq(%w[B B])
+    expect(%w[A A B A C A B].diff_with_dups(%w[A C], %w[D F], %w[B R T])).to eq(%w[])
+    expect(%w[A A B A C A B].diff_with_dups(%w[R B])).to eq(%w[A A A C A])
+  end
+
+  it 'comma_join' do
+    expect(%w[].comma_join).to eq('')
+    expect(%w[A].comma_join).to eq('A')
+    expect(%w[A B].comma_join).to eq('A and B')
+    expect(%w[A B C].comma_join).to eq('A, B, and C')
+    expect([1, 1, 2, 3, 5, 8].comma_join).to eq('1, 1, 2, 3, 5, and 8')
+  end
+
+  it 'comma_join with only sep param' do
+    expect(%w[].comma_join(sep: '-')).to eq('')
+    expect(%w[A].comma_join(sep: '-')).to eq('A')
+    expect(%w[A B].comma_join(sep: '-')).to eq('A-B')
+    expect(%w[A B C].comma_join(sep: '-')).to eq('A-B-C')
+    expect([1, 1, 2, 3, 5, 8].comma_join(sep: '-')).to eq('1-1-2-3-5-8')
+  end
+
+  it 'comma_join with only last_sep param' do
+    expect(%w[].comma_join(last_sep: '*')).to eq('')
+    expect(%w[A].comma_join(last_sep: '*')).to eq('A')
+    expect(%w[A B].comma_join(last_sep: '*')).to eq('A*B')
+    expect(%w[A B C].comma_join(last_sep: '*')).to eq('A, B*C')
+    expect([1, 1, 2, 3, 5, 8].comma_join(last_sep: '*')).to eq('1, 1, 2, 3, 5*8')
   end
 end

data/spec/lib/date_spec.rb

@@ -15,23 +15,29 @@ describe Date do
     describe 'ensure_date parsing' do
       it 'parses a String as a date' do
         expect(described_class.ensure_date('2018-11-12').class).to be described_class
+        expect(described_class.ensure('2018-11-12').class).to be described_class
       end
 
       it 'leaves a Date as a date' do
         expect(described_class.ensure_date(described_class.today).class).to be described_class
+        expect(described_class.ensure(described_class.today).class).to be described_class
       end
 
       it 'converts Time as a date' do
         expect(described_class.ensure_date(Time.now).class).to be described_class
+        expect(described_class.ensure(Time.now).class).to be described_class
       end
 
       it 'raises an error for bad date string' do
         expect { described_class.ensure_date('2012-mm-tu') }.to raise_error(/invalid date/)
+        expect { described_class.ensure('2012-mm-tu') }.to raise_error(/invalid date/)
       end
 
       it 'raises an error for unknown class' do
         expect { described_class.ensure_date([2011, 11, 12]) }
           .to raise_error(/requires String, Date, DateTime, or Time/)
+        expect { described_class.ensure([2011, 11, 12]) }
+          .to raise_error(/requires String, Date, DateTime, or Time/)
       end
     end
 
@@ -461,7 +467,7 @@ describe Date do
       it 'prints itself in org form' do
         expect(described_class.today.org).to eq('[2012-07-18 Wed]')
         expect((described_class.today + 1.day).org).to eq('[2012-07-19 Thu]')
-        expect((described_class.today + 1.day).org(true)).to eq('<2012-07-19 Thu>')
+        expect((described_class.today + 1.day).org(active: true)).to eq('<2012-07-19 Thu>')
       end
 
       it 'prints itself in eng form' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fat_core
 version: !ruby/object:Gem::Version
-  version: 4.17.0
+  version: 5.1.0
 platform: ruby
 authors:
 - Daniel E. Doherty
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-08-02 00:00:00.000000000 Z
+date: 2024-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -177,6 +177,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".envrc"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -224,7 +225,7 @@ licenses:
 - MIT
 metadata:
   yard.run: yri
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -239,8 +240,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.5.18
+signing_key:
 specification_version: 4
 summary: some useful core extensions
 test_files: []