table_print 0.2.3 → 1.0.0.rc3

data/spec/column_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'column'
+
+include TablePrint
+
+describe Column do
+  let(:c) {Column.new(:data => ["Once upon a time", "there was a dark and stormy night"], :name => :tagline)}
+
+  it "remembers its name as a string" do
+    c.name.should == "tagline"
+  end
+
+  it "exposes the array of data representing the column" do
+    c.data.should == ["Once upon a time", "there was a dark and stormy night"]
+  end
+
+  describe "#add_formatter" do
+    it "stores the formatter" do
+      f = {}
+      c.add_formatter(f)
+      c.formatters.should == [f]
+    end
+  end
+
+  describe "#formatter=" do
+    it "adds the formatters individually" do
+      c.should_receive(:add_formatter).twice
+      c.formatters = [{}, {}]
+    end
+  end
+
+  describe "#display_method" do
+    it "stores the column's display method as a string" do
+      c = Column.new(:display_method => :boofar)
+      c.display_method.should == "boofar"
+    end
+
+    it "doesn't turn a lambda display method into a string" do
+      lam = lambda{}
+      c = Column.new(:display_method => lam)
+      c.display_method.should == lam
+    end
+
+    it "defaults to the column name" do
+      c = Column.new(:name => :boofar)
+      c.display_method.should == "boofar"
+    end
+  end
+
+  describe "#data_width" do
+    it "reflects the width of the data set" do
+      c.data_width.should == 33
+    end
+
+    it "includes the title in the calculation" do
+      c.name = "a horse is a horse of course of course"
+      c.data_width.should == 38
+    end
+  end
+
+  describe "#width" do
+    it "returns the specified width" do
+      c.width = 14
+      c.width.should == 14
+    end
+
+    it "uses the data_width if no width has been set" do
+      c.width.should == 33
+    end
+  end
+end

data/spec/config_resolver_spec.rb

