wice_grid 3.6.2 → 4.1.0

data/spec/support/test_app/app/controllers/all_records_controller.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+class AllRecordsController < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task,
+      include:  [:priority, :status, :project, :assigned_users],
+      order:  'statuses.name',
+      custom_order:  {
+        'tasks.priority_id' => 'priorities.name',
+        'tasks.status_id' => 'statuses.position',
+        'tasks.project_id' => 'projects.name'
+      }
+    )
+  end
+end

data/spec/support/test_app/app/controllers/application_controller.rb

@@ -0,0 +1,99 @@
+# encoding: utf-8
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  before_action :init_example_map
+  before_action :init_current_example_map
+
+  protected
+
+  def init_current_example_map
+    @controller_file_to_show = 'app/controllers/' + controller_name + '_controller.rb'
+    @controller_file = File.join(Rails.root, @controller_file_to_show)
+
+    @view_files_dir = {}
+    view_files_dir = File.join(Rails.root, 'app/views/' + controller_name)
+    Dir.glob("#{view_files_dir}/*").each do |fullpath|
+      fullpath =~ /^.+(app\/views\/.+)$/
+      @view_files_dir[Regexp.last_match(1)] = fullpath
+    end
+  end
+
+  def init_example_map
+    @example_map = [
+      ['Basics',
+       [
+         [:basics1, 'Most simple grid'],
+         [:basics2, 'Named columns'],
+         [:upper_pagination_panel, 'Two pagination panels'],
+         [:basics3, 'Associating columns with database fields'],
+
+         [:blockless_column_definition, 'Dropping the block in #column'],
+         [:numeric_filters, 'Numeric filters'],
+         [:many_grids_on_page, 'More than 1 grid on a page'],
+         [:basics4, 'Disabling filters'],
+         [:disable_all_filters, 'Disabling all filters'],
+         [:dates, 'Date/Datetime helpers'],
+         [:when_filtered, 'Hidden filter panel'],
+         [:basics5, 'Disabling ordering'],
+         [:basics6, 'Initial conditions and ordering'],
+         [:buttons, 'External submit/reset buttons'],
+         [:detached_filters, 'External filters'],
+         [:detached_filters_two_grids, 'External filters (example with 2 grids)'],
+         [:no_records, 'A grid without records']
+
+       ]
+      ],
+
+      ['Joined tables',
+       [
+         [:joining_tables, 'Joined tables'],
+         [:two_associations, '2 associations to the same table']
+       ]
+      ],
+
+      ['Custom filters and ordering',
+       [
+         [:custom_ordering, 'Custom ordering (with String)'],
+         [:custom_ordering_with_arel, 'Custom ordering (with Arel)'],
+         [:custom_ordering_with_proc, 'Custom ordering (with Proc)'],
+         [:custom_ordering_with_ruby, 'Custom ordering (with arbitrary Ruby)'],
+         [:custom_ordering_on_calculated, 'Custom ordering (on a calculated field)'],
+         [:custom_filters1, 'Custom filters (one table)'],
+         [:custom_filters2, 'Custom filters (joined tables)'],
+         [:custom_filters3, 'Custom filters (method chains)'],
+         [:custom_filters4, 'Custom filters: turning off multiple selection'],
+         [:null_values, 'Custom filters (null values)']
+       ]
+      ],
+
+      ['Miscellaneous',
+       [
+         [:styling, 'Styling the grid'],
+         [:negation, 'Text filters with negation'],
+         [:adding_rows, 'Adding custom rows'],
+         [:all_records, 'Removing link "All Records"'],
+         [:csv_export, 'CSV export'],
+         [:csv_and_detached_filters, 'CSV export and external filters'],
+         [:auto_reloads, 'Auto reloading filters'],
+         [:auto_reloads2, 'Auto reloading filters (external filters)'],
+         [:auto_reloads3, 'Auto reloading filters (two grids on page)']
+       ]
+      ],
+
+      ['Integration with the application',
+       [
+         [:action_column, 'Action column'],
+         [:hiding_checkboxes_in_action_column, 'Hiding certain checkboxes in the action column'],
+         [:integration_with_forms, 'Integration with other forms'],
+         [:integration_with_application_view, 'View helpers to access records on the current page and all pages'],
+         [:resultset_processings, 'Callback to process records of the current page'],
+         [:resultset_processings2, 'Callback to process records throughout all pages on demand'],
+         [:localization, 'Localization'],
+         [:custom_filter_params, 'Generating custom filter parameters'],
+         [:saved_queries, 'Saved queries: simple example']
+       ]
+      ]
+    ]
+  end
+end

