wice_grid 3.6.2 → 4.1.0

data/spec/support/test_app/app/views/csv_and_detached_filters/index.html.haml

@@ -0,0 +1,58 @@
+.well
+  %h2= current_page_title
+  %p
+    CSV export works with
+    %code define_grid
+    and external filters, too.
+
+= show_code
+
+= render   'grid'
+
+
+.row
+  .col-md-2
+    ID:
+  .col-md-10
+    = grid_filter @tasks_grid, :id_filter
+
+.row
+  .col-md-2
+    Title:
+  .col-md-10
+    = grid_filter @tasks_grid, :title_filter
+
+.row
+  .col-md-2
+    Description:
+  .col-md-10
+    = grid_filter @tasks_grid, :description_filter
+
+.row
+  .col-md-2
+    Archived:
+  .col-md-10
+    = grid_filter @tasks_grid, :archived_filter
+
+
+.row
+  .col-md-2
+    Due date:
+  .col-md-10
+    = grid_filter @tasks_grid, :due_date
+
+
+.row
+  .col-md-12
+    %button.btn.btn-primary.wg-external-submit-button{'data-grid-name' => 'grid'} Submit
+    %button.btn.btn-default.wg-external-reset-button{'data-grid-name' => 'grid'} Reset
+    %button.btn.btn-primary.wg-external-csv-export-button{'data-grid-name' => 'grid'} Export To CSV
+
+%p
+
+.row
+  .col-md-12
+
+
+
+    = render_grid(@tasks_grid)

data/spec/support/test_app/app/views/csv_export/_projects_grid.html.erb

@@ -0,0 +1,17 @@
+<%= grid(@projects_grid, show_filters: :always, hide_csv_button: true) do |g|
+
+  g.column name:  'ID', attribute: 'id', filter: false
+
+  g.column name:  'Project Name', attribute: 'name'
+
+
+  g.column  name:  'Customer company', assoc: :customer, attribute: 'name' do |task|
+    task.customer.name if task.customer
+  end
+
+  g.column  name:  'Supplier company',
+            assoc: :supplier, attribute: 'name', table_alias: 'suppliers_projects' do |task|
+    task.supplier.name if task.supplier
+  end
+
+end -%>

data/spec/support/test_app/app/views/csv_export/_tasks_grid.html.erb

@@ -0,0 +1,43 @@
+<%= grid(@tasks_grid, upper_pagination_panel: true) do |g|
+
+  g.column name:  'ID', attribute: 'id', filter: false
+
+  # html version
+  g.column name:  'Title', attribute: 'title', in_csv: false do |task|
+    link_to('Edit', edit_task_path(task.title))
+  end
+  # plain text version
+  g.column name:  'Title', in_html: false do |task|
+    task.title
+  end
+
+  g.column name:  'Priority', attribute: 'priority_id', custom_filter: Priority.to_dropdown do |task|
+    task.priority.name if task.priority
+  end
+
+  g.column name:  'Status', attribute: 'status_id', custom_filter: Status.to_dropdown do |task|
+    task.status.name if task.status
+  end
+
+  # html version
+  g.column name:  'Project Name', attribute: 'project_id', custom_filter: Project.to_dropdown,  in_csv: false do |task|
+    link_to_if(task.project, task.project.name, project_path(task.project) )
+  end
+  # plain text version
+  g.column name:  'Project Name', in_html: false do |task|
+    task.project.name if task.project
+  end
+
+  g.column  name:  'Archived', attribute: 'archived' do |task|
+    task.archived? ? 'Yes' : 'No'
+  end
+
+  g.column name:  'Added', attribute: 'created_at' do |task|
+    task.created_at.to_s(:short)
+  end
+
+  # is not included into csv
+  g.column  in_csv: false do |task|
+    link_to('Edit', edit_task_path(task))
+  end
+end -%>

data/spec/support/test_app/app/views/csv_export/index.html.haml

