datagrid 1.6.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4accb02f36dc5af245b6dd84008c22293e9bc0f6105b7fdfebe9458b6a7fa1e1
-  data.tar.gz: 4ca75ebff1804e8eaba5b0e41cae04e32f63c24211baffdc501a93870e1ba7e2
+  metadata.gz: cae619097e4bcae30de30bf2b5e9dc949f197146f3b17c01f5a2e4edb17e5ecc
+  data.tar.gz: 61751f34844c4127b7fc47bbacdbb2656d61aa015f574855de2a23bfc2dffe4a
 SHA512:
-  metadata.gz: e8ab20bbbaec525f993c7e20a1ed5bd0105f6d2fc0c9ab098570401e610b7030a696c263959478b0cb4a39ecf921c81e5621bb76198cbc96060f433f23cbcaa5
-  data.tar.gz: 9158b9d0f26ee862292a5fdc0d9b596ee2ac70e52006cb559af1bfc043a5d43419c476e1b5a796a42a19e7bc5efcfb9e2b4e37e0fdfa9a8286c795a505aad573
+  metadata.gz: 8bcea069b9bafc8b573226366a1abf194910d3fa5798711568b7106428d94ec915b141f23986094d8579ce8450328e1eb5b71932646c4224c0f1f7ac01f9718b
+  data.tar.gz: 7a40443171fe84d7b9f22daabdf2d1c182926fc69c9b47fde54e5a2271c394b8b5f7541a512e898c4e1472f93f4e94cf9cb90a7d47a9ad51113ee65efaf80610

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 1.7.0
+
+* Depend on `railties` instead of `rails` to prevent loading of unnecessary frameworks
+* Bugfix `File.exist?` usage for ruby 3.0 [#307](https://github.com/bogdan/datagrid/issues/307)
+* Drop support of old Ruby versions (< 2.7)
+* Drop support of old Rails versions (< 6.0)
+
+## 1.6.3
+
+* Fix usage of options spread operator for Ruby 3.0 [#296](https://github.com/bogdan/datagrid/issues/296)
+
 ## 1.6.2
 
 * Add `input_options` and `label_options` to `filter` method [#294](https://github.com/bogdan/datagrid/issues/294)

data/Readme.markdown

@@ -1,6 +1,6 @@
 # Datagrid
 
-[![Build Status](https://travis-ci.org/bogdan/datagrid.svg?branch=master)](https://travis-ci.org/bogdan/datagrid)
+[![Build Status](https://github.com/bogdan/datagrid/workflows/CI/badge.svg?branch=master)](https://github.com/bogdan/datagrid/actions)
 
 [![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)
 
@@ -23,10 +23,11 @@ Ruby library that helps you to build and represent table-like data with:
 [Create an issue](https://github.com/bogdan/datagrid/issues/new) if you want more.
 
 
-### Dependencies
+### Documentation
 
-* Ruby >= 2.0
-* Rails >= 3.2
+* [Readme](/Readme.markdown) - this read-me for basic information
+* [Wiki](https://github.com/bogdan/datagrid/wiki) - general reference on how to use the gem
+* [Rdoc](https://rubydoc.info/gems/datagrid) - API reference
 
 ### Live Demo
 

data/datagrid.gemspec

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "datagrid/version"
+
+require_relative "lib/datagrid/version"
 
 Gem::Specification.new do |s|
   s.name = "datagrid"
   s.version = Datagrid::VERSION
   s.require_paths = ["lib"]
   s.authors = ["Bogdan Gusiev"]
-  s.date = "2020-09-07"
   s.summary = "Ruby gem to create datagrids"
   s.description = "This allows you to easily build datagrid aka data tables with sortable columns and filters"
   s.email = "agresso@gmail.com"
@@ -23,19 +21,17 @@ Gem::Specification.new do |s|
     "datagrid.gemspec",
   ]
   s.files += `git ls-files | grep -E '^(app|lib|templates)'`.split("\n")
-  s.homepage = "http://github.com/bogdan/datagrid"
+  s.homepage = "https://github.com/bogdan/datagrid"
   s.licenses = ["MIT"]
-  s.required_ruby_version = Gem::Requirement.new(">= 2.0")
-  s.rubygems_version = "3.0.8"
-  url = 'https://github.com/bogdan/datagrid'
+  s.required_ruby_version = Gem::Requirement.new(">= 2.7")
   s.metadata = {
-    "homepage_uri" => url,
-    "bug_tracker_uri" => "#{url}/issues",
-    "documentation_uri" => "#{url}/wiki",
-    "changelog_uri" => "#{url}/blob/master/CHANGELOG.md",
-    "source_code_uri" => url,
+    "homepage_uri" => s.homepage,
+    "bug_tracker_uri" => "#{s.homepage}/issues",
+    "documentation_uri" => "#{s.homepage}/wiki",
+    "changelog_uri" => "#{s.homepage}/blob/master/CHANGELOG.md",
+    "source_code_uri" => s.homepage,
   }
 
-  s.add_dependency(%q<rails>, [">= 4.0"])
+  s.add_dependency "railties", ">= 6.0"
 end
 

data/lib/datagrid/active_model.rb

@@ -1,10 +1,7 @@
-
 module Datagrid
-
   # Required to be ActiveModel compatible
-  # @private
-  module ActiveModel #:nodoc:
-
+  module ActiveModel
+    # @!visibility private
     def self.included(base)
       base.extend         ClassMethods
       base.class_eval do
@@ -18,41 +15,40 @@ module Datagrid
           extend ::ActiveModel::AttributesAssignment
         rescue LoadError
         end
-
       end
-      base.send :include, InstanceMethods
-    end # self.included
+    end
 
     module ClassMethods
+      # @return [String] URL query parameter name of the grid class
       def param_name
         self.to_s.underscore.tr('/', '_')
       end
-    end # ClassMethods
+    end
 
-    module InstanceMethods
-      def param_name
-        self.class.param_name
-      end
+    # @return [String] URL query parameter name of the grid class
+    def param_name
+      self.class.param_name
+    end
 
-      def param_key
-        param_name
-      end
+    # @return [String] URL query parameter name of the grid class
+    def param_key
+      param_name
+    end
 
-      def to_key
-        [self.class.param_name]
-      end
+    def to_key
+      [self.class.param_name]
+    end
 
-      def persisted?
-        false
-      end
+    def persisted?
+      false
+    end
 
-      def to_model
-        self
-      end
+    def to_model
+      self
+    end
 
-      def to_param
-        self.param_name
-      end
-    end # InstanceMethods
+    def to_param
+      self.param_name
+    end
   end
 end

data/lib/datagrid/column_names_attribute.rb

@@ -21,45 +21,46 @@ module Datagrid
       # will always present in the grid table and won't be listed
       # in column names selection
       # Accepts same options as <tt>:enum</tt> filter
-      #
-      # Examples:
-      # 
-      #   column_names_filter(:header => "Choose columns")
-      #   
-      def column_names_filter(options = {})
-        filter(:column_names, :enum, {
-          :select => :optional_columns_select,
-          :multiple => true,
-          :dummy => true
-        }.merge(options || {}))
+      # @example
+      #   column_names_filter(header: "Choose columns")
+      # @see Datagrid::Filters::ClassMethods#filter
+      def column_names_filter(**options)
+        filter(
+          :column_names, :enum,
+          select: :optional_columns_select,
+          multiple: true,
+          dummy: true,
+          **options,
+        )
       end
     end
 
-    def columns(*args) #:nodoc:
-      options = args.extract_options!
-      column_names = selected_column_names(*args)
-      column_names << options
-      super(*column_names)
+    # @!visibility private
+    def columns(*args, **options)
+      super(*selected_column_names(*args), **options)
     end
 
-    # Returns a list of enabled columns with <tt>:mandatory => true</tt> option
+    # Returns a list of enabled columns with <tt>mandatory: true</tt> option
     # If no mandatory columns specified than all of them considered mandatory
+    # @return [Array<Datagrid::Columns::Column>]
     def mandatory_columns
       available_columns.select {|c| c.mandatory? }
     end
 
     # Returns a list of enabled columns without <tt>:mandatory => true</tt> option
+    # If no mandatory columns specified than all of them considered mandatory but not optional
+    # @return [Array<Datagrid::Columns::Column>]
     def optional_columns
       available_columns - mandatory_columns
     end
 
     protected
 
-    def optional_columns_select #:nodoc:
+    def optional_columns_select
       optional_columns.map {|c| [c.header, c.name] }
     end
 
-    def selected_column_names(*args)                  
+    def selected_column_names(*args)
       if args.any?
         args.compact!
         args.map!(&:to_sym)
@@ -75,7 +76,7 @@ module Datagrid
 
     def columns_visibility_enabled?
       columns_array.any? do |column|
-        column.options.key?(:mandatory)
+        column.mandatory_explicitly_set?
       end
     end
 

data/lib/datagrid/columns/column.rb

@@ -1,6 +1,8 @@
 class Datagrid::Columns::Column
 
-  class ResponseFormat # :nodoc:
+  # Datagrid class holding an information of
+  # how a column should be rendered in data/console/csv format and HTML format
+  class ResponseFormat
 
     attr_accessor :data_block, :html_block
 
@@ -106,6 +108,10 @@ class Datagrid::Columns::Column
     !! options[:mandatory]
   end
 
+  def mandatory_explicitly_set?
+    options.key?(:mandatory)
+  end
+
   def enabled?(grid)
     ::Datagrid::Utils.process_availability(grid, options[:if], options[:unless])
   end