data/spec/support/test_app/app/controllers/auto_reloads2_controller.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+class AutoReloads2Controller < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task,
+      custom_order:  {
+        'tasks.priority_id' => 'priorities.name',
+        'tasks.status_id' => 'statuses.position',
+        'tasks.project_id' => 'projects.name'
+      },
+      order:  'id',
+      order_direction:  'asc'
+    )
+  end
+end

data/spec/support/test_app/app/controllers/auto_reloads3_controller.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+class AutoReloads3Controller < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task,
+      custom_order: {
+        'tasks.priority_id' => 'priorities.name',
+        'tasks.status_id' => 'statuses.position',
+        'tasks.project_id' => 'projects.name'
+      }
+    )
+    @tasks_grid2 = initialize_grid(Task,
+     name: 'grid2',
+     custom_order: {
+       'tasks.priority_id' => 'priorities.name',
+       'tasks.status_id' => 'statuses.position',
+       'tasks.project_id' => 'projects.name'
+     }
+    )
+  end
+end

data/spec/support/test_app/app/controllers/auto_reloads_controller.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+class AutoReloadsController < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task,
+      custom_order: {
+        'tasks.priority_id' => 'priorities.name',
+        'tasks.status_id' => 'statuses.position',
+        'tasks.project_id' => 'projects.name'
+      },
+      order: 'id',
+      order_direction: 'asc'
+    )
+  end
+end

data/spec/support/test_app/app/controllers/basics1_controller.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+class Basics1Controller < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task)
+  end
+end

data/spec/support/test_app/app/controllers/basics2_controller.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+class Basics2Controller < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task)
+  end
+end

data/spec/support/test_app/app/controllers/basics3_controller.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+class Basics3Controller < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task, order: 'id')
+  end
+end

data/spec/support/test_app/app/controllers/basics4_controller.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+class Basics4Controller < ApplicationController
+  def index
+     @tasks_grid = initialize_grid(Task)
+  end
+end

data/spec/support/test_app/app/controllers/basics5_controller.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+class Basics5Controller < ApplicationController
+  def index
+     @tasks_grid = initialize_grid(Task)
+  end
+end

data/spec/support/test_app/app/controllers/basics6_controller.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+class Basics6Controller < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task,
+      order: 'tasks.title',
+      order_direction: 'desc',
+      conditions: { archived: false },
+      per_page: 20
+    )
+  end
+end

data/spec/support/test_app/app/controllers/blockless_column_definition_controller.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+class BlocklessColumnDefinitionController < ApplicationController
+  def index
+     @tasks_grid = initialize_grid(Task, order: 'id')
+  end
+end

data/spec/support/test_app/app/controllers/buttons_controller.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+class ButtonsController < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task)
+  end
+end

data/spec/support/test_app/app/controllers/csv_and_detached_filters_controller.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+class CsvAndDetachedFiltersController < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task,
+      name: 'grid',
+      enable_export_to_csv: true,
+      csv_field_separator: ';',
+      csv_file_name: 'tasks'
+    )
+
+    export_grid_if_requested('grid' => 'grid')
+  end
+end

data/spec/support/test_app/app/controllers/csv_export_controller.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+class CsvExportController < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task,
+      include: [:priority, :status, :project, :assigned_users],
+      order: 'statuses.name',
+      custom_order: {
+        'tasks.priority_id' => 'priorities.name',
+        'tasks.status_id' => 'statuses.position',
+        'tasks.project_id' => 'projects.name'
+      },
+      name: 'g1',
+      enable_export_to_csv: true,
+      csv_field_separator: ';',
+      csv_file_name: 'tasks'
+    )
+
+    @projects_grid = initialize_grid(Project,
+      name: 'g2',
+      enable_export_to_csv: true,
+      csv_file_name: 'projects'
+    )
+
+    export_grid_if_requested('g1' => 'tasks_grid', 'g2' => 'projects_grid') do
+      # usual render or redirect code executed if the request is not a CSV export request
+    end
+  end
+end

data/spec/support/test_app/app/controllers/custom_filter_params_controller.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+class CustomFilterParamsController < ApplicationController
+  def index
+    @projects_grid = initialize_grid(Project)
+  end
+end

