datagrid 0.8.4 → 0.9.0

data/VERSION

@@ -1 +1 @@
-0.8.4
+0.9.0

data/app/views/datagrid/_order_for.html.erb

@@ -1,10 +1,10 @@
 <div class="order">
   <%= link_to(
       I18n.t("datagrid.table.order.asc", :default => "&uarr;".html_safe).html_safe,
-      url_for(grid.param_name => grid.attributes.merge(:order => column.name, :descending => false)),
+      url_for(grid.param_name => grid.as_query.merge(:order => column.name, :descending => false)),
       :class => "asc") %>
   <%= link_to(
       I18n.t("datagrid.table.order.desc", :default => "&darr;".html_safe).html_safe,
-      url_for(grid.param_name => grid.attributes.merge(:order => column.name, :descending => true )),
+      url_for(grid.param_name => grid.as_query.merge(:order => column.name, :descending => true )),
       :class => "desc") %>
 </div>

data/datagrid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "datagrid"
-  s.version = "0.8.4"
+  s.version = "0.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2013-05-22"
+  s.date = "2013-06-06"
   s.description = "This allows you to easily build datagrid aka data tables with sortable columns and filters"
   s.email = "agresso@gmail.com"
   s.extra_rdoc_files = [
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
     "datagrid.gemspec",
     "lib/datagrid.rb",
     "lib/datagrid/active_model.rb",
+    "lib/datagrid/column_names_attribute.rb",
     "lib/datagrid/columns.rb",
     "lib/datagrid/columns/column.rb",
     "lib/datagrid/configuration.rb",
@@ -63,6 +64,7 @@ Gem::Specification.new do |s|
     "lib/datagrid/utils.rb",
     "lib/tasks/datagrid_tasks.rake",
     "spec/datagrid/active_model_spec.rb",
+    "spec/datagrid/column_names_attribute_spec.rb",
     "spec/datagrid/columns_spec.rb",
     "spec/datagrid/core_spec.rb",
     "spec/datagrid/drivers/active_record_spec.rb",

data/lib/datagrid.rb

@@ -9,6 +9,7 @@ module Datagrid
   autoload :ActiveModel
   autoload :Filters
   autoload :Columns
+  autoload :ColumnNamesAttribute
   autoload :Ordering
   autoload :Configuration
 
@@ -30,6 +31,7 @@ module Datagrid
       include ::Datagrid::ActiveModel
       include ::Datagrid::Filters
       include ::Datagrid::Columns
+      include ::Datagrid::ColumnNamesAttribute
       include ::Datagrid::Ordering
 
     end

data/lib/datagrid/column_names_attribute.rb

@@ -0,0 +1,47 @@
+module Datagrid
+  module ColumnNamesAttribute
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :columns_array
+      self.columns_array = []
+
+      datagrid_attribute :column_names do |names|
+        names = Array(names).reject(&:blank?)
+        if names.reject(&:blank?).blank?
+          columns.map(&:name)
+        else
+          names
+        end
+      end
+    end
+
+    module ClassMethods
+      def column_names_filter
+        filter(:column_names, :enum, :select => proc { |grid| grid.class.columns.map {|c| [c.header, c.name] }}, :multiple => true ) do |value|
+          scoped
+        end
+      end
+    end
+
+    def columns(*args)
+      options = args.extract_options!
+      column_names = selected_column_names(*args)
+      column_names << options
+      super(*column_names)
+    end
+
+    protected
+
+    def selected_column_names(*args)
+      if args.any?
+        args.compact!
+        args.map!(&:to_sym)
+        args
+      else
+        column_names ? column_names.clone : []
+      end
+    end
+  end
+end
+

data/lib/datagrid/columns.rb

@@ -11,8 +11,6 @@ module Datagrid
       base.class_eval do
 
         include Datagrid::Core
-        class_attribute :columns_array
-        self.columns_array = []
 
       end
       base.send :include, InstanceMethods
@@ -47,13 +45,14 @@ module Datagrid
         columns_array << Datagrid::Columns::Column.new(self, name, options, &block)
       end
 
+      # Returns column definition with given name
       def column_by_name(name)
         self.columns.find do |col|
           col.name.to_sym == name.to_sym
         end
       end
 
-      def inherited(child_class)
+      def inherited(child_class) #:nodoc:
         super(child_class)
         child_class.columns_array = self.columns_array.clone
       end
@@ -133,19 +132,29 @@ module Datagrid
         end
       end
 
+
+      # Returns all columns selected in grid instance
+      #
+      # Examples:
+      # 
+      #   MyGrid.new.columns # => all defined columns
+      #   grid = MyGrid.new(:column_names => [:id, :name])
+      #   grid.columns # => id and name columsn
+      #   grid.columns(:id, :category) # => id and category column
       def columns(*args)
         self.class.columns(*args)
       end
 
       def data_columns(*names)
-        names << {:data => true}
+        options = names.extract_options!
+        options[:data] = true
+        names << options
         self.columns(*names)
       end
 
       def column_by_name(name)
         self.class.column_by_name(name)
       end
-
     end # InstanceMethods
 
   end

data/lib/datagrid/core.rb

@@ -94,6 +94,14 @@ module Datagrid
         end
       end
 
+      def as_query
+        attributes = self.attributes.clone
+        attributes.each do |key, value|
+          attributes.delete(key) if value.nil?
+        end
+        attributes
+      end
+
       def paginate(*args, &block)
         ::Datagrid::Utils.warn_once("#paginate is deprecated. Call it like object.assets.paginate(...).")
         self.assets.paginate(*args, &block)

data/lib/datagrid/filters/enum_filter.rb

@@ -20,7 +20,9 @@ class Datagrid::Filters::EnumFilter < Datagrid::Filters::BaseFilter
   end
 
   def include_blank
-    self.options.has_key?(:include_blank) ? options[:include_blank] : true unless self.prompt
+    unless self.prompt
+      self.options.has_key?(:include_blank) ? options[:include_blank] : !multiple
+    end
   end
   
   def prompt

data/lib/datagrid/helper.rb

@@ -4,30 +4,93 @@ require "action_view"
 module Datagrid
   module Helper
 
-    def datagrid_format_value(report, column, asset)
-      datagrid_renderer.format_value(report, column, asset)
+    # 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)
     end
 
+    # Renders html table with columns defined in grid class.
+    # In the most common used you need to pass paginated collection 
+    # to datagrid table because datagrid do not have pagination compatibilities:
+    #     
+    #   assets = grid.assets.page(params[:page])
+    #   datagrid_table(grid, assets, options)
+    #
+    # Supported options:
+    #
+    # * <tt>:html</tt> - hash of attributes for <table> tag
+    # * <tt>:order</tt> - If false do not generate ordering controlls. 
+    #   Default: true.
+    # * <tt>:cycle</tt> - Used as arguments for cycle for each row. 
+    #   Default: false. Example: <tt>["odd", "even"]</tt>.
+    # * <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)
     end
 
+    # Renders HTML table header for given grid instance using columns defined in it
+    #
+    # Supported options:
+    #
+    # * <tt>:order</tt> - display ordering controls built-in into header
+    #   Default: true
+    #     
     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)
     end
 