@@ -0,0 +1,90 @@
+.well
+  %h2= current_page_title
+  %p
+    A grid can export itself in the form of a CSV file. The contents of the file corresponds to the selected subset of all records,
+    that is, the CSV export follows the state of filters and sorting.
+  %p
+    To enable CSV export for a grid please do the following:
+    %ol
+      %li Make sure that the grid helper is in its own partial and there are no other elements in that partial including whitespaces
+      %li
+        Enable CSV export by adding
+        %code enable_export_to_csv:  true
+        to
+        %code initialize_grid
+      %li
+        Set the name of the exported file using option
+        %code :csv_file_name
+        in
+        %code initialize_grid
+      %li
+        Change the CSV field separator by adding
+        %code csv_field_separator:  'your-separator'
+        to
+        %code initialize_grid
+        \.
+        The default field separator is the comma, and you can change the default by editing the value of
+        %code Wice::Defaults::CSV_FIELD_SEPARATOR
+        in the config file
+
+      %li
+        The action code should be finished by a call to
+        %code export_grid_if_requested
+        \:
+        :plain
+          <pre>
+          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
+          </pre>
+        The block is executed if the call is not a request for a CSV file, so place your usual
+        %code redirect_to
+        ,
+        %code render
+        inside the block, or just skip it if your action does not have an explicit render:
+        :plain
+          <pre>
+          export_grid_if_requested('g1' => 'tasks_grid', 'g2' => 'projects_grid')
+          </pre>
+
+        The keys of the hash submitted as an argument to
+        %code  export_grid_if_requested
+        are names of grids, and the values are names of partials where the grids are defined.
+
+      %li
+        If a column definition contains markup, first disable its export to CSV adding
+        %code in_csv: false
+        to the column definition, and then duplicate the column definition without the markup in the block while adding
+        %code in_html: false
+        to the column definition. Any filter related parameters like
+        %code :attribute
+        ,
+        %code :assoc
+        , or
+        %code :custom_filter
+        can be skipped in a CSV-only column.
+      %li
+        If you need an external CSV export button , add  class
+        %code wg-external-csv-export-button
+        to any clickable element on page
+        and set its attribute
+        %code data-grid-name
+        to the name of the grid. If you need to disable the default export icon in the grid, add
+        %code hide_csv_button: true
+        to the
+        %code grid
+        helper.
+
+= show_code
+
+%p
+  %button.btn.btn-primary.wg-external-csv-export-button{'data-grid-name' => 'g1'} Export To CSV
+
+
+.row-fluid
+  .col-md-12
+    =render  'projects_grid'
+
+.row-fluid
+  .col-md-12
+    =render  'tasks_grid'

data/spec/support/test_app/app/views/custom_filter_params/_grid.html.erb

@@ -0,0 +1,12 @@
+<%= grid(@projects_grid) do |g|
+
+  g.column name:  'Project Name', attribute: 'name'  do |project|
+    link_to(project.name,
+            tasks_path(
+              wice_grid_custom_filter_params(
+                grid_name: 'grid',
+                attribute: 'project_id',
+                value: project.id  )))
+  end
+
+end -%>

data/spec/support/test_app/app/views/custom_filter_params/index.html.haml

@@ -0,0 +1,12 @@
+.well
+  %h2= current_page_title
+  %p
+    Helper
+    %code wice_grid_custom_filter_params
+    simplifies generation of links with HTTP parameters understood by WiceGrid custom filter parameters.
+
+= show_code
+
+.row-fluid
+  .col-md-4
+    = render   'grid'

data/spec/support/test_app/app/views/custom_filters1/_g1.html.erb

@@ -0,0 +1,8 @@
+<%= grid(@versions_grid1) do |g|
+
+  g.column name:  'Project', attribute: 'name', assoc: :project, filter: false
+
+  g.column name:  'Version name', attribute: 'name', filter: false
+
+  g.column name:  'Status', attribute: 'status', custom_filter: {'Development' => 'development', 'Testing' => 'testing', 'Production' => 'production'}
+end -%>