@@ -0,0 +1,236 @@
+require 'spec_helper'
+require 'config_resolver'
+
+describe TablePrint::ConfigResolver do
+
+  #it "starts with the specified config" do
+  #  Sandbox.add_class("Configged")
+  #  TablePrint::Config.set(Sandbox::Configged, [:title, :author])
+  #  c = TablePrint::ConfigResolver.new(Object, Object, [:name])
+  #  c.columns.length.should == 2
+  #  c.columns.first.name.should == 'title'
+  #  c.columns.last.name.should == 'author'
+  #end
+
+  describe "#get_and_remove" do
+    it "deletes and returns the :except key from an array" do
+      c = TablePrint::ConfigResolver.new(Object, [])
+      options = [:title, :author, {:except => [:title]}]
+      c.get_and_remove(options, :except).should == [:title]
+      options.should == [:title, :author]
+    end
+
+    it "deletes and returns the :except key from an array with an :include key" do
+      c = TablePrint::ConfigResolver.new(Object, [])
+      options = [:title, {:except => [:title]}, {:include => [:author]}]
+      c.get_and_remove(options, :except).should == [:title]
+      options.should == [:title, {:include => [:author]}]
+    end
+
+    it "deletes and returns the :except key from a hash with an :include key" do
+      c = TablePrint::ConfigResolver.new(Object, [])
+      options = [:title, {:except => [:title], :include => [:author]}]
+      c.get_and_remove(options, :except).should == [:title]
+      options.should == [:title, {:include => [:author]}]
+    end
+
+    it "deletes and returns both the :include and :except keys" do
+      c = TablePrint::ConfigResolver.new(Object, [])
+      options = [:title, {:except => [:title]}, {:include => [:author]}]
+      c.get_and_remove(options, :include).should == [:author]
+      c.get_and_remove(options, :except).should == [:title]
+      options.should == [:title]
+    end
+
+    it "works even if the array doesn't have an exception hash" do
+      c = TablePrint::ConfigResolver.new(Object, [])
+      options = [:title, :author]
+      c.get_and_remove(options, :except).should == []
+      options.should == [:title, :author]
+    end
+  end
+
+  describe ":only" do
+    context "with a symbol" do
+      it "returns a column named foo" do
+        c = TablePrint::ConfigResolver.new(Object, [:title], :foo)
+        c.columns.length.should == 1
+        c.columns.first.name.should == 'foo'
+      end
+    end
+    context "with a string" do
+      it "returns a column named foo" do
+        c = TablePrint::ConfigResolver.new(Object, [:title], 'foo')
+        c.columns.length.should == 1
+        c.columns.first.name.should == 'foo'
+      end
+    end
+    context "with an array of symbols and strings" do
+      it "returns columns named foo and bar" do
+        c = TablePrint::ConfigResolver.new(Object, [:title], :foo, 'bar')
+        c.columns.length.should == 2
+        c.columns.first.name.should == 'foo'
+        c.columns.last.name.should == 'bar'
+      end
+    end
+  end
+
+  describe ":include" do
+    context "with a symbol" do
+      it "adds foo to the list of methods" do
+        c = TablePrint::ConfigResolver.new(Object, [:title], :include => :foo)
+        c.columns.length.should == 2
+        c.columns.first.name.should == 'title'
+        c.columns.last.name.should == 'foo'
+      end
+    end
+
+    context "with an array" do
+      it "adds foo and bar to the list of methods" do
+        c = TablePrint::ConfigResolver.new(Object, [:title], :include => [:foo, :bar])
+        c.columns.length.should == 3
+        c.columns.first.name.should == 'title'
+        c.columns.last.name.should == 'bar'
+      end
+    end
+
+    context "with options" do
+      it "adds foo to the list of methods and remembers its options" do
+        c = TablePrint::ConfigResolver.new(Object, [:title], :include => {:foo => {:width => 10}})
+        c.columns.length.should == 2
+        c.columns.first.name.should == 'title'
+
+        c.columns.last.name.should == 'foo'
+        c.columns.last.width.should == 10
+      end
+    end
+  end
+
+  describe ":except" do
+    context "with a symbol" do
+      it "removes foo from the list of methods" do
+        c = TablePrint::ConfigResolver.new(Object, [:title, :foo], :except => :foo)
+        c.columns.length.should == 1
+        c.columns.first.name.should == 'title'
+      end
+    end
+    context "with an array" do
+      it "removes foo and bar from the list of methods" do
+        c = TablePrint::ConfigResolver.new(Object, [:title, :foo, :bar], :except => [:foo, 'bar'])
+        c.columns.length.should == 1
+        c.columns.first.name.should == 'title'
+      end
+    end
+  end
+
+  describe "lambdas" do
+    it "uses the key as the name and the lambda as the display method" do
+      lam = lambda {}
+      c = TablePrint::ConfigResolver.new(Object, [:title], :foo => {:display_method => lam})
+      c.columns.length.should == 1
+      c.columns.first.name.should == 'foo'
+      c.columns.first.display_method.should == lam
+    end
+
+    context "without the display_method keyword" do
+      it "uses the key as the name and the lambda as the display method" do
+        lam = lambda {}
+        c = TablePrint::ConfigResolver.new(Object, [:title], :foo => lam)
+        c.columns.length.should == 1
+        c.columns.first.name.should == 'foo'
+        c.columns.first.display_method.should == lam
+      end
+    end
+  end
+
+  describe "#usable_column_names" do
+    it "returns default columns" do
+      c = TablePrint::ConfigResolver.new(Object, [:title])
+      c.usable_column_names.should == ['title']
+    end
+
+    it "returns specified columns instead of default columns" do
+      c = TablePrint::ConfigResolver.new(Object, [:title], [:author])
+      c.usable_column_names.should == ['author']
+    end
+
+    it "applies includes on top of default columns" do
+      c = TablePrint::ConfigResolver.new(Object, [:title], [:include => :author])
+      c.usable_column_names.should == ['title', 'author']
+    end
+
+    it "applies includes on top of specified columns" do
+      c = TablePrint::ConfigResolver.new(Object, [:title], [:author, {:include => :pub_date}])
+      c.usable_column_names.should == ['author', 'pub_date']
+    end
+
+    it "applies excepts on top of default columns" do
+      c = TablePrint::ConfigResolver.new(Object, [:title, :author], [:except => :author])
+      c.usable_column_names.should == ['title']
+    end
+
+    it "applies excepts on top of specified columns" do
+      c = TablePrint::ConfigResolver.new(Object, [:title, :author], [:pub_date, :length, {:except => :length}])
+      c.usable_column_names.should == ['pub_date']
+    end
+
+    it "applies both includes and excepts on top of specified columns" do
+      c = TablePrint::ConfigResolver.new(Object, [:title, :author], [:pub_date, :length, {:except => :length, :include => :foobar}])
+      c.usable_column_names.should == ['pub_date', 'foobar']
+    end
+  end
+
+  describe "column options" do
+    context "display_method" do
+      it "sets the display method on the column" do
+        c = TablePrint::ConfigResolver.new(Object, [:title], :title => {:display_method => :boofar})
+        c.columns.length.should == 1
+        c.columns.first.name.should == 'title'
+        c.columns.first.display_method.should == "boofar"
+      end
+    end
+    context "width" do
+      it "sets the width" do
+        c = TablePrint::ConfigResolver.new(Object, [:title], :title => {:width => 100})
+        c.columns.length.should == 1
+        c.columns.first.name.should == 'title'
+        c.columns.first.width.should == 100
+      end
+    end
+    context "formatters" do
+      it "adds the formatters to the column" do
+        f1 = {}
+        f2 = {}
+        c = TablePrint::ConfigResolver.new(Object, [:title], :title => {:formatters => [f1, f2]})
+        c.columns.length.should == 1
+        c.columns.first.name.should == 'title'
+        c.columns.first.formatters.should == [f1, f2]
+      end
+    end
+  end
+
+  describe "#option_to_column" do
+    context "with a symbol" do
+      it "returns a column named foo" do
+        c = TablePrint::ConfigResolver.new(Object, [])
+        column = c.option_to_column(:foo)
+        column.name.should == 'foo'
+      end
+    end
+    context "with a string" do
+      it "returns a column named foo" do
+        c = TablePrint::ConfigResolver.new(Object, [])
+        column = c.option_to_column('foo')
+        column.name.should == 'foo'
+      end
+    end
+    context "with a hash" do
+      it "returns a column named foo and the specified options" do
+        c = TablePrint::ConfigResolver.new(Object, [])
+        column = c.option_to_column({:foo => {:width => 10}})
+        column.name.should == 'foo'
+        column.width.should == 10
+      end
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'config'
+
+describe TablePrint::Config do
+  it "defaults max_width to 30" do
+    TablePrint::Config.max_width.should == 30
+  end
+
+  it "defaults time_format to year-month-day-hour-minute-second" do
+    TablePrint::Config.time_format.should == "%Y-%m-%d %H:%M:%S"
+  end
+
+  describe "individual config options" do
+    describe "storing and retrieving" do
+      it "sets the variable" do
+        TablePrint::Config.set(:max_width, [10])
+        TablePrint::Config.max_width.should == 10
+        TablePrint::Config.set(:max_width, [30])
+      end
+    end
+
+    describe "clearing" do
+      it "resets the variable to its initial value" do
+        TablePrint::Config.set(:max_width, [10])
+        TablePrint::Config.clear(:max_width)
+        TablePrint::Config.max_width.should == 30
+      end
+    end
+  end
+
+  describe "class-based column config" do
+    before :all do
+      Sandbox.add_class("Blog")
+    end
+
+    describe "storing and retrieving" do
+      it "stores the column hash" do
+        TablePrint::Config.set(Sandbox::Blog, [:title, :author])
+        TablePrint::Config.for(Sandbox::Blog).should == [:title, :author]
+      end
+    end
+
+    describe "clearing" do
+      it "removes the class from storage" do
+        TablePrint::Config.set(Sandbox::Blog, [:title, :author])
+        TablePrint::Config.clear(Sandbox::Blog)
+        TablePrint::Config.for(Sandbox::Blog).should be_nil
+      end
+    end
+  end
+end
+

