datagrid 0.9.3 → 1.0.0

data/lib/datagrid/helper.rb

@@ -57,6 +57,7 @@ module Datagrid
 
     # Provides access to datagrid columns data.
     #
+    #   # Suppose that <tt>grid</tt> has first_name and last_name columns
     #   <%= datagrid_row(grid, user) do |row| %>
     #     <tr>
     #       <td><%= row.first_name %></td>
@@ -73,7 +74,7 @@ module Datagrid
       end
     end
 
-    class HtmlRow
+    class HtmlRow #:nodoc:
       def initialize(context, grid, asset)
         @context = context
         @grid = grid

data/lib/datagrid/locale/en.yml

@@ -0,0 +1,28 @@
+en:
+  datagrid:
+    no_results:
+      "——"
+    table:
+      order:
+        asc: "↑"
+        desc: "↓"
+    form:
+      search: "Search"
+      reset: "Reset"
+    filters:
+      integer:
+        range_separator:
+          "<span class=\"separator integer\"> - </span>"
+      date:
+        range_separator:
+          "<span class=\"separator date\"> - </span>"
+
+      eboolean:
+        "yes": "Yes"
+        "no": "No"
+      dynamic:
+        operations:
+          ">=": ">="
+          "<=": "<="
+          "=": "="
+          "=~": "=~"

data/lib/datagrid/ordering.rb

@@ -17,10 +17,8 @@ module Datagrid
             unless column 
               order_unsupported(value, "no column #{value} in #{self.class}")
             end
-            unless column.order
-              order_unsupported(
-                name, "#{self.class}##{name} don't support order" 
-              ) 
+            unless column.supports_order?
+              order_unsupported(column.name, "column don't support order" ) 
             end
             value
           else
@@ -49,25 +47,41 @@ module Datagrid
     module InstanceMethods
 
       def assets # :nodoc:
-        result = super
-        if order
-          column = column_by_name(order)
-          result = apply_order(result, column)
-        end
-        result
+        apply_order(super)
+      end
+
+      # Returns a column definition that is currently used to order assets
+      # 
+      #   class MyGrid
+      #     scope { Model }
+      #     column(:id)
+      #     column(:name)
+      #   end
+      #   MyGrid.new(:order => "name").order_column # => #<Column name: "name", ...>
+      #
+      def order_column
+        column_by_name(order)
       end
 
       private
 
-      def apply_order(assets, column)
-        if descending?
-          if column.order_desc
-            apply_asc_order(assets, column.order_desc)
-          else
-            apply_desc_order(assets, column.order)
+      def apply_order(assets)
+        return assets unless order
+        if order_column.order_by_value?
+          assets = assets.sort_by do |asset|
+            order_column.order_by_value(asset, self)
           end
+          descending? ? assets.reverse : assets
         else
-          apply_asc_order(assets, column.order)
+          if descending?
+            if order_column.order_desc
+              apply_asc_order(assets, order_column.order_desc)
+            else
+              apply_desc_order(assets, order_column.order)
+            end
+          else
+            apply_asc_order(assets, order_column.order)
+          end
         end
       end
 
@@ -90,7 +104,7 @@ module Datagrid
       def reverse_order(assets)
         driver.reverse_order(assets)
       rescue NotImplementedError
-        self.class.order_unsupported("Your ORM do not support reverse order: please specify :order_desc option manually")
+        self.class.order_unsupported(order_column.name, "Your ORM do not support reverse order: please specify :order_desc option manually")
       end
 
       def apply_block_order(assets, order)
@@ -100,7 +114,7 @@ module Datagrid
         when 1
           order.call(assets)
         else
-          self.class.order_unsupported("Order option proc can not handle more than one argument")
+          self.class.order_unsupported(order_column.name, "Order option proc can not handle more than one argument")
         end
       end
     end # InstanceMethods

data/lib/datagrid/utils.rb

@@ -1,5 +1,5 @@
-module Datagrid
-  module Utils
+module Datagrid 
+  module Utils # :nodoc:
     class << self
 
 
@@ -9,14 +9,13 @@ module Datagrid
         TRUTH.include?(value)
       end
 
-      def warn_once(message)
+      def warn_once(message, delay = 5)
         @warnings ||= {}
-        if @warnings[message] 
-          false
-        else
-          warn message
-          @warnings[message] = true
-        end
+        timestamp = @warnings[message]
+        return false if timestamp && timestamp >= Time.now - delay
+        warn message
+        @warnings[message] = Time.now
+        true
       end
 
       def add_html_classes(options, *classes)

data/spec/datagrid/column_names_attribute_spec.rb

@@ -2,6 +2,49 @@ require "spec_helper"
 
 describe Datagrid::ColumnNamesAttribute do
 