data/spec/support/test_app/app/views/custom_filters1/_g2.html.erb

@@ -0,0 +1,9 @@
+<%= grid(@versions_grid2) do |g|
+
+  g.column name:  'Project', attribute: 'name', assoc: :project, filter: false
+
+  g.column name:  'Version name', attribute: 'name', filter: false
+
+  g.column name:  'Status', attribute: 'status',
+           custom_filter: [['Development', 'development'], ['Testing', 'testing'], ['Production', 'production']]
+end -%>

data/spec/support/test_app/app/views/custom_filters1/_g3.html.erb

@@ -0,0 +1,9 @@
+<%= grid(@versions_grid3) do |g|
+
+  g.column name:  'Project', attribute: 'name', assoc: :project, filter: false
+
+  g.column name:  'Version name', attribute: 'name', filter: false
+
+  g.column name:  'Status', attribute: 'status',
+           custom_filter: ['development', 'testing', 'production']
+end -%>

data/spec/support/test_app/app/views/custom_filters1/_g4.html.erb

@@ -0,0 +1,8 @@
+<%= grid(@versions_grid4) do |g|
+
+  g.column name:  'Project', attribute: 'name', assoc: :project, filter: false
+
+  g.column name:  'Version name', attribute: 'name', filter: false
+
+  g.column name:  'Status', attribute: 'status', custom_filter: :auto
+end -%>

data/spec/support/test_app/app/views/custom_filters1/index.html.haml

@@ -0,0 +1,30 @@
+.well
+  %h2= current_page_title
+  %p
+    Just like
+    %code options_for_select
+    ,
+    %code :custom_filter
+    can take arguments in the form of a hash, an array of two element arrays, or just an array.
+  %p
+    %code custom_filter: :auto
+    will instruct WiceGrid to figure out the list of possible values by running a
+    %code SELECT DISTINCT `column` FROM `table`
+    query on the table.
+
+= show_code
+
+.row-fluid
+  .col-md-6
+    = render   'g1'
+
+  .col-md-6
+    = render   'g2'
+
+
+.row-fluid
+  .col-md-6
+    = render   'g3'
+
+  .col-md-6
+    = render   'g4'

data/spec/support/test_app/app/views/custom_filters2/_grid.html.erb

@@ -0,0 +1,30 @@
+<%= grid(@tasks_grid) do |g|
+
+  g.column name:  'ID', attribute: 'id', filter: false
+
+  g.column name:  'Title', attribute: 'title'
+
+  g.column name:  'Priority', attribute: 'name', assoc: :priority, custom_filter: %w(Anecdotic High Low Normal Urgent) do |task|
+    task.priority.name if task.priority
+  end
+
+  g.column name:  'Status', attribute: 'status_id',  custom_filter: Status.to_dropdown  do |task|
+    task.status.name if task.status
+  end
+
+  g.column name:  'Project Name', attribute: 'project_id', custom_filter: Project.to_dropdown do |task|
+    task.project.name if task.project
+  end
+
+  g.column  name:  'Archived', attribute: 'archived' do |task|
+    task.archived? ? 'Yes' : 'No'
+  end
+
+  g.column name:  'Added', attribute: 'created_at' do |task|
+    task.created_at.to_s(:short)
+  end
+
+  g.column   do |task|
+    link_to('Edit', edit_task_path(task))
+  end
+end -%>

data/spec/support/test_app/app/views/custom_filters2/index.html.haml

