duffy 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73762eee91c5b809fa97cbecf522816e751d80d87ab085d8ba29a7aa0971dd37
-  data.tar.gz: 41d570f9aa5e93fcf875567f0a689db05770ed58d293aab8997c86860635ec5e
+  metadata.gz: 7b26949061663fcfd666bc4479d89671494dfc81d2e14a3bb3189970de202255
+  data.tar.gz: e8dc1912140fc07fb39c4f9d15070c26397d91b9cd63fdaa7fc164e889e4cf5c
 SHA512:
-  metadata.gz: 68ba4df32be9196d43b56b30c4ec97c39ae6794cac761f3fc2f5cbd622967a65bec9b1b138664569a153c66e4113ed9988f4547910a8e785f82f5a35e62167b8
-  data.tar.gz: 22616030c9bedd21996236912e0eab43d53ad617c5361b4bff7d8ff20b7d6ec95275e951e16883a601d7d92860f9d50448c8e4b3c968b6455f769db1889edc48
+  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/lib/duffy/array.rb

@@ -14,4 +14,36 @@ class Array
     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.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/version.rb

@@ -1,8 +1,9 @@
 module Duffy
-  VERSION = '1.0.5'
+  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.

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: duffy
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Jacob Duffy
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-20 00:00:00.000000000 Z
+date: 2022-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -102,10 +102,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -113,6 +113,7 @@ files:
 - bin/console
 - doc/abc.png
 - doc/abc123.png
+- doc/markdown.png
 - duffy.gemspec
 - lib/duffy.rb
 - lib/duffy/active_record.rb
@@ -139,7 +140,7 @@ homepage: https://github.com/duffyjp/duffy
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,8 +155,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Library of things
 test_files:

data/.travis.yml

@@ -1,18 +0,0 @@
-env:
-  global:
-    - CC_TEST_REPORTER_ID=d77de389b3b98dc3b4f404875592cde5efbf22d5268880fc8e86c4c323871bb9
-language: ruby
-rvm:
-  - 2.6.1
-
-before_install:
-  - gem update bundler
-
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script:
-  - bundle exec rspec
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT