org_tp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8a83f8237762908daa19602bd9081127d14400a6
+  data.tar.gz: cce28c651cbbacf2efaa215209135bc1e963337b
+SHA512:
+  metadata.gz: 91391f554d786d9138edb2226bf8eec232c894cc109f854f658b96b9a585a0df75bdf114414bcfbcf8c0f43881725571dc1e842149a82fe3cea603b1652e353f
+  data.tar.gz: cb22bf2cbc811a43cbb1a19f23d728060443621139faecca02c30fc109a83dcce3502a3d7b2c8526343f623bffa215e866c2f47727381ac2881fe47be53bbd9e

data/.gitignore

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

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,101 @@
+* OrgTp
+
+  OrgTp shows ascii table like emacs org-table for easy reading.
+
+** Install
+
+#+BEGIN_SRC shell
+gem install org_tp
+#+END_SRC
+
+** Examples
+
+*** Hash of Array
+
+#+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
+
+*** Integer, String, Symbol
+
+#+BEGIN_SRC ruby
+tp 1
+# >> |---|
+# >> | 1 |
+# >> |---|
+#+END_SRC
+
+#+BEGIN_SRC ruby
+tp "foo"
+# >> |-----|
+# >> | foo |
+# >> |-----|
+#+END_SRC
+
+#+BEGIN_SRC ruby
+tp :foo
+# >> |-----|
+# >> | foo |
+# >> |-----|
+#+END_SRC
+
+*** ActiveRecord
+
+#+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
+
+*** How to table as string
+
+#+BEGIN_SRC ruby
+puts [{id: 1, name: "alice"}, {id: 2, name: "bob"}].to_t
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> |----+-------|
+#+END_SRC

data/Rakefile

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

data/examples/0100_example.rb

