datagrid 1.5.9 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94a9a3ff232cd83f323e280e35a805ebd4ec725b74b531c18328c4de27952f2f
-  data.tar.gz: c91f39764fa86f0d8b016de33eeabfd37b47d16411f3f52ec796f2bf1d14d534
+  metadata.gz: 76bece54343c202c79e7ca4d5e90ae1cc91d2c5a77b965a175b36df801e10bd1
+  data.tar.gz: 68e58ec9dec5f010b43a7e078fdbf2c3c1b0923c9f2ab38c327d3665570d08fa
 SHA512:
-  metadata.gz: b999afc64d7094dfd47a2e4f393824df58edf15769c445a9d16712dc6f531f3b30f872046cd657bc9323df6a460b4d1a74334fc4b498de141a9998d3aa6c34bc
-  data.tar.gz: 89d0e83bd75e28ee33dc890d2f5f82de6391a9d32b0723e77afa8dfc0856d126c1fe0ee4c8ab5b0b2f5491e5908b45e14de0bd18669c2786764faeac8c6fc0c2
+  metadata.gz: 9aeb7a29ea7df278090a6417e1f940dfe9f8b1aa57dd907f9f739c4d2bc3e613be66be28635c5cf51a70b9067a7f7da4a00e7adaf09ae8ddea0247c7f34a56b1
+  data.tar.gz: 8660381aa1d508c624b0bc6d1c6e71ca3e6c1e89cad518733aeaee31d1968dc6382c45d1d06cbb60cd33ea1407d3e79e92e5920d93483bdfd47a31ffa1e23cef

data/.travis.yml

@@ -1,10 +1,12 @@
 language: ruby
 #bundler_args: --without development
 rvm:
-  - 2.2.2
-  - 2.3.0
-  - 2.4.1
-  - 2.5.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
   #- jruby
   #- jruby-head
 #env: JRUBY_OPTS="--server -J-Xms512m -J-Xmx1024m"

data/Gemfile

@@ -6,17 +6,21 @@ group :development do
 
   gem "bundler"
   if RUBY_VERSION >= "2.3"
-    gem "jeweler", ">= 2.1.2", platform: [:ruby_23, :ruby_24, :ruby_25]
+    gem "jeweler", ">= 2.1.2", platform: :mri, github: 'technicalpickles/jeweler'
   end
 
 
   #gem "json", ">= 1.9"
-  gem "pry-byebug", :platform => [:ruby_24, :ruby_25, :ruby_22, :ruby_23] & Bundler::Dsl::VALID_PLATFORMS
+  gem "pry-byebug"
 
   gem "rspec", ">= 3"
   gem "nokogiri" # used to test html output
 
-  gem "sqlite3", "~> 1.3.6"
+  if RUBY_VERSION >= "2.5"
+    gem "sqlite3", "~> 1.4", platform: :mri
+  else
+    gem "sqlite3", "~> 1.3.6"
+  end
   gem "sequel"
 
   group :mongo do

data/Readme.markdown

