data_grid 0.0.1 → 0.0.2

data/lib/data_grid/view_helpers.rb

@@ -0,0 +1,271 @@
+# encoding: utf-8
+# Views methods
+
+module DataGrid
+  module ViewHelpers
+
+    # FORMATERS
+    def data_grid_formatter_plain_text(txt)
+      txt
+    end
+  
+    def data_grid_formatter_bold(txt)
+      raw "<strong>#{txt}</strong>"
+    end
+  
+    def data_grid_formatter_money_pl(price)
+      pieces = price.to_s.split('<br />')
+      results = []
+      pieces.each do |p|
+        p = p.to_f
+        p = ((p*100.0).round)/100.0
+        result = p.to_s
+        result = result + '0' if (((p*10).to_s == (p*10).to_i.to_f.to_s) and (p > 0))
+        result = '0' if p.zero?
+
+        results << result.gsub('.', ',')
+      end
+      raw(results.join('<br />'))
+    end
+  
+    def data_grid_formatter_datetime(dt)
+      I18n.l(dt)
+    end
+  
+    def data_grid_formatter_date(d)
+      I18n.l(d)
+    end
+
+    def show_grid(data_grid)
+      data_grid.view_context = self
+      data_grid.prepare_data
+      render 'data_grid/data_grid', :data_grid => data_grid
+    end
+
+    # Simple slug method used in URL params - column names
+    def slug(p_str)
+      str = String.new(p_str)
+      str.strip!
+
+      s =  ['ą', 'ć', 'ę', 'ł', 'ń', 'ó', 'ś', 'ż', 'ź',
+                   'Ą', 'Ć', 'Ę', 'Ł', 'Ń', 'Ó', 'Ś', 'Ż', 'Ź',
+                   'é', 'à', ' - ', 'À', 'Á', 'Ã', 'Ä', 'Å',
+                   'Æ', 'Ç', 'È', 'É', 'Ê', 'Ë', 'Ì', 'Í', 'Î',
+                   'Ï', 'Đ', 'Ñ', 'Ô', 'Õ', 'Ö', 'Ù', 'Û', 'Ý',
+                   'ß', 'à', 'á', 'â', 'ã', 'ä', 'å', 'æ', 'ç',
+                   'è', 'é', 'ê', 'ë', 'ì', 'í', 'í', 'î', 'ï',
+                   'ñ', 'ò', 'ô', 'õ', 'ö', 'ù', 'ú', 'û', 'ü',
+                   'ý', 'ÿ', '€', '$', 'Š', 'š', 'ž', 'Œ', 'œ',
+                   'Ÿ', '§', '@' ]
+      r = ['a', 'c', 'e', 'l', 'n', 'o', 's', 'z', 'z',
+                   'a', 'c', 'e', 'l', 'n', 'o', 's', 'z', 'z',
+                   'e', 'a', '-', 'a', 'a', 'a', 'a', 'a',
+                   'ae', 'c', 'e', 'e', 'e', 'e', 'i', 'i', 'i',
+                   'i', 'd', 'n', 'o', 'o', 'o', 'u', 'u', 'y',
+                   'b', 'a', 'a', 'a', 'a', 'a', 'a', 'ae', 'c',
+                   'e', 'e', 'e', 'e', 'i', 'i', 'i', 'i', 'i',
+                   'n', 'o', 'o', 'o', 'o', 'u', 'u', 'u', 'u',
+                   'y', 'y', 'e', 's', 's', 's', 'z', 'oe', 'oe',
+                   'y', 'p', 'at' ]
+      s.each_index {|i| str.gsub!(s[i], r[i])}
+      str.downcase!
+      str.gsub!(Regexp.new('\ +'), '-')
+      str.gsub!(Regexp.new('[^A-z0-9\-]'), '')
+      str.gsub!(Regexp.new('\-+', '-'), '-')
+      str
+    end
+
+    # Render given column header
+    def data_grid_header(data_grid, column)
+      if column.sortable
+        col_index = data_grid.columns.index(column)
+        link_to(raw(column.title), data_grid.params.merge(
+          "sort_#{data_grid.name}" => slug(column.title) + '_' + col_index.to_s,
+          "sort_direction_#{data_grid.name}" => ((data_grid.sort == col_index) and (data_grid.sort_direction == 'ASC')) ? 'DESC' : 'ASC'), :class => 'underline sorting ' + ((data_grid.sort == col_index) ? ((data_grid.sort_direction == 'ASC') ? 'up' : 'down') : '')) 
+      else
+        raw column.title
+      end
+    end
+  
+    # Show export link
+    def data_grid_export_link(data_grid)
+      link_to(
+        image_tag("data_grid/#{data_grid.export_enabled}.gif", :border => 0), 
+        data_grid.params.merge("export_#{data_grid.name}" => data_grid.export_enabled)
+      )
+    end
+
+    # Based on column filter type, display form with inputs
+    def data_grid_filter(data_grid, column)
+      hidden_submit_input = '<input type="submit" value="" style="width:0px; height: 0px; border: none; padding: 0px; font-size: 0px">'.html_safe
+      output = ''
+      col_index = data_grid.columns.index(column)
+      case column.filter
+      when :boolean
+        filter_select_name = "filter_#{data_grid.name}_#{col_index}"
+        base_url = url_for(data_grid.params.merge(filter_select_name => nil))
+        output = select_tag(filter_select_name,
+          options_for_select([[I18n.t('data_grid.all_options'), ''], [I18n.t('data_grid.option_true'), '1'], [I18n.t('data_grid.option_false'), '0']], column.filter_value),
+          :onchange => "window.location.href='#{base_url}#{(base_url.include?('?')) ? '&' : '?' }#{filter_select_name}=' + this.value")
+      when :auto
+        filter_select_name = "filter_#{data_grid.name}_#{col_index}"
+        base_url = url_for(data_grid.params.merge(filter_select_name => nil))
+        output = select_tag(filter_select_name,
+          options_for_select([[I18n.t('data_grid.all_options'), '']] + column.filter_data.map{|fd| [column.auto_filter_hash.nil? ? fd : column.auto_filter_hash[fd.to_s.to_sym], fd]}, column.filter_value),
+          :onchange => "window.location.href='#{base_url}#{(base_url.include?('?')) ? '&' : '?' }#{filter_select_name}=' + this.value")
+      
+      when :text
+        filter_input_name = "filter_#{data_grid.name}_#{col_index}"
+        base_url = url_for(data_grid.params.merge(filter_input_name => nil))
+        output = form_tag(base_url, :method => 'GET') do
+          text_field_tag(filter_input_name, column.filter_value) + 
+          data_grid_dump_as_hidden_fields(data_grid, [filter_input_name]) + 
+          hidden_submit_input
+        end
+      when :number
+        filter_input_name = "filter_#{data_grid.name}_#{col_index}"
+        base_url = url_for(data_grid.params.merge(filter_input_name => nil))
+        output = form_tag(base_url, :method => 'GET') do
+          text_field_tag(filter_input_name, column.filter_value, :class => 'data_grid_filter_input') + 
+          data_grid_dump_as_hidden_fields(data_grid, [filter_input_name]) + 
+          hidden_submit_input
+        end
+      when :range
+        filter_input_name_from = "filter_#{data_grid.name}_#{col_index}_from"
+        filter_input_name_to = "filter_#{data_grid.name}_#{col_index}_to"
+        base_url = url_for(data_grid.params.merge(filter_input_name_from => nil, filter_input_name_to => nil))
+        output = form_tag(base_url, :method => 'GET') do
+          data_grid_dump_as_hidden_fields(data_grid, [filter_input_name_from, filter_input_name_to]) + 
+          text_field_tag(filter_input_name_from, column.filter_value.to_s.split(DataGrid.range_separator)[0], :class => 'data_grid_filter_input') + 
+          ' - ' + 
+          text_field_tag(filter_input_name_to, column.filter_value.to_s.split(DataGrid.range_separator)[1], :class => 'data_grid_filter_input') +
+          hidden_submit_input
+        end
+      
+      when :date        
+        date_format = I18n.t(:"date.formats.default", {:locale => I18n.locale })
+        filter_input_name_from = "filter_#{data_grid.name}_#{col_index}_from"
+        filter_input_name_to = "filter_#{data_grid.name}_#{col_index}_to"
+        form_id = "filter_#{data_grid.name}_#{col_index}_form"
+      
+        base_url = url_for(data_grid.params.merge(filter_input_name_from => nil, filter_input_name_to => nil))
+        output = "<form method='get' action='#{base_url}' id='#{form_id}'>"
+        output << data_grid_dump_as_hidden_fields(data_grid, [filter_input_name_from, filter_input_name_to])
+      
+        date_picker, datepicker_placeholder_id, trigger_id, dom_id, date_span_id = select_date_datetime_common(
+        {:id => "filter_#{data_grid.name}_#{col_index}_from", :name => filter_input_name_from}, data_grid.params[filter_input_name_from], form_id)
+
+        output << "#{I18n.t('data_grid.filter_date_from')}: <span id=\"#{datepicker_placeholder_id}\">#{date_picker}</span>"
+        output << %(<script type="text/javascript">\n)
+        output << %(    Calendar.setup\({\n)
+        output << %(        button : "#{trigger_id}",\n )
+        output << %(        ifFormat : "#{date_format}",\n )
+        output << %(        inputField : "#{dom_id}",\n )
+        output << %(        include_blank : true,\n )
+        output << %(        singleClick    :    true,\n)
+        output << %(        onClose    :    function(cal){handleCalendarClose(cal, "#{dom_id}", "#{form_id}");}\n)
+        output << %(    }\);\n)
+        output << %(</script><br />\n)
+      
+        date_picker, datepicker_placeholder_id, trigger_id, dom_id, date_span_id = select_date_datetime_common(
+        {:id => "filter_#{data_grid.name}_#{col_index}_to", :name => filter_input_name_to}, data_grid.params[filter_input_name_to], form_id)
+
+        output << "#{I18n.t('data_grid.filter_date_to')}: <span id=\"#{datepicker_placeholder_id}\">#{date_picker}</span>"
+        output << %(<script type="text/javascript">\n)
+        output << %(    Calendar.setup\({\n)
+        output << %(        button : "#{trigger_id}",\n )
+        output << %(        ifFormat : "#{date_format}",\n )
+        output << %(        inputField : "#{dom_id}",\n )
+        output << %(        include_blank : true,\n )
+        output << %(        singleClick    :    true,\n)
+        output << %(        onClose    :    function(cal){handleCalendarClose(cal, "#{dom_id}", "#{form_id}");}\n)
+        output << %(    }\);\n)
+        output << %(</script>\n)
+      
+        output << hidden_submit_input
+        output << '</form>'
+      
+      else
+        output = '&nbsp;'
+      end
+
+      raw output
+    end
+  
+    # Prepare calendar in filters area
+    def select_date_datetime_common(options, date_string, form_id)  #:nodoc:
+      dom_id = options[:id]
+    
+      trigger_id = dom_id + '_trigger'
+      datepicker_placeholder_id = dom_id + '_date_placeholder'
+      date_span_id = dom_id + '_date_view'
+
+      date_picker = image_tag('data_grid/calendar_view_month.png', :id => trigger_id, :style => 'cursor: pointer') +
+
+      link_to_function(
+        content_tag(:span, date_string, :id => date_span_id),
+        %! dataGridSetInnerHtml("#{date_span_id}", ""); dataGridSetValue("#{dom_id}", ""); handleCalendarClose(false, "#{dom_id}", "#{form_id}");!,
+        :class => 'date_label') + ' ' +
+
+        hidden_field_tag(options[:name], date_string, :class => 'text-input', :id => dom_id,
+          :onchange => "dataGridSetInnerHtml(\"#{date_span_id}\", this.value);")
+
+      return date_picker, datepicker_placeholder_id, trigger_id, dom_id, date_span_id
+    end
+
+
+    # Display data_grid per page selector
+    def data_grid_per_page_selector(data_grid)
+      per_page_param = "per_page_#{data_grid.name}"
+      base_url = url_for(data_grid.params.merge(per_page_param => nil))
+      select_tag(:per_page,
+        options_for_select(DataGrid.available_per_pages, data_grid.per_page),
+        :onchange => "window.location.href='#{base_url}#{(base_url.include?('?')) ? '&' : '?' }#{per_page_param}=' + this.value", :class => 'data_grid_per_page_selector')
+    end
+
+
+    # Dump all data_grid options as hidden fields
+    def data_grid_dump_as_hidden_fields(data_grid, except = [])
+      output = ''
+      data_grid.params.each_pair do |k, v|
+        next if except.include?(k)
+        output << hidden_field_tag(k, v)
+      end
+      output.html_safe
+    end
+  
+
+    # Displays data grid pager
+    def data_grid_pager(data_grid)
+      output = []
+      if data_grid.pages < 8
+        1.upto(data_grid.pages){|page_number|
+          if data_grid.page == page_number or data_grid.page == 0
+            output << "<li>#{page_number}</li>"
+          else
+            output << '<li>' + link_to(page_number, data_grid.params.merge('page_' + data_grid.name => page_number) ) + '</li>'
+          end
+        }
+      else
+        if data_grid.page - 4 > 0
+          output << '<li>' + link_to("1", data_grid.params.merge('page_' + data_grid.name => 1), :class => 'prev' ) + '</li><li>...</li>'
+        end
+        1.upto(data_grid.pages){|page_number|
+          if data_grid.page == page_number or data_grid.page == 0
+            output << "<li>#{page_number}</li>"
+          else
+            if page_number > data_grid.page - 4 and page_number < data_grid.page + 4
+              output << '<li>' + link_to(page_number, data_grid.params.merge('page_' + data_grid.name => page_number) ) + '</li>'
+            end
+          end
+        }
+        if data_grid.page + 3 < data_grid.pages
+          output << '<li>...</li><li>' + link_to("#{data_grid.pages}",data_grid.params.merge('page_' + data_grid.name => data_grid.pages), :class => 'next' ) + '</li>'
+        end
+      end
+    
+      raw("<ul class='data_grid_pagination'>" + output.join(' ') + "</ul>")
+    end
+  end
+end
+

