datagrid 1.8.1 → 2.0.0.pre.alpha

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datagrid
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 2.0.0.pre.alpha
 platform: ruby
 authors:
 - Bogdan Gusiev
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-05 00:00:00.000000000 Z
+date: 2024-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,27 +16,27 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
-description: This allows you to easily build datagrid aka data tables with sortable
-  columns and filters
+        version: '7.0'
+description: The library allows you to easily build datagrid aka data tables with
+  sortable columns and filters
 email: agresso@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- Readme.markdown
+- README.md
 files:
 - CHANGELOG.md
 - LICENSE.txt
-- Readme.markdown
-- app/assets/stylesheets/datagrid.sass
+- README.md
+- app/assets/stylesheets/datagrid.css
 - app/views/datagrid/_enum_checkboxes.html.erb
 - app/views/datagrid/_form.html.erb
 - app/views/datagrid/_head.html.erb
@@ -47,11 +47,13 @@ files:
 - datagrid.gemspec
 - lib/datagrid.rb
 - lib/datagrid/active_model.rb
+- lib/datagrid/base.rb
 - lib/datagrid/column_names_attribute.rb
 - lib/datagrid/columns.rb
 - lib/datagrid/columns/column.rb
 - lib/datagrid/configuration.rb
 - lib/datagrid/core.rb
+- lib/datagrid/deprecated_object.rb
 - lib/datagrid/drivers.rb
 - lib/datagrid/drivers/abstract_driver.rb
 - lib/datagrid/drivers/active_record.rb
@@ -63,7 +65,6 @@ files:
 - lib/datagrid/filters.rb
 - lib/datagrid/filters/base_filter.rb
 - lib/datagrid/filters/boolean_filter.rb
-- lib/datagrid/filters/composite_filters.rb
 - lib/datagrid/filters/date_filter.rb
 - lib/datagrid/filters/date_time_filter.rb
 - lib/datagrid/filters/default_filter.rb
@@ -76,19 +77,16 @@ files:
 - lib/datagrid/filters/select_options.rb
 - lib/datagrid/filters/string_filter.rb
 - lib/datagrid/form_builder.rb
+- lib/datagrid/generators/scaffold.rb
+- lib/datagrid/generators/views.rb
 - lib/datagrid/helper.rb
 - lib/datagrid/locale/en.yml
 - lib/datagrid/ordering.rb
-- lib/datagrid/renderer.rb
 - lib/datagrid/rspec.rb
-- lib/datagrid/scaffold.rb
 - lib/datagrid/utils.rb
 - lib/datagrid/version.rb
-- lib/tasks/datagrid_tasks.rake
 - templates/base.rb.erb
-- templates/controller.rb.erb
 - templates/grid.rb.erb
-- templates/index.html.erb
 homepage: https://github.com/bogdan/datagrid
 licenses:
 - MIT
@@ -96,8 +94,9 @@ metadata:
   homepage_uri: https://github.com/bogdan/datagrid
   bug_tracker_uri: https://github.com/bogdan/datagrid/issues
   documentation_uri: https://github.com/bogdan/datagrid/wiki
-  changelog_uri: https://github.com/bogdan/datagrid/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/bogdan/datagrid/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/bogdan/datagrid
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -106,15 +105,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.15
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: Ruby gem to create datagrids
+summary: Library that provides DSL to present table like data
 test_files: []

data/app/assets/stylesheets/datagrid.sass

@@ -1,134 +0,0 @@
-$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
-
-  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
-  .enum_filter.checkboxes 
-    float: none
-    display: block
-    input
-      margin: 7px
-    margin-left: 150px
-
-
-.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/lib/datagrid/filters/composite_filters.rb

@@ -1,49 +0,0 @@
-module Datagrid
-  module Filters
-    # @!visibility private
-    module CompositeFilters
-
-      def self.included(base)
-        base.extend         ClassMethods
-        base.class_eval do
-        end
-      end
-
-      # @!visibility private
-      module ClassMethods
-
-        def date_range_filters(field, from_options = {}, to_options = {})
-          Utils.warn_once('date_range_filters is deprecated in favor of range option for date filter')
-          from_options = normalize_composite_filter_options(from_options, field)
-          to_options = normalize_composite_filter_options(to_options, field)
-
-          filter(from_options[:name] || :"from_#{field.to_s.tr('.', '_')}", :date, **from_options) do |date, scope, grid|
-            grid.driver.greater_equal(scope, field, date)
-          end
-          filter(to_options[:name] || :"to_#{field.to_s.tr('.', '_')}", :date, **to_options) do |date, scope, grid|
-            grid.driver.less_equal(scope, field, date)
-          end
-        end
-
-        def integer_range_filters(field, from_options = {}, to_options = {})
-          Utils.warn_once('integer_range_filters is deprecated in favor of range option for integer filter')
-          from_options = normalize_composite_filter_options(from_options, field)
-          to_options = normalize_composite_filter_options(to_options, field)
-          filter(from_options[:name] || :"from_#{field.to_s.tr('.', '_')}", :integer, **from_options) do |value, scope, grid|
-            grid.driver.greater_equal(scope, field, value)
-          end
-          filter(to_options[:name] || :"to_#{field.to_s.tr('.', '_')}", :integer, **to_options) do |value, scope, grid|
-            grid.driver.less_equal(scope, field, value)
-          end
-        end
-
-        def normalize_composite_filter_options(options, field)
-          if options.is_a?(String) || options.is_a?(Symbol)
-            options = {name: options}
-          end
-          options
-        end
-      end
-    end
-  end
-end

