duffy 1.0.1 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '031931bb20a67704daaeb756697289c59b8b4b17d20542e547f44b9a810f8937'
-  data.tar.gz: 8d1d8ce9b7815f888604ff54be223a4efb4cecac8c5d6a8f3da7b63bb5be943b
+  metadata.gz: 7b26949061663fcfd666bc4479d89671494dfc81d2e14a3bb3189970de202255
+  data.tar.gz: e8dc1912140fc07fb39c4f9d15070c26397d91b9cd63fdaa7fc164e889e4cf5c
 SHA512:
-  metadata.gz: 7eaf20af8b3da4f7d0524fa485cf08faa159fe706a93e5d3d63e6ca58e1e38b4460eed508b4a09ebd083b3261378cb215de93bb46c0d636a7e285d0999fccd44
-  data.tar.gz: a33c601156a194d07e7a5675ca5ab94363181a1ccc6f2175e66fe6240e670fe1eddb454809637f47fde604a8f4de0a3c7c2d199b968a4cb2ee651ba85f63fab2
+  metadata.gz: 2816bf8e70c972cc7ce9e3066f8d54d9c93cb8e00958e2bd7ada8ab060163958faaeff52ca973af982039994acdcef6a0148b907d2193976ed4cbcf0787bfa11
+  data.tar.gz: '065851c6e0a9e97533715eef0800390cd0811c2ecc3453871479be7fb9d85056fbdc4327c54cbf4555819e5aa81b5f82c1007cd94525c316c17bb905f980dae0'

data/.github/workflows/rspec.yml

@@ -0,0 +1,17 @@
+name: RSpec
+on: push
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby: [2.6, 2.7, '3.0', 3.1]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+      - run: bundle exec rake

data/README.md

@@ -1,9 +1,5 @@
 # Duffy
 