data/lib/data_grid.rb

@@ -0,0 +1,43 @@
+require "data_grid/version"
+require "data_grid/engine"
+require "data_grid/controller"
+require "data_grid/data_grid_logic"
+require "data_grid/column"
+require "data_grid/summaries"
+require "data_grid/view_helpers"
+
+module DataGrid
+
+  # Default per page
+  mattr_accessor :per_page
+
+  # Used in URL in range filter
+  mattr_accessor :range_separator
+
+  # Default columns sortable state
+  mattr_accessor :column_sortable
+
+  # Default column summary formatter
+  mattr_accessor :column_summary_formatter
+
+  # Default sort direction
+  mattr_accessor :sort_direction
+
+  # Show table footer
+  mattr_accessor :show_footer
+
+  # Available per page options
+  mattr_accessor :available_per_pages
+
+  # Method used to save grid state
+  mattr_accessor :state_saver_method
+
+  # Default export filename
+  mattr_accessor :export_filename
+
+
+  def self.setup
+    yield self
+  end
+
+end

data/lib/generators/data_grid/copy_view_generator.rb

@@ -0,0 +1,16 @@
+module DataGrid
+  module Generators
+    class CopyViewGenerator < Rails::Generators::Base
+      @@root = File.expand_path("../../templates", __FILE__)
+      source_root @@root
+
+      desc "Copy views ..."
+      
+      def copy_view_files
+        view_root = File.expand_path('../../../../app/views', __FILE__)
+        FileUtils.cp_r(Dir["#{view_root}/data_grid"], 'app/views')
+      end
+  
+    end
+  end
+end

data/lib/generators/data_grid/install_generator.rb

@@ -0,0 +1,29 @@
+module DataGrid
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      @@root = File.expand_path("../../templates", __FILE__)
+      source_root @@root
+
+      desc "Copy files ..."
+
+      def copy_initializer
+        template "data_grid.rb", "config/initializers/data_grid.rb"
+      end
+
+      
+      def copy_all_files
+        assets_root = File.expand_path('../../../../app/assets', __FILE__)
+
+        # only for Rails = 3.0.x
+        if Rails::VERSION::MAJOR == 3 and Rails::VERSION::MINOR.zero?
+          copy_file "#{@@root}/stylesheets/data_grid/data_grid_3_0.css", "public/stylesheets/data_grid/data_grid.css"
+          copy_file "#{assets_root}/javascripts/data_grid/data_grid.js", "public/javascripts/data_grid/data_grid.js"
+          FileUtils.cp_r(Dir["#{assets_root}/stylesheets/data_grid/grid_calendar"], 'public/stylesheets/data_grid')
+          FileUtils.cp_r(Dir["#{assets_root}/javascripts/data_grid/grid_calendar"], 'public/javascripts/data_grid')
+          FileUtils.cp_r(Dir["#{assets_root}/images/data_grid"], 'public/images')
+        end
+      end
+  
+    end
+  end
+end