+    # Renders ordering controls for the given column name
     def datagrid_order_for(grid, column)
       datagrid_renderer.order_for(grid, column)
     end
 
+    # Renders HTML for for grid with all filters inputs and lables defined in it
     def datagrid_form_for(grid, options = {})
       datagrid_renderer.form_for(grid, options)
     end
 
+    # Provides access to datagrid column data.
+    #
+    #   <%= datagrid_row(grid, user) do |row| %>
+    #     <tr>
+    #       <td><%= row.first_name %></td>
+    #       <td><%= row.last_name %></td>
+    #     </tr>
+    #   <% end %>
+    #
+    # Used in case you want to build datagrid table completelly manually
+    def datagrid_row(grid, asset, &block)
+      HtmlRow.new(self, grid, asset).tap do |row|
+        if block_given?
+          return capture(row, &block)
+        end
+      end
+    end
+
+    class HtmlRow
+      def initialize(context, grid, asset)
+        @context = context
+        @grid = grid
+        @asset = asset
+      end 
+
+      def method_missing(method, *args, &blk)
+        if column = @grid.column_by_name(method)
+          @context.datagrid_format_value(@grid, column, @asset)
+        else
+          super
+        end
+      end
+    end
+
     protected
 
     def datagrid_renderer

data/lib/datagrid/renderer.rb

@@ -12,6 +12,9 @@ module Datagrid
     end
 
     def format_value(grid, column, asset)
