wice_grid 3.6.2 → 4.1.0

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

@@ -0,0 +1,15 @@
+.well
+  %h2= current_page_title
+  %p
+    %code negation: true
+    adds a checkox to a text filter. The checked checkbox is the logical
+    %i NOT
+    \- it changes the semantics of a text filter to
+    %b not
+    showing all records with a matching substring.
+
+= show_code
+
+.row-fluid
+  .col-md-12
+    = render   'grid'

data/spec/support/test_app/app/views/no_records/_empty_grid.html.haml

@@ -0,0 +1 @@
+.well No records found

data/spec/support/test_app/app/views/no_records/_grid1.html.erb

@@ -0,0 +1,11 @@
+<%= grid(@tasks_grid) do |g|
+
+  g.blank_slate  do
+    content_tag :div, "No records found", class: 'well'
+  end
+
+  g.column name:  'ID', attribute: 'id'
+
+  g.column name:  'Title', attribute: 'title'
+
+end -%>

data/spec/support/test_app/app/views/no_records/_grid2.html.erb

@@ -0,0 +1,9 @@
+<%= grid(@tasks_grid2) do |g|
+
+  g.blank_slate content_tag(:div, "No records found", class: 'well')
+
+  g.column name:  'ID', attribute: 'id'
+
+  g.column name:  'Title', attribute: 'title'
+
+end -%>

data/spec/support/test_app/app/views/no_records/_grid3.html.erb

@@ -0,0 +1,9 @@
+<%= grid(@tasks_grid3) do |g|
+
+  g.blank_slate partial:  "empty_grid"
+
+  g.column name:  'ID', attribute: 'id'
+
+  g.column name:  'Title', attribute: 'title'
+
+end -%>

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

@@ -0,0 +1,24 @@
+.well
+  %h2= current_page_title
+  %p
+    What if there no records to render in a grid?
+    There are three ways to define what to show in this case:
+    %ul
+      %li
+        %code blank_slate
+        with a block. This looks like a column definition, but the value
+        returned by the block is rendred when there are no records.
+      %li
+        %code blank_slate
+        whithout a block, but with one string argument.
+      %li
+        %code blank_slate
+        with parameter
+        %code partial:  "partial_name"
+        which defines a partial to render.
+
+= show_code
+
+.example1= render   'grid1'
+.example2= render   'grid2'
+.example3= render   'grid3'

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

@@ -0,0 +1,17 @@
+<%= grid(@tasks_grid) do |g|
+
+  g.column name:  'ID', attribute: 'id', filter: false
+
+  g.column name:  'Title', attribute: 'title'
+
+
+  g.column name:  'Priority', attribute: 'priority_id',
+    custom_filter: [['NOT DEFINED', 'null'], ['DEFINED', 'not null']] + Priority.to_dropdown do |task|
+    task.priority.name if task.priority
+  end
+
+
+  g.column   do |task|
+    link_to('Edit', edit_task_path(task))
+  end
+end -%>

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

@@ -0,0 +1,21 @@
+.well
+  %h2= current_page_title
+  %p
+    Strings
+    %code null
+    and
+    %code not null
+    in
+    %code custom_filter
+    values
+    are treated speacially and result in
+    %code IS NULL
+    and
+    %code IS NOT NULL
+    WHERE-clauses.
+
+= show_code
+
+.row-fluid
+  .col-md-12
+    = render   'grid'

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

@@ -0,0 +1,19 @@
+<%= grid(@tasks_grid) do |g|
+
+  g.column name:  'ID', attribute: 'id', filter_type: :range
+
+  g.column name:  'Title', attribute: 'title'
+
+  g.column  name:  'Description', attribute: 'description'
+
+  g.column  name:  'Archived', attribute: 'archived' do |task|
+    task.archived? ? 'Yes' : 'No'
+  end
+
+  g.column name:  'Due Date', attribute: 'due_date'
+
+
+  g.column   do |task|
+    link_to('Edit', edit_task_path(task))
+  end
+end -%>

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

@@ -0,0 +1,12 @@
+.well
+  %h2= current_page_title
+  %p
+    By default the filter for numeric columns is a one input field filter which checks for equality. You can also use a range filter which check if the value is with a range. Use
+    %code filter_type: :range
+
+
+= show_code
+
+.row-fluid
+  .col-md-12
+    = render   'grid'

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