-  describe ".column_names_filter" do
+  let(:column_names_filter_options) do
+    {}
+  end
+
+  let(:report) do
+    options = column_names_filter_options
+    test_report do
+      scope { Entry }
+      column_names_filter(options)
+      column(:id)
+      column(:name, :mandatory => true)
+      column(:category)
+    end
+  end
+  subject { report }
+
+
+  let!(:entry) do
+    Entry.create!(:name => 'hello', :category => 'greeting')
+  end
+
+  it "should work" do
+    subject.column_names = [:id]
+    subject.mandatory_columns.map(&:name).should == [:name]
+    subject.optional_columns.map(&:name).should == [:id, :category]
+    subject.data.should == [["Id", "Name"], [entry.id, "hello"]]
+    columns_filter = subject.filter_by_name(:column_names)
+    columns_filter.should_not be_nil
+    columns_filter.select(subject).should == [["Id", :id], ["Category", :category]]
+  end
+
+  it "should show only mandatory columns by default" do
+    subject.row_for(entry).should == [ "hello" ]
+    subject.column_names = ["name", "category"]
+    subject.row_for(entry).should == ["hello", "greeting"]
+  end
+
+
+  context "when default option is passed to column_names_filter" do
+    let(:column_names_filter_options) do
+      { :default => [:id] }
+    end
+    its(:data) { should == [["Id", "Name"], [entry.id, 'hello']] }
+
   end
 end

data/spec/datagrid/columns_spec.rb

@@ -161,4 +161,20 @@ describe Datagrid::Columns do
       report.rows.should == [["Hello World"]]
     end
   end
+
+  describe ".default_column_options" do
+    it "should pass default options to each column definition" do
+      report = test_report do
+        scope {Entry}
+        self.default_column_options = {:order => false}
+        column(:id)
+        column(:name, :order => "name")
+      end
+      first = Entry.create(:name => '1st')
+      second = Entry.create(:name => '2nd')
+      proc { report.attributes = {:order => :id} }.should raise_error(Datagrid::OrderUnsupported)
+      report.attributes = {:order => :name, :descending => true}
+      report.assets.should == [second, first]
+    end
+  end
 end

data/spec/datagrid/filters/dynamic_filter_spec.rb

@@ -0,0 +1,37 @@
+require "spec_helper" 
+
+
+describe Datagrid::Filters::DynamicFilter do
+  let(:report) do
+    test_report do
+      scope  {Entry}
+      filter(:condition, :dynamic)
+    end
+  end
+
+  it "should support = operation" do
+    report.condition = [:name, "=", "hello"]
+    report.assets.should include(Entry.create!(:name => 'hello'))
+    report.assets.should_not include(Entry.create!(:name => 'bye'))
+  end
+  it "should blank value" do
+    report.condition = [:name, "=", ""]
+    report.assets.should include(Entry.create!(:name => 'hello'))
+  end
+  it "should support =~ operation" do
+    report.condition = [:name, "=~", "ell"]
+    report.assets.should include(Entry.create!(:name => 'hello'))
+    report.assets.should_not include(Entry.create!(:name => 'bye'))
+  end
+  it "should support >= operation" do
+    report.condition = [:group_id, ">=", 2]
+    report.assets.should include(Entry.create!(:group_id => 3))
+    report.assets.should_not include(Entry.create!(:group_id => 1))
+  end
+  it "should support <= operation" do
+    report.condition = [:group_id, "<=", 2]
+    report.assets.should include(Entry.create!(:group_id => 1))
+    report.assets.should_not include(Entry.create!(:group_id => 3))
+  end
+
+end

data/spec/datagrid/filters/integer_filter_spec.rb

@@ -103,5 +103,23 @@ describe Datagrid::Filters::IntegerFilter do
     report.assets.should include(Entry.create!(:group => Group.create!(:rating => 5)))
   end
 
+  it "should support multiple values" do
+    report = test_report(:group_id => "1,2") do
+      scope {Entry}
+      filter(:group_id, :string, :multiple => true)
+    end
+    report.assets.should include(Entry.create!( :group_id => 1))
+    report.assets.should include(Entry.create!( :group_id => 2))
+    report.assets.should_not include(Entry.create!( :group_id => 3))
+  end
+  it "should support custom separator multiple values" do
+    report = test_report(:group_id => "1|2") do
+      scope {Entry}
+      filter(:group_id, :string, :multiple => '|')
+    end
+    report.assets.should include(Entry.create!( :group_id => 1))
+    report.assets.should include(Entry.create!( :group_id => 2))
+    report.assets.should_not include(Entry.create!( :group_id => 3))
+  end
   
 end

data/spec/datagrid/filters/string_filter_spec.rb

@@ -0,0 +1,25 @@
+require "spec_helper" 
+
+
+describe Datagrid::Filters::StringFilter do
+
+  it "should support multiple values" do
+    report = test_report(:name => "one,two") do
+      scope {Entry}
+      filter(:name, :string, :multiple => true)
+    end
+    report.assets.should include(Entry.create!( :name => "one"))
+    report.assets.should include(Entry.create!( :name => "two"))
+    report.assets.should_not include(Entry.create!( :name => "three"))
+  end
+  it "should support custom separator multiple values" do
+    report = test_report(:name => "one,1|two,2") do
+      scope {Entry}
+      filter(:name, :string, :multiple => '|')
+    end
+    report.assets.should include(Entry.create!( :name => "one,1"))
+    report.assets.should include(Entry.create!( :name => "two,2"))
+    report.assets.should_not include(Entry.create!( :name => "one"))
+  end
+
+end

