datagrid 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44f9ec4967241697a3299e94ea4c112eee7976a0
-  data.tar.gz: 704336e23cb2865df032a9842a0c74797a43b19b
+  metadata.gz: 87a528983e7fd2ef73cf521c573fec464b5461cb
+  data.tar.gz: f74b44092e5cb1b1c5c076514c655c6874729f45
 SHA512:
-  metadata.gz: ef2563a325877ffa13f721b5903e5381e064804a35d007e15d5ad279691504886e157c956a56698594351232782a9b9be45afb52038eacfad59f9e3553e31307
-  data.tar.gz: f30f96c8b933c2cc71636f0183615a47c6fe25a0658ea6c4cfd0a6ca738babaf4a1606be3b32071bfc93a505f4d58975327231759f6e70dba57e16830781bfd2
+  metadata.gz: 5a60e18d5454ad9dabc58d4c367b5b93b1d589d6c4a5dc6aa8d2a7836b4046c587a21fdd694c1553f5746fb4c6b76851fb95a38d8062a6a1cb993e6f06081ff0
+  data.tar.gz: 09c2cc3b93a3387d1b36eb09bf42c226eeab2bb363ae0ea7db00280d38136b330f1c39bca03441b3969519f4526f413e86dfa8382f9c1b358e28138002b414a5

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+#bundler_args: --without development
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  #- jruby
+  #- jruby-head
+#env: JRUBY_OPTS="--server -J-Xms512m -J-Xmx1024m"
+#matrix:
+  #allow_failures:
+    #- rvm: jruby-head
+    #- gemfile: gemfiles/rails41.gemfile
+notifications:
+  email: false
+services:
+  - mongodb
+gemfile:
+  - Gemfile
+  #- gemfiles/rails41.gemfile

data/Readme.markdown

@@ -1,5 +1,7 @@
 # Datagrid
 
