datagrid 1.1.2 → 1.2.0

data/lib/datagrid/helper.rb

@@ -4,9 +4,21 @@ require "action_view"
 module Datagrid
   module Helper
 
-    # Format an value from datagrid column with given name and for given model
-    def datagrid_format_value(report, column_name, model)
-      datagrid_renderer.format_value(report, column_name, model)
+    # Returns individual cell value from the given grid, column name and model
+    # Allows to render custom HTML layout for grid data
+    #
+    #   <ul>
+    #     <% @grid.columns.each do |column|
+    #       <li><%= column.header %>: <%= datagrid_value(@grid, column.name, @resource %></li>
+    #     <% end %>
+    #   </ul>
+    #
+    def datagrid_value(grid, column_name, model)
+      datagrid_renderer.format_value(grid, column_name, model)
+    end
+
+    def datagrid_format_value(grid, column_name, model) #:nodoc:
+      datagrid_value(grid, column_name, model)
     end
 
     # Renders html table with columns defined in grid class.
@@ -24,8 +36,10 @@ module Datagrid
     # * <tt>:columns</tt> - Array of column names to display. 
     #   Used in case when same grid class is used in different places 
     #   and needs different columns. Default: all defined columns.
-    def datagrid_table(report, *args)
-      datagrid_renderer.table(report, *args)
+    # * <tt>:partials</tt> - Path for partials lookup.
+    #   Default: 'datagrid'.
+    def datagrid_table(grid, *args)
+      datagrid_renderer.table(grid, *args)
     end
 
     # Renders HTML table header for given grid instance using columns defined in it
@@ -34,23 +48,43 @@ module Datagrid
     #
     # * <tt>:order</tt> - display ordering controls built-in into header
     #   Default: true
-    #     
+    # * <tt>:partials</tt> - Path for partials lookup.
+    #   Default: 'datagrid'.
     def datagrid_header(grid, options = {})
       datagrid_renderer.header(grid, options)
     end
 
 
     # Renders HTML table rows using given grid definition using columns defined in it
-    def datagrid_rows(report, assets, options = {})
-      datagrid_renderer.rows(report, assets, options)
+    #
+    # Supported options:
+    #
+    # * <tt>:columns</tt> - Array of column names to display. 
+    #   Used in case when same grid class is used in different places 
+    #   and needs different columns. Default: all defined columns.
+    # * <tt>:partials</tt> - Path for partials lookup.
+    #   Default: 'datagrid'.
+    def datagrid_rows(grid, assets, options = {})
+      datagrid_renderer.rows(grid, assets, options)
     end
 
     # Renders ordering controls for the given column name
-    def datagrid_order_for(grid, column)
-      datagrid_renderer.order_for(grid, column)
+    #
+    # Supported options:
+    #
+    # * <tt>:partials</tt> - Path for partials lookup.
+    #   Default: 'datagrid'.
+    def datagrid_order_for(grid, column, options = {})
+      datagrid_renderer.order_for(grid, column, options)
     end
 
     # Renders HTML for for grid with all filters inputs and lables defined in it
+    #
+    # Supported options:
+    #
+    # * <tt>:partials</tt> - Path for form partial lookup.
+    #   Default: 'datagrid'.
+    # * All options supported by Rails <tt>form_for</tt> helper
     def datagrid_form_for(grid, options = {})
       datagrid_renderer.form_for(grid, options)
     end
@@ -83,7 +117,7 @@ module Datagrid
 
       def method_missing(method, *args, &blk)
         if column = @grid.column_by_name(method)
-          @context.datagrid_format_value(@grid, column, @asset)
+          @context.datagrid_value(@grid, column, @asset)
         else
           super
         end

data/lib/datagrid/renderer.rb

@@ -30,7 +30,7 @@ module Datagrid
       options[:method] ||= :get
       options[:html] ||= {}
       options[:html][:class] ||= "datagrid-form #{@template.dom_class(grid)}"
-      @template.render :partial => "datagrid/form", :locals => {:grid => grid, :options => options}
+      _render_partial('form', options[:partials], {:grid => grid, :options => options})
     end
 
     def table(grid, *args)
@@ -47,29 +47,50 @@ module Datagrid
         assets = assets.paginate(paginate)
       end
 
