tabled 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adb359bc58e55473ea7dd7cfa6904958d176941ca5b4fb6681a06dc6fd964969
-  data.tar.gz: 9b19a8cb5e626295d74ad3c6c688c4c6f239acc978280903046605f3ee35c9ad
+  metadata.gz: 5f87e77f21f054305b5292f4f02f81c3edea126d0049dd94139691881c0fd140
+  data.tar.gz: 2b816ea5e5dd85ef1cd0af90c40970baf8364453c7aab445b54075f732ae604b
 SHA512:
-  metadata.gz: 1e1b1a24376f259ce913a07887d7e13a2bfb6a2475a28440fde93759b6da479d1d36a98acba8476d1e5ed1844b29dc1192ace0694d5c458f4362ee55e8766cc8
-  data.tar.gz: 675b13f080fb7ed1ce7319028684707b5423096f6a7f355dd96fbba6e69d472f3c320cb6e03d53072234589a67c71aa343868358d841df20fc039ffce9136139
+  metadata.gz: e1092ca10cfe3b9a002c8d3a379cf7ca387cfb422607a5075392eab020d7436b5ed83e2b4d35926da6230277221ca6e7a75d040e665a042d5cc60ce6aa2faf54
+  data.tar.gz: 26104ad19f5a160519acc10479f644881410b4bf92c5f1ded9e470eb62e58f5c96228bc471e55b7495c0b6cd71fc5a9faf6bfb322e2e716ffb4acc8f217d53a3

data/.github/workflows/codemetrics.yml

@@ -2,23 +2,26 @@ name: CodeMetrics report sending
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    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
+          ruby-version: 3.1
           bundler-cache: true
 
-      - run: sh ./sending_report.sh
+      - name: Codemetrics sending report
+        env:
+          CODEMETRICS_TOKEN: ${{ secrets.CODEMETRICS_TOKEN }}
+        uses: Rukomoynikov/codemetrics-gh-action@main

data/.github/workflows/linters.yml

@@ -5,23 +5,22 @@
 # This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
 # For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
 
-name: Ruby
+name: Static analysis
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
 
 permissions:
   contents: read
 
 jobs:
-
   linters:
     strategy:
       matrix:
-        ruby-version: ['3.0']
+        ruby-version: ["3.0"]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
@@ -37,7 +36,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, macos-latest]
-        ruby-version: ['2.7', '3.0', '3.1', '3.2']
+        ruby-version: ["3.0", "3.1", "3.2"]
     steps:
       - uses: actions/checkout@v3
       - name: Set up Ruby

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config --auto-gen-only-exclude`
-# on 2023-09-06 20:39:31 UTC using RuboCop version 1.56.2.
+# on 2023-09-24 10:40:26 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
@@ -57,18 +57,22 @@ RSpec/ExampleLength:
     - 'spec/integration/file_builders/export_json_spec.rb'
     - 'spec/unit/tabled_spec.rb'
 
-# Offense count: 1
-RSpec/MultipleDescribes:
+# Offense count: 2
+# Configuration parameters: Include, CustomTransform, IgnoreMethods, SpecSuffixOnly.
+# Include: **/*_spec*rb*, **/spec/**/*
+RSpec/FilePath:
   Exclude:
-    - 'spec/integration/tabled_spec.rb'
+    - 'spec/integration/print_files/print_csv_spec.rb'
+    - 'spec/integration/print_files/print_json_spec.rb'
 
-# Offense count: 7
-RSpec/RepeatedDescription:
+# Offense count: 4
+# Configuration parameters: Max, AllowedGroups.
+RSpec/NestedGroups:
   Exclude:
-    - 'spec/integration/tabled_spec.rb'
-    - 'spec/unit/tabled_spec.rb'
+    - 'spec/integration/print_files/print_csv_spec.rb'
+    - 'spec/integration/print_files/print_json_spec.rb'
 
-# Offense count: 12
+# Offense count: 13
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
@@ -81,5 +85,14 @@ Style/Documentation:
     - 'lib/file_builders/json_file_builder.rb'
     - 'lib/helpers.rb'
     - 'lib/parsers/csv_parser.rb'
+    - 'lib/parsers/json_parser.rb'
     - 'lib/tabled.rb'
     - 'lib/template.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Max, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Exclude:
+    - 'spec/unit/tabled_spec.rb'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    tabled (0.0.6)
+    tabled (1.1.0)
       dry-cli
 
 GEM
@@ -67,7 +67,11 @@ GEM
     unicode-display_width (2.4.2)
 
 PLATFORMS
+  aarch64-linux
+  arm64-darwin-2
+  arm64-darwin-20
   arm64-darwin-22
+  arm64-darwin-23
   x86_64-darwin-20
   x86_64-linux
 
@@ -79,4 +83,4 @@ DEPENDENCIES
   tabled!
 
 BUNDLED WITH
-   2.3.26
+   2.5.11

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright 2017-2023 Max Rukomoynikov
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,25 +1,46 @@
+# Tabled
 
 [![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) ![Downloads](https://badgen.net/rubygems/dt/tabled)
 
+Tabled is a versatile gem designed for rendering tabular data in a console. It offers various features to make data presentation simple and customizable.
 
-# Description
-Library can be used to render your data to a console. Though it's quite simple, but has many features.
+## Table of Contents
 
-# 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.
+- [Installation](#installation)
+- [Usage](#usage)
+- [Options](#options)
+- [Examples](#examples)
+- [Exporting Data](#exporting-data)
+- [Printing CSV or JSON Files](#printing-csv-or-json-files)
+- [Contributing](#contributing)
 
-### Params for Tabled instance
-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.
-3. `titles` - optional parameter with list of columns titles
+## Installation
+```shell
+bundle add tabled
+# or
+gem install tabled
+```
+
+## Usage
+To use Tabled in your application, follow these steps:
+1. Require the gem in your code:
+   ```ruby
+   require 'tabled'
+   ```
+2. Pass an array of rows to the application. Each row can contain any number of columns and optional footer text.
+
+## Options
+Tabled accepts the following options:
+
+- `framed` (optional, default: true): Specify if the output should have frames.
+- `row_separator` (optional, default: "-"): Set the character for row separators or set it to nil if you don't want to separate rows.
+- `titles` (optional): Provide a list of column titles.
+
+## Examples
+Here are some examples to help you get started:
 
-More examples in [demo.rb](./demo.rb)
+### Simple Data Structure
 
-### Simple data structure
 ```ruby
 data = [
   ["Helena", "20 years", "Female"],
@@ -27,18 +48,11 @@ data = [
   ["Alan", "23 years", "Male"],
 ]
 
-Tabled.new(data, framed: false,
-           row_separator: nil).print_to_console
+Tabled.new(data, framed: false, row_separator: nil).print_to_console
 ```
 
-Result
-```shell
-Helena  20 years  Female
-John    18 years  Male
-Alan    23 years  Male
-```
+### Using Footer Inside a Row
 
-### Using footer inside a row
 ```ruby
 data = [
   ["Helena", "20 years", "Female"],
@@ -49,43 +63,27 @@ data = [
 Tabled.new(data, row_separator: nil).print_to_console
 ```
 
-Result
-```shell
-----------------------------------------------------------------
-| Helena 20 years Female                                       |
-| John   18 years Male                                         |
-| Legendary assassin John Wick (Keanu Reeves).                 |
-| Alan   23 years Male                                         |
-----------------------------------------------------------------
-```
+## Exporting Data
 
-### 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`.
+You can export the data in CSV or JSON formats. By default, the file is saved in the current directory with the file name "tabled.csv" (CSV format).
 
 ```ruby
-# CSV
-data = [
-  ["Helena", "20 years", "Female"],
-]
-
-Tabled
-  .new(data)
-  .export_to_csv
+# Export to CSV
+Tabled.new(data).export_to_file
 
-# JSON
-data = [
-  ["Helena", "20 years", "Female"],
-]
+# Export to JSON
+Tabled.new(data, titles: ['Name', 'Age', 'Gender']).export_to_file(format: :json)
 
-Tabled
-  .new(data, titles: ['Name', 'Age', 'Gender'])
-  .export_to_csv(format: :json)
+# Customize file name
+Tabled.new(data, titles: ['Name', 'Age', 'Gender']).export_to_file(file_name: 'my_file.json')
 ```
 
-# Printing CSV files to console
-As a part of the gem `tabled` binary is included. So, you can basicaly run it like:
+## Printing CSV or JSON Files
+
+As part of the gem, the *tabled* binary is included. You can run it like this:
+
 ```shell
-tabled print path_to_csv_file
+tabled print path_to_[csv|json]_file
 ```
 
 # Contributing
@@ -94,3 +92,7 @@ tabled print path_to_csv_file
 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
+
+# Development process in Docker
+
+Run `docker compose run --build --rm app bash` to get full packed dev environment for the gem developing.

data/bin/tabled

@@ -3,6 +3,7 @@
 
 require_relative '../lib/tabled'
 require_relative '../lib/parsers/csv_parser'
+require_relative '../lib/parsers/json_parser'
 require 'dry/cli'
 require 'pathname'
 
@@ -19,12 +20,34 @@ module TabledCli
         def call(input: nil, **)
           return p 'File must be provided' if input.nil?
           return p 'File doesn\'t exist' unless File.exist?(Pathname.new(input))
+          return p 'Unsupported file format' unless %w[.csv .json].include?(File.extname(Pathname.new(input)).downcase)
 
-          Tabled.new(Tabled::CSVParser.parse(Pathname.new(input))).print_to_console
+          file = Pathname.new(input)
+
+          $stdout << case File.extname(file).downcase
+                     when '.csv'
+                       print_csv(file)
+                     when '.json'
+                       print_json(file)
+                     end
+        end
+
+        def print_csv(input)
+          Tabled
+            .new(Tabled::CSVParser.parse(Pathname.new(input)))
+            .print_to_console
+        end
+
+        def print_json(input)
+          titles, values = Tabled::JSONParser.parse(Pathname.new(input))
+
+          Tabled
+            .new(values, titles: titles)
+            .print_to_console
         end
       end
 
-      register 'print', Print, aliases: ['p', '-p', '--print']
+      register 'print', Print, aliases: %w[p -p --print]
     end
   end
 end

data/docker-compose.yml

@@ -0,0 +1,10 @@
+services:
+  app:
+    build:
+      dockerfile_inline: |
+        FROM ruby:bullseye
+        COPY Gemfile Gemfile.lock tabled.gemspec .
+        RUN bundle install
+    working_dir: /app
+    volumes:
+      - ./:/app

data/lib/errors/format_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+# Custom errors for the gem
+class Tabled::FormatError < StandardError # rubocop:disable Style/ClassAndModuleChildren
+  def initialize(received_format:)
+    @received_format = received_format
+    super
+  end
+
+  def message
+    "Expected to receive CSV but received #{@received_format}"
+  end
+end

data/lib/parsers/csv_parser.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'csv'
+
 class Tabled
   class CSVParser
     def self.parse(file_path)

data/lib/parsers/json_parser.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'json'
+class Tabled
+  class JSONParser
+    def self.parse(file_path)
+      file = File.read(file_path)
+      json_entries = ::JSON.parse(file)
+
+      unless json_entries.is_a?(Array) && json_entries.first.is_a?(Hash)
+        raise ArgumentError, 'Invalid JSON format. Expected an array of objects.'
+      end
+
+      [json_entries.first.keys, json_entries.map(&:values)]
+    end
+  end
+end

data/lib/tabled.rb

@@ -4,6 +4,7 @@ require_relative 'template'
 require_relative 'helpers'
 require_relative 'content_shaper'
 require_relative 'file_builders/base_file_builder'
+require_relative 'errors/format_error'
 
 class Tabled
   include BaseFileBuilder
@@ -21,4 +22,10 @@ class Tabled
   def print_to_console
     print content.join("\n")
   end
+
+  def self.from_csv(csv:, **options)
+    raise Tabled::FormatError.new(received_format: csv.class) unless csv.is_a? CSV::Table
+
+    new(csv.to_a, **options)
+  end
 end

data/tabled.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'tabled'
-  s.version     = '1.0.0'
+  s.version     = '1.2.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']

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tabled
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Max Rukomoynikov
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-06 00:00:00.000000000 Z
+date: 2024-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -97,15 +97,19 @@ files:
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
+- LICENSE.md
 - README.md
 - bin/tabled
 - demo.rb
+- docker-compose.yml
 - lib/content_shaper.rb
+- lib/errors/format_error.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/parsers/json_parser.rb
 - lib/tabled.rb
 - lib/template.rb
 - sending_report.sh
@@ -116,7 +120,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/Rukomoynikov/tabled
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -131,8 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
-signing_key:
+rubygems_version: 3.5.11
+signing_key: 
 specification_version: 4
 summary: Library for rendering pretty tables in console
 test_files: []