@@ -1,6 +1,7 @@
 # Datagrid
 
 [![Build Status](https://travis-ci.org/bogdan/datagrid.svg?branch=master)](https://travis-ci.org/bogdan/datagrid)
+
 [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid?ref=badge_shield)
 
 Ruby library that helps you to build and represent table-like data with:
@@ -201,4 +202,4 @@ Read [author blog](http://gusiev.com).
 
 
 ## License
-[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid?ref=badge_large)
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fbogdan%2Fdatagrid?ref=badge_large)

data/VERSION

@@ -1 +1 @@
-1.5.9
+1.6.1

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

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

data/datagrid.gemspec

@@ -2,20 +2,21 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: datagrid 1.5.9 ruby lib
+# stub: datagrid 1.6.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "datagrid".freeze
-  s.version = "1.5.9"
+  s.version = "1.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Bogdan Gusiev".freeze]
-  s.date = "2019-05-10"
+  s.date = "2020-09-07"
   s.description = "This allows you to easily build datagrid aka data tables with sortable columns and filters".freeze
   s.email = "agresso@gmail.com".freeze
   s.extra_rdoc_files = [
-    "LICENSE.txt"
+    "LICENSE.txt",
+    "Readme.markdown"
   ]
   s.files = [
     ".document",
@@ -130,7 +131,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/bogdan/datagrid".freeze
   s.licenses = ["MIT".freeze]
   s.required_ruby_version = Gem::Requirement.new(">= 2.0".freeze)
-  s.rubygems_version = "2.7.8".freeze
+  s.rubygems_version = "3.0.8".freeze
   s.summary = "Ruby gem to create datagrids".freeze
 
   if s.respond_to? :specification_version then
@@ -143,7 +144,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<pry-byebug>.freeze, [">= 0"])
       s.add_development_dependency(%q<rspec>.freeze, [">= 3"])
       s.add_development_dependency(%q<nokogiri>.freeze, [">= 0"])
-      s.add_development_dependency(%q<sqlite3>.freeze, ["~> 1.3.6"])
+      s.add_development_dependency(%q<sqlite3>.freeze, ["~> 1.4"])
       s.add_development_dependency(%q<sequel>.freeze, [">= 0"])
       s.add_development_dependency(%q<mongoid>.freeze, [">= 0"])
       s.add_development_dependency(%q<bson>.freeze, [">= 0"])
@@ -155,7 +156,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<pry-byebug>.freeze, [">= 0"])
       s.add_dependency(%q<rspec>.freeze, [">= 3"])
       s.add_dependency(%q<nokogiri>.freeze, [">= 0"])
-      s.add_dependency(%q<sqlite3>.freeze, ["~> 1.3.6"])
+      s.add_dependency(%q<sqlite3>.freeze, ["~> 1.4"])
       s.add_dependency(%q<sequel>.freeze, [">= 0"])
       s.add_dependency(%q<mongoid>.freeze, [">= 0"])
       s.add_dependency(%q<bson>.freeze, [">= 0"])
@@ -168,7 +169,7 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<pry-byebug>.freeze, [">= 0"])
     s.add_dependency(%q<rspec>.freeze, [">= 3"])
     s.add_dependency(%q<nokogiri>.freeze, [">= 0"])
-    s.add_dependency(%q<sqlite3>.freeze, ["~> 1.3.6"])
+    s.add_dependency(%q<sqlite3>.freeze, ["~> 1.4"])
     s.add_dependency(%q<sequel>.freeze, [">= 0"])
     s.add_dependency(%q<mongoid>.freeze, [">= 0"])
     s.add_dependency(%q<bson>.freeze, [">= 0"])

data/lib/datagrid/columns.rb

@@ -16,6 +16,7 @@ module Datagrid
         self.default_column_options = {}
 
         class_attribute :batch_size
+        self.batch_size = 1000
 
         class_attribute :columns_array
         self.columns_array = []
@@ -315,9 +316,8 @@ module Datagrid
       def to_csv(*column_names)
         require "csv"
         options = column_names.extract_options!
-        CSV.generate(
-          {:headers => self.header(*column_names), :write_headers => true}.merge!(options)
-        ) do |csv|
+        options = {:headers => self.header(*column_names), :write_headers => true}.merge!(options)
+        CSV.generate(**options) do |csv|
           each_with_batches do |asset|
             csv << row_for(asset, *column_names)
           end
@@ -406,7 +406,7 @@ module Datagrid
       # Defines a column at instance level
       #
       # See Datagrid::Columns::ClassMethods#column for more info
-      def column(name, options_or_query = {}, options = {}, &block) #:nodoc:
+      def column(name, options_or_query = {}, options = {}, &block)
         self.class.define_column(columns_array, name, options_or_query, options, &block)
       end
 
@@ -415,7 +415,7 @@ module Datagrid
         super
       end
 
-      # Returns all columns available for current grid configuration.
+      # Returns all columns that are possible to be displayed for the current grid object
       #
       #   class MyGrid
       #     filter(:search) {|scope, value| scope.full_text_search(value)}
@@ -535,6 +535,8 @@ module Datagrid
       def value_from_html_block(context, asset, column)
         args = []
         remaining_arity = column.html_block.arity
+        remaining_arity = 1 if remaining_arity < 0
+
         asset = decorate(asset)
 
         if column.data?

data/lib/datagrid/core.rb