-      @template.render :partial => "datagrid/table", :locals => {:grid => grid, :options => options, :assets => assets}
+      _render_partial('table', options[:partials],
+                      {
+                        :grid => grid,
+                        :options => options,
+                        :assets => assets
+                      })
     end
 
     def header(grid, options = {})
       options[:order] = true unless options.has_key?(:order)
 
-      @template.render :partial => "datagrid/head", :locals => {:grid => grid, :options => options}
+      _render_partial('head', options[:partials],
+                      { :grid => grid, :options => options })
     end
 
     def rows(grid, assets, options = {})
       result = assets.map do |asset|
-        @template.render :partial => "datagrid/row", :locals => {:grid => grid, :options => options, :asset => asset}
+        _render_partial('row', options[:partials],
+                        {
+                          :grid => grid,
+                          :options => options,
+                          :asset => asset
+                        })
       end.join
 
       _safe(result)
     end
 
-    def order_for(grid, column)
-      @template.render :partial => "datagrid/order_for", :locals => { :grid => grid, :column => column }
+    def order_for(grid, column, options = {})
+      _render_partial('order_for', options[:partials],
+                      { :grid => grid, :column => column })
     end
 
+    private
+
     def _safe(string)
       string.respond_to?(:html_safe) ? string.html_safe : string
     end
+
+    def _render_partial(partial_name, partials_path, locals = {})
+      @template.render({
+        :partial => File.join(partials_path || 'datagrid', partial_name),
+        :locals => locals
+      })
+    end
   end
 end

data/spec/datagrid/column_names_attribute_spec.rb

@@ -39,6 +39,12 @@ describe Datagrid::ColumnNamesAttribute do
     subject.row_for(entry).should == ["hello", "greeting"]
   end
 
+  it "should find any column by name" do
+    subject.column_by_name(:id).should_not be_nil
+    subject.column_by_name(:name).should_not be_nil
+    subject.column_by_name(:category).should_not be_nil
+  end
+
 
   context "when default option is passed to column_names_filter" do
     let(:column_names_filter_options) do

data/spec/datagrid/columns_spec.rb

@@ -146,6 +146,7 @@ describe Datagrid::Columns do
         scope {Entry}
         column(:id, :if => :show?)
         column(:name, :unless => proc {|grid| !grid.show? })
+        column(:category)
 
         def show?
           false
@@ -153,6 +154,7 @@ describe Datagrid::Columns do
       end
       report.columns(:id).should == []
       report.columns(:name).should == []
+      report.available_columns.map(&:name).should == [:category]
     end
 
   describe ".column_names attributes" do
@@ -243,6 +245,21 @@ describe Datagrid::Columns do
       fake_assets.should_not_receive(:find_each)
       report.rows
     end
+    
+    it "should support instance level batch size" do
+      grid = test_report do
+        scope {Entry}
+        column :id
+        self.batch_size = 25
+      end
+      grid.batch_size = 0
+      fake_assets = double(:assets)
+
+      grid.should_receive(:assets) { fake_assets }
+      fake_assets.should_receive(:each)
+      fake_assets.should_not_receive(:find_each)
+      grid.rows
+    end
   end
 
   describe ".data_row" do
@@ -285,4 +302,90 @@ describe Datagrid::Columns do
       grid.row_for(group).should == [2, false]
     end
   end