data/spec/datagrid/filters_spec.rb

@@ -75,7 +75,7 @@ describe Datagrid::Filters do
       $FILTER_PERFORMED = false
       report = test_report(:name => value) do
         scope {Entry}
-        filter(:name, options) do |value|
+        filter(:name, options) do |_|
           $FILTER_PERFORMED = true
           self
         end
@@ -161,4 +161,18 @@ describe Datagrid::Filters do
     Entry.create!(:created_at => 3.days.ago)
     grid.assets.should_not be_empty
   end
+
+  describe "#filter_by" do
+    it "should allow partial filtering" do
+      grid = test_report do
+        scope {Entry}
+        filter(:id)
+        filter(:name)
+      end
+      e = Entry.create!(:name => 'hello')
+      grid.attributes = {:id => -1, :name => 'hello'}
+      grid.assets.should be_empty
+      grid.filter_by(:name).should_not be_empty
+    end
+  end
 end

data/spec/datagrid/form_builder_spec.rb

@@ -245,6 +245,19 @@ describe Datagrid::FormBuilder do
       let(:_filter) { :name }
 
       it {should equal_to_dom('<input class="name string_filter" id="report_name" name="report[name]" size="30" type="text">')}
+
+      context "when multiple option is set" do
+      let(:_grid) do
+        test_report(:name => "one,two") do
+          scope {Entry}
+          filter(:name, :string, :multiple => true)
+        end
+      end
+
+      let(:_filter) { :name }
+
+      it {should equal_to_dom('<input class="name string_filter" id="report_name" name="report[name]" size="30" type="text" value="one,two">')}
+      end
     end
 
     context "with non multiple filter" do
@@ -332,8 +345,78 @@ describe Datagrid::FormBuilder do
 
       it { should equal_to_dom(expected_html) }
     end
+
+    context "with dynamic filter" do
+      let(:filter_options) do
+        {}
+      end
+      
+      let(:_grid) do
+        options = filter_options
+        test_report do
+          scope {Entry}
+          filter(:condition, :dynamic, options)
+        end
+      end
+      let(:_filter) { :condition }
+      context "with no options" do
+        let(:expected_html) do
+          <<-HTML
+         <select class="condition dynamic_filter field" id="report_condition" name="report[condition][]"><option value="id">Id</option>
+         <option value="group_id">Group</option>
+         <option value="name">Name</option>
+         <option value="category">Category</option>
+         <option value="access_level">Access level</option>
+         <option value="pet">Pet</option>
+         <option value="disabled">Disabled</option>
+         <option value="confirmed">Confirmed</option>
+         <option value="shipping_date">Shipping date</option>
+         <option value="created_at">Created at</option>
+         <option value="updated_at">Updated at</option></select><select class="condition dynamic_filter operation" id="report_condition" name="report[condition][]"><option value="=">=</option>
+         <option value="=~">=~</option>
+         <option value="&gt;=">&gt;=</option>
+         <option value="&lt;=">&lt;=</option></select><input class="condition dynamic_filter value" id="report_condition" name="report[condition][]" size="30" type="text">
+          HTML
+        end
+        it {should equal_to_dom(expected_html)}
+
+      end
+      context "when default option passed" do
+        let(:filter_options) do
+          {:select => [:id, :name], :default => [:id, '>=', 1]}
+        end
+        let(:expected_html) do
+          <<-HTML
+            <select class="condition dynamic_filter field" id="report_condition" name="report[condition][]"><option value="id" selected>id</option>
+       <option value="name">name</option></select><select class="condition dynamic_filter operation" id="report_condition" name="report[condition][]"><option value="=">=</option>
+       <option value="=~">=~</option>
+       <option value="&gt;=" selected>&gt;=</option>
+       <option value="&lt;=">&lt;=</option></select><input class="condition dynamic_filter value" id="report_condition" name="report[condition][]" size="30" type="text" value="1">
+          HTML
+        end
+        it {should equal_to_dom(expected_html)}
+
+      end
+      context "when select option passed" do
+        let(:filter_options) do
+          {:select => [:id, :name]}
+        end
+        let(:expected_html) do
+          <<-HTML
+        <select class="condition dynamic_filter field" id="report_condition" name="report[condition][]"><option value="id">id</option>
+       <option value="name">name</option></select><select class="condition dynamic_filter operation" id="report_condition" name="report[condition][]"><option value="=">=</option>
+       <option value="=~">=~</option>
+       <option value="&gt;=">&gt;=</option>
+       <option value="&lt;=">&lt;=</option></select><input class="condition dynamic_filter value" id="report_condition" name="report[condition][]" size="30" type="text">
+          HTML
+        end
+        it {should equal_to_dom(expected_html)}
+
+      end
+    end
   end
 
+
   describe ".datagrid_label" do
     let(:_grid) do
       test_report do