tabled 0.0.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6975cba3c924564332a058b0780101a7e469e25ca6143d9743bd19ea3e45c0c5
-  data.tar.gz: d3de8444e683807a3490f2c7fa34e5c0c3538054923036d2981659074e0bc31e
+  metadata.gz: adb359bc58e55473ea7dd7cfa6904958d176941ca5b4fb6681a06dc6fd964969
+  data.tar.gz: 9b19a8cb5e626295d74ad3c6c688c4c6f239acc978280903046605f3ee35c9ad
 SHA512:
-  metadata.gz: d161770b55f054132a064529a4eb4d420fb9172b8ccff788cba15b337f4110c22adde0ea2a26d36d05bacf99795de62a1e77bebf9b75919868cb04c77f83c194
-  data.tar.gz: 2481ed7691562b8f78a17a8cfa5de798787a76385f64d55d545574639a514af4e5ba7ee040893ea3a3b721f57547d2b9b196efec4c044f4edbe61a11672c0371
+  metadata.gz: 1e1b1a24376f259ce913a07887d7e13a2bfb6a2475a28440fde93759b6da479d1d36a98acba8476d1e5ed1844b29dc1192ace0694d5c458f4362ee55e8766cc8
+  data.tar.gz: 675b13f080fb7ed1ce7319028684707b5423096f6a7f355dd96fbba6e69d472f3c320cb6e03d53072234589a67c71aa343868358d841df20fc039ffce9136139

data/.github/workflows/codemetrics.yml

@@ -0,0 +1,24 @@
+name: CodeMetrics report sending
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+
+jobs:
+
+  report_sending:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0
+          bundler-cache: true
+
+      - run: sh ./sending_report.sh

data/.github/workflows/linters.yml

@@ -30,13 +30,14 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby-version }}
           bundler-cache: true
+      - run: bundle exec rubocop
 
   test:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
     steps:
       - uses: actions/checkout@v3
       - name: Set up Ruby

data/.gitignore

@@ -1,4 +1,5 @@
 .byebug_history
 coverage
 .idea
-*.gem
+*.gem
+.DS_Store

data/.rubocop_todo.yml

@@ -1,42 +1,42 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2022-06-24 15:05:43 UTC using RuboCop version 1.29.1.
+# on 2023-09-06 20:39:31 UTC using RuboCop version 1.56.2.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 4
+# Configuration parameters: EnforcedStyle, AllowedGems, Include.
+# SupportedStyles: Gemfile, gems.rb, gemspec
+# Include: **/*.gemspec, **/Gemfile, **/gems.rb
+Gemspec/DevelopmentDependencies:
+  Exclude:
+    - 'tabled.gemspec'
+
 # Offense count: 1
-# Configuration parameters: Include.
+# Configuration parameters: Severity, Include.
 # Include: **/*.gemspec
 Gemspec/RequiredRubyVersion:
   Exclude:
     - 'tabled.gemspec'
 
-# Offense count: 3
-# Configuration parameters: IgnoredMethods, CountRepeatedAttributes, Max.
+# Offense count: 4
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
     - 'lib/content_shaper.rb'
+    - 'lib/file_builders/csv_file_builder.rb'
     - 'lib/helpers.rb'
 
-# Offense count: 3
-# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
-# IgnoredMethods: refine
-Metrics/BlockLength:
-  Exclude:
-    - '**/*.gemspec'
-    - 'spec/framed/tabled_spec.rb'
-    - 'spec/non_framed/tabled_spec.rb'
-
 # Offense count: 1
-# Configuration parameters: IgnoredMethods, Max.
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/CyclomaticComplexity:
   Exclude:
     - 'lib/helpers.rb'
 
 # Offense count: 5
-# Configuration parameters: CountComments, Max, CountAsOne, ExcludedMethods, IgnoredMethods.
+# Configuration parameters: CountComments, Max, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Exclude:
     - 'lib/content_shaper.rb'