+
+  describe "instance level column definition" do
+    let(:modified_grid) do
+      grid = test_report do
+        scope { Entry }
+        column(:id)
+      end
+      grid.column(:name)
+      grid
+    end 
+
+    let(:basic_grid) { modified_grid.class.new }
+    let!(:entry) { Entry.create!(:name => "Hello", :category => 'first') }
+
+    it "should have correct columns" do
+      modified_grid.columns.size.should == 2
+      basic_grid.class.columns.size.should == 1
+      basic_grid.columns.size.should == 1
+    end
+
+    it "should give correct header" do
+      modified_grid.header.should == ["Id", "Name"]
+      basic_grid.header.should == ["Id"]
+    end
+
+    it "should give correct rows" do
+      modified_grid.rows.should == [[entry.id, 'Hello']]
+      basic_grid.rows.should == [[entry.id]]
+    end
+
+    it "should support possitioning" do
+      modified_grid.column(:category, :before => :name)
+      modified_grid.header.should == ["Id", "Category", "Name"]
+    end
+
+    it "should support columns block" do
+      modified_grid.column(:category) do
+        category.capitalize
+      end
+      modified_grid.rows.should == [[entry.id, "Hello", 'First']]
+    end
+
+    it "should support column_names accessor" do
+      modified_grid.column_names = [:name]
+      modified_grid.rows.should == [['Hello']]
+      modified_grid.column_names = [:id]
+      modified_grid.rows.should == [[entry.id]]
+    end
+    it "should support column_names accessor with mandatory columns" do
+      modified_grid.column(:category, :mandatory => true)
+      modified_grid.column_names = [:name]
+      modified_grid.rows.should == [['Hello', 'first']]
+      basic_grid.column_names = [:id]
+      basic_grid.rows.should == [[entry.id]]
+    end
+
+    it "should support available columns" do
+      modified_grid.column(:category, :mandatory => true)
+      modified_grid.available_columns.map(&:name).should == [:id, :name, :category]
+    end
+
+    it "should respect column availability criteria" do
+      modified_grid.column(:category, :if => proc { false })
+      modified_grid.columns.map(&:name).should == [:id, :name]
+    end
+  end
+
+  describe 'dynamic helper' do
+    it "should work" do
+      grid = test_report do
+        scope {Entry} 
+        column(:id)
+        dynamic {
+          column(:name)
+          column(:category)
+        }
+      end
+
+      grid.columns.map(&:name).should == [:id, :name, :category]
+      grid.class.columns.map(&:name).should == [:id]
+
+      grid.column_by_name(:id).should_not be_nil
+      grid.column_by_name(:name).should_not be_nil
+    end
+  end
+
 end

data/spec/datagrid/drivers/mongo_mapper_spec.rb

@@ -1,4 +1,4 @@
-describe Datagrid::Drivers::MongoMapper do
+describe Datagrid::Drivers::MongoMapper, :mongomapper do
 
   describe ".match?" do
     

data/spec/datagrid/drivers/mongoid_spec.rb

@@ -1,4 +1,4 @@
-describe Datagrid::Drivers::Mongoid do
+describe Datagrid::Drivers::Mongoid, :mongoid do
 
   describe ".match?" do
     

data/spec/datagrid/filters/date_filter_spec.rb

@@ -16,7 +16,7 @@ describe Datagrid::Filters::DateFilter do
   end
 
   {:active_record => Entry, :mongoid => MongoidEntry}.each do |orm, klass|
-    describe "with orm #{orm}" do
+    describe "with orm #{orm}", orm => true do
       describe "date to timestamp conversion" do
         let(:klass) { klass }
         subject do

data/spec/datagrid/filters/date_time_filter_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe Datagrid::Filters::DateTimeFilter do
   {:active_record => Entry, :mongoid => MongoidEntry}.each do |orm, klass|
-    describe "with orm #{orm}" do
+    describe "with orm #{orm}", orm => true do
       describe "timestamp to timestamp conversion" do
         let(:klass) { klass }
         subject do
@@ -117,7 +117,7 @@ describe Datagrid::Filters::DateTimeFilter do
 
   context "when datetime format is configured" do
     around(:each) do |example|
-      with_datetime_format(format = "%m/%d/%Y %H:%M") do
+      with_datetime_format("%m/%d/%Y %H:%M") do
         example.run
       end
     end

data/spec/datagrid/form_builder_spec.rb

@@ -14,7 +14,6 @@ describe Datagrid::FormBuilder do
 
   let(:template) { ActionView::Base.new}
   let(:view) { ActionView::Helpers::FormBuilder.new(:report, _grid, template, {}, Proc.new {|f| })}
-  subject { view }
 
 
   describe ".datagrid_filter" do
@@ -28,6 +27,7 @@ describe Datagrid::FormBuilder do
     subject do
       view.datagrid_filter(_filter, _filter_options)
     end