@@ -0,0 +1,27 @@
+<%= grid(@tasks_grid, hide_submit_button: true) do |g|
+
+  g.column name:  'ID', attribute: 'id', filter: false
+
+  g.column name:  'Title', attribute: 'title', auto_reload:  true
+
+  g.column name:  'Priority', attribute: 'priority_id', custom_filter: Priority.to_dropdown, auto_reload:  true do |task|
+    task.priority.name if task.priority
+  end
+
+  g.column name:  'Status', attribute: 'status_id', custom_filter: Status.to_dropdown, auto_reload:  true  do |task|
+    task.status.name if task.status
+  end
+
+  g.column name:  'Project Name', attribute: 'project_id', custom_filter: Project.to_dropdown, auto_reload:  true do |task|
+    task.project.name if task.project
+  end
+
+  g.column  name:  'Archived', attribute: 'archived', auto_reload:  true do |task|
+    task.archived? ? 'Yes' : 'No'
+  end
+
+  g.column name:  'Added', attribute: 'created_at', auto_reload:  true do |task|
+    task.created_at.to_s(:short)
+  end
+
+end -%>

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

@@ -0,0 +1,50 @@
+.well
+  %h2= current_page_title
+  %p
+    In addition to
+    %a{href:  integration_with_application_view_index_path}
+      %code current_page_records
+    and
+    %a{href: integration_with_application_view_index_path}
+      %code current_page_records
+    helpers
+    a callback can be setup in the controller which is executed when a grid page is rendered.
+    Though the results of that processing is rendered on page, normally such callbacks are used
+    for some kind of background processing. Please notice that the callback is executed
+    %em after
+    the controller action and thus all controller instance variables have already been injected inti the view,
+    that is why the current example has a definition of
+    %code @one_page_records
+    %em before
+    the callback, so that the object is injected into the view and the callback block has access to the object as well.
+
+    The callback can be setup separately as a block:
+
+    :plain
+      <pre>
+      @grid.with_paginated_resultset do |records|
+        ...
+      end
+      </pre>
+
+    or as an argument of
+    %code initialize_grid
+    where the value is the name of the method to be invoked:
+
+    :plain
+      <pre>
+      @grid = initialize_grid(Task,
+        with_paginated_resultset: :process_records
+      )
+      </pre>
+
+= show_code
+
+= render   'grid'
+
+.row-fluid
+  .col-md-12
+    .well
+      = @one_page_records.size
+      records on the current page:
+      = @one_page_records.map(&:id).to_sentence

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

@@ -0,0 +1,27 @@
+<%= grid(@tasks_grid, hide_submit_button: true) do |g|
+
+  g.column name:  'ID', attribute: 'id', filter: false
+
+  g.column name:  'Title', attribute: 'title', auto_reload:  true
+
+  g.column name:  'Priority', attribute: 'priority_id', custom_filter: Priority.to_dropdown, auto_reload:  true do |task|
+    task.priority.name if task.priority
+  end
+
+  g.column name:  'Status', attribute: 'status_id', custom_filter: Status.to_dropdown, auto_reload:  true  do |task|
+    task.status.name if task.status
+  end
+
+  g.column name:  'Project Name', attribute: 'project_id', custom_filter: Project.to_dropdown, auto_reload:  true do |task|
+    task.project.name if task.project
+  end
+
+  g.column  name:  'Archived', attribute: 'archived', auto_reload:  true do |task|
+    task.archived? ? 'Yes' : 'No'
+  end
+
+  g.column name:  'Added', attribute: 'created_at', auto_reload:  true do |task|
+    task.created_at.to_s(:short)
+  end
+
+end -%>

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

@@ -0,0 +1,48 @@
+.well
+  %h2= current_page_title
+  %p
+    In addition to the
+    %a{href:  resultset_processings_path}
+      %code with_paginated_resultset
+      callback
+    there is callback
+    %code with_resultset
+    \.
+
+  %p
+    Just like
+    %code with_paginated_resultset
+    it can be defined as a block and as a symbol referring to a method in the controller.
+
+  %p
+    The difference is that the value submitted to the method or the callback is not a list of
+    all records but an ActiveRelation object which can be used to obtain all records.
+
+    In the example on this page the list of all records is only obtained when button
+    %code Show IDs of records throughout all pages
+    is clicked.
+
+  %p
+    Normally
+    %code with_resultset
+    is used
+    for some kind of background processing.
+    The results of callback are rendered on page only for the sake of the demonstration.
+
+= show_code
+
+= form_tag(resultset_processings2_index_path, method:  :get) do
+  = dump_filter_parameters_as_hidden_fields(@tasks_grid)
+  = hidden_field :process_selected_tasks, 1
+  %button#process.btn.btn-primary{type:  'submit'} Show IDs of records throughout all pages
+
+.example
+  = render   'grid'
+
+  -unless controller.selected_tasks.blank?
+    .row-fluid
+      .col-md-12
+        .well
+          = controller.selected_tasks.size
+          records on all pages:
+          = controller.selected_tasks.map(&:id).to_sentence

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