@@ -44,18 +44,31 @@ Metrics/MethodLength:
     - 'spec/factories/factory_data.rb'
 
 # Offense count: 1
-# Configuration parameters: IgnoredMethods, Max.
+# Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
   Exclude:
     - 'lib/helpers.rb'
 
-# Offense count: 1
+# Offense count: 4
 # Configuration parameters: Max, CountAsOne.
 RSpec/ExampleLength:
   Exclude:
-    - 'spec/framed/tabled_spec.rb'
+    - 'spec/integration/file_builders/export_csv_spec.rb'
+    - 'spec/integration/file_builders/export_json_spec.rb'
+    - 'spec/unit/tabled_spec.rb'
+
+# Offense count: 1
+RSpec/MultipleDescribes:
+  Exclude:
+    - 'spec/integration/tabled_spec.rb'
+
+# Offense count: 7
+RSpec/RepeatedDescription:
+  Exclude:
+    - 'spec/integration/tabled_spec.rb'
+    - 'spec/unit/tabled_spec.rb'
 
-# Offense count: 9
+# Offense count: 12
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
@@ -63,6 +76,9 @@ Style/Documentation:
     - 'test/**/*'
     - 'bin/tabled'
     - 'lib/content_shaper.rb'
+    - 'lib/file_builders/base_file_builder.rb'
+    - 'lib/file_builders/csv_file_builder.rb'
+    - 'lib/file_builders/json_file_builder.rb'
     - 'lib/helpers.rb'
     - 'lib/parsers/csv_parser.rb'
     - 'lib/tabled.rb'

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+### Version 0.0.6 (September 05, 2023)
+1. Tabled now can export data into CSV and JSON files
+
 ### Version 0.0.5 (September 04, 2023)
 1. (Bug fix) Unnecessary dev gem reference removed
 

data/Gemfile.lock

@@ -1,59 +1,75 @@
 PATH
   remote: .
   specs:
-    tabled (0.0.5)
+    tabled (0.0.6)
       dry-cli
 
 GEM
   remote: http://rubygems.org/
   specs:
     ast (2.4.2)
+    base64 (0.1.1)
     diff-lcs (1.5.0)
     docile (1.4.0)
     dry-cli (1.0.0)
-    parallel (1.22.1)
-    parser (3.1.2.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
     rainbow (3.1.1)
-    regexp_parser (2.4.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.29.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.2)
+      base64 (~> 0.1.1)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.17.0, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.18.0)
-      parser (>= 3.1.1.0)
-    rubocop-rspec (2.10.0)
-      rubocop (~> 1.19)
-    ruby-progressbar (1.11.0)
-    simplecov (0.21.2)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-rspec (2.23.2)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.4.2)
 
 PLATFORMS
-  ruby
+  arm64-darwin-22
+  x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   rspec

data/README.md

@@ -3,7 +3,7 @@
 
 
 # Description
-Library can be used to render your data to a console. Though it's quite simple, but has many features. 
+Library can be used to render your data to a console. Though it's quite simple, but has many features.
 
 # How to use
 1. Install the gem `bundle add tabled` or `gem install tabled`
@@ -11,7 +11,7 @@ Library can be used to render your data to a console. Though it's quite simple,
 3. Pass to the application array of rows. Each row may have any amount of columns and optional footer text.
 
 ### Params for Tabled instance
-Tabled accepts two params. Data which is prohibited and options.   
+Tabled accepts two params. Data which is prohibited and options.
 Available options:
 1. `framed` - optional, default is true
 2. `row_separator` - optional, default is `-`. Can be `nil` if you don't need separate rows.
@@ -27,7 +27,7 @@ data = [
   ["Alan", "23 years", "Male"],
 ]
 