+
     let(:_filter_options) { {} }
     context "with default filter type" do
       let(:_grid) {
@@ -257,8 +257,8 @@ describe Datagrid::FormBuilder do
         else
           it { should equal_to_dom(
             '
-<label class="category enum_filter checkboxes" for="report_category_first"><input name="report[category][]" type="hidden"><input id="report_category_first" name="report[category][]" type="checkbox" value="first" />first</label>
-<label class="category enum_filter checkboxes" for="report_category_second"><input name="report[category][]" type="hidden"><input id="report_category_second" name="report[category][]" type="checkbox" value="second" />second</label>
+<label class="category enum_filter checkboxes" for="report_category_first"><input id="report_category_first" name="report[category][]" type="checkbox" value="first" />first</label>
+<label class="category enum_filter checkboxes" for="report_category_second"><input id="report_category_second" name="report[category][]" type="checkbox" value="second" />second</label>
             '
           )}
 
@@ -392,6 +392,31 @@ describe Datagrid::FormBuilder do
 
       it { should equal_to_dom(expected_html) }
     end
+    context "with column_names_filter default given as symbols" do
+      let(:_grid) do
+        test_report() do
+          scope {Entry}
+
+          column_names_filter(:default => [:id, :name], :checkboxes => true)
+
+          column(:id)
+          column(:name)
+          column(:category)
+        end       
+      end
+      let(:_filter) { :column_names }
+      let(:expected_html) do
+        <<DOM
+<label class="column_names enum_filter checkboxes" for="report_column_names_id"><input checked id="report_column_names_id" name="report[column_names][]" type="checkbox" value="id">Id</label>
+<label class="column_names enum_filter checkboxes" for="report_column_names_name"><input checked id="report_column_names_name" name="report[column_names][]" type="checkbox" value="name">Name</label>
+<label class="column_names enum_filter checkboxes" for="report_column_names_category"><input id="report_column_names_category" name="report[column_names][]" type="checkbox" value="category">Category</label>
+DOM
+      end
+
+      it do
+        should equal_to_dom(expected_html)
+      end
+    end
 
     context "with dynamic filter" do
       let(:filter_options) do

data/spec/datagrid/helper_spec.rb

@@ -128,6 +128,26 @@ describe Datagrid::Helper do
       end
     end
 
+    context 'with partials attribute' do
+      let(:grid) do
+        test_report do
+          scope { Entry }
+          column(:name)
+          column(:category)
+        end
+      end
+
+      it 'renders namespaced table partial' do
+        rendered_partial = subject.datagrid_table(grid, [entry], {
+                                    :partials => 'client/datagrid'
+                                    })
+        expect(rendered_partial).to include 'Namespaced table partial.'
+        expect(rendered_partial).to include 'Namespaced row partial.'
+        expect(rendered_partial).to include 'Namespaced head partial.'
+        expect(rendered_partial).to include 'Namespaced order_for partial.'
+      end
+    end
+
 
     describe ".datagrid_rows" do
       it "should support urls" do
@@ -308,7 +328,7 @@ describe Datagrid::Helper do
             "td.name" => 1
           )
         end
-    end
+      end
     end
 
     describe ".datagrid_order_for" do
@@ -328,6 +348,13 @@ describe Datagrid::Helper do
       end
     end
     describe ".datagrid_form_for" do
+      it 'returns namespaced partial if partials options is passed' do
+        rendered_form = subject.datagrid_form_for(grid, {
+          :url => '',
+          :partials => 'client/datagrid'
+        })
+        expect(rendered_form).to include 'Namespaced form partial.'
+      end
       it "should render form and filter inputs" do
         class FormForGrid
           include Datagrid
@@ -393,7 +420,7 @@ describe Datagrid::Helper do
     end
   end
 
-  describe ".datagrid_format_value" do
+  describe ".datagrid_value" do
     it "should format value by column name" do
       report = test_report do
         scope {Entry}
@@ -401,7 +428,7 @@ describe Datagrid::Helper do
           "<b>#{e.name}</b>"
         end
       end
-      subject.datagrid_format_value(report, :name, entry).should == "<b>Star</b>"
+      subject.datagrid_value(report, :name, entry).should == "<b>Star</b>"
     end
     it "should support format in column" do
       report = test_report do
@@ -412,7 +439,7 @@ describe Datagrid::Helper do
           end
         end
       end
-      subject.datagrid_format_value(report, :name, entry).should == "<a href=\"/profile\">Star</a>"
+      subject.datagrid_value(report, :name, entry).should == "<a href=\"/profile\">Star</a>"
     end
   end
 end