tabled 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8bff1dfe77f793e213ad96a8b29f0680d8a1f51b47af41384467b8846c87482
-  data.tar.gz: bc34ee68acd27d1525ca10568f32decac36765ba92216992d897f17f1852e40e
+  metadata.gz: 5f87e77f21f054305b5292f4f02f81c3edea126d0049dd94139691881c0fd140
+  data.tar.gz: 2b816ea5e5dd85ef1cd0af90c40970baf8364453c7aab445b54075f732ae604b
 SHA512:
-  metadata.gz: b8d072e93948a3a2f748ef71cc589b9deee8d3ba820c91c421c808335d3e85ef75a82feeb7a1969127c83f263fa872e4a0bc5de0099ab37ae9f01c9f76e1aea1
-  data.tar.gz: 6db4bf05dbcd226a2b575c8420d7835833de07811580a94fd38a907afab82e9ac2eebc82453fbb8c89ce762f4455ed34a42e458e4988696b024a68d082c62635
+  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/Gemfile.lock

@@ -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/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/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.1.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.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Max Rukomoynikov
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-24 00:00:00.000000000 Z
+date: 2024-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -97,10 +97,13 @@ 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
@@ -117,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
@@ -132,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: []