-[![Build Status](https://travis-ci.org/duffyjp/duffy.svg?branch=master)](https://travis-ci.org/duffyjp/duffy)
-[![Code Climate](https://codeclimate.com/github/duffyjp/duffy/badges/gpa.svg)](https://codeclimate.com/github/duffyjp/duffy)
-[![Test Coverage](https://codeclimate.com/github/duffyjp/duffy/badges/coverage.svg)](https://codeclimate.com/github/duffyjp/duffy/coverage)
-
 This is a collection of reusable things I don't want to keep duplicating in tons of projects.
 
 ## Installation
@@ -39,10 +35,10 @@ to_ssn            | "123456789"     | "123-45-6789"
 
 
 ## Array Patches:
-Method            | Example                | Output
-------------------|------------------------|-------
-to_box            | ['abc', 123].to_box    | ![Example](doc/abc123.png)
-
+Method            | Example                   | Output
+------------------|---------------------------|-------
+to_box            | ['abc', 123].to_box       | ![Example](doc/abc123.png)
+to_markdown       | [[1,2],[3,4]].to_markdown | ![Example](doc/markdown.png)
 
 ## Date Patches:
 * See config to set your organization's fiscal year start.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "duffy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/duffy.gemspec

@@ -19,8 +19,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'activesupport' # Required for ActiveSupport::Configurable
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
   spec.add_development_dependency "rails", '>= 5.0'
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+
 end

data/lib/duffy/array.rb

@@ -10,8 +10,40 @@ class Array
   def to_box(safe: true)
     return nil if self.empty?
     b = safe ? "+-++ | +++" : "╔─╦╗ ║ ╚╩╝"
-    out  = (b[0] + self.map{ |x| b[1] * (x.to_s.length + 2) }.join(b[2]) + b[3])[0,80] + "\n"
+    out  = (b[0] + self.map{ |x| b[1] * (x.to_s.gsub(/\e\[([;\d]+)?m/, '').length + 2) }.join(b[2]) + b[3])[0,80] + "\n"
     out << (b[5,2] + self.join(b[4,3]) + b[4,2])[0,80] + "\n"
-    out << (b[7] + self.map{ |x| b[1] * (x.to_s.length + 2) }.join(b[8]) + b[9])[0,80]
+    out << (b[7] + self.map{ |x| b[1] * (x.to_s.gsub(/\e\[([;\d]+)?m/, '').length + 2) }.join(b[8]) + b[9])[0,80]
   end
+
+
+
+  # Create a markdown table from a 2D Array
+  #
+  # puts [["Car", "Boat", Date.today, 5],["Horse", "Car", nil, 0]].to_markdown
+  # String | String | Date       | Integer
+  # -------|--------|------------|---------
+  # Car    | Boat   | 2022-01-12 | 5
+  # Horse  | Car    |            | 0
+  #
+  def to_markdown
+    raise "expected 2D array" unless self.first.is_a?(Array)
+
+    # Find max widths of data/headers: eg => [10, 25, 18, 21, 6]
+    widths = self.transpose.map{ |col| ([col.first.class.to_s.length] + col.map{ |i| i.to_s.length }).max }
+
+    # Use the class of each cell in the first row for the table headers.
+    out = self.first.map.with_index{|c,i| c.class.to_s.ljust(widths[i])}.join(" | ") + "\n"
+    out << out.gsub(/[^|]/, "-") + "\n"
+
+    # Left justify each cell
+    self.each do |row|
+      out << row.map(&:to_s).map.with_index{|c,i| c.ljust(widths[i])}.join(" | ") + "\n"
+    end
+    out
+
+  rescue => e
+    warn "Unable to generate table: #{e}"
+    nil
+  end
+
 end

data/lib/duffy/string.rb

@@ -113,11 +113,11 @@ class String
     string = (self.upcase == self)? self.downcase : self
 
     result = ""
-    string.gsub(/[_-]/, ' ').split(/( [:.;?!][ ] | (?:[ ]|^)[""] )/x).each do |s|
+    string.gsub('_', ' ').split(/( [:.;?!][ ] | (?:[ ]|^)[""] )/x).each do |s|
       s.gsub!(/ \b( [[:alpha:]] [[:lower:].'']* )\b /x) do |w|
         # Skip words with inresult dots, e.g. "del.icio.us" or "example.com"
         (w =~ / [[:alpha:]] [.] [[:alpha:]] /x) ? w : w.capitalize
-      end #gsub!
+      end
 
       # Lowercase our list of small words:
       s.gsub!(/\b(#{small_re})\b/io) { |w| w.downcase }
@@ -135,9 +135,19 @@ class String
     # Special Cases:
     upcase_re = (Array(Duffy.configuration.upcase_custom) + Array(Duffy.configuration.upcase_default)).uniq.join("|")
 
+    # Names with apostrophes; O'Brian, De'Wayne. 3+ Skips "I've" "Haven't" etc.
+    result.gsub!(/([A-Z][a-z]*)'([a-z]{3,})/) { "#{$1}'#{$2.capitalize}" }
+
     result.gsub!(/ V(s?)\. /, ' v\1. ') # "v." and "vs."
+
     result.gsub!(/([''])S\b/, '\1s') # 'S (otherwise you get "the SEC'S decision")
+
     result.gsub!(/\b(#{upcase_re})\b/i) { |w| w.upcase } unless upcase_re.blank?
-    result
+
+    # Squash repeated whitespace characters
+    result.gsub!(/\s+/, ' ')
+
+    # Strip leading / tailing whitespace and return
+    result.strip
   end
 end

data/lib/duffy/system.rb

@@ -92,6 +92,20 @@ module Duffy
         0
       end
 
+      # The battery percentage 0.0 .. 100.0
+      # nil if no battery or error reading value.
+      # Darwin: pmset -g batt
+      # Linux:
+      def battery_percent
+        case RUBY_PLATFORM
+          when /darwin/ then `pmset -g batt`.scan(/^.*\t(.*%);/)[0][0].to_f
+          when /linux/  then File.read("/sys/class/power_supply/BAT0/charge_now").to_i * 100 / File.read("/sys/class/power_supply/BAT0/charge_full").to_i
+          else nil
+        end
+      rescue
+        nil
+      end
+
       # Memory available for use in Megabytes
       # Darwin: vm_stat (Pages Free + Pages Inactive)
       # Linux:  Read /proc/meminfo
@@ -119,6 +133,7 @@ module Duffy
         0
       end
 
+
       private
 
       # [CPU USE, CPU IDLE]

data/lib/duffy/version.rb

@@ -1,8 +1,13 @@
 module Duffy
-  VERSION = '1.0.1'
+  VERSION = '1.0.6'
 end
 
 # History
+# 1.0.6 - Add to_markdown Array method.
+# 1.0.5 - Update smart_titlecase to better accommodate names.
+# 1.0.4 - Added battery_percent method.
+# 1.0.3 - to_box methods now accept ANSI colored strings.
+# 1.0.2 - Added SimpleCov and added some more String tests.
 # 1.0.1 - Added String.to_box and Array.to_box.  Nice for text banners.
 # 1.0.0 - Using Shellwords to escape directory listing in System.freespace.
 # 0.3.6 - Added disk freespace method.  Looks at working directory.

data/spec/array_spec.rb

@@ -21,4 +21,33 @@ describe Array do
     end
 
   end
+
+  describe "to_markdown" do
+
+    it "creates a markdown compatible table" do
+      array = [[1,2,3],[4,5,6],[7,8,9]]
+      expect(array.to_markdown).to eq "Integer | Integer | Integer\n--------|---------|---------\n1       | 2       | 3      \n4       | 5       | 6      \n7       | 8       | 9      \n"
+    end
+
+    it "uses the first row for column header names" do
+      array = [[1, "a", Date.today]]
+      expect(array.to_markdown.lines.first).to eq "Integer | String | Date      \n"
+    end
+
+    it "arrays with very short data format correctly" do
+      array = [[1,2,3],[4,5,6],[7,8,9]]
+      expect(array.to_markdown).to eq "Integer | Integer | Integer\n--------|---------|---------\n1       | 2       | 3      \n4       | 5       | 6      \n7       | 8       | 9      \n"
+    end
+
+    it "rejects non-2D arrays" do
+      array = ["Wisconsin", "cheese"]
+      expect{array.to_markdown}.to output("Unable to generate table: expected 2D array\n").to_stderr
+    end
+
+    it "rejects arrays with inconsistent dimensions" do
+      array = [[1],[2,3],[4,5,6]]
+      expect{array.to_markdown}.to output("Unable to generate table: element size differs (2 should be 1)\n").to_stderr
+    end
+  end
+
 end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'simplecov'
+SimpleCov.start
+
 require 'bundler/setup'
 require 'rails'
 Bundler.setup

data/spec/string_spec.rb

@@ -2,6 +2,89 @@ require 'spec_helper'
 
 describe String do
 
+  describe "md5" do
+    it "generates an md5sum of the given string" do
+      expect("foobar".md5).to eq "3858f62230ac3c915f300c664312c63f"
+    end
+  end
+
+  describe "pretty_phone" do
+    it "formats an American phone number with Area Code" do
+      expect("1234567890".pretty_phone).to eq "(123) 456-7890"
+    end
+
+    it "formats an American phone number without Area Code" do
+      expect("4567890".pretty_phone).to eq "456-7890"
+    end
+
+    it "leaves longer strings alone" do
+      expect("11234567890".pretty_phone).to eq "11234567890"
+    end
+
+    it "leaves shorter strings alone" do
+      expect("1123".pretty_phone).to eq "1123"
+    end
+  end
+
+  describe "smart_titlecase" do
+    {
+      "123 Main St."            => "123 Main St.",            # Numbers are allowed
+      "A Tale Of Two Cities"    => "A Tale of Two Cities",    # Articles are only capitalized if first
+      "At mt. Kilimanjaro"      => "At Mt. Kilimanjaro",      # Small non-articles are capitalized
+      "De'wayne"                => "De'Wayne",                # Names with apostrophes (longer first half)
+      "Hyphenated-Lastname"     => "Hyphenated-Lastname",     # Hyphenated words retain hyphen and capitalize
+      "I'm Here Ma'am"          => "I'm Here Ma'am",          # Contractions are treated as a single word
+      "Miller (Smith)"          => "Miller (Smith)",          # Parentheses are allowed
+      "O'brian"                 => "O'Brian",                 # Names with apostrophes (single character first half)
+      "Sample"                  => "Sample",                  # Already Capitalized, all lower, all upper okay
+      "Under_scores"            => "Under Scores",            # Underscores are treated as spaces
+
+      "Double  Space"           => "Double Space",            # Clear duplicated whitespace
+      "  Leading Space"         => "Leading Space",           # Remove leading whitespace
+      "Trailing Space  "        => "Trailing Space",          # Remove trailing whitespace
+    }.each do |before, after|
+
+      # As typed above
+      it "#{before.strip.ljust(22)} => #{after}" do
+        expect(before.smart_titlecase).to eq after
+      end
+
+      # As all-lowercase
+      it "#{before.strip.downcase.ljust(22)} => #{after}" do
+        expect(before.downcase.smart_titlecase).to eq after
+      end
+
+      # As all-uppercase
+      it "#{before.strip.upcase.ljust(22)} => #{after}" do
+        expect(before.upcase.smart_titlecase).to eq after
+      end
+    end
+
+    # CamelCase words will be preserved.
+    {
+      "DreamWorks"              => "DreamWorks",
+      "McDonald's happy-meal"   => "McDonald's Happy-Meal",
+    }.each do |before, after|
+
+      # As typed above
+      it "#{before.ljust(22)} => #{after}" do
+        expect(before.smart_titlecase).to eq after
+      end
+    end
+
+  end
+
+  describe "to_alpha" do
+    it "strips everything but a-z and A-Z" do
+      expect("123abc$%^DEF".to_alpha).to eq "abcDEF"
+    end
+  end
+  describe "to_alpha_numeric" do
+    it "strips everything but a-z, A-Z and 0-9" do
+      expect("123abc$%^DEF".to_alpha_numeric).to eq "123abcDEF"
+    end
+  end
+
   describe "to_box" do
     it "creates a safe box around a string" do
       expect("foobar".to_box).to eq "+--------+\n| foobar |\n+--------+"

data/spec/system_spec.rb

@@ -3,10 +3,16 @@ describe Duffy::System do
 
   # These methods return per-host settings.  Verify the return object type and value within reason.
   # This generates the documentation more than anything.
-  describe "cpus" do
-    it "returns the number of physical cpus" do
-      expect(Duffy::System.cpus).to be_an(Integer)
-      expect(Duffy::System.cpus).to be >= 1
+
+  describe "battery_percent" do
+    it "returns the percentage of battery remaining" do
+      expect([Float, nil]).to include Duffy::System.battery_percent.class
+    end
+  end
+
+  describe "cpu_percent" do
+    it "returns the current cpu load percentage" do
+      expect(Duffy::System.cpu_percent).to be_a(Float)
     end
   end
 
@@ -17,6 +23,13 @@ describe Duffy::System do
     end
   end
 
+  describe "cpus" do
+    it "returns the number of physical cpus" do
+      expect(Duffy::System.cpus).to be_an(Integer)
+      expect(Duffy::System.cpus).to be >= 1
+    end
+  end
+
   describe "freespace" do
     it "returns working directory freespace in megabytes" do
       expect(Duffy::System.freespace).to be_an(Integer)
@@ -24,23 +37,17 @@ describe Duffy::System do
     end
   end
 
-
-  describe "threads" do
-    it "returns the total number of threads" do
-      expect(Duffy::System.threads).to be_an(Integer)
-      expect(Duffy::System.threads).to be >= 1
-    end
-  end
-
-  describe "virtual?" do
-    it "returns true if in a hypervisor, false otherwise." do
-      expect(Duffy::System.virtual?).to be_in [true, false]
+  describe 'mem_available' do
+    it "returns the amount of available memory in Megabytes" do
+      expect(Duffy::System.mem_available).to be_an(Integer)
+      expect(Duffy::System.mem_available).to be > 0
     end
   end
 
-  describe "cpu_percent" do
-    it "returns the current cpu load percentage" do
-      expect(Duffy::System.cpu_percent).to be_a(Float)
+  describe 'mem_percent' do
+    it "returns the amount of used memory as a percentage of total" do
+      expect(Duffy::System.mem_percent).to be_a(Float)
+      expect(Duffy::System.mem_percent).to be > 0
     end
   end
 
@@ -51,13 +58,6 @@ describe Duffy::System do
     end
   end
 
-  describe 'mem_available' do
-    it "returns the amount of available memory in Megabytes" do
-      expect(Duffy::System.mem_available).to be_an(Integer)
-      expect(Duffy::System.mem_available).to be > 0
-    end
-  end
-
   describe 'mem_used' do
     it "returns the amount of used memory in Megabytes" do
       expect(Duffy::System.mem_used).to be_an(Integer)
@@ -65,12 +65,17 @@ describe Duffy::System do
     end
   end
 
-  describe 'mem_percent' do
-    it "returns the amount of used memory as a percentage of total" do
-      expect(Duffy::System.mem_percent).to be_a(Float)
-      expect(Duffy::System.mem_percent).to be > 0
+  describe "threads" do
+    it "returns the total number of threads" do
+      expect(Duffy::System.threads).to be_an(Integer)
+      expect(Duffy::System.threads).to be >= 1
     end
   end
 
+  describe "virtual?" do
+    it "returns true if in a hypervisor, false otherwise." do
+      expect(Duffy::System.virtual?).to be_in [true, false]
+    end
+  end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duffy
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.6
 platform: ruby
 authors:
 - Jacob Duffy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-03-01 00:00:00.000000000 Z
+date: 2022-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -28,30 +28,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -80,23 +80,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Random collection of useful things.
 email:
 - duffy.jp@gmail.com
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
 - doc/abc.png
 - doc/abc123.png
+- doc/markdown.png
 - duffy.gemspec
 - lib/duffy.rb
 - lib/duffy/active_record.rb
@@ -123,7 +140,7 @@ homepage: https://github.com/duffyjp/duffy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,8 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Library of things
 test_files:

data/.travis.yml

@@ -1,6 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.0
-
-before_install:
-  - gem update bundler