datagrid 0.9.3 → 1.0.0

data/Readme.markdown

@@ -93,12 +93,12 @@ In order to create a report, you need to define:
 ### Scope
 
 Default scope of objects to filter and display.
-In common case it is `ActiveRecord::Base` (or any other supported ORM) subclass with some generic scopes like in example above:
+In common case it is `ActiveRecord::Base` (or any other supported ORM) subclass with some generic scopes like:
 
 ``` ruby
-  scope do
-    User.includes(:group)
-  end
+scope do
+  User.includes(:group)
+end
 ```
 
 [More about scope](https://github.com/bogdan/datagrid/wiki/Scope)
@@ -116,11 +116,13 @@ Datagrid supports different type of filters including:
 
 * text
 * integer
+* float
 * date
 * boolean
 * eboolean - the select of "yes", "no" and any
 * enum
 * string
+* dynamic
 
 [More about filters](https://github.com/bogdan/datagrid/wiki/Filters)
 

data/VERSION

@@ -1 +1 @@
-0.9.3
+1.0.0

data/app/assets/stylesheets/datagrid.css.sass

@@ -0,0 +1,132 @@
+$dg-form-label: 150px
+
+= clearfix
+  *zoom: 1
+
+  &:before,
+  &:after
+    display: table
+    content: ''
+
+  &:after
+    clear: both
+
+=inline-block
+  display: inline-block
+  zoom: 1
+  *display: inline
+
+table.datagrid
+  background-color: transparent
+  border-collapse: collapse
+  max-width: 100%
+
+  th
+    background-color: #eee
+    text-align: left
+
+  td,
+  th 
+    border: 1px solid #d6d6d6
+    padding: 5px 10px
+
+    .order
+      a.asc, a.desc
+        text-decoration: none
+        font-weight: normal
+
+    &.ordered
+      background-color: #fff7d5
+
+      &.asc
+        a.asc
+          font-weight: bold
+          color: #d00
+
+      &.desc
+        a.desc
+          font-weight: bold
+          color: #d00
+  .noresults
+    text-align: center
+    
+.datagrid-form
+  background-color: #f0f0f0
+  border-radius: 5px
+  padding: 20px
+
+.datagrid-filter
+  margin: 10px
+  +clearfix
+
+  label
+    width: $dg-form-label
+    float: left
+  a
+    float: left
+
+    &.dp-choose-date
+      margin-left: -22px
+      margin-top: 7px
+
+  input[class*='filter']
+    border: 2px solid #ccc
+    border-radius: 4px
+    float: left
+    padding: 5px 12px
+    width: 207px
+
+    &.from, &.to
+      width: 83px
+
+  select
+    float: left
+    width: 235px
+
+    &[multiple]
+      border: 2px solid #ccc
+      border-radius: 5px
+      height: 100px
+    &.dynamic_filter
+      &.field
+        width: 178px
+      &.operation
+        margin-left: 7px
+        width: 50px
+  input.dynamic_filter.value
+    margin: 10px 0 0 $dg-form-label
+    clear: both
+
+  .separator
+    float: left
+    margin: 6px 4px 0
+
+
+.datagrid-actions
+  padding-left: $dg-form-label +10
+
+  input[type='submit']
+    background-color: #555
+    border: none
+    border-radius: 5px
+    color: white
+    cursor: pointer
+    font-size: 14px
+    font-weight: bold
+    line-height: normal
+    padding: 7px 15px
+    vertical-align: middle
+    +inline-block
+
+    &:hover,
+    &:focus
+      background-color: #333
+
+    &:active
+      background-color: #000
+
+  > a
+    font-size: 14px
+    padding: 7px 15px
+    vertical-align: middle
+    +inline-block

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

@@ -1,9 +1,12 @@
 <%= form_for grid, options do |f| -%>
   <% grid.filters.each do |filter| %>
-    <div class="filter">
+    <div class="datagrid-filter filter">
       <%= f.datagrid_label filter %>
       <%= f.datagrid_filter filter %>
     </div>
   <% end %>
-  <%= f.submit I18n.t("datgrid.form.submit", :default => "Search").html_safe %>
+  <div class="datagrid-actions">
+    <%= f.submit I18n.t("datagrid.form.search").html_safe, :class => "datagrid-submit" %>
+    <%= link_to I18n.t('datagrid.form.reset').html_safe, url_for(grid.to_param => {}), :class => "datagrid-reset" %>
+  </div>
 <% end -%>

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,
+      I18n.t("datagrid.table.order.asc").html_safe,
       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,
+      I18n.t("datagrid.table.order.desc").html_safe,
       url_for(grid.param_name => grid.as_query.merge(:order => column.name, :descending => true )),
       :class => "desc") %>
 </div>

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

@@ -10,7 +10,7 @@ Local variables:
   </thead>
   <tbody>
     <% if assets.empty? %>
-    <tr><td class="noresults" colspan="100%"><%= I18n.t 'datagrid.no_results', :default => '&mdash;&mdash;'.html_safe %></td></tr>
+    <tr><td class="noresults" colspan="100%"><%= I18n.t('datagrid.no_results').html_safe %></td></tr>
     <% else %>
     <%= datagrid_rows(grid, assets, options) %>
     <% end %>

data/datagrid.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "datagrid"
-  s.version = "0.9.3"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2013-08-26"
+  s.date = "2013-09-19"
   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 = [
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
     "Rakefile",
     "Readme.markdown",
     "VERSION",
+    "app/assets/stylesheets/datagrid.css.sass",
     "app/views/datagrid/_form.html.erb",
     "app/views/datagrid/_head.html.erb",
     "app/views/datagrid/_order_for.html.erb",
@@ -50,13 +51,17 @@ Gem::Specification.new do |s|
     "lib/datagrid/filters/composite_filters.rb",
     "lib/datagrid/filters/date_filter.rb",
     "lib/datagrid/filters/default_filter.rb",
+    "lib/datagrid/filters/dynamic_filter.rb",
     "lib/datagrid/filters/enum_filter.rb",
     "lib/datagrid/filters/float_filter.rb",
     "lib/datagrid/filters/integer_filter.rb",
     "lib/datagrid/filters/ranged_filter.rb",
+    "lib/datagrid/filters/select_options.rb",
     "lib/datagrid/filters/string_filter.rb",
     "lib/datagrid/form_builder.rb",
     "lib/datagrid/helper.rb",
+    "lib/datagrid/i18n.rb",
+    "lib/datagrid/locale/en.yml",
     "lib/datagrid/ordering.rb",
     "lib/datagrid/renderer.rb",
     "lib/datagrid/rspec.rb",
@@ -74,9 +79,11 @@ Gem::Specification.new do |s|
     "spec/datagrid/filters/boolean_enum_filter_spec.rb",
     "spec/datagrid/filters/composite_filters_spec.rb",
     "spec/datagrid/filters/date_filter_spec.rb",
+    "spec/datagrid/filters/dynamic_filter_spec.rb",
     "spec/datagrid/filters/enum_filter_spec.rb",
     "spec/datagrid/filters/float_filter_spec.rb",
     "spec/datagrid/filters/integer_filter_spec.rb",
+    "spec/datagrid/filters/string_filter_spec.rb",
     "spec/datagrid/filters_spec.rb",
     "spec/datagrid/form_builder_spec.rb",
     "spec/datagrid/helper_spec.rb",
@@ -99,7 +106,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/bogdan/datagrid"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.25"
   s.summary = "Ruby gem to create datagrids"
 
   if s.respond_to? :specification_version then

data/lib/datagrid.rb

@@ -46,5 +46,6 @@ module Datagrid
 end
 
 require "datagrid/scaffold"
+I18n.load_path << File.expand_path('../datagrid/locale/en.yml', __FILE__)
 
 

data/lib/datagrid/column_names_attribute.rb

@@ -9,7 +9,7 @@ module Datagrid
       datagrid_attribute :column_names do |names|
         names = Array(names).reject(&:blank?)
         if names.reject(&:blank?).blank?
-          columns.map(&:name)
+          []
         else
           names
         end
@@ -18,10 +18,12 @@ module Datagrid
 
     module ClassMethods
       # Adds a filter that acts like a column selection
-      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
+      def column_names_filter(options = {})
+        filter(:column_names, :enum, {
+          :select => :optional_columns_select,
+          :multiple => true,
+          :dummy => true
+        }.merge(options || {}))
       end
     end
 
@@ -32,17 +34,46 @@ module Datagrid
       super(*column_names)
     end
 
+    # Returns a list of columns with <tt>:mandatory => true</tt> option
+    # If no mandatory columns specified than all of them considered mandatory
+    def mandatory_columns
+      self.class.columns.select(&:mandatory?)
+    end
+
+    # Returns a list of columns without <tt>:mandatory => true</tt> option
+    def optional_columns
+      self.class.columns - mandatory_columns
+    end
+
     protected
 
-    def selected_column_names(*args)
+    def optional_columns_select #:nodoc:
+      optional_columns.map {|c| [c.header, c.name] }
+    end
+
+    def selected_column_names(*args)                  
       if args.any?
         args.compact!
         args.map!(&:to_sym)
         args
       else
-        column_names ? column_names.clone : []
+        if column_names && column_names.any?
+          column_names + mandatory_columns.map(&:name)
+        else
+          columns_enabled_by_default.map(&:name)
+        end
       end
     end
+
+    def columns_visibility_enabled?
+      self.class.columns.any? do |column|
+        column.options.key?(:mandatory)
+      end
+    end
+
+    def columns_enabled_by_default
+      columns_visibility_enabled? ? mandatory_columns : []
+    end
   end
 end
 

data/lib/datagrid/columns.rb

@@ -12,12 +12,39 @@ module Datagrid
 
         include Datagrid::Core
 
+        class_attribute :default_column_options
+        self.default_column_options = {}
+
       end
       base.send :include, InstanceMethods
     end # self.included
 
     module ClassMethods
 
+
+      ##
+      # :method: default_column_options=
+      #
+      # :call-seq: default_column_options=(options)
+      #
+      # Specifies default options for `column` method.
+      # They still can be overwritten at column level.
+      #
+      #   # Disable default order
+      #   self.default_column_options = { :order => false }
+      #   # Makes entire report HTML
+      #   self.default_column_options = { :html => true }
+      #
+
+      ##
+      # :method: default_column_options
+      #
+      # :call-seq: default_column_options
+      #
+      # Returns specified default column options hash
+      # See <tt>default_column_options=</tt> for more information
+      #
+
       # Returns a list of columns defined.
       # All column definistion are returned by default
       # You can limit the output with only columns you need like:
@@ -32,7 +59,7 @@ module Datagrid
         args.compact!
         args.map!(&:to_sym)
         columns_array.select do |column|
-          (!options[:data] || column.data?) && (!options[:html] || column.html?)&& (args.empty? || args.include?(column.name))
+          (!options[:data] || column.data?) && (!options[:html] || column.html?) && (column.mandatory? || args.empty? || args.include?(column.name))
         end
       end
 
@@ -47,8 +74,15 @@ module Datagrid
       # Available options:
       #   
       #   * <tt>:html</tt> - determines if current column should be present in html table and how is it formatted
-      #   * <tt>:order</tt> - determines if this column could be sortable and how
-      #   * <tt>:order_desc</tt> - determines a descending order for given column (only in case when <tt>:order</tt> can not be easily inverted
+      #   * <tt>:order</tt> - determines if this column could be sortable and how. 
+      #     The value of order is explicitly passed to ORM ordering method. 
+      #     Ex: <tt>"created_at, id"</tt> for ActiveRecord, <tt>[:created_at, :id]</tt> for Mongoid
+      #   * <tt>:order_desc</tt> - determines a descending order for given column 
+      #     (only in case when <tt>:order</tt> can not be easily reversed by ORM)
+      #   * <tt>:order_by_value</tt> - used in case it is easier to perform ordering at ruby level not on database level. 
+      #     Warning: using ruby to order large datasets is very unrecommended. 
+      #     If set to true - datagrid will use column value to order by this column
+      #     If block is given - datagrid will use value returned from block
       #   * <tt>:url</tt> - a proc with one argument, pass this option to easily convert the value into an URL
       #   * <tt>:before</tt> - determines the position of this column, by adding it before the column passed here
       #   * <tt>:after</tt> - determines the position of this column, by adding it after the column passed here
@@ -60,7 +94,7 @@ module Datagrid
           model.send(name)
         end
         position = Datagrid::Utils.extract_position_from_options(columns_array, options)
-        column = Datagrid::Columns::Column.new(self, name, options, &block)
+        column = Datagrid::Columns::Column.new(self, name, default_column_options.merge(options), &block)
         columns_array.insert(position, column)
       end
 

data/lib/datagrid/columns/column.rb

@@ -58,13 +58,29 @@ class Datagrid::Columns::Column
   end
 
   def order
-    if options.has_key?(:order)
+    if options.has_key?(:order) && options[:order] != true
       self.options[:order]
     else
       grid_class.driver.default_order(grid_class.scope, name)
     end
   end
 
+  def supports_order?
+    order || order_by_value?
+  end
+
+  def order_by_value(model, grid)
+    if options[:order_by_value] == true
+      data_value(model, grid)
+    else
+      Datagrid::Utils.apply_args(model, grid, &options[:order_by_value])
+    end
+  end
+
+  def order_by_value?
+    !! options[:order_by_value]
+  end
+
   def order_desc
     return nil unless order
     self.options[:order_desc]  
@@ -77,6 +93,18 @@ class Datagrid::Columns::Column
   def data?
     self.data_block != nil
   end
+  
+  def mandatory?
+    !! options[:mandatory]
+  end
+
+  def inspect
+    "#<Datagird::Columns::Column #{grid_class}##{name} #{options.inspect}>"
+  end
+
+  def to_s
+    header
+  end
 
   def html_value(context, asset, grid)
     if html? && html_block