tableficate 0.1.3 → 0.2.0

data/lib/tableficate/table.rb

@@ -1,6 +1,6 @@
 module Tableficate
   class Table
-    attr_reader :columns, :rows, :current_sort, :filters, :options, :as
+    attr_reader :columns, :rows, :current_sort, :filters, :options, :as, :template
 
     def initialize(template, rows, options, data)
       @template = template
@@ -25,24 +25,70 @@ module Tableficate
       @columns.push(Column.new(self, name, options, &block))
     end
 
-    def actions(options = {}, &block)
-      @columns.push(ActionColumn.new(self, options, block))
+    def actions(&block)
+      @columns.push(ActionColumn.new(self, &block))
     end
 
     def show_sort?
       self.columns.any?{|column| column.show_sort?}
     end
 
-    def input_filter(name, options = {})
-      @filters.push(InputFilter.new(self, name, options))
-    end
+    def filter(name, options = {})
+      as_map = {
+        :'datetime-local' => Filter::Input,
+        text:     Filter::Input,
+        email:    Filter::Input,
+        url:      Filter::Input,
+        tel:      Filter::Input,
+        number:   Filter::Input,
+        range:    Filter::Input,
+        date:     Filter::Input,
+        month:    Filter::Input,
+        week:     Filter::Input,
+        time:     Filter::Input,
+        datetime: Filter::Input,
+        search:   Filter::Input,
+        color:    Filter::Input,
+        select:   Filter::Select,
+        radio:    Filter::Radio,
+        checkbox: Filter::CheckBox
+      }
+
+      as = options.delete(:as) || (options[:collection] ? :select : :text)
+
+      raise Filter::UnknownInputType if as_map[as].nil?
+
+      options[:type] = as.to_s
 
-    def input_range_filter(name, options = {})
-      @filters.push(InputRangeFilter.new(self, name, options))
+      @filters.push(as_map[as].new(self, name, options))
     end
 
-    def select_filter(name, choices, options = {})
-      @filters.push(SelectFilter.new(self, name, choices, options))
+    def filter_range(name, options = {})
+      as_map = {
+        :'datetime-local' => Filter::InputRange,
+        text:     Filter::InputRange,
+        email:    Filter::InputRange,
+        url:      Filter::InputRange,
+        tel:      Filter::InputRange,
+        number:   Filter::InputRange,
+        range:    Filter::InputRange,
+        date:     Filter::InputRange,
+        month:    Filter::InputRange,
+        week:     Filter::InputRange,
+        time:     Filter::InputRange,
+        datetime: Filter::InputRange,
+        search:   Filter::InputRange,
+        color:    Filter::InputRange,
+        select:   Filter::SelectRange
+      }
+
+      as = options.delete(:as) || (options[:collection] ? :select : :text)
+
+      raise Filter::UnknownInputType if as_map[as].nil?
+
+      options[:type] = as.to_s
+
+      @filters.push(as_map[as].new(self, name, options))
     end
 
     def render(options = {})

data/lib/tableficate/version.rb

@@ -1,3 +1,3 @@
 module Tableficate
-  VERSION = '0.1.3'
+  VERSION = "0.2.0"
 end

data/lib/tableficate.rb

@@ -4,9 +4,15 @@ require 'tableficate/utils'
 require 'tableficate/finder'
 require 'tableficate/column'
 require 'tableficate/action_column'
-require 'tableficate/filters/filter'
-require 'tableficate/filters/input_filters'
-require 'tableficate/filters/select_filter'
+require 'tableficate/filters/collection'
+require 'tableficate/filters/choice'
+require 'tableficate/filters/base'
+require 'tableficate/filters/input'
+require 'tableficate/filters/input_range'
+require 'tableficate/filters/select'
+require 'tableficate/filters/select_range'
+require 'tableficate/filters/radio'
+require 'tableficate/filters/check_box'
 require 'tableficate/table'
 require 'tableficate/helper'
 require 'tableficate/base'

data/spec/action_column_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Tableficate::ActionColumn do
   before(:all) do