data/lib/datagrid/renderer.rb

@@ -1,157 +0,0 @@
-require "action_view"
-
-module Datagrid
-  # @!visibility private
-  class Renderer
-
-    def self.for(template)
-      new(template)
-    end
-
-    def initialize(template)
-      @template = template
-    end
-
-    def format_value(grid, column, asset)
-      if column.is_a?(String) || column.is_a?(Symbol)
-        column = grid.column_by_name(column)
-      end
-
-      value = grid.html_value(column, @template, asset)
-
-      url = column.options[:url] && column.options[:url].call(asset)
-      if url
-        @template.link_to(value, url)
-      else
-        value
-      end
-    end
-
-    def form_for(grid, options = {})
-      options[:method] ||= :get
-      options[:html] ||= {}
-      options[:html][:class] ||= "datagrid-form #{@template.dom_class(grid)}"
-      options[:as] ||= grid.param_name
-      _render_partial('form', options[:partials], {:grid => grid, :options => options})
-    end
-
-    def table(grid, assets, **options)
-      options[:html] ||= {}
-      options[:html][:class] ||= "datagrid #{@template.dom_class(grid)}"
-
-      _render_partial('table', options[:partials],
-                      {
-                        grid: grid,
-                        options: options,
-                        assets: assets
-                      })
-    end
-
-    def header(grid, options = {})
-      options[:order] = true unless options.has_key?(:order)
-
-      _render_partial('head', options[:partials],
-                      { :grid => grid, :options => options })
-    end
-
-    def rows(grid, assets = grid.assets, **options, &block)
-      result = assets.map do |asset|
-        row(grid, asset, **options, &block)
-      end.to_a.join
-
-      _safe(result)
-    end
-
-    def row(grid, asset, **options, &block)
-      Datagrid::Helper::HtmlRow.new(self, grid, asset, options).tap do |row|
-        if block_given?
-          return @template.capture(row, &block)
-        end
-      end
-    end
-
-    def order_for(grid, column, options = {})
-      _render_partial('order_for', options[:partials],
-                      { :grid => grid, :column => column })
-    end
-
-    def order_path(grid, column, descending, request)
-      column = grid.column_by_name(column)
-      query = request ? request.query_parameters : {}
-      ActionDispatch::Http::URL.path_for(
-        path: request ? request.path : '/',
-        params: query.merge(grid.query_params(order: column.name, descending: descending))
-      )
-    end
-
-    private
-
-    def _safe(string)
-      string.respond_to?(:html_safe) ? string.html_safe : string
-    end
-
-    def _render_partial(partial_name, partials_path, locals = {})
-      @template.render({
-        :partial => File.join(partials_path || 'datagrid', partial_name),
-        :locals => locals
-      })
-    end
-  end
-
-  module Helper
-    # Represents a datagrid row that provides access to column values for the given asset
-    # @example
-    #   row = datagrid_row(grid, user)
-    #   row.class      # => Datagrid::Helper::HtmlRow
-    #   row.first_name # => "<strong>Bogdan</strong>"
-    #   row.grid       # => Grid object
-    #   row.asset      # => User object
-    #   row.each do |value|
-    #     puts value
-    #   end
-    class HtmlRow
-
-      include Enumerable
-
-      attr_reader :grid, :asset, :options
-
-      # @!visibility private
-      def initialize(renderer, grid, asset, options)
-        @renderer = renderer
-        @grid = grid
-        @asset = asset
-        @options = options
-      end
-
-      # @return [Object] a column value for given column name
-      def get(column)
-        @renderer.format_value(@grid, column, @asset)
-      end
-
-      # Iterates over all column values that are available in the row
-      # param block [Proc] column value iterator
-      def each(&block)
-        (@options[:columns] || @grid.html_columns).each do |column|
-          block.call(get(column))
-        end
-      end
-
-      def to_s
-        @renderer.send(:_render_partial, 'row', options[:partials], {
-          :grid => grid,
-          :options => options,
-          :asset => asset
-        })
-      end
-
-      protected
-      def method_missing(method, *args, &blk)
-        if column = @grid.column_by_name(method)
-          get(column)
-        else
-          super
-        end
-      end
-    end
-  end
-end

