datagrid 1.5.5 → 1.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 012d1468059f7ed2bc98a58b26d982960eb40c9c
-  data.tar.gz: 6bd2b6019015f43c84e372fd27a5472e7f72d115
+  metadata.gz: de5cf9444ec74f75f3238dcdd239daf3fcf3782e
+  data.tar.gz: 026fd1c07e87df9f44d30ced49cfffb4e33c0775
 SHA512:
-  metadata.gz: 430016e9d03c4f09f0d8e0efec3faac6ec8c9428aa77a98679de546e3c52f7325aad22aae6a7aaed04b5bdb5be1048f2a9df73df43101bdb3178cdf1a57888c9
-  data.tar.gz: bdeb1423e1bdbf3ef66d2e4656ff565c50ec1a3e2cd18dc5d076e3b364528618cec623b20b528b8b98399a9f15ebbd1cb9f0bdbb7de8a35993ccc174f389ca08
+  metadata.gz: f5a5ef91ad59f2cb24cde7ef914e2dbc85149f828983746563d27df21f3c5a5b1ee724924d512fa5b1feb8fda26beab0fab54239f12fadc8a106185e7d232234
+  data.tar.gz: 66b23c02db354d88e6128ac0eaaf8fcdba5d7a45699d024a67606371f13b4a27e052decc582b83c47b933d37ae766a7c0c3340fc4f6201fed7d0a24db7210be9

data/VERSION

@@ -1 +1 @@
-1.5.5
+1.5.6

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

@@ -2,7 +2,7 @@
   <% grid.filters.each do |filter| %>
     <div class="datagrid-filter filter">
       <%= f.datagrid_label filter %>
-      <%= f.datagrid_filter filter, partials: options[:partials] %>
+      <%= f.datagrid_filter filter %>
     </div>
   <% end %>
   <div class="datagrid-actions">

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.5.5 ruby lib
+# stub: datagrid 1.5.6 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "datagrid".freeze
-  s.version = "1.5.5"
+  s.version = "1.5.6"
 
   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 = "2017-10-03"