-    @action_column = Tableficate::ActionColumn.new(nil, nil) do
+    @action_column = Tableficate::ActionColumn.new(nil) do
       Actions!
     end
   end

data/spec/column_spec.rb

@@ -23,6 +23,14 @@ describe Tableficate::Column do
 
     column.value(row).should == 'Norman Borlaug'
   end
+  it 'should not escape html in block outputs' do
+    row = NobelPrizeWinner.find_by_first_name_and_last_name('Norman', 'Borlaug')
+    column = Tableficate::Column.new(nil, :full_name) do |row|
+      [row.first_name, row.last_name].join('<br/>')
+    end
+
+    ERB::Util::html_escape(column.value(row)).should == 'Norman<br/>Borlaug'
+  end
 
   it 'should allow sorting to be turned on and off' do
     column = Tableficate::Column.new(nil, :first_name, show_sort: false)

data/spec/filters/base_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Tableficate::Filter::Base do
+  before(:all) do
+    @table = Tableficate::Table.new(nil, NobelPrizeWinner.limit(1), {}, {})
+    @table.column(:first_name, header: 'Given Name')
+  end
+
+  it 'should find the correct template type' do
+    Tableficate::Filter::Base.new(@table, :first_name).template.should == 'filters/base'
+  end
+
+  it 'should use the provided label or default to the column header' do
+    Tableficate::Filter::Base.new(@table, :first_name).label.should == 'Given Name'
+    Tableficate::Filter::Base.new(@table, :first_name, label: 'First').label.should == 'First'
+  end
+
+  it 'should provide a field name' do
+    Tableficate::Filter::Base.new(@table, :first_name).field_name.should == "#{@table.as}[filter][first_name]"
+  end
+
+  it 'should provide a field value when given params or a blank value' do
+    Tableficate::Filter::Base.new(@table, :first_name).field_value({filter: {first_name: 'Aaron'}}).should == 'Aaron'
+    Tableficate::Filter::Base.new(@table, :first_name).field_value({}).should == ''
+  end
+
+  it 'should allow for filters that do not match a particular field' do
+    Tableficate::Filter::Base.new(@table, :custom_field).label.should == 'Custom Field'
+  end
+end

data/spec/filters/choice_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe Tableficate::Filter::Choice do
+  it 'should mark a choice as selected if it has a :selected or :checked option' do
+    choice = Tableficate::Filter::Choice.new('foo', 'bar', {selected: 'selected'})
+    choice.selected?.should be true
+    choice.options[:selected].should be nil
+
+    choice = Tableficate::Filter::Choice.new('foo', 'bar', {checked: 'checked'})
+    choice.checked?.should be true
+    choice.options[:checked].should be nil
+  end
+end

data/spec/filters/collection_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe Tableficate::Filter::Collection do
+  it 'allows for a collection to accept a range' do
+    collection = Tableficate::Filter::Collection.new(1..3)
+
+    1.upto(3) do |i|
+      index = i - 1
+      collection[index].name.should == i
+      collection[index].value.should == i
+      collection[index].selected?.should be false
+    end
+  end
+
+  it 'allows for a collection to accept a hash' do
+    h = {one: 1, two: 2, three: 3}
+
+    collection = Tableficate::Filter::Collection.new(h)
+
+    i = 0
+    h.each do |key, value|
+      collection[i].name.should == key
+      collection[i].value.should == value
+      collection[i].selected?.should be false
+      i += 1
+    end
+  end
+
+  it 'allows for a collection to accept an array' do
+    a = [*1..3]
+
+    collection = Tableficate::Filter::Collection.new(a)
+
+    1.upto(3) do |i|
+      index = i - 1
+      collection[index].name.should == i
+      collection[index].value.should == i
+      collection[index].selected?.should be false
+    end
+  end
+
+  it 'allows for a collection to accept a nested array' do
+    a = [[:one, 1], [:two, 2], [:three, 3]]
+
+    collection = Tableficate::Filter::Collection.new(a)
+
+    0.upto(2) do |i|
+      key, value = a[i]
+      collection[i].name.should == key
+      collection[i].value.should == value
+      collection[i].selected?.should be false
+    end
+  end
+
+  it 'should mark choices as selected based on the :selected option' do
+    a = [*1..3]
+
+    collection = Tableficate::Filter::Collection.new(a, selected: 2)
+
+    1.upto(3) do |i|
+      collection[i - 1].selected?.should be (i == 2)
+    end
+
+    collection = Tableficate::Filter::Collection.new(a, selected: [2, 3])
+
+    1.upto(3) do |i|
+      collection[i - 1].selected?.should be (i == 2 or i == 3)
+    end
+  end
+
+  it 'should mark choices as disabled based on the :disabled option' do
+    a = [*1..3]
+
+    collection = Tableficate::Filter::Collection.new(a, disabled: 2)
+
+    1.upto(3) do |i|
+      if i == 2
+        collection[i - 1].options[:disabled].should == 'disabled'
+      else
+        collection[i - 1].options.has_key?(:disabled).should be false
+      end
+    end
+
+    collection = Tableficate::Filter::Collection.new(a, disabled: [2, 3])
+
+    1.upto(3) do |i|
+      if i == 2 or i == 3
+        collection[i - 1].options[:disabled].should == 'disabled'
+      else
+        collection[i - 1].options.has_key?(:disabled).should be false
+      end
+    end
+  end
+end