+      if column.is_a?(String) || column.is_a?(Symbol)
+        column = grid.column_by_name(column)
+      end
 
       value = if column.html?
         args = []

data/spec/datagrid/column_names_attribute_spec.rb

@@ -0,0 +1,7 @@
+require "spec_helper"
+
+describe Datagrid::ColumnNamesAttribute do
+
+  describe ".column_names_filter" do
+  end
+end

data/spec/datagrid/columns_spec.rb

@@ -53,7 +53,7 @@ describe Datagrid::Columns do
     it "should support csv export of particular columns" do
       subject.to_csv(:name).should == "Name\nStar\n"
     end
-    
+
     it "should support csv export options" do
       subject.to_csv(:col_sep => ";").should == "Group;Name;Access level;Pet\nPop;Star;admin;ROTTWEILER\n"
     end
@@ -92,4 +92,33 @@ describe Datagrid::Columns do
     child.column_by_name(:group_id).should_not be_nil
   end
 
+  describe ".column_names attributes" do
+    let(:grid) do
+      test_report(:column_names => ["id", "name"]) do
+        scope { Entry }
+        column(:id)
+        column(:name)
+        column(:category)
+      end
+    end
+    let!(:entry) do
+      Entry.create!(:name => 'hello')
+    end
+    it "should be suppored in header" do
+      grid.header.should == ["Id", "Name"]
+    end
+    it "should be suppored in rows" do
+      grid.rows.should == [[entry.id, "hello"]]
+    end
+
+    it "should be suppored in csv" do
+      grid.to_csv.should == "Id,Name\n#{entry.id},hello\n"
+    end
+
+    it "should support explicit overwrite" do
+      grid.header(:id, :name, :category).should == %w(Id Name Category)
+    end
+
+  end
+
 end

data/spec/datagrid/filters/enum_filter_spec.rb

@@ -32,4 +32,5 @@ describe Datagrid::Filters::EnumFilter do
       filter(:group_id, :enum, :select => proc { raise 'hello' })
     end
   end
+
 end

data/spec/datagrid/form_builder_spec.rb

@@ -262,6 +262,41 @@ describe Datagrid::FormBuilder do
       )}
 
     end
+
+    context "with enum multiple filter" do
+      let(:_grid) do
+        test_report do
+          scope {Entry}
+          filter(:group_id, :enum, :select => ['hello'], :multiple => true)
+        end
+      end
+      let(:_filter) { :group_id }
+      it { should equal_to_dom(<<HTML) }
+<input name="report[group_id][]" type="hidden" value=""><select class="group_id enum_filter" id="report_group_id" multiple name="report[group_id][]">
+<option value="hello">hello</option></select>
+HTML
+
+    end
+
+    context "with column names filter" do
+      let(:_grid) do
+        test_report(:column_names => [:id, :name]) do
+          scope {Entry}
+
+          column_names_filter
+
+          column(:id)
+          column(:name)
+          column(:category)
+        end       
+      end
+      let(:_filter) { :column_names }
+      it { should equal_to_dom(<<HTML)}
+<input name="report[column_names][]" type="hidden" value=""><select class="column_names enum_filter" id="report_column_names" multiple name="report[column_names][]"><option value="id" selected>Id</option>
+<option value="name" selected>Name</option>
+<option value="category">Category</option></select>
+HTML
+    end
   end
 
   describe ".datagrid_label" do

data/spec/datagrid/helper_spec.rb

@@ -95,6 +95,25 @@ describe Datagrid::Helper do
         "table.datagrid td.group" => 0
       )
     end
+    context "with column_names attribute" do
+      let(:grid) do
+        test_report(:column_names => "name") do
+          scope { Entry }
+          column(:name)
+          column(:category)
+        end
+      end
+
+      it "should output only given column names" do
+        subject.datagrid_table(grid, [entry]).should match_css_pattern(
+          "table.datagrid th.name" => 1,
+          "table.datagrid td.name" => 1,
+          "table.datagrid th.category" => 0,
+          "table.datagrid td.category" => 0
+        )
+      end
+    end
+
 
     describe ".datagrid_rows" do
       it "should support urls" do
@@ -114,7 +133,7 @@ describe Datagrid::Helper do
         end
         subject.datagrid_rows(rp, [entry]).should match_css_pattern(
           "tr td.name" => "Star"
-        )  
+        )
       end
 
       it "should add ordering classes to column" do
