tabled 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9ad158738f50082bbcc59da4ab6e84e6d1d3a336bd4168623c72a037144df34
-  data.tar.gz: 679b46c1e778597edcb871484106aaeaccc70a8153ad75749f8116eae563adbe
+  metadata.gz: a9bea1975c1f4f3cf411a90414b7497ac7a580dd0138ff42cf47f1019c42b21e
+  data.tar.gz: 6b623b51a521cc9c1e6459420dce36080cfc0382269e4dddf5cd7849a0d55f73
 SHA512:
-  metadata.gz: cc7dc1ee13cd9f4085ada67db778e79153f4bec054501d745694644155186fff9a46335120f384c796c42d55cf69d641d358865a74c7fd7edbc86835b67dfed6
-  data.tar.gz: 5eda9d7584f0bd89813ff666f840d281e56fd1f5cc2617eedf8b7366da258b830a3774752b74ccbdb87921fb35e5a70a0651736f4c45c1287af5055c428d0193
+  metadata.gz: 68fb74f92e12cb02a9b3c565e67fe482d4ee667bfeae7a9864c0ae2a9317ca0834a77edfe6f6757a83a9a14ae87b7f49703e43f314460954a064d2e8c56ce19b
+  data.tar.gz: 59f967d55a04ef8695b3cfbbbcf06333c0c71a93644a260ffc94259152355e169cfb8d23ef6150ee258617837379ff8811c224b3184aabde920fc142035f6fe2

data/.rspec

@@ -0,0 +1 @@
+--format documentation

data/README.md

