monosheet 0.9.0

data/CHANGELOG

@@ -0,0 +1 @@
+v0.9.0. Initial release

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2010 Jesse Trimble
+
+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/Manifest

@@ -0,0 +1,17 @@
+CHANGELOG
+LICENSE
+Manifest
+README.rdoc
+Rakefile
+features/monosheet.feature
+features/support/person.rb
+features/support/steps.rb
+lib/monosheet.rb
+lib/monosheet/api.rb
+lib/monosheet/inheritable_attributes.rb
+lib/monosheet/output_table.rb
+lib/monosheet/output_table_header_row.rb
+lib/monosheet/output_table_row_divider.rb
+monosheet.gemspec
+spec/header_row_spec.rb
+spec/row_divider_spec.rb

data/Rakefile

@@ -0,0 +1,15 @@
+require "rubygems"
+require "rake"
+require "echoe"
+
+Echoe.new('monosheet') do |p|
+  p.description = "Give monosheet an array of objects, it gives you back a human-readable table that outputs nicely in monospace font."
+  p.url = "http://github.com/jtrim/monosheet"
+  p.author = "Jesse Trimble"
+  p.email = "jesseltrimble@gmail.com"
+  p.ignore_pattern = ["tmp/*", "script/*"] 
+  p.development_dependencies = ["active_support >=3.0.1"]
+  p.summary = "Easy, monospace output of tabular data."
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/features/monosheet.feature

@@ -0,0 +1,23 @@
+Feature: Monosheet rendering
+  As a CLI user
+  To avoid ugliness
+  I test Monosheet to ensure things render properly
+
+  Scenario: I test to ensure the expected result is rendered
+    Given I initialize a collection with the following object properties:
+      | first_name | middle_name | last_name | birthday            | favorite_color | 
+      | James      | Leon        | Smith     | June 1st, 1775      | green          | 
+      | Kayla      | LeAnn       | Smith     | February 15th, 1776 | purple         | 
+      | Dexter     | Luca        | Johnson   | January 30th, 1756  | blue           | 
+    Then my monosheet should look like:
+    """
+    +============+=============+===========+=====================+================+
+    : First Name : Middle Name : Last Name :      Birthday       : Favorite Color :
+    +============+=============+===========+=====================+================+
+    | James      | Leon        | Smith     | June 1st, 1775      | green          |
+    +------------+-------------+-----------+---------------------+----------------+
+    | Kayla      | LeAnn       | Smith     | February 15th, 1776 | purple         |
+    +------------+-------------+-----------+---------------------+----------------+
+    | Dexter     | Luca        | Johnson   | January 30th, 1756  | blue           |
+    +------------+-------------+-----------+---------------------+----------------+
+    """

data/features/support/person.rb

@@ -0,0 +1,7 @@
+class Person
+  attr_accessor :first_name
+  attr_accessor :middle_name
+  attr_accessor :last_name
+  attr_accessor :birthday
+  attr_accessor :favorite_color
+end

data/features/support/steps.rb

@@ -0,0 +1,33 @@
+require "rubygems"
+require "ruby-debug"; Debugger.start
+require File.expand_path(File.dirname(__FILE__) + "/person")
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/monosheet")
+
+Given /^I initialize a collection with the following object properties:$/ do |object_property_hashes|
+  collection = []
+  object_property_hashes.hashes.each do |object_properties|
+    p = Person.new
+    p.first_name     = object_properties[:first_name]
+    p.middle_name    = object_properties[:middle_name]
+    p.last_name      = object_properties[:last_name]
+    p.birthday       = object_properties[:birthday]
+    p.favorite_color = object_properties[:favorite_color]
+
+    collection << p
+  end
+
+  $collection = collection.dup
+end
+
+Then /^my monosheet should look like:$/ do |expected_monosheet|
+  Monosheet::output_table($collection) do |t|
+    t.column :first_name
+    t.column :middle_name
+    t.column :last_name
+    t.column :birthday
+    t.column :favorite_color
+  end
+
+  Monosheet::output_table.render.should == expected_monosheet
+end
+

data/lib/monosheet.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'active_support'
+
+class String; include ActiveSupport::Inflector; end
+String.extend(ActiveSupport::Inflector)
+
+require "monosheet/inheritable_attributes"
+require "monosheet/api"
+require "monosheet/output_table"

data/lib/monosheet/api.rb

@@ -0,0 +1,31 @@
+require "active_support/core_ext/string/inflections"
+
+module Monosheet 
+
+  def Monosheet::output_table(data_source = nil)
+    return @output_table if data_source.nil?
+
+    @output_table = Monosheet::OutputTable.new(data_source)
+    yield(@output_table) if block_given?
+  end
+
+end
+
+module Monosheet::ObjectRenderer
+  def render(column_sizes)
+    rendered = "| "
+    @columns_to_render.each_with_index do |column, index|
+      if self.send(column.to_sym).is_a? Integer
+        rendered << self.send(column.to_sym).to_s.rjust(column_sizes[index])
+      else
+        rendered << self.send(column.to_sym).to_s.ljust(column_sizes[index])
+      end
+      rendered << " | "
+    end
+    rendered.strip
+  end
+
+  def set_columns_to_render(columns)
+    @columns_to_render = columns
+  end
+end