@@ -9,7 +9,7 @@ module Datagrid
       base.class_eval do
         class_attribute :scope_value
 
-        class_attribute :datagrid_attributes
+        class_attribute :datagrid_attributes, instance_writer: false
         self.datagrid_attributes = []
 
         class_attribute :dynamic_block, :instance_writer => false
@@ -163,6 +163,9 @@ module Datagrid
       end
 
       # Returns serializable query arguments skipping all nil values
+      #
+      #   grid = ProductsGrid.new(category: 'dresses', available: true)
+      #   grid.as_query # => {category: 'dresses', available: true}
       def as_query
         attributes = self.attributes.clone
         attributes.each do |key, value|
@@ -171,6 +174,15 @@ module Datagrid
         attributes
       end
 
+      # Returns query parameters to link this grid from a page
+      #
+      #   grid = ProductsGrid.new(category: 'dresses', available: true)
+      #   Rails.application.routes.url_helpers.products_path(grid.query_params)
+      #     # => "/products?products_grid[category]=dresses&products_grid[available]=true"
+      def query_params(attributes = {})
+        { param_name.to_sym => as_query.merge(attributes) }
+      end
+
       # Redefines scope at instance level
       #
       #   class MyGrid

data/lib/datagrid/drivers/active_record.rb

@@ -105,7 +105,8 @@ module Datagrid
         if scope.limit_value
           raise Datagrid::ConfigurationError, "ActiveRecord can not use batches in combination with SQL limit"
         end
-        scope.find_each(batch_size ? { :batch_size => batch_size} : {}, &block)
+        options = batch_size ? { batch_size: batch_size } : {}
+        scope.find_each(**options, &block)
       end
 
       def default_cache_key(asset)

data/lib/datagrid/drivers/mongoid.rb

@@ -12,7 +12,11 @@ module Datagrid
       end
 
       def to_scope(scope)
-        scope.where(nil)
+        if scope.respond_to?(:all)
+          scope.all
+        else
+          scope.where(nil)
+        end
       end
 
       def where(scope, attribute, value)

data/lib/datagrid/helper.rb

@@ -73,7 +73,7 @@ module Datagrid
     #       %td= row.project_name
     #       %td.project-status{class: row.status}= row.status
     def datagrid_rows(grid, assets = grid.assets, **options, &block)
-      datagrid_renderer.rows(grid, assets, options, &block)
+      datagrid_renderer.rows(grid, assets, **options, &block)
     end
 
     # Renders ordering controls for the given column name

data/lib/datagrid/renderer.rb

@@ -81,10 +81,9 @@ module Datagrid
     def order_path(grid, column, descending, request)
       column = grid.column_by_name(column)
       query = request ? request.query_parameters : {}
-      order_parameter = {grid.param_name => grid.as_query.merge(:order => column.name, :descending => descending)}
       ActionDispatch::Http::URL.path_for(
         path: request ? request.path : '/',
-        params: query.merge(order_parameter)
+        params: query.merge(grid.query_params(order: column.name, descending: descending))
       )
     end
 

data/lib/datagrid/utils.rb

@@ -72,12 +72,8 @@ module Datagrid
       end
 
       def apply_args(*args, &block)
-        return block.call(*args) if block.arity < 0
-        args = args.clone
-        (args.size - block.arity).times do
-          args.pop
-        end
-        block.call(*args)
+        size = block.arity < 0 ? args.size : block.arity
+        block.call(*args.slice(0, size))
       end
 
       def parse_date(value)

data/spec/datagrid/core_spec.rb

@@ -193,4 +193,18 @@ describe Datagrid::Core do
       }.to_not raise_error
     end
   end
+
+
+  describe ".query_param" do
+    it "works" do
+      grid = test_report(name: 'value') do
+        scope {Entry}
+        filter(:name)
+        def param_name
+          'grid'
+        end
+      end
+      expect(grid.query_params).to eq({grid: {name: 'value'}})
+    end
+  end
 end

data/spec/datagrid/filters/date_filter_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require "active_support/testing/time_helpers"
 
 describe Datagrid::Filters::DateFilter do
 
@@ -122,14 +123,16 @@ describe Datagrid::Filters::DateFilter do
 
 
   it "should support block" do