data/spec/filters/input_range_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Tableficate::Filter::InputStart do
+  before(:each) do
+    template = mock('Template')
+    template.stub!(:lookup_context).and_return(ActionView::LookupContext.new([]))
+    template.lookup_context.stub!(:exists?).and_return(true)
+    @table = Tableficate::Table.new(template, NobelPrizeWinner.joins(:nobel_prizes).limit(1), {}, {})
+    @table.column(:year)
+  end
+
+  it 'should append "[start]" to field_name' do
+    Tableficate::Filter::InputStart.new(@table, :year).field_name == "#{@table.as}[filter][year][start]"
+  end
+
+  it 'should append "_start" to the name' do
+    Tableficate::Filter::InputStart.new(@table, :year).name == :year_start
+  end
+
+  it 'should provide a field value when given params or a blank value' do
+    Tableficate::Filter::InputStart.new(@table, :year).field_value({filter: {year: {start: '2011'}}}).should == '2011'
+    Tableficate::Filter::InputStart.new(@table, :year).field_value({}).should == ''
+  end
+end
+
+describe Tableficate::Filter::InputStop do
+  before(:each) do
+    template = mock('Template')
+    template.stub!(:lookup_context).and_return(ActionView::LookupContext.new([]))
+    template.lookup_context.stub!(:exists?).and_return(true)
+    @table = Tableficate::Table.new(template, NobelPrizeWinner.joins(:nobel_prizes).limit(1), {}, {})
+    @table.column(:year)
+  end
+
+  it 'should append "[stop]" to field_name' do
+    Tableficate::Filter::InputStop.new(@table, :year).field_name == "#{@table.as}[filter][year][stop]"
+  end
+
+  it 'should append "_stop" to the name' do
+    Tableficate::Filter::InputStop.new(@table, :year).name == :year_stop
+  end
+
+  it 'should provide a field value when given params or a blank value' do
+    Tableficate::Filter::InputStop.new(@table, :year).field_value({filter: {year: {stop: '2011'}}}).should == '2011'
+    Tableficate::Filter::InputStop.new(@table, :year).field_value({}).should == ''
+  end
+end
+
+describe Tableficate::Filter::InputRange do
+  before(:each) do
+    template = mock('Template')
+    template.stub!(:lookup_context).and_return(ActionView::LookupContext.new([]))
+    @table = Tableficate::Table.new(template, NobelPrizeWinner.joins(:nobel_prizes).limit(1), {}, {})
+    @table.column(:year)
+  end
+
+  it 'should create a start and stop input' do
+    @table.template.lookup_context.stub!(:exists?).and_return(true)
+
+    filter = Tableficate::Filter::InputRange.new(@table, :year)
+
+    filter.start.is_a?(Tableficate::Filter::InputStart).should be true
+    filter.stop.is_a?(Tableficate::Filter::InputStop).should be true
+  end
+
+  it 'should use the :start and :stop option hashes for the individual filters and default any values not passed to the range options provided' do
+    @table.template.lookup_context.stub!(:exists?).and_return(true)
+
+    filter = Tableficate::Filter::InputRange.new(@table, :year, label: 'Nobel Prize Won In')
+    filter.start.label.should == 'Nobel Prize Won In'
+    filter.stop.label.should == 'Nobel Prize Won In'
+
+    filter = Tableficate::Filter::InputRange.new(@table, :year, label: 'Nobel Prize Won In', start: {label: 'Nobel Prize Won Between'}, stop: {label: 'and'})
+    filter.start.label.should == 'Nobel Prize Won Between'
+    filter.stop.label.should == 'and'
+  end
+
+  it 'should look for a partial based on the input range type and use it if found' do
+    @table.template.lookup_context.stub(:exists?).and_return(true)
+
+    Tableficate::Filter::InputRange.new(@table, :year, type: 'search').template.should == 'filters/input_range_search'
+  end
+
+  it 'should look for a partial based on the input range type and use the default if it is not found' do
+    @table.template.lookup_context.should_receive(:exists?) do |*args|
+      (args.first == 'tableficate/filters/input_range' or args.first == 'tableficate/filters/input')
+    end.at_least(:once)
+
+    Tableficate::Filter::InputRange.new(@table, :year, type: 'search').template.should == 'filters/input_range'
+  end
+end