data/lib/monosheet/inheritable_attributes.rb

@@ -0,0 +1,25 @@
+module ClassLevelInheritableAttributes
+  def self.included(base)
+    base.extend(ClassMethods)    
+  end
+  
+  module ClassMethods
+    def inheritable_attributes(*args)
+      @inheritable_attributes = [:inheritable_attributes] unless @inheritable_attributes.is_a? Array
+      @inheritable_attributes += args
+      args.each do |arg|
+        class_eval %(
+          class << self; attr_accessor :#{arg} end
+        )
+      end
+      @inheritable_attributes
+    end
+    
+    def inherited(subclass)
+      @inheritable_attributes.each do |inheritable_attribute|
+        instance_var = "@#{inheritable_attribute}"
+        subclass.instance_variable_set(instance_var, instance_variable_get(instance_var))
+      end
+    end
+  end
+end

data/lib/monosheet/output_table.rb

@@ -0,0 +1,47 @@
+require "monosheet/output_table_header_row"
+require "monosheet/output_table_row_divider"
+
+class Monosheet::OutputTable
+  
+  def initialize(data_source)
+    @data_source = data_source
+    @columns = []
+    @row_divider_class = Class.new(Monosheet::OutputTableRowDivider)
+  end
+
+  def column(name)
+    return unless @data_source.respond_to?(:size) && @data_source.size > 0
+    @columns << name.to_sym
+  end
+
+  def render
+    output_items = [@row_divider_class.new("=")]
+    output_items << Monosheet::OutputTableHeaderRow.new(initialize_column_sizes_and_get_column_titles)
+    output_items << @row_divider_class.new("=")
+
+    @data_source.each do |data_item|
+      @columns.each_with_index do |column_key, index|
+        if data_item.send(column_key.to_sym).to_s.size > @row_divider_class.column_size[index]
+          @row_divider_class.column_size[index] = data_item.send(column_key.to_sym).to_s.size
+        end
+      end
+
+      data_item.extend Monosheet::ObjectRenderer
+      data_item.set_columns_to_render @columns
+
+      output_items << data_item
+      output_items << @row_divider_class.new
+    end
+
+    output_items.map { |item| item.render @row_divider_class.column_size }.join("\n")
+  end
+
+private
+
+  def initialize_column_sizes_and_get_column_titles
+    column_titles = @columns.map { |c| c.to_s.titleize }
+    @row_divider_class.column_size = column_titles.map { |t| t.size }
+    column_titles
+  end
+
+end

data/lib/monosheet/output_table_header_row.rb

@@ -0,0 +1,14 @@
+class Monosheet::OutputTableHeaderRow
+  attr_accessor :column_names
+  def initialize(column_names)
+    @column_names = column_names
+  end
+
+  def render(column_sizes)
+    rendered = ":"
+    @column_names.each_with_index do |name, index|
+      rendered << " #{ name.center column_sizes[index] } :"
+    end
+    rendered
+  end
+end

data/lib/monosheet/output_table_row_divider.rb

@@ -0,0 +1,17 @@
+class Monosheet::OutputTableRowDivider
+  include ClassLevelInheritableAttributes
+  inheritable_attributes :column_size 
+  @column_size = []
+
+  def initialize(line_char="-")
+    @line_char = line_char 
+  end
+
+  def render(*args) # ugly temporary hack because of the contract-by-design thing I've got going on with the "render" method
+    divider_output = "+"
+    self.class.column_size.each do |column_width_in_characters|
+      divider_output << "#{@line_char}#{@line_char * column_width_in_characters}#{@line_char}+"
+    end
+    divider_output
+  end
+end

data/monosheet.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+
+  s.name = %q{monosheet}
+  s.version = "0.9.0"
+  s.add_dependency 'activesupport', '~> 3.0.0'
+  s.add_development_dependency 'rspec', '~> 2.0.0'
+  s.add_development_dependency 'cucumber', '~> 0.9.0'
+
+  s.authors = ["Jesse Trimble"]
+  s.email = %q{jesseltrimble@gmail.com}
+  s.homepage = %q{http://github.com/jtrim/monosheet}
+
+  s.date = %q{2010-11-04}
+  s.description = %q{Give monosheet an array of objects, it gives you back a human-readable table that outputs nicely in monospace font.}
+  s.summary = %q{Easy, monospace output of tabular data.}
+
+  s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "lib/monosheet.rb", "lib/monosheet/api.rb", "lib/monosheet/inheritable_attributes.rb", "lib/monosheet/output_table.rb", "lib/monosheet/output_table_header_row.rb", "lib/monosheet/output_table_row_divider.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.rdoc", "Rakefile", "features/monosheet.feature", "features/support/person.rb", "features/support/steps.rb", "lib/monosheet.rb", "lib/monosheet/api.rb", "lib/monosheet/inheritable_attributes.rb", "lib/monosheet/output_table.rb", "lib/monosheet/output_table_header_row.rb", "lib/monosheet/output_table_row_divider.rb", "monosheet.gemspec", "spec/header_row_spec.rb", "spec/row_divider_spec.rb"]
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Monosheet", "--main", "README.rdoc"]
+  s.require_path = "lib"
+  s.rubygems_version = %q{1.3.7}
+
+end

