fat_core 3.0.0 → 4.0.0

data/lib/fat_core/symbol.rb

@@ -2,20 +2,44 @@ require 'fat_core/string'
 
 module FatCore
   module Symbol
-    # Convert to capitalized string: :hello_world -> "Hello World"
-    def entitle
+    # Convert to a title-ized string, that is, convert all '_' to a space, then
+    # call String#entitle on the result.
+    #
+    # @example
+    #   :hello_world.entitle #=> "Hello World"
+    #   :hello_world.as_string #=> "Hello World"
+    #   :joy_to_the_world #=> 'Joy to the World'
+    #
+    # @return [String]
+    def as_string
       to_s.tr('_', ' ').split(' ').join(' ').entitle
     end
-    alias as_string entitle
+    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
+    # type.
+    #
+    # @return [Symbol] just self
     def as_sym
       self
     end
 
+    # Prepare this symbol for use in a TeX document by converting to String then
+    # quoting it.
+    #
+    # @example
+    #   :hammer_smith.tex_quote  #=> "hammer\\_smith"
+    #
+    # @return [String]
     def tex_quote
       to_s.tex_quote
     end
   end
 end
 
-Symbol.include(FatCore::Symbol)
+class Symbol
+  include FatCore::Symbol
+  # @!parse include FatCore::Symbol
+  # @!parse extend FatCore::Symbol::ClassMethods
+end

data/lib/fat_core/version.rb

@@ -1,7 +1,8 @@
 module FatCore
-  MAJOR = 3
+  MAJOR = 4
   MINOR = 0
   PATCH = 0
 
+  # FatCore version number
   VERSION = [MAJOR, MINOR, PATCH].compact.join('.')
 end

data/spec/lib/{big_decimal_spec.rb → bigdecimal_spec.rb}

@@ -1,4 +1,4 @@
-require 'fat_core/big_decimal'
+require 'fat_core/bigdecimal'
 
 describe BigDecimal do
   it 'should provide a human-readable inspect for BigDecimal' do

data/spec/lib/date_spec.rb

@@ -593,7 +593,7 @@ describe Date do
         expect(Date.today.add_chunk(:quarter)).to eq(Date.parse('2012-10-18'))
         expect(Date.today.add_chunk(:bimonth)).to eq(Date.parse('2012-09-18'))
         expect(Date.today.add_chunk(:month)).to eq(Date.parse('2012-08-18'))
-        expect(Date.today.add_chunk(:semimonth)).to eq(Date.parse('2012-08-02'))
+        expect(Date.today.add_chunk(:semimonth)).to eq(Date.parse('2012-08-03'))
         expect(Date.today.add_chunk(:biweek)).to eq(Date.parse('2012-08-01'))
         expect(Date.today.add_chunk(:week)).to eq(Date.parse('2012-07-25'))
         expect(Date.today.add_chunk(:day)).to eq(Date.parse('2012-07-19'))

data/spec/lib/numeric_spec.rb

@@ -38,7 +38,7 @@ describe Numeric do
 
     # if places is nil, use 4 places for numbers with a fractional
     # part and 0 places for numbers without
-    expect(-123_456_789.0123456.commas).to eq '-123,456,789.0123'
+    expect(-123_456_789.0123456.commas).to eq '-123,456,789.0123456'
     expect(-123_456_789.0.commas).to eq '-123,456,789'
     expect(-123_456_789.00.commas).to eq '-123,456,789'
   end

data/spec/lib/range_spec.rb

@@ -164,23 +164,25 @@ describe Range do
     end
 
     it 'should be able to determine whether a set contains covered overlaps' do
-      expect((0..10)).to have_overlaps_within([(0..3), (2..6), (7..10)])
+      expect(Range.overlaps_among?([(0..3), (2..6), (7..10)])).to be true
+      expect((0..10).overlaps_among?([(0..3), (2..6), (7..10)])).to be true
     end
 
-    it 'should not care about overlaps outside range' do
-      expect((11..15)).to_not have_overlaps_within([(0..3), (2..6), (7..10)])
+    it 'should not care about overlaps outside self' do
+      expect(Range.overlaps_among?([(0..3), (2..6), (7..10)])).to be true
+      expect((11..15).overlaps_among?([(0..3), (2..6), (7..10)])).to be false
     end
 
     it 'should not count contiguous ranges as overlapping' do
-      expect((0..10)).to_not have_overlaps_within([(0..3), (4..6), (7..10)])
+      expect(Range.overlaps_among?([(0..3), (4..6), (7..10)])).to be false
     end
 
     it 'should not count non-contiguous ranges as overlapping' do
-      expect((0..10)).to_not have_overlaps_within([(0..3), (4..6), (8..10)])
+      expect(Range.overlaps_among?([(0..3), (4..6), (8..10)])).to be false
     end
 
     it 'should not count an empty set as overlapping' do
-      expect((0..10)).to_not have_overlaps_within([])
+      expect(Range.overlaps_among?([])).to be false
     end
   end
 

data/spec/lib/string_spec.rb

@@ -1,4 +1,5 @@
 require 'fat_core/string'
+require 'fat_core/date'
 
 describe String do
   before do
@@ -70,8 +71,20 @@ the people, for the people, shall not perish from the earth."
       expect('   string    here  '.clean).to eq 'string here'
     end
 
-    it 'should be able to convert a digital date to iso form' do
-      expect('20140521'.digdate2iso).to eq '2014-05-21'
+    it 'should be able to convert a numeric string to a commified form' do
+      expect('20140521'.commas).to eq '20,140,521'
+      expect('20140521.556'.commas).to eq '20,140,521.556'
+      expect('20140521.556'.commas(2)).to eq '20,140,521.56'
+      expect('-20140521.556'.commas).to eq '-20,140,521.556'
+      expect('+20140521.556'.commas).to eq '20,140,521.556'
+      expect('+20140521.556e3'.commas).to eq '20,140,521,556'
+    end
+
+    it 'should be able to convert a digital date to a Date' do
+      expect('20140521'.as_date.iso).to eq '2014-05-21'
+      expect('2014-05-21'.as_date.iso).to eq '2014-05-21'
+      expect('2014/05/21'.as_date.iso).to eq '2014-05-21'
+      expect('2014/5/21'.as_date.iso).to eq '2014-05-21'
     end
 
     it 'should wrap a short string' do