data/lib/datagrid/scaffold.rb

@@ -1,129 +0,0 @@
-require "rails/generators"
-
-class Datagrid::Scaffold < Rails::Generators::NamedBase
-
-  include Rails::Generators::ResourceHelpers
-
-  check_class_collision :suffix => "Grid"
-  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)
-      inject_into_file grid_controller_file, index_action, :after => %r{class .*#{grid_controller_class_name}.*\n}
-    else
-      template "controller.rb.erb", grid_controller_file
-    end
-    template "index.html.erb", view_file
-    route(generate_routing_namespace("resources :#{grid_controller_short_name}"))
-    unless defined?(::Kaminari) || defined?(::WillPaginate)
-      gem 'kaminari'
-    end
-    in_root do
-      {
-        "css" => " *= require datagrid",
-        "css.sass" => " *= require datagrid",
-        "css.scss" => " *= require datagrid",
-      }.each do |extension, string|
-        file = "app/assets/stylesheets/application.#{extension}"
-        if file_exists?(file)
-          inject_into_file file, string + "\n", {:before => %r{.*require_self}} # before all
-        end
-      end
-    end
-  end
-
-  def view_file
-    Rails.root.join("app/views").join(controller_file_path).join("index.html.erb")
-  end
-
-  def grid_class_name
-    file_name.camelize.pluralize + "Grid"
-  end
-
-  def grid_controller_class_name
-    controller_class_name.camelize + "Controller"
-  end
-
-  def grid_controller_file
-    Rails.root.join("app/controllers").join("#{grid_controller_class_name.underscore}.rb")
-  end
-
-  def grid_controller_short_name
-    controller_file_name
-  end
-
-  def grid_model_name
-    file_name.camelize.singularize
-  end
-
-  def grid_param_name
-    grid_class_name.underscore
-  end
-
-  def pagination_helper_code
-    if defined?(::WillPaginate)
-      "will_paginate(@grid.assets)"
-    else
-      # Kaminari is default
-      "paginate(@grid.assets)"
-    end
-  end
-
-  def base_grid_file
-    "app/grids/base_grid.rb"
-  end
-
-  def grid_route_name
-    controller_class_name.underscore.gsub("/", "_") + "_path"
-  end
-
-  def index_action
-    indent(<<-RUBY)
-def index
-  @grid = #{grid_class_name}.new(grid_params) do |scope|
-    scope.page(params[:page])
-  end
-end
-
-protected
-
-def grid_params
-  params.fetch(:#{grid_param_name}, {}).permit!
-end
-RUBY
-  end
-
-  protected
-  def generate_routing_namespace(code)
-    depth = regular_class_path.length
-    # Create 'namespace' ladder
-    # namespace :foo do
-    #   namespace :bar do
-    namespace_ladder = regular_class_path.each_with_index.map do |ns, i|
-      indent("namespace :#{ns} do\n", i * 2)
-    end.join
-
-    # Create route
-    #     get 'baz/index'
-    route = indent(code, depth * 2)
-
-    # Create `end` ladder
-    #   end
-    # end
-    end_ladder = (1..depth).reverse_each.map do |i|
-      indent("end\n", i * 2)
-    end.join
-
-    # 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.exist?(name)
-  end
-end

data/lib/tasks/datagrid_tasks.rake

@@ -1,15 +0,0 @@
-namespace :datagrid do
-
-  desc "Copy table partials into rails application"
-  task :copy_partials do
-    require "fileutils"
-    views_path = "app/views/datagrid"
-    destination_dir = (Rails.root + views_path).to_s
-    pattern = File.expand_path(File.dirname(__FILE__) + "/../../#{views_path}") + "/*"
-    Dir[pattern].each do |template|
-      puts "* copy #{template} => #{destination_dir}"
-      FileUtils.mkdir_p destination_dir
-      FileUtils.cp template, destination_dir
-    end
-  end
-end

data/templates/controller.rb.erb

@@ -1,6 +0,0 @@
-class <%= grid_controller_class_name %> < ApplicationController
-
-<%= index_action -%>
-
-end
-

data/templates/index.html.erb

@@ -1,5 +0,0 @@
-<%%= datagrid_form_for @grid, method: :get, url: <%= grid_route_name %> %>
-
-<%%= <%=pagination_helper_code%> %>
-<%%= datagrid_table @grid %>
-<%%= <%=pagination_helper_code%> %>