data/spec/filters/input_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe Tableficate::Filter::Input do
+  before(:each) do
+    template = mock('Template')
+    template.stub!(:lookup_context).and_return(ActionView::LookupContext.new([]))
+    @table = Tableficate::Table.new(template, NobelPrizeWinner.joins(:nobel_prizes).limit(1), {}, {})
+    @table.column(:first_name)
+  end
+
+  it 'should look for a partial based on the input type and use it if found' do
+    @table.template.lookup_context.stub(:exists?).and_return(true)
+
+    Tableficate::Filter::Input.new(@table, :first_name, type: 'search').template.should == 'filters/input_search'
+  end
+
+  it 'should look for a partial based on the input type and use the default if it is not found' do
+    @table.template.lookup_context.should_receive(:exists?) do |*args|
+      (args.first == 'tableficate/filters/input')
+    end
+
+    Tableficate::Filter::Input.new(@table, :first_name, type: 'search').template.should == 'filters/input'
+  end
+end

data/spec/generators/tableficate_table_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+require 'genspec'
+
+describe 'tableficate:table' do
+  with_args :foo do
+    it 'should generate app/tables/foo.rb' do
+      subject.should generate('app/tables/foo.rb') { |content|
+        content.should =~ /class Foo < Tableficate\:\:Base/
+      }
+    end
+  end
+
+  with_args :foo, :bars do
+    it 'should generate app/tables/foo.rb' do
+      subject.should generate('app/tables/foo.rb') { |content|
+        content.should =~ /scope \:bars/
+      }
+    end
+  end
+end

data/spec/generators/tableficate_theme_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'genspec'
+
+describe 'tableficate:theme' do
+  with_args :foo do
+    it 'should generate app/views/tableficate/foo/ with all files' do
+      subject.should generate('app/views/tableficate/foo')
+      subject.should generate('app/views/tableficate/foo/_table.html.erb')
+    end
+  end
+end

data/spec/helper_spec.rb