@@ -0,0 +1,30 @@
+<%= grid(@tasks_grid, show_filters: :always) do |g|
+
+  g.column name:  'ID', attribute: 'id', filter: false
+
+  g.column name:  'Title', attribute: 'title'
+
+  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
+
+  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(:db)
+  end
+
+  g.column   do |task|
+    link_to('Edit', edit_task_path(task))
+  end
+end -%>

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

@@ -0,0 +1,15 @@
+.well
+  %h2= current_page_title
+  %p
+    Read
+    %code SAVED_QUERIES_HOWTO.rdoc
+    for details.
+
+= show_code
+
+.row-fluid
+  .col-md-6
+
+    = saved_queries_panel(@tasks_grid, confirm:  false)
+
+= render   'grid'

data/spec/support/test_app/app/views/styling/_grid1.html.erb

@@ -0,0 +1,12 @@
+<%= grid(@versions_grid1, html: {class: 'my-grid'}, header_tr_html:  {class: 'my-header'}) do |g|
+
+  g.column name:  'ID', attribute: 'id', filter: false
+
+  g.column name:  'Project', attribute: 'name', assoc: :project do |version|
+    version.project.name if version.project
+  end
+
+  g.column name:  'Version name', attribute: 'name', html: {style: 'font-weight: bold; text-align: center'}
+
+  g.column name:  'Status', attribute: 'status', custom_filter: {'Development' => 'development', 'Testing' => 'testing', 'Production' => 'production'}
+end -%>

data/spec/support/test_app/app/views/styling/_grid2.html.erb

@@ -0,0 +1,31 @@
+<%= grid(@versions_grid2) do |g|
+
+  g.row_attributes do |version|
+    if version.status == 'production'
+      {style: 'background-color: rgb(255, 255, 204);'}
+    end
+  end
+
+  g.column name:  'ID', attribute: 'id', filter: false do |version|
+    if version.id.to_s.index('9')
+      [version.id, {style: 'background-color: rgb(255, 105, 104);'}]
+    else
+      version.id
+    end
+  end
+
+  g.column name:  'Project', attribute: 'name', assoc: :project, class: 'special-column' do |version|
+    if version.project
+      if version.project.name == 'Divine Firmware'
+        [version.project.name , {style: 'background-color: rgb(255, 105, 104);', class: 'some-special-class'}]
+      else
+        version.project.name
+      end
+    end
+  end
+
+  g.column name:  'Version name', attribute: 'name'
+
+  g.column name:  'Status', attribute: 'status', custom_filter: {'Development' => 'development', 'Testing' => 'testing', 'Production' => 'production'}
+end -%>
+

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

@@ -0,0 +1,65 @@
+:css
+  table.my-grid {
+    border: 1px solid red;
+  }
+  table.my-grid tr.my-header {
+    background-color: #ebebeb;
+  }
+
+
+.well
+  %h2= current_page_title
+  %ul
+    %li
+      %code :html
+      in the
+      %code grid
+      helper defines html arguments for the
+      %code table
+      tag.
+
+    %li
+      %code :header_tr_html
+      in the
+      %code grid
+      helper defines html attributes for the header rows with column names and filters.
+
+
+    %li
+      %code :html
+      in the
+      %code column
+      helper defines html attributes for the
+      %code td
+      tag.
+
+
+    %li
+      %code g.row_attributes do |record| ... end
+      is similar to a
+      %code column
+      definition, but returns a hash of html attributes to be added to each
+      %code tr.
+      Because the block is evaluated for each record, just like
+      %column
+      , the returned value can be calculated dynamically depending on the record.
+
+    %li
+      Each
+      %code column
+      block can return a 2-value array, the first value of which is the content of the cell, and
+      the second is a hash of html attributes for the
+      %code td
+      tag.
+
+= show_code
+
+
+.row-fluid
+  .col-md-12
+    = render   'grid1'
+
+
+.row-fluid
+  .col-md-12
+    = render   'grid2'