data/spec/header_row_spec.rb

@@ -0,0 +1,15 @@
+require "lib/monosheet"
+
+describe Monosheet::OutputTableHeaderRow, "initialize" do
+  it "should allow for the setting of column names in the constructor" do
+    header_row = Monosheet::OutputTableHeaderRow.new(["One", "Two", "Three"])
+    header_row.column_names.should == ["One", "Two", "Three"]
+  end
+end
+
+describe Monosheet::OutputTableHeaderRow, "render" do
+  it "should render a proper table header with centered column names, given column sizes" do
+    header_row = Monosheet::OutputTableHeaderRow.new(["One", "Two", "Three"])
+    header_row.render([10, 5, 8]).should == ":    One     :  Two  :  Three   :"
+  end
+end

data/spec/row_divider_spec.rb

@@ -0,0 +1,35 @@
+require "lib/monosheet"
+
+describe Monosheet::OutputTableRowDivider, "column_size" do
+  it "should allow the setting of column sizes" do
+    Monosheet::OutputTableRowDivider.column_size = [5,5,5]
+    Monosheet::OutputTableRowDivider.column_size.should == [5,5,5]
+  end
+end
+
+describe Monosheet::OutputTableRowDivider, "render" do
+  it "should output the correctly sized table row divider" do
+    Monosheet::OutputTableRowDivider.new.render.should == "+-------+-------+-------+"
+  end
+end
+
+RowDividerSubclass = Class.new(Monosheet::OutputTableRowDivider)
+describe RowDividerSubclass, "column_size" do
+  it "should allow the setting of column sizes that are different than the parent class" do
+    RowDividerSubclass.column_size = [5,4,3]
+    RowDividerSubclass.column_size.should == [5,4,3]
+
+    Monosheet::OutputTableRowDivider.column_size.should == [5,5,5]
+  end
+end
+
+describe RowDividerSubclass, "render" do
+  it "should output the correctly sized table row divider that's different than the super class" do
+    RowDividerSubclass.new.render.should == "+-------+------+-----+"
+    Monosheet::OutputTableRowDivider.new.render.should == "+-------+-------+-------+"
+  end
+
+  it "should support specifying a different divider character in the constructor" do
+    RowDividerSubclass.new("$").render.should == "+$$$$$$$+$$$$$$+$$$$$+"
+  end
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification 
+name: monosheet
+version: !ruby/object:Gem::Version 
+  hash: 59
+  prerelease: false
+  segments: 
+  - 0
+  - 9
+  - 0
+  version: 0.9.0
+platform: ruby
+authors: 
+- Jesse Trimble
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-04 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 9
+        - 0
+        version: 0.9.0
+  type: :development
+  version_requirements: *id003
+description: Give monosheet an array of objects, it gives you back a human-readable table that outputs nicely in monospace font.
+email: jesseltrimble@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- LICENSE
+- README.rdoc
+- lib/monosheet.rb
+- lib/monosheet/api.rb
+- lib/monosheet/inheritable_attributes.rb
+- lib/monosheet/output_table.rb
+- lib/monosheet/output_table_header_row.rb
+- lib/monosheet/output_table_row_divider.rb
+files: 
+- CHANGELOG
+- LICENSE
+- Manifest
+- README.rdoc
+- Rakefile
+- features/monosheet.feature
+- features/support/person.rb
+- features/support/steps.rb
+- lib/monosheet.rb
+- lib/monosheet/api.rb
+- lib/monosheet/inheritable_attributes.rb
+- lib/monosheet/output_table.rb
+- lib/monosheet/output_table_header_row.rb
+- lib/monosheet/output_table_row_divider.rb
+- monosheet.gemspec
+- spec/header_row_spec.rb
+- spec/row_divider_spec.rb
+has_rdoc: true
+homepage: http://github.com/jtrim/monosheet
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Monosheet
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Easy, monospace output of tabular data.
+test_files: 
+- features/monosheet.feature
+- features/support/person.rb
+- features/support/steps.rb
+- spec/header_row_spec.rb
+- spec/row_divider_spec.rb