@@ -0,0 +1,164 @@
+require 'spec_helper'
+include Tableficate::Helper
+
+describe Tableficate::Helper, type: :request do
+  describe 'tableficate_select_tag' do
+    it 'allows for a collection to accept a string' do
+      visit '/filters/select_from_string'
+      page.should have_xpath("//select[@id='nobel_prize_winners_filter_category']/option[text()='Peace']")
+    end
+
+    it 'selects an option from the params when the collection is a string' do
+      visit '/filters/select_from_string?nobel_prize_winners[filter][category]=Peace'
+      page.should have_xpath("//select[@id='nobel_prize_winners_filter_category']/option[text()='Peace'][@selected='selected']")
+    end
+
+    it 'should display a multi select box from a string' do
+      visit '/filters/multi_select_from_string'
+
+      ['Chemistry', 'Literature', 'Peace', 'Physics', 'Physiology or Medicine'].each do |category|
+        page.should have_xpath("//select[@id='nobel_prize_winners_filter_category']/option[text()='#{category}']")
+        page.should have_no_xpath("//select[@id='nobel_prize_winners_filter_category']/option[text()='#{category}'][@selected='selected']")
+      end
+    end
+
+    it 'should display a multi select box and select an option' do
+      visit '/filters/multi_select_from_string?nobel_prize_winners[filter][category][]=Peace&nobel_prize_winners[filter][category][]=Literature'
+
+      ['Chemistry', 'Literature', 'Peace', 'Physics', 'Physiology or Medicine'].each do |category|
+        page.should have_xpath("//select[@id='nobel_prize_winners_filter_category']/option[text()='#{category}']")
+        if category == 'Peace' or category == 'Literature'
+          page.should have_xpath("//select[@id='nobel_prize_winners_filter_category']/option[text()='#{category}'][@selected='selected']")
+        else
+          page.should have_no_xpath("//select[@id='nobel_prize_winners_filter_category']/option[text()='#{category}'][@selected='selected']")
+        end
+      end
+    end
+
+    it 'should display a select box' do
+      visit '/filters/select_tag'
+
+      ['Chemistry', 'Literature', 'Peace', 'Physics', 'Physiology or Medicine'].each do |category|
+        page.should have_xpath("//select[@id='nobel_prize_winners_filter_category']/option[@value='#{category}']")
+        page.should have_no_xpath("//select[@id='nobel_prize_winners_filter_category']/option[@value='#{category}'][@selected='selected']")
+      end
+    end
+
+    it 'should display a select box and select an option' do
+      visit '/filters/select_tag?nobel_prize_winners[filter][category]=Peace'
+
+      ['Chemistry', 'Literature', 'Peace', 'Physics', 'Physiology or Medicine'].each do |category|
+        page.should have_xpath("//select[@id='nobel_prize_winners_filter_category']/option[@value='#{category}']")
+        if category == 'Peace'
+          page.should have_xpath("//select[@id='nobel_prize_winners_filter_category']/option[@value='#{category}'][@selected='selected']")
+        else
+          page.should have_no_xpath("//select[@id='nobel_prize_winners_filter_category']/option[@value='#{category}'][@selected='selected']")
+        end
+      end
+    end
+
+    it 'should display a multi select box' do
+      visit '/filters/multi_select_tag'
+
+      ['Chemistry', 'Literature', 'Peace', 'Physics', 'Physiology or Medicine'].each do |category|
+        page.should have_xpath("//select[@id='nobel_prize_winners_filter_category']/option[@value='#{category}']")
+        page.should have_no_xpath("//select[@id='nobel_prize_winners_filter_category']/option[@value='#{category}'][@selected='selected']")
+      end
+    end
+
+    it 'should display a select box and select an option' do
+      visit '/filters/multi_select_tag?nobel_prize_winners[filter][category][]=Peace&nobel_prize_winners[filter][category][]=Literature'
+
+      ['Chemistry', 'Literature', 'Peace', 'Physics', 'Physiology or Medicine'].each do |category|
+        page.should have_xpath("//select[@id='nobel_prize_winners_filter_category']/option[@value='#{category}']")
+        if category == 'Peace' or category == 'Literature'
+          page.should have_xpath("//select[@id='nobel_prize_winners_filter_category']/option[@value='#{category}'][@selected='selected']")
+        else
+          page.should have_no_xpath("//select[@id='nobel_prize_winners_filter_category']/option[@value='#{category}'][@selected='selected']")
+        end
+      end
+    end
+  end
+
+  describe 'tableficate_radio_tags' do
+    it 'takes a block for custom output' do
+      visit '/filters/radio_tags?theme=custom_radio_block'
+
+      page.html.should match /<label for="nobel_prize_winners_filter_category_Chemistry">Chemistry<\/label>\s*<input id="nobel_prize_winners_filter_category_Chemistry" name="nobel_prize_winners\[filter\]\[category\]" type="radio" value="Chemistry">/
+    end
+
+    it 'should display a group of radio tags with no selection and nothing filtered' do
+      visit '/filters/radio_tags'
+
+      ['Chemistry', 'Literature', 'Peace', 'Physics', 'Physiology or Medicine'].each do |category|
+        id = "nobel_prize_winners_filter_category_#{category.gsub(/ /, '_')}"
+
+        page.should have_xpath("//input[@type='radio'][@id='#{id}'][@value='#{category}']")
+
+        page.has_no_checked_field?(id).should be true
+      end
+
+      page.should have_xpath('//table/tbody/tr', count: NobelPrizeWinner.joins(:nobel_prizes).size)
+    end
+
+    it 'should display a group of radio tags with a selection and the table filtered' do
+      selected_category = 'Peace'
+      visit "/filters/radio_tags?nobel_prize_winners[filter][category]=#{selected_category}"
+
+      ['Chemistry', 'Literature', 'Peace', 'Physics', 'Physiology or Medicine'].each do |category|
+        id = "nobel_prize_winners_filter_category_#{category.gsub(/ /, '_')}"
+
+        page.should have_xpath("//input[@type='radio'][@id='#{id}'][@value='#{category}']")
+
+        if category == selected_category
+          page.has_checked_field?(id).should be true
+        else
+          page.has_no_checked_field?(id).should be true
+        end
+      end
+
+      page.should have_xpath('//table/tbody/tr', count: NobelPrizeWinner.joins(:nobel_prizes).where('nobel_prizes.category = ?', selected_category).size)
+    end
+  end
+
+  describe 'tableficate_check_box_tags' do
+    it 'takes a block for custom output' do
+      visit '/filters/check_box_tags?theme=custom_check_box_block'
+
+      page.html.should match /<label for="nobel_prize_winners_filter_category_Chemistry">Chemistry<\/label>\s*<input id="nobel_prize_winners_filter_category_Chemistry" name="nobel_prize_winners\[filter\]\[category\]\[\]" type="checkbox" value="Chemistry">/
+    end
+
+    it 'should display a group of check box tags with no selection and nothing filtered' do
+      visit '/filters/check_box_tags'
+
+      ['Chemistry', 'Literature', 'Peace', 'Physics', 'Physiology or Medicine'].each do |category|
+        id = "nobel_prize_winners_filter_category_#{category.gsub(/ /, '_')}"
+
+        page.should have_xpath("//input[@type='checkbox'][@id='#{id}'][@value='#{category}']")
+
+        page.has_no_checked_field?(id).should be true
+      end
+
+      page.should have_xpath('//table/tbody/tr', count: NobelPrizeWinner.joins(:nobel_prizes).size)
+    end
+
+    it 'should display a group of check box tags with a selection and the table filtered' do
+      selected_category = 'Peace'
+      visit "/filters/check_box_tags?nobel_prize_winners[filter][category]=#{selected_category}"
+
+      ['Chemistry', 'Literature', 'Peace', 'Physics', 'Physiology or Medicine'].each do |category|
+        id = "nobel_prize_winners_filter_category_#{category.gsub(/ /, '_')}"
+
+        page.should have_xpath("//input[@type='checkbox'][@id='#{id}'][@value='#{category}']")
+
+        if category == selected_category
+          page.has_checked_field?(id).should be true
+        else
+          page.has_no_checked_field?(id).should be true
+        end
+      end
+
+      page.should have_xpath('//table/tbody/tr', count: NobelPrizeWinner.joins(:nobel_prizes).where('nobel_prizes.category = ?', selected_category).size)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
 ENV["RAILS_ENV"] ||= 'test'
 
 require File.expand_path("../test_app/config/environment", __FILE__)
+
+require 'capybara/rspec'
+require 'capybara/rails'