@@ -0,0 +1,51 @@
+$LOAD_PATH << "../lib"
+require "org_tp"
+
+tp 1
+tp "foo"
+tp :foo
+tp [:a, :b]
+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
+# >> |---|
+# >> | 1 |
+# >> |---|
+# >> |-----|
+# >> | foo |
+# >> |-----|
+# >> |-----|
+# >> | foo |
+# >> |-----|
+# >> |---|
+# >> | a |
+# >> | b |
+# >> |---|
+# >> |------+-------|
+# >> | 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,37 @@
+$LOAD_PATH << "../lib"
+require "active_record"
+require "org_tp"
+
+ActiveRecord::Base.include(OrgTp::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
+
+["alice", "bob", "carol"].each { |e| User.create!(name: e) }
+
+tp User
+tp User.first
+tp User.limit(1)
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |  2 | bob   |
+# >> |  3 | carol |
+# >> |----+-------|
+# >> |------+-------|
+# >> | id   |     1 |
+# >> | name | alice |
+# >> |------+-------|
+# >> |----+-------|
+# >> | id | name  |
+# >> |----+-------|
+# >> |  1 | alice |
+# >> |----+-------|

data/examples/0120_default_options.rb

@@ -0,0 +1,24 @@
+$LOAD_PATH << "../lib"
+require "org_tp"
+
+tp OrgTp::Generator.default_options
+OrgTp::Generator.default_options.update(intersection_both: "+")
+tp OrgTp::Generator.default_options
+# >> |-------------------+-------|
+# >> | header            |       |
+# >> | vertical          | |     |
+# >> | intersection      | +     |
+# >> | intersection_both | |     |
+# >> | horizon           | -     |
+# >> | padding           |       |
+# >> | in_code           | UTF-8 |
+# >> |-------------------+-------|
+# >> +-------------------+-------+
+# >> | header            |       |
+# >> | vertical          | |     |
+# >> | intersection      | +     |
+# >> | intersection_both | +     |
+# >> | horizon           | -     |
+# >> | padding           |       |
+# >> | in_code           | UTF-8 |
+# >> +-------------------+-------+

data/lib/org_tp/core_ext.rb

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

data/lib/org_tp/org_tp.rb

@@ -0,0 +1,183 @@
+# 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 OrgTp
+  def self.generate(*args, &block)
+    Generator.new(*args, &block).generate
+  end
+
+  class Generator
+    class_attribute :default_options
+    self.default_options = {
+      header: nil,
+      vertical: '|',
+      intersection: '+',
+      intersection_both: '|',
+      horizon: '-',
+      padding: ' ',
+      in_code: Kconv::UTF8,
+    }
+
+    def initialize(rows, **options)
+      @options = default_options.merge(options)
+      @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
+        end
+      end
+
+      table_rows_build
+
+      out = []
+      out << separater
+      if @column_names
+        out << header
+        out << separater
+      end
+      out << body
+      out << separater
+      out.flatten * "\n" + "\n"
+    end
+
+    private
+
+    def table_rows_build
+      columns = @rows.inject([]) { |a, e| a | e.keys }
+      if @options[:header]
+        @column_names = columns
+      end
+      @table_rows = @rows.collect { |e| e.values_at(*columns) }
+    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, column_widths[i]) + padding
+      }
+      s = s.join(@options[:vertical])
+      [@options[:vertical], s, @options[:vertical]].join
+    end
+
+    def padding
+      @options[:padding]
+    end
+
+    def just(value, max_width)
+      align = Float(value) && :right rescue :left
+      space = ' ' * (max_width - 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
+      [
+        {
+          _case: -> e { e.kind_of?(Hash) },
+          header: false,
+          process: -> e {
+            e.collect do |k, v|
+              {'(key)' => k.to_s, '(value)' => v.to_s}
+            end
+          },
+        },
+        {
+          _case: -> e { e.kind_of?(Array) && e.any? { |e| !e.kind_of?(Hash) } },
+          header: false,
+          process: -> e {
+            e.collect do |e|
+              if e.kind_of? Hash
+                e
+              else
+                {'(array_value)' => e}
+              end
+            end
+          },
+        },
+        {
+          _case: -> e { e.kind_of?(Array) && e.all? { |e| e.kind_of?(Hash) } },
+          header: true,
+          process: -> e { e },
+        },
+      ]
+    end
+  end
+end
+
+if $0 == __FILE__
+  rows = [
+    {id: 1, name: 'alice', description: '0123456789'},
+    {id: 2, name: 'bob',   description: 'あいうえお'},
+    {id: 3, name: 'carol'},
+  ]
+  print OrgTp.generate({a: []})
+  print OrgTp.generate([])
+  print OrgTp.generate(rows)
+  print OrgTp.generate({a: 1, b: 2}, header: false)
+end
+# >> +---+----+
+# >> | a | [] |
+# >> +---+----+
+# >>
+# >> +----+-------+-------------+
+# >> | id | name  | description |
+# >> +----+-------+-------------+
+# >> |  1 | alice |  0123456789 |
+# >> |  2 | bob   | あいうえお  |
+# >> |  3 | carol |             |
+# >> +----+-------+-------------+
+# >> +---+---+
+# >> | a | 1 |
+# >> | b | 2 |
+# >> +---+---+

data/lib/org_tp/railtie.rb

@@ -0,0 +1,13 @@
+module OrgTp
+  class Railtie < Rails::Railtie
+    initializer 'org_tp' do
+      ActiveSupport.on_load(:active_record) do
+        include OrgTp::ActiveRecord
+      end
+
+      if defined?(Mongoid::Document)
+        Mongoid::Document.include(OrgTp::ActiveRecord)
+      end
+    end
+  end
+end

data/lib/org_tp/version.rb

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

data/lib/org_tp.rb

@@ -0,0 +1,28 @@
+require 'org_tp/version'
+require 'org_tp/org_tp'
+require 'org_tp/core_ext'
+
+if defined?(Rails)
+  require 'org_tp/railtie'
+else
+  if defined?(ActiveSupport)
+    ActiveSupport.on_load(:active_record) do
+      include OrgTp::ActiveRecord
+    end
+  end
+  if defined?(Mongoid::Document)
+    Mongoid::Document.include(OrgTp::ActiveRecord)
+  end
+end
+
+if defined?(Tapp)
+  module Tapp::Printer
+    class Tp < Base
+      def print(*args)
+        tp *args
+      end
+    end
+
+    register :tp, Tp
+  end
+end

data/org_tp.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'org_tp/version'
+
+Gem::Specification.new do |spec|
+  spec.name         = "org_tp"
+  spec.version      = OrgTp::VERSION
+  spec.author       = "akicho8"
+  spec.email        = "akicho8@gmail.com"
+  spec.homepage     = "https://github.com/akicho8/org_tp"
+  spec.summary      = "OrgTp shows ascii table like emacs org-table for easy reading."
+  spec.description  = "OrgTp shows ascii 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

data/spec/active_record_spec.rb

@@ -0,0 +1,38 @@
+require_relative "spec_helper"
+require "active_record"
+
+ActiveRecord::Base.send(:include, OrgTp::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 OrgTp::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
+  end
+end

data/spec/org_tp_spec.rb

@@ -0,0 +1,99 @@
+require_relative "spec_helper"
+
+describe OrgTp do
+  before do
+    @rows = [
+      {id: 1, name: "alice", description: "0123456789"},
+      {id: 2, name: "bob",   description: "あいうえお"},
+      {id: 3, name: "bob"},
+    ]
+  end
+
+  it "空の場合" do
+    OrgTp.generate([]).should == ""
+  end
+
+  it "フォーマット指定なし" do
+    OrgTp.generate(@rows).should == <<~EOT
+|----+-------+-------------|
+| id | name  | description |
+|----+-------+-------------|
+|  1 | alice |  0123456789 |
+|  2 | bob   | あいうえお  |
+|  3 | bob   |             |
+|----+-------+-------------|
+EOT
+  end
+
+  it "ヘッダーなし" do
+    OrgTp.generate(@rows, header: false).should == <<~EOT
+|---+-------+------------|
+| 1 | alice | 0123456789 |
+| 2 | bob   | あいうえお |
+| 3 | bob   |            |
+|---+-------+------------|
+EOT
+  end
+
+  it "パディングなし" do
+    OrgTp.generate(@rows, padding: "").should == <<~EOT
+|--+-----+-----------|
+|id|name |description|
+|--+-----+-----------|
+| 1|alice| 0123456789|
+| 2|bob  |あいうえお |
+| 3|bob  |           |
+|--+-----+-----------|
+EOT
+  end
+
+  describe "組み込み" do
+    it "ハッシュの配列はいままで通り" do
+      [{a: 1}].to_t.should == <<~EOT
+|---|
+| a |
+|---|
+| 1 |
+|---|
+EOT
+    end
+
+    it "ハッシュのみの場合は縦に表示" do
+      {a: 1}.to_t.should == <<~EOT
+|---+---|
+| a | 1 |
+|---+---|
+EOT
+    end
+
+    it "文字列の配列は縦に並べて表示" do
+      ["a", "b"].to_t.should == <<~EOT
+|---|
+| a |
+| b |
+|---|
+EOT
+    end
+
+    it "その他" 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 "ハッシュの配列で値が配列のとき幅がおかしくならない" do
+      OrgTp.generate([{"a" => ["a"]}]).should == <<~EOT
+|-------|
+| a     |
+|-------|
+| ["a"] |
+|-------|
+EOT
+    end
+  end
+end

data/spec/spec_helper.rb

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

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: org_tp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- akicho8
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-05 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: OrgTp shows ascii table like emacs org-table for easy reading.
+email: akicho8@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.org
+- Rakefile
+- examples/0100_example.rb
+- examples/0110_active_record.rb
+- examples/0120_default_options.rb
+- lib/org_tp.rb
+- lib/org_tp/core_ext.rb
+- lib/org_tp/org_tp.rb
+- lib/org_tp/railtie.rb
+- lib/org_tp/version.rb
+- org_tp.gemspec
+- spec/active_record_spec.rb
+- spec/org_tp_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/akicho8/org_tp
+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.6.11
+signing_key: 
+specification_version: 4
+summary: OrgTp shows ascii table like emacs org-table for easy reading.
+test_files:
+- spec/active_record_spec.rb
+- spec/org_tp_spec.rb
+- spec/spec_helper.rb