Can't name fields using hirb in Ruby

Question

I know my question is pretty simple, but I can't manage to find an answer on the internet.

I have a hash called sorted_frequency. I want to output it as a table using the gem hirb. At the time I just have been able to print the hash under the default field names (0, 1). So it looks like that:

0      1

wordA  ntimes
wordB  mtimes
wordC  rtimes

I'd like to rename the field names so it would be something like this:

words  number of times

wordA  ntimes
wordB  mtimes
wordC  rtimes

My actual code is this:

#needs to install 'docx' and 'hirb' gems

require 'docx'
require 'hirb'
doc = Docx::Document.open('monografia.docx')
text_listed = doc.to_s.downcase.split(" ")
forbidden_list = ["o", "si", "em", "ha", "no", "és", "amb", "i", "/","el", 
"la", "els","les", "l'", "lo", "los", "en", "n'", "na", "es", "ets", "s'", 
"sa", "so", "ses", "sos", "un", "una", "unes", "uns", "a", "que", "s'", 
"al", "de","del", "per", "ens", "als", "com"]

clean_text= text_listed - forbidden_list

frequency = Hash.new 0

clean_text.each { |word| frequency[word] += 1 }

sorted_frequency = Hash[frequency.sort_by{ | word, times | -times }[0..20]]

puts Hirb::Helpers::AutoTable.render(sorted_frequency)

Again, I'm sorry if this a newbie question

EDIT:

As all my code has been asked, I'll explain it. It opens a docx document with the help of a gem called 'docx'. After that, it splits the doc by spaces and creates an array. After that, I remove some words I don't want to count (those included in the forbidden_list). Then I create a hash where the key is the word, and the value is the number of times that word appears in the docx. After that, I sort that hash and output using the gem 'hirb. The problem is I just don't know how to name the fields of the table created. I hope someone can help me.

Answer 1

According to the hirb docs, AutoTable.render() takes an argument which can be an array_of_arrays or an array_of_hashes. But because your hash argument worked, I looked at your table output, and I decided to try to merely add an option to change the column names that you got:

require 'hirb'

freqs = {
  'go' => 3,
  'no' => 4,
  'to' => 1
}

puts Hirb::Helpers::AutoTable.render(
  freqs,
  fields: [1, 0],  #Specify which fields to include in the table and their order. 
                   #For a row that is an array, the field names are the integers 0, 1, 2, etc.
                   #For a row that is a hash, the field names are the keys.
  headers: {0 => 'Word', 1 => 'Frequency'},  #Convert the field names to something more desirable for the column headers
  description: false #Get rid of "3 rows in set" following the table
)


--output:--
+-----------+------+
| Frequency | Word |
+-----------+------+
| 3         | go   |
| 4         | no   |
| 1         | to   |
+-----------+------+

It worked. What must be happening is: AutoTable.render() expects an array--either an array_of_arrays or an array_of_hashes--and if the method doesn't get an array as an argument, it calls to_a() on the argument. Take a look at what happens to your hash:

~/ruby_programs$ irb
2.4.0 :001 > freqs = {'go' => 3, 'no' => 4, 'to' => 1}
 => {"go"=>3, "no"=>4, "to"=>1} 

2.4.0 :002 > freqs.to_a
 => [["go", 3], ["no", 4], ["to", 1]] 

There's the array_of_arrays that AutoTable.render() needs. Rearranging a little, the array_of_arrays looks like this:

index 0  index 1
     |    |
[    V    V
   ["go", 3],  #row array
   ["no", 4], 
   ["to", 1]
] 

For an array_of_arrays, the column headers in the table are the index positions in each row array. The options for AutoTable.render() let you specify which columns/index positions to include in the table and their order, and the options allow you to convert the column headers to something more desirable.

Here's a more general example:

require 'hirb'
require 'pp'

data = [
  ['go', 1, '1/12/18'],
  ['to', 4, '1/24/18'],
  ['at', 2, '1/28/18']
]

puts Hirb::Helpers::AutoTable.render(
  data,
  fields: [2, 0],  #Specify the index positions in each row array to include in the table and their column order in the table
  headers: {0 => 'Word', 2 => 'Date'},  #Convert the column headers to something more desirable
  description: false #Get rid of "3 rows in set" following the table
)

--output:--
+---------+------+
| Date    | Word |
+---------+------+
| 1/12/18 | go   |
| 1/24/18 | to   |
| 1/28/18 | at   |
+---------+------+

====

require 'hirb'
require 'pp'

freqs = {
  'go' => 3,
  'no' => 4,
  'to' => 1
}

col_names = %w[word count]

new_freqs = freqs.map do |key, val| 
  {col_names[0] => key, col_names[1] => val}
end

pp new_freqs

puts Hirb::Helpers::AutoTable.render(
  new_freqs, 
  fields: ['word', 'count'],  #Specify which keys to include in table and their column order.
  headers: {'word' => 'Good Word', 'count' => 'Frequency'},  #Convert keys to more desirable headers.
  description: false #Get rid of "3 rows in set" following the table
)

--output:--
[{"word"=>"go", "count"=>3},
 {"word"=>"no", "count"=>4},
 {"word"=>"to", "count"=>1}]
+-----------+-----------+
| Good Word | Frequency |
+-----------+-----------+
| go        | 3         |
| no        | 4         |
| to        | 1         |
+-----------+-----------+

====

require 'hirb'
require 'pp'

freqs = {
  'go' => 3,
  'no' => 4,
  'to' => 1
}

col_names = %i[word count]

new_freqs = freqs.map do |key, val| 
  {col_names[0] => key, col_names[1] => val}
end

pp new_freqs
puts Hirb::Helpers::AutoTable.render(new_freqs)

--output:--
[{:word=>"go", :count=>3}, {:word=>"no", :count=>4}, {:word=>"to", :count=>1}]
+-------+------+
| count | word |
+-------+------+
| 3     | go   |
| 4     | no   |
| 1     | to   |
+-------+------+
3 rows in set

===

require 'hirb'
require 'pp'

data = {
  'first' => 'second', 
  'third' => 'fourth', 
  'fifth' => 'sixth'
}

col_names = %i[field1 field2]

new_data = data.map do |key, val| 
  {col_names[0] => key, col_names[1] => val}
end

pp new_data
puts Hirb::Helpers::AutoTable.render(new_data)

--output:--
[{:field1=>"first", :field2=>"second"},
 {:field1=>"third", :field2=>"fourth"},
 {:field1=>"fifth", :field2=>"sixth"}]
+--------+--------+
| field1 | field2 |
+--------+--------+
| first  | second |
| third  | fourth |
| fifth  | sixth  |
+--------+--------+
3 rows in set

=====

require 'hirb'

data = [
  {field1: 'first', field2: 'second'},
  {field1: 'third', field2: 'fourth'},
  {field1: 'fifth', field2: 'sixth'}
]

puts Hirb::Helpers::AutoTable.render(data)

--output:--
+--------+--------+
| field1 | field2 |
+--------+--------+
| first  | second |
| third  | fourth |
| fifth  | sixth  |
+--------+--------+
3 rows in set