table_format 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6305bf0c58e332244e99cf17d886b464e2a171d5b3725c27fd99a6245bb6f240
+  data.tar.gz: 3b17401ae6d8e231c29504e59f86ce22f869533489e13cf9b8a93689bea21661
+SHA512:
+  metadata.gz: 4de5cfd39d6f9afe11e02ecb9957489b4c2720804656abb065dad688e2c8b7ee39e2fe1a70bbd1ea61dda0886841161703f6c1f84ff37017bd34da3a6e39e35b
+  data.tar.gz: 17cd1665ed3203b7d01e7ca4a8ca1c2179ce0bd685276b99d9f9f90652f5aa879baf05442f75efd334c2a8b836a8959cd5e20b065e4099af7b69358a60936046

data/.gitignore

@@ -0,0 +1,3 @@
+/*.gem
+/*.html
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.5

data/Gemfile

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

data/README.org

@@ -0,0 +1,196 @@
+#+html: <a href="https://badge.fury.io/rb/table_format"><img src="https://badge.fury.io/rb/table_format.svg" alt="Gem Version" height="18"></a>
+#+html: <a href="https://travis-ci.org/akicho8/table_format"><img src="https://travis-ci.org/akicho8/table_format.svg?branch=master" /></a>
+#+html: <a href="https://codeclimate.com/github/akicho8/table_format/maintainability"><img src="https://api.codeclimate.com/v1/badges/3af6a246ec61ddafd45d/maintainability" /></a>
+
+* TableFormat
+
+  TableFormat shows text table like emacs org-table for easy reading.
+
+#+BEGIN_SRC ruby
+tp Object.constants.grep(/RUBY_/).map { |e| [e, Object.const_get(e)] }.to_h
+
+# >> |---------------------+------------------------------------------------------------|
+# >> |        RUBY_VERSION | 2.5.0                                                      |
+# >> |   RUBY_RELEASE_DATE | 2017-12-25                                                 |
+# >> |       RUBY_PLATFORM | x86_64-darwin16                                            |
+# >> |     RUBY_PATCHLEVEL | 0                                                          |
+# >> |    RUBY_DESCRIPTION | ruby 2.5.0p0 (2017-12-25 revision 61468) [x86_64-darwin16] |
+# >> |         RUBY_ENGINE | ruby                                                       |
+# >> |       RUBY_REVISION | 61468                                                      |
+# >> | RUBY_ENGINE_VERSION | 2.5.0                                                      |
+# >> |      RUBY_COPYRIGHT | ruby - Copyright (C) 1993-2017 Yukihiro Matsumoto          |
+# >> |---------------------+------------------------------------------------------------|
+#+END_SRC
+
+** Installation
+
+Install as a standalone gem
+
+#+BEGIN_SRC shell-script
+$ gem install table_format
+#+END_SRC
+
+Or install within application using Gemfile
+
+#+BEGIN_SRC shell-script
+$ bundle add table_format
+$ bundle install
+#+END_SRC
+
+** Examples
+
+*** Array of hash
+
+#+BEGIN_SRC ruby
+tp [{id: 1, name: 'alice'}, {id: 2, name: 'bob'}]
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> |----+-------|
+#+END_SRC
+
+*** Hash
+
+#+BEGIN_SRC ruby
+tp({id: 1, name: 'alice'})
+# >> |------+-------|
+# >> |   id | 1     |
+# >> | name | alice |
+# >> |------+-------|
+#+END_SRC
+
+*** Array
+
+#+BEGIN_SRC ruby
+tp [:alice, :bob]
+# >> |-------|
+# >> | alice |
+# >> | bob   |
+# >> |-------|
+#+END_SRC
+
+*** ActiveRecord or Mongoid
+
+#+BEGIN_SRC ruby
+['alice', 'bob'].each { |e| User.create!(name: e) }
+#+END_SRC
+
+#+BEGIN_SRC ruby
+tp User
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> |----+-------|
+#+END_SRC
+
+#+BEGIN_SRC ruby
+tp User.limit(1)
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |----+-------|
+#+END_SRC
+
+#+BEGIN_SRC ruby
+tp User.first
+# >> |------+-------|
+# >> |   id | 1     |
+# >> | name | alice |
+# >> |------+-------|
+#+END_SRC
+
+**** ActiveRecord::Result
+
+#+BEGIN_SRC ruby
+tp ActiveRecord::Base.connection.select_all('SELECT * FROM users')
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> |----+-------|
+#+END_SRC
+
+** How to table as string
+
+Use to_t method.
+
+#+BEGIN_SRC ruby
+puts [{id: 1, name: 'alice'}, {id: 2, name: 'bob'}].to_t
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> |----+-------|
+#+END_SRC
+
+** Options
+
+Pass as the second argument to tp or the first argument to to_t.
+
+#+BEGIN_SRC ruby
+tp 1
+# >> |---|
+# >> | 1 |
+# >> |---|
+
+tp 1, intersection_both: '+'
+# >> +---+
+# >> | 1 |
+# >> +---+
+#+END_SRC
+
+*** Markdown format example
+
+=markdown: true= has the same meaning as =intersection: '|', cover: false=
+
+#+BEGIN_SRC ruby
+tp [{id: 1, name: 'alice'}, {id: 2, name: 'bob'}], markdown: true
+# >> | id | name  |
+# >> |----|-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+#+END_SRC
+
+#+BEGIN_SRC ruby
+tp [{id: 1, name: 'alice'}, {id: 2, name: 'bob'}], intersection: '|', cover: false
+# >> | id | name  |
+# >> |----|-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+#+END_SRC
+
+** Global Options
+
+#+BEGIN_SRC ruby
+tp TableFormat.default_options
+# >> |-------------------+-------|
+# >> |          markdown | false |
+# >> |            header |       |
+# >> |             cover | true  |
+# >> |          vertical | |     |
+# >> |      intersection | +     |
+# >> | intersection_both | |     |
+# >> |           horizon | -     |
+# >> |           padding |       |
+# >> |           in_code | UTF-8 |
+# >> |-------------------+-------|
+
+tp 1
+# >> |---|
+# >> | 1 |
+# >> |---|
+
+TableFormat.default_options[:intersection_both] = '+'
+
+tp 1
+# >> +---+
+# >> | 1 |
+# >> +---+
+#+END_SRC

data/Rakefile

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

data/examples/0100_basic.rb

@@ -0,0 +1,54 @@
+$LOAD_PATH << '../lib'
+require 'table_format'
+
+tp :ok
+tp 'foo'
+tp :foo
+tp [:alice, :bob]
+tp({id: 1, name: 'alice'})
+tp [{id: 1, name: 'alice'}, {id: 2, name: 'bob'}]
+puts [{id: 1, name: 'alice'}, {id: 2, name: 'bob'}].to_t
+puts [{'a': ['a']}].to_t
+puts [{'a': {'a': 1}}].to_t
+# >> |----|
+# >> | ok |
+# >> |----|
+# >> |----|
+# >> | ok |
+# >> |----|
+# >> |-----|
+# >> | foo |
+# >> |-----|
+# >> |-----|
+# >> | foo |
+# >> |-----|
+# >> |-------|
+# >> | alice |
+# >> | bob   |
+# >> |-------|
+# >> |------+-------|
+# >> |   id | 1     |
+# >> | name | alice |
+# >> |------+-------|
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> |----+-------|
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> |----+-------|
+# >> |-------|
+# >> | a     |
+# >> |-------|
+# >> | ["a"] |
+# >> |-------|
+# >> |---------|
+# >> | a       |
+# >> |---------|
+# >> | {:a=>1} |
+# >> |---------|

data/examples/0110_active_record.rb

@@ -0,0 +1,92 @@
+$LOAD_PATH << '../lib'
+require 'active_record'
+require 'table_format'
+
+# tp ::ActiveRecord::Result.ancestors
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Migration.verbose = false
+ActiveRecord::Schema.define do
+  create_table :users do |t|
+    t.string :name
+  end
+end
+
+class User < ActiveRecord::Base
+end
+
+['alice', 'bob', 'carol'].each { |e| User.create!(name: e) }
+
+tp User.limit(2)
+
+tp User
+tp User.first
+
+p User.limit(1).class.name      # => "ActiveRecord::Relation"
+tp User.limit(1)
+puts table_format(User.limit(1))
+
+tp ActiveRecord::Base.connection.select_all('SELECT * FROM users')
+tp ActiveRecord::Base.connection.select_one('SELECT * FROM users')
+tp ActiveRecord::Base.connection.select_value('SELECT 1 + 2')
+
+puts User.first.to_t
+
+puts table_format(User.first)
+
+puts Struct.new(:a, :b).new(1, 2).to_h.to_t
+
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> |----+-------|
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> |  3 | carol |
+# >> |----+-------|
+# >> |------+-------|
+# >> |   id | 1     |
+# >> | name | alice |
+# >> |------+-------|
+# >> "ActiveRecord::Relation"
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |----+-------|
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |----+-------|
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> |  3 | carol |
+# >> |----+-------|
+# >> |------+-------|
+# >> |   id | 1     |
+# >> | name | alice |
+# >> |------+-------|
+# >> |---|
+# >> | 3 |
+# >> |---|
+# >> |------+-------|
+# >> |   id | 1     |
+# >> | name | alice |
+# >> |------+-------|
+# >> |------+-------|
+# >> |   id | 1     |
+# >> | name | alice |
+# >> |------+-------|
+# >> |---+---|
+# >> | a | 1 |
+# >> | b | 2 |
+# >> |---+---|

data/examples/0120_default_options.rb

@@ -0,0 +1,34 @@
+$LOAD_PATH << '../lib'
+require 'table_format'
+
+tp 1, intersection_both: '+'
+
+tp TableFormat.default_options
+TableFormat.default_options.update(intersection_both: '+')
+tp TableFormat.default_options
+
+# >> +---+
+# >> | 1 |
+# >> +---+
+# >> |-------------------+-------|
+# >> |          markdown | false |
+# >> |            header |       |
+# >> |             cover | true  |
+# >> |          vertical | |     |
+# >> |      intersection | +     |
+# >> | intersection_both | |     |
+# >> |           horizon | -     |
+# >> |           padding |       |
+# >> |           in_code | UTF-8 |
+# >> |-------------------+-------|
+# >> +-------------------+-------+
+# >> |          markdown | false |
+# >> |            header |       |
+# >> |             cover | true  |
+# >> |          vertical | |     |
+# >> |      intersection | +     |
+# >> | intersection_both | +     |
+# >> |           horizon | -     |
+# >> |           padding |       |
+# >> |           in_code | UTF-8 |
+# >> +-------------------+-------+

data/examples/0130_mongoid.rb

@@ -0,0 +1,35 @@
+$LOAD_PATH << '../lib'
+require 'active_record'
+require 'mongoid'
+require 'table_format'
+
+Mongo::Logger.logger.level = Logger::INFO
+Mongoid::Config.connect_to('test')
+Mongoid::Clients.default.database.drop
+
+class User
+  include Mongoid::Document
+  field :name, type: String
+end
+
+['alice', 'bob', 'carol'].each { |e| User.create!(name: e) }
+
+tp User
+tp User.first
+tp User.limit(1)
+# >> |--------------------------+-------|
+# >> | _id                      | name  |
+# >> |--------------------------+-------|
+# >> | 59ed43e9f6453f17bc8e4fd3 | alice |
+# >> | 59ed43e9f6453f17bc8e4fd4 | bob   |
+# >> | 59ed43e9f6453f17bc8e4fd5 | carol |
+# >> |--------------------------+-------|
+# >> |------+--------------------------|
+# >> |  _id | 59ed43e9f6453f17bc8e4fd3 |
+# >> | name | alice                    |
+# >> |------+--------------------------|
+# >> |--------------------------+-------|
+# >> | _id                      | name  |
+# >> |--------------------------+-------|
+# >> | 59ed43e9f6453f17bc8e4fd3 | alice |
+# >> |--------------------------+-------|

data/examples/0140_markdown_format.rb

@@ -0,0 +1,51 @@
+$LOAD_PATH << '../lib'
+require 'table_format'
+
+array = [
+  {id: 1, name: 'alice' },
+  {id: 2, name: 'bob'   },
+]
+
+# tp with options
+tp array, intersection: '|', cover: false
+
+# to_t with options
+array.to_t(intersection: '|', cover: false) # => "| id | name  |\n|----|-------|\n|  1 | alice |\n|  2 | bob   |\n"
+
+puts
+
+# set global options
+TableFormat.default_options.update(intersection: '|', cover: false)
+tp array
+
+######################################## markdown option
+
+# tp with options
+tp array, markdown: true
+
+# to_t with options
+array.to_t(markdown: true) # => "| id | name  |\n|----|-------|\n|  1 | alice |\n|  2 | bob   |\n"
+
+puts
+
+# set global options
+TableFormat.default_options.update(markdown: true)
+tp array
+# >> | id | name  |
+# >> |----|-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> 
+# >> | id | name  |
+# >> |----|-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> | id | name  |
+# >> |----|-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> 
+# >> | id | name  |
+# >> |----|-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |

data/lib/table_format.rb

@@ -0,0 +1,24 @@
+require 'table_format/version'
+require 'table_format/generator'
+require 'table_format/core_ext'
+
+if defined?(Rails)
+  require 'table_format/railtie'
+else
+  if defined?(ActiveSupport)
+    ActiveSupport.on_load(:active_record) do
+      include TableFormat::ActiveRecord
+      ::ActiveRecord::Result.include TableFormat::ActiveRecordResult
+
+      ::ActiveRecord::Relation.class_eval do
+        def to_t(**options)
+          TableFormat.generate(to_a.collect(&:attributes), options)
+        end
+      end
+
+    end
+  end
+  if defined?(Mongoid::Document)
+    Mongoid::Document.include(TableFormat::ActiveRecord)
+  end
+end

data/lib/table_format/core_ext.rb

@@ -0,0 +1,68 @@
+require 'active_support/core_ext/kernel/concern'
+
+module TableFormat
+  concern :ActiveRecord do
+    class_methods do
+      def to_t(**options)
+        TableFormat.generate(all.collect(&:attributes), options)
+      end
+    end
+
+    def to_t(**options)
+      TableFormat.generate(attributes, options)
+    end
+  end
+
+  concern :ActiveRecordResult do
+    def to_t(**options)
+      TableFormat.generate(collect(&:to_h), options)
+    end
+  end
+end
+
+Object.class_eval do
+  def to_t(**options)
+    case
+    when respond_to?(:to_h)
+      to_h.to_t(options)
+    when respond_to?(:to_a)
+      to_a.to_t(options)
+    else
+      TableFormat.generate([{self.class.name => self}], {header: false}.merge(options))
+    end
+  end
+end
+
+Kernel.class_eval do
+  private
+
+  def tp(object, **options)
+    object.tap do
+      table_format(object).display
+    end
+  end
+
+  def table_format(object, **options)
+    object.to_t(options)
+  end
+end
+
+Array.class_eval do
+  def to_t(**options)
+    TableFormat.generate(self, options)
+  end
+end
+
+Hash.class_eval do
+  def to_t(**options)
+    TableFormat.generate(self, options)
+  end
+end
+
+[Symbol, String, Numeric].each do |klass|
+  klass.class_eval do
+    def to_t(**options)
+      TableFormat.generate([{self.class.name => self}], {header: false}.merge(options))
+    end
+  end
+end

data/lib/table_format/generator.rb

@@ -0,0 +1,240 @@
+# frozen_string_literal: true
+require 'active_support/core_ext/string'          # for blank?
+require 'active_support/core_ext/class/attribute' # for class_attribute
+require 'kconv'
+
+module TableFormat
+  mattr_accessor :default_options do
+    {
+      markdown: false,
+      header: nil,
+      cover: true,
+      vertical: '|',
+      intersection: '+',
+      intersection_both: '|',
+      horizon: '-',
+      padding: ' ',
+      in_code: Kconv::UTF8,
+    }
+  end
+
+  def self.generate(*args, &block)
+    Generator.new(*args, &block).generate
+  end
+
+  class Generator
+    def self.default_options
+      warn "[DEPRECATED] `TableFormat::Generator.default_options' is deprecated. Use `TableFormat.default_options' instead."
+      TableFormat.default_options
+    end
+
+    def initialize(rows, **options)
+      @options = TableFormat.default_options.merge(options)
+
+      if @options[:markdown]
+        @options[:intersection] = '|'
+        @options[:cover] = false
+      end
+
+      @rows = rows
+      @column_names = nil
+    end
+
+    def generate
+      if @rows.blank?
+        return ''
+      end
+
+      pre_processes.each do |e|
+        if e[:_case][@rows]
+          @rows = e[:process][@rows]
+          if @options[:header].nil?
+            @options[:header] = e[:header]
+          end
+          @options[:align] ||= e[:align]
+        end
+      end
+
+      table_rows_build
+
+      out = []
+      if @options[:cover]
+        out << separater
+      end
+      if @column_names
+        out << header
+        out << separater
+      end
+      out << body
+      if @options[:cover]
+        out << separater
+      end
+      out.flatten * "\n" + "\n"
+    end
+
+    private
+
+    def table_rows_build
+      if @options[:header]
+        @column_names = all_columns
+      end
+      @table_rows = @rows.collect { |e| e.values_at(*all_columns) }
+    end
+
+    def all_columns
+      @all_columns ||= @rows.inject([]) { |a, e| a | e.keys }
+    end
+
+    def column_widths
+      @column_widths ||= ([@column_names] + @table_rows).compact.transpose.collect do |vertical_values|
+        vertical_values.collect { |e| str_width(e) }.max
+      end
+    end
+
+    def separater
+      @separater ||= _separater
+    end
+
+    def _separater
+      s = column_widths.collect { |e|
+        @options[:horizon] * (padding.size + e + padding.size)
+      }
+      s = s.join(@options[:intersection])
+      [@options[:intersection_both], s, @options[:intersection_both]].join
+    end
+
+    def header
+      @header ||= line_str(@column_names)
+    end
+
+    def body
+      @table_rows.collect { |row| line_str(row) }
+    end
+
+    def line_str(row)
+      s = row.collect.with_index {|e, i|
+        padding + just(e, i) + padding
+      }
+      s = s.join(@options[:vertical])
+      [@options[:vertical], s, @options[:vertical]].join
+    end
+
+    def padding
+      @options[:padding]
+    end
+
+    def just(value, i)
+      align = (@options[:align] || {}).fetch(all_columns[i]) do
+        Float(value) && :right rescue :left
+      end
+      space = ' ' * (column_widths[i] - str_width(value))
+      lspace = ''
+      rspace = ''
+      if align == :right
+        lspace = space
+      else
+        rspace = space
+      end
+      # If value is `[]`,
+      # executing to_s, it becomes `[]`.
+      # not executing to_s, it becomes empty string
+      [lspace, value.to_s, rspace].join
+    end
+
+    def str_width(str)
+      str.to_s.kconv(Kconv::EUC, @options[:in_code]).bytesize
+    end
+
+    def pre_processes
+      [
+        # Hash
+        {
+          _case: -> e { e.kind_of?(Hash) },
+          header: false,
+          process: -> e {
+            e.collect do |k, v|
+              {'(key)' => k.to_s, '(value)' => v.to_s}
+            end
+          },
+          align: {'(key)' => :right, '(value)' => :left},
+        },
+
+        # Array of Hash
+        {
+          _case: -> e { e.kind_of?(Array) && e.all? { |v| v.kind_of?(Hash) } },
+          header: true,
+          process: -> e { e },
+        },
+
+        # Array excluding Hash
+        {
+          _case: -> e { e.kind_of?(Array) && e.none? { |v| v.kind_of?(Hash) } },
+          header: false,
+          process: -> e {
+            e.collect do |v|
+              {'(array_element)' => v}
+            end
+          },
+        },
+
+        # Array containing Hash and others
+        {
+          _case: -> e { e.kind_of?(Array) && e.any? { |v| !v.kind_of?(Hash) } },
+          header: true,
+          process: -> e {
+            e.collect do |v|
+              if v.kind_of? Hash
+                v
+              else
+                {'(array_element)' => v}
+              end
+            end
+          },
+        },
+      ]
+    end
+  end
+end
+
+if $0 == __FILE__
+  rows = [
+    {id: 1, name: 'alice', description: '0123456789'},
+    {id: 2, name: 'bob',   description: 'あいうえお'},
+    {id: 3, name: 'carol'},
+  ]
+  print TableFormat.generate({a: []})
+  print TableFormat.generate([])
+  print TableFormat.generate(rows)
+  print TableFormat.generate({a: 1, b: 2}, header: false)
+  print TableFormat.generate([["a", "b"], ["c", "d"]])
+  print TableFormat.generate([["a", "b"], {"c" => "d"}])
+  print TableFormat.generate({id: 1, created_at: "2000-01-01"})
+end
+# >> |---+----|
+# >> | a | [] |
+# >> |---+----|
+# >> |----+-------+-------------|
+# >> | id | name  | description |
+# >> |----+-------+-------------|
+# >> |  1 | alice |  0123456789 |
+# >> |  2 | bob   | あいうえお  |
+# >> |  3 | carol |             |
+# >> |----+-------+-------------|
+# >> |---+---|
+# >> | a | 1 |
+# >> | b | 2 |
+# >> |---+---|
+# >> |------------|
+# >> | ["a", "b"] |
+# >> | ["c", "d"] |
+# >> |------------|
+# >> |-----------------+---|
+# >> | (array_element) | c |
+# >> |-----------------+---|
+# >> | ["a", "b"]      |   |
+# >> |                 | d |
+# >> |-----------------+---|
+# >> |------------+------------|
+# >> |         id | 1          |
+# >> | created_at | 2000-01-01 |
+# >> |------------+------------|

data/lib/table_format/railtie.rb

@@ -0,0 +1,20 @@
+module TableFormat
+  class Railtie < Rails::Railtie
+    initializer 'table_format' do
+      ActiveSupport.on_load(:active_record) do
+        include TableFormat::ActiveRecord
+        ::ActiveRecord::Result.include TableFormat::ActiveRecordResult
+
+        ::ActiveRecord::Relation.class_eval do
+          def to_t(**options)
+            TableFormat.generate(to_a.collect(&:attributes), options)
+          end
+        end
+      end
+
+      if defined?(Mongoid::Document)
+        Mongoid::Document.include(TableFormat::ActiveRecord)
+      end
+    end
+  end
+end

data/lib/table_format/version.rb

@@ -0,0 +1,3 @@
+module TableFormat
+  VERSION = '0.0.1'
+end

data/spec/active_record_spec.rb

@@ -0,0 +1,47 @@
+require_relative 'spec_helper'
+require 'active_record'
+
+ActiveRecord::Base.send(:include, TableFormat::ActiveRecord)
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :users do |t|
+    t.string :name
+  end
+end
+
+class User < ActiveRecord::Base
+end
+
+describe TableFormat::ActiveRecord do
+  before do
+    2.times { |i| User.create!(name: i) }
+  end
+
+  it do
+    User.to_t.should == <<~EOT
+|----+------|
+| id | name |
+|----+------|
+|  1 |    0 |
+|  2 |    1 |
+|----+------|
+EOT
+    User.first.to_t.should == <<~EOT
+|------+---|
+|   id | 1 |
+| name | 0 |
+|------+---|
+EOT
+
+    ActiveRecord::Base.connection.select_all('select * from users').to_t.should == <<~EOT
+|----+------|
+| id | name |
+|----+------|
+|  1 |    0 |
+|  2 |    1 |
+|----+------|
+EOT
+  end
+end

data/spec/core_ext_spec.rb

@@ -0,0 +1,20 @@
+require_relative 'spec_helper'
+
+describe TableFormat do
+  require 'tempfile'
+  require 'active_support/testing/stream'
+  include ActiveSupport::Testing::Stream
+
+  it do
+    capture(:stdout) { tp 1 }.should == <<~EOT
+|---|
+| 1 |
+|---|
+    EOT
+  end
+
+  it 'result is like p method' do
+    v = Object.new
+    quietly { tp v }.should == v
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'table_format'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = [:should, :expect]
+  end
+end

data/spec/table_format_spec.rb

@@ -0,0 +1,128 @@
+require_relative 'spec_helper'
+
+describe TableFormat do
+  before do
+    @rows = [
+      {id: 1, name: 'alice', description: '0123456789'},
+      {id: 2, name: 'bob',   description: 'あいうえお'},
+      {id: 3, name: 'bob'},
+    ]
+  end
+
+  it 'empty array' do
+    TableFormat.generate([]).should == ''
+  end
+
+  it 'default' do
+    TableFormat.generate(@rows).should == <<~EOT
+|----+-------+-------------|
+| id | name  | description |
+|----+-------+-------------|
+|  1 | alice |  0123456789 |
+|  2 | bob   | あいうえお  |
+|  3 | bob   |             |
+|----+-------+-------------|
+EOT
+  end
+
+  it 'header: false' do
+    TableFormat.generate(@rows, header: false).should == <<~EOT
+|---+-------+------------|
+| 1 | alice | 0123456789 |
+| 2 | bob   | あいうえお |
+| 3 | bob   |            |
+|---+-------+------------|
+EOT
+  end
+
+  it 'padding disable' do
+    TableFormat.generate(@rows, padding: '').should == <<~EOT
+|--+-----+-----------|
+|id|name |description|
+|--+-----+-----------|
+| 1|alice| 0123456789|
+| 2|bob  |あいうえお |
+| 3|bob  |           |
+|--+-----+-----------|
+EOT
+  end
+
+  it 'markdown format' do
+    TableFormat.generate(@rows, intersection: '|', cover: false).should == <<~EOT
+| id | name  | description |
+|----|-------|-------------|
+|  1 | alice |  0123456789 |
+|  2 | bob   | あいうえお  |
+|  3 | bob   |             |
+EOT
+
+    TableFormat.generate(@rows, markdown: true).should == <<~EOT
+| id | name  | description |
+|----|-------|-------------|
+|  1 | alice |  0123456789 |
+|  2 | bob   | あいうえお  |
+|  3 | bob   |             |
+EOT
+  end
+
+  describe 'various to_t' do
+    it 'hash array' do
+      [{a: 1}].to_t.should == <<~EOT
+|---|
+| a |
+|---|
+| 1 |
+|---|
+EOT
+    end
+
+    it 'Hash' do
+      {a: 1}.to_t.should == <<~EOT
+|---+---|
+| a | 1 |
+|---+---|
+EOT
+    end
+
+    it 'String Array' do
+      ['a', 'b'].to_t.should == <<~EOT
+|---|
+| a |
+| b |
+|---|
+EOT
+    end
+
+    it 'Others' do
+      1.to_t.should be_present
+      '1'.to_t.should be_present
+      Module.new.should be_present
+      {[:a] => []}.to_t.should == <<~EOT
+|------+----|
+| [:a] | [] |
+|------+----|
+EOT
+    end
+
+    it 'Array of hashes and width is correct even when value is array' do
+      TableFormat.generate([{'a' => ['a']}]).should == <<~EOT
+|-------|
+| a     |
+|-------|
+| ["a"] |
+|-------|
+EOT
+    end
+
+    it 'Array containing Hash and others' do
+      TableFormat.generate([["a", "b"], {"c" => "d"}]).should == <<~EOT
+|-----------------+---|
+| (array_element) | c |
+|-----------------+---|
+| ["a", "b"]      |   |
+|                 | d |
+|-----------------+---|
+EOT
+    end
+  end
+end

data/table_format.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'table_format/version'
+
+Gem::Specification.new do |spec|
+  spec.name         = 'table_format'
+  spec.version      = TableFormat::VERSION
+  spec.author       = 'akicho8'
+  spec.email        = 'akicho8@gmail.com'
+  spec.homepage     = 'https://github.com/akicho8/table_format'
+  spec.summary      = 'TableFormat shows text table like emacs org-table for easy reading.'
+  spec.description  = 'TableFormat shows text table like emacs org-table for easy reading.'
+  spec.platform     = Gem::Platform::RUBY
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+  spec.rdoc_options  = ['--line-numbers', '--inline-source', '--charset=UTF-8', '--diagram', '--image-format=jpg']
+
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: table_format
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- akicho8
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-06-28 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: TableFormat shows text table like emacs org-table for easy reading.
+email: akicho8@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.org
+- Rakefile
+- examples/0100_basic.rb
+- examples/0110_active_record.rb
+- examples/0120_default_options.rb
+- examples/0130_mongoid.rb
+- examples/0140_markdown_format.rb
+- lib/table_format.rb
+- lib/table_format/core_ext.rb
+- lib/table_format/generator.rb
+- lib/table_format/railtie.rb
+- lib/table_format/version.rb
+- spec/active_record_spec.rb
+- spec/core_ext_spec.rb
+- spec/spec_helper.rb
+- spec/table_format_spec.rb
+- table_format.gemspec
+homepage: https://github.com/akicho8/table_format
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--line-numbers"
+- "--inline-source"
+- "--charset=UTF-8"
+- "--diagram"
+- "--image-format=jpg"
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: TableFormat shows text table like emacs org-table for easy reading.
+test_files:
+- spec/active_record_spec.rb
+- spec/core_ext_spec.rb
+- spec/spec_helper.rb
+- spec/table_format_spec.rb