+  s.date = "2017-10-30"
   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 = [
@@ -122,6 +122,7 @@ Gem::Specification.new do |s|
     "spec/support/test_partials/custom_checkboxes/_enum_checkboxes.html.erb",
     "spec/support/test_partials/custom_form/_form.html.erb",
     "spec/support/test_partials/custom_range/_range_filter.html.erb",
+    "templates/base.rb.erb",
     "templates/controller.rb.erb",
     "templates/grid.rb.erb",
     "templates/index.html.erb"

data/lib/datagrid/filters.rb

@@ -72,8 +72,11 @@ module Datagrid
       #
       # * <tt>:header</tt> - determines the header of the filter
       # * <tt>:default</tt> - the default filter value. Able to accept a <tt>Proc</tt> in case default should be recalculated
+      # * <tt>:range</tt> - if true, filter can accept two values that are treated as a range that will be used for filtering
+      #   Not all of the filter types support this option. Here are the list of types that do:
+      #   <tt>:integer</tt>, <tt>:float</tt>, <tt>:date</tt>, <tt>:datetime</tt>, <tt>:string</tt>
       # * <tt>:multiple</tt> -  if true multiple values can be assigned to this filter.
-      #   By default multiple values are parsed from string using `,` separator.
+      #   If String is assigned as a filter value, it is parsed from string using a separator symbol (`,` by default).
       #   But you can specify a different separator as option value. Default: false.
       # * <tt>:allow_nil</tt> - determines if the value can be nil
       # * <tt>:allow_blank</tt> - determines if the value can be blank

data/lib/datagrid/filters/base_filter.rb

@@ -154,7 +154,6 @@ class Datagrid::Filters::BaseFilter #:nodoc:
   def normalize_multiple_value(value)
     case value
     when String
-      #TODO: write tests and doc
       value.split(separator)
     when Range
       [value.first, value.last]

data/lib/datagrid/filters/ranged_filter.rb

@@ -1,6 +1,5 @@
 module Datagrid::Filters::RangedFilter
 
-
   def initialize(grid, name, options, &block)
     super(grid, name, options, &block)
     if range?

data/lib/datagrid/filters/string_filter.rb

@@ -1,4 +1,7 @@
 class Datagrid::Filters::StringFilter < Datagrid::Filters::BaseFilter
+
+  include Datagrid::Filters::RangedFilter
+
   def parse(value)
     value.nil? ? nil : value.to_s
   end

data/lib/datagrid/form_builder.rb

@@ -8,7 +8,7 @@ module Datagrid
       filter = datagrid_get_filter(filter_or_attribute)
       options = add_html_classes(options, filter.name, datagrid_filter_html_class(filter))
       # Prevent partials option from appearing in HTML attributes
-      options.delete(:partials) unless supports_partial?(filter)
+      options.delete(:partials) # Legacy option
       self.send(filter.form_builder_helper_name, filter, options, &block)
     end
 
@@ -48,7 +48,7 @@ module Datagrid
     def datagrid_enum_filter(attribute_or_filter, options = {}, &block)
       filter = datagrid_get_filter(attribute_or_filter)
       if filter.checkboxes?
-        partial = partial_path(options, 'enum_checkboxes')
+        partial = partial_path('enum_checkboxes')
         options = add_html_classes(options, 'checkboxes')
         elements = object.select_options(filter).map do |element|
           text, value = @template.send(:option_text_and_value, element)
@@ -138,7 +138,7 @@ module Datagrid
     def datagrid_range_filter(type, attribute_or_filter, options = {})
       filter = datagrid_get_filter(attribute_or_filter)
       if filter.range?
-        partial = partial_path(options, 'range_filter')
+        partial = partial_path('range_filter')
         options = options.merge(:multiple => true)
 
 
@@ -224,8 +224,8 @@ module Datagrid
       Datagrid::Utils.add_html_classes(options, *classes)
     end
 
-    def partial_path(options, name)
-      if partials = options.delete(:partials)
+    def partial_path(name)
+      if partials = self.options[:partials]
         partial_name = File.join(partials, name)
         # Second argument is []: no magical namespaces to lookup added from controller
         if @template.lookup_context.template_exists?(partial_name, [], true)
@@ -235,10 +235,6 @@ module Datagrid
       File.join('datagrid', name)
     end
 
-    def supports_partial?(filter)
-      (filter.supports_range? && filter.range?) || (filter.type == :enum && filter.checkboxes?)
-    end
-
     class Error < StandardError
     end
   end

data/lib/datagrid/scaffold.rb

@@ -8,8 +8,11 @@ class Datagrid::Scaffold < Rails::Generators::NamedBase
   source_root File.expand_path(__FILE__ + "/../../../templates")
 
   def create_scaffold
+    unless file_exists?(base_grid_file)
+      template "base.rb.erb", base_grid_file
+    end
     template "grid.rb.erb", "app/grids/#{grid_class_name.underscore}.rb"
-    if File.exists?(grid_controller_file)
+    if file_exists?(grid_controller_file)
       inject_into_file grid_controller_file, index_action, :after => %r{class .*#{grid_controller_class_name}.*\n}
     else
       template "controller.rb.erb", grid_controller_file
@@ -26,7 +29,7 @@ class Datagrid::Scaffold < Rails::Generators::NamedBase
         "css.scss" => " *= require datagrid",
       }.each do |extension, string|
         file = "app/assets/stylesheets/application.#{extension}"
-        if File.exists?(Rails.root.join(file))
+        if file_exists?(file)
           inject_into_file file, string + "\n", {:before => %r{.*require_self}} # before all
         end
       end
@@ -68,7 +71,10 @@ class Datagrid::Scaffold < Rails::Generators::NamedBase
       # Kaminari is default
       "paginate(@grid.assets)"
     end
+  end
 
+  def base_grid_file
+    "app/grids/base_grid.rb"
   end
 
   def grid_route_name
@@ -109,4 +115,9 @@ RUBY
     # Combine the 3 parts to generate complete route entry
     namespace_ladder + route + "\n" + end_ladder
   end
+
+  def file_exists?(name)
+    name = Rails.root.join(name) unless name.to_s.first == "/"
+    File.exists?(name)
+  end
 end

data/lib/datagrid/utils.rb

@@ -146,8 +146,10 @@ module Datagrid
           option.call(grid)
         when Symbol, String
           grid.send(option.to_sym)
+        when TrueClass, FalseClass
+          option
         else
-          raise Datagrid::ConfigurationError, "Incorrect column availability option: #{option.insepct}"
+          raise Datagrid::ConfigurationError, "Incorrect column availability option: #{option.inspect}"
         end
       end
     end

data/spec/datagrid/columns_spec.rb

@@ -229,6 +229,14 @@ describe Datagrid::Columns do
       expect(report.available_columns.map(&:name)).to eq([:category])
     end
 
+    it "raises when incorrect unless option is given" do
+      expect do
+        test_report do
+          column(:id, if: Object.new)
+        end
+      end.to raise_error(Datagrid::ConfigurationError)
+    end
+
     it "raises when :before and :after used together" do
       expect do
         test_report do

data/spec/datagrid/filters/string_filter_spec.rb

@@ -1,5 +1,4 @@
-require "spec_helper" 
-
+require "spec_helper"
 
 describe Datagrid::Filters::StringFilter do
 
@@ -23,4 +22,14 @@ describe Datagrid::Filters::StringFilter do
     expect(report.assets).not_to include(Entry.create!( :name => "two"))
   end
 
+  it "supports range" do
+    report = test_report(:name => ['ab', 'lm']) do
+      scope {Entry}
+      filter(:name, :string, range: true)
+    end
+    expect(report.assets).to include(Entry.create!( :name => "ac"))
+    expect(report.assets).to include(Entry.create!( :name => "kl"))
+    expect(report.assets).not_to include(Entry.create!( :name => "aa"))
+    expect(report.assets).not_to include(Entry.create!( :name => "mn"))
+  end
 end

data/spec/datagrid/form_builder_spec.rb

@@ -18,7 +18,8 @@ describe Datagrid::FormBuilder do
       v.view_paths << File.expand_path("../../support/test_partials", __FILE__)
     end
   end
-  let(:view) { ActionView::Helpers::FormBuilder.new(:report, _grid, template, {})}
+  let(:view) { ActionView::Helpers::FormBuilder.new(:report, _grid, template, view_options)}
+  let(:view_options) { {} }
 
 
   describe ".datagrid_filter" do
@@ -60,7 +61,7 @@ describe Datagrid::FormBuilder do
       )}
 
       context "when partials option is passed for filter that don't support range" do