@@ -0,0 +1,56 @@
+[![Gem Version](https://badge.fury.io/rb/tabled.svg)](https://badge.fury.io/rb/tabled) ![CI is pasing for ruby 2.6 - 3.0](https://github.com/rukomoynikov/tabled/actions/workflows/linters.yml/badge.svg)
+
+
+# Description
+This library can be used to render your data to a console. It's quite simple and has many features
+
+# How to use
+1. Install the gem `bundle add tabled` or `gem install tabled`
+2. Add to the application `require 'tabled''`
+3. Pass to the application array of rows. Each row may have any amount of columns and optional footer text.
+
+### Simple data structure
+```ruby
+data = [
+  ["Helena", "20 years", "Female"],
+  ["John", "18 years", "Male"],
+  ["Alan", "23 years", "Male"],
+]
+
+Tabled.new(data).print_to_console
+```
+
+Result
+```shell
+Helena  20 years  Female
+John    18 years  Male
+Alan    23 years  Male
+```
+
+### Using footer inside a row
+```ruby
+data = [
+  ["Helena", "20 years", "Female"],
+  ["John", "18 years", "Male", { footer: "Legendary assassin John Wick (Keanu Reeves) retired from his violent career after marrying the love of his life." }],
+  ["Alan", "23 years", "Male"],
+]
+
+Tabled.new(data).print_to_console
+```
+
+Result
+```shell
+Helena  20 years  Female
+
+John    18 years  Male
+Legendary assassin John Wick.
+
+Alan    23 years  Male
+```
+
+# Contributing
+1. Fork it ( http://github.com/rodhilton/console_table/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request

data/demo.rb

@@ -0,0 +1,130 @@
+require_relative './lib/tabled'
+
+STAR_WARS_CHARACTERS = [
+  {
+    "name": "Luke Skywalker",
+    "height": "172",
+    "mass": "77",
+    "hair_color": "blond",
+    "skin_color": "fair",
+    "eye_color": "blue",
+    "birth_year": "19BBY",
+    "gender": "male",
+  },
+  {
+    "name": "C-3PO",
+    "height": "167",
+    "mass": "75",
+    "hair_color": "n/a",
+    "skin_color": "gold",
+    "eye_color": "yellow",
+    "birth_year": "112BBY",
+    "gender": "n/a",
+  },
+  {
+    "name": "R2-D2",
+    "height": "96",
+    "mass": "32",
+    "hair_color": "n/a",
+    "skin_color": "white, blue",
+    "eye_color": "red",
+    "birth_year": "33BBY",
+    "gender": "n/a",
+  },
+  {
+    "name": "Darth Vader",
+    "height": "202",
+    "mass": "136",
+    "hair_color": "none",
+    "skin_color": "white",
+    "eye_color": "yellow",
+    "birth_year": "41.9BBY",
+    "gender": "male",
+  },
+  {
+    "name": "Leia Organa",
+    "height": "150",
+    "mass": "49",
+    "hair_color": "brown",
+    "skin_color": "light",
+    "eye_color": "brown",
+    "birth_year": "19BBY",
+    "gender": "female",
+  },
+  {
+    "name": "Owen Lars",
+    "height": "178",
+    "mass": "120",
+    "hair_color": "brown, grey",
+    "skin_color": "light",
+    "eye_color": "blue",
+    "birth_year": "52BBY",
+    "gender": "male",
+  },
+  {
+    "name": "Beru Whitesun lars",
+    "height": "165",
+    "mass": "75",
+    "hair_color": "brown",
+    "skin_color": "light",
+    "eye_color": "blue",
+    "birth_year": "47BBY",
+    "gender": "female",
+  },
+  {
+    "name": "R5-D4",
+    "height": "97",
+    "mass": "32",
+    "hair_color": "n/a",
+    "skin_color": "white, red",
+    "eye_color": "red",
+    "birth_year": "unknown",
+    "gender": "n/a",
+  },
+  {
+    "name": "Biggs Darklighter",
+    "height": "183",
+    "mass": "84",
+    "hair_color": "black",
+    "skin_color": "light",
+    "eye_color": "brown",
+    "birth_year": "24BBY",
+    "gender": "male",
+  },
+  {
+    "name": "Obi-Wan Kenobi",
+    "height": "182",
+    "mass": "77",
+    "hair_color": "auburn, white",
+    "skin_color": "fair",
+    "eye_color": "blue-gray",
+    "birth_year": "57BBY",
+    "gender": "male",
+  }
+]
+
+print "Printing without any params: \n"
+
+data = STAR_WARS_CHARACTERS.map { |character|
+  [character[:name], character[:height], character[:gender]]
+}
+
+Tabled.new(data).print_to_console
+
+print "\n\n############################\n\n"
+print "Printing without frame: \n"
+
+data = STAR_WARS_CHARACTERS.map { |character|
+  [character[:name], character[:height], character[:gender]]
+}
+
+Tabled.new(data, framed: false).print_to_console
+
+print "\n\n############################\n\n"
+print "Printing without frame: and row separator\n"
+
+data = STAR_WARS_CHARACTERS.map { |character|
+  [character[:name], character[:height], character[:gender]]
+}
+
+Tabled.new(data, framed: false, row_separator: nil).print_to_console

data/lib/content_shaper.rb

@@ -0,0 +1,68 @@
+class Tabled
+  class ContentShaper
+    attr_accessor :data, :options, :columns_width
+
+    def initialize(data, columns_width, options)
+      @data = data
+      @columns_width = columns_width
+      @options = options
+    end
+
+    def shape
+      content =
+        data
+          .inject([]) { |enumerator, row|
+            enumerator << Tabled::Template::Row.render(row, columns_width, options[:framed])
+            enumerator << Tabled::Template::RowFooter.render(row, columns_width, options[:framed])
+
+            #  Row separator
+            unless options[:row_separator].nil?
+              enumerator << options[:row_separator].to_s * row_length
+            end
+
+            enumerator
+          }
+          .compact
+
+      content = add_left_and_right_borders(content)
+      content = add_top_bottom_borders(content)
+
+      content
+    end
+
+    private
+
+    def row_length
+      @row_length ||= columns_width.sum
+    end
+
+    def add_left_and_right_borders(content)
+      content.inject([]) { |enumerator, row|
+        # For a row separator all symbols are the same
+        row_is_separator = row.split('').uniq.size == 1
+        if row_is_separator && !options[:row_separator].nil?
+          enumerator << (options[:row_separator] * 2) + row + options[:row_separator]
+        elsif !options[:framed]
+          enumerator << row
+        else
+          enumerator << ('| ' if options[:framed]) + row + ('|' if options[:framed])
+        end
+
+        enumerator
+      }
+    end
+
+    def add_top_bottom_borders(content)
+      #  Top and bottom borders
+      if options[:framed]
+        [
+          '-' * (row_length + 3),
+          options[:row_separator] ? content[0..-2] : content,
+          '-' * (row_length + 3)
+        ].flatten
+      else
+        content
+      end
+    end
+  end
+end

data/lib/helpers.rb

@@ -0,0 +1,31 @@
+class Tabled
+  class Helpers
+    # Calculates columns size
+    def self.calculate_columns_width(data)
+      columns_width = []
+
+      data.each do |row|
+        row_without_params = row[0..-2]
+        row_without_params.each_with_index { |column, index|
+          is_column_last = row_without_params.count == index + 1
+          if is_column_last
+            possible_new_value = [row.last.fetch(:footer, '').to_s.size, column.to_s.size].sort.last
+            columns_width[index] = possible_new_value if possible_new_value > (columns_width[index] || 0)
+          else
+            columns_width[index] = column.to_s.size if column.to_s.size > (columns_width[index] || 0)
+          end
+        }
+      end
+
+      columns_width.map { |column_width| column_width + 1 }
+    end
+
+    # Add hash as a last element of the row
+    def self.convert_to_required_structure(data)
+      data.map { |row|
+        row << {} unless row.last.is_a?(Hash)
+        row
+      }
+    end
+  end
+end

data/lib/tabled.rb

@@ -1,55 +1,21 @@
 require 'byebug'
-require 'template'
+require_relative './template'
+require_relative './helpers'
+require_relative './content_shaper'
 
 class Tabled
-  DEFAULT_OPTIONS = { borders: false }
+  DEFAULT_OPTIONS = { framed: true, row_separator: '-' }
   attr_accessor :data, :columns_width, :content, :options
 
   def initialize(data, **options)
     @options = DEFAULT_OPTIONS.merge(options)
-    @data = data
-    @columns_width = []
-
-    convert_to_required_structure
-    calculate_columns_width
-    prepare_content
+    @data = Tabled::Helpers.convert_to_required_structure(data)
+    @columns_width = Tabled::Helpers.calculate_columns_width(data)
+    @content = Tabled::ContentShaper.new(data, @columns_width, @options).shape()
   end
 
 
   def print_to_console
     print content.join("\n")
   end
-
-  private
-
-  def convert_to_required_structure
-    self.data = data.map { |row|
-      row << {} unless row.last.is_a?(Hash)
-      row
-    }
-  end
-
-  def calculate_columns_width
-    data.each do |row|
-      row_without_params = row[0..-2]
-      row_without_params.each_with_index { |column, index|
-        is_column_last = row_without_params.count == index + 1
-        if is_column_last
-          possible_new_value = [row.last.fetch(:footer, '').to_s.size, column.to_s.size].sort.last
-          self.columns_width[index] = possible_new_value if possible_new_value > (self.columns_width[index] || 0)
-        else
-          self.columns_width[index] = column.to_s.size if column.to_s.size > (self.columns_width[index] || 0)
-        end
-      }
-    end
-
-    self.columns_width = columns_width.map { |column_width| column_width + 1 }
-  end
-
-  def prepare_content
-    self.content = data.inject([]) { |enumerator, row|
-      enumerator << Tabled::Template::Row.render(row, columns_width, options)
-      enumerator << Tabled::Template::RowFooter.render(row)
-    }.compact
-  end
 end

data/lib/template.rb

@@ -1,23 +1,21 @@
 class Tabled
   class Template
     class Row
-      def self.render(row, columns_width, options)
+      def self.render(row, columns_width, is_framed)
         row[0..-2].map.with_index { |column, index|
           spaces = ' ' * (columns_width[index] - column.to_s.size)
           column.to_s + spaces
         }.join('')
       end
     end
-  end
-end
 
-class Tabled
-  class Template
     class RowFooter
-      def self.render(row)
+      def self.render(row, columns_width, is_framed)
         return nil unless row.last.fetch(:footer, false)
 
-        row.last.fetch(:footer)
+        footer = row.last.fetch(:footer)
+        required_spaces = columns_width.sum() - footer.size
+        footer + (' ' * required_spaces)
       end
     end
   end

data/tabled.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'tabled'
-  s.version     = '0.0.1'
+  s.version     = '0.0.2'
   s.summary     = "Library for rendering pretty tables in console"
   s.description = "This library can be used to render your data to a console. It's quite simple and has many features"
   s.authors     = ["Max Rukomoynikov"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabled
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Max Rukomoynikov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-11 00:00:00.000000000 Z
+date: 2022-05-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: byebug
@@ -61,8 +61,13 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/linters.yml"
 - ".gitignore"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
+- README.md
+- demo.rb
+- lib/content_shaper.rb
+- lib/helpers.rb
 - lib/tabled.rb
 - lib/template.rb
 - tabled.gemspec