-    report = test_report(:created_at => Date.today) do
+    date = Date.new(2018, 01, 07)
+    time = Time.utc(2018, 01, 07, 2, 2)
+    report = test_report(:created_at => date) do
       scope { Entry }
       filter(:created_at, :date, :range => true) do |value|
         where("created_at >= ?", value)
       end
     end
-    expect(report.assets).not_to include(Entry.create!(:created_at => 1.day.ago))
-    expect(report.assets).to include(Entry.create!(:created_at => Time.now))
+    expect(report.assets).not_to include(Entry.create!(:created_at => time - 1.day))
+    expect(report.assets).to include(Entry.create!(:created_at => time))
   end
 
 

data/spec/datagrid/form_builder_spec.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
 require 'spec_helper'
+require "action_controller"
 
 class MyFormBuilder
   include Datagrid::FormBuilder
@@ -11,19 +12,15 @@ end
 
 
 describe Datagrid::FormBuilder do
-
   let(:template) do
-    ActionView::Base.new.tap do |v|
-      v.view_paths << File.expand_path("../../../app/views", __FILE__)
-      v.view_paths << File.expand_path("../../support/test_partials", __FILE__)
-    end
+    action_view_template
   end
+
   let(:view) { ActionView::Helpers::FormBuilder.new(:report, _grid, template, view_options)}
   let(:view_options) { {} }
 
 
   describe ".datagrid_filter" do
-
     it "should work for every filter type" do
       Datagrid::Filters::FILTER_TYPES.each do |type, klass|
         expect(Datagrid::FormBuilder.instance_methods.map(&:to_sym)).to include(klass.form_builder_helper_name)

data/spec/datagrid/helper_spec.rb

@@ -1,16 +1,13 @@
 require 'spec_helper'
 require "active_support/core_ext/hash"
 require "active_support/core_ext/object"
+require "action_controller"
 
 require 'datagrid/renderer'
 
 describe Datagrid::Helper do
   subject do
-    template = ActionView::Base.new
-    allow(template).to receive(:protect_against_forgery?).and_return(false)
-    template.view_paths << File.expand_path("../../../app/views", __FILE__)
-    template.view_paths << File.expand_path("../../support/test_partials", __FILE__)
-    template
+    action_view_template
   end
 
   before(:each) do
@@ -248,6 +245,17 @@ describe Datagrid::Helper do
       )
     end
 
+    it "should render columns with &:symbol block" do
+      rp = test_report do
+        scope { Entry }
+        column(:name, &:name)
+      end
+
+      expect(subject.datagrid_rows(rp, [entry])).to match_css_pattern(
+        "tr td.name" => "Star"
+      )
+    end
+
     it "should render html columns" do
       rp = test_report do
         scope { Entry }
@@ -260,6 +268,41 @@ describe Datagrid::Helper do
       )
     end
 
+    it "should render :html columns with &:symbol block" do
+      rp = test_report do
+        scope { Entry }
+        column(:name, :html => true, &:name)
+      end
+
+      expect(subject.datagrid_rows(rp, [entry])).to match_css_pattern(
+        "tr td.name" => "Star"
+      )
+    end
+
+    it "should render format columns with &:symbol block" do
+      rp = test_report do
+        scope { Entry }
+        column(:name) do |record|
+          format(record, &:name)
+        end
+      end
+
+      expect(subject.datagrid_rows(rp, [entry])).to match_css_pattern(
+        "tr td.name" => "Star"
+      )
+    end
+
+    it "should render :html columns with &:symbol block with a data attribute" do
+      rp = test_report do
+        scope { Entry }
+        column(:name, :html => true, data: 'DATA', &:name)
+      end
+
+      expect(subject.datagrid_rows(rp, [entry])).to match_css_pattern(
+        "tr td.name" => "Star"
+      )
+    end
+
     it "should render argument-based html columns" do
       rp = test_report do
         scope { Entry }
@@ -389,14 +432,14 @@ describe Datagrid::Helper do
     end
 
     it "should escape html" do
-      entry.update_attributes!(:name => "<div>hello</div>")
+      entry.update!(:name => "<div>hello</div>")
       expect(subject.datagrid_rows(grid, [entry], :columns => [:name])).to equal_to_dom(<<-HTML)
        <tr><td class="name">&lt;div&gt;hello&lt;/div&gt;</td></tr>
         HTML
     end
 
     it "should not escape safe html" do