@@ -186,9 +205,9 @@ describe Datagrid::Helper do
       it "should render argument-based html blocks with double arguments" do
         rp = test_report do
           scope { Entry }
-          column(:name, :html => lambda { |data, model| 
+          column(:name, :html => lambda { |data, model|
             content_tag :h1, "#{data}-#{model.name.downcase}"
-          })            
+          })
         end
         subject.datagrid_rows(rp, [entry]).should match_css_pattern(
           "tr td.name h1" => "Star-star"
@@ -198,9 +217,9 @@ describe Datagrid::Helper do
       it "should render argument-based html blocks with triple arguments" do
         rp = test_report do
           scope { Entry }
-          column(:name, :html => lambda { |data, model, grid| 
+          column(:name, :html => lambda { |data, model, grid|
             content_tag :h1, "#{data}-#{model.name.downcase}-#{grid.assets.klass}"
-          })            
+          })
         end
         subject.datagrid_rows(rp, [entry]).should match_css_pattern(
           "tr td.name h1" => "Star-star-Entry"
@@ -210,11 +229,11 @@ describe Datagrid::Helper do
       it "should render argument-based html blocks with double arguments and custom data" do
         rp = test_report do
           scope { Entry }
-          column(:name, :html => lambda { |data, model| 
+          column(:name, :html => lambda { |data, model|
             content_tag :h1, "#{data}-#{model.name}"
           }) do
             self.name.upcase
-          end            
+          end
         end
         subject.datagrid_rows(rp, [entry]).should match_css_pattern(
           "tr td.name h1" => "STAR-Star"
@@ -224,11 +243,11 @@ describe Datagrid::Helper do
       it "should render argument-based html blocks with triple arguments and custom data" do
         rp = test_report do
           scope { Entry }
-          column(:name, :html => lambda { |data, model, grid| 
+          column(:name, :html => lambda { |data, model, grid|
             content_tag :h1, "#{data}-#{model.name}-#{grid.assets.klass}"
           }) do
             self.name.upcase
-          end            
+          end
         end
         subject.datagrid_rows(rp, [entry]).should match_css_pattern(
           "tr td.name h1" => "STAR-Star-Entry"
@@ -295,5 +314,52 @@ describe Datagrid::Helper do
         )
       end
     end
+
+    describe ".datagrid_row" do
+      let(:grid) do
+        test_report do
+          scope { Entry }
+          column(:name)
+          column(:category)
+        end
+      end
+
+      let(:entry) do
+        Entry.create!(:name => "Hello", :category => "greetings")
+      end
+
+      it "should provide access to row data" do
+        r = subject.datagrid_row(grid, entry)
+        r.name.should == "Hello"
+        r.category.should == "greetings"
+      end
+      it "should yield block" do
+        subject.datagrid_row(grid, entry) do |row|
+          row.name.should == "Hello"
+          row.category.should == "greetings"
+        end
+      end
+
+      it "should output data from block" do
+        name = subject.datagrid_row(grid, entry) do |row|
+          subject.concat(row.name)
+          subject.concat(",")
+          subject.concat(row.category)
+        end
+        name.should == "Hello,greetings"
+      end
+    end
+  end
+
+  describe ".datagrid_format_value" do
+    it "should format value by column name" do
+      report = test_report do
+        scope {Entry}
+        column(:name) do |e|
+          "<b>#{e.name}</b>"
+        end
+      end
+      subject.datagrid_format_value(report, :name, entry).should == "<b>Star</b>"
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-22 00:00:00.000000000 Z
+date: 2013-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -258,6 +258,7 @@ files:
 - datagrid.gemspec
 - lib/datagrid.rb
 - lib/datagrid/active_model.rb
+- lib/datagrid/column_names_attribute.rb
 - lib/datagrid/columns.rb
 - lib/datagrid/columns/column.rb
 - lib/datagrid/configuration.rb
@@ -290,6 +291,7 @@ files:
 - lib/datagrid/utils.rb
 - lib/tasks/datagrid_tasks.rake
 - spec/datagrid/active_model_spec.rb
+- spec/datagrid/column_names_attribute_spec.rb
 - spec/datagrid/columns_spec.rb
 - spec/datagrid/core_spec.rb
 - spec/datagrid/drivers/active_record_spec.rb
@@ -335,7 +337,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3876339943882620778
+      hash: 1228935778461264019
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: