cli-format 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d8aac542c4c1f36ffb6df02868633539c1a3f3fc7f5bf5c1d42cd22eb8925a20
+  data.tar.gz: bf568ed13e7f0e3e6ffdf6331f6983236ec1fe1a8cb963a3fef4b65a1a16b6a6
+SHA512:
+  metadata.gz: 25570ef38bfef3dc4ae4d91cb14b79173c37e8da0b444a69b3c1ebc36d2ef2285e976c7e96faddac074474fef84633f8c6953d427384087bbcac84807e217a67
+  data.tar.gz: e0623dd69a6f1bf1c7a988ed4d5cff25cecdbf83c5dfece00ee0680659443205d34805eef6236432c129ea69668538083d135ae5c6b1667229f2901b8f6e0608

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.6
+before_install: gem install bundler -v 2.0.2

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cli_format.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    cli-format (0.1.0)
+      activesupport
+      text-table
+      zeitwerk
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    rake (10.5.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    text-table (1.2.4)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  cli-format!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Tung Nguyen
+
+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

@@ -0,0 +1,94 @@
+# cli-format
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cli-format'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+```ruby
+require "cli-format"
+
+options = {header: true, format: "table"}
+header = ["Name", "Food", "Color"]
+data = [
+  ["Tung", "Apple", "Yellow"],
+  ["Bob", "Pear", "Blue"],
+]
+
+presenter = CliFormat::Presenter.new(options)
+presenter.header = header
+data.each do |row|
+  presenter.rows << row
+end
+presenter.show
+```
+
+Format table shows:
+
+    +------+-------+--------+
+    | Name | Food  | Color  |
+    +------+-------+--------+
+    | Tung | Apple | Yellow |
+    | Bob  | Pear  | Blue   |
+    +------+-------+--------+
+
+Format csv shows:
+
+    Name,Food,Color
+    Tung,Apple,Yellow
+    Bob,Pear,Blue
+
+Format json shows:
+
+```json
+{
+  "header": [
+    "Name",
+    "Food",
+    "Color"
+  ],
+  "data": [
+    [
+      "Tung",
+      "Apple",
+      "Yellow"
+    ],
+    [
+      "Bob",
+      "Pear",
+      "Blue"
+    ]
+  ]
+}
+```
+
+## Text
+
+If you would like to grab just the text and not it shown, use the `text` method.
+
+```ruby
+presenter.text
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/cli_format.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cli_format"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cli-format.gemspec

@@ -0,0 +1,33 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cli_format/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cli-format"
+  spec.version       = CliFormat::VERSION
+  spec.authors       = ["Tung Nguyen"]
+  spec.email         = ["tongueroo@gmail.com"]
+
+  spec.summary       = "Format cli output in different ways: tab, table, csv, json, etc"
+  spec.homepage      = "https://github.com/tongueroo/cli-format"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "text-table"
+  spec.add_dependency "zeitwerk"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/cli-format.rb

@@ -0,0 +1 @@
+require_relative "cli_format"

data/lib/cli_format.rb

@@ -0,0 +1,13 @@
+require "active_support/core_ext/string"
+require "cli_format/version"
+require "cli_format/autoloader"
+CliFormat::Autoloader.setup
+
+module CliFormat
+  class Error < StandardError; end
+  # Your code goes here...
+
+  def self.formats
+    %w[csv table tab json]
+  end
+end

data/lib/cli_format/autoloader.rb

@@ -0,0 +1,22 @@
+require "zeitwerk"
+
+module CliFormat
+  class Autoloader
+    class Inflector < Zeitwerk::Inflector
+      def camelize(basename, _abspath)
+        map = { cli: "CLI", version: "VERSION" }
+        map[basename.to_sym] || super
+      end
+    end
+
+    class << self
+      def setup
+        loader = Zeitwerk::Loader.new
+        loader.inflector = Inflector.new
+        loader.push_dir(File.dirname(__dir__)) # lib
+        loader.ignore("#{File.dirname(__dir__)}/cli-format.rb")
+        loader.setup
+      end
+    end
+  end
+end

data/lib/cli_format/presenter.rb

@@ -0,0 +1,20 @@
+module CliFormat
+  class Presenter
+    attr_accessor :header, :rows
+    def initialize(options)
+      @options = options
+      @rows = []
+    end
+
+    def show
+      presenter_class = "CliFormat::Presenter::#{format.classify}".constantize
+      presenter = presenter_class.new(@options, @header, @rows)
+      presenter.show
+    end
+
+    # Formats: tabs, markdown, json, csv, table, etc
+    def format
+      @options[:format] || ENV['CLI_FORMAT'] || "table"
+    end
+  end
+end

data/lib/cli_format/presenter/base.rb

@@ -0,0 +1,12 @@
+class CliFormat::Presenter
+  class Base
+    def initialize(options, header, rows)
+      @options, @header, @rows = options, header, rows
+      @buffer = []
+    end
+
+    def show
+      puts text
+    end
+  end
+end

data/lib/cli_format/presenter/csv.rb

@@ -0,0 +1,14 @@
+require 'csv'
+
+class CliFormat::Presenter
+  class Csv < Base
+    def text
+      CSV.generate do |csv|
+        csv << @header if @header
+        @rows.each do |row|
+          csv << row
+        end
+      end
+    end
+  end
+end

data/lib/cli_format/presenter/json.rb

@@ -0,0 +1,13 @@
+require "json"
+
+class CliFormat::Presenter
+  class Json < Base
+    def text
+      json_data = {
+        header: @header,
+        data: @rows
+      }
+      JSON.pretty_generate(json_data)
+    end
+  end
+end

data/lib/cli_format/presenter/tab.rb

@@ -0,0 +1,11 @@
+class CliFormat::Presenter
+  class Tab < Base
+    def text
+      @buffer << @header.join("\t") if @header
+      @rows.each do |row|
+        @buffer << row.join("\t")
+      end
+      @buffer.join("\n")
+    end
+  end
+end

data/lib/cli_format/presenter/table.rb

@@ -0,0 +1,12 @@
+require 'text-table'
+
+class CliFormat::Presenter
+  class Table < Base
+    def text
+      table = Text::Table.new
+      table.head = @header if @header
+      table.rows = @rows
+      table
+    end
+  end
+end

data/lib/cli_format/version.rb

@@ -0,0 +1,3 @@
+module CliFormat
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: cli-format
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tung Nguyen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: text-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- tongueroo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cli-format.gemspec
+- lib/cli-format.rb
+- lib/cli_format.rb
+- lib/cli_format/autoloader.rb
+- lib/cli_format/presenter.rb
+- lib/cli_format/presenter/base.rb
+- lib/cli_format/presenter/csv.rb
+- lib/cli_format/presenter/json.rb
+- lib/cli_format/presenter/tab.rb
+- lib/cli_format/presenter/table.rb
+- lib/cli_format/version.rb
+homepage: https://github.com/tongueroo/cli-format
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tongueroo/cli-format
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: 'Format cli output in different ways: tab, table, csv, json, etc'
+test_files: []