-        let(:_filter_options) { {partials: 'anything' } }
+        let(:view_options) { {partials: 'anything' } }
         it { should equal_to_dom(
           '<input class="group_id integer_filter" type="text" name="report[group_id]" id="report_group_id"/>'
         )}
@@ -138,7 +139,7 @@ describe Datagrid::FormBuilder do
       end
 
       context "with custom partials option and template exists" do
-        let(:_filter_options) { { :partials => 'custom_range' } }
+        let(:view_options) { { :partials => 'custom_range' } }
         let(:_range) { nil }
         it { should equal_to_dom(
           "custom_range_partial"
@@ -146,7 +147,7 @@ describe Datagrid::FormBuilder do
       end
 
       context "when custom partial doesn't exist" do
-        let(:_filter_options) { { :partials => 'not_existed' } }
+        let(:view_options) { { :partials => 'not_existed' } }
         let(:_range) { nil }
         it { should equal_to_dom(
           '<input class="group_id integer_filter from" multiple type="text" name="report[group_id][]"><span class="separator integer"> - </span><input class="group_id integer_filter to" multiple type="text" name="report[group_id][]">'
@@ -361,7 +362,7 @@ describe Datagrid::FormBuilder do
         end
 
         context "when partials option passed and partial exists" do
-          let(:_filter_options) { {partials: 'custom_checkboxes'} }
+          let(:view_options) { {partials: 'custom_checkboxes'} }
           it { should equal_to_dom('custom_enum_checkboxes') }
         end
       end

data/templates/base.rb.erb

@@ -0,0 +1,19 @@
+class BaseGrid
+
+  include Datagrid
+
+  self.default_column_options = {
+    # Uncomment to disable the default order
+    # order: false,
+    # Uncomment to make all columns HTML by default
+    # html: true,
+  }
+
+  def self.date_column(name, *args)
+    column(name, *args) do |model|
+      format(block_given? ? yield : model.send(name)) do |date|
+        date.strftime("%m/%d/%Y")
+      end
+    end
+  end
+end

data/templates/grid.rb.erb

@@ -1,6 +1,4 @@
-class <%= grid_class_name %>
-
-  include Datagrid
+class <%= grid_class_name %> < BaseGrid
 
   scope do
     <%= grid_model_name %>
@@ -11,7 +9,5 @@ class <%= grid_class_name %>
 
   column(:id)
   column(:name)
-  column(:created_at) do |model|
-    model.created_at.to_date
-  end
+  date_column(:created_at)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 1.5.5
+  version: 1.5.6
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-03 00:00:00.000000000 Z
+date: 2017-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -276,6 +276,7 @@ files:
 - spec/support/test_partials/custom_checkboxes/_enum_checkboxes.html.erb
 - spec/support/test_partials/custom_form/_form.html.erb
 - spec/support/test_partials/custom_range/_range_filter.html.erb
+- templates/base.rb.erb
 - templates/controller.rb.erb
 - templates/grid.rb.erb
 - templates/index.html.erb