data/spec/fingerprinter_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+require 'ostruct'
+require 'fingerprinter'
+require 'column'
+
+class TablePrint::Row
+  attr_accessor :groups, :cells
+end
+
+include TablePrint
+
+describe Fingerprinter do
+
+  before(:each) do
+    Sandbox.cleanup!
+  end
+
+  describe "#lift" do
+    it "turns a single level of columns into a single row" do
+      rows = Fingerprinter.new.lift([Column.new(:name => "name")], OpenStruct.new(:name => "dale carnegie"))
+      rows.length.should == 1
+      row = rows.first
+      row.children.length.should == 0
+      row.cells.should == {'name' => "dale carnegie"}
+    end
+
+    it "uses the display_method to get the data" do
+      rows = Fingerprinter.new.lift([Column.new(:name => "name of work", :display_method => "title")], OpenStruct.new(:title => "of mice and men"))
+      rows.length.should == 1
+      row = rows.first
+      row.children.length.should == 0
+      row.cells.should == {'name of work' => "of mice and men"}
+    end
+
+    it "turns multiple levels of columns into multiple rows" do
+      rows = Fingerprinter.new.lift([Column.new(:name => "name"), Column.new(:name => "books.title")], OpenStruct.new(:name => "dale carnegie", :books => [OpenStruct.new(:title => "how to make influences")]))
+      rows.length.should == 1
+      row = rows.first
+      row.children.length.should == 1
+      row.cells.should == {'name' => "dale carnegie"}
+      row.children.first.children.first.cells.should == {'books.title' => "how to make influences"}
+    end
+
+    it "doesn't choke if an association doesn't exist" do
+      rows = Fingerprinter.new.lift([Column.new(:name => "name"), Column.new(:name => "books.title")], OpenStruct.new(:name => "dale carnegie", :books => []))
+
+      rows.length.should == 1
+
+      row = rows.first
+      row.children.length.should == 0
+    end
+
+    it "allows a lambda as the display_method" do
+      rows = Fingerprinter.new.lift([Column.new(:name => "name", :display_method => lambda { |row| row.name.gsub(/[aeiou]/, "") })], OpenStruct.new(:name => "dale carnegie"))
+      rows.length.should == 1
+      row = rows.first
+      row.children.length.should == 0
+      row.cells.should == {'name' => "dl crng"}
+    end
+  end
+
+  describe "#hash_to_rows" do
+    it "uses hashes with empty values as column names" do
+      f = Fingerprinter.new
+      f.instance_variable_set("@column_names_by_display_method", {"name" => "name"})
+      rows = f.hash_to_rows("", {'name' => {}}, OpenStruct.new(:name => "dale carnegie"))
+      rows.length.should == 1
+      row = rows.first
+      row.children.length.should == 0
+      row.cells.should == {'name' => 'dale carnegie'}
+    end
+
+    it 'recurses for subsequent levels of hash' do
+      f = Fingerprinter.new
+      f.instance_variable_set("@column_names_by_display_method", {"name" => "name", "books.title" => "books.title"})
+      rows = f.hash_to_rows("", {'name' => {}, 'books' => {'title' => {}}}, [OpenStruct.new(:name => 'dale carnegie', :books => [OpenStruct.new(:title => "hallmark")])])
+      rows.length.should == 1
+
+      top_row = rows.first
+      top_row.cells.should == {'name' => 'dale carnegie'}
+      top_row.children.length.should == 1
+      top_row.children.first.child_count.should == 1
+
+      bottom_row = top_row.children.first.children.first
+      bottom_row.cells.should == {'books.title' => 'hallmark'}
+    end
+  end
+
+  describe "#populate_row" do
+    it "fills a row by calling methods on the target object" do
+      f = Fingerprinter.new
+      f.instance_variable_set("@column_names_by_display_method", {"title" => "title", "author" => "author"})
+      row = f.populate_row("", {'title' => {}, 'author' => {}, 'publisher' => {'address' => {}}}, OpenStruct.new(:title => "foobar", :author => "bobby"))
+      row.cells.should == {'title' => "foobar", 'author' => 'bobby'}
+    end
+
+    it "uses the provided prefix to name the cells" do
+      f = Fingerprinter.new
+      f.instance_variable_set("@column_names_by_display_method", {"bar.title" => "bar.title", "bar.author" => "bar.author"})
+      row = f.populate_row("bar", {'title' => {}, 'author' => {}, 'publisher' => {'address' => {}}}, OpenStruct.new(:title => "foobar", :author => "bobby"))
+      row.cells.should == {'bar.title' => "foobar", 'bar.author' => 'bobby'}
+    end
+
+    it "uses the column name as the cell name but uses the display method to get the value" do
+      f = Fingerprinter.new
+      f.instance_variable_set("@column_names_by_display_method", {"bar.title" => "title", "bar.author" => "bar.author"})
+      row = f.populate_row("bar", {'title' => {}, 'author' => {}, 'publisher' => {'address' => {}}}, OpenStruct.new(:title => "foobar", :author => "bobby"))
+      row.cells.should == {'title' => "foobar", 'bar.author' => 'bobby'}
+    end
+  end
+
+  describe "#create_child_group" do
+    it "adds the next level of column information to the prefix" do
+      f = Fingerprinter.new
+      books = []
+
+      f.should_receive(:hash_to_rows).with("author.books", {'title' => {}}, books).and_return([])
+      groups = f.create_child_group("author", {'books' => {'title' => {}}}, OpenStruct.new(:name => "bobby", :books => books))
+      groups.length.should == 1
+      groups.first.should be_a TablePrint::RowGroup
+    end
+  end
+
+  describe "#columns_to_handle" do
+    it "returns hash keys that have an empty hash as the value" do
+      Fingerprinter.new.handleable_columns({'name' => {}, 'books' => {'title' => {}}}).should == ["name"]
+    end
+  end
+
+  describe "#columns_to_pass" do
+    it "returns hash keys that do not have an empty hash as the value" do
+      Fingerprinter.new.passable_columns({'name' => {}, 'books' => {'title' => {}}}).should == ["books"]
+    end
+  end
+
+  describe "#chain_to_nested_hash" do
+    it "turns a list of methods into a nested hash" do
+      Fingerprinter.new.display_method_to_nested_hash("books").should == {'books' => {}}
+      Fingerprinter.new.display_method_to_nested_hash("reviews.user").should == {'reviews' => {'user' => {}}}
+    end
+  end
+
+  describe "#columns_to_nested_hash" do
+    it "splits the column names into a nested hash" do
+      Fingerprinter.new.display_methods_to_nested_hash(["books.name"]).should == {'books' => {'name' => {}}}
+      Fingerprinter.new.display_methods_to_nested_hash(
+          ["books.name", "books.publisher", "reviews.rating", "reviews.user.email", "reviews.user.id"]
+      ).should == {'books' => {'name' => {}, 'publisher' => {}}, 'reviews' => {'rating' => {}, 'user' => {'email' => {}, 'id' => {}}}}
+    end
+  end
+end