-      entry.update_attributes!(:name => "<div>hello</div>")
+      entry.update!(:name => "<div>hello</div>")
       grid.column(:safe_name) do |model|
         model.name.html_safe
       end

data/spec/datagrid_spec.rb

@@ -60,8 +60,8 @@ describe Datagrid do
 
   describe ".batch_size" do
     context "when not defined on class level" do
-      it "returns nil" do
-        expect(subject.batch_size).to eq(nil)
+      it "returns 1000" do
+        expect(subject.batch_size).to eq(1000)
       end
     end
 
@@ -77,6 +77,17 @@ describe Datagrid do
       end
     end
 
+    context "when set to nil in the grid class" do
+      subject do
+        test_report do
+          self.batch_size = nil
+        end
+      end
+
+      it "returns nil" do
+        expect(subject.batch_size).to eq(nil)
+      end
+    end
   end
 
 

data/spec/spec_helper.rb

@@ -17,7 +17,7 @@ require 'action_view'
 require "rails"
 require "mongoid"
 begin
-require 'mongo_mapper'
+  require 'mongo_mapper'
 rescue LoadError
 end
 
@@ -55,9 +55,11 @@ begin
         "database" =>"datagrid_mongoid",
         "autocreate_indexes" => true,
         "logger" => nil,
-        "options" => {
-          "connect_timeout" => 2,
-          wait_queue_timeout: 2
+        options: {
+          connect_timeout: 2,
+          wait_queue_timeout: 2,
+          server_selection_timeout: 2,
+          socket_timeout: 1
         }
       }
     }
@@ -80,8 +82,6 @@ rescue Mongo::Error::NoServerAvailable
 end
 
 RSpec.configure do |config|
-
-
   config.after(:each) do
     #TODO better database truncation
     Group.delete_all
@@ -103,12 +103,21 @@ RSpec.configure do |config|
     #c.syntax = :expect
     c.syntax = [:should, :expect]
   end
+end
 
+def action_view_template
+  context = ActionView::LookupContext.new([
+    File.expand_path("../../app/views", __FILE__),
+    File.expand_path("../support/test_partials", __FILE__),
+  ], {})
+  klass = ActionView::Base.respond_to?(:with_empty_template_cache) ? ActionView::Base.with_empty_template_cache : ActionView::Base
+  template = klass.new(context, {}, ::ActionController::Base.new)
+  allow(template).to receive(:protect_against_forgery?).and_return(false)
+  template
 end
 
 
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/schema.rb"].each {|f| require f}
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/spec/support/simple_report.rb

@@ -45,7 +45,7 @@ class SimpleReport
   end
 
   column(:actions, :html => true) do |model|
-    render :partial => "actions", :locals => {:model => model}
+    render :partial => "/actions", :locals => {:model => model}
   end
 
   column(:pet, :html => lambda {|data| content_tag :em, data}) do

data/spec/support/test_partials/client/datagrid/_order_for.html.erb

@@ -2,10 +2,10 @@
   <p>Namespaced order_for partial.</p>
   <%= link_to(
       I18n.t("datagrid.table.order.asc").html_safe,
-      url_for(grid.param_name => grid.as_query.merge(:order => column.name, :descending => false)),
+      url_for(grid.query_params(order: column.name, descending: false)),
       :class => "asc") %>
   <%= link_to(
       I18n.t("datagrid.table.order.desc").html_safe,
-      url_for(grid.param_name => grid.as_query.merge(:order => column.name, :descending => true )),
+      url_for(grid.query_params(order: column.name, descending: true)),
       :class => "desc") %>
 </div>

data/spec/support/test_partials/client/datagrid/_table.html.erb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.6.1
 platform: ruby
 authors:
 - Bogdan Gusiev
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-10 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: sequel
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +171,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
+- Readme.markdown
 files:
 - ".document"
 - ".rspec"
@@ -284,7 +285,7 @@ homepage: http://github.com/bogdan/datagrid
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -299,9 +300,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Ruby gem to create datagrids
 test_files: []