data/spec/support/test_app/app/controllers/custom_filters1_controller.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+class CustomFilters1Controller < ApplicationController
+  def index
+    @versions_grid1 = initialize_grid(Version, name: 'g1', per_page: 5)
+    @versions_grid2 = initialize_grid(Version, name: 'g2', per_page: 5)
+    @versions_grid3 = initialize_grid(Version, name: 'g3', per_page: 5)
+    @versions_grid4 = initialize_grid(Version, name: 'g4', per_page: 5)
+  end
+end

data/spec/support/test_app/app/controllers/custom_filters2_controller.rb

@@ -0,0 +1,14 @@
+# encoding: utf-8
+class CustomFilters2Controller < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task,
+      include: [:priority, :status, :project],
+      order: 'statuses.name',
+      custom_order: {
+        # 'tasks.priority_id' => 'priorities.name',
+        'tasks.status_id'   => 'statuses.position',
+        'tasks.project_id'  => 'projects.name'
+      }
+    )
+  end
+end

data/spec/support/test_app/app/controllers/custom_filters3_controller.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+class CustomFilters3Controller < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task,
+      include: [:relevant_version, :expected_version, :project],
+      conditions: { projects: { id: Project.first.id } },
+      custom_order: {
+        'tasks.expected_version_id' => 'expected_versions_tasks.name'
+      }
+    )
+  end
+end

data/spec/support/test_app/app/controllers/custom_filters4_controller.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+class CustomFilters4Controller < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task,
+      include: [:relevant_version, :expected_version, :project],
+      conditions: ['projects.id = ?', Project.first],
+      custom_order: {
+        'tasks.expected_version_id' => 'expected_versions_tasks.name'
+      }
+    )
+  end
+end

data/spec/support/test_app/app/controllers/custom_ordering_controller.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+class CustomOrderingController < ApplicationController
+  def index
+    @status_grid1 = initialize_grid(Status,
+      order: 'statuses.name',
+      custom_order: {
+        'statuses.name' => 'length( ? )'
+      }
+    )
+    @status_grid2 = initialize_grid(Status,
+      name: 'g2',
+      order: 'statuses.name',
+      custom_order: {
+        'statuses.name' => 'statuses.position'
+      }
+    )
+  end
+end

data/spec/support/test_app/app/controllers/custom_ordering_on_calculated_controller.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+class CustomOrderingOnCalculatedController < ApplicationController
+  def index
+    @status_grid = initialize_grid(Status)
+  end
+end

data/spec/support/test_app/app/controllers/custom_ordering_with_arel_controller.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+class CustomOrderingWithArelController < ApplicationController
+  def index
+    @status_grid1 = initialize_grid(Status,
+      order: 'statuses.name',
+      custom_order: {
+        'statuses.name' => Arel.sql('length( ? )')
+      }
+    )
+    @status_grid2 = initialize_grid(Status,
+      name: 'g2',
+      order: 'statuses.name',
+      custom_order: {
+        'statuses.name' => Status.arel_table[:position]
+      }
+    )
+  end
+end

data/spec/support/test_app/app/controllers/custom_ordering_with_proc_controller.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+class CustomOrderingWithProcController < ApplicationController
+  def index
+    @status_grid = initialize_grid(Status,
+      order: 'statuses.name',
+      custom_order: {
+        'statuses.name' => ->(column_name) { params[:sort_by_length] ? "length(#{column_name})" : column_name }
+      }
+    )
+  end
+end

data/spec/support/test_app/app/controllers/custom_ordering_with_ruby_controller.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+class CustomOrderingWithRubyController < ApplicationController
+  def index
+    @status_grid = initialize_grid(Status)
+  end
+end

data/spec/support/test_app/app/controllers/dates_controller.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+class DatesController < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task,
+      order: 'id'
+    )
+  end
+end

data/spec/support/test_app/app/controllers/detached_filters_controller.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+class DetachedFiltersController < ApplicationController
+  def index
+    @tasks_grid = initialize_grid(Task)
+  end
+end

data/spec/support/test_app/app/controllers/detached_filters_two_grids_controller.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+class DetachedFiltersTwoGridsController < ApplicationController
+  def index
+    @grid1 = initialize_grid(Task)
+    @grid2 = initialize_grid(Task, name: 'grid2')
+  end
+end

data/spec/support/test_app/app/controllers/disable_all_filters_controller.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+class DisableAllFiltersController < ApplicationController
+  def index
+     @tasks_grid = initialize_grid(Task)
+  end
+end