@@ -97,13 +110,6 @@ the people, for the people, shall not perish from the earth."
       expect(str.split("\n")[23]).to match(/^#{twenty_fourth_line}/)
     end
 
-    it 'should be able to quote special TeX characters' do
-      expect('$10,000'.tex_quote).to eq('\\$10,000')
-      expect('would~~have'.tex_quote).to eq('would\\textasciitilde{}\\textasciitilde{}have')
-      expect('<hello>'.tex_quote).to eq('\\textless{}hello\\textgreater{}')
-      expect('{hello}'.tex_quote).to eq('\\{hello\\}')
-    end
-
     it 'should be able to determine is it\'s a valid number' do
       expect('88'.number?).to be true
       expect('-88'.number?).to be true
@@ -147,44 +153,6 @@ the people, for the people, shall not perish from the earth."
         .to eq "hello world   it's me"
     end
 
-    it 'should be able to fuzzy match with another string' do
-      expect('Hello, world'.fuzzy_match('or')).to be_truthy
-      expect('Hello, world'.fuzzy_match('ox')).to be_falsy
-    end
-
-    it 'should be able to match with another string containing re' do
-      expect('Hello, world'.matches_with('/or/')).to be_truthy
-      expect('Hello, world'.matches_with('/ox/')).to be_falsy
-    end
-
-    it 'should be able to match with another string containing string' do
-      expect('Hello, world'.matches_with('or')).to be_truthy
-      expect('Hello, world'.matches_with('ox')).to be_falsy
-    end
-
-    it 'should be able to fuzzy match space-separated parts' do
-      expect('Hello world'.fuzzy_match('hel or')).to be_truthy
-      expect('Hello, world'.fuzzy_match('hel ox')).to be_falsy
-    end
-
-    it 'should be able to fuzzy match colon-separated parts' do
-      expect('Hello:world'.fuzzy_match('hel:or')).to be_truthy
-      expect('Hello:world'.fuzzy_match('hel:ox')).to be_falsy
-    end
-
-    it 'should return the matched text' do
-      expect('Hello:world'.fuzzy_match('hel')).to eq('Hel')
-      expect('Hello:world'.fuzzy_match('hel:or')).to eq('Hello:wor')
-      expect('Hello:world'.matches_with('/^h.*r/')).to eq('Hello:wor')
-    end
-
-    it 'should ignore periods, commas, and apostrophes when matching' do
-      expect("St. Luke's".fuzzy_match('st lukes')).to eq('St Lukes')
-      expect('St Lukes'.fuzzy_match('st. luke\'s')).to eq('St Lukes')
-      expect('St Lukes, Inc.'.fuzzy_match('st luke inc')).to eq('St Lukes Inc')
-      expect('E*TRADE'.fuzzy_match('etrade')).to eq('ETRADE')
-    end
-
     it 'should be able to properly capitalize a string as a title' do
       # Capitalize little words only at beginning and end
       expect('the cat in the hat'.entitle).to eq('The Cat in the Hat')
@@ -194,14 +162,14 @@ the people, for the people, shall not perish from the earth."
       expect('tr'.entitle).to eq('Tr')
       expect('trd'.entitle).to eq('TRD')
       # Don't capitalize c/o
-      expect('IBM c/o watson'.entitle).to eq('Ibm c/o Watson')
+      expect('IBM c/o watson'.entitle).to eq('IBM c/o Watson')
       # Capitlaize p.o.
       expect('p.o. box 123'.entitle).to eq('P.O. Box 123')
       # Don't capitalize ordinals
       expect('22nd of september'.entitle).to eq('22nd of September')
       # Capitalize common abbrevs
-      expect('US BANK'.entitle).to eq('US Bank')
-      expect('NW territory'.entitle).to eq('NW Territory')
+      expect('US BANK'.entitle).to eq('US BANK')
+      expect('nw territory'.entitle).to eq('NW Territory')
       # Leave word starting with numbers alone
       expect('apartment 33-B'.entitle).to eq('Apartment 33-B')
       # Assume all consanants is an acronym
@@ -212,14 +180,60 @@ the people, for the people, shall not perish from the earth."
 
     it 'should be able to compute its Levenshtein distance from another string' do
       expect('Something'.distance('Smoething')).to eq 1
-      expect('Something'.distance('Smoething', block_size: 0)).to eq 2
-      expect('Something'.distance('meSothing', block_size: 1)).to eq 4
-      expect('Something'.distance('meSothing', block_size: 2)).to eq 2
-      expect('SomethingElse'.distance('Encyclopedia')).to eq 10
-      expect('SomethingElseUnrelated'.distance('EncyclopediaBritanica', max_distance: 40))
-        .to eq 21
-      expect('SomethingElseUnrelated'.distance('EncyclopediaBritanica',
-                                               max_distance: 15)).to eq 15
+      expect('Something'.distance('meSothing')).to eq 4
+      expect('SomethingElse'.distance('Encyclopedia')).to eq 11
+      expect('SomethingElseUnrelated'.distance('EncyclopediaBritanica'))
+        .to eq 11
+      expect('SomethingElseUnrelated'.distance('EncyclopediaBritanica')).to eq 11
+    end
+
+    describe 'Quoting' do
+      it 'should be able to quote special TeX characters' do
+        expect('$10,000'.tex_quote).to eq('\\$10,000')
+        expect('would~~have'.tex_quote).to eq('would\\textasciitilde{}\\textasciitilde{}have')
+        expect('<hello>'.tex_quote).to eq('\\textless{}hello\\textgreater{}')
+        expect('{hello}'.tex_quote).to eq('\\{hello\\}')
+      end
+    end
+
+    describe 'Matching' do
+      it 'should be able to fuzzy match with another string' do
+        expect('Hello, world'.fuzzy_match('or')).to be_truthy
+        expect('Hello, world'.fuzzy_match('ox')).to be_falsy
+      end
+
+      it 'should be able to fuzzy match with another string containing re' do
+        expect('Hello, world'.matches_with('/or/')).to be_truthy
+        expect('Hello, world'.matches_with('/ox/')).to be_falsy
+      end
+
+      it 'should be able to fuzzy match space-separated parts' do
+        expect('Hello world'.fuzzy_match('hel or')).to be_truthy
+        expect('Hello, world'.fuzzy_match('hel ox')).to be_falsy
+      end
+
+      it 'should be able to fuzzy match colon-separated parts' do
+        expect('Hello:world'.fuzzy_match('hel:or')).to be_truthy
+        expect('Hello:world'.fuzzy_match('hel:ox')).to be_falsy
+      end
+
+      it 'should be able to fuzzy match colon-separated parts' do
+        expect('Hello:world'.fuzzy_match('hel:or')).to be_truthy
+        expect('Hello:world'.fuzzy_match('hel:ox')).to be_falsy
+      end
+
+      it 'should return the matched text' do
+        expect('Hello:world'.fuzzy_match('hel')).to eq('Hel')
+        expect('Hello:world'.fuzzy_match('hel:or')).to eq('Hello:wor')
+        expect('Hello:world'.matches_with('/^h.*r/')).to eq('Hello:wor')
+      end
+
+      it 'should ignore periods, commas, and apostrophes when matching' do
+        expect("St. Luke's".fuzzy_match('st lukes')).to eq('St Lukes')
+        expect('St Lukes'.fuzzy_match('st. luke\'s')).to eq('St Lukes')
+        expect('St Lukes, Inc.'.fuzzy_match('st luke inc')).to eq('St Lukes Inc')
+        expect('E*TRADE'.fuzzy_match('etrade')).to eq('ETRADE')
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -5,8 +5,9 @@ SimpleCov.start
 require 'bundler/setup'
 Bundler.setup
 
-require 'pry'
-require 'byebug'
+# Note: I now include these in my global ~/.rspec file, so no need for them
+# here.
+# require 'pry' require 'byebug'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fat_core
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 4.0.0
 platform: ruby
 authors:
 - Daniel E. Doherty
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-09 00:00:00.000000000 Z
+date: 2017-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: simplecov
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rcodetools
+  name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -182,7 +182,6 @@ description: Write a longer description. Optional.
 email:
 - ded@ddoherty.net
 executables:
-- console
 - easters
 extensions: []
 extra_rdoc_files: []
@@ -201,12 +200,11 @@ files:
 - bin/console
 - bin/easters
 - fat_core.gemspec
-- lib/core_extensions/date/fat_core.rb
 - lib/fat_core.rb
 - lib/fat_core/ChangeLog
 - lib/fat_core/all.rb
 - lib/fat_core/array.rb
-- lib/fat_core/big_decimal.rb
+- lib/fat_core/bigdecimal.rb
 - lib/fat_core/date.rb
 - lib/fat_core/enumerable.rb
 - lib/fat_core/hash.rb
@@ -218,7 +216,7 @@ files:
 - lib/fat_core/symbol.rb
 - lib/fat_core/version.rb
 - spec/lib/array_spec.rb
-- spec/lib/big_decimal_spec.rb
+- spec/lib/bigdecimal_spec.rb
 - spec/lib/date_spec.rb
 - spec/lib/enumerable_spec.rb
 - spec/lib/hash_spec.rb
@@ -232,7 +230,8 @@ files:
 homepage: ''
 licenses:
 - MIT
-metadata: {}
+metadata:
+  yard.run: yri
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -249,13 +248,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: fat_core provides some useful core extensions
 test_files:
 - spec/lib/array_spec.rb
-- spec/lib/big_decimal_spec.rb
+- spec/lib/bigdecimal_spec.rb
 - spec/lib/date_spec.rb
 - spec/lib/enumerable_spec.rb
 - spec/lib/hash_spec.rb

data/lib/core_extensions/date/fat_core.rb

@@ -1,6 +0,0 @@
-module CoreExtensions
-  module Date
-    module FatCore
-    end
-  end
-end

data/lib/fat_core/big_decimal.rb

@@ -1,12 +0,0 @@
-require 'bigdecimal'
-
-module FatCore
-  module BigDecimal
-    # Provide a human-readable display for BigDecimal. e.g., while debugging.
-    def inspect
-      to_f.to_s
-    end
-  end
-end
-
-BigDecimal.prepend(FatCore::BigDecimal)