+[![Build Status](https://travis-ci.org/bogdan/datagrid.svg?branch=master)](https://travis-ci.org/bogdan/datagrid)
+
 Ruby library that helps you to build and represent table-like data with:
 
 * Customizable filtering

data/VERSION

@@ -1 +1 @@
-1.1.2
+1.2.0

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

@@ -2,7 +2,7 @@
   <% grid.html_columns(*options[:columns]).each do |column| %>
     <th class="<%= datagrid_column_classes(grid, column) %>">
       <%= column.header %>
-      <%= datagrid_order_for(grid, column) if column.order && options[:order]%>
+      <%= datagrid_order_for(grid, column, options) if column.order && options[:order]%>
     </th>
   <% end %>
 </tr>

data/datagrid.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: datagrid 1.1.2 ruby lib
+# stub: datagrid 1.2.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "datagrid"
-  s.version = "1.1.2"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2014-03-17"
+  s.date = "2014-05-10"
   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 = [
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
     ".rspec",
+    ".travis.yml",
     "Gemfile",
     "LICENSE.txt",
     "Rakefile",
@@ -105,6 +106,11 @@ Gem::Specification.new do |s|
     "spec/support/mongoid.rb",
     "spec/support/simple_report.rb",
     "spec/support/test_partials/_actions.html.erb",
+    "spec/support/test_partials/client/datagrid/_form.html.erb",
+    "spec/support/test_partials/client/datagrid/_head.html.erb",
+    "spec/support/test_partials/client/datagrid/_order_for.html.erb",
+    "spec/support/test_partials/client/datagrid/_row.html.erb",
+    "spec/support/test_partials/client/datagrid/_table.html.erb",
     "templates/controller.rb.erb",
     "templates/grid.rb.erb",
     "templates/index.html.erb"

data/lib/datagrid.rb

@@ -24,7 +24,6 @@ module Datagrid
   autoload :Engine
 
   def self.included(base)
-    base.extend         ClassMethods
     base.class_eval do
 
       include ::Datagrid::Core
@@ -37,9 +36,6 @@ module Datagrid
     end
   end # self.included
 
-  module ClassMethods
-  end # ClassMethods
-
   class ConfigurationError < StandardError; end
   class ArgumentError < ::ArgumentError; end
 

data/lib/datagrid/active_model.rb

@@ -2,7 +2,8 @@
 module Datagrid
 
   # Required to be ActiveModel compatible
-  module ActiveModel
+  # @private
+  module ActiveModel #:nodoc:
   
     def self.included(base)
       base.extend         ClassMethods

data/lib/datagrid/column_names_attribute.rb

@@ -3,9 +3,6 @@ module Datagrid
     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?
@@ -48,12 +45,12 @@ module Datagrid
     # 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?)
+      columns_array.select(&:mandatory?)
     end
 
     # Returns a list of columns without <tt>:mandatory => true</tt> option
     def optional_columns
-      self.class.columns - mandatory_columns
+      columns_array - mandatory_columns
     end
 
     protected
@@ -77,7 +74,7 @@ module Datagrid
     end
 
     def columns_visibility_enabled?
-      self.class.columns.any? do |column|
+      columns_array.any? do |column|
         column.options.key?(:mandatory)
       end
     end

data/lib/datagrid/columns.rb

@@ -12,11 +12,16 @@ module Datagrid
 
         include Datagrid::Core
 
-        class_attribute :default_column_options
+        class_attribute :default_column_options, :instance_writer => false
         self.default_column_options = {}
 
         class_attribute :batch_size
 
+        class_attribute :columns_array
+        self.columns_array = []
+
+        class_attribute :dynamic_block, :instance_writer => false
+
       end
       base.send :include, InstanceMethods
     end # self.included
@@ -72,18 +77,13 @@ module Datagrid
       # All column definistion are returned by default
       # You can limit the output with only columns you need like:
       #
-      #   grid.columns(:id, :name)
+      #   GridClass.columns(:id, :name)
       #
       # Supported options:
       #
       # * :data - if true returns only non-html columns. Default: false.
       def columns(*args)
-        options = args.extract_options!
-        args.compact!
-        args.map!(&:to_sym)
-        columns_array.select do |column|
-          (!options[:data] || column.data?) && (!options[:html] || column.html?) && (column.mandatory? || args.empty? || args.include?(column.name))
-        end
+        filter_columns(columns_array, *args)
       end
 
       # Defines new datagrid column
@@ -116,25 +116,12 @@ module Datagrid
       #
       # See: https://github.com/bogdan/datagrid/wiki/Columns for examples
       def column(name, options_or_query = {}, options = {}, &block)
-        if options_or_query.is_a?(String)
-          query = options_or_query
-        else
-          options = options_or_query
-        end
-        check_scope_defined!("Scope should be defined before columns")
-        block ||= lambda do |model|
-          model.send(name)
-        end
-        position = Datagrid::Utils.extract_position_from_options(columns_array, options)
-        column = Datagrid::Columns::Column.new(self, name, query, default_column_options.merge(options), &block)
-        columns_array.insert(position, column)
+        define_column(columns_array, name, options_or_query, 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
+        find_column_by_name(columns_array, name)
       end
 
       # Returns an array of all defined column names
@@ -146,6 +133,14 @@ module Datagrid
         Datagrid::Columns::Column::ResponseFormat.new(&block)
       end
 
+      # Formats column value for HTML.
+      # Helps to distinguish formatting as plain data and HTML
+      #
+      #   column(:name) do |model|
+      #     format(model.name) do |value|
+      #       content_tag(:strong, value)
+      #     end
+      #   end
       def format(value, &block)
         if block_given?
           respond_to do |f|
@@ -161,11 +156,72 @@ module Datagrid
         end
       end
 
+      # Allows dynamic columns definition, that could not be defined at class level
+      #
+      #   class MerchantsGrid
+      #
+      #     scope { Merchant }
+      #
+      #     column(:name)
+      #
+      #     dynamic do
+      #       PurchaseCategory.all.each do |category|
+      #         column(:"#{category.name.underscore}_sales") do |merchant|
+      #           merchant.purchases.where(:category_id => category.id).count
+      #         end
+      #       end
+      #     end
+      #   end
+      #
+      #   grid = MerchantsGrid.new
+      #   grid.data # => [
+      #             #      [ "Name",   "Swimwear Sales", "Sportswear Sales", ... ]
+      #             #      [ "Reebok", 2083382,            8382283,          ... ]
+      #             #      [ "Nike",   8372283,            18734783,         ... ]
+      #             #    ]
+      def dynamic(&block)
+        previous_block = dynamic_block
+        self.dynamic_block = proc {
+          instance_eval(&previous_block) if previous_block
+          instance_eval(&block)
+        }
+      end
+
       def inherited(child_class) #:nodoc:
         super(child_class)
         child_class.columns_array = self.columns_array.clone
       end
 
+      def filter_columns(columns, *args) #:nodoc:
+        options = args.extract_options!
+        args.compact!
+        args.map!(&:to_sym)
+        columns.select do |column|
+          (!options[:data] || column.data?) && (!options[:html] || column.html?) && (column.mandatory? || args.empty? || args.include?(column.name))
+        end
+      end
+
+      def define_column(columns, name, options_or_query = {}, options = {}, &block) #:nodoc:
+        if options_or_query.is_a?(String)
+          query = options_or_query
+        else
+          options = options_or_query
+        end
+        check_scope_defined!("Scope should be defined before columns")
+        block ||= lambda do |model|
+          model.send(name)
+        end
+        position = Datagrid::Utils.extract_position_from_options(columns, options)
+        column = Datagrid::Columns::Column.new(self, name, query, default_column_options.merge(options), &block)
+        columns.insert(position, column)
+      end
+
+      def find_column_by_name(columns,name) #:nodoc:
+        columns.find do |col|
+          col.name.to_sym == name.to_sym
+        end
+      end
+
     end # ClassMethods
 
     module InstanceMethods
@@ -277,7 +333,7 @@ module Datagrid
       #   grid.columns # => id and name columns
       #   grid.columns(:id, :category) # => id and category column
       def columns(*args)
-        self.class.columns(*args).select {|column| column.enabled?(self)}
+        self.class.filter_columns(columns_array, *args).select {|column| column.enabled?(self)} 
       end
 
       # Returns all columns that can be represented in plain data(non-html) way
@@ -298,10 +354,9 @@ module Datagrid
 
       # Finds a column definition by name
       def column_by_name(name)
-        self.class.column_by_name(name)
+        self.class.find_column_by_name(columns_array, name)
       end
 
-
       # Gives ability to have a different formatting for CSV and HTML column value.
       #
       # Example:
@@ -347,6 +402,40 @@ module Datagrid
         ::Datagrid::Columns::DataRow.new(self, asset)
       end
 
+      # Defines a column at instance level
+      #
+      # See Datagrid::Columns::ClassMethods#column for more info
+      def column(name, options_or_query = {}, options = {}, &block) #:nodoc:
+        self.class.define_column(columns_array, name, options_or_query, options, &block)
+      end
+
+      def initialize(*) #:nodoc:
+        self.columns_array = self.class.columns_array.clone
+        instance_eval(&dynamic_block) if dynamic_block
+        super
+      end
+
+      # Returns all columns available for current grid configuration
+      #   
+      #   class MyGrid
+      #     filter(:search)
+      #     column(:id)
+      #     column(:name, :mandatory => true)
+      #     column(:search_match, :if => proc {|grid| grid.search.present? }
+      #   end
+      #
+      #   grid = MyGrid.new
+      #   grid.columns # => [ <#Column:name> ]
+      #   grid.available_columns # => [ <#Column:id>, <#Column:name> ]
+      #   grid.search = "keyword"
+      #   grid.available_columns # => [ <#Column:id>, <#Column:name>, <#Column:search_match> ] 
+      #
+      def available_columns
+        columns_array.select do |column|
+          column.enabled?(self)
+        end
+      end
+
       protected
 
       def map_with_batches(&block)
@@ -365,7 +454,6 @@ module Datagrid
         end
       end
 
-
       def csv_class
         if RUBY_VERSION >= "1.9"
           require 'csv'

data/lib/datagrid/drivers.rb

@@ -6,6 +6,6 @@ require "datagrid/drivers/mongo_mapper"
 
 
 module Datagrid
-  module Drivers
+  module Drivers # :nodoc:
   end
 end

data/lib/datagrid/drivers/abstract_driver.rb

@@ -1,6 +1,6 @@
 module Datagrid
   module Drivers
-    class AbstractDriver
+    class AbstractDriver #:nodoc:
 
       TIMESTAMP_CLASSES = [DateTime, Time, ActiveSupport::TimeWithZone]
 

data/lib/datagrid/drivers/active_record.rb

@@ -1,6 +1,6 @@
 module Datagrid
   module Drivers
-    class ActiveRecord < AbstractDriver
+    class ActiveRecord < AbstractDriver #:nodoc:
 
       def self.match?(scope)
         return false unless defined?(::ActiveRecord)

data/lib/datagrid/drivers/array.rb

@@ -1,6 +1,6 @@
 module Datagrid
   module Drivers
-    class Array < AbstractDriver
+    class Array < AbstractDriver #:nodoc:
 
       def self.match?(scope)
         !Datagrid::Drivers::ActiveRecord.match?(scope) && scope.is_a?(::Array)

data/lib/datagrid/drivers/mongo_mapper.rb

@@ -1,6 +1,6 @@
 module Datagrid
   module Drivers
-    class MongoMapper < AbstractDriver
+    class MongoMapper < AbstractDriver #:nodoc:
 
       def self.match?(scope)
         return false unless defined?(::MongoMapper)

data/lib/datagrid/drivers/mongoid.rb

@@ -1,6 +1,6 @@
 module Datagrid
   module Drivers
-    class Mongoid < AbstractDriver
+    class Mongoid < AbstractDriver #:nodoc:
 
       def self.match?(scope)
         return false unless defined?(::Mongoid)

data/lib/datagrid/form_builder.rb

@@ -50,7 +50,10 @@ module Datagrid
         filter.select(object).map do |element|
           text, value = @template.send(:option_text_and_value, element)
           id = [object_name, filter.name, value].join('_').underscore
-          input = check_box(filter.name, datagrid_extra_checkbox_options.reverse_merge(:id => id, :multiple => true), value.to_s, nil)
+          html_options = datagrid_extra_checkbox_options.reverse_merge(
+            :id => id, :multiple => true, :checked => enum_checkbox_checked?(filter, value)
+          )
+          input = check_box(filter.name, html_options, value.to_s, nil)
           label(filter.name, input + text, options.reverse_merge(:for => id))
         end.join("\n").html_safe
       else
@@ -61,6 +64,17 @@ module Datagrid
       end
     end
 
+    def enum_checkbox_checked?(filter, option_value)
+      current_value = object.send(filter.name)
+      if current_value.respond_to?(:include?)
+        # Typecast everything to string
+        # to remove difference between String and Symbol
+        current_value.map(&:to_s).include?(option_value.to_s)
+      else
+        current_value.to_s == option_value.to_s
+      end
+    end
+
     def datagrid_integer_filter(attribute_or_filter, options = {})
       filter = datagrid_get_filter(attribute_or_filter)
       if filter.multiple? && self.object[filter.name].blank?