data_grid 0.0.1 → 0.0.2

data/app/assets/stylesheets/data_grid/grid_calendar/skins/aqua/theme.css

@@ -0,0 +1,236 @@
+/* Distributed as part of The Coolest DHTML Calendar
+   Author: Mihai Bazon, www.bazon.net/mishoo
+   Copyright Dynarch.com 2005, www.dynarch.com
+*/
+
+/* The main calendar widget.  DIV containing a table. */
+
+div.calendar { position: relative; }
+
+.calendar, .calendar table {
+  border: 1px solid #bdb2bf;
+  font-size: 11px;
+  color: #000;
+  cursor: default;
+  background: url("normal-bg.gif");
+  font-family: "trebuchet ms",verdana,tahoma,sans-serif;
+}
+
+.calendar {
+  border-color: #797979;
+}
+
+/* Header part -- contains navigation buttons and day names. */
+
+.calendar .button { /* "<<", "<", ">", ">>" buttons have this class */
+  text-align: center;    /* They are the navigation buttons */
+  padding: 2px;          /* Make the buttons seem like they're pressing */
+  background: url("title-bg.gif") repeat-x 0 100%; color: #000;
+  font-weight: bold;
+}
+
+.calendar .nav {
+  font-family: verdana,tahoma,sans-serif;
+}
+
+.calendar .nav div {
+  background: transparent url("menuarrow.gif") no-repeat 100% 100%;
+}
+
+.calendar thead tr { background: url("title-bg.gif") repeat-x 0 100%; color: #000; }
+
+.calendar thead .title { /* This holds the current "month, year" */
+  font-weight: bold;      /* Pressing it will take you to the current date */
+  text-align: center;
+  padding: 2px;
+  background: url("title-bg.gif") repeat-x 0 100%; color: #000;
+}
+
+.calendar thead .headrow { /* Row <TR> containing navigation buttons */
+}
+
+.calendar thead .name { /* Cells <TD> containing the day names */
+  border-bottom: 1px solid #797979;
+  padding: 2px;
+  text-align: center;
+  color: #000;
+}
+
+.calendar thead .weekend { /* How a weekend day name shows in header */
+  color: #c44;
+}
+
+.calendar thead .hilite { /* How do the buttons in header appear when hover */
+  background: url("hover-bg.gif");
+  border-bottom: 1px solid #797979;
+  padding: 2px 2px 1px 2px;
+}
+
+.calendar thead .active { /* Active (pressed) buttons in header */
+  background: url("active-bg.gif"); color: #fff;
+  padding: 3px 1px 0px 3px;
+  border-bottom: 1px solid #797979;
+}
+
+.calendar thead .daynames { /* Row <TR> containing the day names */
+  background: url("dark-bg.gif");
+}
+
+/* The body part -- contains all the days in month. */
+
+.calendar tbody .day { /* Cells <TD> containing month days dates */
+  font-family: verdana,tahoma,sans-serif;
+  width: 2em;
+  color: #000;
+  text-align: right;
+  padding: 2px 4px 2px 2px;
+}
+.calendar tbody .day.othermonth {
+  font-size: 80%;
+  color: #999;
+}
+.calendar tbody .day.othermonth.oweekend {
+  color: #f99;
+}
+
+.calendar table .wn {
+  padding: 2px 3px 2px 2px;
+  border-right: 1px solid #797979;
+  background: url("dark-bg.gif");
+}
+
+.calendar tbody .rowhilite td,
+.calendar tbody .rowhilite td.wn {
+  background: url("rowhover-bg.gif");
+}
+
+.calendar tbody td.today { font-weight: bold; /* background: url("today-bg.gif") no-repeat 70% 50%; */ }
+
+.calendar tbody td.hilite { /* Hovered cells <TD> */
+  background: url("hover-bg.gif");
+  padding: 1px 3px 1px 1px;
+  border: 1px solid #bbb;
+}
+
+.calendar tbody td.active { /* Active (pressed) cells <TD> */
+  padding: 2px 2px 0px 2px;
+}
+
+.calendar tbody td.weekend { /* Cells showing weekend days */
+  color: #c44;
+}
+
+.calendar tbody td.selected { /* Cell showing selected date */
+  font-weight: bold;
+  border: 1px solid #797979;
+  padding: 1px 3px 1px 1px;
+  background: url("active-bg.gif"); color: #fff;
+}
+
+.calendar tbody .disabled { color: #999; }
+
+.calendar tbody .emptycell { /* Empty cells (the best is to hide them) */
+  visibility: hidden;
+}
+
+.calendar tbody .emptyrow { /* Empty row (some months need less than 6 rows) */
+  display: none;
+}
+
+/* The footer part -- status bar and "Close" button */
+
+.calendar tfoot .footrow { /* The <TR> in footer (only one right now) */
+  text-align: center;
+  background: #565;
+  color: #fff;
+}
+
+.calendar tfoot .ttip { /* Tooltip (status bar) cell <TD> */
+  padding: 2px;
+  background: url("status-bg.gif") repeat-x 0 0; color: #000;
+}
+
+.calendar tfoot .hilite { /* Hover style for buttons in footer */
+  background: #afa;
+  border: 1px solid #084;
+  color: #000;
+  padding: 1px;
+}
+
+.calendar tfoot .active { /* Active (pressed) style for buttons in footer */
+  background: #7c7;
+  padding: 2px 0px 0px 2px;
+}
+
+/* Combo boxes (menus that display months/years for direct selection) */
+
+.calendar .combo {
+  position: absolute;
+  display: none;
+  top: 0px;
+  left: 0px;
+  width: 4em;
+  cursor: default;
+  border-width: 0 1px 1px 1px;
+  border-style: solid;
+  border-color: #797979;
+  background: url("normal-bg.gif"); color: #000;
+  z-index: 100;
+  font-size: 90%;
+}
+
+.calendar .combo .label,
+.calendar .combo .label-IEfix {
+  text-align: center;
+  padding: 1px;
+}
+
+.calendar .combo .label-IEfix {
+  width: 4em;
+}
+
+.calendar .combo .hilite {
+  background: url("hover-bg.gif"); color: #000;
+}
+
+.calendar .combo .active {
+  background: url("active-bg.gif"); color: #fff;
+  font-weight: bold;
+}
+
+.calendar td.time {
+  border-top: 1px solid #797979;
+  padding: 1px 0px;
+  text-align: center;
+  background: url("dark-bg.gif");
+}
+
+.calendar td.time .hour,
+.calendar td.time .minute,
+.calendar td.time .ampm {
+  padding: 0px 5px 0px 6px;
+  font-weight: bold;
+  background: url("normal-bg.gif"); color: #000;
+}
+
+.calendar td.time .hour,
+.calendar td.time .minute {
+  font-family: monospace;
+}
+
+.calendar td.time .ampm {
+  text-align: center;
+}
+
+.calendar td.time .colon {
+  padding: 0px 2px 0px 3px;
+  font-weight: bold;
+}
+
+.calendar td.time span.hilite {
+  background: url("hover-bg.gif"); color: #000;
+}
+
+.calendar td.time span.active {
+  background: url("active-bg.gif"); color: #fff;
+}

data/app/views/data_grid/_data_grid.html.erb

@@ -0,0 +1,101 @@
+<div class="data_grid">
+  <table class="data_grid" width="99%" cellpadding="0" cellspacing="0">
+    <tbody>
+      <tr>
+        <% data_grid.columns.each do |col| %>
+          <th class="<%= col.filter_active? ? "filter" : '' %>">
+            <%= data_grid_header(data_grid, col) %>
+          </th>
+        <% end %>
+      </tr>
+
+      <% if data_grid.filters? %>
+        <tr class="filters">
+          <% data_grid.columns.each do |col| %>
+            <td class="<%= col.filter_active? ? "filter" : '' %>">
+              <%= data_grid_filter(data_grid, col) %>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+
+      <% if data_grid.out_data.empty? %>
+        <tr>
+          <td colspan="<%= data_grid.columns.size %>" class="grid_no_data data_grid_row">
+            <br />
+            <%= t('data_grid.no_data') %>
+            <br />
+            <br />
+          </td>
+        </tr>
+      <% else %>
+        <% data_grid.out_data.each_with_index do |row, row_index| %>
+          <tr>
+            <% data_grid.columns.each_with_index do |col, col_index| %>
+              <% cell = row[col_index].is_a?(Array) ? row[col_index][0] : row[col_index] %>
+              <td class="<%= (row_index.odd? ? "odd " : '') + (col.css_class).to_s + ' data_grid_row'  %>" style="<%= col.style ? "#{(data_grid.row_styles[row_index].to_s if data_grid.row_styles).to_s + ';' + col.style}" : data_grid.row_styles ? "#{data_grid.row_styles[row_index]}" : '' %>">
+                <%= col.formatter ? send("data_grid_formatter_#{col.formatter}", cell) : cell %>
+              </td>
+            <% end %>
+          </tr> 
+          <% unless data_grid.hidden_row.nil? %>
+            <tr>
+              <td colspan="<%= data_grid.columns.size %>">
+                <%= data_grid.out_hidden_rows[row_index] %>
+              </td>
+            </tr>
+          <% end %>
+        <% end %>
+      <% end %>
+
+      <% if data_grid.summary? %>
+        <tr class="summary">
+          <% data_grid.columns.each_with_index  do |col, col_index| %>
+            <td>
+              <%= col.summary_formatter ? send("data_grid_formatter_#{col.summary_formatter}", data_grid.summaries[col_index].to_s) : data_grid.summaries[col_index].to_s  %>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+
+      <% if data_grid.global_summary? %>
+        <tr class="summary">
+          <% data_grid.columns.each_with_index  do |col, col_index| %>
+            <td>
+              <%= col.summary_formatter ? send("data_grid_formatter_#{col.summary_formatter}", data_grid.global_summaries[col_index].to_s) : data_grid.global_summaries[col_index].to_s %>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+
+      <% if data_grid.footer? %>
+        <tfoot>
+          <tr>
+            <td colspan="<%= data_grid.columns.size + 1 %>">
+              <div class="data_grid_fl">
+                <%= t('data_grid.results') %>:
+                <%=  data_grid.entries_from %>
+                - 
+                <%= data_grid.entries_to %>
+                /
+                <%= data_grid.total %>
+              </div>
+              <% if data_grid.export_enabled %>
+                <div class="data_grid_fl data_grid_lmargin">
+                  <%= data_grid_export_link(data_grid) %>
+                </div>
+              <% end %>
+              <div class="data_grid_fr">
+                <%= t('data_grid.per_page') %>:
+                <%= data_grid_per_page_selector(data_grid) %>
+              </div>
+              <div class="pagination data_grid_fr">
+                <%= data_grid_pager(data_grid) %>
+              </div>
+            </td>
+          </tr>
+        </tfoot>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  data_grid:
+    no_data: No data ...
+    results: Results
+    per_page: Per page
+    filter_date_from: From
+    filter_date_to: To
+    all_options: All
+    option_true: 'Yes'
+    option_false: 'No'

data/data_grid.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'data_grid/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "data_grid"
+  gem.version       = DataGrid::VERSION
+  gem.authors       = ["Krzysztof Kempiński"]
+  gem.email         = ["kkempin@gmail.com"]
+  gem.description   = %q{This gem generates configurable grids for Rails applications}
+  gem.summary       = %q{data grid tool for Rails applications}
+  gem.homepage      = "https://github.com/kkempin/data_grid"
+
+  gem.required_rubygems_version = ">= 1.3.6"
+  gem.add_dependency "rails", ">= 3.0"
+  gem.add_dependency "fastercsv"
+  gem.add_development_dependency "bundler", ">= 1.0.0"
+  gem.add_development_dependency "rspec", "~> 2.6"
+  gem.add_development_dependency "rspec-rails"
+  gem.add_development_dependency "sqlite3"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/data_grid/column.rb

@@ -0,0 +1,38 @@
+# Class Column used to define colums in DataGrid
+
+module DataGrid
+  class Column
+
+    attr_accessor :field, :title, :sortable, :sort_by, :filter, :filter_data, :filter_value, :filter_by, :style, :summary, :summary_formatter, :formatter, :hide_in_export, :css_class, :global_summary, :auto_filter_hash
+
+    def initialize(column_field, attrs = {})
+      self.sortable = attrs[:sortable] || DataGrid.column_sortable 
+      self.title = attrs[:title]
+      self.field = column_field
+      self.sort_by = attrs[:sort_by] || self.field
+      self.filter = attrs[:filter]
+      self.filter_data = []
+      self.style = attrs[:style]
+      self.summary = attrs[:summary]
+      self.global_summary = attrs[:global_summary]
+      self.summary_formatter = attrs[:summary_formatter] || DataGrid.column_summary_formatter
+      self.formatter = attrs[:formatter]
+      self.filter_by = attrs[:filter_by] || self.field
+      self.hide_in_export = attrs[:hide_in_export] || false
+      self.css_class = attrs[:css_class] || ''
+      self.auto_filter_hash = attrs[:auto_filter_hash]
+    end
+
+    def sort_field
+      if self.field.class == Symbol
+        return self.sort_by ? self.sort_by : self.field
+      else
+        return self.sort_by
+      end
+    end
+    
+    def filter_active?
+      !self.filter_value.to_s.split(DataGrid.range_separator).first.blank?
+    end
+  end
+end

data/lib/data_grid/controller.rb

@@ -0,0 +1,30 @@
+module DataGrid
+  module Controller
+    extend ActiveSupport::Concern
+
+    def prepare_grid(&block)
+      # Build logic object
+      data_grid = DataGrid::DataGridLogic.new(:params => params)
+      block.call(data_grid)
+
+      # Restore state
+      if data_grid.state_saver and DataGrid.state_saver_method
+        require "data_grid/#{DataGrid.state_saver_method}_state_saver"
+        self.restore_state(data_grid)
+      end
+
+      # Get and save data from params
+      data_grid.get_params_from_request
+      self.save_state(data_grid) if data_grid.state_saver
+
+      # Export on demand
+      if data_grid.export_enabled and params["export_#{data_grid.name}"]
+        require "data_grid/#{params["export_#{data_grid.name}"]}_exporter"
+        self.export(data_grid, data_grid.export_filename)
+      end
+      
+      data_grid
+    end
+
+  end
+end

data/lib/data_grid/cookies_state_saver.rb

@@ -0,0 +1,42 @@
+# State consists of actual per_page, page, sort, sort direction of DataGrid
+
+module DataGrid
+  module Controller
+
+    STATE_KEYS = [:per_page, :page, :sort, :sort_direction]
+
+    # Save grid state in cookies
+    def save_state(data_grid)
+      cookies["data_grid_state_#{data_grid.name}"] ||= {}
+    
+      state = {}
+      STATE_KEYS.each do |key|
+        state[key] = data_grid.send(key)
+      end
+      
+      data_grid.columns.each_with_index do |col, col_index|
+        state[:columns] ||= {}
+        state[:columns][col_index] = col.filter_value
+      end
+      
+      cookies["data_grid_state_#{data_grid.name}"] = Marshal.dump(state)
+    end
+  
+    # Restore state from cookies
+    def restore_state(data_grid)
+      if cookies["data_grid_state_#{data_grid.name}"]
+        state = Marshal.load(cookies["data_grid_state_#{data_grid.name}"])
+        STATE_KEYS.each do |key|
+          data_grid.send("#{key}=", state[key])
+        end
+      
+        if state[:columns]
+          state[:columns].each_pair do |k, v|
+            data_grid.columns[k.to_i].filter_value = v if data_grid.columns[k.to_i]
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/data_grid/csv_exporter.rb

@@ -0,0 +1,79 @@
+# Module used to export data to CSV
+
+class CsvContent 
+  include ActionView::Helpers::TagHelper 
+  include ActionView::Helpers::FormTagHelper
+
+  def image_tag name, options = nil
+    ''
+  end
+
+  def link_to name, options=nil, extra=nil
+    name
+  end
+
+  def raw s=''
+    s.to_s.gsub('<br />', ', ')
+  end
+end
+
+
+module DataGrid
+  module Controller
+    # Do CSV export
+     def export(data_grid, filename = DataGrid.export_filename)
+      require 'csv'
+      
+      if request.env['HTTP_USER_AGENT'] =~ /msie/i
+       headers['Pragma'] = 'public'
+       headers["Content-type"] = "text/plain; charset=utf-8; header=present"
+       headers['Cache-Control'] = 'no-cache, must-revalidate, post-check=0, pre-check=0'       
+       headers['Content-Disposition'] = "attachment; filename=\"#{filename}\""
+       headers['Expires'] = "0" 
+      else
+        headers["Content-Type"] ||= 'text/csv; charset=utf-8; header=present'   
+        headers["Content-Disposition"] = "attachment; filename=\"#{filename}\""
+      end  
+      data_grid.view_context = CsvContent.new
+      data_grid.prepare_data
+
+      csv_string = CSV.generate(:col_sep => ';') do |csv|
+        hide_column_indexes = []
+        cols = []
+        data_grid.columns.each_with_index do |col, i|
+          if col.hide_in_export 
+            hide_column_indexes << i
+          else
+            cols << col.title
+          end
+        end
+        csv << cols
+        data_grid.out_data.each_with_index do |row, row_index|
+          data_row = []
+          row.each_with_index do |row_col, i|
+            next if (!data_grid.hidden_row.nil? and i == row.size-1)
+            unless hide_column_indexes.include?(i)
+              data_row << ((row_col.class == ActiveSupport::SafeBuffer) ? row_col.to_s.gsub(/<\/?[^>]*>/, "") : (row_col.class == String) ? row_col.gsub(/<\/?[^>]*>/, "") : row_col)
+            end
+          end
+          unless data_grid.hidden_row.nil?
+            data_row << data_grid.out_hidden_rows[row_index] 
+          end
+          csv << data_row
+        end
+
+        if data_grid.summary? 
+          data_row = []
+			    data_grid.columns.each_with_index {|col, i| 
+          	data_row <<  data_grid.summaries[i].to_s unless hide_column_indexes.include?(i)
+          } 
+          csv << data_row
+			  end 
+
+      end
+
+      render :text => csv_string
+    end
+  end
+end
+