data/lib/generators/templates/data_grid.rb

@@ -0,0 +1,29 @@
+DataGrid.setup do |config|
+
+  # Default per page
+  config.per_page = 20
+
+  # Used in URL in range filter
+  config.range_separator = '--#--' 
+
+  # Default columns sortable state
+  config.column_sortable = false 
+
+  # Default column summary formatter
+  config.column_summary_formatter = 'plain_text'
+
+  # Default sort direction
+  config.sort_direction = 'asc'
+
+  # Show table footer
+  config.show_footer = true
+
+  # Available per page options
+  config.available_per_pages = [[10,10],[20,20],[50,50],[100,100],[500,500]]
+
+  # Method used to save grid state
+  config.state_saver_method = 'cookies'
+
+  # Default export filename
+  config.export_filename = 'export_to_csv.csv'
+end

data/lib/generators/templates/stylesheets/data_grid/data_grid_3_0.css

@@ -0,0 +1,90 @@
+div.data_grid {
+    font-family: Verdana, Arial, Helvetica, sans-serif;
+    font-size: 12px;
+}
+
+table.data_grid {
+    border: 1px solid #808080;
+    border-collapse: separate;
+    width: 100%;
+}
+
+table.data_grid th {
+    text-align: left;
+    background-color: #C6D4E4;
+    padding: 6px 3px;
+    color: #000;
+    line-height: 18px;
+}
+
+table.data_grid td {
+    border-width: 1px;
+    padding: 3px;
+    border-style: none;
+    border-color: #011b36;
+    color: #000;
+    font-size: 11px;
+    line-height: 18px;
+    padding-left: 4px;
+}
+
+table.data_grid td.odd { background-color: #F0FFF0; }
+
+table.data_grid tr.filters td { 
+  background-color: #E9F0F4; 
+  border-bottom: 1px solid #C0C0C0;
+}
+
+table.data_grid a, table.data_grid a:active, table.data_grid a:focus { color: #12c; }
+
+table.data_grid tr:hover td.data_grid_row { background-color: #ddd; }
+
+table.data_grid td.grid_no_data {
+  font-size:16px; 
+  font-weight:bold;
+}
+
+table.data_grid tr.summary td { background-color: #E9F0F4; }
+
+table.data_grid tfoot tr td { background-color: #E9F0F4; }
+
+table.data_grid a.sorting.down {
+  padding-right: 13px;
+  background: url("/images/data_grid/sort_down.gif") right 4px no-repeat; 
+}
+
+table.data_grid a.sorting.up {
+  padding-right: 13px;
+  background: url("/images/data_grid/sort_up.gif") right 4px no-repeat; 
+}
+
+table.data_grid tfoot td div { margin: 0; padding: 0; }
+table.data_grid tfoot td .data_grid_fl { float:left; }
+table.data_grid tfoot td .data_grid_fr { float:right; }
+table.data_grid tfoot td .data_grid_lmargin { margin-left: 20px; }
+
+table.data_grid tfoot td .pagination { margin-right: 40px; }
+table.data_grid tfoot td ul.data_grid_pagination {
+  display: inline-block;
+  padding: 0;
+  margin: 0;
+  
+  *float: left;
+}
+table.data_grid tfoot td ul.data_grid_pagination li {
+  display: inline;
+  font-size: 14px;
+  font-weight: bold;
+  float: none;
+  margin: 0 2px;
+}
+table.data_grid tfoot td ul.data_grid_pagination a {
+  display: inline-block;
+  font-weight: bold;
+  font-size: 12px;
+
+  *display: block;
+}
+
+table.data_grid form input.data_grid_filter_input { width: 48px; }
+

data/spec/orm_spec.rb

@@ -0,0 +1,57 @@
+require 'active_support'
+require 'support/active_record'
+require 'data_grid/data_grid_logic'
+require 'data_grid/data_source_orm'
+
+describe DataGrid::DataSourceORM do
+  it "selects right data source (ORM)" do
+    data_grid_logic = DataGrid::DataGridLogic.new(:params => ActiveSupport::HashWithIndifferentAccess.new())
+    data_grid_logic.add_column(:name, :title => 'Name')
+    data_grid_logic.data = User.scoped
+
+    data_grid_logic.in_data.class.should eql(ActiveRecord::Relation)
+  end
+ 
+  it "paginate 10 per page from configuraion" do
+    data_grid_logic = DataGrid::DataGridLogic.new(:params => ActiveSupport::HashWithIndifferentAccess.new(:"page_" => '1'))
+    data_grid_logic.add_column(:name, :title => 'Name')
+    data_grid_logic.per_page = 10
+    data_grid_logic.data = User.scoped
+    data_grid_logic.get_params_from_request
+    data_grid_logic.prepare_data
+
+    data_grid_logic.out_data.size.should eql(10)
+  end
+
+  it "paginate 10 per page from params" do
+    data_grid_logic = DataGrid::DataGridLogic.new(:params => ActiveSupport::HashWithIndifferentAccess.new(:"page_" => '1', :"per_page_" => '10'))
+    data_grid_logic.add_column(:name, :title => 'Name')
+    data_grid_logic.per_page = 20
+    data_grid_logic.data = User.scoped
+    data_grid_logic.get_params_from_request
+    data_grid_logic.prepare_data
+
+    data_grid_logic.out_data.size.should eql(10)
+  end
+
+  it "paginate correct data and sort correctly" do
+    data_grid_logic = DataGrid::DataGridLogic.new(:params => ActiveSupport::HashWithIndifferentAccess.new(:"page_" => '2', :"per_page_" => '10', :"sort_" => 'name', :"sort_direction_" => 'ASC'))
+    data_grid_logic.add_column(:name, :title => 'Name')
+    data_grid_logic.data = User.scoped
+    data_grid_logic.get_params_from_request
+    data_grid_logic.prepare_data
+
+    data_grid_logic.out_data.first[0].should eql('John_19')
+  end
+
+  it "filter text method" do
+    data_grid_logic = DataGrid::DataGridLogic.new(:params => ActiveSupport::HashWithIndifferentAccess.new(:"page_" => '1', :"per_page_" => '10', :"filter__0" => '9', :"sort_" => 'name', :"sort_direction_" => 'ASC'))
+    data_grid_logic.add_column(:name, :title => 'Name', :filter => :text)
+    data_grid_logic.data = User.scoped
+    data_grid_logic.get_params_from_request
+    data_grid_logic.prepare_data
+
+    data_grid_logic.out_data.size.should eql(5)
+    data_grid_logic.out_data.first[0].should eql('John_19')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+ 
+ENV["RAILS_ENV"] ||= 'test'
+ 
+require "rails/all"
+
+require 'rspec/rails'
+ 
+root = File.expand_path(File.dirname(__FILE__))
+ 
+RSpec.configure do |config|
+end
+ 
+require 'data_grid'

data/spec/support/active_record.rb

@@ -0,0 +1,17 @@
+require 'active_record'
+require 'rspec/rails/extensions/active_record/base'
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: ":memory:"
+
+ActiveRecord::Migration.create_table :users do |t|
+  t.string :name
+  t.timestamps
+end
+
+class User < ActiveRecord::Base
+end
+
+1.upto(50) do |i|
+  User.create({
+    :name => "John_#{i}"
+  })
+end