@@ -0,0 +1,41 @@
+.well
+  %h2= current_page_title
+  %p
+    There are two approaches to custom filters with joined tables. The first thing that comes to mind is to define
+    a column of a joined table with
+    %code :attribute
+    and
+    %code :assoc
+    , and submit a list of all possible values of this column to
+    %code :custom_filter
+    , like it is done in the example below in the Priority column:
+  %p
+    %code g.column name:  'Priority', attribute: 'name', assoc: :priority, custom_filter: %w(Anecdotic High Low Normal Urgent) do |task|
+
+  %p
+    This works but such a filter produces a query with a
+    %code WHERE
+    clause comparing a varchar field with one of the string values submitted to
+    %code :custom_filter
+    \.
+    This is not guaranteed to be as efficient as comparing an indexed integer foreign key with an integer primary key, thus, this approach is highly advised against.
+  %p
+    To implement filtering by foreign keys, define the column with the foreign key in
+    %code :attribute
+    and submit a hash or a two element array containing the IDs and labels of the joined table to
+    %code :attribute
+    \.
+    This has a negative side effect on sorting - the column will now be sorted according to the numerical value of the foreign key.
+    It can be dealt with by overiding sorting by
+    %code :custom_order
+    in
+    %code initialize_grid
+    \:
+  %p
+    %code custom_order: {'tasks.status_id' => 'statuses.position', 'tasks.project_id' => 'projects.name'}
+
+= show_code
+
+.row-fluid
+  .col-md-12
+    = render   'grid'

data/spec/support/test_app/app/views/custom_filters3/_grid.html.erb

@@ -0,0 +1,18 @@
+<%= grid(@tasks_grid) do |g|
+
+  g.column name:  'ID', attribute: 'id', filter: false
+
+  g.column name:  'Title', attribute: 'title'
+
+  g.column name:  'Found in version', assoc: :relevant_version, attribute: 'name', custom_filter: :auto do |task|
+    task.relevant_version.name if task.relevant_version
+  end
+
+  g.column name:  'Expected in version', attribute: 'expected_version_id', custom_filter: [:expected_version, :to_option] do |task|
+    task.expected_version.name if task.expected_version
+  end
+
+  g.column   do |task|
+    link_to('Edit', edit_task_path(task))
+  end
+end -%>

data/spec/support/test_app/app/views/custom_filters3/index.html.haml

@@ -0,0 +1,16 @@
+.well
+  %h2= current_page_title
+  %p
+    An array of symbols submitted to
+    %code :custom_filter
+    has a special meaning. The first symbol is sent as a method name to EVERY ActiveRecord object.
+    If an object responds to this method, the second method name is sent to the returned value unless it is nil, and so on.
+    The dropdown is populated by the list unique values.
+    The conditions set up by the user are ignored, that is, the records used are all those found on all pages without any active filters.
+    Naturally this can be extremely inneffective and should be used with caution.
+
+= show_code
+
+.row-fluid
+  .col-md-12
+    = render   'grid'

data/spec/support/test_app/app/views/custom_filters4/_grid.html.erb

@@ -0,0 +1,20 @@
+<%= grid(@tasks_grid) do |g|
+
+  g.column name:  'ID', attribute: 'id', filter: false
+
+  g.column name:  'Title', attribute: 'title'
+
+  g.column name:  'Found in version', assoc: :relevant_version,
+           attribute: 'name', custom_filter: :auto, allow_multiple_selection:  false do |task|
+    task.relevant_version.name if task.relevant_version
+  end
+
+  g.column name:  'Expected in version', attribute: 'expected_version_id',
+           custom_filter: [:expected_version, :to_option], allow_multiple_selection:  false do |task|
+    task.expected_version.name if task.expected_version
+  end
+
+  g.column   do |task|
+    link_to('Edit', edit_task_path(task))
+  end
+end -%>

data/spec/support/test_app/app/views/custom_filters4/index.html.haml

@@ -0,0 +1,12 @@
+.well
+  %h2= current_page_title
+  %p
+    Use
+    %code allow_multiple_selection:  false
+    to turn off mutiple selection in custom filters.
+
+= show_code
+
+.row-fluid
+  .col-md-12
+    = render   'grid'