barcharts 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5393825325d9bc8d34a37947ee8ab0f23fa1a33e
+  data.tar.gz: 5ee63429bba7ad9fbd65e199f6ae263be43083e9
+SHA512:
+  metadata.gz: b21fa054fcc843fa93662d54cf2c981aab09f845cfc9933c32009a442418b5cc6b06241a37eace67e5a74573bcb87ca1463fb8e882511930425a673b3101806e
+  data.tar.gz: 639270dc6175fc3e8211d075b7845458ea7e31f370636d857e729c5934c74888f94e2433916701497492f53c2c44d7a6521c2f0651560200d1695c6aa2f0f149

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+
+### 0.0.1 / 2020-03-06
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,9 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/barcharts.rb
+lib/barcharts/version.rb
+script/test_readme.rb
+test/helper.rb
+test/test_barchart.rb

data/README.md

@@ -0,0 +1,189 @@
+# barcharts gem - print barcharts in your terminal in ascii or with unicode block elements
+
+* home  :: [github.com/feedreader/pluto](https://github.com/feedreader/pluto)
+* bugs  :: [github.com/feedreader/pluto/issues](https://github.com/feedreader/pluto/issues)
+* gem   :: [rubygems.org/gems/barcharts](https://rubygems.org/gems/barcharts)
+* rdoc  :: [rubydoc.info/gems/barcharts](http://rubydoc.info/gems/barcharts)
+* forum :: [groups.google.com/group/wwwmake](http://groups.google.com/group/wwwmake)
+
+
+## Usage
+
+Use the `barchart` method to print barcharts.
+Let's use the
+"Q: Where do Rubyists come from / What are the top countries for blogs?"
+example from the Planet Ruby page:
+
+``` ruby
+require 'barchart'
+
+data = [
+  ['Australia',     3],
+  ['Austria',       1],
+  ['Canada',        1],
+  ['Croatia',       1],
+  ['India',         1],
+  ['Poland',        2],
+  ['Spain',         1],
+  ['Switzerland',   1],
+  ['Ukraine',       1],
+  ['United States', 6],
+]
+
+# -or-
+
+data = {
+  'Australia':     3,
+  'Austria':       1,
+  'Canada':        1,
+  'Croatia':       1,
+  'India':         1,
+  'Poland':        2,
+  'Spain':         1,
+  'Switzerland':   1,
+  'Ukraine':       1,
+  'United States': 6,
+}
+
+puts barchart( data, title: 'Location', chars: '*' )
+```
+
+Resulting in:
+
+```
+Location  (n=18)
+---------------------------------
+  Australia      (16%) | ******** 3
+  Austria        ( 5%) | ** 1
+  Canada         ( 5%) | ** 1
+  Croatia        ( 5%) | ** 1
+  India          ( 5%) | ** 1
+  Poland         (11%) | ***** 2
+  Spain          ( 5%) | ** 1
+  Switzerland    ( 5%) | ** 1
+  Ukraine        ( 5%) | ** 1
+  United States  (33%) | **************** 6
+```
+
+or using Unicode block elements:
+
+``` ruby
+puts barchart( data, title: 'Location', chars: '▏▎▍▋▊▉' )
+```
+
+Resulting in:
+
+```
+Location  (n=18)
+---------------------------------
+  Australia      (16%) | ▉▉▉▉▉▉▉▉▍ 3
+  Austria        ( 5%) | ▉▉▊ 1
+  Canada         ( 5%) | ▉▉▊ 1
+  Croatia        ( 5%) | ▉▉▊ 1
+  India          ( 5%) | ▉▉▊ 1
+  Poland         (11%) | ▉▉▉▉▉▋ 2
+  Spain          ( 5%) | ▉▉▊ 1
+  Switzerland    ( 5%) | ▉▉▊ 1
+  Ukraine        ( 5%) | ▉▉▊ 1
+  United States  (33%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▊ 6
+```
+
+
+Aside: What are Unicode block elements?
+
+Unicode among other block elements defines:
+
+- `▏`   - U+258F - Left one eighth block
+- `▎`   - U+258E - Left one quarter block
+- `▍`   - U+258D - Left three eighths block
+- `▋`   - U+258B - Left five eighths block
+- `▊`   - U+258A - Left three quarters block
+- `▉`   - U+2589 - Left seven eighths block
+
+See [Block Elements @ Wikipedia](https://en.wikipedia.org/wiki/Block_Elements) for more.
+
+
+
+### Barchart Options - `sort: true|false`, `n: <sample size>`
+
+Pass in `sort: true` to reverse sort the dataset (highest values first).
+Let's use the
+"Q: What (web site) publishing tools are in use?" example:
+
+``` ruby
+data = [
+  ['Webgen',      1],
+  ['Jekyll',     12],
+  ['WordPress',   3],
+  ['Hugo',        1],
+  ['Ghost',       2],
+  ['Transistor',  1],
+  ['Simplecast',  1],
+  ['?',          30],
+]
+
+puts barchart( data, title: 'Generators', sort: true )
+```
+
+Resulting in:
+
+```
+Generators  (n=51)
+---------------------------------
+  ?           (58%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▍ 30
+  Jekyll      (23%) | ▉▉▉▉▉▉▉▉▉▉▉▊ 12
+  WordPress   ( 5%) | ▉▉▉ 3
+  Ghost       ( 3%) | ▉▉ 2
+  Hugo        ( 1%) | ▉ 1
+  Transistor  ( 1%) | ▉ 1
+  Simplecast  ( 1%) | ▉ 1
+  Webgen      ( 1%) | ▉ 1
+```
+
+
+Pass in `n: <sample size>` to use a "custom" sample size
+AND to turn off the auto-calculation of the
+usage percentage.
+Let's use the
+"Q: What are the top topics / words in headlines?" example:
+
+``` ruby
+data = [
+  ['rails',       13],
+  ['ruby',        12],
+  ['conferences',  6],
+  ['dry',          5],
+  ['rom',          4],
+  ['ml',           2],
+]
+
+puts barchart( data, title: 'Top Words in Headlines 2020', n: 47)
+```
+
+resulting in:
+
+```
+Top Words in Headlines 2020  (n=47)
+---------------------------------
+  rails        | ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▍ 13
+  ruby         | ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▎ 12
+  conferences  | ▉▉▉▉▉▉▉▏ 6
+  dry          | ▉▉▉▉▉▉ 5
+  rom          | ▉▉▉▉▊ 4
+  ml           | ▉▉▍ 2
+```
+
+
+That's all for now.
+
+
+
+## License
+
+The `barcharts` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+## Questions? Comments?
+
+Send them along to the [wwwmake Forum/Mailing List](http://groups.google.com/group/wwwmake).
+Thanks!

data/Rakefile

@@ -0,0 +1,28 @@
+require 'hoe'
+require './lib/barcharts/version.rb'
+
+Hoe.spec 'barcharts' do
+
+  self.version = Barcharts::VERSION
+
+  self.summary = "barcharts - print barcharts in your terminal in ascii or with unicode block elements"
+  self.description = summary
+
+  self.urls    = ['https://github.com/feedreader/pluto']
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = []
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.2.2'
+  }
+
+end

data/lib/barcharts.rb

@@ -0,0 +1,96 @@
+require 'pp'
+require 'date'
+require 'time'
+require 'json'
+
+
+# our own code
+require 'barcharts/version'   # note: let version always go first
+
+
+
+def bar( value, max_value, max_width: 50, chars: '▏▎▍▋▊▉' )
+  # ▏   - U+258F  Left one eighth block
+  # ▎   - U+258E  Left one quarter block
+  # ▍   - U+258D  Left three eighths block
+  # ▋   - U+258B  Left five eighths block
+  # ▊   - U+258A  Left three quarters block
+  # ▉   - U+2589  Left seven eighths block
+  #
+  ## for unicode block elements see
+  ##   https://en.wikipedia.org/wiki/Block_Elements
+
+  width   = (value*max_width).to_f / max_value   ## 50 = max width same as 100%
+
+  buf = chars[-1] * width.floor
+
+  if chars.size > 1    ## check fractional part?
+     frac = width - width.floor   # e.g.      12.5405405405405406
+                                  #  becomes   0.5405405405405406
+     buf += chars[ (frac*chars.size).floor ]   if frac > 0.0
+  end
+
+  buf
+end
+
+
+def barchart( data, title:,
+                    sort: nil,
+                    n: nil,
+                    max_width: nil,
+                    chars: nil )
+
+  ## note: always convert hash to array
+  ##          example:
+  ##            { 'one': 1,
+  ##              'two': 2 }
+  ##  becomes:  [[ 'one', 1],
+  ##             [ 'two', 2]]
+  data = data.to_a     if data.is_a?( Hash )
+
+  ## convert values to alway be numbers
+  ##   e.g. support hash as value e.g. { count: 2 } becomes just 2
+  data = data.map do |rec|
+                    rec[1] = rec[1][:count]   if rec[1].is_a?( Hash )
+                    rec
+                  end
+
+  if sort
+    data = data.sort_by { |rec| rec[1] }.reverse
+  end
+
+
+
+  sum       = data.reduce( 0 ) { |sum,rec| sum+rec[1] }
+  max_label = data.reduce( 4 ) { |max,rec| rec[0].size > max ? rec[0].size : max }    ## max label length
+
+  n = sum   if n.nil?   ## no n passed in? use (default to) sum
+
+  bar_opts = {  }
+  bar_opts[:max_width] = max_width   if max_width
+  bar_opts[:chars ]    = chars       if chars
+  
+  
+  buf = "#{title}  (n=#{n})\n"
+  buf << "---------------------------------\n"
+  data.each do |rec|
+    label   = rec[0]
+    value   = rec[1]
+
+    percent = value*100 / sum
+
+    buf << "  %-#{max_label}s " % label
+    buf << " (%2d%%)" %  percent     if n == sum  ## only print percent if NOT passed in custom n
+    buf << " | "
+    buf << bar( value, sum, **bar_opts )
+    buf << " %d" % value     if value > 0
+    buf << "\n"
+  end
+
+  buf
+end  # method barchart
+
+
+
+# say hello
+puts Barcharts.banner   if $DEBUG || (defined?($RUBYLIBS_DEBUG) && $RUBYLIBS_DEBUG)

data/lib/barcharts/version.rb

@@ -0,0 +1,22 @@
+
+module Barcharts
+  MAJOR = 0    ## todo: namespace inside version or something - why? why not??
+  MINOR = 1
+  PATCH = 0
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "barcharts/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}]"
+  end
+
+  def self.root
+    "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"
+  end
+end # module Barcharts
+
+
+

data/script/test_readme.rb

@@ -0,0 +1,51 @@
+###
+#  to run use
+#     ruby -I ./lib script/test_readme.rb
+
+
+require 'barcharts'
+
+
+
+data = [
+  ['Australia',     3],
+  ['Austria',       1],
+  ['Canada',        1],
+  ['Croatia',       1],
+  ['India',         1],
+  ['Poland',        2],
+  ['Spain',         1],
+  ['Switzerland',   1],
+  ['Ukraine',       1],
+  ['United States', 6],
+]
+
+puts barchart( data, title: 'Location', chars: '*' )
+
+puts barchart( data, title: 'Location', chars: '▏▎▍▋▊▉' )
+
+
+
+data = [
+  ['Webgen',      1],
+  ['Jekyll',     12],
+  ['WordPress',   3],
+  ['Hugo',        1],
+  ['Ghost',       2],
+  ['Transistor',  1],
+  ['Simplecast',  1],
+  ['?',          30],
+]
+
+puts barchart( data, title: 'Generators', sort: true )
+
+data = [
+  ['rails',       13],
+  ['ruby',        12],
+  ['conferences',  6],
+  ['dry',          5],
+  ['rom',          4],
+  ['ml',           2],
+]
+
+puts barchart( data, title: 'Top Words in Headlines 2020', n: 47)

data/test/helper.rb

@@ -0,0 +1,7 @@
+## minitest setup
+require 'minitest/autorun'
+
+## our own code
+require 'barcharts'
+
+

data/test/test_barchart.rb

@@ -0,0 +1,107 @@
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_barchart.rb
+
+
+require 'helper'
+
+
+class TestBarchart < MiniTest::Test
+
+  def test_array
+    data = [
+     ['two',   2],
+     ['one',   1],
+     ['three', 3],
+     ['five',  5],
+     ['four',  4],
+    ]
+
+
+    assert_equal <<TXT, barchart( data, title: 'Test' )
+Test  (n=15)
+---------------------------------
+  two    (13%) | ▉▉▉▉▉▉▊ 2
+  one    ( 6%) | ▉▉▉▍ 1
+  three  (20%) | ▉▉▉▉▉▉▉▉▉▉ 3
+  five   (33%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▊ 5
+  four   (26%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▍ 4
+TXT
+
+    assert_equal <<TXT, barchart( data, title: 'Test', sort: true )
+Test  (n=15)
+---------------------------------
+  five   (33%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▊ 5
+  four   (26%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▍ 4
+  three  (20%) | ▉▉▉▉▉▉▉▉▉▉ 3
+  two    (13%) | ▉▉▉▉▉▉▊ 2
+  one    ( 6%) | ▉▉▉▍ 1
+TXT
+  end
+
+
+  def test_hash
+data = {
+  'two':   2,
+  'one':   1,
+  'three three': 3,
+  'five':  5,
+  'four':  4,
+}
+
+  assert_equal <<TXT, barchart( data, title: 'Test' )
+Test  (n=15)
+---------------------------------
+  two          (13%) | ▉▉▉▉▉▉▊ 2
+  one          ( 6%) | ▉▉▉▍ 1
+  three three  (20%) | ▉▉▉▉▉▉▉▉▉▉ 3
+  five         (33%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▊ 5
+  four         (26%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▍ 4
+TXT
+
+  assert_equal <<TXT, barchart( data, title: 'Test', sort: true )
+Test  (n=15)
+---------------------------------
+  five         (33%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▊ 5
+  four         (26%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▍ 4
+  three three  (20%) | ▉▉▉▉▉▉▉▉▉▉ 3
+  two          (13%) | ▉▉▉▉▉▉▊ 2
+  one          ( 6%) | ▉▉▉▍ 1
+TXT
+  end
+
+  def test_hash_count
+data = {
+  'two':   { count: 22 },
+  'one':   { count: 1 },
+  'three': { count: 3 },
+  'five':  { count: 55 },
+  'four':  { count: 44 },
+}
+
+  puts barchart( data, title: 'Test' )
+  puts barchart( data, title: 'Test', sort: true )
+
+  assert_equal <<TXT, barchart( data, title: 'Test' )
+Test  (n=125)
+---------------------------------
+  two    (17%) | ▉▉▉▉▉▉▉▉▊ 22
+  one    ( 0%) | ▍ 1
+  three  ( 2%) | ▉▎ 3
+  five   (44%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 55
+  four   (35%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▋ 44
+TXT
+
+  assert_equal <<TXT, barchart( data, title: 'Test', sort: true )
+Test  (n=125)
+---------------------------------
+  five   (44%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉ 55
+  four   (35%) | ▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▉▋ 44
+  two    (17%) | ▉▉▉▉▉▉▉▉▊ 22
+  three  ( 2%) | ▉▎ 3
+  one    ( 0%) | ▍ 1
+TXT
+end
+
+end  # class TestBarchart
+

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: barcharts
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.16'
+description: barcharts - print barcharts in your terminal in ascii or with unicode
+  block elements
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/barcharts.rb
+- lib/barcharts/version.rb
+- script/test_readme.rb
+- test/helper.rb
+- test/test_barchart.rb
+homepage: https://github.com/feedreader/pluto
+licenses:
+- Public Domain
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: barcharts - print barcharts in your terminal in ascii or with unicode block
+  elements
+test_files: []