-Tabled.new(data, framed: false, 
+Tabled.new(data, framed: false,
            row_separator: nil).print_to_console
 ```
 
@@ -59,6 +59,29 @@ Result
 ----------------------------------------------------------------
 ```
 
+### Export data to CSV or JSON file
+Passed data can be exported as a file. Available formats are `csv` and `json`. Both parameters are optional. By default, file will be saved in the current directory and with file name `tabled.csv` and file format is `CSV`.
+
+```ruby
+# CSV
+data = [
+  ["Helena", "20 years", "Female"],
+]
+
+Tabled
+  .new(data)
+  .export_to_csv
+
+# JSON
+data = [
+  ["Helena", "20 years", "Female"],
+]
+
+Tabled
+  .new(data, titles: ['Name', 'Age', 'Gender'])
+  .export_to_csv(format: :json)
+```
+
 # Printing CSV files to console
 As a part of the gem `tabled` binary is included. So, you can basicaly run it like:
 ```shell

data/demo.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_relative './lib/tabled'
+require_relative 'lib/tabled'
 
 STAR_WARS_CHARACTERS = [
   {

data/lib/file_builders/base_file_builder.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'csv_file_builder'
+require_relative 'json_file_builder'
+
+module BaseFileBuilder
+  def export_to_file(file_name: 'tabled.csv', format: :csv)
+    case format
+    when :csv
+      FileBuilders::CSVFileBuilder.new(data, file_name, options).export_to_file
+    when :json
+      FileBuilders::JSONFileBuilder.new(data, file_name, options).export_to_file
+    else
+      raise 'Not implemented yet'
+    end
+  end
+end

data/lib/file_builders/csv_file_builder.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module FileBuilders
+  class CSVFileBuilder
+    attr_reader :data, :file_name, :options
+
+    def initialize(data, file_name, options)
+      @data = data
+      @file_name = file_name
+      @options = options
+    end
+
+    def export_to_file
+      titles_row = (options[:titles].join(';').concat(';').concat("\n") if options[:titles].size.positive?)
+
+      data_without_options = data.map { |row| row[0...-1] }
+      csv_data = data_without_options.map { |row| row.join(';').concat(';') }.join("\n")
+
+      File.open(file_name, 'a') do |file|
+        file << titles_row
+        file << csv_data
+      end
+    end
+  end
+end

data/lib/file_builders/json_file_builder.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module FileBuilders
+  class JSONFileBuilder
+    attr_reader :data, :file_name, :options, :titles
+
+    def initialize(data, file_name, options)
+      @data = data
+      @file_name = file_name
+      @options = options
+      @titles = options[:titles]
+    end
+
+    def export_to_file
+      return puts 'For JSON format titles are required' if titles.empty?
+
+      json_data = data.inject([]) do |result, row|
+        result << titles.zip(row).to_h
+      end
+
+      File.open(file_name, 'a') do |file|
+        file << JSON.pretty_generate(json_data)
+      end
+    end
+  end
+end

data/lib/helpers.rb

@@ -9,15 +9,16 @@ class Tabled
       data.each do |row|
         # [0..-2] Due to reason last item is always hash with row params
         row[0..-2].each_with_index do |column, index|
-          columns_width[index] = column.to_s.size if column.to_s.size > (columns_width[index] || 0)
+          column_size = column.to_s.gsub(/\e\[[0-9;]*m/, '').size
+          columns_width[index] = column_size if column_size > (columns_width[index] || 0)
         end
       end
 
       # If titles longer than data use titles column width
       columns_width.each_with_index do |_column_size, index|
-        title_size = options[:titles].fetch(index, '').size
+        title_size = options[:titles].fetch(index, '').gsub(/\e\[[0-9;]*m/, '').size
 
-        columns_width[index] = title_size > columns_width[index] ? title_size : columns_width[index]
+        columns_width[index] = [title_size, columns_width[index]].max
       end
 
       # Add 1 space in the end of each column
@@ -28,7 +29,7 @@ class Tabled
       # Add to the last column footer spaces if needed
       longest_footer_size = # longest footers
         data.map do |row|
-          row.last.fetch(:footer, '')
+          row.last.fetch(:footer, '').gsub(/\e\[[0-9;]*m/, '')
         end.max.to_s.size + 1
       last_col_spaces = longest_footer_size - columns_width.sum # spaces required to the end
       columns_width[-1] = columns_width.last + last_col_spaces if last_col_spaces.positive?

data/lib/tabled.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
-require_relative './template'
-require_relative './helpers'
-require_relative './content_shaper'
+require_relative 'template'
+require_relative 'helpers'
+require_relative 'content_shaper'
+require_relative 'file_builders/base_file_builder'
 
 class Tabled
+  include BaseFileBuilder
+
   DEFAULT_OPTIONS = { framed: true, row_separator: '-', titles: [] }.freeze
-  attr_accessor :data, :columns_width, :content, :options
+  attr_accessor :data, :data_without_options, :columns_width, :content, :options
 
   def initialize(data, **options)
     @options = DEFAULT_OPTIONS.merge(options)

data/lib/template.rb

@@ -6,7 +6,7 @@ class Tabled
       # | Luke Skywalker     172    male   |
       def self.render(row, columns_width, _is_framed)
         row[0..-2].map.with_index do |column, index|
-          spaces = ' ' * (columns_width[index] - column.to_s.size)
+          spaces = ' ' * (columns_width[index] - column.to_s.gsub(/\e\[[0-9;]*m/, '').size)
           column.to_s + spaces
         end.join
       end
@@ -29,7 +29,7 @@ class Tabled
         return nil unless row.last.fetch(:footer, false)
 
         footer = row.last.fetch(:footer)
-        required_spaces = columns_width.sum - footer.size
+        required_spaces = columns_width.sum - footer.gsub(/\e\[[0-9;]*m/, '').size
         footer + (' ' * required_spaces)
       end
     end

data/sending_report.sh

@@ -0,0 +1,9 @@
+rm .rubocop.yml
+
+bundle exec rubocop -f json -o rubocop-report.json
+
+curl --location 'https://codemetrics.dev/reports' \
+--form 'report=@"./rubocop-report.json"' \
+--form 'tool="rubocop"' \
+--form 'token="SFMyNTY.g2gDYQduBgCX0w9migFiAAFRgA.w0a9y7VQGzfLkr2G1Cxxwm7m9uTcl99c24dh3zpKrl0"' \
+--form 'branch="'"$GITHUB_HEAD_REF"'"'

data/tabled.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'tabled'
-  s.version     = '0.0.5'
+  s.version     = '1.0.0'
   s.summary     = 'Library for rendering pretty tables in console'
   s.description = 'Library can be used to render your data to a console. Being quite simple it has many features.'
   s.authors     = ['Max Rukomoynikov']
@@ -17,8 +17,7 @@ Gem::Specification.new do |s|
                     'rubygems_mfa_required' => 'true' }
   s.license = 'MIT'
 
-  s.add_dependency 'dry-cli'
-
+  s.add_dependency 'dry-cli' # For CLI ap
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'rubocop-rspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabled
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Max Rukomoynikov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-05 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -88,6 +88,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/codemetrics.yml"
 - ".github/workflows/linters.yml"
 - ".gitignore"
 - ".rspec"
@@ -100,10 +101,14 @@ files:
 - bin/tabled
 - demo.rb
 - lib/content_shaper.rb
+- lib/file_builders/base_file_builder.rb
+- lib/file_builders/csv_file_builder.rb
+- lib/file_builders/json_file_builder.rb
 - lib/helpers.rb
 - lib/parsers/csv_parser.rb
 - lib/tabled.rb
 - lib/template.rb
+- sending_report.sh
 - tabled.gemspec
 homepage: https://rubygems.org/gems/tabled
 licenses: