aligned_table 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7dbee126d20129c2ec3d2d12d95e50f925efa69d
+  data.tar.gz: 7f2997860de015315179c9bb0441645a2c34814f
+SHA512:
+  metadata.gz: 3821b6a25b7df02f93e87fa90d97350e9d79ec68c92b91916bd4ed2c6a5cec0ab4345cc7306d7628422631889ec29a76b098fc2071cfc80f70bb62c7d06c2f34
+  data.tar.gz: 2ff5468a03bad691a44681201612d6495e73718b3f886091a4589e61deb2574bf2a36552e405eab1cabcc07246522ceccb123ea433aa262cf8675fb8534ec09b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Zak Kristjanson
+
+MIT License
+
+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,99 @@
+# AlignedTable
+
+An easy way to create simple lightweight text tables with a
+right-aligned first column, total row, and title.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'aligned_table'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install aligned_table
+
+## Usage
+
+### Basic Usage
+```ruby
+at = AlignedTable.new
+at.title = "My Title"
+at.separator = " | "
+at.rows = [
+  ["My Cool Column", "Some data"],
+  ["More data", "Info"]
+]
+
+puts at.render
+```
+
+gives you
+
+```
+======= My Title =======
+My Cool Column Some data
+     More data Info
+```
+
+### Custom Separators
+```ruby
+at = AlignedTable.new
+at.title = "My Title"
+
+at.rows = [
+  ["My Cool Column", "Some data"],
+  ["More data", "Info"]
+]
+
+puts at.render
+```
+
+gives you
+
+```
+======== My Title ========
+My Cool Column | Some data
+     More data | Info
+```
+
+
+### Column Lines
+Pass a symbol instead of a string, and the output will be repeated
+for the length of the line
+```ruby
+at = AlignedTable.new
+at.title = "My Title"
+
+at.rows = [
+  ["My Cool Column", "Some data"],
+  ["More data", "Info"],
+  [nil, :-],
+  [nil, "Total: 15 bananas"]
+]
+
+puts at.render
+```
+
+gives you
+
+```
+=========== My Title ===========
+My Cool Column Some data
+     More data Info
+               -----------------
+               Total: 15 bananas
+```
+
+
+## Contributing
+
+1. Fork it ( http://github.com/ubercow/aligned_table/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

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

data/aligned_table.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'aligned_table'
+
+Gem::Specification.new do |spec|
+  spec.name          = "aligned_table"
+  spec.version       = AlignedTable::VERSION
+  spec.authors       = ["Zak Kristjanson"]
+  spec.email         = ["zak.kristjanson@gmail.com"]
+  spec.summary       = "An easy way to create simple lightweight text tables."
+  spec.homepage      = "https://github.com/ubercow/aligned_table"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+end

data/lib/aligned_table.rb

@@ -0,0 +1,56 @@
+class AlignedTable
+  VERSION = "0.1.0"
+
+  attr_accessor :rows, :title, :separator
+
+  def initialize
+    @separator = " "
+  end
+
+  def render
+    col_len = column_lengths
+    rows = @rows.map do |row|
+      render_row(row, col_len)
+    end
+
+    max_row_length = rows.max_by(&:length).length
+
+    if @title
+      rows.unshift(" #@title ".center(max_row_length, "="))
+    end
+
+    rows.join("\n")
+  end
+
+  def column_lengths
+    columns = []
+
+    @rows.each do |row|
+      row.each_with_index do |col, index|
+        columns[index] ||= []
+        columns[index] << col
+      end
+    end
+
+    columns.map! do |col|
+      col.map { |x| x.to_s }.max_by(&:length).length
+    end
+
+    columns
+  end
+
+  def render_row(row, col_len)
+    columns = row.each_with_index.map do |col, index|
+      if col.is_a?(Symbol)
+        col.to_s * col_len[index]
+      else
+        if index == 0
+          col.to_s.rjust(col_len[index])
+        else
+          col.to_s.ljust(col_len[index])
+        end
+      end
+    end
+    columns.join(@separator)
+  end
+end

data/spec/lib/aligned_table_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe AlignedTable do
+  describe ".column_lengths" do
+    context "with a column of nils" do
+      it "returns 0 for the column count" do
+        at = AlignedTable.new
+        at.rows = [[nil],[nil]]
+        expect(at.column_lengths).to eq([0])
+      end
+    end
+
+    context "with a column of strings" do
+      it "returns the maximum string length" do
+        at = AlignedTable.new
+        at.rows = [["some"],["random"],["content"]]
+        expect(at.column_lengths).to eq([7])
+      end
+    end
+
+    context "with multiple columns of strings" do
+      it "returns the maximum string length" do
+        at = AlignedTable.new
+        at.rows = [
+          ["some", "more"],
+          ["random", "things"],
+          ["content", "here"]
+        ]
+        expect(at.column_lengths).to eq([7, 6])
+      end
+    end
+  end
+
+  describe ".render_row" do
+    context "with a symbol" do
+      it "renders symbols as a repeated line" do
+        at = AlignedTable.new
+        rendered = at.render_row([:-], [5])
+        expect(rendered).to eq("-----")
+      end
+    end
+
+    context "with rows with text" do
+      it "renders the first column left padded" do
+        at = AlignedTable.new
+        rendered = at.render_row(["col1", "col2"], [5, 4])
+        expect(rendered).to eq(" col1 col2")
+      end
+
+      it "renders additional columns right padded" do
+        at = AlignedTable.new
+        rendered = at.render_row(["col1", "col2"], [5, 7])
+        expect(rendered).to eq(" col1 col2   ")
+      end
+    end
+
+    describe "with a nonstandard separator" do
+      it "renders rows with separator" do
+        at = AlignedTable.new
+        at.separator = " | "
+        rendered = at.render_row(["col1", "col2"], [3, 3])
+        expect(rendered).to eq("col1 | col2")
+      end
+    end
+  end
+
+  describe ".rows" do
+    context "with a title" do
+      it "renders the title before rows" do
+        at = AlignedTable.new
+        at.title = "Table"
+        at.rows = [
+          ["hey", "what's"],
+          ["going", "on"]
+        ]
+        output = at.render
+        expect(output).to eq("== Table ===\n  hey what's\ngoing on    ")
+      end
+    end
+
+    context "without a title" do
+      it "renders the rows" do
+        at = AlignedTable.new
+        at.rows = [
+          ["hey", "what's"],
+          ["going", "on"]
+        ]
+        output = at.render
+        expect(output).to eq("  hey what's\ngoing on    ")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+Bundler.setup
+
+
+require 'aligned_table'
+
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: aligned_table
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zak Kristjanson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+description: 
+email:
+- zak.kristjanson@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- aligned_table.gemspec
+- lib/aligned_table.rb
+- spec/lib/aligned_table_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ubercow/aligned_table
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An easy way to create simple lightweight text tables.
+test_files:
+- spec/lib/aligned_table_spec.rb
+- spec/spec_helper.rb
+has_rdoc: